cachethod 0.0.4 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGM0ODY3ZDUyMzU1YTNhNmY1NzY2Mjk3NThlNDBkYzE3YTViMTAyNg==
+    ZjE2N2IyNDUyMzQ1MjEzMGQ2Mjk5YzdhMzM2NTdkMjJlMGRmYjMyMA==
   data.tar.gz: !binary |-
-    MDVjMWU1MDhhNTA2ZmNjYTU0YTE4ZDE4MDkwNjAyMzI5Mjc5NWJjZg==
+    NGQxMmIxNGNmYzk0Yjc5YzkyYjRhZDYwN2YwNmM3YmFlMDgwOTkzNg==
 SHA512:
   metadata.gz: !binary |-
-    YzJhMjFmNDUzYTY4MjIyMDIxY2UxOWYzYTAxZGEyNDk5ZTUxYTAwNjZmNmM1
-    YWZiMTdiNzY3NWE3YTViYjQ3Mzk1NTgyNzU2Mzk0YTk2OGFmMTA5ZDIxYmY2
-    ZTFjOGFiZWFiNGE2NmI3NTUzYTU0NzYwNzY1Zjc1ZTJhZDVjZjM=
+    YmFlMGMxNzJlNzc4NGNjOWI2ZGU0NGUxNzNmNjE1NTg1MjNiMWJiZGUzOGJh
+    ZTQ2MDgyNzhiMWU0NjZhNzM3ZjI3MWY5MjI5NzI4NjBhMDNjMTFhNjczNzQ4
+    NjA0OTlkZWQ1ODQxYTY2OTYzNDVkNzk0ZDI5NGY1MDFmODIzZjM=
   data.tar.gz: !binary |-
-    YTE4YzA3NWVlNDEyYzFjYWUxOGMyOTFkZjRkY2Q4OTkzZTAyNjUwMjY1NGIy
-    NWM4Y2JjOTMxNDMwNjA4MjI1YzkwYTAxYTQ3ZTEyMDdkN2UyNjZlZDJhNjY3
-    ZGMwMzAzMDFkOTFiZDk2OGRhNWY0NjQzZjQ5ZmRlYjkxZDAxYjE=
+    Y2FiYjFlZWE3NTNiZTA0ZTczYTBhY2ZmMzg0YjNhN2VjZmY2NTU3Y2RhMGRk
+    M2UyNjMwYzRlNDE5YzE4Y2ZmZjY4NTMyYjQwNzY1Y2RlNWY3MDI5NWQ0MzI0
+    OWIwNGQzNDYyM2VkZTYwOTRjZDgzYTYwNjQ4MTdhMjIyOTFhMWM=

data/LICENSE

@@ -0,0 +1,8 @@
+/*
+ * ----------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * As long as you retain this notice you can do whatever you want with this
+ * stuff. If we meet some day, and you think this stuff is worth it, you can
+ * buy me a beer in return. Rene Klacan
+ * ----------------------------------------------------------------------------
+ */

data/README.md

@@ -0,0 +1,117 @@
+# Cachethod
+
+With this Rails plugin you can **cache** your **model methods** and speed up
+obtaining results. This can be very useful when you are doing some
+expensive operations (eg. reading from file or doing some http request)
+in your model methods and you don't need fresh results every time you
+invoke the method or results just don't change so frequently.
+
+**Works out of box with Rails 3 and Rails 4.**
+
+## About
+
+It wraps Rails.cache.fetch method so it is completely without
+configuration and if you change cache configuration of your project it
+will be reflected also on Cachethod methods.
+
+## Install
+
+In Gemfile
+
+```ruby
+gem 'cachethod'
+```
+
+Then run
+
+```
+bundle install
+```
+
+## Usage
+
+First step is including **Cachethod** module to your class.
+
+Next you can choose one of following methods:
+
+```ruby
+cache_method :method_name, expires_in: 1.minutes
+cachethod :method_name, expires_in: 2.days
+cache_methods [:method1_name, :method2_name], expires_in: 3.weeks
+cachethods [:method2_name, :method2_name], expires_in: 4.months
+```
+
+First argument is name of the method you want to cache and other
+arguments are the same that you are used to pass on Rails.cache.fetch
+method.
+
+Just put it in your controller:
+
+```ruby
+class User < ActiveRecord::Base
+  include Cachethod
+
+  cache_method :some_io_method, expires_in: 10.minutes
+
+  def some_io_method
+    ...
+  end
+end
+```
+
+Then invoke cached method multiple times in the usual way and you will
+see the difference:
+
+```ruby
+user.some_io_method
+user.some_io_method
+user.some_io_method
+```
+
+If you want to access uncached version of your method then you can do:
+
+```ruby
+user.some_io_method!
+```
+
+## Result
+
+For example it translates following code:
+
+```ruby
+class Stormtrooper
+  include Cachethod
+
+  cache_methods [:some_io_method, :another_io_method], expires_in: 10.minutes
+
+  def some_io_method
+    ...
+  end
+
+  def another_io_method
+    ...
+  end
+end
+```
+
+into the equivalent of:
+
+```ruby
+class Stormtrooper < ActiveRecord::Base
+  def some_io_method
+    Rails.cache.fetch(:some_key, expires_in: 10.minutes) do
+      ...
+    end
+  end
+
+  def another_io_method
+    Rails.cache.fetch(:another_key, expires_in: 10.minutes) do
+      ...
+    end
+  end
+end
+```
+
+## License
+
+This library is distributed under the Beerware license.

