rubocop-ipepe 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88e1adbe08b2ef30c8afacb029a5240dcb26fb73cb7462951a5e48b42a2c011e
+  data.tar.gz: f09e9d131d92b567b163af95a17399ea251d0c04cb73de37bacf763b5762c305
+SHA512:
+  metadata.gz: b43f6237752ad1a9f250c9645c1fbdcbb547c2b5c2f76ed12246d8c3bdc83a8df660f6980ba0b59caa69dd87be9b61c5d56e3fc47f8c85b721eb618231c57863
+  data.tar.gz: f4ea5b113609baa4371c244272c00daa21d912436fb4d474c51ef1a1977370a9935222b62e534c1d306153ff01bd571e4459761e6e2143ce617cb3df67103568

data/.github/workflows/rspec.yml

@@ -0,0 +1,41 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5','2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v3
+      - run: rm -rf Gemfile.lock
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Check coverage
+        run: ruby bin/coveragecheck

data/.github/workflows/rubocop.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# pulled from repo
+name: "Rubocop"
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: 2.7
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Rubocop run
+        run: |
+          bash -c "
+            bundle exec rubocop -P --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+            [[ $? -ne 2 ]]
+          "
+
+      - name: Upload Sarif output
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: rubocop.sarif

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  DisabledByDefault: false
+  SuggestExtensions: false
+  NewCops: enable
+  TargetRubyVersion: 2.4
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-ipepe.rb
+
+Style/MixinUsage:
+  Exclude:
+    - 'bin/*'
+Style/FetchEnvVar:
+  Enabled: false
+Style/RedundantConstantBase:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+Style/ZeroLengthPredicate:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+Metrics/BlockLength:
+  Exclude:
+    - "*.rake"
+    - "spec/**/*.rb"
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/ParameterLists:
+  Max: 6
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NegatedIf:
+  EnforcedStyle: postfix
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+Metrics/MethodLength:
+  Max: 20
+Style/DoubleNegation:
+  Enabled: false
+Style/WordArray:
+  EnforcedStyle: brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/CommentedKeyword:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-ipepe.gemspec
+gemspec
+
+gem "code-scanning-rubocop"
+gem "rake", "~> 12.0"
+gem "rspec"
+gem "rubocop"
+gem "simplecov"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    rubocop-ipepe (0.2.0)
+      rubocop (~> 1.41)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    code-scanning-rubocop (0.6.1)
+      rubocop (~> 1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  code-scanning-rubocop
+  rake (~> 12.0)
+  rspec
+  rubocop
+  rubocop-ipepe!
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2023 Patryk Ptasinski
+
+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,115 @@
+# RuboCop Ipepe
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-ipepe.svg)](https://rubygems.org/gems/rubocop-ipepe)
+![CI](https://github.com/ipepe-oss/rubocop-ipepe/workflows/CI/badge.svg)
+
+[RuboCop](https://github.com/rubocop/rubocop).
+
+## Installation
+
+Just install the `rubocop-ipepe` gem
+
+```bash
+gem install rubocop-ipepe
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-ipepe', require: false
+```
+
+## Usage
+
+You need to tell RuboCop to load the Ipepe extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-ipepe
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-ipepe
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Ipepe
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-ipepe
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-ipepe'
+end
+```
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/ipepe`](lib/rubocop/cop/ipepe), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Ipepe cops just like any other
+cop. For example:
+
+```yaml
+Ipepe/SpecificMatcher:
+  Exclude:
+    - spec/my_spec.rb
+```
+
+### Ipepe/MultipleConditionUnless
+
+Checks for multiple conditions in `unless` statement.
+
+```ruby
+# bad
+unless foo && bar
+  do_something
+end
+
+# good
+if foo || bar
+  do_something
+end
+```
+
+### Ipepe/TernaryOperator
+
+Prohibits any use of ternary operator.
+
+```ruby
+# bad
+foo ? bar : baz
+
+# good
+if foo
+  bar
+else
+  baz
+end
+```
+
+## Development
+
+### Adding a new cop
+`bundle exec rake 'new_cop[Ipepe/TestOperator]'`
+
+## License
+
+`rubocop-ipepe` is MIT licensed. [See the accompanying file](LICENSE.md) for
+the full text.

data/Rakefile

@@ -0,0 +1,35 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/ipepe_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/ipepe"
+
+# 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/coveragecheck

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "json"
+
+File.read("coverage/.last_run.json").tap do |json|
+  data = JSON.parse(json)
+  coverage = [
+    data.dig("result", "covered_percent").to_f,
+    data.dig("result", "line").to_f
+  ].max
+  puts "Coverage: #{coverage}%"
+  if coverage < 100
+    puts "Coverage is below 100%! Exiting with error."
+    exit 1
+  end
+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/config/default.yml

@@ -0,0 +1,34 @@
+Ipepe:
+  Enabled: true
+  DocumentationBaseURL: "https://github.com/ipepe-oss/rubocop-ipepe"
+
+Ipepe/TernaryOperator:
+  Enabled: true
+  Description: "Prefer explicit if over ternary operator"
+  VersionAdded: '0.1.0'
+
+Ipepe/MultipleConditionUnless:
+  Description: "`unless` with multiple conditions is not allowed"
+  Enabled: true
+  VersionAdded: '0.1.0'
+# TODO: implement
+#  EnforcedStyle: 'allow_single_condition'
+#  SupportedStyles:
+#    - 'allow_single_condition'
+#    - 'never_unless'
+
+Ipepe/AlphabeticalArrayOfStrings:
+  Description: 'Ensure that strings in array are in alphabetical order'
+  Enabled: true
+  VersionAdded: '0.2.0'
+
+Ipepe/AlphabeticalHashKeys:
+  Description: 'Ensure that hash keys are in alphabetical order'
+  Enabled: true
+  VersionAdded: '0.2.0'
+# TODO: implement
+#  EnforcedStyle: 'symbols_only'
+#  SupportedStyles:
+#    - 'symbols_only'
+#    - 'strings_only'
+#    - 'symbols_and_strings'

data/config/rails.default.yml

@@ -0,0 +1,83 @@
+require:
+  - rubocop-performance
+AllCops:
+  DisabledByDefault: false
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'db/schema.rb'
+Style/MixinUsage:
+  Exclude:
+    - 'bin/*'
+Style/FetchEnvVar:
+  Enabled: false
+Style/RedundantConstantBase:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+Style/ZeroLengthPredicate:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'db/seeds.rb'
+Metrics/BlockLength:
+  Exclude:
+    - db/seeds.rb
+    - app/admin/**/*.rb
+    - spec/**/*_spec.rb
+    - config/routes.rb
+    - config/deploy.rb
+    - app/admin/**/*.rb
+    - lib/tasks/**/*.rake
+Metrics/AbcSize:
+  Exclude:
+    - db/migrate/*.rb
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/ParameterLists:
+  Max: 6
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NegatedIf:
+  EnforcedStyle: postfix
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'db/**/*.rb'
+Style/DoubleNegation:
+  Enabled: false
+Style/WordArray:
+  EnforcedStyle: brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/CommentedKeyword:
+  Enabled: false
+Naming/PredicateName:
+  Exclude:
+    - 'app/serializers/**/*.rb'

data/config/ruby.default.yml

@@ -0,0 +1,64 @@
+AllCops:
+  DisabledByDefault: false
+  SuggestExtensions: false
+  NewCops: enable
+Style/MixinUsage:
+  Exclude:
+    - 'bin/*'
+Style/FetchEnvVar:
+  Enabled: false
+Style/RedundantConstantBase:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+Style/ZeroLengthPredicate:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+Metrics/BlockLength:
+  Exclude:
+    - "*.rake"
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/ParameterLists:
+  Max: 6
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NegatedIf:
+  EnforcedStyle: postfix
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+Metrics/MethodLength:
+  Max: 20
+Style/DoubleNegation:
+  Enabled: false
+Style/WordArray:
+  EnforcedStyle: brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/CommentedKeyword:
+  Enabled: false

data/lib/rubocop/cop/ipepe/alphabetical_array_of_strings.rb

@@ -0,0 +1,29 @@
+module RuboCop
+  module Cop
+    module Ipepe
+      class AlphabeticalArrayOfStrings < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        MSG = "Ensure that strings in array are in alphabetical order".freeze
+
+        def on_array(node)
+          str_type_hash = {}
+          node.children.each do |n|
+            str_type_hash[n.str_type?] ||= 0
+            str_type_hash[n.str_type?] += 1
+          end
+
+          return if str_type_hash.size != 1 || str_type_hash[true].nil?
+
+          strings = node.children.map(&:value)
+          sorted_strings = strings.sort
+
+          return if strings == sorted_strings
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, "[#{sorted_strings.map { |s| "\"#{s}\"" }.join(', ')}]")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ipepe/alphabetical_hash_keys.rb

