gnar-style 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e13cb25e1fc2909b27e6ab09a9febe2f3f107ce
+  data.tar.gz: 7c73588f837d50b0a31fa6d9ea61774cb87a0cc0
+SHA512:
+  metadata.gz: 9c82eb9ac650259796c068e43b2b524cf7250643e94e504bd52a90fd341033b5976352af4dc98441680dc3dd154e6f91112f8fc889778768e656286ca700e5b8
+  data.tar.gz: c48fe0f66ebe642d27127dadb9c65dee037b0dc7baaa745313f50f81ba4853335c498f3c8cb81e70981170d8514dc77e5e86cb4250d6812659b45ca58a3a3d61

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--order rand
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: rubocop/rubocop_gem.yml

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## Current release (in development)
+
+## 0.2.0
+
+* Move rubocop template files into `rubocop/` directory rather than the ambiguous `gnar_style/` directory. [#4](https://github.com/TheGnarCo/gnar-style/pull/4)
+  *Kevin Murphy*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kevin Murphy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# gnar-style
+
+Gnar shared style configurations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test
+  gem 'gnar-style'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gnar-style
+
+## Usage
+
+This gem includes rubocop, and it's not necessary to separately include rubocop directly in your application's dependencies.
+
+### Inheriting from the gem
+
+Create a `.rubocop.yml` with the following configuration:
+
+```yaml
+inherit_gem:
+  gnar-style:
+    # Choose from one of these three
+    - "rubocop/rubocop.yml" # if the pure ruby style is all that's needed
+    - "rubocop/rubocop_gem.yml" # if the application is a gem, already inherits from the default ruby style
+    - "rubocop/rubocop_rails.yml" # if the application is a rails project, already inherits from the default ruby style
+```
+
+To check your application against these style configurations:
+
+```bash
+$ bundle exec rubocop
+```
+
+You [must](https://github.com/bbatsov/rubocop/blob/master/manual/configuration.md#inheriting-configuration-from-a-dependency-gem) use `bundle exec` when using the `inherit_gem` directive.
+
+### Inheriting from local copies of gem files
+
+Use this approach should you not be able to, or not want to, use the `inherit_gem` directive. This may be because the requirement to use `bundle exec rubocop` to find the dependency's runtime installation path is not an option for you.
+
+There is a command to copy the templates locally:
+
+```bash
+$ bundle exec gnar-style copy_local
+```
+
+The `copy_local` command accepts a `--format` option to specify what kind of project you have, and therefore, what files you need.
+
+Acceptable options for the format are:
+* `ruby` (the default)
+* `gem`
+* `rails`
+
+You can use this option as follows:
+```bash
+$ bundle exec gnar-style copy_local --format=gem
+```
+
+Create a `.rubocop.yml` with the following configuration:
+
+```yaml
+inherit_from:
+  # Choose from one of these three
+  - "gnar_style/rubocop.yml"  # if the pure ruby style is all that's needed
+  - "gnar_style/rubocop_gem.yml" # if the application is a gem, already inherits from the default ruby style
+  - "gnar_style/rubocop_rails.yml" # if the application is a rails project, already inherits from the default ruby style
+```
+
+To check your application against these style configurations:
+
+```bash
+$ rubocop
+```
+
+Upon updating this gem for any future updates, you'll need to re-run the `copy_local` command to store the updates locally.
+
+## Overriding Styles
+
+Note that if you add in a local style exception in your own application after inheriting from gnar-style, that will completely override gnar-style's defaults. This is particularly important if you're not looking to modify the style at all, but instead are hoping to add to, for example, the list of files excluded.
+
+Consider the following:
+```yaml
+# In gnar-style/default.yml
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+```
+
+```yaml
+# In your app's .rubocop.yml
+inherit_gem:
+  gnar-style:
+    - "rubocop/rubocop.yml"
+
+Metrics/BlockLength:
+  Exclude:
+    - specific_file.rb
+```
+
+In this example, all files in the spec directory will no longer be excluded from the `Metrics/BlockLength` cop. The excluded array is overridden, and not inherited. This is discussed in [this rubocop issue](https://github.com/bbatsov/rubocop/issues/3208), though the suggestion to have a `super` keyword does not seem to have been implemented.
+
+If you want to add to the list, you'll instead need to add in the prior array elements into your application's `.rubocop.yml` by referencing the initial list from gnar-style.
+
+## Different Styles
+
+gnar-style provides defaults for three different scenarios. You can specify which configuration to use in your `rubocop.yml`. See the [Usage](#usage) section for details.
+
+* `rubocop.yml` - Base styling configurations.
+* `rubocop_rails.yml` - Styling for use in a rails project.
+* `rubocop_gem.yml` - Styling for use in a gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TheGnarCo/gnar-style. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gnar/style"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gnar-style

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "gnar/style"
+Gnar::Style::Cli::Application.start(ARGV)

data/gnar-style.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gnar/style/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gnar-style"
+  spec.version       = Gnar::Style::VERSION
+  spec.authors       = ["The Gnar Company"]
+  spec.email         = ["hi@thegnar.co"]
+
+  spec.summary       = "Style guide default configuration for The Gnar Company"
+  spec.homepage      = "https://github.com/TheGnarCo/gnar-style"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop", "~> 0.49"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gnar/style.rb

@@ -0,0 +1,7 @@
+require "gnar/style/cli/application"
+require "gnar/style/version"
+
+module Gnar
+  module Style
+  end
+end

data/lib/gnar/style/cli/application.rb

@@ -0,0 +1,28 @@
+require "thor"
+
+module Gnar
+  module Style
+    module Cli
+      class Application < Thor
+        include Thor::Actions
+
+        desc "copy_local", "Copy configuration files from the gem into your local directory"
+        option :format, type: :string, default: "ruby", enum: %w[gem rails ruby]
+        def copy_local
+          copy_file "rubocop.yml", "gnar_style/rubocop.yml"
+
+          case options[:format]
+          when "rails"
+            copy_file "rubocop_rails.yml", "gnar_style/rubocop_rails.yml"
+          when "gem"
+            copy_file "rubocop_gem.yml", "gnar_style/rubocop_gem.yml"
+          end
+        end
+
+        def self.source_root
+          "#{File.dirname(__FILE__)}/../../../../rubocop"
+        end
+      end
+    end
+  end
+end

data/lib/gnar/style/version.rb

@@ -0,0 +1,5 @@
+module Gnar
+  module Style
+    VERSION = "0.2.0".freeze
+  end
+end

data/rubocop/rubocop.yml

@@ -0,0 +1,34 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - 'Gemfile'
+
+Metrics/LineLength:
+  Max: 100
+  Severity: refactor
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'

data/rubocop/rubocop_gem.yml

@@ -0,0 +1,14 @@
+inherit_from: rubocop.yml
+
+Layout/ExtraSpacing:
+  Exclude:
+    - '*.gemspec'
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    - '*.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/rubocop/rubocop_rails.yml

@@ -0,0 +1,13 @@
+inherit_from: rubocop.yml
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - 'vendor/**/*'
+
+Rails:
+  Enabled: true
+
+Metrics/MethodLength:
+  Exclude:
+    - 'db/migrate/**/*'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: gnar-style
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- The Gnar Company
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- hi@thegnar.co
+executables:
+- gnar-style
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gnar-style
+- gnar-style.gemspec
+- lib/gnar/style.rb
+- lib/gnar/style/cli/application.rb
+- lib/gnar/style/version.rb
+- rubocop/rubocop.yml
+- rubocop/rubocop_gem.yml
+- rubocop/rubocop_rails.yml
+homepage: https://github.com/TheGnarCo/gnar-style
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Style guide default configuration for The Gnar Company
+test_files: []