pakiderm 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5dbcfdc6c5fa18f286ce21d37b5b9560747a8e3
-  data.tar.gz: 5c295331e64db36225eb9554e8ef488d1756d446
+  metadata.gz: 5a06111ba9f942e52a25123a6bd971bd9d589aee
+  data.tar.gz: 1c44ca4ae3fde3db92211845f9c9d17102929ce5
 SHA512:
-  metadata.gz: 27c60daed7867e398ee9412cabc17724509aac0498a354d25fc9873bbda9fc3b784e5e038173c5eb5757572228c16010cea8e7e4c48b621f1c6903e525d24f9b
-  data.tar.gz: 262c3402e1d6dc60c650994050c6af51e9957af9d64506216638069478a65640cf0cf3b1599a46533d036ecb8664a1dac429c969f6b43d6ce623957ec5519e9b
+  metadata.gz: f982969d4f44cdd49b75b7f51bcbd927578ffc25c085f776b464684acedf85332222db71c403d193594a92b60fb21f2f8d61c1220175f1ee93cf761e5268f9dc
+  data.tar.gz: 59ba25e547895beaa4d345b3ff7a1b9c14551e5671be21c67948590fafddd534dcbe14efaf3ff7354e6bad9d5f2f46869b52a475bcfe7fde26b434c08d0d4454

data/README.md

@@ -1,18 +1,23 @@
 Pakiderm
 =====================
 
-Allows you to memoize simple methods and works only on ruby 2.0.
+[![Gem Version](https://badge.fury.io/rb/pakiderm.svg)](http://badge.fury.io/rb/pakiderm)
+[![Build Status](https://travis-ci.org/ElMassimo/pakiderm.svg)](https://travis-ci.org/ElMassimo/pakiderm)
+[![Coverage Status](https://coveralls.io/repos/github/ElMassimo/pakiderm/badge.svg?branch=master)](https://coveralls.io/github/ElMassimo/pakiderm?branch=master)
+[![Inline docs](http://inch-ci.org/github/ElMassimo/pakiderm.svg)](http://inch-ci.org/github/ElMassimo/pakiderm)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/queryable/blob/master/LICENSE.txt)
+
+Allows you to unobtrusively memoize simple methods.
 
 ## Usage
 ```ruby
 class Counter
   extend Pakiderm
 
+  memoize \
   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.
@@ -25,17 +30,38 @@ counter.increment
 
 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:.
+You can also pass a list of methods that should be memoized:
+```ruby
+memoize :complex_calculation, :api_response, :db_query
+```
 
 ## 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.
+Pakiderm adds a method by using `Module#prepend` in order to"intercept" calls to the original method and provide memoization.
+
+### Caveat
+If you override the method in a subclass, Pakiderm's method won't be able to intercept calls to the subclass' method.
+
+License
+--------
+
+    Copyright (c) 2014 Máximo Mussini
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
 
-### 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.
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/pakiderm.rb

@@ -5,84 +5,46 @@
 #
 #   class PersonQuery
 #     extend Pakiderm
+#
+#     memoize \
 #     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.
+  # Public: Adds memoization to methods without parameters using Module#prepend.
   #
-  # names - Names of the methods to be memoized. Can take a hash of options as
-  #         the last parameter. Only valid option is :assignable.
+  # names - Names of the methods to be memoized.
   #
   # 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
+    prepend Module.new {
+      names.each do |name|
+        ivar = Pakiderm.memoized_ivar_for(name)
 
-  # 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]
+        define_method(name) {
+          if instance_variable_defined?(ivar)
+            instance_variable_get(ivar)
+          else
+            instance_variable_set(ivar, super())
+          end
+        }
       end
-    ASSIGNMENT
+    }
   end
 
-  # Internal: Creates a valid instance variable name from a method name
+  # Internal: Creates a valid name for the instance variable used to store the
+  # memoized value for a method.
   #
-  # name - Name of the memoized method.
-  #
-  # Examples
-  #
-  #   Pakiderm.memoized_ivar_for(:empty?)
-  #   # => '@_memoized_empty_query'
+  # name - Name of the method to memoize.
   #
-  # Returns a String with the code of the assignment method.
+  # Returns a String.
   def self.memoized_ivar_for(name)
-    "@_memoized_#{name.to_s.sub(/\?$/, '_query').sub(/!$/, '_bang')}"
+    "@pakiderm_#{ name.to_s.gsub('?', '_question_mark').sub('!', '_bang') }"
   end
 end

data/lib/pakiderm/version.rb

@@ -0,0 +1,3 @@
+module Pakiderm
+  VERSION = '2.0.0'
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pakiderm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
-dependencies: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Pakiderm is a simple module that encapsulates a modern memoization technique.
 email:
 - maximomussini@gmail.com
@@ -20,30 +34,29 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/pakiderm.rb
+- lib/pakiderm/version.rb
 homepage: https://github.com/ElMassimo/pakiderm
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 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
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pakiderm will never forget the return value.
 test_files: []
-has_rdoc: