rfix 1.0.6 → 1.0.7.pre.68

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a81fcd91613705689bcc70a1ed0d639d7000d002005615fba624383a5c53ce7
-  data.tar.gz: '087e5a65e5c38470af4ffa18cc05ce199801cb8eda1414459e208ebf66b3e4b9'
+  metadata.gz: a26f95a0567bf3581515e5f7b7acc0b020ffad71f610e64cec9314b1a128573d
+  data.tar.gz: f70e41c32e3fe733fda2349d83c02e77705461337da6c0b5313e763c0950a46c
 SHA512:
-  metadata.gz: 64487b5340afcad795570aa055bf8713433d97c5f369c13c5c7994069a00a9457ada3dcbda76fe248c8d1b1b101725626cc771029919fe3b10cac6452d5cdd3a
-  data.tar.gz: 67768f496a89bdd928e524ae1bc34f5658681cd991fabb71571f3368cc682cab7bbd621c9b238af3ed5dbdc9bb2116034119c8f7208878060c706e1ec9631160
+  metadata.gz: 325fa9f8df215013e37cb0ee1b05d969cc3c66933a52b52605bbff6a5a4061445d7bb143b05bdca7ba624a5d9aa722582df782ea211110e83fd4cecd35d3b965
+  data.tar.gz: 255ffb2025dd390cb83939ffa90479cdb7dcd395b9f0511f9afdda54aad56c9975662c20080b575d31d4e9b9c1a35ce3f96b02629921a39684f669210f09cae3

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+cache:
+  bundler: true
+  directories:
+    - $HOME/.rvm
+    - $HOME/Library/Caches/Homebrew
+before_cache:
+  - brew cleanup
 rvm:
   - 2.5.0
   - 2.6.2
@@ -17,8 +24,7 @@ gemfile:
   - ci/Gemfile.rubocop-0.85.1
 before_install:
   - yes | gem update --system --force
-  - gem uninstall bundler
-  - gem install bundler -v 2.1.4
+  - gem install bundler
   - bundle config git.allow_insecure true
 install:
   - bundle install
@@ -37,4 +43,5 @@ jobs:
       gem: rfix
       on:
         repo: oleander/rfix-rb
+        tags: false
       cleanup: 'false'

data/Gemfile.lock

@@ -21,7 +21,7 @@ GIT
 PATH
   remote: .
   specs:
-    rfix (1.0.6)
+    rfix (1.0.7)
       rainbow (~> 3.0)
       rouge (~> 3.20)
       rubocop (~> 0.80)

data/README.md

@@ -1,39 +1,85 @@
-# Rfix [![Build Status](https://travis-ci.org/oleander/rfix-rb.svg?branch=master)](https://travis-ci.org/oleander/rfix-rb)
+# Rfix [![Build Status](https://travis-ci.org/oleander/rfix-rb.svg?branch=master)](https://travis-ci.org/oleander/rfix-rb) [![Gem](https://img.shields.io/gem/dt/rfix)](https://rubygems.org/gems/rfix)
 
-RuboCop CLI that only complains about your latest changes
+RuboCop CLI that only complains about your latest changes. Includes a RuboCop formatter with syntax highlighting and build in hyperlinks for offense documentation. Supports both linting (`rfix lint`) and the RuboCops autofix feature (`rfix local|origin|branch`) for the changes you made.
+
+Supports the same CLI arguments as RuboCop. Run `rfix --help` for the complete list.
+
+![Printscreen](resources/ps.png)
 
 ## Installation
 
 ``` shell
-$ gem install rfix
-$ rfix <local|branch|origin|info|all> [--dry] [--help]
+$ gem install rfix --pre
+```
+
+## Help
+
+``` shell
+$ rfix branch <branch> # Fix changes made between HEAD and <branch>
+$ rfix origin          # Fix changes made between HEAD and origin branch
+$ rfix local           # Fix changes not yet pushed to upstream branch
+$ rfix info            # Display runtime dependencies and their versions
+$ rfix all             # Fix all files in this repository (not recommended)
+$ rfix lint            # Shortcut for 'rfix local --dry --untracked'
+$ rfix                 # Displays this list of supported commands
 ```
 
+### Arguments
+
+- `--dry` Turns off RuboCops autofix feature (read-only mode)
+- `--help` Displays RubyCops and Rfix supported arguments
+- `--list-files` List all files being passed to RubyCop
+- `--untracked` Include files not tracked by git
+- `--config` Configuration file, defaults to `.rubocop.yml`
+
 ## Development
 
