cookstyle 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a37a4a7a9ec43c83e6085e8971b23619ecbc3856bb23e809e1e75bd862b9969
-  data.tar.gz: 6c0985615bebda8f779282554a089be993b8d3bb92efdcad2a52b46cef7a79a8
+  metadata.gz: aeeb9f2df11ca3427f17df1c4e2ccf8b0adc510276bcd395cf9e20a02714dd96
+  data.tar.gz: 1d5bccf02c9b86b0080641b8192249bd0b5aaabfb8bbe3403f4e46dec715bdd5
 SHA512:
-  metadata.gz: 92eb8d8eb33a6523c05c29013f670305d17ac480a0e992081ebcd15fc2a6b716ccd59fe6889ed87c0f1f098f853343d67035664021b98023a739ba3cc40a8302
-  data.tar.gz: 420492d447f9d021f3a1b98074f7e12d0e4b5268ede661fb5db3d79bedf24672373548c247b825a80d114dff7ca68605db795d1db8279ffb392a8842a7c5b85d
+  metadata.gz: c81f0e25b0cd9234a4d7c5efb8a62c97f5c4765f395adce9047af577768838162299b7130ce63bce5525274fef2592480b08e4bdde50d683d471dd9eaa6c3e96
+  data.tar.gz: e654324057aa0be6abd35dad2dae215358594861930c712b737f2cc745b97606c219d9bab92459aea5d958cd6c364e0037d5e8c833d3f6545eb7902b4ec3eead

data/bin/cookstyle

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 # -*- encoding: utf-8 -*-
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
 
-require "cookstyle"
+require 'cookstyle'
 
-if ARGV.size == 1 && %w[-v --version].include?(ARGV.first)
+if ARGV.size == 1 && %w(-v --version).include?(ARGV.first)
   puts "Cookstyle #{Cookstyle::VERSION}"
-  print "  * RuboCop "
+  print '  * RuboCop '
 end
 
-load Gem.bin_path("rubocop", "rubocop")
+load Gem.bin_path('rubocop', 'rubocop')

data/config/cookstyle.yml

@@ -230,3 +230,9 @@ Style/UnpackFirst:
 # simplify how you get the min or max of an array
 Performance/UnneededSort:
   Enable: true
+
+Style/SymbolProc:
+  # A list of method names to be ignored by the check.
+  # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
+  IgnoredMethods:
+    - lazy

data/lib/cookstyle.rb

@@ -1,19 +1,19 @@
-require "cookstyle/version"
+require 'cookstyle/version'
 
 # ensure the desired target version of RuboCop is gem activated
-gem "rubocop", "= #{Cookstyle::RUBOCOP_VERSION}"
-require "rubocop"
+gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
+require 'rubocop'
 
 module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(
       /^.*$/,
-      File.realpath(File.join(File.dirname(__FILE__), ".."))
+      File.realpath(File.join(File.dirname(__FILE__), '..'))
     )
 
     DEFAULT_FILE.gsub!(
       /^.*$/,
-      File.join(RUBOCOP_HOME, "config", "default.yml")
+      File.join(RUBOCOP_HOME, 'config', 'default.yml')
     )
   end
 end

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "3.0.0".freeze
-  RUBOCOP_VERSION = "0.55.0".freeze
+  VERSION = '3.0.1'.freeze
+  RUBOCOP_VERSION = '0.55.0'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Thom May
+- Tim Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -69,19 +70,13 @@ dependencies:
 description: 
 email:
 - thom@chef.io
+- tsmith@chef.io
 executables:
 - cookstyle
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
+- LICENSE
 - bin/cookstyle
 - config/cookstyle.yml
 - config/cookstyle_base.yml
@@ -90,7 +85,6 @@ files:
 - config/disabled.yml
 - config/enabled.yml
 - config/upstream.yml
-- cookstyle.gemspec
 - lib/cookstyle.rb
 - lib/cookstyle/version.rb
 homepage: https://github.com/chef/cookstyle
@@ -113,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Rubocop configuration for Chef cookbooks
+summary: RuboCop configuration for Chef cookbooks
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-cache: bundler
-dist: trusty
-sudo: false
-
-branches:
-  only:
-    - master
-
-# Early warning system to catch if Rubygems breaks something
-before_install:
-  - gem update --system
-
-rvm:
-  - 2.3.4
-  - 2.4.1

data/CHANGELOG.md

@@ -1,116 +0,0 @@
-# Cookstyle Changelog
-
-## 3.0.0 (2018-05-07)
-
-The RuboCop engine has been updated from 0.49 to 0.55 in this release of Cookstyle. This fixes a very large number of bugs and may lead to new warnings being shown for existing rules. Additionally the names of many rules were changed which may require updating your .rubocop.yml files if you previously disabled these rules.
-
-### Newly Enabled Cops:
-
-- Bundler/InsecureProtocolSource
-- Layout/EmptyComment
-- Layout/EmptyLinesAroundArguments
-- Lint/BigDecimalNew
-- Lint/BooleanSymbol
-- Lint/InterpolationCheck:
-- Lint/RedundantWithIndex
-- Lint/RedundantWithObject
-- Lint/RegexpInCondition
-- Lint/ShadowedArgument
-- Lint/UnneededCopEnableDirective
-- Lint/UnneededRequireStatement
-- Lint/UriRegexp
-- Performance/UnneededSort
-- Performance/UriDefaultParser
-- Style/MinMax
-- Style/RedundantConditional
-- Style/TrailingBodyOnMethodDefinition
-- Style/UnpackFirst
-
-## 2.2.0 (2017-12-6)
-
-- Style/GuardClause disabled as it forces consistency that may sacrifice readability in a cookbook.
-
-## 2.1.0 (2017-08-24)
-
-- The Layout/EndOfLine cop now enforces a LF for line endings. This prevents users on Windows from seeing the "Carriage return character missing" error message.
-
-## 2.0.0 (2017-05-31)
-
-### Security Update
-
-Rubocop has been upgraded from 0.47.1 to 0.49.1 to resolve <http://www.cvedetails.com/cve/CVE-2017-8418/>. Unfortunately between these versions a large number of rules were moved from the style namespace to the layout namespace. If you previously enabled/disabled whitespace or layout related rules in your own .rubocop.yml there is a good chance you'll need to update your config.
-
-### Newly Enabled Cops:
-
-- Style/YodaCondition which alerts on backwards and confusing condition logic
-- Layout/EmptyLinesAroundExceptionHandlingKeywords which makes our empty line policy more consistent when using exception handling
-
-## 1.4.0 (2017-05-30)
-
-- Our configuration of Lint/AmbiguousRegexpLiteral now ignores files in the test dir even if you run Cookstyle against a chef-repo directory instead of individual cookbook directories.
-- We now explicitly set TargetRubyVersion to 2.0, as Ruby 2.0 shipped in older Chef 12 releases.
-
-### Newly Disabled Cops:
-
-- BlockLength which completes Cookstyle ignoring length in cookbooks.
-- Performance/Casecmp which resulted in confusing code.
-
-## 1.3.1 (2017-04-17)
-
-### Newly Disabled Cops:
-
-- Style/DoubleNegation which is needed in some situations to avoid Chef deprecation warnings
-
-## 1.3.0 (2017-02-13)
-
-- Upgraded the Rubocop engine from 0.46 -> 0.47.1, but disabled all new cops. This aligns cookstyle with the Rubocop in Chefstyle and also resolves multiple bugs in Rubocop 0.46\. If you previously disabled the Lint/Eval cop in your own Rubocop config you'll need to update that with the new cop name of Security/Eval.
-
-## 1.2.0 (2017-01-19)
-
-- Change Style/NumericPredicate to use comparisons. We found that cookstyle autocorrecting code from foo == 0 to foo.zero? was breaking a lot of cookbooks. Additionally .zero? is significantly slower than just using foo == 0.
-
-## 1.1.1 (2016-12-22)
-
-- Properly disabled the correct cop to avoid warning on InSpec matchers: Lint/AmbiguousRegexpLiteral
-
-## 1.1.0 (2016-12-13)
-
-### Newly Disabled Cops:
-
-- All Rails cops since they don't apply to us
-- Metrics/ClassLength
-
-## 1.0.1 (2016-12-12)
-
-### Newly Disabled Cops:
-
-- Style/TernaryParentheses
-
-### Newly Enabled Cops:
-
-- Lint/ShadowedException
-
-## 1.0.0 (2016-12-12)
-
-### Newly Disabled Cops:
-
-- Metrics/CyclomaticComplexity
-- Style/NumericLiterals
-- Style/RegexpLiteral in /tests/ directory
-- Style/AsciiComments
-
-### Newly Enabled Cops:
-
-- Bundler/DuplicatedGem
-- Style/SpaceInsideArrayPercentLiteral
-- Style/NumericPredicate
-- Style/EmptyCaseCondition
-- Style/EachForSimpleLoop
-- Style/PreferredHashMethods
-- Lint/UnifiedInteger
-- Lint/PercentSymbolArray
-- Lint/PercentStringArray
-- Lint/EmptyWhen
-- Lint/EmptyExpression
-- Lint/DuplicateCaseCondition
-- Style/TrailingCommaInLiteral

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in cookstyle.gemspec
-gemspec

