tag_ripper 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e80933d8c317438627b041b30bd905ae33ed8d993db4ef149e69f3f71fd30d7
-  data.tar.gz: 7eeb22fc466b8b50da7f6d3e887dfc02c04d0de462abf870f36bf0beda6b3a68
+  metadata.gz: e8223c939423f3fce3c103a0e16649b925cc2cf9d0130618e4172c8f8e206bde
+  data.tar.gz: dbd6a188942b85df76b27189df7cdcbfea4257e10c6fd7003467fdb552eb25b7
 SHA512:
-  metadata.gz: 131915acf06d838e8d5aa62ee92b62eab06743071298aa57fb887975cd9414b825d9929a40349bd6e4607ee5b7475eb41dc205939dc8a86d8c51856880317692
-  data.tar.gz: e7e86cc4d7984e3f05d1743d42892ee235152467a16f64edbc64cfe79d9683a5130aa013ce193084adb3348d509cc06938d78bbf5d2823efcb7a33ef61fbcf89
+  metadata.gz: 1a72eee3e5dbcafe2729452701418ea233ee6f0439bab493d7220687081a0fa9efc6ec20cb4d4fab5eaf6ea427e0fc5a5df7d6269f20bbfd53feadc5454abf50
+  data.tar.gz: 556c44f1683a4c46c896e11d4c0da33c1e1c14af6061a8ce28072feb8187bc56e6763e357e7d7a568c55da99f2edb95d78a13b56ff0b19124023df382d703be7

data/Guardfile

@@ -3,10 +3,3 @@ guard :minitest, cli: "--verbose" do
   watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
   watch("test/test_helper.rb") { "test" }
 end
-
-guard :rubocop, all_on_start: false do
-  watch(/^.+\.rb$/)
-  watch(%r{^(config|test)/.+\.rb$})
-  watch("Gemfile")
-  watch(".rubocop.yml")
-end

data/lib/tag_ripper/taggable_entity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module TagRipper
   # Follows the state changes of a taggable entity (class, model, or method)
   # as it responds to various Lexical tokens.
@@ -26,6 +28,7 @@ module TagRipper
       pending
       tagged
       awaiting_name
+      naming
       named
       closed
     ].freeze
@@ -34,30 +37,32 @@ module TagRipper
     # @return [Array<Symbol>]
     OPENED_STATUSES = %i[tagged awaiting_name named].freeze
 
-    def initialize(name: nil, parent: nil, type: nil)
+    def initialize(name: nil, parent: nil, type: nil, status: :pending)
       @name = name
       @tags = Hash.new { |hash, key| hash[key] = Set.new }
       @parent = parent
       @type = type
-      self.status = :pending
+      self.status = status
     end
 
     alias id object_id
 
     def send_event(event_name, lex)
-      debug_event(event_name, lex) if ENV["DEBUG_TAG_RIPPER"]
-      if respond_to?(event_name, true)
-        send(event_name, lex)
-      else
-        self
-      end
+      debug(<<~DEBUG)
+        Sending #{event_name} to #{self} with #{lex.token.inspect}
+        #{inspect}
+
+      DEBUG
+
+      return self unless respond_to?(event_name, true)
+
+      send(event_name, lex)
     end
 
-    def debug_event(event_name, lex)
-      puts <<~OUTPUT.chomp
-        Sending #{event_name} to #{self} with #{lex.token.inspect}
-        #{inspect}"
-      OUTPUT
+    def debug(*strings)
+      return if ENV.fetch("TAG_RIPPER_DEBUG", "false") == "false"
+
+      puts strings.join(" - ")
     end
 
     def module?
@@ -112,12 +117,12 @@ module TagRipper
       !!@name
     end
 
-    def name=(name)
-      unless may_name?
+    def name=(value)
+      unless may_append_name?
         raise IllegalStateTransitionError.new(from: @status, to: :named)
       end
 
-      @name = name.to_s
+      @name = value
       self.status = :named
     end
 
@@ -145,6 +150,10 @@ module TagRipper
       awaiting_name?
     end
 
+    def may_append_name?
+      awaiting_name? | naming?
+    end
+
     def may_close?
       named?
     end
@@ -182,8 +191,12 @@ module TagRipper
     protected
 
     def append_name!(string)
-      raise StandardError, "Cannot append #{string} to nil" unless @name
+      unless may_append_name?
+        raise IllegalStateTransitionError.new(from: @status, to: :naming)
+      end
 
+      @status = :naming
+      @name ||= ""
       @name.concat(string.to_s)
     end
 
@@ -251,22 +264,36 @@ module TagRipper
                                 define_method].freeze
     private_constant :IGNORED_IDENT_KEYWORDS
 
-    def name_from_lex(lex) # rubocop:disable Metrics
+    def name_from_lex(lex)
       return self if IGNORED_IDENT_KEYWORDS.include?(lex.token)
-      # TODO: Simplify this logic
-      return self if named? && !@name.end_with?("::")
-      return self unless may_name? || (name? && @name.end_with?("::"))
 
-      # self.status = :awaiting_name # TODO: Fix this with a proper state
-      if named? && @name.to_s.end_with?("::")
-        append_name!(lex.token)
-      else
-        self.name = "#{name}#{lex.token}"
-      end
+      # If we are already done naming, then we don't want to name some more...
+      return self if named?
+
+      # Unless we are awaiting more name information, return self
+      return self unless may_append_name?
+
+      append_name!(lex.token)
 
       self
     end # rubocop:enable Metrics
 
+    # Token is not likely to be part of a TaggableEntity name
+    # (e.g. spaces, newlines, semicolons, keywords...)
+    def on_non_name_token(_lex)
+      if naming?
+        @status = :named
+      end
+      self
+    end
+
+    alias on_nl on_non_name_token
+    alias on_sp on_non_name_token
+    alias on_semicolon on_non_name_token
+    alias on_comma on_non_name_token
+    alias on_lparen on_non_name_token
+    alias on_rparen on_non_name_token
+
     ##
     # Matches names of constants: module names, const names, etc.
     alias on_const name_from_lex
@@ -276,7 +303,7 @@ module TagRipper
     alias on_ident name_from_lex
 
     def on_op(lex)
-      if lex.double_colon?
+      if lex.double_colon? && may_append_name?
         append_name!(lex.token)
       end
 

data/lib/tag_ripper/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tag_ripper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Gavin Morrice
 bindir: exe
 cert_chain: []
-date: 2025-07-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Add tags to your Ruby code comments and then Rip the as lexical tokens
 email:
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Rips tags from Ruby code
 test_files: []