lcgstyle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2078eb195eb828f2bcc4d02b8598f4f07882cc2f
+  data.tar.gz: d7a5013bf728e5b0370c29ab6ea2fa3528821321
+SHA512:
+  metadata.gz: 6eff1735c11a9cfa6838b89ac2b0e447765f5026e6012fec127cae8a8ea585cac21c30f416dd22fe8d3646cc4a6a4386c3cf092885b8f8287bd08f9d0caaa9fd
+  data.tar.gz: a3bde6800c7603cd0d2a00973635844f51105d8cb851e7235344e3532a2a97f3772946c606b7046e63ff431dbb897876b64b618682303917919f2a0e202e20bb

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,106 @@
+# Lcgstyle - Version Pinned rubocop and sane defaults for Ruby
+
+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.  It is not intended for any audience outside of chef
+core ruby development.
+
+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/lcgstyle.yml](https://github.com/chef/lcgstyle/blob/master/config/lcgstyle.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 'lcgstyle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lcgstyle
+
+## Usage
+
+### Vanilla RuboCop
+
+Run RuboCop as normal, simply add a `-r lcgstyle` option when running:
+
+```sh
+rubocop -r lcgstyle -D --format offenses
+```
+
+### lcgstyle Command
+
+Use this tool just as you would RuboCop, but invoke the `lcgstyle` binary
+instead which patches RuboCop to load rules from the lcgstyle gem. For example:
+
+```sh
+lcgstyle -D --format offenses
+```
+
+### Rake
+
+In a Rakefile, the setup is exactly the same, except you need to require the
+lcgstyle library first:
+
+```ruby
+require "lcgstyle"
+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 lcgstyle` option to the `:cli` option in your Guardfile:
+
+```ruby
+guard :rubocop, cli: "-r lcgstyle" do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+```
+
+Alternatively you could pass the path to Lcgstyle's configuration by using the `Lcgstyle.config` method:
+
+```ruby
+require "lcgstyle"
+
+guard :rubocop, cli: "--config #{Lcgstyle.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

@@ -0,0 +1,28 @@
+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.each_with_object({}) { |acc, cop| acc[cop.cop_name] = { "Enabled" => false } }
+  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 "lcgstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end

data/bin/lcgstyle

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