michie 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6ef1a836a13383202e735dd16366a9e171183bf8405f25bfb812d68560155b
-  data.tar.gz: c343ea5eb201adaea073ac2406a87d0a570b2adc7c93d93c8ace4473ae9e118c
+  metadata.gz: 40d6d7b81b0093d54b3a6f19f1c0581fa5f4033370a68824ae06a82e4dc4e6b9
+  data.tar.gz: 3799a5eab4afe92769e1e7e83c2de26f3ce3b96df4880befd51d084a5b43b36e
 SHA512:
-  metadata.gz: 0162b216d0e66f5ea0ef7d4925f51063bc7cd73b48e02444fa9bdd42e9a29db045d7dc5a84c7a0c4a8dd4495fcbd03c471eed860d0628778f83d6afbf6011e95
-  data.tar.gz: 79eeae6b562a5973534ce7d80aaa1f2385e72311c67a87ebe1abc30ef201b32a08864296dc8060f6de1d451f7b2c263a24e0768aa96784f9ee4d8197033cc51b
+  metadata.gz: 8e4d1e6eef0910a3754c32bc98422fb0e797f3295e138fa09e7d891f219ceca4cad73fb8e9ce5dd529246855cd805d3171a33b17663de66b86e4f6c96eddc206
+  data.tar.gz: 4d65ac8ec4d97603fcf8d4db99119b3f40a1860637f9e677383dc1a1bcdcf2dbcf39f22bd1d23ae4a59dc7bc800c21602747233b57e3d59573b7f809c5a3c1ee

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Michie Changelog
+
+## 0.x
+
+### 0.2.0
+
+- Support passing method names to `memoize`
+- Use method type prefix to avoid instance variable name collisions
+
+### 0.1.0
+
+Initial release.

data/README.md

@@ -1,8 +1,15 @@
 # Michie
 
-Michie (pronounced /ˈmɪki/, like “Mickey”) memoizes methods defined in a block.
-Unlike other meomization libraries, Michie encapsulates its memoization in
-a single module which it prepends over the original method.
+[![Gem Version](https://badge.fury.io/rb/michie.svg)][gem]
+[![Build Status](https://github.com/shioyama/michie/actions/workflows/ruby.yml/badge.svg)][actions]
+
+[gem]: https://rubygems.org/gems/michie
+[actions]: https://github.com/shioyama/michie/actions
+
+Michie (pronounced /ˈmɪki/, like “Mickey”) memoizes methods either passed by
+method name or defined in a block. Unlike other meomization libraries, Michie
+encapsulates its memoization in a single module which it prepends over the
+original method.
 
 ## Usage
 
@@ -15,10 +22,26 @@ class BillingApi
 
   memoize do
     def fetch_aggregate_data
-	  # returns all data from remote server
-	end
+      # returns all data from remote server
+    end
   end
 end
+```
+
+Alternatively, you can pass the method name(s) to `memoize` after they have
+been defined:
+
+```ruby
+class BillingApi
+  extend Michie
+
+  def fetch_aggregate_data
+	# returns all data from remote server
+  end
+  memoize :fetch_aggregate_data
+end
+```
+
 
 api = BillingApi.new
 api.fetch_aggregate_data
@@ -56,9 +79,12 @@ def fetch_aggregate_data
 end
 ```
 
-By default, Michie prepends `__michie_` to the method name to generate the
-instance variable name. This can be changed by passing a `prefix` option to
-`memoize` (see specs for details).
+By default, Michie generates an instance variable name prefix combining a
+"base" string `__michie_` with either an `m_` (normal methods), `b_` (bang
+methods ending in `!`) or `q_` (query methods ending in `?`). This prefix is
+combined with the method name of the method to be memoized to generate the
+instance variable name.  The base prefix can be changed by passing a `prefix`
+option to `memoize` (see specs for details).
 
 Since Michie uses the presence of an instance variable to signal memoization,
 `false` and `nil` values can be memoized (unlike techniques which use `||=`).
@@ -74,8 +100,8 @@ class BillingApi
 
   memoize(eager: true) do
     def fetch_aggregate_data
-	  # returns all data from remote server
-	end
+      # returns all data from remote server
+    end
   end
 end
 

data/lib/michie/version.rb

@@ -1,3 +1,3 @@
 module Michie
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/michie.rb

@@ -4,10 +4,16 @@ require "michie/version"
 module Michie
   DEFAULT_IVAR_PREFIX = "__michie"
 
-  def memoize(eager: false, prefix: DEFAULT_IVAR_PREFIX, &block)
-    methods_before = instance_methods(false) + private_instance_methods(false)
-    block.call
-    methods_to_memoize = instance_methods(false) + private_instance_methods(false) - methods_before
+  def memoize(*args, eager: false, prefix: DEFAULT_IVAR_PREFIX)
+    if block_given? && !args.empty?
+      raise ArgumentError, "memoize takes method names or a block defining methods, not both."
+    elsif block_given?
+      methods_before = instance_methods(false) + private_instance_methods(false)
+      yield
+      methods_to_memoize = instance_methods(false) + private_instance_methods(false) - methods_before
+    elsif !args.empty?
+      methods_to_memoize = args
+    end
 
     memoizer = eager ? EagerMemoizer : Memoizer
 
@@ -67,13 +73,15 @@ module Michie
 
   module Helpers
     def ivar_name(method_name, memoization_prefix)
-      string = "#{memoization_prefix}_#{method_name.to_s}"
+      string = String === method_name ? method_name.dup : method_name.to_s
+      method_type_prefix = "m"
 
-      if string.end_with?("?", "!")
-        string = string.dup
-        string.sub!(/\?\Z/, "_query") || string.sub!(/!\Z/, "_bang")
+      if string.chomp!("?")
+        method_type_prefix = "q"
+      elsif string.chomp!("!")
+        method_type_prefix = "b"
       end
-      "@#{string}"
+      "@#{memoization_prefix}_#{method_type_prefix}_#{string}"
     end
     module_function :ivar_name
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: michie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt