dbg_tags 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d46c56e295261f0f6f156e3c70c41aade388aed18c0cb3e9ae76bee4aa22c3b2
-  data.tar.gz: a5d7eea81b5582c768fd1ac1300368fa5363c01a99186658f85c1c6f9811401d
+  metadata.gz: d23d3bfe9f58ffa0b26481b6aa296208c6febff871649c197506ee836a54f36e
+  data.tar.gz: 669f9963e7dcdb9bffceabff6c7f45ba48d7b75c0d7d7293d9c65d16d772eb1d
 SHA512:
-  metadata.gz: 61c3376e8b6b4eaba1887c6269ce96a92b9541a750891c0014799ca60e18ec14fdb3372d984d8b8b62576b041718709cc330776271f112284a71836058c781bf
-  data.tar.gz: 21c04cd90236a8157e74dd32228be60805f366c63448bce43f1aa6efa16863861079f0a911110b04bc45a2febd1c434797f53b2e0f3f877d374d4b1284bc9edc
+  metadata.gz: 1b2f84b3808a68011ae0a489c294e20f81d10ebc8a99f28d620191dd862b9ae399046ddfd5e9952334730377a11c6b49c8912aaca3a91c9617b24838899b5785
+  data.tar.gz: db37f12455aef1520cd5a0c1e93dbe2f352b07f3cd345fc92b367e26da649b6eb817e66550b90d64a46ebc9fa7feeb971edd0344292854b756f7e2bff23fab1d

data/lib/dbg_tags.rb

@@ -3,45 +3,41 @@
 #
 #   # enabling
 #   # -----------
-# require 'dbg_tags'
+#   require 'dbg_tags'
 #
-# Tag.enable :feature1, :feature2..., featureN: :log, featureO: :val, ...
-# Tag.enable feature1: :trc, feature2: :val
-# Tag.enable feature: Tag::TRC
-# Tag.enable :dtl # enables ALL logging for :generic 
-# Tag.enable :val # enables val+trc+log+err for :generic only
-# Tag.enable :trc # enables trc+log+err for :generic only
-# Tag.enable :log # enables log+err tags for :generic
-# Tag.enable :err # enables err tags for :generic
-# Tag.enable # sets :generic to :trc
-# Tag.enable(...) do ... end
-# Tag.enable feature: nil
-# Tag.enable feature: :nil
-# Tag.enable all: :err    # :all is a default for ALL systems, including :generic
-# Tag.enable test: :err # switch on paranoia checking
-# Tag.enable feature: '>=trc'  # make sure at least level trc
+#   Tag.enable :feature1, :feature2..., featureN: :log, featureO: :val, ...
+#   Tag.enable feature1: :trc, feature2: :val
+#   Tag.enable feature: Tag::TRC
+#   Tag.enable :dtl # enables ALL logging for :generic 
+#   Tag.enable :val # enables val+trc+log+err for :generic only
+#   Tag.enable :trc # enables trc+log+err for :generic only
+#   Tag.enable :log # enables log+err tags for :generic
+#   Tag.enable :err # enables err tags for :generic
+#   Tag.enable # sets :generic to :trc
+#   Tag.enable(...) do ... end
+#   Tag.enable feature: nil
+#   Tag.enable feature: :nil
+#   Tag.enable all: :err    # :all is a default for ALL systems, including :generic
+#   Tag.enable test: :err # switch on paranoia checking
+#   Tag.enable feature: '>=trc'  # make sure at least level trc
 #
 #   # logging 
 #   # -----------
-# Tag.err 'text', short for Tag.err(:generic) 'text' 
+#   Tag.err 'text', short for Tag.err(:generic) 'text' 
 # 		    # :err should be used for fail states and paranoia stuff
-# Tag.log 'text' # prints very important messages only
-# Tag.trc 'text' # default level, method entries, for example
-# Tag.val 'text' # prints more details
-# Tag.dtl 'text' # likely prints megabytes of details
-# Tag.err :feature, 'FAILURE'
-# Tag.log :feature, 'log me'
-# Tag.trc :feature, 'called method'
-# Tag.val(:feature) { "text#{expr}" }
-# Tag.dtl(:feature) { "text#{very complicated expr}" }
-# Tag.err(:test) { raise 'aaaarg' if complex_paranoia_failure }
-# Tag.err(:test) { raise 'CANTHAPPEN' if complex_paranoia_failure }
+#   Tag.log 'text' # prints very important messages only
+#   Tag.trc 'text' # default level, method entries, for example
+#   Tag.val 'text' # prints more details
+#   Tag.dtl 'text' # likely prints megabytes of details
+#   Tag.err :feature, 'FAILURE'
+#   Tag.log :feature, 'log me'
+#   Tag.trc :feature, 'called method'
+#   Tag.val(:feature) { "text#{expr}" }
+#   Tag.dtl(:feature) { "text#{very complicated expr}" }
+#   Tag.err(:test) { raise 'aaaarg' if complex_paranoia_failure }
+#   Tag.err(:test) { raise 'CANTHAPPEN' if complex_paranoia_failure }
 
 module Tag
-
-  # the default is :trc
-  TAG_DEFAULT_LEVEL = 3
-
   # :all overrides the minimum level on ALL tags in the system
   TAG_FEATURE_ALL = :all
 
@@ -66,79 +62,24 @@ module Tag
   # level 5. Mostly used for exhaustive dumping of attribute values and minor details
   DTL = 5
 
+  # the default is :trc
+  TAG_DEFAULT_LEVEL = TRC 
+
   # nil and :nil will both map to NONE
   TAG_MAPPING =  { none: NONE, err: ERR, log: LOG, trc: TRC, val: VAL, dtl: DTL, 
                    nil: NONE,
                    nil => NONE
                  } # TAG_MAPPING
 
