pakiderm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5dbcfdc6c5fa18f286ce21d37b5b9560747a8e3
+  data.tar.gz: 5c295331e64db36225eb9554e8ef488d1756d446
+SHA512:
+  metadata.gz: 27c60daed7867e398ee9412cabc17724509aac0498a354d25fc9873bbda9fc3b784e5e038173c5eb5757572228c16010cea8e7e4c48b621f1c6903e525d24f9b
+  data.tar.gz: 262c3402e1d6dc60c650994050c6af51e9957af9d64506216638069478a65640cf0cf3b1599a46533d036ecb8664a1dac429c969f6b43d6ce623957ec5519e9b

data/README.md

@@ -0,0 +1,41 @@
+Pakiderm
+=====================
+
+Allows you to memoize simple methods and works only on ruby 2.0.
+
+## Usage
+```ruby
+class Counter
+  extend Pakiderm
+
+  def increment
+    @sum = 1 + @sum.to_i
+  end
+
+  memoize :increment
+end
+```
+Your method will only be called the first time, the result will be stored and returned on subsequent invocations.
+```irb
+counter = Counter.new
+=> Counter
+
+counter.increment
+=> 1
+
+counter.increment
+=> 1
+
+counter.increment = 5
+=> 5
+
+counter.increment
+=> 5
+```
+As you can see, it also provides an assignment operator, so you can override the memoized value :smiley:.
+
+## Background
+Pakiderm uses Module#prepend to add the memoized method before yours in the method lookup path of your class. Your method is called by using 'super', because the class is an ancestor to the prepended module.
+
+### Corolary
+If you override a memoized method in a derived class, you alter the method chain, so the derived method won't be memoized unless you invoke memoize in the derived class as well.

data/lib/pakiderm.rb

@@ -0,0 +1,88 @@
+# Public: Mixin that adds memoization functionality to a plain ruby object.
+# Memoization is selectively applied to methods by using the `memoize` method.
+#
+# Examples
+#
+#   class PersonQuery
+#     extend Pakiderm
+#     def recent_activity
+#       NSA.get("/api/#{person.id}")
+#     end
+#     memoize :recent_activity
+#   end
+#
+module Pakiderm
+
+  # Public: Adds memoization to methods without parameters. Can receive a
+  # single method name, or a list of methods, and an :assignable option that
+  # when true will create an assignment method to modify the memoized value.
+  #
+  # names - Names of the methods to be memoized. Can take a hash of options as
+  #         the last parameter. Only valid option is :assignable.
+  #
+  # Examples
+  #
+  #   memoize :tired?, :complex_formula, :long_running_method!
+  #
+  #   memoize :meaning_of_life, assignable: true
+  #   # self.meaning_of_life = 42
+  #
+  # Returns nothing.
+  def memoize(*names)
+    assignable = names.last.is_a?(Hash) ? names.pop[:assignable] : false
+    memoized = Module.new
+    names.each do |name|
+      ivar = Pakiderm.memoized_ivar_for(name)
+      memoized.module_eval Pakiderm.memoized_method(name, ivar)
+      memoized.module_eval Pakiderm.assignment_method(name, ivar) if assignable
+    end
+    prepend memoized
+  end
+
+  # Internal: Generates a memoized method string.
+  #
+  # name - Name of the method to memoize.
+  #
+  # ivar - Name of the instance variable used to store the memoized result.
+  #
+  # Returns a String with the code of the memoized method.
+  def self.memoized_method(name, ivar)
+    <<-MEMOIZATION
+      def #{name}
+        unless #{ivar}
+          #{ivar} = [super]
+        end
+        #{ivar}[0]
+      end
+    MEMOIZATION
+  end
+
+  # Internal: Generates an assignment method for the memoized value.
+  #
+  # name - Name of the memoized method.
+  #
+  # ivar - Name of the instance variable used to store the memoized result.
+  #
+  # Returns a String with the code of the assignment method.
+  def self.assignment_method(name, ivar)
+    <<-ASSIGNMENT
+      def #{name}=(value)
+        #{ivar} = [value]
+      end
+    ASSIGNMENT
+  end
+
+  # Internal: Creates a valid instance variable name from a method name
+  #
+  # name - Name of the memoized method.
+  #
+  # Examples
+  #
+  #   Pakiderm.memoized_ivar_for(:empty?)
+  #   # => '@_memoized_empty_query'
+  #
+  # Returns a String with the code of the assignment method.
+  def self.memoized_ivar_for(name)
+    "@_memoized_#{name.to_s.sub(/\?$/, '_query').sub(/!$/, '_bang')}"
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: pakiderm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies: []
+description: Pakiderm is a simple module that encapsulates a modern memoization technique.
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/pakiderm.rb
+homepage: https://github.com/ElMassimo/pakiderm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pakiderm will never forget the return value.
+test_files: []
+has_rdoc: