fast_memoize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3f3508bb442a3b0d6970b52b6af6d1d14b21d2569a0716d4a43153deddc9dcb
+  data.tar.gz: '008bd110524e7a5eda61f4969446c0e9c8465312b8938d5e3283ca6bd4aad4c4'
+SHA512:
+  metadata.gz: afe861dd55bf3f16f233563562b9eb77bc6f1182c080349f81fdf847918462787b9595efabed24378f5903ecfbfdbcba2e8353caf241c9ba13e5c285b257ebc5
+  data.tar.gz: e8157d6da65cad13f81b7c27c3e898f37f0dae9ab9ec4335d6e681a64ea86748147027bd084278137abe7ccb7008fc7a1dbeb8e8f884d8834a5f4ca63e3154ed

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at david@tessellatestudio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fast_memoize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    fast_memoize (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (>= 2)
+  fast_memoize!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 David Furber
+
+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,115 @@
+# FastMemoize
+FastMemoize is a Ruby gem for memoization of method return values. The normal memoization in Ruby doesn't require any gems and looks like this:
+
+```ruby
+class Post
+  def user
+    @user ||= User.find(user_id)
+  end
+end
+```
+However, this approach doesn't work if calculated result can be nil or false or in case the method is using arguments. You will also require extra begin/end lines in case your method requires multiple lines:
+
+```ruby
+class Post
+  def user
+    @user ||= begin
+                user_id = calculate_id
+                klass = calculate_klass
+                klass.find(user_id) 
+              end
+  end
+end
+```
+
+But if `User.find` returns `nil` if the user can't be found, then repeated calls to the method will result in the `find` call being re-executed. The usual way around this is to add a `defined?` check at the top of the method:
+```ruby
+class Post
+  def user
+    return @user if defined?(@user)
+
+    @user = begin
+              user_id = calculate_id
+              klass = calculate_klass
+              klass.find(user_id) 
+            end
+  end
+end
+```
+By this time, your code has gotten pretty ugly just to make use of memoization. Not to mention the tedious typing out of all that extra code.
+
+So you'll find yourself skipping the memoization, or inlining code you would otherwise extract to a method because then it would be "memoized" in the variable. But then you end up with long methods and high complexity.
+
+For all these situations memoization gems (like this one) exist. The last example can be rewritten using fast_memoize like this:
+```ruby
+class Post
+  include FastMemoize
+  def user
+    some_id = calculate_id
+    klass = calculate_klass
+    klass.find(some_id)
+  end
+  memoize :user
+end
+```
+
+All of the memoization gems do something like this. But they also do a lot more. If you know what those things are, and you need them, then please use them. But if all you're looking for in a memoization gem is a shorthand for the `return @my_method if defined?(@my_method); @my_method = yada_yada` then this gem is for you. The performance improvement over the other memoization gems is noticeable (performing a trivival memoized operation 10,000 times with each gem):
+```
+       user     system      total        real
+Memery
+0.024411   0.002062   0.026473 (  0.026478)
+Memoist
+0.013781   0.000000   0.013781 (  0.013796)
+Memoizable
+0.041890   0.000000   0.041890 (  0.041913)
+FastMemoize
+0.004280   0.000000   0.004280 (  0.004285)
+Standard Method
+0.003760   0.000000   0.003760 (  0.003761)
+```
+FastMemoize takes slightly longer than the standard inline method because it must call the original method, which has been aliased as `memoized_method_name`. It is still an order of magnitude faster than the alternatives.
+
+## Caveats
+The `memoize` call only accepts one method name. You must place it after the method is defined. The best place is the line after you define the method.
+
+If the method hasn't been defined yet, it will blow up.
+
+Also, the memoized method can't take arguments. That calls for a different approach to memoization. You should still handle that yourself. This gem is just for the simple cases that you typically meet with `@method_name ||=`. FastMemoize will throw an error if you attempt to memoize a method that takes parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_memoize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fast_memoize
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fast_memoize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FastMemoize project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fast_memoize/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fast_memoize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fast_memoize.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fast_memoize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fast_memoize"
+  spec.version       = FastMemoize::VERSION
+  spec.authors       = ["David Furber"]
+  spec.email         = ["furberd@gmail.com"]
+
+  spec.summary       = %q{Memoize the return values of instance methods.}
+  spec.description   = %q{If you are used to doing memoization with `@my_method ||= yada_yada` and `return @my_method if defined?(@my_method); @my_method = yada_yada`, but you would like to get the memoization stuff out of the `yada_yada` part, but still rest assured that the `memoize` method does nothing more than that, then this gem is for you.}
+  spec.homepage      = "https://github.com/dfurber/fast_memoize"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "https://github.com/dfurber/fast_memoize"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">=2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fast_memoize/version.rb

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

data/lib/fast_memoize.rb

@@ -0,0 +1,26 @@
+require "fast_memoize/version"
+
+module FastMemoize
+  class UndefinedMethodError < StandardError; end
+  class ParameterizedMethodError < StandardError; end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def memoize(method)
+      raise UndefinedMethodError.new("Can't memoize undefined method: #{method}") unless method_defined?(method)
+      raise ParameterizedMethodError.new("Can't memoize a parameterized method") if instance_method(method).arity > 0
+
+      alias_method :"memoized_#{method}", method
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{method}
+          return @#{method} if defined?(@#{method})
+
+          @#{method} = memoized_#{method}
+        end
+      METHOD
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fast_memoize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Furber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: If you are used to doing memoization with `@my_method ||= yada_yada`
+  and `return @my_method if defined?(@my_method); @my_method = yada_yada`, but you
+  would like to get the memoization stuff out of the `yada_yada` part, but still rest
+  assured that the `memoize` method does nothing more than that, then this gem is
+  for you.
+email:
+- furberd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fast_memoize.gemspec
+- lib/fast_memoize.rb
+- lib/fast_memoize/version.rb
+homepage: https://github.com/dfurber/fast_memoize
+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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Memoize the return values of instance methods.
+test_files: []