cookstyle 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d68e913afdc2adcf81d98ed36954f87171d8dd3
-  data.tar.gz: db9c077caec8243cce4db32259ff0eaac1532fe2
+  metadata.gz: 252eecc60f7e535245ffbba0cff391f8f7bf8f35
+  data.tar.gz: c13360ce493a065f60914070f60e0b08803dc36c
 SHA512:
-  metadata.gz: 9f96d13059329d2c744198ac738c181c1543eb4f2e6f35e6442440452639313d7b6878abe54a587060088a85ff02a8111537f50fa84798ceff2ce30bd0fc27bf
-  data.tar.gz: 9e151506eb24ae9689f1a13aec5be62949764a393fa4f39e175cb355bf9e6ab3f9a5a1ee13cc29636045a7b312e1d72b6de0fc26adb83613b3ee72e086ccc3df
+  metadata.gz: f5743882a78a21c9c956b04aaa71bd2b01be4fba89a924220834be7839b15af0acb0d81ede63e6e96bf919acca6bdfb89f500a19dff1229fcb2843a2be8311e6
+  data.tar.gz: acb1272ba9a18dff31f05c28ad0423d4c15f105bb2a44d68f3374e75f79aed3775b1597ceb5eb80c3aef64f6b06216838d6bf07a9d75d8f57c7a1c0ca44df7ed

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+cache: bundler
+
+sudo: false
+
+branches:
+  only:
+    - master
 rvm:
-  - 2.2.1
-before_install: gem install bundler -v 1.10.6
+  - 2.2.5
+  - 2.3.1

data/README.md

@@ -1,21 +1,31 @@
 # Cookstyle - Version Pinned rubocop and sane defaults for Chef Cookbooks
 
