memonic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de009766f0ddc455437e5cf5530965053056e7b3
+  data.tar.gz: 59f9760f45a6df85cba1f57502fe31d5070ea47f
+SHA512:
+  metadata.gz: 1fa36f7e0d6685ddbb228d45f177a4ad4a95967bbb9fec410caf63b04af7df119bbd3e072299edb5c9b29af9ad1244f15d7b0926028eb2c297db9db6d3d0bcc8
+  data.tar.gz: fd671c71357aed5cd141a792a59f043d1b8644334abccd74faca9aafaced5b1317cc5560d5a90ae865f63c7d8a5193e7e0880dbfa0849ce8264455fdf6607e99

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - john+memonic@carney.id.au
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pikelet.gemspec
+gemspec

data/README.md

@@ -0,0 +1,128 @@
+# Memonic
+
+[![Build status][build-badge]][build]
+
+## Introduction
+
+Memonic is a very simple, lightweight memoization helper. The simplest way to
+use it is with the `memoize` class method.
+
+    class MyClass
+      include Memonic
+
+      memoize :value do
+        an_expensive_computation
+      end
+    end
+
+This defines an instance method named `value` on `MyClass` that is the
+equivalent of:
+
+    def value
+      unless defined? @value
+        @value = an_expensive_computation
+      end
+      @value
+    end
+
+Note that unlike the more usual `@value ||= computation` pattern, Memonic
+guarantees that the computation is only executed once, even if it returns
+`nil` or `false`.
+
+`memoize` is also available as an instance method. I'm not entirely sure why
+you would want to use it, but if you do, here's how:
+
+    class MyClass
+      include Memonic
+
+      def value
+        memoize(:@value) { an_expensive_computation }
+      end
+    end
+
+Note that the '@' prefix **is** necessary.
+
+## Background
+
+Memoization is a common optimization technique in which the result of a
+potentially expensive computation is captured the first time a function is
+invoked and the cached result is used for subsequent invocations. In Ruby it's
+usually expressed as follows:
+
+    class MyClass
+      def value
+        @value ||= an_expensive_computation
+      end
+    end
+
+This is simple and well-understood, but suffers from a fairly serious flaw: if
+the computation result is `nil` or `false`, then the full computation will be
+performed on every call to `value`. In most cases this is not an issue -
+either the computation in question never yields a "falsey" result, or it's not
+so expensive that it matters if it's repeated a few times. For cases where
+these issues are a concern, the usual solution is to first check whether the
+cached result actually exists:
+
+    def value
+      unless defined?(@value)
+        @value = an_expensive_computation
+      end
+      @value
+    end
+
+This does the job, but it's verbose and not very idiomatic. Memonic does
+pretty much exactly this internally, but dresses it in a convenient, idiomatic
+syntax.
+
+## Alternatives
+
+There are a couple of gems that offer similar functionality. Most of these
+are intended to replace `ActiveSupport::Memoizable`, which was deprecated
+way back in Rails 3.2 for being an overly complex solution to a relatively
+simple problem. The Memoizable-style gems use a slightly different syntax from
+Memonic. You define your method, then mark it for memoization:
+
+    class MyClass
+      extend Memoist
+
+      def value
+        an_expensive_computation
+      end
+      memoize :value
+    end
+
+If you prefer this approach, then you should totally use something like
+[Memoist][memoist] or [Memoizable][memoizable].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'memonic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memonic
+
+## Contributing
+
+1. Fork it ([http://github.com/johncarney/memonic/fork][fork])
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[memoist]:    https://github.com/matthewrudy/memoist
+[memoizable]: https://github.com/dkubb/memoizable
+
+[gem-badge]:        https://badge.fury.io/rb/memonic.svg
+[gem]:              http://badge.fury.io/rb/memonic
+[build-badge]:      https://travis-ci.org/johncarney/memonic.svg?branch=master
+[build]:            https://travis-ci.org/johncarney/memonic
+[coverage-badge]:   https://img.shields.io/coveralls/johncarney/memonic.svg
+[coverage]:         https://coveralls.io/r/johncarney/memonic?branch=master
+[fork]:             http://github.com/johncarney/memonic/fork

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/memonic.rb

@@ -0,0 +1,28 @@
+require "memonic/version"
+
+module Memonic
+  if defined?(ActiveSupport::Concern)
+    extend ActiveSupport::Concern
+  else
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+
+  private
+
+  def memoize(variable, &block)
+    if instance_variable_defined?(variable)
+      instance_variable_get(variable)
+    else
+      instance_variable_set(variable, instance_exec(&block))
+    end
+  end
+
+  module ClassMethods
+    def memoize(name, &block)
+      variable = "@#{name}"
+      define_method(name) { memoize(variable, &block) }
+    end
+  end
+end

data/lib/memonic/version.rb

@@ -0,0 +1,3 @@
+module Memonic
+  VERSION = "1.0.0"
+end

data/memonic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memonic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memonic"
+  spec.version       = Memonic::VERSION
+  spec.authors       = ["John Carney"]
+  spec.email         = ["john@carney.id.au"]
+  spec.summary       = %q{A simple, lightweight memoization helper.}
+  spec.description   = %q{Memonic is a simple, lightweight memoization helper.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/memonic_spec.rb

@@ -0,0 +1,118 @@
+require "spec_helper"
+require "memonic"
+
+describe Memonic do
+  describe ".memoize" do
+    let(:klass) do
+      Struct.new(:computation) do
+        include Memonic
+
+        memoize :value do
+          computation
+        end
+      end
+    end
+
+    let(:instance) { klass.new(result) }
+
+    before do
+      allow(instance).to receive(:computation).and_call_original
+    end
+
+    context "with a truthy result" do
+      let(:result) { Object.new }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+
+    context "with a nil result" do
+      let(:result) { nil }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+
+    context "with a false result" do
+      let(:result) { false }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+  end
+
+  describe "#memoize" do
+    let(:klass) do
+      Struct.new(:computation) do
+        include Memonic
+
+        def value
+          memoize(:@value) { computation }
+        end
+      end
+    end
+
+    let(:instance) { klass.new(result) }
+
+    before do
+      allow(instance).to receive(:computation).and_call_original
+    end
+
+    context "with a truthy result" do
+      let(:result) { Object.new }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+
+    context "with a nil result" do
+      let(:result) { nil }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+
+    context "with a false result" do
+      let(:result) { false }
+
+      it "returns the computation result" do
+        expect(instance.value).to be result
+      end
+
+      it "invokes the computation only once" do
+        2.times { instance.value }
+        expect(instance).to have_received(:computation).once
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: memonic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Carney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Memonic is a simple, lightweight memoization helper.
+email:
+- john@carney.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/memonic.rb
+- lib/memonic/version.rb
+- memonic.gemspec
+- spec/memonic_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: A simple, lightweight memoization helper.
+test_files:
+- spec/memonic_spec.rb
+- spec/spec_helper.rb