Module: ActiveRemote::Cached::ClassMethods

Defined in:
lib/active_remote/cached.rb

Instance Method Summary collapse

Instance Method Details

#_cached_delete_method_name(arguments) ⇒ Object 



107
108
109
 
# File 'lib/active_remote/cached.rb', line 107

def _cached_delete_method_name(arguments)
  "cached_delete_by_#{arguments.join('_and_')}"
end

#_cached_exist_find_method_name(arguments) ⇒ Object 



111
112
113
 
# File 'lib/active_remote/cached.rb', line 111

def _cached_exist_find_method_name(arguments)
  "cached_exist_find_by_#{arguments.join('_and_')}"
end

#_cached_exist_search_method_name(arguments) ⇒ Object 



115
116
117
 
# File 'lib/active_remote/cached.rb', line 115

def _cached_exist_search_method_name(arguments)
  "cached_exist_search_by_#{arguments.join('_and_')}"
end

#_cached_find_method_name(arguments) ⇒ Object 



119
120
121
 
# File 'lib/active_remote/cached.rb', line 119

def _cached_find_method_name(arguments)
  "cached_find_by_#{arguments.join('_and_')}"
end

#_cached_search_method_name(arguments) ⇒ Object 



123
124
125
 
# File 'lib/active_remote/cached.rb', line 123

def _cached_search_method_name(arguments)
  "cached_search_by_#{arguments.join('_and_')}"
end

#_create_cached_finder_for(cached_finder_key, options = {}) ⇒ Object

Underscored Methods



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/active_remote/cached.rb', line 71

def _create_cached_finder_for(cached_finder_key, options = {})
  cached_finder_key_set = [ cached_finder_key ].flatten.sort

  ##
  # Run each permutation of the arguments passed in
  # and define each finder/searcher
  #
  cached_finder_key_set.permutation do |arguments|
    delete_method_name = _cached_delete_method_name(arguments)
    exist_find_method_name = _cached_exist_find_method_name(arguments)
    exist_search_method_name = _cached_exist_search_method_name(arguments)
    find_method_name = _cached_find_method_name(arguments)
    search_method_name = _cached_search_method_name(arguments)

    unless self.respond_to?(delete_method_name)
      _define_cached_delete_method(delete_method_name, arguments, options)
    end

    unless self.respond_to?(exist_find_method_name)
      _define_cached_exist_find_method(exist_find_method_name, arguments, options)
    end

    unless self.respond_to?(exist_search_method_name)
      _define_cached_exist_search_method(exist_search_method_name, arguments, options)
    end

    unless self.respond_to?(find_method_name)
      _define_cached_find_method(find_method_name, arguments, options)
    end

    unless self.respond_to?(search_method_name)
      _define_cached_search_method(search_method_name, arguments, options)
    end
  end
end

#_define_cached_delete_method(method_name, *method_arguments, cached_finder_options) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/active_remote/cached.rb', line 127

