armitage-rubocop 0.83.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '079a5cd3b52832506fb37b97fe3f548e8d5e993502c30936d06e9c9c9d50cb8b'
+  data.tar.gz: 27377dcf4675b9b611ef0834c284843d946e5d260595b381fe79c0a98fad193d
+SHA512:
+  metadata.gz: 966d1e9845d6065260ab3e6f425a8b38b12f57104b10ce71bd661eb3857bd51e57b815850903f9f27a68b2f873130b341b126cbb9beda4622f78b42bcc672fce
+  data.tar.gz: 13ac3c3269bd87875f11f7cf97b0fb356ddaa6c30a79e87506f056abcbb8719a303345112c12e64567b3ebe393a13a0dddd338725ca31ece093faa898d2a07d7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+/Gemfile.lock
+.ruby-version
+gemfiles/*.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - ./lib/rubocop.general.yml
+  - ./lib/rubocop.rake.yml
+
+AllCops:
+  TargetRubyVersion: 2.7.1

data/.yamllint

@@ -0,0 +1,50 @@
+extends: default
+
+yaml-files:
+- '*.yml'
+- '*.yaml'
+
+rules:
+  braces:
+    min-spaces-inside: 1
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+  colons:
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments: disable
+  comments-indentation: {}
+  document-start: disable
+  document-end: disable
+  empty-lines:
+    max: 1
+  empty-values: disable
+  hyphens:
+    max-spaces-after: 1
+  indentation:
+    spaces: 2
+    indent-sequences: whatever
+    check-multi-line-strings: true
+  key-duplicates: {}
+  key-ordering: disable
+  line-length:
+    max: 150
+    allow-non-breakable-words: false
+  new-line-at-end-of-file: enable
+  new-lines:
+    type: unix
+  octal-values:
+    forbid-explicit-octal: true
+  quoted-strings: disable
+  trailing-spaces: {}
+  truthy: {}

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 iamdaiver@icloud.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/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source('https://rubygems.org')
+
+# Specify your gem's dependencies in armitage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2020 Rustam Ibragimov
+
+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,86 @@
+# armitage-rubocop · [![Gem Version](https://badge.fury.io/rb/armitage-rubocop.svg)](https://badge.fury.io/rb/armitage-rubocop)
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Build](#build)
+
+---
+
+Configured rules:
+
+- **Common** (`.rubocop.general.yml`) (`.rubocop.rails.yml`) (`.rubocop.rake.yml`)
+  - Bundler
+  - Rake
+  - Gemspec
+  - Layout
+  - Lint
+  - Metrics
+  - Migration
+  - Naming
+  - Performance
+  - Rails (isn't included in `.rubocop.general.yml`)
+  - Security
+  - Style
+  - Rake (isn't included in `.rubocop.general.yml`)
+- **RSpec** (`.rubocop.rspec.yml`) (`.rubocop.rails.yml`)
+  - Capybara
+  - FactoryBot
+  - Rails
+  - RSpec
+
+---
+
+### Installation
+```ruby
+gem 'armitage-rubocop'
+```
+
+```shell
+$ bundle install
+# --- or ---
+$ gem install 'armitage-rubocop'
+```
+
+```ruby
+require 'armitage-rubocop'
+```
+
+---
+
+### Usage
+
+- edit your `.rubocop.yml` file:
+
+```yaml
+# --- vanilla ---
+inherit_gem:
+  armitage-rubocop:
+    - lib/rubocop.general.yml
+    - lib/rubocop.rspec.yml
+    - lib/rubocop.rake.yml
+```
+
+```yaml
+# --- rails ---
+inherit_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

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'open3'
+require 'yaml'
+require 'rubocop'
+require 'rubocop-rails'
+require 'rubocop-performance'
+require 'rubocop-rspec'
+require 'rubocop-rake'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
+  t.options = ['--config', config_path]
+  t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
+  t.requires << 'rubocop-rails'
+  t.requires << 'rubocop-rake'
+end
+
+NON_CHECKABLE_COPS = %w[Rails].freeze # NOTE: Global "Rails" cop has only `Enabled` option
+
+# rubocop:disable Rails/RakeEnvironment
+namespace :armitage_rubocop do
+  desc 'Full armitage-rubocop build (code style, cops validation, yaml validation)'
+  task :build do
+    build_processes = {
+      code_style_check:
+        Open3.popen3('bundle exec rake rubocop'),
+      cops_validation:
+        Open3.popen3('bundle exec rake armitage_rubocop:validation:recognizable_cops'),
+      yaml_validation:
+        Open3.popen3('bundle exec rake armitage_rubocop:validation:valid_yamls')
+    }
+
+    # 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, wtr]
+        build_result = build_process[3].value.exitstatus
+        result_data[build_type] = build_result
+      end
+    end
+
+    result_message = results.each_pair.map do |(result_type, result_status)|
+      type = "- \e[1;33m#{result_type}\e[0m\t=> "
+      desc = result_status.zero? ? "\e[32msuccess\e[0m" : "\e[31mfail\e[0m"
+
+      "#{type} #{desc}"
+    end.join("\n")
+
+    if results.values.all?(&:zero?)
+      puts "[\e[32mARMITAGE_RUBOCOP BUILD\e[0m] => \e[1;33mSuccessful!\e[0m\n#{result_message}"
+    else
+      abort "[\e[31mARMITAGE_RUBOCOP BUILD\e[0m] => FAILED!\n#{result_message}"
+    end
+  end
+
+  namespace :validation do
+    desc 'Checks that all *.yml files has the valid structure'
+    task :valid_yamls do
+      yamls = Dir[Pathname.new(__FILE__).join('../lib/**/*.yml')]
+
+      # NOTE: try to load without Psych exceptions
+      invalid_yamls = yamls.each_with_object([]) do |file_name, invalid_files|
+        YAML.safe_load(File.read(file_name)) rescue (invalid_files << "- \e[33m#{file_name}\e[0m")
+      end
+
+      if invalid_yamls.empty?
+        puts "[\e[32mYAML FILE VALIDATION\e[0m] => \e[1;33mall files has valid strucutre!\e[0m"
+      else
+        invalid_yamls_message = invalid_yamls.join("\n")
+        abort "[\e[31mYAML FILE VALIDATION\e[0m] => some files has invalid structure:\n" \
+              "#{invalid_yamls_message}"
+      end
+    end
+
+    desc 'Checks that all defined cops can be used'
+    task :recognizable_cops do
+      yamls = Dir[Pathname.new(__FILE__).join('../lib/**/*.yml')]
+      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
+      #  - see https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/config_loader.rb
+      #  - RuboCop::Config#validate
+      #  - RuboCop::Config#warn_about_unrecognized_cops
+      #  - RuboCop::ConfigLoader.load_file
+      #  - RuboCop::ConfigLoader.default_configuration
+      yamls.each do |yaml_file|
+        rubocop_config = RuboCop::ConfigLoader.load_file(yaml_file)
+
+        # NOTE: validate cop existence
+        rubocop_config.each_key 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[cop] = "\e[31mBAD COP\e[0m"
+        end
+
+        # NOTE: validate cop params
+        rubocop_config.each_key do |cop|
+          next if invalid_cops.key?(cop)
+
+          invalid_params = Set.new
+
+          rubocop_config[cop].each_key do |cop_param|
+            next if RuboCop::ConfigValidator::COMMON_PARAMS.include?(cop_param)
+            next if NON_CHECKABLE_COPS.include?(cop)
+            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.to_a.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.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
+  end
+end
+# rubocop:enable Rails/RakeEnvironment
+
+task default: :rubocop

data/armitage-rubocop.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.version     = '0.83.0'
+
+  spec.name        = 'armitage-rubocop'
+  spec.license     = 'MIT'
+  spec.authors     = ['Rustam Ibragimov']
+  spec.email       = ['iamdaiver@icloud.com']
+  spec.homepage    = 'https://github.com/0exp/armitage'
+
+  spec.summary     = 'A set of rubocop settings'
+  spec.description = 'A set of rubocop settings used in my own projects.' \
+                     'Support for: vanilla ruby, rspec, rails.'
+
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_dependency 'rubocop',             '= 0.83.0'
+  spec.add_dependency 'rubocop-performance', '= 1.5.2'
+  spec.add_dependency 'rubocop-rails',       '= 2.5.2'
+  spec.add_dependency 'rubocop-rspec',       '= 1.39.0'
+  spec.add_dependency 'rubocop-rake',        '= 0.5.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end