ractor-cache 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ed3b5b4ab4307230b9dab1a21f269ac9d3bae8803f11bb209798df4de02e031
-  data.tar.gz: ed75a15f8035a23955d1e25ce9c88e32a540881a2322ba0267c0c98302d50010
+  metadata.gz: 5e9137be1f90de7eed4e93838b8d0035747afd9b3f7be3211ab6777e0eded201
+  data.tar.gz: da7ccf5d0d16439ac04d2e8bc5763cc9883672717974fcc744a95bb69e6bb00c
 SHA512:
-  metadata.gz: 63984280a9bc9d9530e86cc4d9c69987a4dbcc0128cf3525bf434006bbfc3b00515f5fb1e2aa65c85050cb37691dd666d7b39f1d9d05574078c29713501c8780
-  data.tar.gz: 4e9725ab3449785e3b87a594c13c4175a083cc5910bf72c5fece2bcdcd4da7ce3c4ac4aa222553c6efceb8525a9490173e0f32274fdee13e6c9dfaeb01a0f878
+  metadata.gz: cbdd4316207650c65565de5c8dd6a2534689b9e237ba0b42583812248cef6ba764e218374ee45b256925aef52748436ff7e03d05eda93adba08412236f5882f8
+  data.tar.gz: d2fd27ff3e85f403fa8bfd010cd69b600dda81e09593855c48f31de80948e346f1c531101becc2c2b9df5708253b079314c3dc033e5360894141b2c047985f92

data/.rubocop.yml

@@ -70,3 +70,7 @@ Lint/UselessAssignment:
 Layout/HashAlignment:
   Exclude:
     - 'lib/ractor/cache/cached_method.rb'
+
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*.rb'

data/README.md

@@ -18,12 +18,21 @@ class Foo
     do_long_calculation
   end
 end
+
+# Lower level "manual" usage (discussed later):
+class Foo
+  include Ractor::Cache # => defines a `ractor_cache` method that returns a hash
+
+  def long_calc
+    ractor_cache[:long_calc] ||= do_long_calculation
+  end
+end
 ```
 
 ## Why?
 
 0) It's pretty
-1) Handles `nil` / `false` results
+1) Handles `nil` / `false` results ("manual" usage: DIY)
 2) Works even for frozen instances
 3) Works even for deeply frozen instances (`Ractor`-shareable).
 
@@ -71,7 +80,7 @@ foo.long_calc # => `FrozenError`, @cache is frozen
 
 ## How to resolve this
 
-This gem will use associate a mutable data structure to the instance. Even if deeply-frozen it can still mutate the data structure. The data is Ractor-local, so it won't be shared and won't cause issues. Internally a `WeakMap` is used to make sure objects are still garbage collected as they should.
+This gem will associate a mutable data structure to the instance. Even if deeply-frozen it can still mutate the data structure. The data is Ractor-local, so it won't be shared and won't cause issues. A `WeakMap` is used to make sure objects are still garbage collected as they should.
 
 Implementation details [explained here](hacker_guide.md)
 

data/lib/ractor/cache.rb

@@ -7,12 +7,13 @@ class Ractor
   module Cache
     require_relative_dir
 
-    private def cache(method_name)
-      CachingLayer[self].cache(method_name)
-    end
+    CacheStore = ::Hash # By default, use a Hash
+    include CachingLayer
 
     refine Module do
-      include Cache
+      def cache(method_name)
+        CachingLayer[self].cache(method_name)
+      end
     end
   end
 end

data/lib/ractor/cache/caching_layer.rb

@@ -12,16 +12,16 @@ class Ractor
 
       if use_ractor_storage
         private def ractor_cache
-          CachingLayer.ractor_storage[self] ||= self.class::Store.new
+          CachingLayer.ractor_storage[self] ||= self.class::CacheStore.new
         end
       else
         def freeze
-          ractor_cache
+          ractor_cache # make sure cache is initialized before freezing
           super
         end
 
         private def ractor_cache
-          @ractor_cache ||= self.class::Store.new
+          @ractor_cache ||= self.class::CacheStore.new
         end
       end
 
@@ -38,7 +38,7 @@ class Ractor
           file, line = cm.method(:compile_method).source_location
           module_eval(cm.compile_method, file, line + 2)
           @cached << cm
-          update_store_methods(self::Store)
+          update_store_methods(self::CacheStore)
         end
 
         private def update_store_methods(store)
@@ -59,8 +59,8 @@ class Ractor
           @cached = []
           @parent = mod
           mod.prepend self
-          substore = sublayer&.const_get(:Store, false) || Cache::Store
-          const_set(:Store, Class.new(substore))
+          substore = sublayer&.const_get(:CacheStore, false) || Cache::Store
+          const_set(:CacheStore, Class.new(substore))
 
           self
         end

data/lib/ractor/cache/version.rb

@@ -2,6 +2,6 @@
 
 class Ractor
   module Cache
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ractor-cache
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc-Andre Lafortune