dlss_cops 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 526655efdb533728bac0be0070435a9219bee213
-  data.tar.gz: 9c45adba622c4ca6cbb1f6f064bec0f780d20718
+  metadata.gz: bcdf17146b75a66e0a0d819bd0d69b2604ff2f83
+  data.tar.gz: 34efc86383db01ab220683df7e435bbbbf3dc43a
 SHA512:
-  metadata.gz: 6a52591aa226140f105a15bcdf343007ecdb07c87399bc78b409ed4bedd9e87286186e7150333288f5590df0ab8017ef20cc7f83eeea36515598a1c015eb6477
-  data.tar.gz: 77df0275b1ce1e921d87191cd168fdb2a47d2b875976c1eb53550a528ec0572597a08b2373360a273f7694ac6810cd911ebfebb0009b831d38ba42c38c28814e
+  metadata.gz: 1f9dd2505a3ca294e859212c06e456c0e9501931f4ffb2e7f1b782a9cbfc42321e473274b7ac2e6bdb3853dacff05f98e71c8d90ea09606cd694f946098ca9d9
+  data.tar.gz: 96997a42a9daf0b7d55b93844a3a70de5ac297bd40c6125644f71d62e30d3d9e59e35fc5dd9ddc66fa2fbb52afad7c68a692779af2341859c3148ec5d3fb609f

data/.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_from:
-  - ./config/rubocop.yml
+  - ./config/dlss_baseline.yml

data/README.md

@@ -1,27 +1,39 @@
 # DlssCops
 
-DlssCops is a Rubocop configuration gem that holds DLSS's shared Ruby style guide.
+DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style guide.
+See https://github.com/bbatsov/rubocop for more information about Rubocop.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+We recommend you use the latest version of DlssCops but if needed, you can
+select a specific version to manage change.  
+
+Add a development_dependency in your gem's gemspec file
 
 ```ruby
-gem 'dlss_cops'
+  gemspec.add_development_dependency 'dlss_cops'
 ```
 
-Then execute:
+OR, if it's not a gem, add these lines to your Gemfile:
 
-    $ bundle
+```ruby
+group :development, :test do
+  gem 'dlss_cops'
+end
+```
 
-Then set up your .rubocop.yml` file as such:
+## Usage
+
+Set up your .rubocop.yml file:
 
 ```yaml
 inherit_gem:
-  dlss_cops: "config/rubocop.yml"
+  dlss_cops: "config/dlss_baseline.yml"
 
 AllCops:
   TargetRubyVersion: 2.2
 ```
 
 Then you can launch rubocop via: `bundle exec rubocop <options>`
+
+See https://github.com/bbatsov/rubocop#basic-usage  for more information.

data/config/{rubocop.yml → dlss_baseline.yml}

@@ -7,9 +7,17 @@ AllCops:
     - '**/Rakefile'
     - '**/config.ru'
   Exclude:
+    - 'Gemfile'
+    - 'Gemfile.lock'
+    - '*.gemspec'
+    - '**/*.md'
+    - 'bin/*'
+    - 'config/**/*.yml'
     - 'db/**/*'
     - 'script/**/*'
     - '.internal_test_app/**/*'
+    - 'spec/fixtures/**/*'
+    - 'spec/internal/**/*'
     - 'spec/test_app_templates/**/*'
     - 'vendor/**/*'
 
@@ -17,7 +25,7 @@ AllCops:
 Rails:
   Enabled: true
 
-# Cops with default values configured
+# DLSS configuration changes for these cops enabled by default in Rubocop
 
 Metrics/AbcSize:
   Max: 20
@@ -55,7 +63,11 @@ RSpec/ExampleWording:
   IgnoredWords:
     - only
 
-# Cops that are turned off by default because we disagree about them
+# DLSS explicitly disabling these cops enabled by default in Rubocop
+# (DLSS agrees they should be disabled, or we disagree about whether they should be enabled)
+
+Style/AccessModifierIndentation:
+  Enabled: false
 
 Style/AlignHash:
   Enabled: false

data/dlss_cops.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Michael J. Giarlo']
   spec.email         = ['mjgiarlo@stanford.edu']
 
-  spec.summary       = 'DlssCops is a Rubocop configuration gem that holds the DLSS Ruby style guide'
-  spec.description   = 'DlssCops is a Rubocop configuration gem that holds the DLSS Ruby style guide.'
+  spec.summary       = "DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style guide"
+  spec.description   = "DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style guide."
   spec.homepage      = 'https://github.com/sul-dlss/dlss_cops'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/dlss_cops/version.rb

@@ -1,3 +1,3 @@
 module DlssCops
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dlss_cops
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael J. Giarlo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: DlssCops is a Rubocop configuration gem that holds the DLSS Ruby style
-  guide.
+description: DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby
+  style guide.
 email:
 - mjgiarlo@stanford.edu
 executables: []
@@ -76,14 +76,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- config/rubocop.yml
+- config/dlss_baseline.yml
 - dlss_cops.gemspec
 - lib/dlss_cops.rb
 - lib/dlss_cops/version.rb
@@ -109,5 +107,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: DlssCops is a Rubocop configuration gem that holds the DLSS Ruby style guide
+summary: DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style
+  guide
 test_files: []