-Pull requests to this repo will not be accepted without corresponding
-PRs into at least the chef-client and ohai codebases to clean the
-code up.  PRs will not be accepted that assume unfunded mandates for
-other people to finish the work.  Do not open PRs offering opinions
-or suggestions without offering to do the work.
-
-The project itself is a derivative of
-[finstyle](https://github.com/fnichol/finstyle), but starts with all
-rules disabled.  The active ruleset is in the
-[config/cookstyle.yml](https://github.com/chef/cookstyle/blob/master/config/cookstyle.yml)
-file.
+[![Gem Version](https://badge.fury.io/rb/cookstyle.svg)](https://badge.fury.io/rb/cookstyle) [![Build Status](https://travis-ci.org/chef/cookstyle.svg?branch=master)](https://travis-ci.org/chef/cookstyle)
+
+Pull Requests will not be accepted that assume unfunded mandates for other people to finish the work cleaning up various Chef owned cookbooks. Do not open PRs offering opinions or suggestions without offering to do the work.
+
+The project itself is a derivative of [finstyle](https://github.com/fnichol/finstyle), but starts with all rules disabled. The active ruleset is in the [config/cookstyle.yml](https://github.com/chef/cookstyle/blob/master/config/cookstyle.yml) file.
 
 ## How It Works
 
 This library has a direct dependency on one specific version of RuboCop (at a time), and [patches it][patch] to load the [upstream configuration][upstream] and [custom set][config] of rule updates. When a new RuboCop release comes out, this library can rev its pinned version dependency and [re-vendor][rakefile] the upstream configuration to determine if any breaking style or lint rules were added/dropped/reversed/etc.
 
+## NOTE CAREFULLY ABOUT UPDATING COOKSTYLE
+
+This is designed to allow bumping the rubocop engine while keeping backwards compatibility with the config and not requiring all the cookbooks to update.
+
+The [cookstyle_base.yml](https://github.com/chef/cookstyle/blob/master/config/cookstyle_base.yml) file is (essentially) the enabled.yml file from 0.37.2 (as of this writing) which is applied on top of 0.46.0 with all the rules disabled. It pins the default enabled set to 0.37.2 compatibility while running under the 0.46.0 engine.
+
+There is no rake task for updating the `cookstyle_base.yml` file. It was generated by hand -- the Description and other fields need to be dropped out of it.
+
+It may be necessary to edit that file (again by hand) to resolve issues with later rubocop engines changing cop names (renaming, splitting up, etc).
+
+Occasionally the `cookstyle_base.yml` file should be updated, which will generate a lot of work to fix every cookbook that cookstyle runs against.
+
+When updating to a new engine the `rake vendor` task should still always be run in order to update the base set of cops and generate the default disabled.yml ruleset.
+
+When editing the `cookstyle_base.yml` becomes too much of a PITA, it may be time to bump the engine, run `rake vendor` and then drop the new `enabled.yml` into `cookstyle_base.yml`, fix it up, and ship it and then deal with the fallout of all the new cops...
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,11 +36,15 @@ gem 'cookstyle'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install cookstyle
+```
+$ gem install cookstyle
+```
 
 ## Usage
 
@@ -44,8 +58,7 @@ rubocop -r cookstyle -D --format offenses
 
 ### cookstyle Command
 
-Use this tool just as you would RuboCop, but invoke the `cookstyle` binary
-instead which patches RuboCop to load rules from the cookstyle gem. For example:
+Use this tool just as you would RuboCop, but invoke the `cookstyle` binary instead which patches RuboCop to load rules from the cookstyle gem. For example:
 
 ```sh
 cookstyle -D --format offenses
@@ -53,8 +66,7 @@ cookstyle -D --format offenses
 
 ### Rake
 
-In a Rakefile, the setup is exactly the same, except you need to require the
-cookstyle library first:
+In a Rakefile, the setup is exactly the same, except you need to require the cookstyle library first:
 
 ```ruby
 require "cookstyle"

data/Rakefile

@@ -26,3 +26,5 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new(:style) do |task|
   task.options << "--display-cop-names"
 end
+
+task default: [:build, :install]

data/config/cookstyle.yml

@@ -5,10 +5,6 @@ AllCops:
 
 AlignParameters:
   Enabled: false
-ClassLength:
-  Enabled: false
-CyclomaticComplexity:
-  Enabled: false
 Documentation:
   Enabled: false
 Encoding:
@@ -27,7 +23,87 @@ Metrics/AbcSize:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 PerceivedComplexity:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+
+# https://github.com/chef/cookstyle/pull/5
+Style/TrailingCommaInLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+# Underscores in numbers are unnecessary, especially for port numbers where they are unexpected
+Style/NumericLiterals:
+  Enabled: false
+
+# regex rules often trigger no matter what you do with inspec/serverspec matchers
+Style/RegexpLiteral:
+  Exclude:
+    - 'test/**/*'
+
+# some names are not ascii and this prevents copyright comments
+Style/AsciiComments:
+  Enabled: false
+
+# avoid case statements where the 2nd 'when' would never fire
+Lint/DuplicateCaseCondition:
+  Enabled: true
+
+# empty expressions serve no purpose
+Lint/EmptyExpression:
+  Enabled: true
+
+# when in a case statement should always do something
+Lint/EmptyWhen:
+  Enabled: true
+
+# %w('something') is almost always a typo
+Lint/PercentStringArray:
+  Enabled: true
+
+# %w(:something) should be a string not a symbol
+Lint/PercentSymbolArray:
+  Enabled: true
+
+# if you rescue Exception, then rescue say StandardError you're gonna have a bad time
+Lint/ShadowedException:
+  Enabled: false
+
+# We're on modern ruby so let's assume Integer everywhere
+Lint/UnifiedInteger:
+  Enabled: true
+
+# consistent hash key/value checks
+Style/PreferredHashMethods:
+  Enabled: true
+
+# when iterating a fixed number of times this is much easier to read
+Style/EachForSimpleLoop:
+  Enabled: true
+
+# a case statement without a condition is just an if statement
+Style/EmptyCaseCondition:
+  Enabled: true
+
+# helpers are easiest to read
+Style/NumericPredicate:
+  Enabled: true
+
+# this is bad %w(something     another_thing   one_more)
+Style/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+# ( true ) ? 'bob' : 'bill' is unnecessary
+Style/TernaryParentheses:
+  Enabled: true
+
+# disable this until there's an autocorrect
+Bundler/OrderedGems:
+  Enabled: false
+
+# There's no reason to have a gem listed twice
+Bundler/DuplicatedGem:
+   Enabled: true

data/config/disable_all.yml

@@ -17,6 +17,8 @@ Lint/DefEndAlignment:
   Enabled: false
 Lint/DeprecatedClassMethods:
   Enabled: false
+Lint/DuplicateCaseCondition:
+  Enabled: false
 Lint/DuplicateMethods:
   Enabled: false
 Lint/DuplicatedKey:
@@ -27,8 +29,12 @@ Lint/ElseLayout:
   Enabled: false
 Lint/EmptyEnsure:
   Enabled: false
+Lint/EmptyExpression:
+  Enabled: false
 Lint/EmptyInterpolation:
   Enabled: false
+Lint/EmptyWhen:
+  Enabled: false
 Lint/EndAlignment:
   Enabled: false
 Lint/EndInMethod:
@@ -45,6 +51,8 @@ Lint/HandleExceptions:
   Enabled: false
 Lint/ImplicitStringConcatenation:
   Enabled: false
+Lint/InheritException:
+  Enabled: false
 Lint/IneffectiveAccessModifier:
   Enabled: false
 Lint/InvalidCharacterLiteral:
@@ -63,20 +71,30 @@ Lint/NonLocalExitFromIterator:
   Enabled: false
 Lint/ParenthesesAsGroupedExpression:
   Enabled: false
+Lint/PercentStringArray:
+  Enabled: false
+Lint/PercentSymbolArray:
+  Enabled: false
 Lint/RandOne:
   Enabled: false
 Lint/RequireParentheses:
   Enabled: false
 Lint/RescueException:
   Enabled: false
+Lint/ShadowedException:
+  Enabled: false
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
 Lint/StringConversionInInterpolation:
   Enabled: false
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
+Lint/UnifiedInteger:
+  Enabled: false
 Lint/UnneededDisable:
   Enabled: false
+Lint/UnneededSplatExpansion:
+  Enabled: false
 Lint/UnreachableCode:
   Enabled: false
 Lint/UnusedBlockArgument:
@@ -99,6 +117,8 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false
 Metrics/BlockNesting:
   Enabled: false
 Metrics/ClassLength:
@@ -149,6 +169,8 @@ Performance/Sample:
   Enabled: false
 Performance/Size:
   Enabled: false
+Performance/SortWithBlock:
+  Enabled: false
 Performance/StartWith:
   Enabled: false
 Performance/StringReplacement:
@@ -227,7 +249,9 @@ Style/Copyright:
   Enabled: false
 Style/DefWithParentheses:
   Enabled: false
-Style/DeprecatedHashMethods:
+Style/PreferredHashMethods:
+  Enabled: false
+Style/DocumentationMethod:
   Enabled: false
 Style/Documentation:
   Enabled: false
@@ -235,10 +259,14 @@ Style/DotPosition:
   Enabled: false
 Style/DoubleNegation:
   Enabled: false
+Style/EachForSimpleLoop:
+  Enabled: false
 Style/EachWithObject:
   Enabled: false
 Style/ElseAlignment:
   Enabled: false
+Style/EmptyCaseCondition:
+  Enabled: false
 Style/EmptyElse:
   Enabled: false
 Style/EmptyLineBetweenDefs:
@@ -303,6 +331,8 @@ Style/IfUnlessModifierOfIfUnless:
   Enabled: false
 Style/IfWithSemicolon:
   Enabled: false
+Style/ImplicitRuntimeError:
+  Enabled: false
 Style/IndentArray:
   Enabled: false
 Style/IndentAssignment:
@@ -335,6 +365,8 @@ Style/MethodDefParentheses:
   Enabled: false
 Style/MethodName:
   Enabled: false
+Style/MethodMissing:
+  Enabled: false
 Style/MissingElse:
   Enabled: false
 Style/ModuleFunction:
@@ -351,6 +383,10 @@ Style/MultilineHashBraceLayout:
   Enabled: false
 Style/MultilineIfThen:
   Enabled: false
+Style/MultilineIfModifier:
+  Enabled: false
+Style/MultilineMemoization:
+  Enabled: false
 Style/MultilineMethodCallBraceLayout:
   Enabled: false
 Style/MultilineMethodCallIndentation:
@@ -383,6 +419,10 @@ Style/Not:
   Enabled: false
 Style/NumericLiterals:
   Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
 Style/OneLineConditional:
   Enabled: false
 Style/OpMethod:
@@ -425,6 +465,8 @@ Style/RescueEnsureAlignment:
   Enabled: false
 Style/RescueModifier:
   Enabled: false
+Style/SafeNavigation:
+  Enabled: false
 Style/SelfAssignment:
   Enabled: false
 Style/Semicolon:
@@ -465,6 +507,10 @@ Style/SpaceBeforeFirstArg:
   Enabled: false
 Style/SpaceBeforeSemicolon:
   Enabled: false
+Style/SpaceInLambdaLiteral:
+  Enabled: false
+Style/SpaceInsideArrayPercentLiteral:
+  Enabled: false
 Style/SpaceInsideBlockBraces:
   Enabled: false
 Style/SpaceInsideBrackets:
@@ -473,6 +519,8 @@ Style/SpaceInsideHashLiteralBraces:
   Enabled: false
 Style/SpaceInsideParens:
   Enabled: false
+Style/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
 Style/SpaceInsideRangeLiteral:
   Enabled: false
 Style/SpaceInsideStringInterpolation:
@@ -497,6 +545,8 @@ Style/SymbolProc:
   Enabled: false
 Style/Tab:
   Enabled: false
+Style/TernaryParentheses:
+  Enabled: false
 Style/TrailingBlankLines:
   Enabled: false
 Style/TrailingCommaInArguments:
@@ -521,6 +571,8 @@ Style/VariableInterpolation:
   Enabled: false
 Style/VariableName:
   Enabled: false
+Style/VariableNumber:
+  Enabled: false
 Style/WhenThen:
   Enabled: false
 Style/WhileUntilDo:
@@ -535,23 +587,45 @@ Rails/ActionFilter:
   Enabled: false
 Rails/Date:
   Enabled: false
+Rails/DynamicFindBy:
+  Enabled: false
 Rails/Delegate:
   Enabled: false
+Rails/DelegateAllowBlank:
+  Enabled: false
+Rails/Exit:
+  Enabled: false
 Rails/FindBy:
   Enabled: false
 Rails/FindEach:
   Enabled: false
 Rails/HasAndBelongsToMany:
   Enabled: false
+Rails/HttpPositionalArguments:
+  Enabled: false
+Rails/NotNullColumn:
+  Enabled: false
+Rails/OutputSafety:
+  Enabled: false
 Rails/Output:
   Enabled: false
 Rails/PluralizationGrammar:
   Enabled: false
 Rails/ReadWriteAttribute:
   Enabled: false
+Rails/RequestReferer:
+  Enabled: false
+Rails/SafeNavigation:
+  Enabled: false
+Rails/SaveBang:
+  Enabled: false
 Rails/ScopeArgs:
   Enabled: false
 Rails/TimeZone:
   Enabled: false
+Rails/UniqBeforePluck:
+  Enabled: false
 Rails/Validation:
   Enabled: false
+Security/JSONLoad:
+  Enabled: false

data/config/disabled.yml

@@ -5,22 +5,34 @@
 Rails:
   Enabled: false
 
+Rails/SaveBang:
+  Description: 'Identifies possible cases where Active Record save! or related should be used.'
+  StyleGuide: 'https://github.com/bbatsov/rails-style-guide#save-bang'
+  Enabled: false
+
 Style/AutoResourceCleanup:
   Description: 'Suggests the usage of an auto resource cleanup version of a method (if available).'
   Enabled: false
 
 Style/CollectionMethods:
   Description: 'Preferred collection methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size'
+  StyleGuide: '#map-find-select-reduce-size'
   Enabled: false
 
 Style/Copyright:
   Description: 'Include a copyright notice in each file before any code.'
   Enabled: false
 
+Style/DocumentationMethod:
+  Description: 'Public methods.'
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
 Style/Encoding:
   Description: 'Use UTF-8 as the source file encoding.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#utf-8'
+  StyleGuide: '#utf-8'
   Enabled: false
 
 Style/FirstArrayElementLineBreak:
@@ -47,13 +59,19 @@ Style/FirstMethodParameterLineBreak:
                  multi-line method parameter definition.
   Enabled: false
 
+Style/ImplicitRuntimeError:
+  Description: >-
+                 Use `raise` or `fail` with an explicit exception class and
+                 message, rather than just a message.
+  Enabled: false
+
 Style/InlineComment:
-  Description: 'Avoid inline comments.'
+  Description: 'Avoid trailing inline comments.'
   Enabled: false
 
 Style/MethodCalledOnDoEndBlock:
   Description: 'Avoid chaining a method call on a do...end block.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
+  StyleGuide: '#single-line-blocks'
   Enabled: false
 
 Style/MissingElse:
@@ -73,37 +91,9 @@ Style/MissingElse:
     - case
     - both
 
-Style/MultilineArrayBraceLayout:
-  Description: >-
-                 Checks that the closing brace in an array literal is
-                 symmetrical with respect to the opening brace and the
-                 array elements.
-  Enabled: false
-
 Style/MultilineAssignmentLayout:
   Description: 'Check for a newline after the assignment operator in multi-line assignments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-conditional-assignment'
-  Enabled: false
-
-Style/MultilineHashBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a hash literal is
-                 symmetrical with respect to the opening brace and the
-                 hash elements.
-  Enabled: false
-
-Style/MultilineMethodCallBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a method call is
-                 symmetrical with respect to the opening brace and the
-                 method arguments.
-  Enabled: false
-
-Style/MultilineMethodDefinitionBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a method definition is
-                 symmetrical with respect to the opening brace and the
-                 method parameters.
+  StyleGuide: '#indent-conditional-assignment'
   Enabled: false
 
 Style/OptionHash:
@@ -112,7 +102,7 @@ Style/OptionHash:
 
 Style/Send:
   Description: 'Prefer `Object#__send__` or `Object#public_send` to `send`, as `send` may overlap with existing methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#prefer-public-send'
+  StyleGuide: '#prefer-public-send'
   Enabled: false
 
 Style/StringMethods:
@@ -121,5 +111,5 @@ Style/StringMethods:
 
 Style/SymbolArray:
   Description: 'Use %i or %I for arrays of symbols.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-i'
+  StyleGuide: '#percent-i'
   Enabled: false