lite-memoize 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a2e51485362684ce1520b7eca9484106b5b83c9bc6336b2215dcffa6d56cfed
-  data.tar.gz: 43eb2cd5cb4330f12a503f3b66594b6a0c076bb1a0a991a0735bef1c11fd3cb6
+  metadata.gz: 764d8311718bd18bada8e3f63104f1e81f9e300a995dbac0f61a41ded9706cd0
+  data.tar.gz: 9d6abb3e67c30129a3e9401fbdb1f213238991ccf9a636a0f889260081a29dd2
 SHA512:
-  metadata.gz: b082b4804dbcedb965b006b0077375195316720d7397b5ed0140b5ae0de8847706d3503e8ca9f33f7c6ce064a0d79c2ff6f25a57a06e3a458ee2506e0f623436
-  data.tar.gz: 0dc03f302a930483a8ca51f114e80b6ed36506153bf1840f0ddcfb221404acd1f307dc77ae1dcf8f4a0a60970513d382954180cb70e49928d7727a41dcdcf48c
+  metadata.gz: c34cde89e7350fb9d95d111924b90045ec0927d4f2f997623dba9ac28d794a06be10136cdc71e1f621f19f763af73a3688a7c983c7f651bfa10ee3c610266589
+  data.tar.gz: 4491d5d262bb90fcbc15a951f99bfeefc7ffa7631a4326f5037de0c5ca2016fa8f9b671f8575f16d5aea23c0ecda3d0a60d56e82d035ca0624c37cc13bc938ed

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.2] - 2019-08-07
+### Added
+- Added variable base memoization
+### Changed
+- Renamed mixin to table
+- Changed caller_key method to private
+
 ## [1.0.1] - 2019-07-18
 ### Added
 - Added alias memoization
@@ -13,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Improved speed of key generation and lookup for instance
 - Changed refresh arg to reload
