dbg_tags 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23d3bfe9f58ffa0b26481b6aa296208c6febff871649c197506ee836a54f36e
-  data.tar.gz: 669f9963e7dcdb9bffceabff6c7f45ba48d7b75c0d7d7293d9c65d16d772eb1d
+  metadata.gz: a8e0401ca437e4c46fe63c0fa1aeb0a952e0bb26bb9470b72cf630201cc9e0fd
+  data.tar.gz: a148a7f14a0a8eeac1109f00ec9a8f0b768f391c2c218f1fc03fa3b61c8abed2
 SHA512:
-  metadata.gz: 1b2f84b3808a68011ae0a489c294e20f81d10ebc8a99f28d620191dd862b9ae399046ddfd5e9952334730377a11c6b49c8912aaca3a91c9617b24838899b5785
-  data.tar.gz: db37f12455aef1520cd5a0c1e93dbe2f352b07f3cd345fc92b367e26da649b6eb817e66550b90d64a46ebc9fa7feeb971edd0344292854b756f7e2bff23fab1d
+  metadata.gz: 82fa4fd016e062e9901d306dc44597ddf6eaad44201721ea874228e59114eb371e4322d3799c6e1aab1fda467534490f32109fb26ff0aa09db48368e485ae3be
+  data.tar.gz: cb6d061257ee53ddb4962468aa03dd507499a4aebe400483818210b729c04c4af0eca967617fe8d594deead9500aef05ae068a7e379c38c8728b29ddc0113e9c

data/lib/dbg_tags.rb

@@ -187,14 +187,41 @@ module Tag
 
   class << self
 
+    private # class methods of Tag
+
+    # @param value [Bool] Value to set
+    # Primarily for rspec stuff. Use {disable_thread_local_state} instead
+    def no_thread_local_state= value
+      @no_thread_local_state = value
+    end # Tag::no_thread_local_state=
+
     public # class methods of Tag
 
-    # @return [GlobalState] Thread local data 
+    # @return [Bool,nil] True if we should store global state inside the Tag class itself.
+    attr :no_thread_local_state
+    alias no_thread_local_state? no_thread_local_state
+
+    # DEPRECATED
+    alias no_fiber_local_state? no_thread_local_state? # for B.C.
+
+    # @return [Bool] True (the default) if we should store global state
+    # in each thread of the application.
+    def use_thread_local_state?; !no_thread_local_state? end
+
+    # DEPRECATED
+    alias use_fiber_local_state? use_thread_local_state? # for B.C.
+
+    # @return [GlobalState] Either thread local data (default) or truly global.
     def global_state
-      if gs = Thread.current[:dbg_tags_global_state]
-        gs
+      if @no_thread_local_state
+        @global_state ||= GlobalState.new
       else
-        Thread.current[:dbg_tags_global_state] = GlobalState.new
+        ct = Thread.current 
+        unless state = ct.thread_variable_get(:dbg_tags_global_state)
+          state = GlobalState.new
+          ct.thread_variable_set :dbg_tags_global_state, state
+        end
+        state
       end
     end # Tag::global_state
 
@@ -278,5 +305,23 @@ module Tag
     # @return [bool] Reflects explicit enable calls only. The :all feature is IGNORED
     def enabled? feature; (global_state.enabled[feature] || NONE) > NONE; end
 
+    # shortcut for no_thread_local_state = true
+    # By default thread local state is enabled and this means that
+    # 'enabling' of tags in some thread does effect in others.
+    # So: when using threads leave this enabled, as it will cause race conditions
+    # otherwise.
+    # When not using threads, it is more efficient to disable it.
+    def disable_thread_local_state; self.no_thread_local_state = true end
+  
+    # DEPRECATED
+    alias disable_fiber_local_state disable_thread_local_state # for B.C.
+
+    # shortcut for no_thread_local_state := false
+    # For rspec use mostly.
+    def enable_thread_local_state; self.no_thread_local_state = false end
+
+    # DEPRECATED
+    alias enable_fiber_local_state enable_thread_local_state # for B.C.
+
   end # singleton class Tag
 end # module Tag

data/spec/01_tag_spec.rb

@@ -255,6 +255,7 @@ describe 'tag' do
   end # context 'Nested levels'
 
   it 'has thread local data to prevent mix ups (tag_300)' do
