chefstyle 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360289d97b80eca841ffa20be478fcaad392ac2934e0dea20e17763c02c6fd23
-  data.tar.gz: 0ad54108181dfdd289e4f83897743c438ad5a5f884abb0ca9757124c251451fd
+  metadata.gz: 0e26762f4088c8da0c654c85b10f475d664004764ec2fc726b82a2aec25f3fe9
+  data.tar.gz: e7813e1a9a62931ffbb87f4ef627649db808e58681f530e18fd9973fa2a9700a
 SHA512:
-  metadata.gz: f0ab9fa0cd190c03c0de27bcfd76f5f8887820c6212b406291491f6271c17b6b50034be1d0ef2fdbc47c95c55d198c5f5e40713fef8fdbb3cf9fa6d9c2d3805a
-  data.tar.gz: fbc840097a36d3f79af3fa57155c9c75f57a07bd5774a72b0d2ac973342d34c0c719c796b9040f4b31ca6206366689552eebe246901a46b35b6c21a46e8a8e9d
+  metadata.gz: b73fd1a8f6049b9189d9563ca7a37b43f9635749720fe6319bc0e69a350db1d2f8f2f82f8ccad25434522bc31499366ce392d3dba3b896e2d4fe3531ef399ecb
+  data.tar.gz: 49e26eb57f3f5e732aba4648d12745166883f64e471f0d2c1e4b1a016aae22c466f094565e7e84bb790dbe066753845362941946916bdfb8bb88a0bcaed3ca30

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chefstyle.gemspec
+gemspec
+
+group :debug do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+end
+
+group :docs do
+  gem "github-markup"
+  gem "redcarpet"
+  gem "yard"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/chefstyle.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chefstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chefstyle"
+  spec.version       = Chefstyle::VERSION
+  spec.authors       = ["Chef Software, Inc."]
+  spec.email         = ["oss@chef.io"]
+
+  spec.summary       = %q{Rubocop configuration for Chef's ruby projects}
+  spec.homepage      = "https://github.com/chef/chefstyle"
+  spec.license       = "Apache-2.0"
+  spec.required_ruby_version = ">= 2.2"
+
+  spec.files         = %w{LICENSE chefstyle.gemspec Gemfile} + Dir.glob("{bin,config,lib}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  spec.executables    = %w[chefstyle]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency("rubocop", Chefstyle::RUBOCOP_VERSION)
+end

data/lib/chefstyle/version.rb

@@ -1,4 +1,4 @@
 module Chefstyle
-  VERSION = "0.11.0".freeze
+  VERSION = "0.11.2".freeze
   RUBOCOP_VERSION = "0.55.0".freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chefstyle
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
-- Thom May
+- Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,15 +68,16 @@ dependencies:
         version: 0.55.0
 description: 
 email:
-- thom@chef.io
+- oss@chef.io
 executables:
 - chefstyle
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
-- README.md
+- Gemfile
+- LICENSE
 - bin/chefstyle
+- chefstyle.gemspec
 - config/chefstyle.yml
 - config/default.yml
 - config/disable_all.yml
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rubocop configuration for Chef's ruby projects

data/README.md

@@ -1,136 +0,0 @@
-# Chefstyle - Version Pinned rubocop and sane defaults for Ruby
-
-[![Gem Version](https://badge.fury.io/rb/chefstyle.svg)](https://badge.fury.io/rb/chefstyle) [![Build Status](https://travis-ci.org/chef/chefstyle.svg?branch=master)](https://travis-ci.org/chef/chefstyle)
-
-This is an internal style guide for chef ruby projects (chef-client,
-ohai, mixlib-shellout, mixlib-config, etc).
-
-It is not meant for consumption by cookbooks or for any general
-purpose uses.  **Chef Users and Customers Should Generally Not Use
-This Tool and Should Use Cookstyle**.  It is not intended for any audience
-outside of chef core ruby development.
-
-It will conflict with rubocop defaults, cookstyle, finstyle and other
-ruby style guides entirely by design.  The point is that the core
-chef authors vehemently disagree with them on points of style and this
-point is generally not up for debate.
-
-It will have many rules that are disabled simply because fixing a
-project as large as chef-client would be tedious and have little
-value.  It will have other rules that are disabled because chef
-exposes edge conditions that make them falsely alert.  Other rules
-will be selected based on the biases of the core chef developers
-which are often violently at odds with the rubocop core developers
-over ruby style.
-
-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/chefstyle.yml](https://github.com/chef/chefstyle/blob/master/config/chefstyle.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.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'chefstyle'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install chefstyle
-
-## Usage
-
-### Vanilla RuboCop
-
-Run RuboCop as normal, simply add a `-r chefstyle` option when running:
-
-```sh
-rubocop -r chefstyle -D --format offenses
-```
-
-### chefstyle Command
-
-Use this tool just as you would RuboCop, but invoke the `chefstyle` binary
-instead which patches RuboCop to load rules from the chefstyle gem. For example:
-
-```sh
-chefstyle -D --format offenses
-```
-
-### Rake
-
-In a Rakefile, the setup is exactly the same, except you need to require the
-chefstyle library first:
-
-```ruby
-require "chefstyle"
-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 chefstyle` option to the `:cli` option in your Guardfile:
-
-```ruby
-guard :rubocop, cli: "-r chefstyle" do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-```
-
-Alternatively you could pass the path to Chefstyle's configuration by using the `Chefstyle.config` method:
-
-```ruby
-require "chefstyle"
-
-guard :rubocop, cli: "--config #{Chefstyle.config}" do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-```
-
-### git pre-commit hoooks
-
-In any repo a pre-commit hook can be used in .git/hooks/pre-commit to catch offenses before checkin:
-
-```ruby
-#!/usr/bin/env ruby
-
-changed_files = `git diff --name-only --cached`.split.select { |f| File.extname(f) == ".rb" }
-
-unless changed_files.empty?
-  system "chefstyle #{changed_files.join(" ")}"
-  unless $?.success?
-    puts "\n\nthere was a chefstyle error, please fix before commiting:"
-    puts "(chefstyle -a may be able to autofix these issues for you)\n\n"
-  end
-end
-exit $?.to_s[-1].to_i
-```
-
-For whatever `$REASON` git does not allow easily distributing hooks in the repo itself so each individual user
-needs to set this up.
-
-### .rubocop.yml
-
-As with vanilla RuboCop, any custom settings can still be placed in a `.rubocop.yml` file in the root of your project.