rubocop-guild 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 466b0005b6dc35330f583dfeeac8441ef2d12b0ca6c9679bf3eb726f1e41dfde
+  data.tar.gz: 64264aead05aad92a8e1da44299ede7a497fe3ebc49f98ac27819b7334ee4d8f
+SHA512:
+  metadata.gz: eaf62f0796f6e9d1c67211a8fc5b0ca95764231929e790bc8101035e6e71f71746b4c549c1d30c5097290a6a256bf9a9a103f176bc3179f07ed993e5550895d6
+  data.tar.gz: e98e4434045255a9aedc24746dbf684d922b6e33da676365f0b6b1b58d5bdd35aa66e254bf23b6d8e458d71080844b94cef59939ce506b7d71d7d49273dd839e

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop-guild.gemspec
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+# RuboCop Guild
+
+Guild Education shared RuboCop config
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-guild'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-guild
+
+## Usage
+
+### Rake Task
+
+This gem exposes a Rake task that will perform the installation for you:
+
+```bash
+rake guild:rubocop:install
+```
+
+### Manually
+
+Add this to the top of your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  rubocop-guild:
+    - config/guild.yml
+```
+
+If you want to override the settings, do that below these lines.
+
+## Development
+
+Clone the repo and make the associated changes to the [`config/guild.yml`](https://github.com/GuildEducationInc/rubocop-guild/tree/master/config/guild.yml) file.
+
+In addition, please follow these guildlines:
+
+1. Associated cop definitions should be grouped
+2. Cops should be in alphabetical order within their groups. This makes it easier to look up the cop in the RuboCop documentation
+
+## Publishing
+
+Make sure you've been granted publish access to the [rubygem](https://rubygems.org/gems/rubocop-guild)
+
+1. Increment the gem version in `version.rb`
+2. Run `bin/rake release`. This will create a new tag based on the version, push the tag to Github, and then push the gem to Rubygems

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+import "./lib/tasks/install.rake"

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/config/guild.yml

@@ -0,0 +1,63 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - lib/templates/**/*
+    - lib/scripts/**/*
+    - db/**/*
+    - tmp/**/*
+    - vendor/**/*
+    - bin/**/*
+    - log/**/*
+    - scripts/**/*
+    - Rakefile
+    - node_modules/**/*
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  CountComments: false
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+RSpec/ExampleLength:
+  Max: 8
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/MessageSpies:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/lib/rubocop/guild.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rubocop/guild/railtie' if defined?(Rails)

data/lib/rubocop/guild/railtie.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RubocopGuildRailtie < Rails::Railtie
+  rake_tasks do
+    load "tasks/install.rake"
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,22 @@
+namespace :guild do
+  namespace :rubocop do
+    desc 'Install the Guild RuboCop config to .rubocop.yml'
+    task :install do
+      require 'yaml'
+
+      if File.exist?('.rubocop.yml')
+        STDOUT.puts "Warning: this will blow away your existing .rubocop.yml!"
+        STDOUT.print "Do you wish to continue? (y/n) "
+        exit if STDIN.gets.strip.downcase != 'y'
+      end
+
+      File.open('.rubocop.yml', 'w') do |f|
+        f.write({
+          'inherit_gem' => {
+            'rubocop-guild' => ['config/guild.yml']
+          }
+        }.to_yaml.gsub("---\n", ''))
+      end
+    end
+  end
+end

data/rubocop-guild.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-guild"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Stafford Brunk"]
+  spec.email         = ["stafford@guildeducation.com"]
+
+  spec.summary       = %q{Guild's shared RuboCop config}
+  spec.description   = %q{Guild's RuboCop config based around our preferred style}
+  spec.homepage      = "https://github.com/GuildEducationInc/rubocop-guild"
+
+  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 "rubocop-rspec", "~> 1.15"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-guild
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stafford Brunk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-12 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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Guild's RuboCop config based around our preferred style
+email:
+- stafford@guildeducation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/rake
+- config/guild.yml
+- lib/rubocop/guild.rb
+- lib/rubocop/guild/railtie.rb
+- lib/tasks/install.rake
+- rubocop-guild.gemspec
+homepage: https://github.com/GuildEducationInc/rubocop-guild
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Guild's shared RuboCop config
+test_files: []