-  # @@enabled[:feature] => 0..5
-  @@enabled = {} 
-  @@stream = STDERR
-
-  module InstanceMethods
-    @@inside = false
-
-    # @param feature [Symbol,nil] Subsystem to print logging for. Fully dynamic/free
-    # @param msg [String,nil] 
-    # @note feature and msg can be switched
-    # @param block [Proc,nil] If set the result overrides and msg passed.
-    # The call is silently ignored if called from inside another Tag block (likely
-    #   a sign of a stack overflow in process).
-    # The call is silently ignored if the current tag level is too low.
-    # For trc it should be trc or val or dtl to actually print something.
-    # @!method trc feature = TAG_FEATURE_GENERIC, msg = '', &block
-
-    # see trc 
-    # !method err feature = TAG_FEATURE_GENERIC, msg = '', &block
-   
-    # see trc 
-    # !method log feature = TAG_FEATURE_GENERIC, msg = '', &block
-   
-    # see trc 
-    # !method val feature = TAG_FEATURE_GENERIC, msg = '', &block
- 
-    # see trc 
-    # !method dtl feature = TAG_FEATURE_GENERIC, msg = '', &block
-  
-    TAG_MAPPING.each do |meth, lev|
-      next if lev == NONE
-      define_method meth do |feature = TAG_FEATURE_GENERIC, msg = '', &msg_block|
-	msg, feature = feature, TAG_FEATURE_GENERIC if String === feature
-#STDERR.puts "DEBUGTAG #{meth}. feature=#{feature}, level=#{Tag.level(feature)}, lev=#{lev}"
-	return if @@inside || (Tag.level(feature) || Tag::NONE) < lev
-	# either msg OR msg_block must be set
-	if msg_block 
-	  prev_inside = @@inside
-	  begin
-	    @@inside = true
-	    msg = msg_block.call 
-	  ensure
-	    @@inside = prev_inside
-	  end
-	end
-        if msg
-          c = caller[0]
-  #STDERR.puts "DEBUGTAG c[#{idx}] = #{c}, caller[1]=#{caller[1]}, caller[2]=#{caller[2]}"
-          label = c[/\w+\.rb:\d+:in `[^']+'/]&.sub(/in `([^']+)'/, '\1:') ||
-                  c[/\w+\.rb:\d+:/] ||
-                  c[/[^:\/]+:\d+:/] || 
-                  c
-          Tag.stream.print "#{label} #{msg}\n"
-        end
-      end # Tag.err, Tag.log, Tag.trc, Tag.val, Tag.dtl
-    end # each
-
-    # inside? -> true if we are currently executing a block in err/log/trc/val or dtl.
-    def inside?; @@inside; end
-
-  end # module Tag::InstanceMethods
-
-  extend InstanceMethods
-  include InstanceMethods
-
-  class << self
-    private # class methods of Tag
+  # This class stores an instance of the global state of the Tag system
+  class GlobalState
+    private
+    def initialize
+      # @enabled[:feature] => 0..5
+      @enabled = {}
+      @inside = false
+      @stream = STDERR
+    end # GlobalState.initialize
 
     # @param level_spec [Integer,Symbol,String,nil]
     # @param feature [Symbol]
@@ -162,9 +103,21 @@ module Tag
       raise ArgumentError, "bad level #{level_spec.inspect}"
     end # Tag::debunk_level
 
-    public # class methods of Tag
+    public # methods of GlobalState
 
-    # @param features [<Symbol>]
+    # @return [{Symbol} => 0..5]
+    attr :enabled
+
+    # @return [Bool] True if a Tag.err..dtl is currently active
+    attr_accessor :inside
+    alias inside? inside
+
+    # @return [IO] Current output stream
+    attr_accessor :stream
+
+    # @param features [<Symbol>] To enable on :trc level
+    # @param opts [{Symbol => Symbol}] Keys are features, values levels.
+    # A block can be given to restore the original state afterwards
     # enable :feature, ...[, feature: level, ...] [block]
     # :generic is NO LONGER IMPLICETELY ENABLED as of version 1.0.0
     # Use :all to set a default for all features not mentioned otherwise
@@ -173,62 +126,157 @@ module Tag
     # Strings can be used in the shape of 'err' or '>=err' etc.
     # If '>=LVL' is used the level will not lower, if already set in an outer block.
     # If no level is specified for a feature the default is :trc (== TRC == 3)
-    # use nil or :none to disable all tags, even the ERR level ones.
+    # use nil, :nil, :none or Tag::NONE to disable all tags, even the ERR level ones.
     #
     # enable performs a merge with an existing enable.
     def enable *features, **opts
-      org_enabled = @@enabled.dup # to restore the state at the end (unused unless block_given)
+      org_enabled = @enabled.clone # to restore the state at the end (unused unless block_given)
       features.each do |feature|
         case feature
         when 0..5 # not a feature, apply to :generic
-          @@enabled[TAG_FEATURE_GENERIC] = feature 
+          @enabled[TAG_FEATURE_GENERIC] = feature 
         when Symbol
           if TAG_MAPPING[feature] # not a feature 
-            @@enabled[TAG_FEATURE_GENERIC] = TAG_MAPPING[feature]
+            @enabled[TAG_FEATURE_GENERIC] = TAG_MAPPING[feature]
           else
-            @@enabled[feature] = TAG_DEFAULT_LEVEL
+            @enabled[feature] = TAG_DEFAULT_LEVEL
           end
         when String
-          @@enabled[TAG_FEATURE_GENERIC] = debunk_level feature, TAG_FEATURE_GENERIC
+          @enabled[TAG_FEATURE_GENERIC] = debunk_level feature, TAG_FEATURE_GENERIC
         else
           raise ArgumentError "bad level #{feature.inspect}"
         end # case
       end # each
       opts.each do |feature, level|
         # OK        STDERR.puts "OPTION!!!!!!!!!!!!!!!!!, calling debunk_level"
-        @@enabled[feature] = debunk_level level, feature
+        @enabled[feature] = debunk_level level, feature
       end
       if features.empty? && opts.empty?
-        @@enabled[TAG_FEATURE_GENERIC] = TAG_DEFAULT_LEVEL
+        @enabled[TAG_FEATURE_GENERIC] = TAG_DEFAULT_LEVEL
       end
       if block_given?
-#        STDERR.puts "TAG: block_given!"
         begin
-#          STDERR.puts "TAG: yield!"
           yield
         ensure
-          @@enabled = org_enabled
+          @enabled = org_enabled
         end # ensure
       end # block_given?
-    end # Tag.enable
+    end # GlobalState.enable
+
+    # @param state [{Symbol=>0..5}] As returned by Tag.state (aka Tag.enabled)
+    # A block can be given to restore the original state afterwards.
+    # restore_state overwrites any existing enabled feature.
+    def restore_state state
+      org_enabled = @enabled.clone # to restore the state at the end (unused unless block_given)
+      @enabled = state.dup
+      if block_given?
+        begin
+          yield
+        ensure
+          @enabled = org_enabled
+        end # ensure
+      end # block_given?
+    end # GlobalState.restore_state
+
+    # @param feature [Symbol]
+    # @return [0..5] Current effective level for feature.
+    def level feature
+      @enabled[feature] || @enabled[TAG_FEATURE_ALL] || Tag::NONE 
+    end # GlobalState.level
+  end # GlobalState
+
+  class << self
+
+    public # class methods of Tag
+
+    # @return [GlobalState] Thread local data 
+    def global_state
+      if gs = Thread.current[:dbg_tags_global_state]
+        gs
+      else
+        Thread.current[:dbg_tags_global_state] = GlobalState.new
+      end
+    end # Tag::global_state
+
+    # @param feature [Symbol,nil] Subsystem to print logging for. Fully dynamic/free
+    # @param msg [String,nil] 
+    # @note feature and msg can be switched
+    # @param block [Proc,nil] If set the result overrides and msg passed.
+    # The call is silently ignored if called from inside another Tag block (likely
+    # a sign of a stack overflow in process).
+    # The call is silently ignored if the current tag level is too low.
+    # For trc it should be trc or val or dtl to actually print something.
+    # @!method trc feature = TAG_FEATURE_GENERIC, msg = '', &block
+
+    # @!method err feature = TAG_FEATURE_GENERIC, msg = '', &block
+    # @see trc 
+   
+    # @!method log feature = TAG_FEATURE_GENERIC, msg = '', &block
+    # @see trc 
+   
+    # @!method val feature = TAG_FEATURE_GENERIC, msg = '', &block
+    # @see trc 
+ 
+    # @!method dtl feature = TAG_FEATURE_GENERIC, msg = '', &block
+    # @see trc 
+  
+    TAG_MAPPING.each do |meth, lev|
+      next if lev == NONE
+      define_method meth do |feature = TAG_FEATURE_GENERIC, msg = '', &msg_block|
+        state = global_state
+	msg, feature = feature, TAG_FEATURE_GENERIC if String === feature
+#STDERR.puts "DEBUGTAG #{meth}. feature=#{feature}, level=#{Tag.level(feature)}, lev=#{lev}"
+        return if state.inside? || (state.level(feature) || Tag::NONE) < lev
+	# either msg OR msg_block must be set
+	if msg_block
+          prev_inside = state.inside?
+	  begin
+            state.inside = true
+	    msg = msg_block.call 
+	  ensure
+            state.inside = prev_inside
+	  end
+	end
+        if msg
+          c = caller[0]
+  #STDERR.puts "DEBUGTAG c[#{idx}] = #{c}, caller[1]=#{caller[1]}, caller[2]=#{caller[2]}"
+          label = c[/\w+\.rb:\d+:in `[^']+'/]&.sub(/in `([^']+)'/, '\1:') ||
+                  c[/\w+\.rb:\d+:/] ||
+                  c[/[^:\/]+:\d+:/] || 
+                  c
+          state.stream.print "#{label} #{msg}\n"
+        end
+      end # Tag.err, Tag.log, Tag.trc, Tag.val, Tag.dtl
+    end # each
+
+    # inside? -> true if we are currently executing a block in err/log/trc/val or dtl.
+    def inside?; global_state.inside?; end
+
+    # @see GlobalState.enable
+    def enable(...); global_state.enable(...); end
+
+    # @see GlobalState.restore_state
+    def restore_state(...); global_state.restore_state(...); end
 
     # @return [{Symbol=>0..5}] Keys are the features
-    def enabled; @@enabled; end
+    def enabled; global_state.enabled; end
+    alias state enabled
 
     # @return [IO] By default this is STDERR
-    def stream; @@stream; end
+    def stream; global_state.stream; end
 
     # @param val [IO] 
     # Override the output stream.
-    def stream= val; @@stream = val; end
+    def stream= val; global_state.stream = val; end
 
     # @param feature [Symbol]
     # @return [0..5] Current effective level for feature.
     # 2023-08-14 no longer returns nil
-    def level feature; @@enabled[feature] || @@enabled[TAG_FEATURE_ALL] || Tag::NONE; end
+    def level feature; global_state.level feature; end
 
     # @param feature [Symbol]
     # @return [bool] Reflects explicit enable calls only. The :all feature is IGNORED
-    def enabled? feature; (@@enabled[feature] || NONE) > NONE; end
+    def enabled? feature; (global_state.enabled[feature] || NONE) > NONE; end
+
   end # singleton class Tag
 end # module Tag

data/spec/01_tag_spec.rb

@@ -1,6 +1,8 @@
 
-require 'simplecov'
-SimpleCov.start
+if t = ENV['USE_SIMPLECOV'] and !t.empty?
+  require 'simplecov'
+  SimpleCov.start { add_filter '/spec/' }
+end
 
 require_relative '../lib/dbg_tags'
 
@@ -9,7 +11,7 @@ class Pathological
     Tag.trc { "HERE in #{self}!" }
     super
   end # to_s
-end 
+end # class Pathological
 
 describe 'tag' do
   before :each do
@@ -252,6 +254,99 @@ describe 'tag' do
     end # it
   end # context 'Nested levels'
 
+  it 'has thread local data to prevent mix ups (tag_300)' do
+    t1 = Thread.new do
+      Tag.enable threads: :trc do
+        Tag.trc(:threads) {
+          expect(Tag.inside?).to be true
+          sleep 1
+          nil
+        }
+      end
+    end 
+    t2 = Thread.new do
+      sleep 0.2
+      expect(Tag.enabled).to eq({})
+      expect(Tag.inside?).to be false
+    end 
+    t1.join
+    t2.join
+  end # it
+
+  it 'each thread has a private tag system (tag_301)' do
+    Tag.enable threads: :trc do
+      expect(Tag.enabled).to eq({threads: 3})
+      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.inside?).to be true
+            sleep 1
+            nil
+          }
+        end
+      end 
+      t1.join
+      expect(Tag.enabled).to eq({threads: 3})
+    end
+  end # it
+
+  it 'each fiber has a private tag system (tag_302)' do
+    Tag.enable threads: :trc do
+      expect(Tag.enabled).to eq({threads: 3})
+      t1 = Fiber.new do
+        expect(Tag.enabled).to eq({})
+        Tag.enable threads: :log do
+          expect(Tag.enabled).to eq({threads: 2})
+          Tag.trc(:threads) {
+            expect(Tag.inside?).to be true
+            sleep 1
+            nil
+          }
+        end
+      end 
+      t1.resume
+      expect(Tag.enabled).to eq({threads: 3})
+    end
+  end # it
+
+  it 'does allow restore_state to transfer state through a Fiber barrier (tag_310)' do
+    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
+        expect(Tag.state).to eq({})
+        Tag.enable foo: :trc
+        Tag.restore_state state do
+          expect(Tag.state).to eq({example: Tag::DTL, fiber: Tag::TRC})
+          did_something = true
+        end
+      end
+      t1.resume
+      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
+    did_something = false
+    state = Tag.state
+    expect(state).to eq({})
+    t1 = Fiber.new do
+      expect(Tag.state).to eq({})
+      Tag.enable foo: :trc
+      Tag.restore_state state do
+        expect(Tag.state).to eq({})
+        did_something = true
+      end
+    end
+    t1.resume
+    expect(Tag.state).to eq({})
+    expect(did_something).to be true
+  end # it
+
   it 'does not allow levels out of range (tag_900)' do
     expect do
       Tag.enable nest: 24
@@ -269,4 +364,5 @@ describe 'tag' do
       Tag.enable nest: '>=foo'
     end.to raise_error ArgumentError, /bad level/i
   end # it
+
 end # describe

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbg_tags
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Eugene Brazwick
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2024-06-04 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
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.5
-signing_key:
+signing_key: 
 specification_version: 4
 summary: a versatile dynamic debug tracing system
 test_files: