fond_memos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fab41ba233662d68f3dc0e9cea0a29b691e5efec
+  data.tar.gz: 8112df52db2be08a8b591b98609f6fd47077dcd6
+SHA512:
+  metadata.gz: ff99433ecdf8520d0b7d19e5bd55604af60a1ad967384e633fb8828e40f29f0d4372e3c498c7f7b54e6026297a62f2dd4dffca1257242ed583f6e94d76b574cc
+  data.tar.gz: 2e3deafa27a396e5022dd61570ae30e8bd217fd3a946962ca88f0f3c243f70317bfaf4f90a75fec8d1991f1268c6ee82e4fa82e5c6c8c02f663efd0636b8656e

data/lib/fond_memos.rb

@@ -0,0 +1,85 @@
+require 'fond_memos/version'
+
+# Include this module in classes that have methods you want to memoize. It is
+# very simple, so skim through the code before you use it just to feel extra
+# secure in using it, and also to help me find any bugs.
+#
+# Eg:
+#
+# Class Foo
+#   include FondMemos
+#
+#   def bar
+#     # expensive calculation
+#   end
+#   memoize :bar
+# end
+
+# foo = Foo.new
+# foo.bar  # expensive
+# foo.bar  # fast
+# foo.forget(:bar)
+# foo.bar  # expensive again (why did you forget?)
+# foo.bar  # fast again (that's better)
+#
+# If you memoize a method with arguments, the #hash method will be called on
+# each argument to generate a key to use in FondMemo's internal hash.
+# To ensure safe and responsible memoizing, it is strongly encouraged to ensure
+# your memoized method arguments have logical hash values.
+#
+# May you always have fond memos of using this gem!
+module FondMemos
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # Calling this will remove the caching instance variable for the method.
+  # In the case of multi argument methods, all values will be forgotten.
+  # @param method [Symbol] the method to forget
+  def forget(method)
+    remove_instance_variable(Internal.var_name(method))
+  end
+
+  private
+
+  def _fond_fetch(var_name, original_method)
+    return instance_variable_get(var_name) if instance_variable_defined?(var_name)
+    instance_variable_set(var_name, original_method.bind(self).call)
+  end
+
+  def _fond_multi_fetch(var_name, original_method, args)
+    instance_variable_set(var_name, {}) unless instance_variable_defined?(var_name)
+    hash = instance_variable_get(var_name)
+    key = args.map(&:hash)
+    if hash.key?(key)
+      hash[key]
+    else
+      hash[key] = original_method.bind(self).call(*args)
+    end
+  end
+
+  #:nodoc:
+  module ClassMethods
+    # Add memoization for the listed methods
+    # @param methods [Array<Symbol>] the methods to memoize
+    def memoize(*methods)
+      methods.each do |m|
+        original_method = instance_method(m)
+        var_name = Internal.var_name(original_method.name)
+        undef_method(m)
+        if original_method.arity.zero?
+          define_method(m) { _fond_fetch(var_name, original_method) }
+        else
+          define_method(m) { |*args| _fond_multi_fetch(var_name, original_method, args) }
+        end
+      end
+    end
+  end
+
+  #:nodoc:
+  module Internal
+    def self.var_name(method)
+      "@memoized_#{method}".to_sym
+    end
+  end
+end

data/lib/fond_memos/version.rb

@@ -0,0 +1,3 @@
+module FondMemos
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fond_memos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: Memoization so simple you could have written it. But I did, so you don't
+  have to.
+email:
+- matt.clark.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fond_memos.rb
+- lib/fond_memos/version.rb
+homepage: https://github.com/mclark/fond_memos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple, effective memoization.
+test_files: []