@@ -0,0 +1,50 @@
+module RuboCop
+  module Cop
+    module Ipepe
+      class AlphabeticalHashKeys < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        MSG = "Ensure that keys in hash are in alphabetical order".freeze
+
+        def on_hash(node)
+          keys = node.children.select(&:pair_type?).map(&:key)
+          sorted_keys = keys.sort_by(&:value)
+          return if cop_not_applicable?(keys, sorted_keys)
+
+          add_offense(node) do |corrector|
+            join_keys_with = " "
+            join_keys_with = "\n " if node.source.include?("\n")
+
+            corrector.replace(
+              node,
+              [
+                "{",
+                sorted_keypairs(node, sorted_keys).join(",#{join_keys_with}"),
+                "}"
+              ].join(join_keys_with)
+            )
+          end
+        end
+
+        private
+
+        def cop_not_applicable?(keys, sorted_keys)
+          keys.empty? ||
+            keys.one? ||
+            (keys.none?(&:str_type?) && keys.none?(&:sym_type?)) ||
+            keys == sorted_keys
+        end
+
+        def sorted_keypairs(node, sorted_keys)
+          sorted_keys.map do |k|
+            keypair = node.children.find { |n| n.key == k }
+            if keypair.key.str_type?
+              "#{keypair.key.source} => #{keypair.value.source}"
+            elsif keypair.key.sym_type?
+              "#{keypair.key.source}: #{keypair.value.source}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ipepe/multiple_condition_unless.rb

@@ -0,0 +1,20 @@
+module RuboCop
+  module Cop
+    module Ipepe
+      class MultipleConditionUnless < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        MSG = "Use only one condition in unless or change to if".freeze
+
+        def on_if(node)
+          return unless node.unless?
+          return unless node.condition.and_type?
+
+          add_offense(node) do |corrector|
+            # change `unless` to `if !(condition)`
+            corrector.replace(node, "if !(#{node.condition.source})\n#{node.if_branch.source}\nend")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ipepe/ternary_operator.rb

@@ -0,0 +1,28 @@
+module RuboCop
+  module Cop
+    module Ipepe
+      class TernaryOperator < ::RuboCop::Cop::Base
+        extend AutoCorrector
+
+        MSG = "Use `if` instead of ternary operator.".freeze
+
+        def on_if(node)
+          return unless node.ternary?
+
+          add_offense(node) do |corrector|
+            corrector.replace(
+              node,
+              [
+                "if #{node.condition.source}",
+                node.if_branch.source,
+                "else",
+                node.else_branch.source,
+                "end"
+              ].join("\n")
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ipepe_cops.rb

@@ -0,0 +1,4 @@
+require_relative "ipepe/alphabetical_array_of_strings"
+require_relative "ipepe/alphabetical_hash_keys"
+require_relative "ipepe/multiple_condition_unless"
+require_relative "ipepe/ternary_operator"

data/lib/rubocop/ipepe/inject.rb

@@ -0,0 +1,18 @@
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Ipepe
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/ipepe/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Ipepe
+    VERSION = "0.2.0".freeze
+  end
+end

data/lib/rubocop/ipepe.rb

@@ -0,0 +1,13 @@
+require "rubocop/ipepe/version"
+
+module RuboCop
+  module Ipepe
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-ipepe.rb

@@ -0,0 +1,9 @@
+require "rubocop"
+
+require_relative "rubocop/ipepe"
+require_relative "rubocop/ipepe/version"
+require_relative "rubocop/ipepe/inject"
+
+RuboCop::Ipepe::Inject.defaults!
+
+require_relative "rubocop/cop/ipepe_cops"

data/rubocop-ipepe.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/rubocop/ipepe/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-ipepe"
+  spec.version       = RuboCop::Ipepe::VERSION
+  spec.authors       = ["Patryk Ptasinski"]
+  spec.email         = ["patryk@ipepe.pl"]
+
+  spec.summary       = "Opinionated RuboCop configuration used by ipepe."
+  spec.description   = "This gem is a collection of RuboCop cops used by ipepe."
+  spec.homepage      = "https://github.com/ipepe-oss/rubocop-ipepe"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}#changelog"
+  spec.licenses = ["MIT"]
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop", "~> 1.41"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-ipepe
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Patryk Ptasinski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+description: This gem is a collection of RuboCop cops used by ipepe.
+email:
+- patryk@ipepe.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/coveragecheck
+- bin/setup
+- config/default.yml
+- config/rails.default.yml
+- config/ruby.default.yml
+- lib/rubocop-ipepe.rb
+- lib/rubocop/cop/ipepe/alphabetical_array_of_strings.rb
+- lib/rubocop/cop/ipepe/alphabetical_hash_keys.rb
+- lib/rubocop/cop/ipepe/multiple_condition_unless.rb
+- lib/rubocop/cop/ipepe/ternary_operator.rb
+- lib/rubocop/cop/ipepe_cops.rb
+- lib/rubocop/ipepe.rb
+- lib/rubocop/ipepe/inject.rb
+- lib/rubocop/ipepe/version.rb
+- rubocop-ipepe.gemspec
+homepage: https://github.com/ipepe-oss/rubocop-ipepe
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ipepe-oss/rubocop-ipepe
+  source_code_uri: https://github.com/ipepe-oss/rubocop-ipepe
+  changelog_uri: https://github.com/ipepe-oss/rubocop-ipepe#changelog
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Opinionated RuboCop configuration used by ipepe.
+test_files: []