ramsey_cop 0.7.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab0d2626071447d40a493e7676824a0ba22f6faa
+  data.tar.gz: fe339310d317bd218af04cc9a35cafa2c147f231
+SHA512:
+  metadata.gz: bd7f6eaa494033e88301c8119432d0f18626708376a1820c0590eca69e42de3cd5fd5af342bf867b9b83df3a97f5bdb5a257be26d6b2bb6dec597bbf17b72cae
+  data.tar.gz: 99766eb0d5372b44e4ba6da3a8abc1ceb5b1f3117c1bae70647dd42cab6ecbee3ea19c159a74ebd154e020ab2f7882ee5899c9b5df3c8d16659650c458a11ce5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+.idea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: default.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODEOWNERS

@@ -0,0 +1,3 @@
+# https://help.github.com/articles/about-codeowners/
+
+*   @jwsloan @rickpeyton

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 peytorb@gmail.com. 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/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to RamseyCop
+
+## Getting Started
+* `git clone git@github.com:ramseyinhouse/ramsey-cop.git`
+* `cd ramsey-cop`
+* `bundle`
+
+## Recommended Workflow
+* Ensure that any local `.rubocop.yml` overrides are removed
+* Pull this gem down
+* Set your gemfile to point your local `ramsey_cop` and run `bundle`
+* Run `rubocop` in your app
+  * Use `rubocop -D` to display cop names in the offense message and help you
+    quickly find the [appropriate override](https://github.com/bbatsov/rubocop/blob/master/config/default.yml)
+* Review the offenses listed
+  * If your code does not adhere to dev standards
+    * Update the style in your code only as you make changes. There is no need to make style-only updates.
+  * Elsif your code does adhere to dev standards || you want to suggest changes
+    * Update the default.yml using a single commit per style change.
+    * Submit a PR
+
+## Submitting a PR
+* Only add/update one cop per commit.
+* Keep the cops defined in `default.yml` in alphabetical order.
+* Follow the precedent set by previous commit messages such as:
+  * Layout/AccessModifierIndentation: set EnforcedStyle: outdent
+  * Style/Alias: set EnforcedStyle: prefer_alias_method
+* If it is not a simple setting, feel free to do something like:
+  * Style/PercentLiteralDelimiters: set PreferredDelimiters
+* After creating a PR, the CODEOWNERS file will assign your PR to the
+  appropriate reviewer.

data/Dockerfile

@@ -0,0 +1,29 @@
+# Build Image
+# docker build -t ruby:ramsey_cop .
+
+# Run Tests
+# docker run ruby:ramsey_cop
+# Run bash
+# docker run -it ruby:ramsey_cop bash
+
+FROM ruby:2.4.0
+
+RUN apt-get update -qq && \
+    apt-get upgrade -y
+
+RUN gem update --system && \
+    gem update bundler
+
+RUN mkdir /app
+WORKDIR /app
+
+
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+ADD ramsey_cop.gemspec /app/ramsey_cop.gemspec
+ADD ./lib/ramsey_cop/version.rb /app/lib/ramsey_cop/version.rb
+RUN bundle install
+ENV PATH="./bin:${PATH}"s
+
+ADD . /app
+CMD ["bundle","exec","rake"]

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    ramsey_cop (0.7.3)
+      rubocop (~> 0.52.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.5.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  rake (~> 10.0)
+  ramsey_cop!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1 @@
+https://www.gnu.org/licenses/gpl-3.0.html

data/README.md

@@ -0,0 +1,51 @@
+# RamseyCop
+
+Inspired by https://blog.percy.io/share-rubocop-rules-across-all-of-your-repos-f3281fbd71f8
+
+Ramsey shared style configs.
+
+## Why
+
+https://www.sandimetz.com/blog/2017/6/1/why-we-argue-style
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test, :development do
+  gem "ramsey_cop"
+end
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+If you're in a Rails app, you can now run:
+```bash
+$ rails generate ramsey_cop
+```
+
+If you're not in a Rails app, you will need to create a `.rubocop.yml` with the following directives:
+
+```yaml
+inherit_gem:
+  ramsey_cop:
+    - default.yml
+```
+
+Now, run:
+
+```bash
+$ bundle exec rubocop
+```
+
+You do not need to include rubocop directly in your application's dependencies. RamseyCop will include a specific version of `rubocop` that is shared across all projects.
+
+## Documentation
+
+* [Introducing RamseyCop to an existing repository](/documentation/existing-repositories.md)
+* [RamseyCop linting in Vim with ALE](/documentation/vim-tips.md)

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 "ramsey_cop"
+
+# 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/default.yml

@@ -0,0 +1,71 @@
+Documentation:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/BlockNesting:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DateTime:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': ()
+    '%I': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true

data/documentation/codeclimate-setup.md

@@ -0,0 +1,13 @@
+# Integrating RamseyCop with CodeClimate
+
+See https://codeclimate.com/changelog/582495c32c33066f1b00191d/ for context.
+
+In your `.codeclimate.yml` file, you will need to add:
+```yml
+prepare:
+  fetch:
+  - url: "https://raw.githubusercontent.com/RamseyInHouse/ramsey-cop/master/default.yml"
+    path: ".rubocop.yml"
+```
+
+This will stomp your `.rubocop.yml` file, but only for the purpose of running RamseyCop against your PR in GitHub. This is necessary because CodeClimate will not install any gems.

data/documentation/existing-repositories.md

@@ -0,0 +1,29 @@
+# Introducing Ramsey Cop to an existing repository
+
+Here are a few tips for introducing RamseyCop to an existing project
+
+* Delete any existing `.rubocop.yml` config files
+* Run `rails generate ramsey_cop`
+  * Or manually create a new `.rubocop.yml` that contains only
+
+```yaml
+inherit_gem:
+  ramsey_cop:
+    - default.yml
+```
+
+## Getting a feel for the current state of your code.
+* Run `bundle exec rubocop -f o` to get a count of violations per cop.
+* Run `bundle exec rubocop -f w` to see your worst offending files.
+* Run `bundle exec rubocop -h` to see the other handy options.
+
+## Letting rubocop fix what it can
+Some of the cops are auto-correctable. This will make all of those changes. Generally it is not advised to make style-only changes, as your time is probably better spent adding some new feature. However, this only requires a review and may be worth the effort. If you're happy with the auto-correct changes, you could go ahead and commit that. If there are changes you are not happy with, then you can put in a PR for this gem to change the cops.
+
+* Run `bundle exec rubocop --auto-correct`
+
+## Your first PR after including RamseyCop
+Hopefully you have CodeClimate running against your repo and blocking PRs when it sees offenses. This is good, and it means your first PR will be blocked for all of your offenses. You may want to get a repo admin to merge your PR anyway. This will allow you to then only focus on offenses as code is changed/added.
+
+## Further notes
+* Be sure to either use `bundle exec rubocop` OR run `bundle binstubs rubocop` before executing `rubocop` to make sure you are getting the version of `rubocop` specified in `RamseyCop`

data/documentation/vim-tips.md

@@ -0,0 +1,10 @@
+# Vim Tips
+
+## RamseyCop, VIM and ALE
+
+[Thoughtbot](https://github.com/thoughtbot) replaced the linting library [Syntastic](https://github.com/vim-syntastic/syntastic) with [ALE](https://github.com/w0rp/ale) in their community dotfiles. ALE works great in Vim with `RamseyCop`
+
+* [Thoughtbot commit](https://github.com/thoughtbot/dotfiles/commit/8ac75ba56b6ad6eb8134283ca3fb406067ed02b4)
+* [ALE repo](https://github.com/w0rp/ale)
+
+![alt text](/documentation/images/vim-tips-01.png "ALE, RamseyCop and Vim Example")

data/lib/generators/ramsey_cop_generator.rb

@@ -0,0 +1,7 @@
+class RamseyCopGenerator < Rails::Generators::Base
+  source_root(File.expand_path(__dir__))
+
+  def create_rubcop_yml
+    template "rscop.yml", ".rubocop.yml"
+  end
+end

data/lib/generators/rscop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  ramsey_cop:
+    - default.yml

data/lib/ramsey_cop/version.rb

@@ -0,0 +1,3 @@
+module RamseyCop
+  VERSION = "0.7.3".freeze
+end

data/lib/ramsey_cop.rb

@@ -0,0 +1,5 @@
+require "ramsey_cop/version"
+
+module RamseyCop
+  # Your code goes here...
+end

data/ramsey_cop.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ramsey_cop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ramsey_cop"
+  spec.version       = RamseyCop::VERSION
+  spec.authors       = ["Rick Peyton", "John Sloan"]
+  spec.email         = ["rick.peyton@daveramsey.com", "john.sloan@daveramsey.com"]
+
+  spec.summary       = "Ramsey style guides and shared style configs."
+  spec.homepage      = "https://github.com/ramseyinhouse/ramsey-cop"
+  spec.license       = "GPLv3"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop", "~> 0.52.1"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ramsey_cop
+version: !ruby/object:Gem::Version
+  version: 0.7.3
+platform: ruby
+authors:
+- Rick Peyton
+- John Sloan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !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:
+- rick.peyton@daveramsey.com
+- john.sloan@daveramsey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- default.yml
+- documentation/codeclimate-setup.md
+- documentation/existing-repositories.md
+- documentation/images/vim-tips-01.png
+- documentation/vim-tips.md
+- lib/generators/ramsey_cop_generator.rb
+- lib/generators/rscop.yml
+- lib/ramsey_cop.rb
+- lib/ramsey_cop/version.rb
+- ramsey_cop.gemspec
+homepage: https://github.com/ramseyinhouse/ramsey-cop
+licenses:
+- GPLv3
+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.8
+signing_key: 
+specification_version: 4
+summary: Ramsey style guides and shared style configs.
+test_files: []