tag_ripper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f55c43ce02431ffc69bd9284ec5875678d743e3c14544f3ebb0710e440921b8
+  data.tar.gz: 10b1baa79118d897442fd87e49ee7da2b9259172802246f22e0ea5a3b3855d72
+SHA512:
+  metadata.gz: ab28505f7eb7784a4a90d7613960263251b43f9d8dcbca34570c360828f7c651e3b60d5e518b0d98e6722e0fc214a53e27f8280dfe3713962474c5914074fb5c
+  data.tar.gz: c38bd4b3c85a1a6b02f7fe57ab61e69ea729f031d9f6a04fd40a85e71e978c820d7577d63a060079f3309a704452b779fa994d7fca6cc09d547dbcbdbb8622af

data/.env.test

@@ -0,0 +1 @@
+TAG_RIPPER_DEBUG=true

data/.rubocop.yml

@@ -0,0 +1,33 @@
+inherit_from: https://raw.githubusercontent.com/Bodacious/style-guides/refs/heads/main/.rubocop.yml
+
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: true
+
+Metrics/AbcSize:
+  Exclude:
+    - test/**/*
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[tag-ripper{at}gavinmorrice{dot}com](mailto:tag-ripper@gavinmorrice.com).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Gavin Morrice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Tag::Ripper
+
+
+[![Ruby](https://github.com/Bodacious/tag-ripper/actions/workflows/main.yml/badge.svg)](https://github.com/Bodacious/tag-ripper/actions/workflows/main.yml)
+
+Lets you annotate Ruby code with tags that can be parsed and collected in code.
+
+Example:
+
+```ruby
+# @domain: Auth
+class User
+  # @warning: untested
+  def some_method_that_isnt_tested
+    # ...
+  end
+end
+
+TagRipper.new(File.read('user.rb')).taggables
+# => [
+# <id=22040, @name=some_method_that_isnt_tested, tags={"warning" => #<Set: {"untested"}>},parent=#<TagRipper::TaggableEntity:0x00000001203bf468>>,
+#  <id=22224, @name=User, tags={"domain" => #<Set: {"Auth"}>},parent=>nil
+# ]
+```
+
+## Installation
+
+TODO: Replace `tag_ripper` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/tag_ripper/configuration.rb

@@ -0,0 +1,28 @@
+module TagRipper
+  class Configuration
+    def initialize
+      @only_tags = Set.new
+      @except_tags = Set.new
+    end
+
+    def eval_config(&block)
+      block.call(self)
+    end
+
+    def only_tags
+      @only_tags.dup
+    end
+
+    def only_tags=(tags)
+      @only_tags = tags.to_set
+    end
+
+    def except_tags
+      @except_tags.dup
+    end
+
+    def except_tags=(tags)
+      @except_tags = tags.to_set
+    end
+  end
+end

data/lib/tag_ripper/lexical_token.rb

@@ -0,0 +1,84 @@
+module TagRipper
+  class LexicalToken
+    require "forwardable"
+    extend Forwardable
+
+    TAG_REGEX = /#\s@(?<tag_name>[\w_-]+):\s(?<tag_value>.+)/
+    END_TOKEN = "end".freeze
+
+    class Location
+      attr_reader :col
+      attr_reader :line
+
+      def initialize(col, line)
+        @col = col
+        @line = line
+        freeze
+      end
+    end
+
+    private_constant :Location
+
+    def_delegators :location, :col, :line
+
+    attr_reader :location
+
+    attr_reader :type
+
+    def initialize((col, line), type, token)
+      @location = Location.new(col, line)
+      @type = type.to_sym
+      @token = token.to_s
+    end
+
+    def to_s
+      token
+    end
+
+    alias event type
+
+    def token
+      @token.dup
+    end
+
+    def comment?
+      type == :on_comment
+    end
+
+    def tag_comment?
+      comment? && token.match?(TAG_REGEX)
+    end
+
+    def keyword?
+      type == :on_kw
+    end
+
+    def end?
+      keyword? && token == END_TOKEN
+    end
+
+    def tag_name
+      return nil unless tag_comment?
+
+      token.match(TAG_REGEX)[:tag_name]
+    end
+
+    def tag_value
+      return nil unless tag_comment?
+
+      token.match(TAG_REGEX)[:tag_value]
+    end
+
+    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
+    end
+  end
+end

data/lib/tag_ripper/ripper.rb

@@ -0,0 +1,36 @@
+module TagRipper
+  class Ripper
+    # Ruby's Ripper lib
+    # https://ruby-doc.org/stdlib-2.5.1/libdoc/ripper/rdoc/Ripper.html
+    require "ripper"
+
+    def initialize(code_string)
+      tokens = ::Ripper.lex(code_string)
+      @lexical_tokens = tokens.map do |(col, line), type, token, _|
+        LexicalToken.new([col, line], type, token)
+      end
+    end
+
+    def taggables
+      @taggables ||= process_taggables
+    end
+
+    def taggable_modules
+      taggables.select(&:module?)
+    end
+
+    protected
+
+    def process_taggables
+      return_taggables = []
+      @lexical_tokens.inject(TaggableEntity.new) do |current_taggable, lex|
+        current_taggable = TaggableEntity.new if current_taggable.nil?
+
+        next_taggable = current_taggable.send_event(lex.event, lex)
+        return_taggables << current_taggable if current_taggable.closed?
+        next_taggable
+      end
+      return_taggables
+    end
+  end
+end

data/lib/tag_ripper/taggable_entity.rb

@@ -0,0 +1,214 @@
+module TagRipper
+  # Follows the state changes of a taggable entity (class, model, or method)
+  # as it responds to various Lexical tokens.
+  # The idea here is that this class will mutate on each new 'event', where
+  # and event is the presence of a new lexical token.
+  #
+  # TaggableEntities begin in a pre-open state, and become open when their
+  # lexical scope opens up. When a new lexical nesting is detected, a child
+  # entity is spawned. This creates a sort of recursion that allows a taggable
+  # entity to be flexible to any amount of code nesting.
+  class TaggableEntity
+    class IllegalStateTransitionError < StandardError
+      def initialize(from:, to:)
+        super("Cannot transition from #{from} to #{to}")
+      end
+    end
+
+    def initialize(name: nil, parent: nil)
+      @name = name
+      @tags = Hash.new { |hash, key| hash[key] = Set.new }
+      @parent = parent
+      @type = nil
+      @status = :pending
+    end
+
+    def send_event(event_name, lex)
+      puts "send_event: #{event_name} - #{lex} #(#{@status})"
+      if respond_to?(event_name, true)
+        send(event_name, lex)
+      else
+        self
+      end
+    end
+
+    def module?
+      (type == :module) | (type == :class)
+    end
+
+    def type
+      @type
+    end
+    def fqn
+      return nil unless named?
+      return name if fqn_names.size == 1
+
+      if type == :instance_method
+        fqn_names[0..-2].join("::") + "##{name}"
+      else
+        fqn_names.join("::")
+      end
+    end
+    alias fully_qualified_name fqn
+
+    def pending? = @status == :pending
+
+    def tagged? = @status == :tagged
+
+    def awaiting_name? = @status == :awaiting_name
+
+    OPENED_STATUSES = %i[tagged awaiting_name named].freeze
+
+    def open?
+      OPENED_STATUSES.include?(@status)
+    end
+
+    def tag!(tag_name, tag_value)
+      unless may_tag?
+        raise IllegalStateTransitionError.new(from: @status, to: :tagged)
+      end
+
+      @status = :tagged
+
+      add_tag(tag_name, tag_value)
+    end
+
+    def await_name!
+      unless may_await_name?
+        raise IllegalStateTransitionError.new(from: @status, to: :awaiting_name)
+      end
+
+      @status = :awaiting_name
+    end
+
+    def name=(name)
+      unless may_name?
+        raise IllegalStateTransitionError.new(from: @status, to: :named)
+      end
+
+      @name = name.to_s
+      @status = :named
+    end
+
+    def close!
+      @open = false
+      @status = :closed
+      freeze
+    end
+
+    def closed?
+      @status == :closed
+    end
+
+    def may_tag?
+      pending? | tagged?
+    end
+
+    def may_await_name?
+      pending? | tagged?
+    end
+
+    def may_name?
+      awaiting_name?
+    end
+
+    def may_close?
+      named?
+    end
+
+    def inspect
+      "<id=#{id},@name=#{@name},tags=#{@tags},parent=#{@parent}>"
+    end
+
+    def tags
+      @tags.dup
+    end
+
+    def name
+      @name.to_s.dup
+    end
+
+    def type=(type)
+      @type = type.to_sym
+    end
+
+    protected
+
+    alias id object_id
+
+    def fqn_names
+      return [name] if parent.nil?
+
+      [*parent.fqn_names, name]
+    end
+
+    def parent
+      @parent
+    end
+
+    def add_tag(name, value)
+      @tags[name].add(value)
+    end
+
+    def named?
+      !!@name
+    end
+
+    def build_child
+      self.class.new(parent: self)
+    end
+
+    # Lex is a comment
+    def on_comment(lex)
+      return self unless lex.tag_comment?
+
+      receiver = named? ? build_child : self
+      if TagRipper.config.only_tags.empty? ||
+         TagRipper.config.only_tags.include?(lex.tag_name)
+        receiver.tag!(lex.tag_name, lex.tag_value)
+      end
+      receiver
+    end
+
+    # Lex is a keyword (e.g. class, module, private, end, etc.)
+    def on_kw(lex)
+      event_token_method_name = :"#{lex.event}_#{lex.token}"
+      return self unless respond_to?(event_token_method_name, true)
+
+      send(event_token_method_name, lex)
+    end
+
+    def on_new_taggable_context_kw(lex)
+      returnable_entity = named? ? build_child : self
+
+      returnable_entity.await_name!
+      self.type = lex.on_kw_type
+
+      returnable_entity
+    end
+
+    alias on_kw_def on_new_taggable_context_kw
+    alias on_kw_module on_new_taggable_context_kw
+    alias on_kw_class on_new_taggable_context_kw
+
+    IGNORED_IDENT_KEYWORDS = %w[require private class_eval instance_eval define_method].freeze
+    private_constant :IGNORED_IDENT_KEYWORDS
+
+    def name_from_lex(lex)
+      return self if IGNORED_IDENT_KEYWORDS.include?(lex.token)
+      return self if named?
+      return self unless may_name?
+
+      self.name = lex.token
+      self
+    end
+
+    alias on_const name_from_lex
+    alias on_ident name_from_lex
+
+    def on_kw_end(_lex)
+      close!
+      parent
+    end
+  end
+end

data/lib/tag_ripper/version.rb

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

data/lib/tag_ripper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "set" unless defined?(Set)
+
+require_relative "tag_ripper/ripper"
+require_relative "tag_ripper/lexical_token"
+require_relative "tag_ripper/taggable_entity"
+require_relative "tag_ripper/configuration"
+module TagRipper
+  class << self
+    def configure(&)
+      configuration.eval_config(&)
+    end
+
+    def configuration
+      @configuration ||= reset_configuration!
+    end
+    alias config configuration
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: tag_ripper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gavin Morrice
+bindir: exe
+cert_chain: []
+date: 2025-04-03 00:00:00.000000000 Z
+dependencies: []
+description: Add tags to your Ruby code comments and then Rip the as lexical tokens
+email:
+- gavin@gavinmorrice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tag_ripper.rb
+- lib/tag_ripper/configuration.rb
+- lib/tag_ripper/lexical_token.rb
+- lib/tag_ripper/ripper.rb
+- lib/tag_ripper/taggable_entity.rb
+- lib/tag_ripper/version.rb
+homepage: https://github.com/Bodacious/tag-ripper/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Bodacious/tag-ripper/
+  source_code_uri: https://github.com/Bodacious/tag-ripper/
+  changelog_uri: https://github.com/Bodacious/tag-ripper/
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rips tags from Ruby code
+test_files: []