CODEWITHSUNDEEP
rubycachingrefactoring
B Seven
B Seven

Reputation: 45951

What is a better, more idiomatic way of writing this Ruby method?

This is a simple method to check a cache and make an expensive API call for a cache miss.

    def search_for params
      cache = Cache.for( params )
      return cache if cache

      response = HTTParty.get( URL, params )
      Cache.set params, response

      response
    end

But it seems wordy and not idiomatic.

Upvotes: 0

Views: 75

Answers (4)

Wand Maker
Wand Maker

Reputation: 18772

If you can modify implementation of Cache#for and have it accept a block that will be executed if value is not found in cache, then, it can simplify the calling sequence to something like below:

def search_for params
  return Cache.for( params ) { HTTParty.get( URL, params ) }
end

You can add a modified for method like below:

class Cache
    # alias the original `for` as `lookup`
    singleton_class.send(:alias_method, :lookup, :for)

    def self.for params, &block
        value = lookup(params);
        if (block_given? and not value) then
            value = block.call
            set params, value
        end
        value
    end
end

Upvotes: 1

Aetherus
Aetherus

Reputation: 8908

Let's do something crazy.

Add [] and []= to Cache

Cache.instance_eval do
  alias_method :[], :for
  alias_method :[]=, :set
end

Create a module to reuse

module Cacheable
  def cached(key)
    Cache[key] ||= yield
  end

  def self.included(base)
    base.extend self
  end
end

Use the Cacheable module

class Foo
  include Cacheable

  # `cached` can be used in instance methods
  def search_for(params)
    cached(params) do
      HTTParty.get(URL, params)
    end
  end

  # `cached` can also be used in class methods
  def self.search_for(params)
    cached(params) do
      HTTParty.get(URL, params)
    end
  end
end

Upvotes: 2

mgidea
mgidea

Reputation: 494

Another option based on your question

def search_for params
  unless response = Cache.for( params )
    response = HTTParty.get( URL, params )
    Cache.set params, response
  end
  response
end

Upvotes: 1

James Mendoza
James Mendoza

Reputation: 41

Does Cache.set return the Cache object that is set? If so, this may work:

def search_for params
  Cache.for(params) || Cache.set(params, HTTParty.get( URL, params ))
end

Upvotes: 4

Related Questions