mememaster 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bcf13cc28b811ea862a086b245ba3afea86508a
-  data.tar.gz: 7d7d3978c858911c49f4e12d43c530f2f11113f9
+  metadata.gz: f86a8254a0324977fdc2e8bbc3445c381dd2cd66
+  data.tar.gz: d4565c572fcf4cc4c56674cd2439dc07400a1378
 SHA512:
-  metadata.gz: 9dc8905bb4337c2e32de615e9455a1bef0ce47956ca0797f5095a423c16d64366eaf60541d6393d1b9863588018b12786548280333bc78a8c9397ef116aa83e4
-  data.tar.gz: 67168fe1cff5a1be817cdbb45054874c20abe4e71714c9b6c42703543c7bb6193cb66d754f1c27a0b08169bc84743c127c869e606700e58b863ab7636e7fec76
+  metadata.gz: ef80f3eda31417cb2434d19931b2791c2fc88b1ff9edf928aa43431b11494b70469f2a4d27bb0bfe8368d0e3676dda32aacd9d03277c561d4259c04967dbeee7
+  data.tar.gz: 30756beeec5adcd58b712d8cae08fd9f28f6963b5100b251684322bfb85b7e5e6d579454fb1624c74464d8ceed8106520b605516e6e3003d528d383739ca4bd6

data/README.md

@@ -2,8 +2,12 @@
 
 Mememaster is a gem for memoization in Ruby. Example:
 
+## Usage
+
 ```ruby
 class A
+  include Mememaster
+
   memoize def call
     puts "calculating"
     42
@@ -16,17 +20,18 @@ class A
   # memoize :call
 end
 
-A.new.call # => 42
-A.new.call # => 42
-A.new.call # => 42
+a = A.new
+a.call # => 42
+a.call # => 42
+a.call # => 42
 
 # Text will be printed only once.
 ```
 
-## Features
-Mememaster is very similar to [Memoist](https://github.com/matthewrudy/memoist). The difference is that it doesn't override methods, instead it uses Ruby 2 `Module.prepend` feature. This approach is cleaner and it allows subclasses' methods to work properly: by default, if you redefine a memoized method in a subclass, it's not memoized by default, but you can memoize it normally (without using awkward `identifier: ` argument) and it will just work.
+## Difference with other gems
+Mememaster is very similar to [Memoist](https://github.com/matthewrudy/memoist). The difference is that it doesn't override methods, instead it uses Ruby 2 `Module.prepend` feature. This approach is cleaner and it allows subclasses' methods to work properly: if you redefine a memoized method in a subclass, it's not memoized by default, but you can memoize it normally (without using awkward `identifier: ` argument) and it will just work.
 
-The other key difference is that it doesn't change method's signature (no extra `reload` param). If you need unmemoized version of method, just make it like this:
+The other key difference is that it doesn't change method's signature (no extra `reload` param). If you need unmemoized result of method, just create an unmemoized version like this:
 
 ```ruby
 memoize def users
@@ -38,6 +43,12 @@ def get_users
 end
 ```
 
+Alternatively, you can clear the whole instance's cache:
+
+```ruby
+a.clear_mememaster_cache!
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/mememaster.rb

@@ -3,6 +3,11 @@
 require "mememaster/version"
 
 module Mememaster
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+  end
+
   def self.method_visibility(klass, method_name)
     case
     when klass.private_method_defined?(method_name)
@@ -14,38 +19,46 @@ module Mememaster
     end
   end
 
-  def memoize(method_name)
-    prepend_mememaster_module!
-    define_memoized_method!(method_name)
-  end
+  module ClassMethods
+    def memoize(method_name)
+      prepend_mememaster_module!
+      define_memoized_method!(method_name)
+    end
 
-  private
+    private
 
-  def prepend_mememaster_module!
-    return if defined?(@_mememaster_module)
-    @_mememaster_module = Module.new
-    prepend @_mememaster_module
-  end
+    def prepend_mememaster_module!
+      return if defined?(@_mememaster_module)
+      @_mememaster_module = Module.new
+      prepend @_mememaster_module
+    end
 
-  def define_memoized_method!(method_name)
-    mod_id = @_mememaster_module.object_id
-    visibility = Mememaster.method_visibility(self, method_name)
+    def define_memoized_method!(method_name)
+      mod_id = @_mememaster_module.object_id
+      visibility = Mememaster.method_visibility(self, method_name)
 
-    @_mememaster_module.module_eval do
-      define_method(method_name) do |*args|
-        @_mememaster_memoized_values ||= {}
+      @_mememaster_module.module_eval do
+        define_method(method_name) do |*args|
+          @_mememaster_memoized_values ||= {}
 
-        key = [method_name, mod_id].join("_").to_sym
-        store = @_mememaster_memoized_values[key] ||= {}
+          key = [method_name, mod_id].join("_").to_sym
+          store = @_mememaster_memoized_values[key] ||= {}
 
-        if store.key?(args)
-          store[args]
-        else
-          store[args] = super(*args)
+          if store.key?(args)
+            store[args]
+          else
+            store[args] = super(*args)
+          end
         end
+
+        send(visibility, method_name)
       end
+    end
+  end
 
-      send(visibility, method_name)
+  module InstanceMethods
+    def clear_mememaster_cache!
+      @_mememaster_memoized_values = {}
     end
   end
 end

data/lib/mememaster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mememaster
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mememaster
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuri Smirnov