salsify_rubocop 0.40.0 → 0.40.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79745e0fa4948d0c8c0d8498da86625a41504805
-  data.tar.gz: 977119e8effeec2719ef5e5011f2f493a09b045e
+  metadata.gz: f740776b4dd783805ab13489676b4d8aa6ffa1c0
+  data.tar.gz: aa84e48dffec1b909c2ecbda341558dac30cd638
 SHA512:
-  metadata.gz: cb10a493f09c1987af22d4a65cdfbf869d316a6cc6864ddca7fe9f2b75a90b36ac8459a626b35f89a2c313b5192a9f5acb60d10c1c2d09d56be0c783495ba60d
-  data.tar.gz: 8dfcfab6cbd6a4eb986dd6ff0f6ac4259f04b99c9978a642a67a70e8268226c368620390e9ce5309f302516525a881047d990592bc8754867c6420b94f0456f0
+  metadata.gz: 06fb43b8eae49f4e048c12a7c054e094c958882bf181e38d59d12e3f997acb11da40a9b9522b83a69f0a28a72427ea90acc43efe271e4fc5e071769bb7274505
+  data.tar.gz: 25c00c93bd7e7eed800b17ee161870d35e33c889959627095a1dc196469c188c41115ca5bb6ef207f7bdb58f1fa4310d55b05926e5681d5fb2fab4f94cf13f34

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 # salsify_rubocop
 
+## v0.40.1
+- Changes to `rubocop_without_rspec` configuration:
+
+        Performance/RedundantMerge:
+          MaxKeyValuePairs: 1
+
+        Style/ModuleFunction:
+          Enabled: false
+
+        Style/RaiseArgs:
+          EnforcedStyle: compact
+
 ## v0.40.0
 - Initial version

data/README.md

@@ -1,28 +1,98 @@
-# SalsifyRubocop
+# salsify_rubocop
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/salsify_rubocop`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provides shared configuration for RuboCop for Salsify applications
+and gems.
 
-TODO: Delete this and the text above, and describe your gem
+[RuboCop](https://github.com/bbatsov/rubocop) is a static code analyzer that 
+can enforce style conventions as well as identify common problems.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'salsify_rubocop'
+group :development, :test do
+  gem 'salsify_rubocop', require: false
+end  
 ```
 
-And then execute:
+Or to your gem's gemspec file:
 
-    $ bundle
+```ruby
+spec.add_development_dependency 'salsify_rubocop'
+```
+
+If you created your gem using 
+[cookiecutter-salsify-gem](https://github.com/salsify/cookiecutter-salsify-gem)
+then this dependency was added automatically.
+
+Then execute:
+
+    $ bundle install
+
+It's best to ensure that you're starting from the latest release, so execute:
+
+    $ bundle update salsify_rubocop
+
+## Configuration
+
+To use one of the shared RuboCop configurations from this gem, you must define
+a `.rubocop.yml` file at the top-level directory in your project:
+
+```yaml
+inherit_gem:
+  salsify_rubocop: conf/rubocop_rails.yml
+```
 
-Or install it yourself as:
+Further customization of RuboCop for your local project may also be added to
+this file.
 
-    $ gem install salsify_rubocop
+### Available Configurations
 
+- **rubocop_rails**: For Rails projects, this inherits from **rubocop**.
+- **rubocop**: Assumes RSpec is used and requires 
+  [rubocop-rspec](https://github.com/nevir/rubocop-rspec). This configuration
+  is the default for gems. This inherits from **rubocop_without_rspec**.
+- **rubocop_without_rspec**: Configuration without `rubocop-rspec`. This is 
+  intended for gems that we may have forked and taken ownership of without
+  converting tests from a different framework.
+  
 ## Usage
 
-TODO: Write usage instructions here
+Run `rubocop` for an entire project:
+
+    $ bundle exec rubocop --format fu
+    
+See the `rubocop` command-line for additional options including auto-generating
+configuration for existing offenses and auto-correction.
+
+### Overcommit
+
+Consider using [overcommit](https://github.com/brigade/overcommit) to 
+automatically run `rubocop` on changed files before committing.
+
+This is automatically added by 
+[cookiecutter-salsify-gem](https://github.com/salsify/cookiecutter-salsify-gem/blob/master/%7B%7Bcookiecutter.repo_name%7D%7D/.overcommit.yml).
+
+### CI
+
+Consider running `rubocop` prior to running tests in CI for your project. 
+
+TODO: add more info here.
+
+## Versioning
+
+This gem is versioned based on the MAJOR.MINOR version of `rubocop`. The first
+release of the `salsify_rubocop` gem was v0.40.0.
+
+The patch version for this gem does _not_ correspond to the patch version of 
+`rubocop`. The patch version for this gem will change any time that one of its
+configurations is modified _or_ its dependency on `rubocop` is changed to require
+a different patch version.
+
+This gem also includes a dependency on `rubocop-rspec` that will be updated to
+the latest compatible version each time that the MAJOR.MINOR version of `rubocop` 
+is updated.
 
 ## Development
 

data/conf/rubocop_without_rspec.yml

@@ -12,6 +12,9 @@ AllCops:
 Lint/AmbiguousOperator:
   Enabled: false
 
+Performance/RedundantMerge:
+  MaxKeyValuePairs: 1
+
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
@@ -54,6 +57,9 @@ Style/GuardClause:
 Style/Lambda:
   Enabled: false
 
+Style/ModuleFunction:
+  Enabled: false
+
 Style/MultilineMethodCallIndentation:
   Enabled: false
 
@@ -66,6 +72,9 @@ Style/MultilineBlockLayout:
 Style/Proc:
   Enabled: false
 
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
 Style/RegexpLiteral:
   Enabled: false
 

data/lib/salsify_rubocop/version.rb

@@ -1,3 +1,3 @@
 module SalsifyRubocop
-  VERSION = '0.40.0'.freeze
+  VERSION = '0.40.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salsify_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.40.1
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Shared shared RuboCop configuration