ddmemoize 1.0.0a1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7674a9402beca0c7c7aa4bcf22c5095856bd4c77cd8994ff5677fa0784fd5f5c
+  data.tar.gz: '090adce10054d2c7f63725947ce96ccb2eff67be093dd6042968600994515191'
+SHA512:
+  metadata.gz: 1a0df32a98e11ea5280e6d15191057e62397dde1796b73e3fe17b264133f47f8b454da468daf854f0ae3102261206141449832e41d19f83274cb11f4c9bcaecc
+  data.tar.gz: cb30c1743351a11dfcdbaea5a9a907f4587c68cfe1b9265a78a654fcea6bc94a2e495e1628240edfbba0ced548ca20cf6da56484ef843e1a7f0cb0f3d30a7a78

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+/.vscode/
+/coverage/
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+-r ./spec/spec_helper.rb
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,54 @@
+# ----- CONFIGURED -----
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+# The documentation lives in the README.
+Style/Documentation:
+  Enabled: false
+
+
+
+# ----- DISABLED (metrics) -----
+
+# Cops for metrics are disabled because they should not cause tests to fail.
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - "2.3"
+  - "2.4"
+
+branches:
+  only:
+    - "master"
+
+cache: bundler
+
+sudo: false
+
+git:
+  depth: 10

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 denis.defreyne@stoneship.org. 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,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :devel do
+  gem 'codecov', require: false
+  gem 'fuubar'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', '~> 0.50'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Denis Defreyne
+
+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/NEWS.md

@@ -0,0 +1,5 @@
+# DDMemoize news
+
+## 1.0.0a1 (2017-12-02)
+
+Initial release.

data/README.md

