finstyle 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeb5600cba9fae12940b3709436b5208a5159123
-  data.tar.gz: f3c5753c338cc74f7b8096901f1eaa52ca785785
+  metadata.gz: 2516678794acc73b1d672039738734f59e277da8
+  data.tar.gz: ad965baa09e63ea6fed1d3d8a59331fbb988de84
 SHA512:
-  metadata.gz: 7b6678252f07c278e9c6cac0ab6a1c2d5e14344a869bba7e3dd8cdd3823866c3255dfbd988f6ac341086c0f5d6e8b4cd9865ed20655a4e10a7964322da4836f8
-  data.tar.gz: 7a65f642a4182990a786df9223a8d86ffd489395e0dabd36743d00428208a00faacb6b6b43c695540a72bbbcbfb9f0dd5168262fe99f14a2ead167a6fc327da6
+  metadata.gz: 490b0375853980a72bdc86fb2ea8a8fc719dddc2f387de649332983639f582060b468ce269e0e758a4ef782880442a0a95a11a127359ae450fd47bce30591971
+  data.tar.gz: 48bcc83bf599e376a4cca64f34bc01ab07a1d0ad8fe5d2164b94e4bfefd15bad10d1de68b6a4a65ff721cf5a29dfe949a3fb80fff3712b21798d096f86c13a35

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Style/FileName:
+  Exclude:
+    - 'bin/**/*'

data/.travis.yml

@@ -8,6 +8,8 @@ rvm:
   - ruby-head
   - jruby-19mode
 
+bundler_args: --without guard
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,11 +1,28 @@
+## 1.1.0 / 2014-07-22
+
+### New features
+
+* Introduce `Finstyle.config` to determine the path to YAML config file. ([@fnichol][])
+* Add `finstyle-config` which outputs the full path to config YAML. ([@fnichol][])
+
+### Improvements
+
+* Add more usage documentation for Guard, RuboCop command, etc. ([@fnichol][])
+* Remove redundant inheritance of enabled/disabled from default.yml. ([@fnichol][])
+* Add guard-rubocop support to project. ([@fnichol][])
+
+
 ## 1.0.1 / 2014-07-21
 
 ### Code changes
 
-* Add source encoding comments to Ruby files for better Ruby 1.9 compat. (@fnichol)
-* Updates to README. (@fnichol)
+* Add source encoding comments to Ruby files for better Ruby 1.9 compat. ([@fnichol][])
+* Updates to README. ([@fnichol][])
 
 
 ## 1.0.0 / 2014-07-21
 
 The initial release.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[@fnichol]: https://github.com/fnichol

data/Gemfile

@@ -1,3 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+group :guard do
+  gem "guard-rubocop"
+end

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rubocop, keep_failed: true, cli: "-r finstyle" do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -30,6 +30,22 @@ Or install it yourself as:
 
 ## Usage
 
+### Vanilla RuboCop
+
+Run RuboCop as normal, simply add a `-r finstyle` option when running:
+
+```sh
+rubocop -r finstyle -D --format offenses
+```
+
+Alternatively, you can use the `finstyle-config` command to determine the path on disk to Finstyle's YAML config file:
+
+```sh
+rubocop --config $(finstyle-config) -D --format offenses
+```
+
+### finstyle Command
+
 Use this tool just as you would RuboCop, but invoke the `finstyle` binary
 instead which patches RuboCop to load rules from the Finstyle gem. For example:
 
@@ -37,6 +53,8 @@ instead which patches RuboCop to load rules from the Finstyle gem. For example:
 finstyle -D --format offenses
 ```
 
+### Rake
+
 In a Rakefile, the setup is exactly the same, except you need to require the
 Finstyle library first:
 
@@ -48,6 +66,30 @@ RuboCop::RakeTask.new do |task|
 end
 ```
 
+### guard-rubocop
+
+You can use one of two methods. The simplest is to add the `-r finstyle` option to the `:cli` option in your Guardfile:
+
+```ruby
+guard :rubocop, cli: "-r finstyle" do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+```
+
+Alternatively you could pass the path to Finstyle's configuration by using the `Finstyle.config` method:
+
+```ruby
+require "finstyle"
+
+guard :rubocop, cli: "--config #{Finstyle.config}" do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+```
+
+### .rubycop.yml
+
 As with vanilla RuboCop, any custom settings can still be placed in a `.rubocop.yml` file in the root of your project.
 
 ## Frequently Ask Questions

data/bin/finstyle-config

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w[.. lib])
+
+require "finstyle"
+
+puts Finstyle.config

data/config/default.yml

@@ -1,5 +1,3 @@
 inherit_from:
   - upstream.yml
-  - enabled.yml
-  - disabled.yml
   - finstyle.yml

data/finstyle.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license        = "MIT"
 
   spec.files          = `git ls-files -z`.split("\x0")
-  spec.executables    = %w[finstyle]
+  spec.executables    = %w[finstyle finstyle-config]
   spec.test_files     = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths  = ["lib"]
 

data/lib/finstyle.rb

@@ -20,3 +20,13 @@ module RuboCop
     )
   end
 end
+
+# Finstyle patches the RuboCop tool to set a new default configuration that
+# is vendored in the Finstyle codebase.
+module Finstyle
+  # @return [String] the absolute path to the main RuboCop configuration YAML
+  #   file
+  def self.config
+    RuboCop::ConfigLoader::DEFAULT_FILE
+  end
+end

data/lib/finstyle/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Finstyle
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finstyle
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -85,18 +85,22 @@ email:
 - fnichol@nichol.ca
 executables:
 - finstyle
+- finstyle-config
 extensions: []
 extra_rdoc_files: []
 files:
 - ".cane"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/finstyle
+- bin/finstyle-config
 - config/default.yml
 - config/disabled.yml
 - config/enabled.yml