def _define_cached_delete_method(method_name, *method_arguments, cached_finder_options)
  method_arguments.flatten!
  expanded_method_args = method_arguments.join(",")
  sorted_method_args = method_arguments.sort.join(",")

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # def self.cached_delete_by_user_guid(user_guid, options = {})
    #   ::ActiveRemote::Cached.cache.delete([name, user_guid])
    # end
    def self.#{method_name}(#{expanded_method_args}, options = {})
      options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
      namespace = options.delete(:namespace)
      find_cache_key = [namespace, name, "#find", #{sorted_method_args}].compact
      search_cache_key = [namespace, name, "#search", #{sorted_method_args}].compact

      ::ActiveRemote::Cached.cache.delete(find_cache_key)
      ::ActiveRemote::Cached.cache.delete(search_cache_key)
    end
  RUBY
end

#_define_cached_exist_find_method(method_name, *method_arguments, cached_finder_options) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/active_remote/cached.rb', line 148

def _define_cached_exist_find_method(method_name, *method_arguments, cached_finder_options)
  method_arguments.flatten!
  expanded_method_args = method_arguments.join(",")
  sorted_method_args = method_arguments.sort.join(",")

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # def self.cached_exist_find_by_user_guid(user_guid, options = {})
    #   ::ActiveRemote::Cached.cache.exist?([name, user_guid])
    # end
    def self.#{method_name}(#{expanded_method_args}, options = {})
      options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
      namespace = options.delete(:namespace)
      cache_key = [namespace, name, "#find", #{sorted_method_args}].compact

      ::ActiveRemote::Cached.cache.exist?(cache_key)
    end
  RUBY

  singleton_class.send(:alias_method, "#{method_name}?", method_name)
end

#_define_cached_exist_search_method(method_name, *method_arguments, cached_finder_options) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/active_remote/cached.rb', line 169

def _define_cached_exist_search_method(method_name, *method_arguments, cached_finder_options)
  method_arguments.flatten!
  expanded_method_args = method_arguments.join(",")
  sorted_method_args = method_arguments.sort.join(",")

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # def self.cached_exist_search_by_user_guid(user_guid, options = {})
    #   ::ActiveRemote::Cached.cache.exist?([namespace, name, "#search", user_guid])
    # end
    def self.#{method_name}(#{expanded_method_args}, options = {})
      options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
      namespace = options.delete(:namespace)
      cache_key = [namespace, name, "#search", #{sorted_method_args}].compact

      ::ActiveRemote::Cached.cache.exist?(cache_key)
    end
  RUBY

  singleton_class.send(:alias_method, "#{method_name}?", method_name)
end

#_define_cached_find_method(method_name, *method_arguments, cached_finder_options) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/active_remote/cached.rb', line 190

def _define_cached_find_method(method_name, *method_arguments, cached_finder_options)
  method_arguments.flatten!
  expanded_method_args = method_arguments.join(",")
  sorted_method_args = method_arguments.sort.join(",")

  expanded_search_args = ""
  method_arguments.each do |method_argument|
    expanded_search_args << ":#{method_argument} => #{method_argument},"
  end

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # def self.cached_find_by_user_guid(user_guid, options = {})
    #   options = ::ActiveRemote::Cached.default_options.merge({}).merge(options)
    #
    #   ::ActiveRemote::Cached.cache.fetch([namespace, name, "#find", user_guid], options) do
    #     self.find(:user_guid => user_guid)
    #   end
    # end
    #
    # If a block is given, it is incumbent on the caller to make sure the expectation
    # of the result object is maintained for requests/responses
    #
    def self.#{method_name}(#{expanded_method_args}, options = {})
      options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
      namespace = options.delete(:namespace)
      cache_key = [namespace, name, "#find", #{sorted_method_args}].compact

      ::ActiveRemote::Cached.cache.fetch(cache_key, options) do
        if block_given?
          yield
        else
          self.find(#{expanded_search_args})
        end
      end
    end
  RUBY
end

#_define_cached_search_method(method_name, *method_arguments, cached_finder_options) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/active_remote/cached.rb', line 228

def _define_cached_search_method(method_name, *method_arguments, cached_finder_options)
  method_arguments.flatten!
  expanded_method_args = method_arguments.join(",")
  sorted_method_args = method_arguments.sort.join(",")

  expanded_search_args = ""
  method_arguments.each do |method_argument|
    expanded_search_args << ":#{method_argument} => #{method_argument},"
  end

  self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
    # def self.cached_search_by_user_guid(user_guid, options = {})
    #   options = ::ActiveRemote::Cached.default_options.merge({}).merge(options)
    #
    #   ::ActiveRemote::Cached.cache.fetch([namespace, name, "#search", user_guid], options) do
    #     self.search(:user_guid => user_guid)
    #   end
    # end
    #
    # If a block is given, it is incumbent on the caller to make sure the expectation
    # of the result object is maintained for requests/responses
    #
    def self.#{method_name}(#{expanded_method_args}, options = {})
      options = ::ActiveRemote::Cached.default_options.merge(#{cached_finder_options}).merge(options)
      namespace = options.delete(:namespace)
      cache_key = [namespace, name, "#search", #{sorted_method_args}].compact

      ::ActiveRemote::Cached.cache.fetch(cache_key, options) do
        if block_given?
          yield
        else
          self.search(#{expanded_search_args})
        end
      end
    end
  RUBY
end

#cached_find(argument_hash, options = {}) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/active_remote/cached.rb', line 42

def cached_find(argument_hash, options = {})
  method_name = _cached_find_method_name(argument_hash.keys)
  arguments = argument_hash.values

  if block_given?
    __send__(method_name, *arguments, options) do
      yield
    end
  else
    __send__(method_name, *arguments, options)
  end
end

#cached_finders(*keys) ⇒ Object 



38
39
40
 
# File 'lib/active_remote/cached.rb', line 38

def cached_finders(*keys)
  cached_finders_for(*keys)
end

#cached_finders_for(*cached_finder_keys) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/active_remote/cached.rb', line 30

def cached_finders_for(*cached_finder_keys)
  options = cached_finder_keys.extract_options!

  cached_finder_keys.each do |cached_finder_key|
    _create_cached_finder_for(cached_finder_key, options)
  end
end

#cached_search(argument_hash, options = {}) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/active_remote/cached.rb', line 55

def cached_search(argument_hash, options = {})
  method_name = _cached_search_method_name(argument_hash.keys)
  arguments = argument_hash.values

  if block_given?
    __send__(method_name, *arguments, options) do
      yield
    end
  else
    __send__(method_name, *arguments, options)
  end
end