armitage-rubocop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c79f9dd2133384170f52d8e63f6d5c790aa676af7316f2041d701c253538834a
-  data.tar.gz: 28b428ec1ccd0a6cfadf9ec77d373c37576d0119ba63d466223badb614db103b
+  metadata.gz: bf9988be221ab5c4cfdf372e5086ecdde56e6bf917948d630641d297244cbee0
+  data.tar.gz: b24b32fc84e143eb9452083a917649ad7ff58581e9e3c6264f2803d993d8547a
 SHA512:
-  metadata.gz: bf13240014c78d087c4fb12bd73126594f438838133e31fbdc01360a34bdf4aad09f53519438a75ffa2c1bd28f41adf4ee6dc863b33335c56f4f50a69d441849
-  data.tar.gz: c41e32a20625100abaf14c9a4f6e7259eb79ce16e20bc2ebe0c4348d82faaab9051e46b4f0d593e9156cce5b5198ab2b094f1ed28a908e5decf8ce6876f797d6
+  metadata.gz: f75a43f8b08530f675a164f25e209af5e35f864238b5ca8f12f925c6a1502c6321206fb7be336afb819ed95fe864e48fba910132bd32b71653de6add6ec79178
+  data.tar.gz: a86dbe13e40123aa55bc2cfd41fd234118904392ccdfc10c66836d39f98adc67d0bd05fe3a73a85409f944edd1a6ffe60941208befd8a85fe7ac90215d5764c0

data/README.md

@@ -1,5 +1,11 @@
 # armitage-rubocop
 
+- [Installation](#installation)
+- [Usage](#usage)
+- [Build](#build)
+
+---
+
 ### Installation
 ```ruby
 gem 'armitage-rubocop'
@@ -15,6 +21,8 @@ $ gem install 'armitage-rubocop'
 require 'armitage-rubocop'
 ```
 
+---
+
 ### Usage
 
 - edit your `.rubocop.yml` file:
@@ -33,3 +41,21 @@ inheit_gem:
   # rails-specific cops + general + rspec
   armitage-rubocop: lib/rubocop.rails.yml
 ```
+
+---
+
+### Build
+
+```ruby
+# --- full build ---
+bundle exec rake armitage_rubocop:build
+
+# --- validate code style ---
+bundle exec rake rubocop
+
+# --- validate yaml files ---
+bundle exec rake armitage_rubocop:validation:valid_yamls
+
+# --- validate rubocop cops (existence and params) ---
+bundle exec rake armitage_rubocop:validation:recognizable_cops
+```

data/Rakefile

@@ -2,12 +2,14 @@
 
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
+require 'open3'
 require 'yaml'
 require 'rubocop'
-require 'open3'
+require 'rubocop-rspec'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = %w[--config ./lib/rubocop.general.yml]
+  t.requires << 'rubocop-rspec'
 end
 
 namespace :armitage_rubocop do
@@ -26,7 +28,7 @@ namespace :armitage_rubocop do
     # NOTE: results structure { type => exit_code }
     results = {}.tap do |result_data|
       build_processes.each_pair do |build_type, build_process|
-        # NOTE: build_process => [stdin, stdout, stderr, whtr]
+        # NOTE: build_process => [stdin, stdout, stderr, wtr]
         build_result = build_process[3].value.exitstatus
         result_data[build_type] = build_result
       end
@@ -53,13 +55,7 @@ namespace :armitage_rubocop do
 
       # NOTE: try to load without Psych exceptions
       invalid_yamls = yamls.each_with_object([]) do |file_name, invalid_files|
-        # rubocop:disable Style/RedundantBegin
-        begin
-          YAML.load(File.read(file_name))
-        rescue StandardError
-          invalid_files << "- \e[33m#{file_name}\e[0m"
-        end
-        # rubocop:enable Style/RedundantBegin
+        YAML.load(File.read(file_name)) rescue (invalid_files << "- \e[33m#{file_name}\e[0m")
       end
 
       if invalid_yamls.empty?
@@ -74,7 +70,7 @@ namespace :armitage_rubocop do
     desc 'Checks that all defined cops can be used'
     task :recognizable_cops do
       yamls = Dir[Pathname.new(__FILE__).join('../lib/**/*.yml')]
-      invalid_cops = Set.new
+      invalid_cops = Hash.new { |h, k| h[k] = +'' }
 
       # NOTE: strongly rubocop-related realization
       #  - see https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/config.rb
@@ -86,19 +82,38 @@ namespace :armitage_rubocop do
       yamls.each do |yaml_file|
         rubocop_config = RuboCop::ConfigLoader.load_file(yaml_file)
 
-        rubocop_config.keys.each_with_object([]) do |cop, acc|
+        # NOTE: validate cop existence
+        rubocop_config.keys.each do |cop|
           next if RuboCop::ConfigLoader.default_configuration.key?(cop)
           next if RuboCop::Cop::Cop.registry.contains_cop_matching?([cop])
           next if cop == 'inherit_mode'
-          invalid_cops << "- \e[33m#{cop}\e[0m"
+          invalid_cops[cop] << "\e[31mBAD COP\e[0m"
+        end
+
+        # NOTE: validate cop params
+        rubocop_config.keys.each do |cop|
+          next if invalid_cops.key?(cop)
+          invalid_params = []
+
+          rubocop_config[cop].each_key do |cop_param|
+            next if RuboCop::Config::COMMON_PARAMS.include?(cop_param)
+            next if RuboCop::ConfigLoader.default_configuration[cop].key?(cop_param)
+            invalid_params << "\e[35m#{cop_param}\e[0m"
+          end
+
+          next if invalid_params.empty?
+          invalid_cops[cop] = "\e[31mBAD PARAMS\e[0m: #{invalid_params.join(', ')}"
         end
       end
 
       if invalid_cops.empty?
         puts "[\e[32mCOP RECOGNITION CHECK\e[0m] => \e[1;33mall cops are recognizable!\e[0m"
       else
-        invalid_cops_message = invalid_cops.to_a.join("\n")
-        abort "[\e[31mCOP RECOGNITION CHECK\e[0m] => some cops can not be recognized:\n" \
+        invalid_cops_message = invalid_cops.each_pair.map do |cop, message|
+          "[\e[32m#{cop}\e[0m]\t- #{message}"
+        end.join("\n")
+
+        abort "[\e[31mCOP RECOGNITION CHECK\e[0m] => some cops can not be fully recognized:\n" \
               "#{invalid_cops_message}"
       end
     end

data/armitage-rubocop.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'armitage-rubocop'
-  spec.version     = '0.1.0'
+  spec.version     = '0.2.0'
   spec.license     = 'MIT'
   spec.authors     = ['Rustam Ibragimov']
   spec.email       = ['iamdaiver@icloud.com']

data/lib/general/layout.yml

@@ -73,8 +73,8 @@ Layout/ElseAlignment:
 
 Layout/EmptyComment:
   Enabled: true
-  AllowBorderComment: false
-  AllowMarginComment: false
+  AllowBorderComment: true
+  AllowMarginComment: true
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/lib/general/metrics.yml

@@ -9,6 +9,7 @@ Metrics/BlockLength:
   ExcludedMethods: []
   Exclude:
     - Rakefile
+    - spec/**/*
 
 Metrics/BlockNesting:
   Enabled: true

data/lib/general/naming.yml

@@ -44,7 +44,7 @@ Naming/UncommunicativeBlockParamName:
 
 Naming/UncommunicativeMethodParamName:
   Enabled: true
-  MinNameLength: 3
+  MinNameLength: 1
   AllowNamesEndingInNumbers: true
 
 Naming/VariableName:

data/lib/general/style.yml

@@ -416,6 +416,8 @@ Style/SingleLineBlockParams:
 Style/SingleLineMethods:
   Enabled: true
   AllowIfMethodIsEmpty: true
+  Exclude:
+    - spec/**/*
 
 Style/SpecialGlobalVars:
   Enabled: true

data/lib/rspec/rspec.yml

@@ -81,8 +81,7 @@ RSpec/Focus:
   Enabled: true
 
 RSpec/HookArgument:
-  Enabled: true
-  EnforcedStyle: implicit
+  Enabled: false
 
 RSpec/ImplicitExpect:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: armitage-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop