memorb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9724352c954ae84fd4004bc0cdc534fd71c847fdd5ceeb241a1b92855cd3374f
-  data.tar.gz: 3d1b910ae44c6680eb4ae5a997800630da89bffed0f851849b32beedfbbeb257
+  metadata.gz: eddf3e947817bc71d168593c818b5a983a060cd62e21936e62595a9b9400d918
+  data.tar.gz: 1d306ffd9b7068f27de0bdfe9267dc7a5a243a7bcfbe1e90380b3cb6a68bd229
 SHA512:
-  metadata.gz: 62d3610c4f5591da319e16bef054ad79acc32329c4ea95e2a9fe793b1124e3059fdf6743a19130e1c6fd5a380bd387c3b0ea8b67b39e3fc13c01c4880b1b23ce
-  data.tar.gz: ece13fcec090a805cd010217e85d6ff3b42868156c47856f58781dc79faa1edb30eb88b06da0039869aac93cc59229c86c98c3c2d308376c39cf970538622983
+  metadata.gz: a9a012843efd2230b6a6927be7048025e1c6d993df11e60d92824acad0b1400159883d14a49ef32b586cdd5057bb98f5e502c747b25151fa8996e60f055f04cc
+  data.tar.gz: b0010e430dd6f80385b369eff2e7ca7962481401a592882509a7351120fc0f6eb6891518a0c85197fef0ce04f3d954a73b71c14c59fb965199d8cac81c0feecf

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2021-05-11
+
+### Changed
+
+- BREAKING CHANGE: Changed the activation alias from `memorb!` to `memoize`.
+- No longer keep a global registry of instance agents to reduce the risk of memory leakage.
+- Updated Gemfile source to HTTPS.
+
+### Removed
+
+- Removed undocumented `purge` method.
+
+## [0.1.0] - 2020-06-08
+
+Initial release.

data/Gemfile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -2,7 +2,11 @@
 
 Memoize instance methods with ease.
 
-[![CircleCI](https://circleci.com/gh/pjrebsch/memorb/tree/master.svg?style=svg)](https://circleci.com/gh/pjrebsch/memorb/tree/master)
+[![Gem Version](https://badge.fury.io/rb/memorb.svg)](https://badge.fury.io/rb/memorb) [![CircleCI](https://circleci.com/gh/pjrebsch/memorb/tree/master.svg?style=svg)](https://circleci.com/gh/pjrebsch/memorb/tree/master)
+
+```bash
+gem install memorb
+```
 
 ## Overview
 
@@ -57,19 +61,19 @@ Memorb exists to make memoization in these cases much easier to implement. Simpl
 class WeekForecast
   extend Memorb
 
-  memorb! def data
+  memoize def data
     ...
   end
 
-  memorb! def week_days
+  memoize def week_days
     ...
   end
 
-  memorb! def rain_on?(day)
+  memoize def rain_on?(day)
     ...
   end
 
-  memorb! def will_rain?
+  memoize def will_rain?
     ...
   end
 end
@@ -79,13 +83,13 @@ These methods' return values will now be memoized for each instance of `WeekFore
 
 ## Usage
 
-First, integrate Memorb into a class with `extend Memorb`. Then, use the `memorb!` class method to register instance methods for memoization.
+First, integrate Memorb into a class with `extend Memorb`. Then, use the `memoize` class method to register instance methods for memoization.
 
 ### Integrating Class Methods
 
 These methods are available as class methods on the integrating class.
 
-#### `memorb!`
+#### `memoize`
 
 Use this method to register instance methods for memoization. When a method is both registered and defined, Memorb will override it. Once the method is overridden, it's considered "enabled" for memoization. On initial invocation with a given set of arguments, the method's return value is cached based on the given arguments and returned. Then, subsequent invocations of that method with the same arguments return the cached value.
 
@@ -96,15 +100,15 @@ Internally, calls to the overriding method implementation are serialized with a
 Conveniently, methods defined using the `def` keyword return the method name, so the method definition can just be prefixed with a registration directive. This approach helps make apparent the fact that the method is being memoized when reading the method.
 
 ```ruby
-memorb! def data
+memoize def data
   ...
 end
 ```
 
-If you prefer `def` and `end` to align, you can move `memorb!` up to a new line and escape the line break. The Memorb registration methods require arguments, so if you forget to escape the line break, you'll be made aware with an exception when the class is loaded.
+If you prefer `def` and `end` to align, you can move `memoize` up to a new line and escape the line break. The Memorb registration methods require arguments, so if you forget to escape the line break, you'll be made aware with an exception when the class is loaded.
 
 ```ruby
-memorb! \
+memoize \
 def data
   ...
 end
@@ -115,7 +119,7 @@ end
 If you wish to enumerate the methods to register all at once, or don't have access to a method's implementation source to use the Prefix form, you can supply a list of method names instead.
 
 ```ruby
-memorb! :data, :week_days, :rain_on?, :will_rain?
+memoize :data, :week_days, :rain_on?, :will_rain?
 ```
 
 Typos are a potential problem. Memorb can't know when a registered method's definition is going to occur, so if you mistype the name of a method you intend to define later, Memorb will anticipate that method's definition indefinitely and the method that you intended to register won't end up being memoized. The Prefix form is recommended for this reason.
@@ -127,7 +131,7 @@ If you do use this form, you can check that all registered methods were enabled
 Instead of listing out method names or decorating their definitions, you can just define them within a block.
 
 ```ruby
-memorb! do
+memoize do
   def data
     ...
   end
@@ -157,7 +161,7 @@ These methods are available on the `Memorb::Integration` instance for an integra
 
 #### `register`
 
-Alias of `memorb!`.
+Alias of `memoize`.
 
 #### `registered_methods`
 

data/lib/memorb/integration.rb

@@ -87,10 +87,6 @@ module Memorb
               _enabled?(_identifier(name))
             end
 
-            def purge(name)
-              _purge(_identifier(name))
-            end
-
             def auto_register?
               _auto_registration.value > 0
             end
@@ -125,17 +121,8 @@ module Memorb
 
             alias_method :inspect, :name
 
-            # Never save reference to the integrator instance or it may
-            # never be garbage collected!
             def create_agent(integrator_instance)
-              Agent.new(integrator_instance.object_id).tap do |agent|
-                _agents.write(agent.id, agent)
-
-                # The proc must not be made here because it would save a
-                # reference to `integrator_instance`.
-                finalizer = _agent_finalizer(agent.id)
-                ::ObjectSpace.define_finalizer(integrator_instance, finalizer)
-              end
+              Agent.new(integrator_instance.object_id)
             end
 
             private
@@ -190,14 +177,6 @@ module Memorb
               _overrides.keys.include?(method_id)
             end
 
-            def _purge(method_id)
-              _agents.keys.each do |id|
-                agent = _agents.read(id)
-                store = agent&.method_store&.read(method_id)
-                store&.reset!
-              end
-            end
-
             def _remove_override(method_id)
               # Ruby will raise an exception if the method doesn't exist.
               # Catching it is the safest thing to do for thread-safety.
@@ -233,11 +212,6 @@ module Memorb
               visibility
             end
 
-            def _agent_finalizer(agent_id)
-              # This must not be a lambda proc, otherwise GC hangs!
-              ::Proc.new { _agents.forget(agent_id) }
-            end
-
             def _registrations
               RubyCompatibility.module_constant(self, :registrations)
             end
@@ -246,10 +220,6 @@ module Memorb
               RubyCompatibility.module_constant(self, :overrides)
             end
 
-            def _agents
-              RubyCompatibility.module_constant(self, :agents)
-            end
-
             def _auto_registration
               RubyCompatibility.module_constant(self, :auto_registration)
             end
@@ -259,7 +229,6 @@ module Memorb
 
         RubyCompatibility.module_constant_set(mixin, :registrations, KeyValueStore.new)
         RubyCompatibility.module_constant_set(mixin, :overrides, KeyValueStore.new)
-        RubyCompatibility.module_constant_set(mixin, :agents, KeyValueStore.new)
         RubyCompatibility.module_constant_set(mixin,
           :auto_registration,
           ::Concurrent::AtomicFixnum.new,

data/lib/memorb/integrator_class_methods.rb

@@ -7,7 +7,7 @@ module Memorb
       Integration[self]
     end
 
-    def memorb!(*args, &block)
+    def memoize(*args, &block)
       memorb.register(*args, &block)
     end
 
@@ -29,14 +29,12 @@ module Memorb
     def method_removed(name)
       super.tap do
         memorb.disable(name)
-        memorb.purge(name)
       end
     end
 
     def method_undefined(name)
       super.tap do
         memorb.disable(name)
-        memorb.purge(name)
       end
     end
 

data/lib/memorb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memorb
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/memorb/integration_spec.rb

@@ -64,7 +64,6 @@ describe ::Memorb::Integration do
     let(:integrator) { target.tap { |x| x.extend(::Memorb) } }
     let(:integrator_singleton) { integrator.singleton_class }
     let(:instance) { integrator.new }
-    let(:agent_registry) { subject.send(:_agents) }
     subject { described_class[integrator] }
 
     describe 'integrator instance methods' do
@@ -76,10 +75,6 @@ describe ::Memorb::Integration do
           agent = instance.memorb
           expect(agent.id).to equal(instance.object_id)
         end
-        it 'adds the agent to the global registry' do
-          agent = instance.memorb
-          expect(agent_registry.keys).to contain_exactly(agent.id)
-        end
       end
       describe '#memorb' do
         it 'returns the agent for the instance' do
@@ -355,27 +350,6 @@ describe ::Memorb::Integration do
         end
       end
     end
-    describe '::purge' do
-      let(:method_name) { :increment }
-      let(:method_id) { ::Memorb::MethodIdentifier.new(method_name) }
-
-      it 'clears cached data for the given method in all instances' do
-        subject.register(method_name)
-        instance.send(method_name)
-        store = instance.memorb.method_store.read(method_id)
-        expect(store.keys).not_to be_empty
-        subject.purge(method_name)
-        expect(store.keys).to be_empty
-      end
-      context 'when the given method has no cache record' do
-        it 'does not raise an error' do
-          subject.register(method_name)
-          store = instance.memorb.method_store.read(method_id)
-          expect(store).to be(nil)
-          expect { subject.purge(method_name) }.not_to raise_error
-        end
-      end
-    end
     describe '::auto_register?' do
       context 'by default' do
         it 'returns false' do
@@ -476,11 +450,6 @@ describe ::Memorb::Integration do
         agent = subject.create_agent(instance)
         expect(agent).to be_an_instance_of(::Memorb::Agent)
       end
-      it 'writes the agent to the global agent registry' do
-        agent = subject.create_agent(instance)
-        registry = subject.send(:_agents)
-        expect(registry.keys).to contain_exactly(agent.id)
-      end
     end
     it 'supports regularly invalid method names' do
       invalid_starting_chars = [0x00..0x40, 0x5b..0x60, 0x7b..0xff]
@@ -513,17 +482,5 @@ describe ::Memorb::Integration do
         expect { klass.include(subject) }.to raise_error(error, error_message)
       end
     end
-    ::SpecHelper.for_testing_garbage_collection do
-      context 'when freed by the garbage collector' do
-        it 'removes its agent from the global registry' do
-          ref = ::WeakRef.new(integrator.new)
-          agent = ref.__getobj__.memorb
-          expect(agent_registry.keys).to include(agent.id)
-          ::SpecHelper.force_garbage_collection
-          expect(ref.weakref_alive?).to be_falsey
-          expect(agent_registry.keys).to be_empty
-        end
-      end
-    end
   end
 end

data/spec/memorb/integrator_class_methods_spec.rb

@@ -10,7 +10,7 @@ describe ::Memorb::IntegratorClassMethods do
       expect(integrator.memorb).to be(integration)
     end
   end
-  describe '::memorb!' do
+  describe '::memoize' do
     it 'calls register with the same arguments' do
       spy = double('spy', register: nil)
       mod = Module.new
@@ -18,7 +18,7 @@ describe ::Memorb::IntegratorClassMethods do
       integrator.singleton_class.prepend(mod)
       block = Proc.new { nil }
       expect(spy).to receive(:register).with(:a, &block)
-      integrator.memorb!(:a, &block)
+      integrator.memoize(:a, &block)
     end
   end
   describe '::inherited' do
@@ -90,16 +90,6 @@ describe ::Memorb::IntegratorClassMethods do
       expect(integration.enabled_methods).not_to include(method_name)
       expect(integration.public_instance_methods).not_to include(method_name)
     end
-    it 'clears cached data for the method in all instances' do
-      ::Memorb::RubyCompatibility
-        .define_method(integrator, method_name) { nil }
-      integration.register(method_name)
-      instance.send(method_name)
-      store = instance.memorb.method_store.read(method_id)
-      expect(store.keys).not_to be_empty
-      ::Memorb::RubyCompatibility.remove_method(integrator, method_name)
-      expect(store.keys).to be_empty
-    end
   end
   describe '::method_undefined' do
     let(:method_name) { :method_1 }
@@ -128,15 +118,5 @@ describe ::Memorb::IntegratorClassMethods do
         instance.send(method_name)
       }.to raise_error(::NoMethodError, /undefined method/)
     end
-    it 'clears cached data for the method in all instances' do
-      ::Memorb::RubyCompatibility
-        .define_method(integrator, method_name) { nil }
-      integration.register(method_name)
-      instance.send(method_name)
-      store = instance.memorb.method_store.read(method_id)
-      expect(store.keys).not_to be_empty
-      ::Memorb::RubyCompatibility.undef_method(integrator, method_name)
-      expect(store.keys).to be_empty
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memorb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Rebsch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -89,7 +90,7 @@ homepage: https://github.com/pjrebsch/memorb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.6'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Memoization made easy
 test_files: []