rubocop_rules 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6118dc53f3cc87ec1fd8ea6da3cd4ccc487c857
+  data.tar.gz: 5b9a2bf8bf2510f0536d6fa12564ac1ff72626e2
+SHA512:
+  metadata.gz: fdbc3c77c46f56ade2c25d836908e05977b5efece039e5f12c7d51573ddff9aebe6247a3d5dd7f686bac431a731254b1f194fc7aa1eacacfa08211d4c84d148b
+  data.tar.gz: 94844afd9174e62868916a6909f650d1f1fd425b5dba2b19a5652fef4f1ae49e17144d5dc311eaf17f2e17476eef01d5a7dde5cea5c6f50385ba88a7dea798ef

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 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+###########################
+# Configuration for rubocop
+# in .rubocop.yml
+
+##############
+# Global rules
+# see .rubocop_common.yml
+
+##############
+# Inherit default rules first, and then override those rules with
+# our violation whitelist.
+inherit_from:
+  - .rubocop_common.yml
+
+##############
+# Project specific overrides here, example:
+# Metrics/BlockLength:
+#   Exclude:
+#    - 'tasks/the_huge_task.rake'

data/.rubocop_common.yml

@@ -0,0 +1,19 @@
+##############
+# Global rules
+AllCops:
+  Exclude:
+    - db/**/*
+
+Rails:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+   - '*.gemspec'
+   - 'spec/**/*.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-11-09 14:30:10 +0100 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2017-11-09
+### Added
+- rubocop-rules init
+- rubocop-rules update

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-rules.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+The MIT License
+
+Copyright (c) 2017 Mathias Klippinge (mathias.klippinge@gmail.com)
+
+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,41 @@
+# Rubocop::Rules
+
+A common place to house rubocop rule enforcement across projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop_rules', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop_rules
+
+## Usage
+
+After installing the gem, you need to initialize your project using the provided CLI.
+
+### Initializing a project
+
+Initialize your project with the cli: `rubocop-rules init`
+
+This will create `.rubocop.yml` and `rubucop_common.yml`, it will then run `rubucop -a` to automatically fix what can be fixed for you.
+In addition to this it will create `rubucop_todo.yml` to put what cannot be fixed in quarantine for you to fix later.
+
+Finally, a linter spec to make sure your code is following the common conventions.
+
+### Updating a project
+
+Whenever a new version of the gem is deployed, you may update your project configuration using the command: `rubocop-rules update`. This command
+will get a fresh copy of `rubucop_common.yml`, it will run autofixes and regenerate a new `rubucop_todo.yml` for you.
+
+## Development
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klarna/rubocop_rules.

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 'rubocop/rules'
+
+# 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/rubocop-rules

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubocop_rules'
+require 'rubocop_rules/cli'
+
+STDOUT.sync = true
+RubocopRules::CLI::Commands.start(ARGV)

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/lib/rubocop_rules.rb

@@ -0,0 +1,5 @@
+require 'rubocop_rules/version'
+
+# :nodoc:
+module RubocopRules
+end

data/lib/rubocop_rules/cli.rb

@@ -0,0 +1,65 @@
+require 'thor'
+require 'open3'
+
+module RubocopRules
+  module CLI
+    # CLI for initializing a project with RubocopRules, and keeping it up to date
+    class Commands < Thor
+      include Thor::Actions
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+      end
+
+      map '-v' => :version
+      map '--version' => :version
+
+      desc 'version', 'Outputs the version number'
+      def version
+        puts RubocopRules::VERSION
+      end
+
+      desc 'init', 'Initialize RubocopRules in your project'
+      def init
+        copy_file '.rubocop_common.yml', '.rubocop_common.yml'
+        copy_file '.rubocop.yml', '.rubocop.yml'
+        copy_file 'spec/lint_spec.rb', 'spec/lint_spec.rb'
+
+        print 'Autocorrecting your code... '
+        run_process(command: 'rubocop -a')
+
+        print 'Generating rubocop_todo... '
+        run_process(command: 'rubocop --auto-gen-config')
+
+        print 'Adding rubocop_todo to configuration... '
+        insert_into_file '.rubocop.yml', '  - .rubocop_todo.yml', after: "  - .rubocop_common.yml\n"
+      end
+
+      desc 'update', 'Regenerate RubocopRules configuration in your project'
+      def update
+        puts 'Recreating configuration...'
+        remove_file '.rubocop_common.yml'
+        copy_file '.rubocop_common.yml', '.rubocop_common.yml'
+
+        puts 'Regenerating rubocop_todo... '
+        remove_file '.rubocop_todo.yml'
+        comment_lines '.rubocop.yml', /\.rubocop_todo\.yml/
+        run_process(command: 'rubocop -a', silent: true)
+        run_process(command: 'rubocop --auto-gen-config', silent: true)
+        uncomment_lines '.rubocop.yml', /\.rubocop_todo\.yml/
+      end
+
+      private
+
+      def run_process(command:, silent: false)
+        output = ''
+        Open3.popen2(command) do |stdin, stdout_stderr, wait_thr|
+          stdin.close
+          output = stdout_stderr.read
+          wait_thr.value
+        end
+        puts output.split("\n").last unless silent
+      end
+    end
+  end
+end

data/lib/rubocop_rules/version.rb

@@ -0,0 +1,3 @@
+module RubocopRules
+  VERSION = '1.0.1'.freeze
+end

data/rubocop-rules.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop_rules/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop_rules'
+  spec.version       = RubocopRules::VERSION
+  spec.authors       = ['Mathias Klippinge']
+  spec.email         = ['mathias.klippinge@gmail.com']
+
+  spec.summary       = 'Common place to host rubocop enforcement across projects'
+  spec.description   = <<-DESC
+    Rubocop config lives all over the place and can easily get out of sync.
+    This project tries to solve this problem by centralizing shared config and provide CLI for keeping it up to date.
+  DESC
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/rubocop-rules}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'rubocop', '~> 0.51.0'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_rules
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Mathias Klippinge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: |2
+      Rubocop config lives all over the place and can easily get out of sync.
+      This project tries to solve this problem by centralizing shared config and provide CLI for keeping it up to date.
+email:
+- mathias.klippinge@gmail.com
+executables:
+- rubocop-rules
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_common.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop-rules
+- bin/setup
+- lib/rubocop_rules.rb
+- lib/rubocop_rules/cli.rb
+- lib/rubocop_rules/version.rb
+- rubocop-rules.gemspec
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.13
+signing_key: 
+specification_version: 4
+summary: Common place to host rubocop enforcement across projects
+test_files: []