rubocop_plus 1.11.0

data/lib/commands/rubo/helpers/output.rb

@@ -0,0 +1,43 @@
+module RubocopPlus
+  module Commands
+    # Helpers for creating output are grouped in this file.
+    class Rubo < Cri::CommandRunner
+      def write_results_message
+        prefix = "#{total_violations_count} issues found, results written to rubocop/"
+        prefix = total_violations_count.zero? ? prefix.rubo_green : prefix.rubo_red
+        puts "#{prefix} (rubocop_plus v#{installed_version_of_gem} / rubocop v#{rubocop_version_name})"
+      end
+
+      def write_starting_message
+        print "Running rubocop ... "
+      end
+
+      # Read the total number of violations from the output.  Unfortunately, rubocop doesn't have a direct way to generate
+      # this number, but it does produce a file with the output burried inside it.  We can search the file and figure out the
+      # violations count.  The file will have a line that looks like this:
+      #    1234  Total
+      def determine_total_violations_count
+        total_line = ""
+        File.readlines(style_counts_text_file_name).each { |line| total_line = line if line.include?("Total") }
+        @total_violations = total_line.empty? ? 0 : total_line.split(" ").first.to_i
+      end
+
+      # Return the total violations count from the last rubocop run and remember the result.  This result should not do
+      # any validation to make sure the file exists, or is correct.  That is checked in other parts of the system.
+      def total_violations_count
+        return @total_violations unless @total_violations.nil?
+
+        first_line = File.read(total_violations_count_text_file_name)
+        @total_violations = first_line.strip.to_i
+      end
+
+      # This method writes a single integer to a file which represents the total number of violations.  The value in this file
+      # can be used to fail builds on the CI/CD pipeline which have too many violations.  Rubocop doesn't appear to have a
+      # formatter that will write the total number of violations to a file.  Fortunately, we can pull this information out of
+      # some other files and write the output ourselves.
+      def generate_total_violations_file
+        File.open(total_violations_count_text_file_name, 'w') { |f| f.print determine_total_violations_count }
+      end
+    end
+  end
+end

data/lib/commands/rubo/helpers/validations.rb

@@ -0,0 +1,57 @@
+module RubocopPlus
+  module Commands
+    # Helpers for performing validations are grouped in this file.
+    class Rubo < Cri::CommandRunner
+      def check_if_yml_present!
+        raise RubocopPlus::Commands::MissingYml unless rubocop_yml_present?
+      end
+
+      def check_if_yml_has_correct_content!
+        raise RubocopPlus::Commands::IncorrectYml unless rubocop_yml_has_correct_content?
+      end
+
+      def check_if_rubocop_command_exists!
+        raise RubocopPlus::Commands::NoRubocopCommand unless rubocop_command_exists?
+      end
+
+      def check_if_results_exist!
+        error = RubocopPlus::Commands::BadOutput
+
+        check_if_violations_count_exists?
+        raise error, "The '#{output_folder_name}' folder does not exist." unless File.directory?(output_folder_name)
+        raise error, "Missing #{style_issues_text_file_name}" unless File.exist?(style_issues_text_file_name)
+        raise error, "Missing #{style_issues_html_file_name}" unless File.exist?(style_issues_html_file_name)
+        raise error, "Missing #{style_counts_text_file_name}" unless File.exist?(style_counts_text_file_name)
+      end
+
+      def check_if_violations_count_exists?
+        error = RubocopPlus::Commands::BadOutput
+        raise error, "Missing #{total_violations_count_text_file_name}" unless File.exist?(total_violations_count_text_file_name)
+
+        violations = File.read(total_violations_count_text_file_name)
+        raise error, "#{total_violations_count_text_file_name} is empty" if violations.nil? || violations.strip.empty?
+      end
+
+      # This method is called when the user runs `rubo --total-violations`.  That option is used to open the "total violations
+      # counts" file  and print the number.  However, the user can run `rubo`, wait for a bit, delete his rubocop folder
+      # and THEN run `rubo --total-violations`.  This is a little different from the other checks where we are IMMEDIATELY
+      # checking the results of the rubo command.  In those checks, we're trying to make sure the rubo command worked correctly
+      # and was successfully able to write results.  In this check, we're making sure the files are still around before we try
+      # and open them.
+      def check_if_total_violations_count_still_present_and_valid!
+        error = RubocopPlus::Commands::OutputMissing
+        prefix = "Cannot proceed."
+        raise error, "#{prefix}  The '#{output_folder_name}' folder does not exist." unless File.directory?(output_folder_name)
+
+        file_name = total_violations_count_text_file_name
+        raise error, "#{prefix}  The #{file_name} file is missing." unless File.exist?(file_name)
+
+        violations = File.read(file_name)
+        raise error, "#{prefix}  The #{file_name} file is empty." if violations.nil? || violations.strip.empty?
+
+        violations = violations.strip
+        raise error, "#{prefix}  The #{file_name} file contains non-digit characters." unless violations =~ /^\d*$/
+      end
+    end
+  end
+end

