offense_to_corrector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3aa29d338b6fbe90a8b026e2a5a7008e4772bfe52b988a26856b6cd4c585a1b
+  data.tar.gz: 63a528f40daa7da31df15a872d66fc0181a72fb457b1e5c23885deb752dbe6f1
+SHA512:
+  metadata.gz: b565e890a4a449467882d5ed53787990342fa5515c38e50f71653480594f4113bb564c1f353be2bdf879ca6cb9263dd9dbf5a58bef4b048e3106febaa303026b
+  data.tar.gz: 23de46b53c06aa98dfc0c4342cce5e4344c955187dbc7d65c5161e96271a7268a89f0fe09939a46a34e7b7f524ed37e24958eeddb647bf69e0a08170be13f41d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 keystonelemur@gmail.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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in offense_to_corrector.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    offense_to_corrector (0.0.1)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  offense_to_corrector!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Brandon Weaver
+
+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,106 @@
+# OffenseToCorrector
+
+> **WARNING**: This is an experimental alpha used as a proof-of-concept, and will
+> require some work to be ready for full-time use in the field.
+
+Takes a RuboCop of Ruby offense like so:
+
+```ruby
+code = <<~RUBY
+  update_attributes_book.update_attributes(author: "Alice")
+                         ^^^^^^^^^^^^^^^^^ Use `update` instead of `update_attributes`.
+RUBY
+```
+
+...and turns it into a skeleton for a RuboCop corrector:
+
+```ruby
+puts OffenseToCorrector.node_offense_data(CODE)
+
+{
+  offending_node: %(#<struct OffenseToCorrector::AtomNode
+    source="update_attributes",
+    range=23..40,
+    parent=s(:send,
+      s(:send, nil, :update_attributes_book), :update_attributes,
+      s(:hash,
+        s(:pair,
+          s(:sym, :author),
+          s(:str, "Alice"))))>),
+  offending_node_matcher: "(send ... :update_attributes ...)"
+}
+
+puts OffenseToCorrector.offense_to_cop(code)
+
+# Generated content
+module RuboCop
+  module Cop
+    module Lint
+      class TODO < Cop
+        MSG = "Use `update` instead of `update_attributes`."
+
+        def_node_matcher :matches?, <<~PATTERN
+          (send ... :update_attributes ...)
+        PATTERN
+
+        def on_send(node)
+          return false unless matches?(node)
+
+          add_offense(node,
+            message: MSG,
+            location: :selector,
+            severity: :warning
+          )
+        end
+
+        # def autocorrect(node)
+        #   lambda do |corrector|
+        #     corrector.replace(
+        #       node.loc.selector,
+        #       "<NEW_CODE_HERE>"
+        #     )
+        #   end
+        # end
+      end
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'offense_to_corrector'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install offense_to_corrector
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/baweaver/offense_to_corrector. 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/baweaver/offense_to_corrector/blob/main/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 OffenseToCorrector project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/baweaver/offense_to_corrector/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/offense_to_corrector/templates/autocorrector_template.erb

@@ -0,0 +1,32 @@
+module RuboCop
+  module Cop
+    module <%= cop_type %>
+      class <%= class_name %> < Cop
+        MSG = "<%= error_message %>"
+
+        def_node_matcher :matches?, <<~PATTERN
+          <%= match_pattern %>
+        PATTERN
+
+        def on_<%= node_type %>(node)
+          return false unless matches?(node)
+
+          add_offense(node,
+            message: MSG,
+            location: :<%= node_location.to_sym %>,
+            severity: :<%= offense_severity.to_sym %>
+          )
+        end
+
+        # def autocorrect(node)
+        #   lambda do |corrector|
+        #     corrector.replace(
+        #       node.loc.<%= node_location.to_s %>,
+        #       "<NEW_CODE_HERE>"
+        #     )
+        #   end
+        # end
+      end
+    end
+  end
+end

data/lib/offense_to_corrector/version.rb

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

data/lib/offense_to_corrector.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+require_relative "offense_to_corrector/version"
+
+require "rubocop"
+require "erb"
+
+module OffenseToCorrector
+  module_function def load_template(name)
+    File.join(File.dirname(__FILE__), "offense_to_corrector/templates", name)
+  end
+
+  module_function def node_offense_data(code)
+    OffenseParser.new(code).node_offense_info
+  end
+
+  module_function def offense_to_cop(code)
+    OffenseParser.new(code).render
+  end
+
+  # The annoying thing is that `RuboCop::AST::Node` 's children / descendant
+  # methods don't capture all the relevant data, so we have to cheat a bit
+  # by wrapping atoms (String, Symbol, Int, etc) in a class to get around that.
+  AtomNode = Struct.new(:source, :range, :parent, keyword_init: true) do
+    def type
+      self.parent.type
+    end
+
+    def to_s
+      relevant_children = self.parent.children.map do |c|
+        next "..." unless c.to_s == self.source.to_s # Wildcard
+
+        case c
+        when String then %("#{c}") # Literal string
+        when Symbol then ":#{c}"   # Literal symbol
+        else c
+        end
+      end
+
+      # The trick here is that these aren't nodes, but we do care about
+      # what the "parent" is that contains it to get something we can
+      # work with. All other children are replaced with wildcards.
+      "(#{self.parent.type} #{relevant_children.join(' ')})"
+    end
+  end
+
+  module AstTools
+    def atom?(value)
+      !value.is_a?(RuboCop::AST::Node)
+    end
+
+    # I may have to work on getting this one later to try and
+    # narrow the band of `AtomNode`
+    # def childless?(node)
+    #   false # TODO
+    # end
+
+    # How much do two ranges overlap? Used to see how well a node
+    # matches with the associated underline
+    def range_overlap_count(a, b)
+      return (b.begin...[a.end, b.end].min).size if a.cover?(b.begin)
+      return (a.begin...[a.end, b.end].min).size if b.cover?(a.begin)
+
+      0
+    end
+
+    # See if a range overlaps another one, bidirectional
+    def range_overlap?(a, b)
+      a.cover?(b.begin) || b.cover?(a.begin)
+    end
+
+    # To get an AST we need the processed source of a string
+    def processed_source_from(string)
+      RuboCop::ProcessedSource.new(string, RUBY_VERSION.to_f)
+    end
+
+    # So why bother with the above then? If we end up into correctors
+    # and tree-rewrites we need that original processed source to be
+    # the basis of the AST, otherwise we get object ID mismatches.
+    def ast_from(value)
+      case value
+      when RuboCop::ProcessedSource
+        value.ast
+      else
+        processed_source_from(value).ast
+      end
+    end
+
+    # Not needed quite yet, but could very potentially be used to verify
+    # how accurate generated cops are.
+    def get_corrector(value)
+      RuboCop::Cop::Corrector.new(value.buffer)
+    end
+
+    # Descendants leaves out a _lot_ of detail potentially. There has to
+    # be a better way to deal with this, but not thinking of one right now.
+    def get_children(source_node)
+      recurse = -> node do
+        collected_children = []
+        node.children.each do |child|
+          next if child.nil?
+
+          # If it's a regular node carry on as you were
+          unless atom?(child) # || childless?(child)
+            collected_children.concat([child, *recurse[child]])
+            next
+          end
+
+          # Otherwise we want to find where that node is in the source code,
+          # and the range it exists in, to create an `AtomNode`
+          child_string = child.to_s
+          range_begin = source_node.source.index(/\b#{child_string}\b/)
+          range_end   = range_begin + child_string.size
+
+          collected_children << AtomNode.new(
+            parent: node,
+            source: child_string,
+            range: range_begin..range_end
+          )
+        end
+
+        collected_children
+      end
+
+      [source_node, *recurse[source_node]]
+    end
+  end
+
+  # ERB template for rendering a cop skeleton, may make this more useful
+  # later, but mostly quick templating for now.
+  class OffenseTemplate
+    def initialize(name: "autocorrector_template.erb")
+      @template = File.read(OffenseToCorrector.load_template(name))
+      @erb = ERB.new(@template)
+    end
+
+    def render(
+      class_name: "TODO",
+      match_pattern:,
+      error_message: "",
+      node_type:,
+      cop_type: "Lint",
+      node_location: "selector",
+      offense_severity: "warning"
+    )
+      @erb.result_with_hash(
+        class_name:,
+        match_pattern:,
+        error_message:,
+        node_type:,
+        cop_type:,
+        node_location:,
+        offense_severity:
+      )
+    end
+  end
+
+  # Bit more of a structured container for an offense (the underline)
+  Offense = Struct.new(:line, :error, :range, keyword_init: true)
+
+  class OffenseParser
+    include AstTools
+
+    # How many underline carots (^), and potentially an error after
+    OFFENSE_MATCH = /^ *?(?<underline>\^+) *?(?<error>.*)?$/
+
+    attr_reader :ast, :source, :offense
+
+    def initialize(string)
+      @ast_lines,  @offense = parse_string(string)
+      @source = processed_source_from(@ast_lines.join("\n"))
+      @ast = ast_from(@source)
+      @ast_nodes = get_children(@ast)
+      @template = OffenseTemplate.new
+    end
+
+    # Render that into the cop skeleton. Perhaps having too much
+    # fun here with rightward assignment.
+    def render
+      call => {
+        offense: { error: },
+        node_offense_info: { offending_node:, offending_node_matcher: }
+      }
+
+      @template.render(
+        class_name: "TODO",
+        match_pattern: offending_node_matcher,
+        error_message: error,
+        node_type: offending_node.type,
+        cop_type: "Lint",
+        node_location: "selector",
+        offense_severity: "warning"
+      )
+    end
+
+    # Quick info on what all is being worked on and what info we got
+    def call
+      { ast:, offense:, node_offense_info: }
+    end
+
+    def node_offense_info
+      return @node_offense_info if defined?(@node_offense_info)
+
+      # Find the node, or atom, with the most overlap with the offense
+      # range defined by that underline.
+      offending_node = @ast_nodes.max do |node|
+        node_range = if node.is_a?(AtomNode)
+          node.range
+        else
+          node.location.expression.to_range
+        end
+
+        # Except we're doing it as a percentage, otherwise parent nodes
+        # will dominate that count potentially. The closer to 100% overlap
+        # the better.
+        overlap_count = range_overlap_count(node_range, @offense[:range])
+        overlap_count.fdiv(node.source.size)
+      end
+
+      @node_offense_info ||= {
+        offending_node:,
+        offending_node_matcher: offending_node.to_s
+      }
+    end
+
+    # See if there's an underline, if so get how long it is and
+    # the error message after it
+    private def offending_meta_from(line)
+      match_data = OFFENSE_MATCH.match(line) or return nil
+      underline  = match_data[:underline]
+      error      = match_data[:error].lstrip
+
+      underline_start = line.index(underline)
+      underline_end   = underline_start + underline.size
+
+      { match_data:, error:, range: underline_start..underline_end }
+    end
+
+    # Figure which part of the passed in code string is AST vs offense
+    private def parse_string(string)
+      ast_lines = []
+      offense = nil
+
+      string.lines.each_with_index do |line, i|
+        meta_info = offending_meta_from(line)
+
+        if meta_info
+          raise "Cannot have multiple offenses" unless offense.nil?
+          offense = Offense.new(line: i, **meta_info.slice(:error, :range))
+        else
+          ast_lines << line
+        end
+      end
+
+      [ast_lines, offense]
+    end
+  end
+end

data/sig/offense_to_corrector.rbs

@@ -0,0 +1,4 @@
+module OffenseToCorrector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: offense_to_corrector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Weaver
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- keystonelemur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/offense_to_corrector.rb
+- lib/offense_to_corrector/templates/autocorrector_template.erb
+- lib/offense_to_corrector/version.rb
+- sig/offense_to_corrector.rbs
+homepage: https://www.github.com/baweaver/offense_to_corrector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/baweaver/offense_to_corrector
+  source_code_uri: https://www.github.com/baweaver/offense_to_corrector
+  changelog_uri: https://www.github.com/baweaver/offense_to_corrector/CHANGELOG.md
+post_install_message:
+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.3.3
+signing_key:
+specification_version: 4
+summary: Transform a RuboCop or Ruby offense into a corrector skeleton
+test_files: []