numeric_memoist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd7d14ad0102f36ee2d5cbdb5a267a9ceadf87f4
+  data.tar.gz: a912f90e0d6a0ccecab4939a7127f3e578d81ecb
+SHA512:
+  metadata.gz: ed5e62405ae8f44f076efa4b2f17f473215bbaf2dba8027146d9af1961c2981672dd9ee75c92e61bfa184ba13fef8552bef10da74c82eb76cc89274f89044d11
+  data.tar.gz: cbdbacc3d056193f64bddb10f3b43c793241530ca12254a2d74cdbc56ae8e022eb35e8420614d74bd86282baac24517babdf9db476ef7fa773cbea098d6b212c

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GOTOH Shunsuke (@antimon2)
+
+MIT License
+
+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,80 @@
+# NumericMemoist
+
+The memoize library allows you to cache methods for Numerics (Integer/Float) in Ruby >= 2.0.0.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'numeric_memoist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install numeric_memoist
+
+## Usage
+
+Open class `Integer`/`Float`, extend `NumericMemoist` like the following:
+
+    require 'numeric_memoist'
+
+    class Integer
+      extend NumericMemoist
+
+      def sq
+        self ** 2
+      end
+      memoize :sq
+    end
+
+Then Integer#sq will only be calcurated once. 
+(These work on Ruby >= 2.0.0, and also <= 1.9.x.)
+
+### Comparison to others
+
+On Ruby <= 1.9.x, you may code as follows:
+
+    class Integer
+      def sq
+        @sq ||= self ** 2
+        # This raises RuntimeError on Ruby >= 2.0.x
+      end
+    end
+
+This doesn't work on Ruby >= 2.0.0, since Integer is frozen.
+
+You may use another similar gem like [Memoist](https://github.com/matthewrudy/memoist):
+
+    require 'memoist'
+
+    class Integer
+      extend Memoist
+
+      def sq
+        self ** 2
+      end
+      memoize :sq
+      # No Error raised, but momeize doesn't work on Ruby >= 2.0.x
+    end
+
+This doesn't work on Ruby >= 2.0.0 for the same reason.
+
+## Contributing
+
+1. Fork it
+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
+
+## Acknowledgements
+
+Inspired by [Memoist](https://github.com/matthewrudy/memoist).
+
+## License
+
+Under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/examples/isqrt_example.rb

@@ -0,0 +1,52 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+require 'numeric_memoist'
+
+class Integer
+  extend NumericMemoist
+
+  def isqrt
+    $stderr.puts "calculate sqrt(#{self}).to_i"
+    # === Newton-Raphson method ===
+    n = self
+    n = (n * n + self).div(2 * n) while n * n > self
+    n
+  end
+
+  def sq?
+    $stderr.puts "determining if #{self} is square number"
+    self.isqrt ** 2 == self
+  end
+  memoize :isqrt, :sq?
+end
+
+class Fixnum
+  # Need not to extend NumericMemoize (Integer has already extended NumericMemoize)
+  def isqrt
+    return super if self > 0x1fffffffffffff
+    $stderr.puts "calculate sqrt(#{self}).to_i (for Fixnum)"
+    return 0.0/0 if self < 0  # => NaN
+    return self if self < 2
+    Math.sqrt(self).to_i
+  end
+  memoize :isqrt
+end
+
+if $0 == __FILE__
+  p 123456789.isqrt
+  # STDERR> calculate sqrt(123456789).to_i (for Fixnum)
+  # STDOUT> 11111
+  p 123456789.sq?
+  # STDERR> determining if 123456789 is square number
+  # STDOUT> false
+  p 123456789.sq?
+  # (output nothig to STDERR)
+  # STDOUT> false
+  pi2 = 986960440108935861883449099987613301336842162813430234017512025
+  p pi2.sq?
+  # STDERR> determining if 986960440108935861883449099987613301336842162813430234017512025 is square number
+  # STDERR> calculate sqrt(986960440108935861883449099987613301336842162813430234017512025).to_i
+  # STDOUT> true
+  p pi2.isqrt
+  # (output nothig to STDERR)
+  # STDOUT> 31415926535897932384626433832795
+end

data/lib/numeric_memoist.rb

@@ -0,0 +1,35 @@
+require "numeric_memoist/version"
+
+module NumericMemoist
+  def memoize *method_names
+    method_names.each do |method_name|
+      _memoize method_name
+    end
+  end
+
+  private
+  def _memoize method_name
+    klass = self.respond_to?(:class_eval) ? self : (class<<self;self;end)
+    klass.class_eval do
+      unmemoized_method = instance_method method_name
+      is_private = private_method_defined? method_name
+      is_protected = protected_method_defined? method_name
+      if unmemoized_method.arity.zero?
+        cache = Hash.new do |h, num|
+          h[num] = unmemoized_method.bind(num).call
+        end
+        define_method(method_name){cache[self]}
+      else
+        cache = Hash.new do |h, num|
+          method = unmemoized_method.bind num
+          h[num] = Hash.new do |h2, args|
+            h2[args] = method[*args]
+          end
+        end
+        define_method(method_name){|*args| cache[self][args]}
+      end
+      private method_name if is_private
+      protected method_name if is_protected
+    end
+  end
+end

data/lib/numeric_memoist/version.rb

@@ -0,0 +1,3 @@
+module NumericMemoist
+  VERSION = "0.0.1"
+end

data/numeric_memoist.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'numeric_memoist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "numeric_memoist"
+  spec.version       = NumericMemoist::VERSION
+  spec.authors       = ["antimon2"]
+  spec.email         = ["antimon2.me@gmail.com"]
+  spec.description   = %q{The memoize library allows you to cache methods for Numerics (Integer/Float) in Ruby >= 2.0.0.}
+  spec.summary       = %q{Memoize methods in Integer/Float}
+  spec.homepage      = %q{https://github.com/antimon2/numeric_memoist}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  # 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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.9.0")
+end

data/test/float_memoize_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+require "numeric_memoist"
+require "stringio"
+
+class FloatMemoizeTest < Test::Unit::TestCase
+  class ::Float
+    extend NumericMemoist
+  end
+
+  def setup
+    @stdout_org = $stdout.dup
+    @stdout_buffer = ""
+    $stdout = StringIO.new @stdout_buffer
+  end
+
+  def test_no_args_method
+    ::Float.class_eval do
+      def no_args_method
+        puts "call #{self}.no_args_method"
+        self
+      end
+      memoize :no_args_method
+    end
+    assert_equal 1.0, 1.0.no_args_method
+    assert_equal ["call 1.0.no_args_method"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 1.0, 1.0.no_args_method
+    assert_equal ["call 1.0.no_args_method"], @stdout_buffer.chomp.split(/\r?\n/)
+  end
+
+  def test_some_args_method
+    ::Float.class_eval do
+      def some_args_method a, b
+        puts "call #{self}.some_args_method(#{a}, #{b})"
+        self * a * b
+      end
+      memoize :some_args_method
+    end
+    assert_equal 6.0, 1.0.some_args_method(2.0, 3.0)
+    assert_equal ["call 1.0.some_args_method(2.0, 3.0)"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 6.0, 1.0.some_args_method(3.0, 2.0)
+    assert_equal ["call 1.0.some_args_method(2.0, 3.0)", "call 1.0.some_args_method(3.0, 2.0)"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 6.0, 1.0.some_args_method(2.0, 3.0)
+    assert_equal ["call 1.0.some_args_method(2.0, 3.0)", "call 1.0.some_args_method(3.0, 2.0)"], @stdout_buffer.chomp.split(/\r?\n/)
+    # assert_equal 6.0, 1.0.some_args_method(2, 3)
+    # assert_equal ["call 1.0.some_args_method(2.0, 3.0)", "call 1.some_args_method(3.0, 2.0)", "call 1.0.some_args_method(2, 3)"], @stdout_buffer.chomp.split(/\r?\n/)
+  end
+
+  def teardown
+    $stdout = @stdout_org
+  end
+end

data/test/integer_memoize_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+require "numeric_memoist"
+require "stringio"
+
+class IntegerMemoizeTest < Test::Unit::TestCase
+  class ::Integer
+    extend NumericMemoist
+  end
+
+  def setup
+    @stdout_org = $stdout.dup
+    @stdout_buffer = ""
+    $stdout = StringIO.new @stdout_buffer
+  end
+
+  def test_no_args_method
+    ::Integer.class_eval do
+      def no_args_method
+        puts "call #{self}.no_args_method"
+        self
+      end
+      memoize :no_args_method
+    end
+    assert_equal 1, 1.no_args_method
+    assert_equal ["call 1.no_args_method"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 1, 1.no_args_method
+    assert_equal ["call 1.no_args_method"], @stdout_buffer.chomp.split(/\r?\n/)
+  end
+
+  def test_some_args_method
+    ::Integer.class_eval do
+      def some_args_method a, b
+        puts "call #{self}.some_args_method(#{a}, #{b})"
+        self * a * b
+      end
+      memoize :some_args_method
+    end
+    assert_equal 6, 1.some_args_method(2, 3)
+    assert_equal ["call 1.some_args_method(2, 3)"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 6, 1.some_args_method(3, 2)
+    assert_equal ["call 1.some_args_method(2, 3)", "call 1.some_args_method(3, 2)"], @stdout_buffer.chomp.split(/\r?\n/)
+    assert_equal 6, 1.some_args_method(2, 3)
+    assert_equal ["call 1.some_args_method(2, 3)", "call 1.some_args_method(3, 2)"], @stdout_buffer.chomp.split(/\r?\n/)
+  end
+
+  def test_recursive_method
+    ::Integer.class_eval do
+      def nth_fib
+        puts "call fib(#{self})"
+        return (even? ? -(-self).nth_fib : (-self).nth_fib) if self < 0
+        return self if self < 2
+        (self - 1).nth_fib + (self - 2).nth_fib
+      end
+      memoize :nth_fib
+    end
+    assert_equal 55, 10.nth_fib
+    assert_equal ["call fib(10)", "call fib(9)", "call fib(8)", "call fib(7)", "call fib(6)", "call fib(5)", "call fib(4)", "call fib(3)", "call fib(2)", "call fib(1)", "call fib(0)"], @stdout_buffer.chomp.split(/\r?\n/)
+  end
+
+  def teardown
+    $stdout = @stdout_org
+  end
+end

data/test/numeric_memoist_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+require "numeric_memoist"
+
+class NumericMemoistTest < Test::Unit::TestCase
+  extend NumericMemoist
+
+  def target_methods
+    [:gcd, :lcm, :gcdlcm]
+  end
+  memoize :target_methods
+
+  # def setup
+  # end
+
+  def test_memoize_exist_methods
+    methods = target_methods
+    assert_nothing_raised do
+      ::Integer.class_eval do
+        extend NumericMemoist
+
+        memoize *methods
+      end
+    end
+  end
+
+  def test_memoize_non_exist_methods
+    assert_raise NameError do
+      ::Integer.class_eval do
+        extend NumericMemoist
+
+        memoize :not_exist_method
+      end
+    end
+  end
+
+  # def teardown
+  # end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "test/unit"
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: numeric_memoist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- antimon2
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: The memoize library allows you to cache methods for Numerics (Integer/Float)
+  in Ruby >= 2.0.0.
+email:
+- antimon2.me@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/isqrt_example.rb
+- lib/numeric_memoist.rb
+- lib/numeric_memoist/version.rb
+- numeric_memoist.gemspec
+- test/float_memoize_test.rb
+- test/integer_memoize_test.rb
+- test/numeric_memoist_test.rb
+- test/test_helper.rb
+homepage: https://github.com/antimon2/numeric_memoist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Memoize methods in Integer/Float
+test_files:
+- test/float_memoize_test.rb
+- test/integer_memoize_test.rb
+- test/numeric_memoist_test.rb
+- test/test_helper.rb