data/lib/commands/rubo/utils/cri_platform_monkey_patch.rb

@@ -0,0 +1,8 @@
+module Cri
+  # A small monkey patch to force the cri gem to stop coloring output.
+  module Platform
+    def self.color?(_io)
+      false
+    end
+  end
+end

data/lib/commands/rubo/utils/which.rb

@@ -0,0 +1,91 @@
+# https://gist.github.com/steakknife/88b6c3837a5e90a08296
+# Copyright (c) 2014,2016 Barry Allard <barry.allard@gmail.com>
+# License: MIT
+#
+# inspiration: https://stackoverflow.com/questions/2889720/one-liner-in-ruby-for-displaying-a-prompt-getting-input-and-assigning-to-a-var
+#
+# Which Bourne shell?
+#
+#     require 'which'
+#
+#     Which 'sh'
+#
+#
+#  Or all zsh(es)
+#
+#     require 'which'
+#
+#     WhichAll 'zsh'
+#
+module Which
+  # similar to `which {{cmd}}`, except relative paths *are* always expanded
+  # returns: first match absolute path (String) to cmd (no symlinks followed),
+  #          or nil if no executable found
+  def which(cmd)
+    which0(cmd) do |abs_exe|
+      return abs_exe
+    end
+    nil
+  end
+
+  # similar to `which -a {{cmd}}`, except relative paths *are* always expanded
+  # returns: always an array, or [] if none found
+  def which_all(cmd)
+    results = []
+    which0(cmd) do |abs_exe|
+      results << abs_exe
+    end
+    results
+  end
+
+  def real_executable?(file)
+    File.executable?(file) && !File.directory?(file)
+  end
+
+  def executable_file_extensions
+    ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  end
+
+  def search_paths
+    ENV['PATH'].split(File::PATH_SEPARATOR)
+  end
+
+  def find_executable(path, cmd, &_block)
+    executable_file_extensions.each do |ext|
+      if real_executable?(abs_exe = File.expand_path(cmd + ext, path))
+        yield(abs_exe)
+      end
+    end
+  end
+
+  # internal use only
+  # +_found_exe+ is yielded to on *all* successful match(es),
+  #              with path to absolute file (String)
+  def which0(cmd, &found_exe)
+    # call expand_path(f, nil) == expand_path(f) for relative/abs path cmd
+    find_executable(nil, cmd, &found_exe) if File.basename(cmd) != cmd
+
+    search_paths.each do |path|
+      find_executable(path, cmd, &found_exe)
+    end
+  end
+
+  module_function(*public_instance_methods) # `extend self`, sorta
+end
+
+# make Which() and WhichAll() work
+module Kernel
+  # rubocop:disable Naming/MethodName
+  # return abs-path to +cmd+
+  def Which(cmd)
+    Which.which cmd
+  end
+  module_function :Which
+
+  # return all abs-path(s) to +cmd+ or [] if none
+  def WhichAll(cmd)
+    Which.which_all cmd
+  end
+  module_function :WhichAll
+  # rubocop:enable Naming/MethodName
+end

data/lib/rubocop_plus.rb

@@ -0,0 +1,14 @@
+require "rubocop_plus/version"
+require "rubocop_plus/core_ext/string"
+require "rubocop"
+# require "rubocop-performance"
+# require "rubocop-rails"
+
+# Setup pry for development when running "rake console". Guard against load
+# errors in production (since pry is not a runtime dependency in the .gemspec)
+# rubocop:disable Lint/HandleExceptions
+begin
+  require "pry"
+rescue LoadError
+end
+# rubocop:enable Lint/HandleExceptions

data/lib/rubocop_plus/core_ext/string.rb

@@ -0,0 +1,23 @@
+# Add some ome simple colorization methods for formatting console output.
+# Prefix methods with rs_ so they don't collide with other gems.
+class String
+  class << self
+    attr_accessor :allow_color
+  end
+
+  def rubo_colorize(color_code)
+    String.allow_color ? "\e[#{color_code}m#{self}\e[0m" : self
+  end
+
+  def rubo_red
+    rubo_colorize(31)
+  end
+
+  def rubo_green
+    rubo_colorize(32)
+  end
+
+  def rubo_yellow
+    rubo_colorize(33)
+  end
+end

data/lib/rubocop_plus/version.rb

@@ -0,0 +1,4 @@
+module RubocopPlus
+  VERSION = "1.11.0".freeze
+  RUBOCOP_VERSION = '0.79.0'.freeze
+end

data/lib/templates/.rubocop.yml

@@ -0,0 +1,14 @@
+# DO NOT MODIFY THIS FILE unless you want to deviate from the rubocop_plus ruleset.
+
+# This file defines the settings used by rubocop when it runs.  You would normally add your customizations directly to this
+# file, but this file has been pre configured to read settings out of the rubocop_plus gem instead.
+
+# Tell rubocop to load its settings from the rubocop_plus gem.
+inherit_gem:
+  rubocop_plus: config/rubocop.yml
+
+Rails:
+  Enabled: true
+
+# Place custom settings below this comment.  All customizations will OVERRIDE rubocop_plus rules.  rubocop_plus & rubocop
+# do not attempt to merge these settings with their defaults.  Long term changes should be ported to the rubocop_plus gem.

data/rubocop_plus.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop_plus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop_plus"
+  spec.version       = RubocopPlus::VERSION
+  spec.authors       = ["roberts1000"]
+  spec.email         = ["roberts@corlewsolutions.com"]
+
+  spec.summary       = "Enhancements to the standard rubocop gem."
+  spec.description   = "Enhancements to the standard rubocop gem."
+  spec.homepage      = "https://github.com/roberts1000/rubocop_plus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+
+  spec.add_dependency "cri", "~> 2.0"
+  spec.add_dependency "rubocop", RubocopPlus::RUBOCOP_VERSION.to_s
+  spec.add_dependency "rubocop-performance", "~> 1.5.2"
+  spec.add_dependency "rubocop-rails", "~> 2.4.1"
+  spec.add_dependency "rubocop-rspec", "~> 1.37.1"
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_plus
+version: !ruby/object:Gem::Version
+  version: 1.11.0
+platform: ruby
+authors:
+- roberts1000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-31 00:00:00.000000000 Z
+dependencies:
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: cri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+description: Enhancements to the standard rubocop gem.
+email:
+- roberts@corlewsolutions.com
+executables:
+- rubo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/start_rspec
+- config/group/layout.yml
+- config/group/lint.yml
+- config/group/metrics.yml
+- config/group/naming.yml
+- config/group/rails.yml
+- config/group/rspec.yml
+- config/group/style.yml
+- config/rubocop.yml
+- exe/rubo
+- lib/commands/rubo.rb
+- lib/commands/rubo/errors/bad_output.rb
+- lib/commands/rubo/errors/incorrect_yml.rb
+- lib/commands/rubo/errors/missing_yml.rb
+- lib/commands/rubo/errors/no_rubocop_command.rb
+- lib/commands/rubo/errors/output_missing.rb
+- lib/commands/rubo/helpers/misc.rb
+- lib/commands/rubo/helpers/output.rb
+- lib/commands/rubo/helpers/validations.rb
+- lib/commands/rubo/utils/cri_platform_monkey_patch.rb
+- lib/commands/rubo/utils/which.rb
+- lib/rubocop_plus.rb
+- lib/rubocop_plus/core_ext/string.rb
+- lib/rubocop_plus/version.rb
+- lib/templates/.rubocop.yml
+- rubocop_plus.gemspec
+homepage: https://github.com/roberts1000/rubocop_plus
+licenses:
+- MIT
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Enhancements to the standard rubocop gem.
+test_files: []