data/README.md

@@ -1,109 +0,0 @@
-# Cookstyle - Sane rubocop defaults for Chef Cookbooks
-
-[![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)
-
-Cookstyle is a set of opinions about Ruby code that are specific to cookbooks. Running both cookstyle and RuboCop on the same codebase will result, by design, in changes being applied and then removed. Needless to say you should _not_ use both tools on the same cookbook.
-
-Cookstyle is infrequently updated, since the rule set is mature and fairly stable. We sync new RuboCop versions when there's advantage to doing so, but are conservative by default.
-
-Cookstyle is included in the ChefDK, and can be used from the command line by running `cookstyle`.
-
-The active ruleset is in the [config/cookstyle.yml](https://github.com/chef/cookstyle/blob/master/config/cookstyle.yml) file. Changes to the rule set must be accompanied by arguments and code demonstrating why the change should be made, and in most cases we would expect the author of the change to help with updating the core community cookbooks.
-
-## How It Works
-
-The project itself is a derivative of [finstyle](https://github.com/fnichol/finstyle), but starts with all rules disabled. Cookstyle 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.55.0 with all the rules disabled. It pins the default enabled set to 0.37.2 compatibility while running under the 0.55.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
-
-Cookstyle is included in the [ChefDK](https://downloads.chef.io/chefdk). If you choose not to use ChefDK, you can still install Cookstyle manually using the instructions below.
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'cookstyle'
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself as:
-
-```
-$ gem install cookstyle
-```
-
-## Usage
-
-### Vanilla RuboCop
-
-Run RuboCop as normal, simply add a `-r cookstyle` option when running:
-
-```sh
-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:
-
-```sh
-cookstyle -D --format offenses
-```
-
-### Rake
-
-In a Rakefile, the setup is exactly the same, except you need to require the cookstyle library first:
-
-```ruby
-require "cookstyle"
-require "rubocop/rake_task"
-RuboCop::RakeTask.new do |task|
-  task.options << "--display-cop-names"
-end
-```
-
-### guard-rubocop
-
-You can use one of two methods. The simplest is to add the `-r cookstyle` option to the `:cli` option in your Guardfile:
-
-```ruby
-guard :rubocop, cli: "-r cookstyle" do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-```
-
-Alternatively you could pass the path to Cookstyle's configuration by using the `Cookstyle.config` method:
-
-```ruby
-require "cookstyle"
-
-guard :rubocop, cli: "--config #{Cookstyle.config}" do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-```
-
-### .rubocop.yml
-
-As with vanilla RuboCop, any custom settings can still be placed in a `.rubocop.yml` file in the root of your project.

data/Rakefile

@@ -1,30 +0,0 @@
-require "bundler/gem_tasks"
-
-upstream = Gem::Specification.find_by_name("rubocop")
-
-desc "Vendor rubocop-#{upstream.version} configuration into gem"
-task :vendor do
-  src = Pathname.new(upstream.gem_dir).join("config")
-  dst = Pathname.new(__FILE__).dirname.join("config")
-
-  mkdir_p dst
-  cp(src.join("default.yml"), dst.join("upstream.yml"))
-  cp(src.join("enabled.yml"), dst.join("enabled.yml"))
-  cp(src.join("disabled.yml"), dst.join("disabled.yml"))
-
-  require 'rubocop'
-  require 'yaml'
-  cfg = RuboCop::Cop::Cop.all.inject({}) { |acc, cop| acc[cop.cop_name] = {"Enabled" => false}; acc }
-  File.open(dst.join("disable_all.yml"), "w"){|fh| fh.write cfg.to_yaml }
-
-  sh %{git add #{dst}/{upstream,enabled,disabled,disable_all}.yml}
-  sh %{git commit -m "Vendor rubocop-#{upstream.version} upstream configuration."}
-end
-
-require "cookstyle"
-require "rubocop/rake_task"
-RuboCop::RakeTask.new(:style) do |task|
-  task.options << "--display-cop-names"
-end
-
-task default: [:build, :install]

data/cookstyle.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cookstyle/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "cookstyle"
-  spec.version       = Cookstyle::VERSION
-  spec.authors       = ["Thom May"]
-  spec.email         = ["thom@chef.io"]
-
-  spec.summary       = %q{Rubocop configuration for Chef cookbooks}
-  spec.homepage      = "https://github.com/chef/cookstyle"
-  spec.license       = "Apache-2.0"
-  spec.required_ruby_version = ">= 2.1"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables    = %w[cookstyle]
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec"
-  spec.add_dependency("rubocop", Cookstyle::RUBOCOP_VERSION)
-end