-- `git clone https://github.com/oleander/rfix-rb`
-- `cd rfix-rb`
-- `bundle install`
-- `bundle exec rake setup`
-- `bundle exec rake local`
-- `bundle exec rake spec`
+### Setup
+
+1. Download repository
+  1. `$ git clone https://github.com/oleander/rfix-rb`
+  2. `$ cd rfix-rb`
+2. Downloads fixtures and run time dependencies
+  - `$ bundle exec rake setup`
+
+### Install from repository
+
+``` shell
+$ bundle exec rake local
+```
+
+### Run tests
+
+``` shell
+$ bundle exec rake spec
+```
 
 ## Overcommit
 
+Add the following to your `.overcommit.yml`, then run `overcommit --install` and `overcommit --sign pre-commit`. It will lint commits not yet pushed to upstream branch everytime `git commit` is ran.
+
 ``` yaml
 PreCommit:
   RFix:
     enabled: true
-    command: ["rfix", "local", "--untracked", "--dry"]
-    description: "Lint changes since last push using RuboCop"
+    command: ["rfix", "lint"]
+    description: "Lint unchanged commits using RuboCop"
     parallelize: true
 ```
 
+### From scratch
+
+1. `gem install overcommit rfix`
+2. `curl https://raw.githubusercontent.com/oleander/rfix-rb/master/resouces/overcommit.yml > .overcommit.yml`
+3. `overcommit --install`
+4. `overcommit --sign pre-commit`
+
+Run `overcommit --run` to test the new hook.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/oleander/rfix.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/rfix

@@ -20,38 +20,13 @@ CLI::UI::StdoutRouter.enable
 
 say "Using RuboCop {{yellow:#{RuboCop::Version.version}}}"
 
-base_config = {
-  color: true,
-  force_exclusion: true,
-  auto_correct: true,
-  formatters: ["Rfix::Formatter"]
-}
-
-# For version 0.80.x .. 0.83.x:
-# Otherwise it will exit with status code = 1
-if (0.80..0.83).include?(RuboCop::Version::STRING.to_f)
-  if is_dry
-    base_config[:fail_level] = :autocorrect
-  else
-    base_config[:fail_level] = :warning
-  end
-end
-
-def load_config
-  yield
-rescue RuboCop::Error => e
-  say_abort "[Config] #{e}"
-rescue TypeError => e
-  say_abort "[Config] #{e}"
+options.on("--untracked", "Include untracked files") do
+  Rfix.load_untracked!
 end
 
 options.on("--dry", "No auto correct") do
   say "Will run rfix in {{red:read-only}} mode"
-  base_config.merge!({ auto_correct: false })
-end
-
-options.on("--untracked", "Include untracked files") do
-  Rfix.load_untracked!
+  Rfix.no_auto_correct!
 end
 
 options.on("--list-files", "List files found by git") do
@@ -73,6 +48,9 @@ when "info"
   say "Using Git {{yellow:#{Rfix.git_version}}}"
   say "Using Ruby {{yellow:#{Rfix.ruby_version}}}"
   exit 0
+when "lint"
+  Rfix.lint_mode!
+  reference = Rfix.ref_since_push
 when "local"
   reference = Rfix.ref_since_push
 when "origin"
@@ -102,6 +80,7 @@ else
     say_error_sub "\t{{bold:rfix local}}           -- {{italic:Fix changes not yet pushed to upstream branch}}"
     say_error_sub "\t{{bold:rfix info}}            -- {{italic:Display runtime dependencies and their versions}}"
     say_error_sub "\t{{bold:rfix all}}             -- {{italic:Fix all files in this repository}} {{warning:(not recommended)}}"
+    say_error_sub "\t{{bold:rfix lint}}            -- {{italic:Shortcut for 'local --dry --untracked'}}"
     say_error_sub "\n"
     say_error_sub "\t{{italic:Optional args: --dry --help --list-files --limit-files --config --untracked}}"
     exit 1
@@ -117,11 +96,11 @@ rescue OptionParser::MissingArgument => e
 end
 
 if path = config_path
-  load_config do
+  Rfix.load_config do
     config.options_config = path
   end
 else
-  load_config do
+  Rfix.load_config do
     config.for(Dir.pwd)
   end
 end
@@ -149,7 +128,7 @@ if should_list_files
 end
 
 env = RuboCop::CLI::Environment.new(
-  base_config.merge(options),
+  Rfix.config.merge(options),
   config,
   paths
 )

data/lib/rfix.rb

@@ -5,9 +5,22 @@
 
 require "rfix/version"
 require "rfix/log"
-require "rfix/extensions"
+require "rfix/extensions/extensions"
+require "rfix/extensions/offense"
 require "rfix/rfix"
 
 module Rfix
+  module Ext; end
   extend self
 end
+
+RuboCop::Options.prepend(Rfix::Ext::Options)
+RuboCop::Runner.prepend(Rfix::Ext::Runner)
+RuboCop::CommentConfig.prepend(Rfix::Ext::CommentConfig)
+RuboCop::Cop::Offense.prepend(Rfix::Ext::Offense)
+
+# TODO: Handle cases where color can't be resolved by CLI::UI
+RuboCop::Formatter::SimpleTextFormatter::COLOR_FOR_SEVERITY.each do |severity, color|
+  id = RuboCop::Cop::Severity::CODE_TABLE.invert.fetch(severity)
+  CLI::UI::Glyph.new(id.to_s, 0x25cf, CLI::UI.resolve_color(color))
+end

data/lib/rfix/cmd.rb

@@ -13,7 +13,7 @@ module Rfix::Cmd
     unless status.success?
       return yield if block_given?
 
-      say_error "[Cmd] {{italic:#{args.join(" ")}}}"
+      say_error "[Cmd] {{italic:#{args.join(' ')}}}"
       say_error "[Pwd] {{italic:#{Dir.pwd}}}"
       say_error "[Err] {{error:#{err.strip}}}"
 

data/lib/rfix/extensions/extensions.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rainbow"
+
+module Rfix::Ext
+  module CommentConfig
+    # Called by RuboCop on every line to see
+    # if its suppose to run against it or not
+    def cop_enabled_at_line?(_cop, line)
+      Rfix.enabled?(processed_source.file_path, line) && super
+    end
+  end
+
+  module Runner
+    # Called _after_ @source has been 'auto fixed' by Rubocop
+    def check_for_infinite_loop(source, offences)
+      # rubocop:disable Style/Semicolon
+      Rfix.refresh!(source); super
+      # rubocop:enable Style/Semicolon
+    end
+  end
+
+  module Options
+    # Appends custom --args to RuboCop CLI
+    def define_options
+      super.tap do |options|
+        @ons.each do |args, block|
+          option(options, *args, &block)
+        end
+      end
+    end
+
+    # Helper method used by rfix to append cli --args to Rubocop
+    def on(*args, &block)
+      @ons ||= []
+      @ons += [[args, block]]
+    end
+  end
+end

data/lib/rfix/extensions/offense.rb

@@ -0,0 +1,77 @@
+module Rfix::Ext
+  module Offense
+    def where
+      line.to_s + ":" + real_column.to_s
+    end
+
+    def info
+      message.split(": ", 2).last.delete("\n")
+    end
+
+    def msg
+      CLI::UI.resolve_text("{{italic:#{info}}}", truncate_to: CLI::UI::Terminal.width - 10)
+    end
+
+    def code
+      message.split(": ", 2).first
+    end
+
+    def star
+      Rainbow("⭑")
+    end
+
+    def cross
+      Rainbow("✗").red
+    end
+
+    def check
+      Rainbow("✓").green
+    end
+
+    def circle
+      Rainbow("⍟")
+    end
+
+    def relative_path
+      Rfix.to_relative(path: location.source_buffer.name)
+    end
+
+    def clickable_path
+      "{{italic:#{relative_path}:#{where}}}"
+    end
+
+    def clickable_plain_severity
+      to_url("https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/#{code}", code)
+    end
+
+    def clickable_severity
+      "{{#{severity.code}}} {{italic:#{clickable_plain_severity}}}"
+    end
+
+    def icon
+      return check.green if corrected?
+      return star.yellow if correctable?
+
+      cross.red
+    end
+
+    def to_clickable(url, title)
+      esc = CLI::UI::ANSI::ESC
+      cmd = esc + "]8;;"
+      slash = "\x07"
+      cmd + "#{escape(url)}#{slash}#{escape(title)}" + cmd + slash
+    end
+
+    def to_path(path, title)
+      to_clickable("file://#{path}", title)
+    end
+
+    def to_url(url, title)
+      to_clickable(url, title)
+    end
+
+    def escape(str)
+      Shellwords.escape(str)
+    end
+  end
+end

data/lib/rfix/formatter.rb

@@ -30,37 +30,14 @@ module Rfix
       report_summary(files.size, offenses.count, corrected.count)
     end
 
-    def to_clickable(url, title)
-      esc = CLI::UI::ANSI::ESC
-      cmd = esc + "]8;;"
-      slash = "\x07"
-      cmd + "#{escape(url)}#{slash}#{escape(title)}" + cmd + slash
-    end
-
-    def to_path(path, title)
-      to_clickable("file://#{path}", title)
-    end
-
-    def to_url(url, title)
-      to_clickable(url, title)
-    end
-
-    def escape(str)
-      Shellwords.escape(str)
-    end
-
     def render_file(file, offenses)
       return if offenses.empty?
 
-      path = Rfix.to_relative(path: file)
-      url = to_url(file, path)
       offenses.each do |offense|
         out("\n\n")
-        clickable_path = "{{italic:#{path}:#{offense.where}}}"
-        clickable_code = to_url("https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/#{offense.code}", offense.code)
         CLI::UI::Frame.open("#{offense.icon} #{offense.msg}", color: :reset)
         report_line(file, offense, offense.location, offense.highlighted_area)
-        CLI::UI::Frame.close("#{clickable_path} » {{italic:#{clickable_code}}}", color: :reset)
+        CLI::UI::Frame.close("#{offense.clickable_severity} » #{offense.clickable_path}", color: :reset)
       end
     end
 

data/lib/rfix/git_helper.rb

@@ -19,7 +19,9 @@ module Rfix::GitHelper
       "--no-renames",
       "--no-merges",
       "--first-parent",
-      "--diff-filter=AM",
+      "--find-renames",
+      "--find-copies",
+      "--diff-filter=AMCR",
       "-U0",
       "--no-color",
       "-p"

data/lib/rfix/log.rb

@@ -13,7 +13,7 @@ module Rfix::Log
   end
 
   def say_error_sub(message)
-    CLI::UI.puts("#{message}")
+    CLI::UI.puts(message.to_s)
   end
 
   def say_debug(message)

data/lib/rfix/rfix.rb

@@ -13,6 +13,36 @@ module Rfix
   include GitHelper
   include Log
 
+  def config
+    @config
+  end
+
+  def set_fail_level(lint)
+    if if lint
+       else
+         @config[:fail_level] = :warning
+      end
+    end
+  end
+
+  def no_auto_correct!
+    @config[:auto_correct] = false
+  end
+
+  def load_config
+    yield
+  rescue RuboCop::Error => e
+    say_abort "[Config] #{e}"
+  rescue TypeError => e
+    say_abort "[Config] #{e}"
+  end
+
+  def lint_mode!
+    @config[:auto_correct] = false
+    @config[:fail_level] = :warning if old?
+    load_untracked!
+  end
+
   def git_version
     cmd("git --version").last.split(/\s+/, 3).last
   end
@@ -36,6 +66,14 @@ module Rfix
   def init!
     @files ||= {}
     @global_enable = false
+    @config = {
+      color: true,
+      force_exclusion: true,
+      auto_correct: true,
+      formatters: ["Rfix::Formatter"]
+    }
+
+    @config[:fail_level] = :autocorrect if old?
   end
 
   def files
@@ -100,6 +138,12 @@ module Rfix
 
   private
 
+  def old?
+    # For version 0.80.x .. 0.83.x:
+    # Otherwise it will exit with status code = 1
+    (0.80..0.83).include?(RuboCop::Version::STRING.to_f)
+  end
+
   def get_file(path, &block)
     if file = @files[path]
       block.call(file)

data/lib/rfix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rfix
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/rfix.gemspec

@@ -18,7 +18,18 @@ Gem::Specification.new do |spec|
   spec.email         = ["linus@oleander.nu"]
 
   spec.summary       = "RuboCop CLI that only complains about your latest changes"
-  spec.description   = "$ rfix local|branch|origin|info|all [--dry] [--help]"
+  spec.description   = <<~TEXT
+     #{spec.summary}
+     Uses 'git diff' to determine what changes were made then runs RuboCop against them
+
+    $ rfix branch <branch> -- Fix changes made between HEAD and <branch>
+    $ rfix origin          -- Fix changes made between HEAD and origin branch
+    $ rfix local           -- Fix changes not yet pushed to upstream branch
+    $ rfix info            -- Display runtime dependencies and their versions
+    $ rfix all             -- Fix all files in this repository (not recommended)
+
+     Optional args: --dry --help --list-files --limit-files --config --untracked
+  TEXT
   spec.homepage      = "https://github.com/oleander/rfix-rb"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
@@ -37,6 +48,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "vendor/cli-ui/lib"]
 
+  spec.requirements << "git, v2.0+"
+
   spec.add_runtime_dependency "rainbow", "~> 3.0"
   spec.add_runtime_dependency "rouge", "~> 3.20"
   spec.add_runtime_dependency "rubocop", "~> 0.80"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfix
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7.pre.68
 platform: ruby
 authors:
 - Linus Oleander
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -52,7 +52,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.80'
-description: "$ rfix local|branch|origin|info|all [--dry] [--help]"
+description: |2
+   RuboCop CLI that only complains about your latest changes
+   Uses 'git diff' to determine what changes were made then runs RuboCop against them
+
+  $ rfix branch <branch> -- Fix changes made between HEAD and <branch>
+  $ rfix origin          -- Fix changes made between HEAD and origin branch
+  $ rfix local           -- Fix changes not yet pushed to upstream branch
+  $ rfix info            -- Display runtime dependencies and their versions
+  $ rfix all             -- Fix all files in this repository (not recommended)
+
+   Optional args: --dry --help --list-files --limit-files --config --untracked
 email:
 - linus@oleander.nu
 executables:
@@ -89,7 +99,8 @@ files:
 - exe/rfix
 - lib/rfix.rb
 - lib/rfix/cmd.rb
-- lib/rfix/extensions.rb
+- lib/rfix/extensions/extensions.rb
+- lib/rfix/extensions/offense.rb
 - lib/rfix/formatter.rb
 - lib/rfix/git_file.rb
 - lib/rfix/git_helper.rb
@@ -98,6 +109,7 @@ files:
 - lib/rfix/tracked_file.rb
 - lib/rfix/untracked_file.rb
 - lib/rfix/version.rb
+- resources/ps.png
 - rfix.gemspec
 - vendor/cli-ui/lib/cli/ui.rb
 - vendor/cli-ui/lib/cli/ui/ansi.rb
@@ -129,7 +141,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/oleander/rfix-rb
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -141,12 +153,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
-requirements: []
-rubygems_version: 3.1.4
-signing_key:
+      version: 1.3.1
+requirements:
+- git, v2.0+
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: RuboCop CLI that only complains about your latest changes
 test_files: []

data/lib/rfix/extensions.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-require "rainbow"
-
-module Rfix::Ext
-  module CommentConfig
-    # Called by RuboCop on every line to see
-    # if its suppose to run against it or not
-    def cop_enabled_at_line?(_cop, line)
-      Rfix.enabled?(processed_source.file_path, line) && super
-    end
-  end
-
-  module Runner
-    # Called _after_ @source has been 'auto fixed' by Rubocop
-    def check_for_infinite_loop(source, offences)
-      Rfix.refresh!(source); super # TODO: Before or after?
-    end
-  end
-
-  module Options
-    # Appends custom --args to RuboCop CLI
-    def define_options
-      super.tap do |options|
-        @ons.each do |args, block|
-          option(options, *args, &block)
-        end
-      end
-    end
-
-    # Helper method used by rfix to append cli --args to Rubocop
-    def on(*args, &block)
-      @ons ||= []
-      @ons += [[args, block]]
-    end
-  end
-
-  module Offense
-    def where
-      line.to_s + ":" + real_column.to_s
-    end
-
-    def info
-      message.split(": ", 2).last.delete("\n")
-    end
-
-    def msg
-      CLI::UI.resolve_text("{{italic:#{info}}}", truncate_to: CLI::UI::Terminal.width - 10)
-    end
-
-    def code
-      message.split(": ", 2).first
-    end
-
-    def star
-      Rainbow("⭑")
-    end
-
-    def cross
-      Rainbow("✗")
-    end
-
-    def check
-      Rainbow("✓")
-    end
-
-    def level
-      colors = {
-        refactor: star.lightcyan,
-        convention: star.lightblue,
-        warning: star.lightyellow,
-        error: cross.indianred,
-        fatal: cross.lightsalmon
-      }
-
-      colors[severity.name]
-    end
-
-    def icon
-      return check.green if corrected?
-      return check.lightgreen if correctable?
-
-      cross.indianred
-    end
-  end
-end
-
-RuboCop::Options.prepend(Rfix::Ext::Options)
-RuboCop::Runner.prepend(Rfix::Ext::Runner)
-RuboCop::CommentConfig.prepend(Rfix::Ext::CommentConfig)
-RuboCop::Cop::Offense.prepend(Rfix::Ext::Offense)