rfix 1.0.7 → 1.0.8.pre.108

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/gem_helper.rb

@@ -0,0 +1,12 @@
+require "bundler"
+
+module GemHelper
+  def source_for(name:, &block)
+    bundle_root = Bundler.bundle_path.join('bundler/gems')
+    path = Dir.glob(bundle_root.join("#{name}-*").to_s).first
+    path or raise "Could not find source for #{name}, run bundle install first"
+    block(path)
+  rescue StandardError => e
+    puts "[Bundler] #{e}"
+  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,11 +13,11 @@ module Rfix::Log
   end
 
   def say_error_sub(message)
-    CLI::UI.puts("#{message}")
+    CLI::UI.puts(message.to_s)
   end
 
   def say_debug(message)
-    CLI::UI.puts("{{*}} #{message}")
+    CLI::UI.puts("{{*}} [{{info:Debug}}] #{message}")
   end
 
   def say_abort(message)

data/lib/rfix/rake_helper.rb

@@ -0,0 +1,56 @@
+require "tmpdir"
+
+module RakeHelper
+  include Rfix::Log
+  include Rfix::Cmd
+  include Rfix::GitHelper
+
+  def dirty?
+    !cmd_succeeded?("git diff --quiet")
+  end
+
+  def clone(github:, ref:)
+    Dir.mktmpdir(github.split("/")) do |src|
+      say "Clone {{info:#{github}}}, hold on ..."
+      git("clone", "https://github.com/#{github}", src)
+      Dir.chdir(src) do
+        say "Check out {{info:#{ref}}}"
+        git("reset", "--hard", ref)
+        git("clean", "-f", "-d")
+      end
+
+      dest = File.join("vendor", github)
+      say "Copy files to {{info:#{dest}}}"
+      FileUtils.mkdir_p(dest)
+      FileUtils.copy_entry(src, dest, true, true, true)
+    end
+  end
+
+  def gemfiles
+    Dir.glob("ci/Gemfile*").unshift("Gemfile").reject do |path|
+      [".lock", ".base"].include?(File.extname(path))
+    end
+  end
+
+  def gemlocks
+    Dir.glob("ci/Gemfile*.lock").unshift("Gemfile.lock")
+  end
+
+  def source_for(name:)
+    bundle_root = Bundler.bundle_path.join('bundler/gems')
+    path = Dir.glob(bundle_root.join("#{name}-*").to_s).first
+    path or raise "Could not find source for #{name}, run bundle install first"
+  end
+
+  def dest_for(name:)
+    File.join(__dir__, 'vendor', name)
+  end
+
+  def osx?
+    ENV.fetch("TRAVIS_OS_NAME") == "osx"
+  end
+
+  def brew_url(ref:)
+    "https://raw.githubusercontent.com/Homebrew/homebrew-core/#{ref}/Formula/git.rb"
+  end
+end

data/lib/rfix/rfix.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Layout/LineLength
+
 require "rubocop"
 require "optparse"
 require "rbconfig"
@@ -13,6 +15,66 @@ module Rfix
   include GitHelper
   include Log
 
+  def thanks
+    tx = []
+    tx << "\n{{v}} Thank you for installing {{green:rfix v#{Rfix::VERSION}}}!\n"
+    tx << "{{i}} Run {{command:rfix}} for avalible commands or any of the following to get started:"
+    tx << ""
+    # tx << "Here are a few examples that might be useful:"
+    indent = " " * 3
+    tx << "#{indent}{{command:rfix local}}   {{italic:# Auto-fixes commits not yet pushed to upstream}}"
+    tx << "#{indent}{{command:rfix origin}}  {{italic:# Auto-fixes commits between HEAD and origin branch}}"
+    tx << "#{indent}{{command:rfix lint}}    {{italic:# Lints commits and untracked files not yet pushed to upstream}}"
+    tx << ""
+    tx << "{{*}} {{bold:ProTip:}} Append {{command:--dry}} to run {{command:rfix}} in read-only mode"
+    tx << ""
+    tx << "{{i}} {{bold:Issues}} {{italic:https://github.com/oleander/rfix-rb/issues}}"
+    tx << "{{i}} {{bold:Readme}} {{italic:https://github.com/oleander/rfix-rb/blob/master/README.md}}"
+    tx << "{{i}} {{bold:Travis}} {{italic:https://travis-ci.org/github/oleander/rfix-rb}}"
+    tx << ""
+    tx << "{{italic:~ Linus}}\n\n"
+    CLI::UI.fmt(tx.join("\n"), enable_color: true)
+  end
+
+  def help
+    cmds = []
+    cmds << "\t{{bold:rfix [cmd] [options]}} -- {{italic:--dry --help --list-files --limit-files --config --untracked}}"
+    cmds << "\t{{bold:rfix branch <branch>}} -- {{italic:Fix changes made between HEAD and <branch>}}"
+    cmds << "\t{{bold:rfix origin}}          -- {{italic:Fix changes made between HEAD and origin branch}}"
+    cmds << "\t{{bold:rfix local}}           -- {{italic:Fix changes not yet pushed to upstream branch}}"
+    cmds << "\t{{bold:rfix info}}            -- {{italic:Display runtime dependencies and their versions}}"
+    cmds << "\t{{bold:rfix all}}             -- {{italic:Fix all files in this repository}} {{warning:(not recommended)}}"
+    cmds << "\t{{bold:rfix lint}}            -- {{italic:Shortcut for 'local --dry --untracked'}}"
+    CLI::UI.fmt(cmds.join("\n"), enable_color: true)
+  end
+
+  def config
+    @config
+  end
+
+  def no_auto_correct!
+    @config[:auto_correct] = false
+  end
+
+  def auto_correct!
+    @config[:auto_correct] = true
+  end
+
+  def load_config
+    yield @store
+  rescue RuboCop::Error => e
+    say_abort "[Config:RuboCop] #{e}"
+  rescue TypeError => e
+    say_abort "[Config:Type] #{e}"
+  rescue Psych::SyntaxError => e
+    say_abort "[Config:Syntax] #{e}"
+  end
+
+  def lint_mode!
+    no_auto_correct!
+    load_untracked!
+  end
+
   def git_version
     cmd("git --version").last.split(/\s+/, 3).last
   end
@@ -33,9 +95,24 @@ module Rfix
     @global_enable
   end
 
+  def store
+    @store
+  end
+
+  def clear_cache!
+    RuboCop::ResultCache.cleanup(@store, true)
+  end
+
   def init!
     @files ||= {}
     @global_enable = false
+    @config = {
+      force_exclusion: true,
+      formatters: ["Rfix::Formatter"]
+    }
+
+    @store = RuboCop::ConfigStore.new
+    auto_correct!
   end
 
   def files
@@ -83,7 +160,7 @@ module Rfix
   end
 
   def has_branch?(name)
-    Open3.capture2e("git", "cat-file", "-t", name).last.success?
+    cmd_succeeded?("git", "cat-file", "-t", name)
   end
 
   # Ref since last push
@@ -100,6 +177,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)
@@ -107,9 +190,7 @@ module Rfix
   end
 
   def list_untrack_files
-    git("status", "-u", "--porcelain", "--no-column").map do |line|
-      line.split(" ", 2).map(&:strip)
-    end.select { |el| el.first == "??" }.map(&:last)
+    git("ls-files", "--exclude-standard", "--others")
   end
 
   def cached(files)
@@ -119,3 +200,5 @@ module Rfix
     end
   end
 end
+
+# rubocop:enable Layout/LineLength

data/lib/rfix/version.rb

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

data/rfix.gemspec

@@ -2,8 +2,11 @@
 
 require "pathname"
 require_relative "lib/rfix/version"
+# require_relative "lib/rfix/gem_helper"
 
 Gem::Specification.new do |spec|
+  # extend GemHelper
+
   spec.name          = "rfix"
 
   if ENV["TRAVIS"]
@@ -17,18 +20,16 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Linus Oleander"]
   spec.email         = ["linus@oleander.nu"]
 
-  spec.summary       = "RuboCop CLI that only complains about your latest changes"
+  # rubocop:disable Layout/LineLength
+  spec.summary       = "RuboCop CLI that only lints and auto-fixes code you committed by utilizing `git-log` and `git-diff`"
+  # rubocop:enable Layout/LineLength
+
   spec.description   = <<~TEXT
-    #{spec.summary}
-    Uses 'git diff' to determine what changes were made then runs RuboCop against them
+    RuboCop CLI that only lints and auto-fixes code you committed by utilizing `git-log` and `git-diff`. Rfix CLI makes it possible to lint (`rfix lint`) and auto-fix (`rfix local|origin|branch`) code changes since a certain point in history. You can auto-fix code committed since creating the current branch (`rfix origin`) or since pushing to upstream (`rfix local`).
 
-  	$ 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)
+    Includes a RuboCop formatter with syntax highlighting and build in hyperlinks for offense documentation.
 
-    Optional args: --dry --help --list-files --limit-files --config --untracked
+    Holds the same CLI arguments as RuboCop. Run `rfix --help` for a complete list or `rfix` for supported commands.
   TEXT
   spec.homepage      = "https://github.com/oleander/rfix-rb"
   spec.license       = "MIT"
@@ -42,13 +43,19 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject(&validate_file)
   end
 
-  spec.files += Dir.glob("vendor/cli-ui/lib/**/*").reject(&validate_file)
+  spec.files += Dir.glob("vendor/shopify/cli-ui/lib/**/*").reject(&validate_file)
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib", "vendor/cli-ui/lib"]
+  spec.require_paths = ["lib", "vendor/shopify/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"
+  spec.add_runtime_dependency "rubocop", ">= 0.80"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "aruba", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 12.3"
 end