+    Tag.enable_thread_local_state # NOTE enabled by default, but other examples may botch it
     t1 = Thread.new do
       Tag.enable threads: :trc do
         Tag.trc(:threads) {
@@ -274,49 +275,101 @@ describe 'tag' do
   end # it
 
   it 'each thread has a private tag system (tag_301)' do
+    Tag.enable_thread_local_state # NOTE enabled by default, but other examples may botch it
+    executed = false
     Tag.enable threads: :trc do
-      expect(Tag.enabled).to eq({threads: 3})
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
       t1 = Thread.new do
         expect(Tag.enabled).to eq({})
         Tag.enable threads: :log do
-          expect(Tag.enabled).to eq({threads: 2})
-          Tag.trc(:threads) {
+          expect(Tag.enabled).to eq({threads: Tag::LOG})
+          Tag.log(:threads) {
             expect(Tag.inside?).to be true
             sleep 1
+            executed = true
             nil
           }
         end
       end 
       t1.join
-      expect(Tag.enabled).to eq({threads: 3})
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
     end
+    expect(executed).to be true
   end # it
 
-  it 'each fiber has a private tag system (tag_302)' do
+  it 'each thread has a private tag system (tag_302)' do
+    Tag.enable_thread_local_state # NOTE enabled by default, but other examples may botch it
+    executed = false
     Tag.enable threads: :trc do
-      expect(Tag.enabled).to eq({threads: 3})
-      t1 = Fiber.new do
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
+      t1 = Thread.new do
         expect(Tag.enabled).to eq({})
         Tag.enable threads: :log do
-          expect(Tag.enabled).to eq({threads: 2})
-          Tag.trc(:threads) {
+          expect(Tag.enabled).to eq({threads: Tag::LOG})
+          Tag.log(:threads) {
             expect(Tag.inside?).to be true
-            sleep 1
+            executed = true
+            nil
+          }
+        end
+      end 
+      t1.join
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
+    end
+    expect(executed).to be true
+  end # it
+
+  it 'Fibers share the tag state (tag_303)' do
+    Tag.enable_thread_local_state # NOTE enabled by default, but other examples may botch it
+    executed = false
+    Tag.enable threads: :trc do
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
+      t1 = Fiber.new do
+        expect(Tag.enabled).to eq({threads: Tag::TRC})
+        Tag.enable threads: :log do
+          expect(Tag.enabled).to eq({threads: Tag::LOG})
+          Tag.log(:threads) {
+            expect(Tag.inside?).to be true
+            executed = true
             nil
           }
         end
       end 
       t1.resume
-      expect(Tag.enabled).to eq({threads: 3})
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
     end
+    expect(executed).to be true
   end # it
 
-  it 'does allow restore_state to transfer state through a Fiber barrier (tag_310)' do
+  it 'allows to disable thread local state (tag_305)' do
+    Tag.disable_thread_local_state
+    executed = false
+    Tag.enable threads: :trc do
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
+      t1 = Thread.new do
+        expect(Tag.enabled).to eq({threads: Tag::TRC})
+        Tag.enable threads: :log do
+          expect(Tag.enabled).to eq({threads: Tag::LOG})
+          Tag.log(:threads) {
+            expect(Tag.inside?).to be true
+            executed = true
+            nil
+          }
+        end
+      end 
+      t1.join
+      expect(Tag.enabled).to eq({threads: Tag::TRC})
+      expect(executed).to be true
+    end
+  end # it
+
+  it 'does allow restore_state to transfer state into a Thread (tag_310)' do
+    Tag.enable_thread_local_state
     did_something = false
     Tag.enable example: :dtl, fiber: :trc do
       state = Tag.state # same as Tag.enabled
       expect(state).to eq({example: Tag::DTL, fiber: Tag::TRC})
-      t1 = Fiber.new do
+      t1 = Thread.new do
         expect(Tag.state).to eq({})
         Tag.enable foo: :trc
         Tag.restore_state state do
@@ -324,17 +377,18 @@ describe 'tag' do
           did_something = true
         end
       end
-      t1.resume
+      t1.join
       expect(Tag.state).to eq({example: Tag::DTL, fiber: Tag::TRC})
     end # enable
     expect(did_something).to be true
   end # it
 
-  it 'does allow a nil-state to transfer state through a Fiber barrier (tag_311)' do
+  it 'does allow a nil-state to transfer into a Thread (tag_311)' do
+    Tag.enable_thread_local_state
     did_something = false
     state = Tag.state
     expect(state).to eq({})
-    t1 = Fiber.new do
+    t1 = Thread.new do
       expect(Tag.state).to eq({})
       Tag.enable foo: :trc
       Tag.restore_state state do
@@ -342,7 +396,7 @@ describe 'tag' do
         did_something = true
       end
     end
-    t1.resume
+    t1.join
     expect(Tag.state).to eq({})
     expect(did_something).to be true
   end # it

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbg_tags
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eugene Brazwick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2026-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,7 +66,7 @@ homepage: https://github.com/Eugene-Brazwick/dbg_tags
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: a versatile dynamic debug tracing system
 test_files: