Skip to content

Instantly share code, notes, and snippets.

@jcasimir
Created August 3, 2012 12:30
Show Gist options
  • Save jcasimir/3247167 to your computer and use it in GitHub Desktop.
Save jcasimir/3247167 to your computer and use it in GitHub Desktop.
LOOKUP_CHAIN = [:params, :user, :session, :http, :default]
def self.set_by(inputs)
locale = nil
LOOKUP_CHAIN.each do |lookup|
locale = send("by_#{lookup}", inputs[lookup])
break if locale
end
return locale
end
@JoshCheek
Copy link

Actually, in the inject based one, the ||= can just be an ||

@nhessler
Copy link

nhessler commented Aug 3, 2012

@ernie understood, but until it's an actual bottleneck I tend to go for what works. either way I really like @JoshCreek 's implementation using inject and including the update of just using ||. it makes it pretty and performant.

@gicappa
Copy link

gicappa commented Aug 3, 2012

Didn't have the time to try it and maybe it won't work but just as starting point:

    def self.set_by(inputs)
      LOOKUP_CHAIN.map {|lookup| send("by_#{lookup}", inputs[lookup]) }.
        reduce { |value| value.nil? ? next : value }
    end

@gicappa
Copy link

gicappa commented Aug 3, 2012

or maybe just

  def self.set_by(inputs)
    LOOKUP_CHAIN.map {|lookup| send("by_#{lookup}", inputs[lookup]) }.
      reduce { |value, lookup| value }
  end

@ernie
Copy link

ernie commented Aug 3, 2012

@jcasimir how about:

class Test
  LOOKUP_CHAIN = [:params, :user, :session, :http, :default]

  def self.set_by(inputs)
    results = Hash.new {|h, k| h[k] = send("by_#{k}", inputs[k]) if k}
    results[LOOKUP_CHAIN.detect {|k| results[k]}]
  end

  def self.by_user(input)
  end

  def self.by_session(input)
  end

  def self.by_http(input)
    puts "ran this"
    1
  end

  def self.by_params(input)
  end

  def self.by_default(input)
  end
end

puts Test.set_by({})
# => ran this
# => 1

The downside -- the intent isn't as clear with this code, unless you're familiar with Hash block behavior.

Explanation:

The hash set up on the first line of the method runs the block on missing keys, and populates the value with the results of running the code being tested. As such, the second line only evaluates each option once (in the inner block) and detect will return this (working) lookup type, and the outer hash retrieves the stored value. The "if k" is necessary in the block to catch the case where no result is returned by any option, to prevent a NoMethodError on a by_ method. Unnecessary if by_default always returns a result.

A similar method for caching dispatch methods is used in Squeel and ARel.

Not saying it's necessarily better than what you've got (for the reason outlined above) but it is an option. :)

@saturnflyer
Copy link

I experimented with method fallback about a year ago here https://gist.github.com/943663
You could use it like this

object.fallback(:params, :user, :session, :http, :default)

with a little tweak to add the "by_" part

@gicappa
Copy link

gicappa commented Aug 3, 2012

ok with the provided test case it's simpler to tri it out and it could be

def self.set_by(inputs)
      LOOKUP_CHAIN.map {|lookup| send("by_#{lookup}", inputs[lookup]) }.detect { |value| value }
end

@tyre
Copy link

tyre commented Aug 3, 2012

@gicappa replace the map with detect and it will return nil if none are found.
That looks like the sanest way to write it.

@ernie
Copy link

ernie commented Aug 3, 2012

@tyre You can't change the map to detect because then it will return the first value in LOOKUP_CHAIN with a truthy return value, but not the actual result of evaluating the block itself. You'll be getting a symbol from LOOKUP_CHAIN as your final result, versus the actual locale.

@tyre
Copy link

tyre commented Aug 3, 2012 via email

@roryokane
Copy link

A test harness of sorts, so that we can verify that our changed versions match the original:

class LocaleChooser


    LOOKUP_CHAIN = [:params, :user, :session, :http, :default]

    def self.set_by(inputs)
        locale = nil
        LOOKUP_CHAIN.each do |lookup|
            locale = send("by_#{lookup}", inputs[lookup])
            break if locale
        end
        return locale
    end


    # define self.by_params(input), self.by_user(input), etc.
    class << self
        returning_lookups = [:user, :http] # edit me for testing

        LOOKUP_CHAIN.each do |lookup|
            define_method("by_#{lookup}") do |input|
                puts "evaluated by_#{lookup}"

                if returning_lookups.include?(lookup)
                    return [lookup, input]
                else
                    return nil
                end
            end
        end
    end
end

p LocaleChooser.set_by({})
puts '---'
p LocaleChooser.set_by(:user => :custom_user) 
puts '---'
p LocaleChooser.set_by(:default => :custom_default)
puts '---'
p LocaleChooser.set_by(:params => :custom_params)

This harness is based on the code in ernie’s comment. The main part of the code, separated with whitespace, is straight from this Gist.

If you run this as shown above (on Ruby 1.9), you get this output:

evaluated by_params
evaluated by_user
[:user, nil]

---
evaluated by_params
evaluated by_user
[:user, :custom_user]

---
evaluated by_params
evaluated by_user
[:user, nil]

---
evaluated by_params
evaluated by_user
[:user, nil]

Change the calls at the bottom and the contents of returning_lookups to test different behaviors.

@roryokane
Copy link

Here’s a refactoring:

module Enumerable
  def find_mapped
    result = nil
    self.each do |lookup|
      result = yield(lookup)
      break if result
    end
    return result
  end
end
LOOKUP_CHAIN = [:params, :user, :session, :http, :default]

def self.set_by(inputs)
  LOOKUP_CHAIN.find_mapped do |lookup|
    locale = send("by_#{lookup}", inputs[lookup])
  end
end

It produces the same output in the test harness I posted previously.

Oh, and sorry for the 4-space indentation in that previous test-harness code. I forgot to convert from tabs to spaces, and GitHub won’t let me edit that comment.

@roryokane
Copy link

@roryokane
Copy link

I just found out that you can make more than one fork of a Gist. So here’s a Gist fork for the test harness I posted earlier.

@roryokane
Copy link

This Gist was posted alongside a tweet by the author:

Any ideas to refactor this little ruby collection operation? https://gist.github.com/3247167

@Yardboy
Copy link

Yardboy commented Aug 6, 2012

Thought about this the other day but just got around to trying it this afternoon. I believe #any? stops when it reaches a truthy result, so how about this:

def self.set_by(inputs)
  locale = nil
  LOOKUP_CHAIN.any? { |lookup| locale = send("by_#{lookup}", inputs[lookup]) }
  return locale
end

Passes the test harness.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment