tag_ripper 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375a528cbf8942e0dd48c51ffe10c005a6b3672b414e82b5d768011f3355e350
-  data.tar.gz: f3e74892414a1587e5dfabeba4cda6839f2dd500f800bda6303fa2ea97f18042
+  metadata.gz: 2e80933d8c317438627b041b30bd905ae33ed8d993db4ef149e69f3f71fd30d7
+  data.tar.gz: 7eeb22fc466b8b50da7f6d3e887dfc02c04d0de462abf870f36bf0beda6b3a68
 SHA512:
-  metadata.gz: 49ababa76c465f7fa6a691f968290a6668762d884e0be15ca3790e6b6b884853aa1ff1bbbe78c9afdeef293b85ab4f3470357d635c9dda531257f26e81d4700b
-  data.tar.gz: 07311f3a4768f8643c0fafcab84f3b6318392a5c1726bcfccf2fcfd1291db35e4039d4493adeb4e0241765b086e56bd2fbb3feee4e9065452c4880df3a9d88f9
+  metadata.gz: 131915acf06d838e8d5aa62ee92b62eab06743071298aa57fb887975cd9414b825d9929a40349bd6e4607ee5b7475eb41dc205939dc8a86d8c51856880317692
+  data.tar.gz: e7e86cc4d7984e3f05d1743d42892ee235152467a16f64edbc64cfe79d9683a5130aa013ce193084adb3348d509cc06938d78bbf5d2823efcb7a33ef61fbcf89

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,12 @@
+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
+
+guard :rubocop, all_on_start: false do
+  watch(/^.+\.rb$/)
+  watch(%r{^(config|test)/.+\.rb$})
+  watch("Gemfile")
+  watch(".rubocop.yml")
+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

@@ -34,17 +34,18 @@ 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)
       @name = name
       @tags = Hash.new { |hash, key| hash[key] = Set.new }
       @parent = parent
-      @type = nil
+      @type = type
       self.status = :pending
     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
@@ -52,6 +53,13 @@ module TagRipper
       end
     end
 
+    def debug_event(event_name, lex)
+      puts <<~OUTPUT.chomp
+        Sending #{event_name} to #{self} with #{lex.token.inspect}
+        #{inspect}"
+      OUTPUT
+    end
+
     def module?
       (type == :module) | (type == :class)
     end
@@ -63,7 +71,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,6 +108,10 @@ module TagRipper
       self.status = :awaiting_name
     end
 
+    def name?
+      !!@name
+    end
+
     def name=(name)
       unless may_name?
         raise IllegalStateTransitionError.new(from: @status, to: :named)
@@ -137,10 +149,20 @@ module TagRipper
       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,6 +175,10 @@ module TagRipper
       @parent
     end
 
+    def status
+      @status
+    end
+
     protected
 
     def append_name!(string)
@@ -182,10 +208,6 @@ module TagRipper
       @tags[name].add(value)
     end
 
-    def named?
-      !!@name
-    end
-
     def build_child
       self.class.new(parent: self)
     end
@@ -216,7 +238,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
@@ -233,10 +255,10 @@ module TagRipper
       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?("::")
+      return self unless may_name? || (name? && @name.end_with?("::"))
 
       # self.status = :awaiting_name # TODO: Fix this with a proper state
-      if named? && @name.end_with?("::")
+      if named? && @name.to_s.end_with?("::")
         append_name!(lex.token)
       else
         self.name = "#{name}#{lex.token}"
@@ -257,6 +279,24 @@ module TagRipper
       if lex.double_colon?
         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.2.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tag_ripper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Gavin Morrice
 bindir: exe
 cert_chain: []
-date: 2025-06-19 00:00:00.000000000 Z
+date: 2025-07-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