@@ -0,0 +1,103 @@
+[![Gem version](https://img.shields.io/gem/v/ddmemoize.svg)](http://rubygems.org/gems/ddmemoize)
+[![Gem downloads](https://img.shields.io/gem/dt/ddmemoize.svg)](http://rubygems.org/gems/ddmemoize)
+[![Build status](https://img.shields.io/travis/ddfreyne/ddmemoize.svg)](https://travis-ci.org/ddfreyne/ddmemoize)
+[![Code Climate](https://img.shields.io/codeclimate/github/ddfreyne/ddmemoize.svg)](https://codeclimate.com/github/ddfreyne/ddmemoize)
+[![Code Coverage](https://img.shields.io/codecov/c/github/ddfreyne/ddmemoize.svg)](https://codecov.io/gh/ddfreyne/ddmemoize)
+
+# DDMemoize
+
+_DDMemoize_ adds support for memoizing Ruby functions.
+
+For example, the following Fibonacci implementation runs quickly (in O(n) rather than in O(2^n)):
+
+```ruby
+class FibFast
+  DDMemoize.activate(self)
+
+  memoized def run(n)
+    if n == 0
+      0
+    elsif n == 1
+      1
+    else
+      run(n - 1) + run(n - 2)
+    end
+  end
+end
+```
+
+Features:
+
+* Supports memoizing functions on frozen objects
+* Releases memoized values when needed in order to reduce memory pressure
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ddmemoize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ddmemoize
+
+## Usage
+
+First, require `ddmemoize` and enable it using `DDMemoize.activate`:
+
+```ruby
+require 'ddmemoize'
+
+class FibFast
+  DDMemoize.activate(self)
+
+  # …
+end
+```
+
+To memoize a function, call `memoize` with the name of the function:
+
+```ruby
+  def run(n)
+    # …
+  end
+  memoize :run
+```
+
+Alternatively, prepend `memoized` to the function definition:
+
+```ruby
+  memoized def run(n)
+    # …
+  end
+```
+
+Do not memoie functions that depend on mutable state.
+
+## Development
+
+Install dependencies:
+
+    $ bundle
+
+Run tests:
+
+    $ bundle exec rake
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddfreyne/ddmemoize. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DDMemoize project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ddfreyne/ddmemoize/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :test
+
+task test: %i[spec rubocop]

data/ddmemoize.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ddmemoize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ddmemoize'
+  spec.version       = DDMemoize::VERSION
+  spec.authors       = ['Denis Defreyne']
+  spec.email         = ['denis+rubygems@denis.ws']
+
+  spec.summary       = 'Adds support for memoizing functions'
+  spec.homepage      = 'https://github.com/ddfreyne/ddmemoize'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_runtime_dependency('ref', '~> 2.0')
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+end

data/lib/ddmemoize.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'ref'
+
+require_relative 'ddmemoize/version'
+
+module DDMemoize
+  class Value
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+  end
+
+  NONE = Object.new
+
+  def self.activate(mod)
+    mod.extend(Mixin)
+  end
+
+  module Mixin
+    def memoize(method_name)
+      original_method_name = '__nonmemoized_' + method_name.to_s
+      alias_method original_method_name, method_name
+
+      instance_cache = Hash.new { |hash, key| hash[key] = {} }
+
+      define_method(method_name) do |*args|
+        instance_method_cache = instance_cache[self]
+
+        value = NONE
+        if instance_method_cache.key?(args)
+          object = instance_method_cache[args].object
+          value = object ? object.value : NONE
+        end
+
+        if value.equal?(NONE)
+          send(original_method_name, *args).tap do |r|
+            instance_method_cache[args] = Ref::SoftReference.new(Value.new(r))
+          end
+        else
+          value
+        end
+      end
+    end
+    alias memoized memoize
+  end
+end

data/lib/ddmemoize/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DDMemoize
+  VERSION = '1.0.0a1'
+end

data/scripts/release

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'octokit'
+
+def run(*args)
+  puts 'I will execute the following:'
+  puts '    ' + args.map { |a| a =~ /\s/ ? a.inspect : a }.join(' ')
+  print 'Is this correct? [y/N] '
+  res = gets
+  unless res.strip.casecmp('y').zero?
+    warn 'Answer was not Y; release aborted.'
+    exit 1
+  end
+
+  system('echo', *args)
+  system(*args)
+
+  print 'Continue? [y/N] '
+  res = gets
+  unless res.strip.casecmp('y').zero?
+    warn 'Answer was not Y; release aborted.'
+    exit 1
+  end
+
+  true
+end
+
+puts '=== Logging in to GitHub’s API…'
+client = Octokit::Client.new(netrc: true)
+puts
+
+puts '=== Deleting old *.gem files…'
+Dir['*.gem'].each do |fn|
+  puts "  #{fn}…"
+  FileUtils.rm_f(fn)
+end
+puts
+
+puts '=== Verifying presence of release date…'
+unless File.readlines('NEWS.md').drop(2).first =~ / \(\d{4}-\d{2}-\d{2}\)$/
+  warn 'No proper release date found!'
+  exit 1
+end
+puts
+
+puts '=== Building new gem…'
+run('gem', 'build', 'ddmemoize.gemspec')
+puts
+
+puts '=== Reading version…'
+require './lib/ddmemoize/version'
+puts "Version = #{DDMemoize::VERSION}"
+puts
+
+puts '=== Verifying that release does not yet exist…'
+releases = client.releases('ddfreyne/ddmemoize')
+release = releases.find { |r| r.tag_name == DDMemoize::VERSION }
+if release
+  warn 'Release already exists!'
+  warn 'ABORTED!'
+  exit 1
+end
+puts
+
+puts '=== Creating Git tag…'
+run('git', 'tag', '--sign', '--annotate', DDMemoize::VERSION, '--message', "Version #{DDMemoize::VERSION}")
+puts
+
+puts '=== Pushing Git data…'
+run('git', 'push', 'origin', '--tags')
+puts
+
+puts '=== Pushing gem…'
+run('gem', 'push', "ddmemoize-#{DDMemoize::VERSION}.gem")
+puts
+
+puts '=== Reading release notes…'
+release_notes =
+  File.readlines('NEWS.md')
+      .drop(4)
+      .take_while { |l| l !~ /^## / }
+      .join
+puts
+
+puts '=== Creating release on GitHub…'
+sleep 3 # Give GitHub some time to detect the new tag
+is_prerelease = DDMemoize::VERSION =~ /a|b|rc/ || DDMemoize::VERSION =~ /^0/
+client.create_release(
+  'ddfreyne/ddmemoize', DDMemoize::VERSION,
+  prerelease: !is_prerelease.nil?,
+  body: release_notes
+)
+puts
+
+puts 'DONE!'

data/spec/ddmemoize_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+describe DDMemoize do
+  it 'has a version number' do
+    expect(DDMemoize::VERSION).not_to be nil
+  end
+
+  class MemoizationSpecSample1
+    DDMemoize.activate(self)
+
+    def initialize(value)
+      @value = value
+    end
+
+    def run(n)
+      @value * 10 + n
+    end
+    memoize :run
+  end
+
+  class MemoizationSpecSample2
+    DDMemoize.activate(self)
+
+    def initialize(value)
+      @value = value
+    end
+
+    def run(n)
+      @value * 100 + n
+    end
+    memoize :run
+  end
+
+  class MemoizationSpecUpcaser
+    DDMemoize.activate(self)
+
+    def run(value)
+      value.upcase
+    end
+    memoize :run
+  end
+
+  class MemoizationSpecUpcaserInlineSyntax
+    DDMemoize.activate(self)
+
+    memoized def run(value)
+      value.upcase
+    end
+  end
+
+  class MemoizationSpecInlineSyntaxReturn
+    DDMemoize.activate(self)
+
+    class << self
+      attr_reader :sym
+    end
+
+    def self.record(sym)
+      @sym = sym
+    end
+
+    record memoized def run; end
+  end
+
+  example do
+    sample1a = MemoizationSpecSample1.new(10)
+    sample1b = MemoizationSpecSample1.new(15)
+    sample2a = MemoizationSpecSample2.new(20)
+    sample2b = MemoizationSpecSample2.new(25)
+
+    3.times do
+      expect(sample1a.run(5)).to eq(10 * 10 + 5)
+      expect(sample1b.run(7)).to eq(10 * 15 + 7)
+      expect(sample2a.run(5)).to eq(100 * 20 + 5)
+      expect(sample2b.run(7)).to eq(100 * 25 + 7)
+    end
+  end
+
+  it 'supports frozen objects' do
+    sample = MemoizationSpecSample1.new(10)
+    sample.freeze
+    sample.run(5)
+  end
+
+  it 'supports memoized def … syntax' do
+    upcaser = MemoizationSpecUpcaserInlineSyntax.new
+    expect(upcaser.run('hi')).to eq('HI')
+  end
+
+  it 'does not crash on #inspect' do
+    upcaser = MemoizationSpecUpcaser.new
+    10_000.times do |i|
+      upcaser.run("hello world #{i}")
+    end
+
+    GC.start
+    GC.start
+
+    upcaser.inspect
+  end
+
+  it 'returns method name' do
+    expect(MemoizationSpecInlineSyntaxReturn.sym).to eq(:run)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
+require 'ddmemoize'
+
+require 'fuubar'
+
+RSpec.configure do |c|
+  c.fuubar_progress_bar_options = {
+    format: '%c/%C |<%b>%i| %p%%',
+  }
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ddmemoize
+version: !ruby/object:Gem::Version
+  version: 1.0.0a1
+platform: ruby
+authors:
+- Denis Defreyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ref
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- denis+rubygems@denis.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- NEWS.md
+- README.md
+- Rakefile
+- ddmemoize.gemspec
+- lib/ddmemoize.rb
+- lib/ddmemoize/version.rb
+- scripts/release
+- spec/ddmemoize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ddfreyne/ddmemoize
+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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Adds support for memoizing functions
+test_files: []