armitage-rubocop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c79f9dd2133384170f52d8e63f6d5c790aa676af7316f2041d701c253538834a
+  data.tar.gz: 28b428ec1ccd0a6cfadf9ec77d373c37576d0119ba63d466223badb614db103b
+SHA512:
+  metadata.gz: bf13240014c78d087c4fb12bd73126594f438838133e31fbdc01360a34bdf4aad09f53519438a75ffa2c1bd28f41adf4ee6dc863b33335c56f4f50a69d441849
+  data.tar.gz: c41e32a20625100abaf14c9a4f6e7259eb79ce16e20bc2ebe0c4348d82faaab9051e46b4f0d593e9156cce5b5198ab2b094f1ed28a908e5decf8ce6876f797d6

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/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 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,35 @@
+# armitage-rubocop
+
+### 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
+```
+
+```yaml
+# --- rails ---
+inheit_gem:
+  # rails-specific cops + general + rspec
+  armitage-rubocop: lib/rubocop.rails.yml
+```

data/Rakefile

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'yaml'
+require 'rubocop'
+require 'open3'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = %w[--config ./lib/rubocop.general.yml]
+end
+
+namespace :armitage_rubocop do
+  task :build do
+    # rubocop:disable Layout/AlignHash
+    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')
+    }
+    # rubocop:enable Layout/AlignHash
+
+    # 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]
+        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|
+        # 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
+      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 = Set.new
+
+      # 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)
+
+        rubocop_config.keys.each_with_object([]) do |cop, acc|
+          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"
+        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}"
+      end
+    end
+  end
+end
+
+task default: :rubocop

data/armitage-rubocop.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+# 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.name        = 'armitage-rubocop'
+  spec.version     = '0.1.0'
+  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.57.2'
+  spec.add_dependency 'rubocop-rspec', '= 1.27.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

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/general/bundler.yml

@@ -0,0 +1,9 @@
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/InsecureProtocolSource:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: false
+  TreatCommentsAsGroupSeparators: true

data/lib/general/gemspec.yml

@@ -0,0 +1,9 @@
+Gemspec/DuplicatedAssignment:
+  Enabled: true
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+  TreatCommentsAsGroupSeparators: true
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/lib/general/layout.yml

@@ -0,0 +1,322 @@
+Layout/AccessModifierIndentation:
+  Enabled: true
+  EnforcedStyle: indent
+  IndentationWidth: ~
+
+Layout/AlignArray:
+  Enabled: true
+
+Layout/AlignHash:
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Layout/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_first_parameter
+  IndentationWidth: ~
+
+Layout/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: either
+
+Layout/BlockEndNewline:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: case
+  IndentationWidth: ~
+  IndentOneStep: false
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ConditionPosition:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+  AutoCorrect: false
+  Severity: warning
+
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: leading
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyComment:
+  Enabled: true
+  AllowBorderComment: false
+  AllowMarginComment: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+  NumberOfEmptyLines: 1
+  AllowAdjacentOneLineDefs: false
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: true
+
+Layout/EmptyLinesAroundBeginBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+  EnforcedStyle: no_empty_lines
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: true
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+  EnforcedStyle: no_empty_lines
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: keyword
+  AutoCorrect: false
+  Severity: warning
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: native
+
+Layout/ExtraSpacing:
+  Enabled: true
+  AllowForAlignment: true
+  ForceEqualSignAlignment: false
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: false
+
+Layout/FirstHashElementLineBreak:
+  Enabled: false
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+  IndentationWidth: ~
+
+Layout/IndentArray:
+  Enabled: true
+  EnforcedStyle: consistent
+  IndentationWidth: ~
+
+Layout/IndentAssignment:
+  Enabled: true
+  IndentationWidth: ~
+
+Layout/IndentHash:
+  Enabled: true
+  EnforcedStyle: consistent
+  IndentationWidth: ~
+
+Layout/IndentHeredoc:
+  Enabled: true
+  EnforcedStyle: auto_detection
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 2
+  IgnoredPatterns: []
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/LeadingBlankLines:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/MultilineBlockLayout:
+  Enabled: true
+
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+  EnforcedStyle: aligned
+  IndentationWidth: ~
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: aligned
+  IndentationWidth: ~
+
+Layout/RescueEnsureAlignment:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterMethodName:
+  Enabled: true
+
+Layout/SpaceAfterNot:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+  EnforcedStyleInsidePipes: no_space
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+  EnforcedStyle: space
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+  AllowForAlignment: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+  AllowForAlignment: true
+
+Layout/SpaceBeforeSemicolon:
+  Enabled: true
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: true
+  EnforcedStyle: require_space
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBrackets: no_space
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+Layout/SpaceInsideParens:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: true
+
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBrackets: no_space
+
+Layout/SpaceInsideStringInterpolation:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Layout/Tab:
+  Enabled: true
+  IndentationWidth: ~
+
+Layout/TrailingBlankLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: false