memo_pad 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8dbc10fe1065849e7193f234563fdaf7938f42eb238e59cc3b40ae1b90eac5a
-  data.tar.gz: b0dc4895a3981928d68525da637ac9deea9544e88325487015cfde5d7e2f78be
+  metadata.gz: 97c689cb2334577cebb1cc240157fe251ed5c5679da2c7568dccb7afd0034ca3
+  data.tar.gz: 917b40d49c689d4709d013363aa8fa23e7f0b50e37d3b3f4d5cab2f5a7309c8d
 SHA512:
-  metadata.gz: 10fe52bbdd3db4877e9cca94856ebd9ec5f6ffcaadf2a116906b9c66363d8d5647a73113c019c08871c0d2f58f59ba6f6932f9b1fcd4d2c5036f98ed0a75f035
-  data.tar.gz: d9c2d8d228527c0f1f94a05cf092646bb49b99a2cdd85e21acfeaa1f522353ca3acff9622ddcb4afc3185ed3774aef0ae92386c8044cfadb36a62682aa61496c
+  metadata.gz: 4cf0fdf8831d0166f340962bcebf2c4fd7ce7543903e0de0236fa8a96a46f40853ee00538638bbfac5f68cd34d289e0b937e02c11df6e97e047fd82b599657b7
+  data.tar.gz: 4f36f0b1bf2f7941378e7a032cb5c8fb1eef0e706e8d03ce14f48a2284171e2b81be9c5647c51e3164854e6a9e49dd4d96acbf37955bfb3fdfef9da0ffbe38a8

data/.rubocop.yml

@@ -6,6 +6,12 @@ AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
 
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  AllowedMethods: ["describe"]
+
 Style/AccessModifierDeclarations:
   Enabled: true
   EnforcedStyle: inline
@@ -17,6 +23,3 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-02-16
+
+- Add `#clear` method to flush all cached entries on the instance.
+
+## [0.2.0] - 2024-02-14
+
+- **BREAKING**: Changes `MemoPad::Memo#call` to `MemoPad::Memo#fetch` to more closely match interfaces like `ActiveSupport::Cache`.
+- Add `#read` and `#write` methods to allow for lower-level manipulation of the cached values, similarly inspired by the interface of `ActiveSupport::Cache`.
+
 ## [0.1.0] - 2024-01-22
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    memo_pad (0.1.0)
+    memo_pad (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -27,7 +27,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 1. First, `include MemoPad` in your class.
-2. Then use `memo_pad.call(name, *args) do; end` to memoize the result of the block.
+2. Then use `memo_pad.fetch(name, *args) do; end` to memoize the result of the block.
 3. There is no step 3.
 
 ```ruby
@@ -35,30 +35,47 @@ class Foo
   include MemoPad
 
   def expensive_method
-    memo_pad.call(:expensive_method) do
+    memo_pad.fetch(:expensive_method) do
       # Do some expensive work here
     end
   end
 
   def expensive_method_with_arguments(foo, bar: nil)
-    memo_pad.call(:expensive_method, foo, bar) do
+    memo_pad.fetch(:expensive_method, foo, bar) do
       # Do expensive work here, respecting the values of `foo` and `bar`
     end
   end
 
   def complex_memoization
-    first_part = memo_pad.call(:complex_memoization_first) do
+    first_part = memo_pad.fetch(:complex_memoization_first) do
       # Some independent expensive work
     end
 
     # Maybe some other unmemoized work
 
-    memo_pad.call(:complex_memoization_second, first_part) do
+    memo_pad.fetch(:complex_memoization_second, first_part) do
       # Some other expensive work, respecting the value of `first_part`
     end
   end
 end
 ```
+
+You can directly write a memo, if needed, with `#write`. It has nearly the same signature as `#fetch`, the name and optional list of arguments, with the addition of the `value:` keyword argument to supply the value to write to the memo.
+
+```ruby
+def precache_things(things)
+  things.each do |thing|
+    memo_pad.write(:has_thing?, thing, value: true)
+  end
+end
+```
+
+You can also flush the whole of the cache on an instance.
+
+```ruby
+foo.memo_pad.clear
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/memo_pad/memo.rb

@@ -11,9 +11,26 @@ module MemoPad
       end
     end
 
-    def call(method_name, *args, &block)
-      result = cache[method_name].fetch(args, &block)
-      cache[method_name][args] = result
+    def fetch(method_name, *args, &block)
+      read!(method_name, *args)
+    rescue KeyError
+      write(method_name, *args, value: block.call)
+    end
+
+    def clear
+      cache.clear
+    end
+
+    def read(method_name, *args)
+      cache[method_name].fetch(args, nil)
+    end
+
+    def read!(method_name, *args)
+      cache[method_name].fetch(args)
+    end
+
+    def write(method_name, *args, value:)
+      cache[method_name][args] = value
     end
   end
 end

data/lib/memo_pad/version.rb

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

data/lib/memo_pad.rb

@@ -12,7 +12,7 @@ require_relative "memo_pad/memo"
 # Memoize results of complex executions on its memo_pad:
 #
 #   def expensive_method
-#     memo_pad.call(:expensive_method) do
+#     memo_pad.fetch(:expensive_method) do
 #       # perform the expensive work
 #     end
 #   end
@@ -20,7 +20,7 @@ require_relative "memo_pad/memo"
 # Pass in any arguments that the memoized result would depend on, if any:
 #
 #   def expensive_with_arguments(foo, bar: nil)
-#     memo_pad.call(:expensive_with_arguments, foo, bar) do
+#     memo_pad.fetch(:expensive_with_arguments, foo, bar) do
 #       # perform the expensive work
 #     end
 #   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memo_pad
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email: