rubocop_rules 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b8336ab0273eaa5a7c4a0d088bc7ac9810a741e
-  data.tar.gz: 922465650ca90d1b9446ea248baeea1bdb05c1ae
+  metadata.gz: 4e0bd546785d9a1d9df847bf044ae292ec66c401
+  data.tar.gz: 2f00f916b40b00a277af380347d70dd3239e4906
 SHA512:
-  metadata.gz: 868353dd4492d90ee7d19ce9921b61ba227ee93d48b19eb8868525bde7a302ed414c436c36be35214f3d2b3dad3ca98bf9379cd2b946ebe116b2457ef2e8087b
-  data.tar.gz: 42f7691892bc591236b633b3de76b6d3c2e38f425541741c027e4a2964e3dd063c1cf1232eb450621025521b2e0e9f8c4ddfcc3f55ec0fe343c11503e3fa8562
+  metadata.gz: a2fa4ec3bfb6745389f50cc0c924629651552ddc0d269a8ba015efb7ad2bffc14c621e336c815dede00b092ef0b63babcaa0489e638f99eabde9efcc201db43e
+  data.tar.gz: afc0abcc63f6d213da68b9ecabd65aa588a146fc6c3ca41b8c03559a3f2450c3d081ff44721ba1c82ac8aa1a643b179dcbd44f01725ca71d1dcdd41dc753b847

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.rubocop.yml

@@ -12,8 +12,20 @@
 inherit_from:
   - .rubocop_common.yml
 
-##############
-# Project specific overrides here, example:
-# Metrics/BlockLength:
-#   Exclude:
-#    - 'tasks/the_huge_task.rake'
+AllCops:
+  Exclude:
+    - db/**/*
+
+Rails:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+   - '*.gemspec'
+   - 'spec/**/*.rb'

data/.rubocop_common.yml

@@ -1,19 +1,13 @@
 ##############
 # Global rules
-AllCops:
-  Exclude:
-    - db/**/*
-
-Rails:
-  Enabled: false
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/BlockLength:
-  Exclude:
-   - '*.gemspec'
-   - 'spec/**/*.rb'
+#
+# This file is meant to be shared across all projects belonging to a specific team.
+# Check this file in to a dedicated repo, and link to it .rubosync.yml config file.
+# Evolve it over time and use rubocop-rules update to apply it.
+#
+
+# Example:
+# ========
+# AllCops:
+#   Exclude:
+#     - db/**/*

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.1
-before_install: gem install bundler -v 1.15.4
+before_install: gem install bundler -v 1.16

data/CHANGELOG.md

@@ -1,16 +1,27 @@
 # 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).
+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.1.0] - 2017-11-28
+
+### Added
+
+* Sync .rubocop_common.yml from external git repo
+
 ## [1.0.2] - 2017-11-09
+
 ### Changed
-- spec/lint_spec.rb was not packaged
+
+* spec/lint_spec.rb was not packaged
 
 ## [1.0.1] - 2017-11-09
+
 ### Added
-- rubocop-rules init
-- rubocop-rules update
+
+* rubocop-rules init
+* rubocop-rules update

data/README.md

@@ -1,7 +1,18 @@
-# Rubocop::Rules
+[![Build Status](https://travis-ci.org/klippx/rubocop_rules.svg?branch=master)](https://travis-ci.org/klippx/rubocop_rules)
+
+# Rubocop Rules
 
 A common place to house rubocop rule enforcement across projects.
 
+When you or your team have a large number of repos, with different Rubocop Rules spread all over the
+place, it gets hard to maintain and sync all "shared" config together with project specific
+"tweaks", as well as todos that are more like todonts...
+
+This is where this tool can be quite handy. It enables you to put all SHARED stuff in one single
+place, and you and your team can develop this file gradually over time. This tool downloads the
+latest version and applies it to your project, leaving you with clean rubocop_todo files and still
+allowing you to have project specific overrides.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,17 +35,84 @@ After installing the gem, you need to initialize your project using the provided
 
 ### Initializing a project
 
-Initialize your project with the cli: `rubocop-rules init`
+Initialize your project with the cli: `rubocop-rules init`, sample output:
+
+```shell
+$ bundle exec rubocop-rules init
+Copying config...
+      create  .rubosync.yml
+      create  .rubocop.yml
+      create  spec/lint_spec.rb
+Downloading latest configuration from git://github.com/klippx/rubocop_rules.git...
+      create  .rubocop_common.yml
+Autocorrecting your code... 28 files inspected, 59 offenses detected
+Generating rubocop_todo... Run `rubocop --config .rubocop_todo.yml`, or add `inherit_from: .rubocop_todo.yml` in a .rubocop.yml file.
+Adding rubocop_todo to configuration...
+      insert  .rubocop.yml
+```
+
+This will create a few files:
 
-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.
+* `.rubosync.yml` is the configuration object for this micro-framework. Use this to configure your
+  git remote hosting the shared rubocop configuration. By default it will use this repo, which is
+  empty. The idea is to customize this.
+* `.rubocop.yml` will source the required rubocop yml files
+* `rubucop_common.yml` is downloaded from git remote specified in `.rubosync.yml`. Note that it
+  expects the `rubucop_common.yml` in the root of this git repo.
 
-Finally, a linter spec to make sure your code is following the common conventions.
+The script 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 `spec/lint_spec.rb` is added 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.
+Whenever a new version of the gem is deployed, you may update your project configuration using the
+command: `rubocop-rules update`. This command will download a fresh copy of `rubucop_common.yml`, it
+will run autofixes and regenerate a new `rubucop_todo.yml` for you!
+
+Sample output:
+
+```shell
+$ bundle exec rubocop-rules update
+Recreating configuration...
+      remove  .rubocop_common.yml
+Downloading latest configuration from ssh://git@stash.int.klarna.net:7999/klapp/rubocop_common.git...
+      create  .rubocop_common.yml
+Regenerating rubocop_todo...
+      remove  .rubocop_todo.yml
+        gsub  .rubocop.yml
+        gsub  .rubocop.yml
+```
+
+## Best practices
+
+### .rubosync.yml
+
+Only configured once per repo, point it to the correct remote.
+
+### .rubocop_common.yml
+
+Never update `.rubocop_common.yml` directly. Allow this tool take care of this for you.
+
+If you feel that you need to update the config in `.rubocop_common.yml`, update it on the shared git
+repo housing this file instead, and then reissue the `rubocop-rules update` command.
+
+### .rubocop_todo.yml
+
+Never update `.rubocop_todo.yml` directly. Allow this tool take care of this for you.
+
+If you feel that you need to update the config in `.rubocop_todo.yml`, fix the actual source code
+and then reissue the `rubocop-rules update` command.
+
+### .rubocop.yml
+
+Update `.rubocop.yml` for project specific overrides. Could be a project with a very large Rake task
+that is pending removal rather than refactoring.
+
+Keep this to a minimum and always consider if it belongs in .rubocop_common.yml or not.
 
 ## Development
 

data/lib/rubocop_rules/cli.rb

@@ -1,5 +1,7 @@
 require 'thor'
 require 'open3'
+require 'git'
+require 'yaml'
 
 module RubocopRules
   module CLI
@@ -22,15 +24,15 @@ module RubocopRules
       desc 'init', 'Initialize RubocopRules in your project'
       def init
         puts 'Copying config... '
-        copy_file '.rubocop_common.yml', '.rubocop_common.yml'
-        copy_file '.rubocop.yml', '.rubocop.yml'
+        copy_file 'templates/.rubosync.yml', '.rubosync.yml'
+        copy_file 'templates/.rubocop.yml', '.rubocop.yml'
         copy_file 'spec/lint_spec.rb', 'spec/lint_spec.rb'
 
-        print 'Autocorrecting your code... '
-        run_process(command: 'rubocop -a')
+        ensure_rubosync_config
+        rubosync_common
 
-        print 'Generating rubocop_todo... '
-        run_process(command: 'rubocop --auto-gen-config')
+        print 'Generating rubocop_todo...'
+        generate_todo
 
         puts 'Adding rubocop_todo to configuration... '
         insert_into_file '.rubocop.yml', '  - .rubocop_todo.yml', after: "  - .rubocop_common.yml\n"
@@ -39,19 +41,44 @@ module RubocopRules
       desc 'update', 'Regenerate RubocopRules configuration in your project'
       def update
         puts 'Recreating configuration...'
+        ensure_rubosync_config
         remove_file '.rubocop_common.yml'
-        copy_file '.rubocop_common.yml', '.rubocop_common.yml'
+        rubosync_common
 
-        puts 'Regenerating rubocop_todo... '
+        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)
+        generate_todo(silent: true)
         uncomment_lines '.rubocop.yml', /\.rubocop_todo\.yml/
       end
 
       private
 
+      def generate_todo(silent: false)
+        run_process(command: 'rubocop -a', silent: silent)
+        run_process(command: 'rubocop --auto-gen-config', silent: silent)
+      end
+
+      def ensure_rubosync_config
+        unless File.exist?('.rubosync.yml')
+          raise 'Missing configuration file! Please add and configure .rubosync.yml'
+        end
+        @config = YAML.safe_load(ERB.new(File.read('.rubosync.yml')).result, [], [], true)
+      end
+
+      def rubosync_common
+        unless @config && @config['git'] && @config['git']['repo']
+          raise 'Missing git repo in configuration! Please configure .rubosync.yml'
+        end
+        repo = @config['git']['repo']
+
+        puts "Downloading latest configuration from #{repo}..."
+        Git.clone(repo, 'common')
+        copy_file Dir.pwd + '/common/.rubocop_common.yml', '.rubocop_common.yml'
+      ensure
+        FileUtils.rm_rf('./common')
+      end
+
       def run_process(command:, silent: false)
         output = ''
         Open3.popen2(command) do |stdin, stdout_stderr, wait_thr|

data/lib/rubocop_rules/version.rb

@@ -1,3 +1,3 @@
 module RubocopRules
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/rubocop-rules.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/rubocop-rules}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.add_dependency 'git'
   spec.add_dependency 'rubocop', '~> 0.51.0'
   spec.add_dependency 'thor'
 

data/templates/.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/templates/.rubosync.yml

@@ -0,0 +1,2 @@
+git:
+  repo: git://github.com/klippx/rubocop_rules.git

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_rules
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Mathias Klippinge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -104,11 +118,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_common.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -123,6 +137,8 @@ files:
 - lib/rubocop_rules/version.rb
 - rubocop-rules.gemspec
 - spec/lint_spec.rb
+- templates/.rubocop.yml
+- templates/.rubosync.yml
 homepage: 
 licenses: []
 metadata:

data/.rubocop_todo.yml

@@ -1,7 +0,0 @@
-# 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.