rubobot 0.63.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 102e7ba880145df220b257dfe5c2c46625ad28ec89b6095884c3277ec509685e
+  data.tar.gz: e487cbae1579463f3e9ab7c3af5f9e139ac5ab7e0dd300f7e7d2492a9a0818ac
+SHA512:
+  metadata.gz: b385727eb0f625c1e58978395ceb4dbb95d8852445d7dbc8aa192c7eb31f9416073bbfa1d89bdcbdf44a12c3a526c9f7d2ecbc72b47249bd6959c683eb5cdcad
+  data.tar.gz: 14d59b4aebe2f05af1c5abec2f39805063788bda04a3274f192ee0a8c3c5e94fa76512b99b97873d2b1651c214eff62fd2b805cbdea8d0babf3c2b3d52008909

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubobot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    rubobot (0.63.1)
+      rubocop (= 0.63.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubobot!
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,29 @@
+# RuboBot
+
+RuboBot runs RuboCop Auto-correct for the cop with the lowest offense count, making it easier to incrementally improve your codebase.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubobot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubobot
+
+## Usage
+
+```sh
+msg=`bundle exec rubobot` && git commit -am "$msg"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/garethrees/rubobot.

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubobot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rubobot

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'rubobot'
+exit RuboBot::CLI.run(ARGV)

data/lib/rubobot.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require 'rubobot/bot'
+require 'rubobot/cli'
+require 'rubobot/configuration'
+require 'rubobot/options'
+require 'rubobot/version'
+
+require 'rubobot/git/commit_message'
+
+require 'rubobot/rubocop/auto_correct'
+require 'rubobot/rubocop/offense'
+require 'rubobot/rubocop/offenses'
+
+require 'rubobot/rubocop/formatter/clang_style_formatter'
+require 'rubobot/rubocop/formatter/offense_count_formatter'
+
+# Automate RuboCop Auto-correct
+module RuboBot
+end

data/lib/rubobot/bot.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboBot
+  # Run rubobot
+  class Bot
+    def initialize(configuration = Configuration.new)
+      @configuration = configuration
+    end
+
+    def autocorrect(paths)
+      loop do
+        ac = RuboBot::RuboCop::AutoCorrect.new(next_cop(paths), paths)
+
+        if ac.run
+          configuration.stdout.puts(ac.commit_message)
+          break
+        end
+      end
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def next_cop(paths)
+      offenses(paths).next.name
+    end
+
+    def offenses(paths)
+      @offenses ||= offenses!(paths)
+    end
+
+    def offenses!(paths)
+      RuboBot::RuboCop::Offenses.new(paths)
+    end
+  end
+end

data/lib/rubobot/cli.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboBot
+  # Entrypoint for running RuboBot from the CLI
+  class CLI
+    STATUS_SUCCESS = 0
+    STATUS_FAILURE = 1
+
+    def self.run(argv)
+      options = Options.new(argv)
+      new(options[:paths], Configuration.new(options)).run
+    end
+
+    def initialize(paths, configuration)
+      @paths = paths
+      @configuration = configuration
+    end
+
+    def run
+      return output(VERSION) if configuration.version?
+
+      commit_message = Bot.new(configuration).autocorrect(paths)
+      output(commit_message) if configuration.commit_message?
+      STATUS_SUCCESS
+    rescue RuboBot::RuboCop::NoOffensesError
+      STATUS_FAILURE
+    end
+
+    private
+
+    def output(string)
+      configuration.stdout.puts(string)
+      STATUS_SUCCESS
+    end
+
+    attr_reader :configuration
+    attr_reader :paths
+  end
+end

data/lib/rubobot/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboBot
+  # Configuration options
+  class Configuration
+    DEFAULTS = { verbose: false,
+                 commit_message: false,
+                 version: false,
+                 stdout: $stdout,
+                 stderr: $stderr,
+                 ctime: Time.now }.freeze
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    %i[verbose commit_message version].each do |option|
+      define_method("#{option}?") { parsed_options[option] }
+    end
+
+    %i[stdout stderr ctime].each do |option|
+      define_method(option) { parsed_options[option] }
+    end
+
+    private
+
+    attr_reader :options
+
+    def parsed_options
+      @parsed_options ||= DEFAULTS.merge(options)
+    end
+  end
+end

data/lib/rubobot/git/commit_message.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboBot
+  module Git
+    # A Git commit message
+    class CommitMessage
+      def initialize(cop, command, stdout)
+        @cop = cop
+        @command = command
+        @stdout = stdout
+      end
+
+      def subject
+        "Auto-correct #{cop}"
+      end
+
+      def body
+        <<~MSG
+          #{command}
+
+          #{stdout}
+        MSG
+      end
+
+      def to_s
+        <<~MSG.chomp
+          #{subject}
+
+          #{body}
+        MSG
+      end
+
+      def ==(other)
+        to_h == other.to_h
+      end
+
+      protected
+
+      def to_h
+        { cop: cop,
+          command: command,
+          stdout: stdout }
+      end
+
+      private
+
+      attr_reader :cop
+      attr_reader :command
+      attr_reader :stdout
+    end
+  end
+end

data/lib/rubobot/options.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module RuboBot
+  # Parse options passed from the CLI
+  class Options
+    def initialize(args)
+      @args = args
+    end
+
+    def [](key)
+      parse[key]
+    end
+
+    def to_hash
+      parse
+    end
+
+    private
+
+    attr_reader :args
+
+    def parse
+      options = {}
+      option_parser.parse!(args, into: options)
+      options[:paths] = args
+      options
+    end
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: rubobot [options] [paths]'
+        opts.on('--commit-message', 'Print commit message')
+        opts.on('-v', '--version', 'Print version')
+        opts.on('--verbose', 'Print debug info')
+      end
+    end
+  end
+end

data/lib/rubobot/rubocop/auto_correct.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboBot
+  module RuboCop
+    # Run rubocop to auto-correct a cop
+    class AutoCorrect
+      # Error for calling methods on an AutoCorrect if the given Cop is not
+      # able to Auto-Correct
+      class NotAutoCorrectableError < StandardError; end
+
+      def initialize(cop, paths)
+        @cop = cop
+        @paths = paths
+
+        formatter = 'RuboBot::RuboCop::Formatter::ClangStyleFormatter'
+        options = { safe_auto_correct: true,
+                    auto_correct: true,
+                    format: formatter,
+                    formatters: [[formatter]],
+                    only: [cop.name] }
+
+        @runner = ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new)
+      end
+
+      def run
+        files_changed?
+      end
+
+      def files_changed?
+        status
+      end
+
+      def commit_message
+        raise NotAutoCorrectableError unless autocorrect?
+        Git::CommitMessage.new(cop.name, command, stdout_str)
+      end
+
+      private
+
+      attr_reader :cop
+      attr_reader :paths
+      attr_reader :runner
+
+      def autocorrect?
+        cop.support_autocorrect? && cop.autocorrect_enabled?
+      end
+
+      def status
+        @status ||= run!
+      end
+
+      def stdout_str
+        return @stdout_str if @stdout_str
+        run!
+        @stdout_str = runner.send(:formatter_set).first.output.string
+      end
+
+      def run!
+        return false unless autocorrect?
+        runner.run(paths)
+      end
+
+      # The command we would have run if shelling out, so that we can record it
+      # in the commit message for manual reproduction.
+      def command
+        'rubocop --safe-auto-correct --format clang ' \
+        "--only #{cop.name} #{paths.join(' ')}"
+      end
+    end
+  end
+end

data/lib/rubobot/rubocop/formatter/clang_style_formatter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
+module RuboBot
+  module RuboCop
+    module Formatter
+      # This formatter collects the list of offended cops with a count of how
+      # many offenses of their kind were found. Ordered by desc offense count.
+      # Does not print output.
+      class ClangStyleFormatter < ::RuboCop::Formatter::ClangStyleFormatter
+        attr_reader :offense_counts
+
+        def initialize(output, options = {})
+          @output = StringIO.new
+          @options = options
+        end
+      end
+    end
+  end
+end

data/lib/rubobot/rubocop/formatter/offense_count_formatter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
+module RuboBot
+  module RuboCop
+    module Formatter
+      # This formatter collects the list of offended cops with a count of how
+      # many offenses of their kind were found. Ordered by desc offense count.
+      # Does not print output.
+      class OffenseCountFormatter < ::RuboCop::Formatter::OffenseCountFormatter
+        attr_reader :offense_counts
+
+        def initialize(output, options = {})
+          @output = StringIO.new
+          @options = options
+        end
+
+        def started(target_files)
+          super
+          @offense_counts = Hash.new(0)
+
+          return unless output.tty?
+        end
+      end
+    end
+  end
+end

data/lib/rubobot/rubocop/offense.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboBot
+  module RuboCop
+    # An offense found by RuboCop
+    class Offense
+      def initialize(offense_data)
+        @offense_data = offense_data
+      end
+
+      def name
+        offense.name
+      end
+
+      def count
+        offense.count
+      end
+
+      def ==(other)
+        offense_data == other.offense_data
+      end
+
+      protected
+
+      attr_reader :offense_data
+
+      private
+
+      def offense
+        data = Struct.new(:name, :count)
+        data.new(*offense_data.first)
+      end
+    end
+  end
+end

data/lib/rubobot/rubocop/offenses.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboBot
+  module RuboCop
+    # Raised when we've iterated through all offenses
+    class NoOffensesError < StandardError; end
+
+    # Offenses found by a RuboCop run
+    class Offenses
+      def initialize(paths)
+        formatter = 'RuboBot::RuboCop::Formatter::OffenseCountFormatter'
+        options = { format: formatter,
+                    formatters: [[formatter]] }
+
+        @paths = Array(paths)
+        @runner = ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new)
+      end
+
+      def next
+        Offense.new([offenses.shift].to_h)
+      rescue TypeError
+        raise NoOffensesError
+      end
+
+      def size
+        offenses.size
+      end
+
+      def ==(other)
+        to_h == other.to_h
+      end
+
+      def to_h
+        offenses.each_with_object({}) do |(cop, count), memo|
+          memo[cop.name] = count
+        end
+      end
+
+      private
+
+      attr_reader :paths
+      attr_reader :runner
+
+      def offenses
+        @offenses ||= offenses!
+      end
+
+      def offenses!
+        sorted_offenses.
+          each_with_object({}) do |(name, count), memo|
+            cop = ::RuboCop::Cop::Cop.registry.find_by_cop_name(name).new
+            memo[cop] = count
+          end
+      end
+
+      def sorted_offenses
+        runner.run(paths)
+        formatter = runner.send(:formatter_set).first
+        formatter.offense_counts.sort_by(&:last)
+      end
+    end
+  end
+end

data/lib/rubobot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RuboBot
+  VERSION = '0.63.1'
+end

data/rubobot.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubobot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubobot'
+  spec.version       = RuboBot::VERSION
+  spec.authors       = ['Gareth Rees']
+  spec.email         = ['gareth@garethrees.co.uk']
+
+  spec.summary       = 'Automate code cleanup, one cop at a time'
+  spec.description   = 'Runs RuboCop Auto-correct for the cop with the ' \
+                       'lowest offense count, making it easier to ' \
+                       'incrementally improve your codebase.'
+
+  spec.homepage      = 'https://github.com/garethrees/rubobot'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(spec)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '0.63.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rubobot
+version: !ruby/object:Gem::Version
+  version: 0.63.1
+platform: ruby
+authors:
+- Gareth Rees
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Runs RuboCop Auto-correct for the cop with the lowest offense count,
+  making it easier to incrementally improve your codebase.
+email:
+- gareth@garethrees.co.uk
+executables:
+- rubobot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rubobot
+- lib/rubobot.rb
+- lib/rubobot/bot.rb
+- lib/rubobot/cli.rb
+- lib/rubobot/configuration.rb
+- lib/rubobot/git/commit_message.rb
+- lib/rubobot/options.rb
+- lib/rubobot/rubocop/auto_correct.rb
+- lib/rubobot/rubocop/formatter/clang_style_formatter.rb
+- lib/rubobot/rubocop/formatter/offense_count_formatter.rb
+- lib/rubobot/rubocop/offense.rb
+- lib/rubobot/rubocop/offenses.rb
+- lib/rubobot/version.rb
+- rubobot.gemspec
+homepage: https://github.com/garethrees/rubobot
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Automate code cleanup, one cop at a time
+test_files: []