rfix 1.0.7.pre.67 → 1.0.7.pre.68

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18adac7bf6bfb125c3cac54933353fb5c52a6a60854f0001afa0c5bdc69ece87
-  data.tar.gz: 1f1656bec3253bb8d609fa35fd157d60c45510e2fc787cf44139ae39dda756f7
+  metadata.gz: a26f95a0567bf3581515e5f7b7acc0b020ffad71f610e64cec9314b1a128573d
+  data.tar.gz: f70e41c32e3fe733fda2349d83c02e77705461337da6c0b5313e763c0950a46c
 SHA512:
-  metadata.gz: 6dac6c467ca60c677bceb2926e3f78ee86164ecda79b50a010595d40a8a5e924fa2182fbe7d90f64b5158abd36aa5b7860b107b2c2495748abfed15154da50d6
-  data.tar.gz: 29c0aca1abaa4ba8b3d13169128f052324061709ca7c03b01296b395d6f00b8dae8e76f231bd59942a350811ed6cb9d5b8a425b37bfd32a8bd01e7b368ed16a1
+  metadata.gz: 325fa9f8df215013e37cb0ee1b05d969cc3c66933a52b52605bbff6a5a4061445d7bb143b05bdca7ba624a5d9aa722582df782ea211110e83fd4cecd35d3b965
+  data.tar.gz: 255ffb2025dd390cb83939ffa90479cdb7dcd395b9f0511f9afdda54aad56c9975662c20080b575d31d4e9b9c1a35ce3f96b02629921a39684f669210f09cae3

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) [![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

@@ -80,7 +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 "\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

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

@@ -18,10 +18,9 @@ module Rfix
   end
 
   def set_fail_level(lint)
-    if
-      if lint
-      else
-        @config[:fail_level] = :warning
+    if if lint
+       else
+         @config[:fail_level] = :warning
       end
     end
   end
@@ -40,9 +39,7 @@ module Rfix
 
   def lint_mode!
     @config[:auto_correct] = false
-    if old?
-      @config[:fail_level] = :warning
-    end
+    @config[:fail_level] = :warning if old?
     load_untracked!
   end
 
@@ -76,9 +73,7 @@ module Rfix
       formatters: ["Rfix::Formatter"]
     }
 
-    if old?
-      @config[:fail_level] = :autocorrect
-    end
+    @config[:fail_level] = :autocorrect if old?
   end
 
   def files

data/rfix.gemspec

@@ -19,16 +19,16 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "RuboCop CLI that only complains about your latest changes"
   spec.description   = <<~TEXT
-    #{spec.summary}
-    Uses 'git diff' to determine what changes were made then runs RuboCop against them
+     #{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)
+    $ 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
+     Optional args: --dry --help --list-files --limit-files --config --untracked
   TEXT
   spec.homepage      = "https://github.com/oleander/rfix-rb"
   spec.license       = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfix
 version: !ruby/object:Gem::Version
-  version: 1.0.7.pre.67
+  version: 1.0.7.pre.68
 platform: ruby
 authors:
 - Linus Oleander
@@ -52,14 +52,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.80'
-description: "RuboCop CLI that only complains about your latest changes\nUses 'git
-  diff' to determine what changes were made then runs RuboCop against them\n\n\t$
-  rfix branch <branch> -- Fix changes made between HEAD and <branch>\n\t$ rfix origin
-  \         -- Fix changes made between HEAD and origin branch\n\t$ rfix local           --
-  Fix changes not yet pushed to upstream branch\n\t$ rfix info            -- Display
-  runtime dependencies and their versions\n\t$ rfix all             -- Fix all files
-  in this repository (not recommended)\n\nOptional args: --dry --help --list-files
-  --limit-files --config --untracked\n"
+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:
@@ -106,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