memoized_on_frozen 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b9b5a0421f853e1b9756a4803bc49c70465d202f0f4a6ba3d9af8132be8e83f
+  data.tar.gz: dc0a3ed91fae98a822084385a8f8a944e9661baff749cf13866200cc62ddcd3f
+SHA512:
+  metadata.gz: d7810466303db44765c16141c0a91d902b4dd4cc4430f8f3fc4d698cf81c2f2f1990a3615773178b0db02b3fd8c3aa732f6f3d84dbfe739b6fc8d93bd5ae6236
+  data.tar.gz: c5f78499029c9ccc8f982f1b582b61af55d8608e65d1e4e852216d94119fa1a0f06f7d38d00f75c824dfd880da0a10f4e86613dd0ec344b9533a4be843a8f161

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/memoized_on_frozen_spec.rb'
+
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'spec/support/rectangle.rb'
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'example.rb'
+    - 'vendor/**/*'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    memoized_on_frozen (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  memoized_on_frozen!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,119 @@
+# MemoizedOnFrozen
+
+[![Build Status](https://travis-ci.org/iliabylich/memoized_on_frozen.svg?branch=master)](https://travis-ci.org/iliabylich/memoized_on_frozen)
+
+Immutable objects are a good thing, but they can't use memoization:
+
+``` ruby
+class Rectangle
+  def initialize(x, y)
+    @x = x
+    @y = y
+
+    freeze
+  end
+
+  def area
+    @area ||= @x * @y
+  end
+end
+
+Rectangle.new(2, 3).area
+# => FrozenError (can't modify frozen Rectangle)
+```
+
+This gem offers a very simple solution - it performs a memoization on a "global" registry object.
+
+Like this:
+``` ruby
+def area
+  $registry[self][:area] ||= @x * @y
+end
+```
+
+But then we face another problem: memory leaking. Every object that is memoized creates a garbage
+in the "global" variable that is never GC-ed. This can be solved using `WeakRef` Ruby class.
+
+`MemoizedOnFrozen` uses a `Hash` as a registry under the hood, but this hash uses `WeakRef`s as keys.
+
+## Example
+
+Declare a class:
+``` ruby
+require 'memoized_on_frozen'
+
+class Rectangle
+  include MemoizedOnFrozen[:area]
+
+  def initialize(x, y)
+    @x = x
+    @y = y
+
+    freeze
+  end
+
+  def area
+    puts 'calculating area'
+    @x * @y
+  end
+end
+```
+
+And see how the library handles it:
+
+``` ruby
+rectangle1 = Rectangle.new(1, 2)
+rectangle2 = Rectangle.new(3, 4)
+
+rectangle1.area
+# calculating area
+# => 2
+rectangle1.area
+# => 2
+
+rectangle2.area
+# calculating area
+# => 12
+rectangle2.area
+# => 12
+
+MemoizedOnFrozen::WEAK_STORE.keys
+# => [rectangle1, rectangle2]
+
+rectangle1 = rectangle2 = nil
+GC.start
+MemoizedOnFrozen::WEAK_STORE.keys
+# => []
+```
+
+You can find a working example in `example.rb`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memoized_on_frozen'
+```
+
+Or if you'd like to use an alias `Memoized` instead of `MemoizedOnFrozen`
+(and you are 100% sure that there are no conflicts with existing classes):
+
+``` ruby
+gem 'memoized_on_frozen', require: 'memoized_on_frozen/as_memoized'
+```
+
+The file `lib/memoized_on_frozen/as_memoized.rb` literally does `Memoized = MemoizedOnFrozen`
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memoized_on_frozen
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iliabylich/memoized_on_frozen.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'memoized_on_frozen'
+
+# 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/example.rb

@@ -0,0 +1,36 @@
+# bundle exec ruby example.rb
+
+require 'memoized_on_frozen'
+
+class Rectangle
+  include MemoizedOnFrozen[:area]
+
+  def initialize(x, y)
+    @x = x
+    @y = y
+
+    freeze
+  end
+
+  def area
+    puts 'calculating area'
+    @x * @y
+  end
+end
+
+rectangle1 = Rectangle.new(1, 2)
+rectangle2 = Rectangle.new(3, 4)
+
+puts rectangle1.area
+puts rectangle1.area
+
+puts rectangle2.area
+puts rectangle2.area
+
+p MemoizedOnFrozen::WEAK_STORE.keys
+# => [rectangle1, rectangle2]
+
+rectangle1 = rectangle2 = nil
+GC.start
+p MemoizedOnFrozen::WEAK_STORE.keys
+# => []

data/lib/memoized_on_frozen.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'memoized_on_frozen/version'
+require 'weakref'
+
+# A builder module that allows you to do memoization on
+# frozen objects
+#
+# @example
+#   class YourClass
+#     include MemoizedOnFrozen[:m]
+#
+#     def initialize
+#       freeze
+#     end
+#
+#     def m
+#       some_heavy_computation
+#     end
+#   end
+#
+module MemoizedOnFrozen
+  # :nodoc:
+  class WeakStore < Hash
+    (Hash.instance_methods(false) - [:select!]).each do |method_name|
+      define_method(method_name) do |*args, &blk|
+        cleanup if potentially_stale?
+        super(*args, &blk)
+      end
+    end
+
+    def initialize(*)
+      super
+      @last_tracked_gc_run = GC.count
+    end
+
+    def cleanup
+      select! { |key, _| key.weakref_alive? }
+      @last_tracked_gc_run = GC.count
+    end
+
+    def potentially_stale?
+      @last_tracked_gc_run != GC.count
+    end
+  end
+
+  WEAK_STORE = WeakStore.new
+
+  # :nodoc:
+  module SetWeakRef
+    def initialize(*args, &block)
+      @_ref = WeakRef.new(self)
+      WEAK_STORE[@_ref] = {}
+      super(*args, &block)
+    end
+  end
+
+  class << self
+    def _module_for(method_names)
+      Module.new do
+        method_names.each do |method_name|
+          define_method(method_name) do
+            WEAK_STORE[@_ref][method_name] ||= super()
+          end
+        end
+      end
+    end
+
+    def [](*method_names)
+      Module.new do
+        define_singleton_method(:included) do |base|
+          base.prepend(SetWeakRef, MemoizedOnFrozen._module_for(method_names))
+        end
+      end
+    end
+  end
+end

data/lib/memoized_on_frozen/as_memoized.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'memoized_on_frozen'
+Memoized = MemoizedOnFrozen

data/lib/memoized_on_frozen/version.rb

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

data/memoized_on_frozen.gemspec

@@ -0,0 +1,28 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memoized_on_frozen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'memoized_on_frozen'
+  spec.version       = MemoizedOnFrozen::VERSION
+  spec.authors       = ['Ilya Bylich']
+  spec.email         = ['ibylich@gmail.com']
+
+  spec.summary       = 'A tiny gem for memoization on frozen objects'
+  spec.description   = 'Because memoization creates an ivar'
+  spec.homepage      = 'https://github.com/iliabylich/memoized_on_frozen'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: memoized_on_frozen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ilya Bylich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Because memoization creates an ivar
+email:
+- ibylich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example.rb
+- lib/memoized_on_frozen.rb
+- lib/memoized_on_frozen/as_memoized.rb
+- lib/memoized_on_frozen/version.rb
+- memoized_on_frozen.gemspec
+homepage: https://github.com/iliabylich/memoized_on_frozen
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A tiny gem for memoization on frozen objects
+test_files: []