thread_local_var_accessors 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6e9d88de11a15e80e03d531bbb506da4b962e057ee1e88f0eb56f79c0eca74
-  data.tar.gz: 919b3b1100b7d8683317869cda3dbd87672ba6e30a0a86c565fffd0cefadcc99
+  metadata.gz: f567c363dc63194dc30aeae5d661ea14c871f9f64cc65ed3d2c2947447d1fc91
+  data.tar.gz: 30c3bc0763221a483de2370af6843c83b39ff6429f27f1b6ad796931fa9dae51
 SHA512:
-  metadata.gz: 2c1c294e53542491de381e69ff49b9b68942f6d5dc06ef8256f954dbec8af9c23396a4fd995d10701017b790c51880c6928c451c4e521c0b7cef80233af50aba
-  data.tar.gz: 740127f6247210b11f2ad478005eb459780afa6f50e451416b74a6ac35081d1ab818151b85bab786dd60031f71ee67cc01fc7b45423c454976f66834e000d0e0
+  metadata.gz: 59329574532e6730a71d3f44d011bedae930ee29a0b592f9ff8fbf7ed6d824a13cb65ab9f51edb40df372615c5975f459bd483fc467f5914af48f992a21f7cfc
+  data.tar.gz: 822c3f467f172562efdab7a38cc73063b42b8937f09d71ad01345c52d80fa69bc438a60067756386aa8d4d8ba74055513cd4303875a3784b13a5d07e3120adcc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    thread_local_var_accessors (0.1.1)
+    thread_local_var_accessors (0.1.2)
       concurrent-ruby
 
 GEM

data/README.md

@@ -105,17 +105,30 @@ Then:
 
 ## Usage
 
-Use the class methods to declare instance getter and setter methods:
+To use the class methods, they must be included into the current module or class, with:
 
-    tlv_reader   :name1
-    tlv_writer   :name2
-    tlv_accessor :name3, :name4
+    class MyNewClass
+      include ThreadLocalVarAccessors
+        ...
+    end
+    
+With the include above, you can use the class methods to declare instance getter and setter methods:
+
+    class MyNewClass
+      include ThreadLocalVarAccessors
+
+      tlv_reader   :name1
+      tlv_writer   :name2
+      tlv_accessor :name3, :name4
+      
+    end
     
 The above invocations: 
+
 - create reader methods for `name1`, `name3`, and `name4`.
 - create writer methods for `name2`, `name3`, and `name4`.
 
-The writer methods accept a value as the second argument, or from the result of an associated block.
+The writer methods accept a value as the second argument, or from the result of an optional, associated block.
 
 Note: to use the read-and-operate operators, eg: `+=`, `-=`, `||=`, etc., the object must have both a reader and writer method.  In other words, it needs to have been created as an `tlv_accessor`.
 
@@ -130,9 +143,17 @@ Alternative block forms:
     tlv_set(name)      { |oldval| newval }
     tlv_set_once(name) { |oldval| newval }
 
-
 In all cases, the `name` can be a string or symbol, with or without a leading `@`.
 
+Ultimately, these methods are all doing these basic accesses of the corresponding instance variables:
+
+    @name1 ||= ThreadLocalVar.new
+    @name1.value = per_thread_value
+    ...
+    @name1.value # returns the per_thread_value
+    
+If you prefer the style above, then you don't really need these accessor methods. 
+
 ### Example Usage
 
 ```ruby

data/lib/thread_local_var_accessors/version.rb

@@ -1,3 +1,3 @@
 module ThreadLocalVarAccessors
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thread_local_var_accessors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alan Stebbens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler