lemo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c30aeed79a652b56d1c5a068cd8e8497bdbf931c
+  data.tar.gz: e20b6ec6ff6ac8e4ccb70c1f1e08bb6279a93750
+SHA512:
+  metadata.gz: e8dd167038ba71a0a43acd96eddf876fabc713f998335a68c366c7389326cca463864129d2ae19fb36ee2ad2cb98222a0e7b0f84db2713aa0a8dddac5334e601
+  data.tar.gz: 6112d081a1b85147d81cf1a351a8756f706446aa6d0cad55d7a25b3c94ca6f1a7a79da8692165337b93673e91fb98014970bfcdce1ce27459117c7f5b43f3eaa

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/.rvmrc

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.3.1@lemo" > .rvmrc
+environment_id="ruby-2.3.1@lemo"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.27.0 (master)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)\n" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME\n" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \command \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \command \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.1 # 2.3 doesn't work 09-Sep-2016
+  - jruby-9.0
+  - jruby-9.1.2.0 # 9.1 doesn't work 09-Sep-2016
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 John Anderson
+
+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,77 @@
+# Lemo [![Gem Version](https://badge.fury.io/rb/lemo.png)](http://badge.fury.io/rb/lemo) [![Build Status](https://travis-ci.org/djellemah/lemo.png?branch=master)](https://travis-ci.org/djellemah/lemo)
+
+Yet another memoize gem. Because it does some things that are important to me.
+
+Attention paid to performance:
+
+* rewrites the memoized method for fast normal-path execution. Rewritten method
+only makes calls to ruby methods, apart from the necessary single call to the
+original method.
+
+* Uses instance variables for memoisation storage.
+
+`Lemo::Memo` treats nil as a value, in other words uses presence or absence of
+an instance variable to establish whether the value has been memoised or not.
+Can clear one or several or all memoized values.
+
+`Lemo::Ormo` behaves like `@ivar ||=` so clearing is just setting `@ivar`
+to `nil`. Or removing it.
+
+`_memoed_methods` gives a hash of methods that have been memoised, and their
+unmemoised method bodies.
+
+Works on singleton instances. Although the syntax is clunky and best avoided.
+
+Is just as threadsafe as `||=` (in other words it mostly isn't)
+
+Will raise an exception if you attempt to memoise methods with parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lemo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lemo
+
+## Usage
+
+``` ruby
+require 'lemo/ormo'
+
+class YourThing
+  include Lemo::Ormo # or Lemo::Memo if you want nil-as-a-value and specialised clearing.
+
+  def normal_method
+    rand
+  end
+
+  memo def expensive_calculation
+    # do complicated stuff that is referentially transparent
+  end
+end
+
+your_thing = YourThing.new
+your_thing.expensive_calculation
+your_thing.clear_memos
+```
+
+## Development
+
+`rspec` to run specs
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/djellemah/lemo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/lemo.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lemo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lemo"
+  spec.version       = Lemo::VERSION
+  spec.authors       = ["John Anderson"]
+  spec.email         = ["panic@semiosix.com"]
+
+  spec.summary       = %q{fast-ish Memoize that handles nils and singletons}
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/djellemah/lemo"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/lemo.rb

@@ -0,0 +1,2 @@
+require_relative 'lemo/memo'
+require_relative 'lemo/ormo'

data/lib/lemo/memo.rb

@@ -0,0 +1,55 @@
+# Copyright John Anderson 2015-2016
+
+require_relative 'memoed_methods'
+
+module Lemo
+  module Memo
+    include MemoedMethods
+
+    module ClassMethods
+      def memoed_methods
+        @memoed_methods ||= {}
+      end
+
+      # provide a legal ivar name from a method name. instance variables
+      # can't have ? ! and other punctuation. Which isn't handled. Obviously.
+      def ivar_from( maybe_meth )
+        :"@_memo_#{maybe_meth.to_s.tr ILLEGAL_IVAR_CHARS,'pi'}"
+      end
+
+      def lemo( meth )
+        unbound_previous_method = instance_method meth
+
+        # still doesn't prevent memoisation of methods with an implicit block
+        unless unbound_previous_method.parameters.empty?
+          raise ArgumentError, "can't memo #{meth} with parameters"
+        end
+
+        memoed_methods[meth] = unbound_previous_method
+        ivar = ivar_from meth
+
+        define_method meth do
+          # This gets executed on every call to meth, so make it fast.
+          if instance_variable_defined? ivar
+            instance_variable_get ivar
+          else
+            # bind the saved method to this instance, call the result ...
+            to_memo = unbound_previous_method.bind( self ).call
+            # ... memo it and return value
+            instance_variable_set ivar, to_memo
+          end
+        end
+
+        meth
+      end
+
+      # for all the things using memo already
+      alias memo lemo
+    end
+
+    # hook in class methods on include
+    def self.included( other_module )
+      other_module.extend ClassMethods
+    end
+  end
+end

data/lib/lemo/memoed_methods.rb

@@ -0,0 +1,44 @@
+module Lemo
+  ILLEGAL_IVAR_CHARS = '?!'.freeze
+
+  module MemoedMethods
+    # the set of methods memoed so far that we know about.
+    def _memoed_methods
+      methods = {}
+
+      if self.class.respond_to?(:memoed_methods)
+        methods.merge! self.class.memoed_methods
+      end
+
+      if singleton_methods.size > 0 && singleton_class.respond_to?(:memoed_methods)
+        methods.merge! singleton_class.memoed_methods
+      end
+
+      methods
+    end
+
+    # Reset some or all memoized variables.
+    # Return cleared value(s)
+    # Has to do quite a lot of meta-work, so don't put this in fast-path code.
+    def _clear_memos( *requested_meths )
+      # construct set of memoed methods to clear
+      requested_meths =
+      if requested_meths.empty?
+        _memoed_methods.keys
+      else
+        # only clear ivars that actually make sense
+        _memoed_methods.keys & requested_meths
+      end
+
+      # clear set of memos and keep their values
+      memoed_values = requested_meths.map do |meth|
+        if instance_variable_defined?( ivar = _memoed_methods[meth].owner.ivar_from(meth) )
+          remove_instance_variable(ivar)
+        end
+      end
+
+      # return nil, the first value, or all values
+      (0..1) === memoed_values.size ? memoed_values.first : memoed_values
+    end
+  end
+end

data/lib/lemo/ormo.rb

@@ -0,0 +1,59 @@
+# Copyright John Anderson 2015-2016
+
+require_relative 'memoed_methods'
+
+module Lemo
+  # simple replacement for ||= (y'know or-or-equals)
+  # in others words stores values as plain old @name, and nil means same as does-not-exist
+  module Ormo
+    include MemoedMethods
+
+    module ClassMethods
+      def memoed_methods
+        @memoed_methods ||= {}
+      end
+
+      # provide a legal ivar name from a method name. instance variables
+      # can't have ? ! and other punctuation. Which isn't handled. Obviously.
+      # WARNING meth, meth? and meth! will access the same ivar.
+      def ivar_from( meth )
+        :"@#{meth.to_s.delete ILLEGAL_IVAR_CHARS}"
+      end
+
+      # WARNING race condition if two threads concurrently define the same
+      # memo'ed method on the same class. Unlikely, but still.
+      def ormo( meth )
+        unbound_previous_method = instance_method meth
+
+        # still doesn't prevent memoisation of methods with an implicit block
+        unless unbound_previous_method.parameters.empty?
+          raise ArgumentError, "can't memo #{meth} with parameters"
+        end
+
+        # keep this for initial calculation, and recalculation
+        memoed_methods[meth] = unbound_previous_method
+        ivar = ivar_from meth
+
+        # Define the class using instance variable @ syntax, for fastest
+        # runtime. Use class_eval to define an instance method, cos self is the
+        # class (or singleton class) right now
+        class_eval <<-RUBY, __FILE__, __LINE__
+          def #{meth}
+            #{ivar} ||= _memoed_methods[:#{meth}].bind(self).call
+          end
+        RUBY
+
+        # allow chaining of symbol returned from def
+        meth
+      end
+
+      # for all the things using memo already
+      alias memo ormo
+    end
+
+    # hook in class methods on include
+    def self.included( other_module )
+      other_module.extend ClassMethods
+    end
+  end
+end

data/lib/lemo/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: lemo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Anderson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fast-ish Memoize that handles nils and singletons
+email:
+- panic@semiosix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lemo.gemspec
+- lib/lemo.rb
+- lib/lemo/memo.rb
+- lib/lemo/memoed_methods.rb
+- lib/lemo/ormo.rb
+- lib/lemo/version.rb
+homepage: http://github.com/djellemah/lemo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: fast-ish Memoize that handles nils and singletons
+test_files: []