cached_attr 0.1

data/README.md

@@ -0,0 +1,4 @@
+cache_attr
+==========
+
+Make a ruby object attribute cacheable

data/lib/cached_attr.rb

@@ -0,0 +1,115 @@
+# This module implements attributes whose reader method executes once, and the returned value is cached for later use.
+# This might be handy for expensive operations.
+#
+# An example, given the following method:
+#
+# def object_to_get
+#   if @object_to_get.nil?
+#     @object_to_get = [code_to_retrieve_object]
+#   end
+#   @object_to_get
+# end
+#
+# ...the cached attribute format would be:
+#
+# cache_attr :object_to_get do
+#   [code_to_retrieve_object]
+# end
+module CachedAttr
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # Defines an attribute on the including class.
+    #
+    # @param name [Symbol] the name of the attribute
+    # @param options [Hash] options
+    # @option options :writer if set to true, also define a writer method for the property
+    # @option options :ttl the time to live for a value. Ignored if nil or false
+    # @option options :method the method to call if no block is given
+    def cached_attr(name, options = {}, &block)
+      default_opts = {
+          :writer => false,
+          :method => false,
+          :ttl => false
+      }
+      opts = default_opts.merge(options)
+
+      class_eval do
+        internal_retrieve_method = "__internal_retrieve_#{name}".to_sym
+        define_method(internal_retrieve_method) do
+          if block.nil?
+            val = self.send(opts[:method])
+          else
+            val = self.instance_exec(&block)
+          end
+          cached_attributes_store[name][:invoke_count] += 1
+          val
+        end
+        internal_init_method = "__internal_init_#{name}".to_sym
+        define_method(internal_init_method) do |val = nil|
+          unless cached_attributes_store.has_key?(name)
+            cached_attributes_store[name] = {:call_count => 0, :invoke_count => 0}
+            if val.nil?
+              cached_attributes_store[name][:value] = self.send(internal_retrieve_method)
+              cached_attributes_store[name][:expires] = Time.now + opts[:ttl] if opts[:ttl]
+
+            else
+              cached_attributes_store[name][:value] = val
+            end
+          end
+          cached_attributes_store[name]
+        end
+
+
+        define_method("_#{name}_reset!".to_sym) do
+          cached_attributes_store.delete(name)
+        end
+
+        define_method("_#{name}_expires".to_sym) do
+          self.send(internal_init_method)[:expires]
+        end
+
+        define_method("_#{name}_call_count".to_sym) do
+          self.send(internal_init_method)[:call_count]
+        end
+
+        define_method("_#{name}_invoke_count".to_sym) do
+          self.send(internal_init_method)[:invoke_count]
+        end
+
+        define_method(name) do
+
+          cache_val = self.send(internal_init_method)
+
+          if opts[:ttl] && cache_val[:expires] && Time.now > cache_val[:expires]
+            cache_val[:value] = self.send(internal_retrieve_method)
+            cache_val[:expires] = Time.now + opts[:ttl]
+          end
+
+          cache_val[:call_count] = cached_attributes_store[name][:call_count] + 1
+          cache_val[:value]
+        end
+
+        if opts[:writer]
+          define_method("#{name}=") do |val|
+            self.send(internal_init_method, val)
+          end
+        end
+      end
+
+    end
+
+  end
+
+  #private
+
+  # The store of cached properties
+  def cached_attributes_store
+    @cached_attributes_store ||= {}
+  end
+
+end

data/spec/cached_attr_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe CachedAttr do
+
+  it "simple case" do
+    t = Test.new
+    5.times do
+      t.one.should == "1"
+    end
+    t._one_call_count.should == 5
+    t._one_invoke_count.should == 1
+  end
+
+  it "using TTL" do
+    t = Test.new
+    t.two.should == "2"
+    t._two_invoke_count.should == 1
+    sleep(3)
+    t.two.should == "2"
+    t._two_invoke_count.should == 2
+  end
+
+  it "using method call" do
+    t = Test.new
+    t.three.should == "3"
+  end
+
+  class Test
+    include CachedAttr
+
+    cached_attr :one do
+      "1"
+    end
+
+    cached_attr :two, :ttl => 2 do
+      "2"
+    end
+
+    cached_attr :three, :method => :three_impl
+
+    def three_impl
+      "3"
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'rspec/autorun'
+require 'simplecov'
+
+unless ENV['COVERAGE'] == 'no'
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require 'cached_attr'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cached_attr
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jerphaes van Blijenburgh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: Cacheable Ruby attributes
+email:
+- jerphaes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cached_attr.rb
+- README.md
+- spec/cached_attr_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jerphaes/cache_attr
+licenses:
+- Apache License 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Cacheable Ruby attributes
+test_files:
+- spec/cached_attr_spec.rb
+- spec/spec_helper.rb