michie 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f6ef1a836a13383202e735dd16366a9e171183bf8405f25bfb812d68560155b
+  data.tar.gz: c343ea5eb201adaea073ac2406a87d0a570b2adc7c93d93c8ace4473ae9e118c
+SHA512:
+  metadata.gz: 0162b216d0e66f5ea0ef7d4925f51063bc7cd73b48e02444fa9bdd42e9a29db045d7dc5a84c7a0c4a8dd4495fcbd03c471eed860d0628778f83d6afbf6011e95
+  data.tar.gz: 79eeae6b562a5973534ce7d80aaa1f2385e72311c67a87ebe1abc30ef201b32a08864296dc8060f6de1d451f7b2c263a24e0768aa96784f9ee4d8197033cc51b

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in michie.gemspec
+gemspec
+
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    michie (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (10.5.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  michie!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Salzberg
+
+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.
+
+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/README.md

@@ -0,0 +1,99 @@
+# 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.
+
+## Usage
+
+Simply extend a class with `Michie` and define methods in a block passed to the
+`memoize` method:
+
+```ruby
+class BillingApi
+  extend Michie
+
+  memoize do
+    def fetch_aggregate_data
+	  # returns all data from remote server
+	end
+  end
+end
+
+api = BillingApi.new
+api.fetch_aggregate_data
+#=> (calls original #fetch_aggregate_data method, fetching and returning data from server)
+
+api.fetch_aggregate_data
+#=> returns value memoized by Michie
+```
+
+Unlike other memoization libraries which use `alias_method` to reference the
+original method, leaving artifacts in the including class, memoization in
+Michie is encapsulated in a module.
+
+This module is dynamically created and prepended by `Michie#memoize`:
+
+```ruby
+BillingApi.ancestors
+#=> [<#Michie::Memoizer (methods: fetch_aggregate_data)>, BillingApi, Object, PP::ObjectMixin, Kernel, BasicObject]
+
+memoizer = BillingApi.ancestors[0]
+memoizer.instance_methods(false)
+#=> [:fetch_aggregate_data]
+```
+
+The memoizer method uses an instance variable to memoize the value returned
+from the original method, and calls the original method with `super`:
+
+```ruby
+def fetch_aggregate_data
+  return @__michie_fetch_aggregate_data if defined?(@__michie_fetch_aggregate_data)
+
+  result = super
+  @__michie_fetch_aggregate_data = result
+  result
+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).
+
+Since Michie uses the presence of an instance variable to signal memoization,
+`false` and `nil` values can be memoized (unlike techniques which use `||=`).
+Michie also respects method visibility, so you can use it to memoize your
+private and protected methods.
+
+Passing `eager: true` to `memoize` will eagerly call all methods defined in the
+`memoize` block as soon as an instance is created:
+
+```ruby
+class BillingApi
+  extend Michie
+
+  memoize(eager: true) do
+    def fetch_aggregate_data
+	  # returns all data from remote server
+	end
+  end
+end
+
+api = BillingApi.new
+# `fetch_agregate_data` has already been memoized
+```
+
+Beware that Michie does not memoize methods that take arguments; this is
+a design decision to make the code as simple and readable as possible.
+
+## Reference
+
+The gem is named after [Donald
+Michie](https://en.wikipedia.org/wiki/Donald_Michie) (1923-2007), the British AI
+researcher who invented memoization. Not to be confused with a [Rust memoization
+library](https://docs.rs/michie/latest/michie/) with the same name.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/michie/version.rb

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

data/lib/michie.rb

@@ -0,0 +1,80 @@
+# frozen-string-literal: true
+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
+
+    memoizer = eager ? EagerMemoizer : Memoizer
+
+    prepend(memoizer.new(methods_to_memoize, prefix))
+  end
+
+  class Memoizer < Module
+    def initialize(methods_to_memoize, prefix)
+      methods_to_memoize.each do |method_name|
+        define_memoized_method(method_name, prefix)
+      end
+    end
+
+    def define_memoized_method(method_name, prefix)
+      ivar = Helpers.ivar_name(method_name, prefix)
+      module_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{method_name}
+          return #{ivar} if defined?(#{ivar})
+
+          result = super
+          #{ivar} = result
+          result
+        end
+      EOM
+    end
+
+    def inspect
+      "<##{self.class} (methods: #{instance_methods(false).join(", ")})>"
+    end
+
+    def prepended(klass)
+      memoized_methods = instance_methods(false)
+      (klass.protected_instance_methods(false) & memoized_methods).each do |method_name|
+        protected method_name
+      end
+      (klass.private_instance_methods(false) & memoized_methods).each do |method_name|
+        private method_name
+      end
+    end
+  end
+
+  class EagerMemoizer < Memoizer
+    def prepended(klass)
+      klass.include(Initializer)
+    end
+
+    module Initializer
+      def initialize(*, &block)
+        super
+
+        self.class.ancestors.grep(EagerMemoizer).each do |mod|
+          mod.instance_methods(false).each { |m| send(m) }
+        end
+      end
+    end
+  end
+
+  module Helpers
+    def ivar_name(method_name, memoization_prefix)
+      string = "#{memoization_prefix}_#{method_name.to_s}"
+
+      if string.end_with?("?", "!")
+        string = string.dup
+        string.sub!(/\?\Z/, "_query") || string.sub!(/!\Z/, "_bang")
+      end
+      "@#{string}"
+    end
+    module_function :ivar_name
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: michie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Salzberg
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Michie allows you to memoize methods simply by defining them in a block.
+email:
+- chris@dejimata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/michie.rb
+- lib/michie/version.rb
+homepage: https://github.com/shioyama/michie
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shioyama/michie
+  source_code_uri: https://github.com/shioyama/michie
+  changelog_uri: https://github.com/shioyama/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Memoization done right.
+test_files: []