rubocop-petal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19be17cd451b07bcec9a8d40b5b2f5b6ba1b8b6b1c41b72a6de2d09e2418a5aa
+  data.tar.gz: fae5baf51f4cc13bcb846cf7821c8747aeaf35ed171bed13c167e3697845f0a2
+SHA512:
+  metadata.gz: e263be802e2969189d10679f9287ecc6d7653644040574e5ad3ffa3221be90cc5aee59c75689ae4ef6a8287b2d95040b4430413995cd0c4b5d4a8ecdcde4ecd3
+  data.tar.gz: 5f19e9ead08ad127feb9e9efb16bcd0eda62e3f5a79e859d77f5eec2e227ae98cb3bcfea43e5ad5db6d046fda3d7b4ade723f4d68a1f8222243f55c8f9c2aba6

data/.github/workflows/build.yml

@@ -0,0 +1,16 @@
+name: Build
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+    - name: Default task, RSpec and Rubocop
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-petal.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+RSpec/ExampleLength:
+  Max: 10

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-petal.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.0'
+gem 'rubocop-rspec', require: false
+
+gem 'activesupport', '~> 5.2.0'

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    rubocop-petal (0.1.0)
+      rubocop
+      rubocop-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.0)
+  rubocop-petal!
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jean-Francis Bastien
+
+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,54 @@
+# RuboCop::Petal
+
+[![Build](https://github.com/petalmd/rubocop-petal/actions/workflows/build.yml/badge.svg)](https://github.com/petalmd/rubocop-petal/actions/workflows/build.yml)
+
+Petal custom cops. List of cops can be find [here](https://github.com/petalmd/rubocop-petal/tree/main/lib/rubocop/cop).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-petal', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-petal
+
+## Usage
+
+In your `.rubocop.yml` file, add `rubocop-petal`
+
+```yaml
+require:
+  - rubocop-rails
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Create new cop
+
+```shell
+bundle exec rake 'new_cop[Rails/MyNewCop]'
+```
+
+## Release
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/petalmd/rubocop-petal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+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/petal_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop/petal'
+
+# 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/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,21 @@
+Rails/EnumPrefix:
+  Description: 'Set prefix options when using enums.'
+  Enabled: true
+  StyleGuide: https://github.com/rails/rails/issues/13389#issue-24527737
+  Include:
+    - app/models/**/*
+
+Rails/RiskyActiverecordInvocation:
+  Description: 'Interpolation, use hash or parameterized syntax.'
+  Enabled: true
+
+Rails/TableName:
+  Description: 'Prevent usage of table_name= to in favor of convention.'
+  Enabled: true
+  StyleGuide: "https://rails.rubystyle.guide/#keep-ar-defaults"
+  Include:
+    - app/models/**/*
+
+Chewy/ResetOnType:
+  Description: 'Prevent using reset! methods on Chewy type class'
+  Enabled: true

data/lib/rubocop/cop/chewy/reset_on_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Chewy
+      # This cop prevent usage of table_name= to in favor of convention.
+      #
+      #   # bad
+      #   UsersIndex::User.reset!
+      #
+      #   # good
+      #   UsersIndex.reset!
+      class ResetOnType < Base
+        MSG = 'Using reset or reset! on the type instead of the index will put Elasticsearch in an unhealthy state'
+
+        def_node_matcher :reset_on_type?, <<~PATTERN
+          (const (const ... #index?) _)
+        PATTERN
+
+        def on_send(node)
+          receiver, method_name, *_args = *node
+          return unless %i[reset reset!].include? method_name
+
+          return unless reset_on_type?(receiver)
+
+          add_offense(node)
+        end
+
+        private
+
+        def index?(sym)
+          sym.to_s.end_with?('Index')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/petal_cops.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'rubocop-rails'
+
+# Auto-require all cops under `rubocop/cop/**/*.rb`
+cops_glob = File.join(__dir__, '**', '*.rb')
+Dir[cops_glob].sort.each { |cop| require(cop) }

data/lib/rubocop/cop/rails/enum_prefix.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces the use of `_prefix` with any enum.
+      # Using a prefix helps prevent overriding of existing methods
+      # Example: enum some_enum: { open: 0, each: 1 }
+      #
+      # Will cause an error because of overlap with existing methods such as `open` and `each`
+      # For more information, see https://github.com/rails/rails/issues/13389#issue-24527737
+      #
+      #   # bad
+      #   enum my_enum: {some_value: 0, another: 1}
+      #
+      #   # good
+      #   enum my_enum: {some_value: 0, another: 1}, _prefix: true
+      #
+      #   # good
+      #   enum my_enum: {some_value: 0, another: 1}, _prefix: :my_prefix
+      #
+      #   # good
+      #   enum my_enum: {some_value: 0, another: 1}, _suffix: true
+      #
+      #   # good
+      #   enum my_enum: {some_value: 0, another: 1}, _suffix: 'another_suffix'
+      class EnumPrefix < Base
+        MSG = 'Prefer using a `_prefix` or `_suffix` with `enum`.'
+
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash ...))
+        PATTERN
+
+        def_node_matcher :use_prefix_or_suffix?, <<~PATTERN
+          (send nil? :enum (hash <(pair (sym {:_prefix :_suffix}) {true str sym}) ...>))
+        PATTERN
+
+        def on_send(node)
+          return unless enum? node
+
+          add_offense(node) unless use_prefix_or_suffix? node
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/risky_activerecord_invocation.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Disallow ActiveRecord calls that pass interpolated or added strings as an argument.
+      # https://github.com/airbnb/ruby/blob/12435e8136d2adf710de999bc0f6bef01215df2c/rubocop-airbnb/lib/rubocop/cop/airbnb/risky_activerecord_invocation.rb
+      class RiskyActiverecordInvocation < Cop
+        VULNERABLE_AR_METHODS = %i[
+          delete_all
+          destroy_all
+          exists?
+          execute
+          find_by_sql
+          group
+          having
+          insert
+          order
+          pluck
+          reorder
+          select
+          select_rows
+          select_values
+          select_all
+          update_all
+          where
+        ].freeze
+
+        MSG = 'Passing a string computed by interpolation or addition to an ActiveRecord ' \
+              'method is likely to lead to SQL injection. Use hash or parameterized syntax. For ' \
+              'more information, see ' \
+              'http://guides.rubyonrails.org/security.html#sql-injection-countermeasures and ' \
+              'https://rails-sqli.org/rails3. If you have confirmed with Security that this is a ' \
+              'safe usage of this style, disable this alert with ' \
+              '`# rubocop:disable Rails/RiskyActiverecordInvocation`.'
+
+        PATTERN_SPEC_FILE = /^.*_spec\.rb$/.freeze
+
+        def on_send(node)
+          receiver, method_name, *args = *node
+          return if processed_source.buffer.name.match? PATTERN_SPEC_FILE
+          return if receiver.nil?
+          return unless vulnerable_ar_method?(method_name)
+          return if !includes_interpolation?(args) && !includes_sum?(args)
+
+          add_offense(node)
+        end
+
+        private
+
+        def vulnerable_ar_method?(method)
+          VULNERABLE_AR_METHODS.include?(method)
+        end
+
+        # Return true if the first arg is a :dstr that has non-:str components
+        def includes_interpolation?(args)
+          !args.first.nil? &&
+            args.first.type == :dstr &&
+            args.first.each_child_node.any? { |child| child.type != :str }
+        end
+
+        def includes_sum?(args)
+          !args.first.nil? &&
+            args.first.type == :send &&
+            args.first.method_name == :+
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/table_name.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the absence of explicit table name definitions.
+      #
+      #   # bad
+      #   self.table_name = 'some_table_name'
+      #   self.table_name = :some_other_name
+      class TableName < Base
+        include ActiveRecordHelper
+
+        MSG = %(
+Avoid using `self.table_name=` if at all possible. When ActiveRecord's defaults are used, it may be omitted.
+If you are working on a new model, you should name the table and model to fit the defaults
+If you absolutely must use it, disable the cop with `# rubocop:disable Rails/TableName`
+        )
+
+        def on_send(node)
+          add_offense(node) if find_set_table_name(node).to_a.any?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Petal
+    # 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/petal/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Petal
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/petal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'petal/version'
+
+module RuboCop
+  module Petal # rubocop:disable Style/Documentation
+    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-petal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/petal'
+require_relative 'rubocop/petal/version'
+require_relative 'rubocop/petal/inject'
+
+RuboCop::Petal::Inject.defaults!
+
+require_relative 'rubocop/cop/petal_cops'

data/rubocop-petal.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/petal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-petal'
+  spec.version       = RuboCop::Petal::VERSION
+  spec.authors       = ['Jean-Francis Bastien']
+  spec.email         = ['jfbastien@petalmd.com']
+
+  spec.summary       = 'Petal custom cops'
+  spec.homepage      = 'https://github.com/petalmd/rubocop-petal'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/petalmd/rubocop-petal'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_runtime_dependency 'rubocop'
+  spec.add_dependency 'rubocop-rails'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-petal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean-Francis Bastien
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-rails
+  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'
+description:
+email:
+- jfbastien@petalmd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-petal.rb
+- lib/rubocop/cop/chewy/reset_on_type.rb
+- lib/rubocop/cop/petal_cops.rb
+- lib/rubocop/cop/rails/enum_prefix.rb
+- lib/rubocop/cop/rails/risky_activerecord_invocation.rb
+- lib/rubocop/cop/rails/table_name.rb
+- lib/rubocop/petal.rb
+- lib/rubocop/petal/inject.rb
+- lib/rubocop/petal/version.rb
+- rubocop-petal.gemspec
+homepage: https://github.com/petalmd/rubocop-petal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petalmd/rubocop-petal
+  source_code_uri: https://github.com/petalmd/rubocop-petal
+  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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Petal custom cops
+test_files: []