contextual_memery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a011f6e427ef5596ab389ba2139429244b850f68b1040b4f96ceb3cf086153e
+  data.tar.gz: 5e3cffb9f6b7c3cc4f0f1fc416ef2ca77968bb89f74584bbaed0ff901e686183
+SHA512:
+  metadata.gz: 1be657f8eac292d36590671e9985395854e4a32304e2428dc849d605bcd5a0578709ece3be968410db2b8003def19edc16e54c1999bc7c80f8af9760265f3a29
+  data.tar.gz: ffe195070b5c659e989273e62ded24dcbf51e0be999296f165e42c551621415bf90c4bcddfce77008ae10f969aad11c8355a189c44d6447cf7d038071348d9ce

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-07-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 RobL
+
+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,146 @@
+# ContextualMemery
+
+`ContextualMemery` builds on the [`memery`](https://github.com/DmitryTsepelev/memery) gem to
+let you turn memoization on and off *at runtime*, scoped to a block, for one or more methods,
+on either an instance or a class.
+
+Where `memery` memoizes a method for the lifetime of the object, `ContextualMemery` memoizes a
+method only for the duration of a block:
+
+```ruby
+instance.banana_time # not memoized
+instance.banana_time # not memoized, recomputed
+
+instance.memoized(:banana_time) do
+  instance.banana_time # computed
+  instance.banana_time # cached
+end
+
+instance.banana_time # not memoized again, cache has been cleared
+```
+
+This is handy when you want to memoize a call for the duration of a request, a job, a loop
+iteration, etc., without permanently memoizing it for the object's whole lifetime.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add contextual_memery
+```
+
+## Usage
+
+Include `ContextualMemery` in your class:
+
+```ruby
+class Thing
+  include ContextualMemery
+
+  def banana_time(*)
+    ...
+  end
+
+  def handyman
+    ...
+  end
+
+  def self.take_back(*)
+    ...
+  end
+end
+```
+
+This gives both instances *and* the class a `memoized` method.
+
+### On an instance
+
+```ruby
+instance = Thing.new
+
+instance.memoized(:banana_time) do
+  instance.banana_time
+  instance.banana_time # cached
+  instance.handyman    # not memoized, still recomputed every call
+end
+```
+
+Pass several method names to memoize more than one method at once:
+
+```ruby
+instance.memoized(:banana_time, :douglas) do
+  ...
+end
+```
+
+Pass `:all`, or no arguments at all, to memoize every method defined directly on the object
+(public, protected and private) for the duration of the block:
+
+```ruby
+instance.memoized(:all) do
+  ...
+end
+
+instance.memoized do
+  ...
+end
+```
+
+### On a class
+
+The exact same API is available on the class itself, for memoizing class (singleton) methods:
+
+```ruby
+Thing.memoized(:take_back) do
+  Thing.take_back
+  Thing.take_back # cached
+end
+```
+
+### Scoped to the block, including indirect calls
+
+Memoization is active for any call made from within the block, even indirectly through other
+methods — it isn't limited to calls written literally inside the `do...end`:
+
+```ruby
+def do_thing(onion)
+  Thing.take_back(onion)
+end
+
+Thing.memoized(:take_back) do
+  foods.each do |food|
+    do_thing(food.skin) # each unique `food.skin` is only computed once
+  end
+end
+```
+
+### Scoping and nesting
+
+- Memoization is scoped per object: memoizing `instance_a` never affects `instance_b`, and
+  memoizing an instance never affects the class (or vice versa).
+- Arguments are still taken into account, exactly like plain `memery`: `banana_time(1)` and
+  `banana_time(2)` are cached separately.
+- The cache is cleared as soon as the outermost `memoized` block for that object finishes, so
+  nesting `memoized` blocks on the same object is safe and won't clear the cache out from under
+  an enclosing block.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to
+run the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and the created tag, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/braindeaf/contextual_memery.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/contextual_memery/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ContextualMemery
+  VERSION = "0.1.0"
+end

data/lib/contextual_memery.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "memery"
+require_relative "contextual_memery/version"
+
+# Mix `ContextualMemery` into a class to gain a `memoized` method that turns on
+# Memery memoization for the duration of a block only, e.g.
+#
+#   class Thing
+#     include ContextualMemery
+#
+#     def banana_time
+#       ...
+#     end
+#   end
+#
+#   instance = Thing.new
+#   instance.memoized(:banana_time) do
+#     instance.banana_time # computed
+#     instance.banana_time # cached
+#   end
+#   instance.banana_time # computed again, cache is gone
+#
+# `include`-ing this module also `extend`s the including class with it, so the
+# same `memoized` method is available on the class itself, letting you scope
+# memoization to class (singleton) methods too:
+#
+#   Thing.memoized(:take_back) do
+#     Thing.take_back
+#     Thing.take_back
+#   end
+module ContextualMemery
+  class Error < StandardError; end
+
+  # Thread-local nesting depth per memoized target (a singleton class), so
+  # that nested #memoized calls on the same object don't clear the cache out
+  # from under an outer, still-active block.
+  THREAD_KEY = :contextual_memery_depths
+
+  # Methods we never want swept up by the implicit "memoize everything" mode.
+  EXCLUDED_METHOD_NAMES = %i[memoized initialize].freeze
+
+  def self.included(base)
+    super
+    base.extend(self)
+  end
+
+  # Turns on memoization for +method_names+ (or every method defined
+  # directly on the receiver when none are given, or +:all+ is given) for the
+  # duration of the block. Works the same whether called on an instance or on
+  # a class/module.
+  def memoized(*method_names)
+    raise ArgumentError, "memoized requires a block" unless block_given?
+
+    target = singleton_class
+    target.include(Memery) unless target.include?(Memery)
+
+    memoize_methods!(target, method_names_to_memoize(method_names))
+
+    ContextualMemery.enter(target)
+    begin
+      yield
+    ensure
+      clear_memery_cache! if ContextualMemery.leave(target)
+    end
+  end
+
+  private
+
+  def memoize_methods!(target, names)
+    names.each do |name|
+      next if target.memoized?(name)
+
+      target.memoize(name, condition: -> { ContextualMemery.active?(target) })
+    end
+  end
+
+  def method_names_to_memoize(method_names)
+    names = (method_names.empty? || method_names == [:all]) ? own_method_names : method_names
+    names.map(&:to_sym) - EXCLUDED_METHOD_NAMES
+  end
+
+  def own_method_names
+    owner = is_a?(Module) ? singleton_class : self.class
+    owner.instance_methods(false) +
+      owner.private_instance_methods(false) +
+      owner.protected_instance_methods(false)
+  end
+
+  class << self
+    def active?(target)
+      depths.fetch(target, 0) > 0
+    end
+
+    def enter(target)
+      depths[target] = depths.fetch(target, 0) + 1
+    end
+
+    # Returns true when this call closed the outermost #memoized block for
+    # +target+, i.e. it's now safe to clear its memoized cache.
+    def leave(target)
+      depths[target] -= 1
+      if depths[target] <= 0
+        depths.delete(target)
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    def depths
+      Thread.current[THREAD_KEY] ||= {}
+    end
+  end
+end

data/sig/contextual_memery.rbs

@@ -0,0 +1,4 @@
+module ContextualMemery
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: contextual_memery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RobL
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ContextualMemery wraps the memery gem to let you turn memoization on
+  and off at runtime, for specific methods, scoped to a block, on either a class or
+  an instance.
+email:
+- contact@robl.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/contextual_memery.rb
+- lib/contextual_memery/version.rb
+- sig/contextual_memery.rbs
+homepage: https://github.com/braindeaf/contextual_memery
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/braindeaf/contextual_memery
+  source_code_uri: https://github.com/braindeaf/contextual_memery.git
+  changelog_uri: https://github.com/braindeaf/contextual_memery/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Dynamically scope Memery memoization to a block, on a class or an instance.
+test_files: []