data/lib/cachethod.rb

@@ -1 +1,43 @@
-require 'cachethod/active_record_base_ext'
+module Cachethod
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def cache_method names, *args
+      @methods_to_cache ||= {}
+
+      [*names].each do |name|
+        if instance_methods.include?(name.to_sym)
+          cache_method_create(name, *args)
+        else
+          @methods_to_cache[name.to_sym] = args
+        end
+      end
+    end
+
+    alias_method :cache_methods, :cache_method
+    alias_method :cachethod, :cache_method
+    alias_method :cachethods, :cache_method
+
+    def method_added name
+      super
+      return if @methods_to_cache.nil? || @methods_to_cache[name].nil?
+      args = @methods_to_cache.delete(name)
+      cache_method_create(name, *args)
+    end
+
+    def cache_method_create name, *args
+      define_method "#{name}_cached" do
+        cache_key = "cachethod.#{self.class.to_s.underscore}-#{id}.#{name}"
+
+        Rails.cache.fetch(cache_key, *args) do
+          send("#{name}!")
+        end
+      end
+
+      alias_method "#{name}!", name
+      alias_method name, "#{name}_cached"
+    end
+  end
+end

data/lib/cachethod/version.rb

@@ -1,3 +1,3 @@
 module Cachethod
-  VERSION = "0.0.4"
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cachethod
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Rene Klacan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,11 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - Rakefile
 - lib/cachethod.rb
-- lib/cachethod/active_record_base_ext.rb
 - lib/cachethod/version.rb
-- lib/tasks/cachethod_tasks.rake
 - test/cachethod_test.rb
 - test/test_helper.rb
 homepage: https://github.com/reneklacan/cachethod

data/lib/cachethod/active_record_base_ext.rb

@@ -1,45 +0,0 @@
-class ActiveRecord::Base
-  class << self
-    alias_method :method_added_original, :method_added
-
-    def cache_method name, *args
-      @methods_to_cache ||= {}
-
-      if name.is_a?(String) || name.is_a?(Symbol)
-        @methods_to_cache[name.to_sym] = args
-      elsif method_name.is_a?(Array)
-        cache_methods(name, *args)
-      else
-        raise Exception.new('Invalid first argument for cachethod method!')
-      end
-    end
-
-    def cache_methods names, *args
-      @methods_to_cache ||= {}
-
-      names.each do |name|
-        @methods_to_cache[name.to_sym] = args
-      end
-    end
-
-    alias_method :cachethod, :cache_method
-    alias_method :cachethods, :cache_method
-
-    def method_added name
-      return if @methods_to_cache.nil? || @methods_to_cache[name].nil?
-
-      args = @methods_to_cache.delete(name)
-
-      define_method "#{name}_cached" do
-        cache_key = "cachethod.#{self.class.to_s.underscore}-#{id}.#{name}"
-
-        Rails.cache.fetch(cache_key, *args) do
-          send("#{name}!")
-        end
-      end
-
-      alias_method "#{name}!", name
-      alias_method name, "#{name}_cached"
-    end
-  end
-end

data/lib/tasks/cachethod_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :cachethod do
-#   # Task goes here
-# end