tag_ripper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375a528cbf8942e0dd48c51ffe10c005a6b3672b414e82b5d768011f3355e350
-  data.tar.gz: f3e74892414a1587e5dfabeba4cda6839f2dd500f800bda6303fa2ea97f18042
+  metadata.gz: e8223c939423f3fce3c103a0e16649b925cc2cf9d0130618e4172c8f8e206bde
+  data.tar.gz: dbd6a188942b85df76b27189df7cdcbfea4257e10c6fd7003467fdb552eb25b7
 SHA512:
-  metadata.gz: 49ababa76c465f7fa6a691f968290a6668762d884e0be15ca3790e6b6b884853aa1ff1bbbe78c9afdeef293b85ab4f3470357d635c9dda531257f26e81d4700b
-  data.tar.gz: 07311f3a4768f8643c0fafcab84f3b6318392a5c1726bcfccf2fcfd1291db35e4039d4493adeb4e0241765b086e56bd2fbb3feee4e9065452c4880df3a9d88f9
+  metadata.gz: 1a72eee3e5dbcafe2729452701418ea233ee6f0439bab493d7220687081a0fa9efc6ec20cb4d4fab5eaf6ea427e0fc5a5df7d6269f20bbfd53feadc5454abf50
+  data.tar.gz: 556c44f1683a4c46c896e11d4c0da33c1e1c14af6061a8ce28072feb8187bc56e6763e357e7d7a568c55da99f2edb95d78a13b56ff0b19124023df382d703be7

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
   Exclude:
     - bin/*
     - test/fixtures/**/*  # These files have particular styles that should be preserved
+    - samples/**/*  # These files have particular styles that should be preserved
 Metrics/AbcSize:
   Exclude:
     - test/**/*

data/.ruby-version

@@ -1 +1 @@
-3.4.2
+3.4.3

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest, cli: "--verbose" do
+  watch(%r{^test/(.+)_test\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch("test/test_helper.rb") { "test" }
+end

data/README.md

@@ -5,7 +5,24 @@
 
 Lets you annotate Ruby code with tags that can be parsed and collected in code.
 
-Example:
+
+## Installation
+
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add tag_ripper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install tag_ripper
+```
+
+## Usage
+
 
 ```ruby
 # @domain: Auth
@@ -35,25 +52,6 @@ TagRipper.new(File.read('user.rb')).taggables
 #    parent: nil
 ```
 
-## Installation
-
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add tag_ripper
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install tag_ripper
-```
-
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -62,7 +60,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/bodacious/tag-ripper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bodacious/tag-ripper/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/bodacious/tag_ripper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bodacious/tag_ripper/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -70,4 +68,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Tag::Ripper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bodacious/tag-ripper/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Tag::Ripper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bodacious/tag_ripper/blob/master/CODE_OF_CONDUCT.md).

data/lib/tag_ripper/lexical_token.rb

@@ -3,8 +3,22 @@ module TagRipper
     require "forwardable"
     extend Forwardable
 
-    TAG_REGEX = /#\s@(?<tag_name>[\w_-]+):\s(?<tag_value>.+)/
-    END_TOKEN = "end".freeze
+    TAG_REGEX = /#\s@(?<tag_name>[\w-]+):\s(?<tag_value>.+)/
+
+    ##
+    # = Operators =
+
+    DOUBLE_COLON = "::".freeze
+    SINGLETON_CLASS = "<<".freeze
+
+    ##
+    # = Keywords =
+
+    KEYWORD_CONST = "const".freeze
+    KEYWORD_CLASS = "class".freeze
+    KEYWORD_DEF = "def".freeze
+    KEYWORD_END = "end".freeze
+    KEYWORD_MODULE = "module".freeze
 
     class Location
       attr_reader :col
@@ -50,7 +64,11 @@ module TagRipper
     end
 
     def double_colon?
-      token == "::"
+      token == DOUBLE_COLON
+    end
+
+    def singleton_class?
+      token == SINGLETON_CLASS
     end
 
     def keyword?
@@ -58,7 +76,7 @@ module TagRipper
     end
 
     def end?
-      keyword? && token == END_TOKEN
+      keyword? && token == KEYWORD_END
     end
 
     def tag_name
@@ -76,13 +94,10 @@ module TagRipper
     def on_kw_type
       return nil unless keyword?
 
-      case token
-      when "const" then :class
-      when "module" then :module
-      when "def" then :instance_method
-      else
-        :unknown
-      end
+      const_lookup = "KEYWORD_#{token.upcase}"
+      return :unknown unless self.class.const_defined?(const_lookup)
+
+      self.class.const_get(const_lookup).to_sym
     end
   end
 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,22 +37,32 @@ module TagRipper
     # @return [Array<Symbol>]
     OPENED_STATUSES = %i[tagged awaiting_name named].freeze
 
-    def initialize(name: nil, parent: 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 = nil
-      self.status = :pending
+      @type = type
+      self.status = status
     end
 
     alias id object_id
 
     def send_event(event_name, lex)
-      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(*strings)
+      return if ENV.fetch("TAG_RIPPER_DEBUG", "false") == "false"
+
+      puts strings.join(" - ")
     end
 
     def module?
@@ -63,7 +76,7 @@ module TagRipper
     # The fully-qualified name of this entity (e.g. +"Foo::Bar::MyClass"+)
     # @return [String]
     def fqn
-      return nil unless named?
+      return nil unless name?
       return name if fqn_names.size == 1
 
       if type == :instance_method
@@ -100,12 +113,16 @@ module TagRipper
       self.status = :awaiting_name
     end
 
-    def name=(name)
-      unless may_name?
+    def name?
+      !!@name
+    end
+
+    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
 
@@ -133,14 +150,28 @@ module TagRipper
       awaiting_name?
     end
 
+    def may_append_name?
+      awaiting_name? | naming?
+    end
+
     def may_close?
       named?
     end
 
+    def parent_id
+      parent&.id
+    end
+
     def inspect
-      "<id=#{id},@name=#{@name},tags=#{@tags},parent=#{@parent}>"
+      exposed_properties = %i[object_id name fqn type parent_id status tags]
+      inner_string = exposed_properties.map do |property|
+        "#{property}=#{public_send(property)}"
+      end.join(", ")
+      "<#{inner_string}>"
     end
 
+    alias to_s inspect
+
     def tags
       @tags.dup
     end
@@ -153,11 +184,19 @@ module TagRipper
       @parent
     end
 
+    def status
+      @status
+    end
+
     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
 
@@ -182,10 +221,6 @@ module TagRipper
       @tags[name].add(value)
     end
 
-    def named?
-      !!@name
-    end
-
     def build_child
       self.class.new(parent: self)
     end
@@ -216,7 +251,7 @@ module TagRipper
       returnable_entity = named? ? build_child : self
 
       returnable_entity.await_name!
-      self.type = lex.on_kw_type
+      returnable_entity.type = lex.on_kw_type
 
       returnable_entity
     end
@@ -229,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.end_with?("::")
 
-      # self.status = :awaiting_name # TODO: Fix this with a proper state
-      if named? && @name.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
@@ -254,9 +303,27 @@ 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
+
+      # return name_from_op(lex) if lex.singleton_class?
+      self
+    end
+
+    def on_kw_self(lex)
+      if module? && awaiting_name?
+        self.name = lex.token
+        return self
+      end
+
+      self
+    end
+
+    ##
+    # Name the current entity 'self' based on an operator (e.g. +class << self+)
+    def name_from_kw(lex)
+      self.name = lex.token
       self
     end
 

data/lib/tag_ripper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TagRipper
-  VERSION = "0.2.0"
+  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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gavin Morrice
 bindir: exe
 cert_chain: []
-date: 2025-06-19 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:
@@ -21,6 +21,7 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -52,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: []