-- Renamed shared to mixin
+- Renamed shared to table
 
 ## [1.0.0] - 2019-06-24
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-memoize (1.0.1)
+    lite-memoize (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/lite-memoize.svg)](http://badge.fury.io/rb/lite-memoize)
 [![Build Status](https://travis-ci.org/drexed/lite-memoize.svg?branch=master)](https://travis-ci.org/drexed/lite-memoize)
 
-Lite::Memoize provides an API for caching and memoizing locally expensive calculations including those with parameters. The flexible API allows you to memoize results using alias, class, instance, or mixin level cache.
+Lite::Memoize provides an API for caching and memoizing locally expensive calculations including those with parameters. The flexible API allows you to memoize results using alias, class, instance, table, or variable based cache.
 
 **NOTE:** If you are coming from `ActiveMemoize`, please read the [port](#port) section.
 
@@ -28,13 +28,14 @@ Or install it yourself as:
 * [Alias](#alias)
 * [Klass](#klass)
 * [Instance](#instance)
-* [Mixin](#mixin)
+* [Table](#table)
+* [Variable](#variable)
 * [Benchmarks](#benchmarks)
 * [Port](#port)
 
 ## Alias
 
-Alias level memoization is the fastest of the available methods, and provides a decent level
+Alias based memoization is the fastest of the available methods, and provides a decent level
 of control. It's the only one that can also be used to memoize class level methods. Method
 arguments are automatically watched to cache dynamic values.
 
@@ -58,7 +59,9 @@ class Movies
     HTTP.get('http://movies.com/any')
   end
 
+  # NOTE: memoize must be before alias
   memoize :random
+  alias rando random
 
   def search(title)
     HTTP.get("http://movies.com?title=#{title}")
@@ -78,7 +81,7 @@ Movies.clear_cache #=> New value
 
 ## Klass
 
-Class level memoization is the quickest way to get up without polluting your class with new methods.
+Class based memoization is the quickest way to get up without polluting your class with new methods.
 It's perfect for short lived or non-altering items like `activerecord` objects.
 
 You can only cache results without access to any information about the `store`.
@@ -91,7 +94,9 @@ class Movies
     HTTP.get('http://movies.com/any')
   end
 
+  # NOTE: memoize must be before alias
   memoize :random
+  alias rando random
 
   def search(title)
     HTTP.get("http://movies.com?title=#{title}")
@@ -104,11 +109,11 @@ end
 
 ## Instance
 
-Instance level memoization is the slowest of the available methods, but it provides
+Instance based memoization is the slowest of the available methods, but it provides
 the most amount of flexibility and control. It's very useful for creating services or things
-where control is paramount like clearing the cache or dumping it to JSON. Please read the spec
-suite to see all available actions. Method arguments are automatically watched to cache dynamic
-values.
+where control is paramount like clearing the cache or dumping it to JSON. Method arguments
+are automatically watched to cache dynamic values. Please read the spec suite to see all
+available actions.
 
 You can access almost all methods in the `instance.rb` file.
 
@@ -128,6 +133,8 @@ class Movies
     cache['random'] ||= HTTP.get("http://movies.com/any?type=#{type}")
   end
 
+  alias rando random
+
   # NOTE: Arguments in the memoize method are optional
   def search(title)
     cache.memoize(as: :find, args: [title], reload: !cache.empty?) do
@@ -138,21 +145,47 @@ class Movies
 end
 ```
 
-## Mixin
+## Variable
+
+Variable based memoization is lean but pollute the class with variables.
+
+```ruby
+class Movies
+  include Lite::Memoize::Variable
+
+  def all
+    memoize(:all) { HTTP.get("http://movies.com/all") }
+  end
+
+  alias full all
+
+  # NOTE: Arguments in the memoize method are optional with the exception of method name
+  def search(title)
+    memoize(:find, args: [title], reload: false) do
+      HTTP.get("http://movies.com?title=#{title}")
+    end
+  end
+
+end
+```
+
+## Table
 
-Mixin level memoization is the leanest of the available methods, and provides a decent level
+Table based memoization is the leanest of the available methods, and provides a decent level
 of control. Useful when you want to keep your class light weight.
 
 You can access all methods to the `Hash` class.
 
 ```ruby
 class Movies
-  include Lite::Memoize::Mixin
+  include Lite::Memoize::Table
 
   def all
     memoize(:all) { HTTP.get("http://movies.com/all") }
   end
 
+  alias full all
+
   # NOTE: Arguments in the memoize method are optional with the exception of method name
   def search(title)
     memoize(:find, args: [title], reload: false) do
@@ -165,9 +198,9 @@ end
 
 ## Benchmarks
 
-The classes ranked from fastest to slowest are `Alias`, `Mixin`, `Klass`, and `Instance`.
+The classes ranked from fastest to slowest are `Alias`, `Table`, `Klass`, `Variable`, and `Instance`.
 
-View all how it compares to other libs by running the [benchmarks](https://github.com/drexed/lite-statistics/tree/master/benchmarks).
+View how each compares to other libs by running the [benchmarks](https://github.com/drexed/lite-statistics/tree/master/benchmarks).
 
 ## Port
 

data/benchmarks/base.rb

@@ -41,9 +41,19 @@ class LiteMemoizeKlassCache
 
 end
 
-class LiteMemoizeMixinCache
+class LiteMemoizeTableCache
 
-  include Lite::Memoize::Mixin
+  include Lite::Memoize::Table
+
+  def randomize
+    memoize(:randomize) { rand(1..99) }
+  end
+
+end
+
+class LiteMemoizeVariableCache
+
+  include Lite::Memoize::Variable
 
   def randomize
     memoize(:randomize) { rand(1..99) }

data/benchmarks/memery.rb

@@ -15,8 +15,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemeryCache.new
 
 Benchmark.ips do |x|
@@ -28,7 +29,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -36,6 +37,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memery') do
     klass_z.randomize
   end

data/benchmarks/memist.rb

@@ -15,8 +15,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemistCache.new
 
 Benchmark.ips do |x|
@@ -28,7 +29,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -36,6 +37,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memist') do
     klass_z.randomize
   end

data/benchmarks/memo-it.rb

@@ -15,8 +15,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemoitCache.new
 
 Benchmark.ips do |x|
@@ -28,7 +29,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -40,5 +41,9 @@ Benchmark.ips do |x|
     klass_z.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.compare!
 end

data/benchmarks/memoist.rb

@@ -17,8 +17,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemoistCache.new
 
 Benchmark.ips do |x|
@@ -30,7 +31,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -38,6 +39,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memoist') do
     klass_z.randomize
   end

data/benchmarks/memoist2.rb

@@ -17,8 +17,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = Memoist2Cache.new
 
 Benchmark.ips do |x|
@@ -30,7 +31,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -38,6 +39,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memoist2') do
     klass_z.randomize
   end

data/benchmarks/memoit.rb

@@ -13,8 +13,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemoitCache.new
 
 Benchmark.ips do |x|
@@ -26,7 +27,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -34,6 +35,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memoit') do
     klass_z.randomize
   end

data/benchmarks/memoizable.rb

@@ -17,8 +17,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemoizableCache.new
 
 Benchmark.ips do |x|
@@ -30,7 +31,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -38,6 +39,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memoizable') do
     klass_z.randomize
   end

data/benchmarks/memoizer.rb

@@ -17,8 +17,9 @@ end
 
 klass_a = LiteMemoizeInstanceCache.new
 klass_b = LiteMemoizeKlassCache.new
-klass_c = LiteMemoizeMixinCache.new
+klass_c = LiteMemoizeTableCache.new
 klass_d = LiteMemoizeAliasCache.new
+klass_e = LiteMemoizeVariableCache.new
 klass_z = MemoizerCache.new
 
 Benchmark.ips do |x|
@@ -30,7 +31,7 @@ Benchmark.ips do |x|
     klass_b.randomize
   end
 
-  x.report('LM.mixin') do
+  x.report('LM.table') do
     klass_c.randomize
   end
 
@@ -38,6 +39,10 @@ Benchmark.ips do |x|
     klass_d.randomize
   end
 
+  x.report('LM.variable') do
+    klass_e.randomize
+  end
+
   x.report('Memoizer') do
     klass_z.randomize
   end

data/lib/lite/memoize.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-%w[version alias mixin instance klass].each do |name|
+%w[version alias table instance klass variable].each do |name|
   require "lite/memoize/#{name}"
 end

data/lib/lite/memoize/instance.rb

@@ -4,7 +4,7 @@ module Lite
   module Memoize
     class Instance
 
-      include Lite::Memoize::Mixin
+      include Lite::Memoize::Table
 
       def initialize; end
 

data/lib/lite/memoize/klass.rb

@@ -4,7 +4,7 @@ module Lite
   module Memoize
     module Klass
 
-      include Lite::Memoize::Mixin
+      include Lite::Memoize::Table
 
       def memoize(method_name, as: nil)
         inner_method = instance_method(method_name)
@@ -16,6 +16,10 @@ module Lite
         end
       end
 
+      # rubocop:disable Style/AccessModifierDeclarations
+      public :caller_key
+      # rubocop:enable Style/AccessModifierDeclarations
+
     end
   end
 end

data/lib/lite/memoize/{mixin.rb → table.rb}

@@ -2,22 +2,12 @@
 
 module Lite
   module Memoize
-    module Mixin
+    module Table
 
       def store
         @_memoized_methods ||= {}
       end
 
-      def caller_key(block, as: nil)
-        name = as ? [as] : block.source_location
-        return name.concat(block) if block.is_a?(Array)
-
-        block.binding.local_variables.each_with_object(name) do |local_name, array|
-          array << local_name
-          array << block.binding.local_variable_get(local_name)
-        end
-      end
-
       def memoize(method_name, args: nil, reload: false)
         key = "#{method_name}:#{args}"
 
@@ -28,6 +18,18 @@ module Lite
         end
       end
 
+      private
+
+      def caller_key(block, as: nil)
+        name = as ? [as] : block.source_location
+        return name.concat(block) if block.is_a?(Array)
+
+        block.binding.local_variables.each_with_object(name) do |local_name, array|
+          array << local_name
+          array << block.binding.local_variable_get(local_name)
+        end
+      end
+
     end
   end
 end

data/lib/lite/memoize/variable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lite
+  module Memoize
+    module Variable
+
+      def memoize(method_name, args: nil, reload: false)
+        key = "#{method_name}#{args}"
+        var = "@#{key.gsub(/\W/, '') || key}"
+        return instance_variable_get(var) if !reload && instance_variable_defined?(var)
+
+        instance_variable_set(var, yield)
+      end
+
+    end
+  end
+end

data/lib/lite/memoize/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Memoize
 
-    VERSION ||= '1.0.1'
+    VERSION ||= '1.0.2'
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-memoize
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,8 @@ files:
 - lib/lite/memoize/alias.rb
 - lib/lite/memoize/instance.rb
 - lib/lite/memoize/klass.rb
-- lib/lite/memoize/mixin.rb
+- lib/lite/memoize/table.rb
+- lib/lite/memoize/variable.rb
 - lib/lite/memoize/version.rb
 - lite-memoize.gemspec
 homepage: http://drexed.github.io/lite-memoize