rubocop-doctolib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08d2ed1d22b78320860a941291ab123cc4f4cf06aaf4cbabe9c6dbc12900d6f7'
+  data.tar.gz: 9a9be592b7cb991ff3c0500415adb85dd1137e8095e27749894eb8a5f6e8f368
+SHA512:
+  metadata.gz: d0b7d7de54233e87e2a83c6916645ca580d98e0111052cf29a6ca9b8c9359c5580826f14eed54e67f1bb9f87dacef87d98252da4f3db28a0bcd945a8f1d3851d
+  data.tar.gz: 4b56ad077d6d3304d512ae62b47f04040262f8ba0fa66b3722efdb1cf52834d10145a2b7981d552ccfd6fd9d949e7ca0344aaf6b6cc080ff212c93c4dd5fedab

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-doctolib.rb

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [0.1.0] - 2021-07-20
+
+- Initial release.
+- Add the Doctolib/NoAsymmetricalPunditAfterActions cop.
+- Add the Doctolib/OneOperationPerMigration cop.
+- Add the Doctolib/NoUnsafeBackgroundMigration cop.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-doctolib.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rubocop-doctolib (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    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.2)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec
+  rubocop (~> 1.7)
+  rubocop-doctolib!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Victor Schubert
+
+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,51 @@
+# Rubocop::Doctolib
+
+rubocop-doctolib is a RuboCop extension containing various cops used and
+produced at Doctolib. Many of them are useful only in the context of a Ruby on
+Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-doctolib', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-doctolib
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rake test` and `bundle exec rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To add a new cop, run `bundle exec rake 'new_cop[Doctolib/NewCopName]'` and
+implement the cop and its tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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/doctolib/rubocop-doctolib.
+
+## 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,44 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+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
+
+  github_user = `git config github.user`.chop
+  github_user = 'your_id' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/doctolib_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/doctolib"
+
+# 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,24 @@
+Doctolib/NoAsymmetricalPunditAfterActions:
+  Description: >
+    Flag pairs of `after_action :verify_authorized` and `after_action
+    :verify_policy_scoped` which potentially let some actions covered by
+    neither filter.
+  Enabled: true
+  VersionAdded: 0.1.0
+
+Doctolib/NoUnsafeBackgroundMigration:
+  Description: Flag migrations which alter the “shape” of the schema.
+  Enabled: true
+  VersionAdded: 0.1.0
+  Include:
+    - db/migrate-background/**/*.rb
+
+Doctolib/OneOperationPerMigration:
+  Description: >
+    Flag ActiveRecord database migrations which contain more than one
+    operation.
+  Enabled: true
+  VersionAdded: 0.1.0
+  Include:
+    - db/migrate/**/*.rb
+    - db/migrate-background/**/*.rb

data/lib/rubocop-doctolib.rb

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

data/lib/rubocop/cop/doctolib/no_asymmetrical_pundit_after_actions.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Doctolib
+      KEYS = %i[only except].freeze
+
+      Verify =
+        Struct.new(:node) do
+          def arguments
+            node.arguments[1...]
+          end
+
+          def covers_all?
+            arguments.empty?
+          end
+
+          def mode
+            only_or_except_kwarg&.key&.value
+          end
+
+          def actions
+            actions = only_or_except_kwarg&.value
+            return if actions.nil?
+            normalize actions
+          end
+
+          private
+
+          def only_or_except_kwarg
+            hash = arguments.last
+            return unless hash.type == :hash
+            hash.pairs.find { |argument| KEYS.include? argument.key.value }
+          end
+
+          def normalize(value)
+            case value.type
+            when :sym
+              Set[value.value]
+            when :array
+              return unless value.values.all? { |value| value.type == :sym }
+              Set.new value.values.map(&:value)
+            end
+          end
+        end
+
+      # Prevent uses of the `verify_authorized` and `verify_policy_scoped`
+      # after-action filters from Pundit, which potentially let some actions
+      # covered by neither after-action filter.
+      #
+      # @example
+      #
+      #   # bad
+      #   after_action :verify_policy_scoped, only: :show
+      #   after_action :verify_authorized, only: :index
+      #
+      #   # bad
+      #   after_action :verify_policy_scoped, only: :show
+      #   after_action :verify_authorized, except: :index
+      #
+      #   # good
+      #   after_action :verify_policy_scoped, only: :show
+      #   after_action :verify_authorized, except: :show
+      #
+      #   # good
+      #   after_action :verify_policy_scoped, only: :show
+      #   after_action :verify_authorized
+      #
+      class NoAsymmetricalPunditAfterActions < Base
+        def_node_matcher :verified_class?, <<~MATCHER
+          (class _ _
+            (begin <
+              $(send nil? :after_action (sym :verify_policy_scoped) ...)
+              $(send nil? :after_action (sym :verify_authorized) ...)
+              ...>))
+        MATCHER
+
+        MSG = <<~MESSAGE.chomp.gsub("\n", ' ')
+          Some actions may not be covered by either of `:verify_policy_scoped` or `:verify_authorized`.
+          Prefer setting these with complementary `except` and `only` parameters.
+        MESSAGE
+
+        def on_class(node)
+          verified_class?(node) do |policy_scoped, authorized|
+            policy_scoped = Verify.new policy_scoped
+            authorized = Verify.new authorized
+            return if policy_scoped.covers_all?
+            return if authorized.covers_all?
+            return if only_superset_of_except? policy_scoped, authorized
+            return if disjoint_excepts? policy_scoped, authorized
+            add_offense policy_scoped.node
+            add_offense authorized.node
+          end
+        end
+
+        private
+
+        def only_superset_of_except?(policy_scoped, authorized)
+          if policy_scoped.mode != authorized.mode
+            only, except = policy_scoped.mode == :only ? [policy_scoped, authorized] : [authorized, policy_scoped]
+            return true if only.actions >= except.actions
+          end
+        end
+
+        def disjoint_excepts?(policy_scoped, authorized)
+          policy_scoped.mode == :except && authorized.mode == :except &&
+            policy_scoped.actions.disjoint?(authorized.actions)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/doctolib/no_unsafe_background_migration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Doctolib
+      # Flag migrations which alter the “shape” of the schema.
+      #
+      # @example
+      #
+      #   # bad
+      #   add_column :foos, :bar, :text
+      #
+      #   # good
+      #   add_index :foos, :bar
+      #
+      class NoUnsafeBackgroundMigration < RuboCop::Cop::Cop
+        MSG = 'Only use background migrations for index creation, column deletion or table deletion.'
+
+        def_node_matcher(:unsafe_operation_method?, <<~PATTERN)
+          {
+            :create_join_table
+            :create_table
+            :add_column
+            :add_reference
+            :add_timestamps
+            :change_column
+            :change_column_default
+            :change_column_null
+            :change_table
+            :rename_column
+            :rename_table
+          }
+        PATTERN
+
+        def_node_matcher(:unsafe_operation?, <<~PATTERN)
+          (send nil? #unsafe_operation_method? ...)
+        PATTERN
+
+        def on_send(node)
+          add_offense(node) if unsafe_operation?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/doctolib/one_operation_per_migration.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Doctolib
+      # Flag ActiveRecord database migrations which contain more than one
+      # operation.
+      #
+      # @example
+      #
+      #   # bad
+      #   def change
+      #     add_column :foos, :bar, :text
+      #     add_column :foos, :qux, :text
+      #   end
+      #
+      #   # good
+      #   def change
+      #     add_column :foos, :bar, :text
+      #   end
+      #
+      class OneOperationPerMigration < RuboCop::Cop::Cop
+        MSG = 'Use only one operation per migration.'
+
+        # From: https://api.rubyonrails.org/classes/ActiveRecord/Migration.html
+        def_node_matcher(:migration_symbol?, <<~PATTERN)
+          {
+            :create_join_table
+            :create_table
+            :add_column
+            :add_foreign_key
+            :add_index
+            :add_reference
+            :add_timestamps
+            :change_column
+            :change_column_default
+            :change_column_null
+            :change_table
+            :rename_column
+            :rename_index
+            :rename_table
+            :drop_table
+            :drop_join_table
+            :remove_column
+            :remove_columns
+            :remove_foreign_key
+            :remove_index
+            :remove_reference
+            :remove_timestamps
+            :execute
+          }
+        PATTERN
+
+        # Descendent of migration class calls migration symbol
+        def_node_matcher(:migration_operation?, <<~PATTERN)
+          {
+            (send nil? #migration_symbol? ...)
+          }
+        PATTERN
+
+        def on_def(node)
+          migration_count = 0
+          each_child_recursive(node) do |child|
+            next unless migration_operation?(child)
+
+            migration_count += 1
+            add_offense(node) if migration_count > 1
+          end
+        end
+
+        private
+
+        def each_child_recursive(node)
+          children_stack = [node] # Initialize stack with root node.
+          until children_stack.empty?
+            # Iterate until all leaves have been found.
+            child = children_stack.pop # Select one child from the stack.
+
+            # Add all the next children to the stack if this node-type can have children.
+            children_stack.push(*child.children) if child.respond_to?(:children)
+
+            yield(child)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/doctolib_cops.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require_relative 'doctolib/no_asymmetrical_pundit_after_actions'
+require_relative 'doctolib/no_unsafe_background_migration'
+require_relative 'doctolib/one_operation_per_migration'

data/lib/rubocop/doctolib.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yaml'
+require_relative "doctolib/version"
+
+module RuboCop
+  module Doctolib
+    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/doctolib/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 Doctolib
+    # 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/doctolib/version.rb

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

data/rubocop-doctolib.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/doctolib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-doctolib"
+  spec.version       = RuboCop::Doctolib::VERSION
+  spec.authors       = ["Doctolib GmbH"]
+  spec.email         = ["foss@doctolib.com"]
+
+  spec.summary       = "Doctolib’s custom cops"
+  spec.description   = "A set of RuboCop cops produced and used at Doctolib."
+  spec.homepage      = "https://github.com/doctolib/rubocop-doctolib"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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'
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-doctolib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doctolib GmbH
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-20 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'
+description: A set of RuboCop cops produced and used at Doctolib.
+email:
+- foss@doctolib.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-doctolib.rb
+- lib/rubocop/cop/doctolib/no_asymmetrical_pundit_after_actions.rb
+- lib/rubocop/cop/doctolib/no_unsafe_background_migration.rb
+- lib/rubocop/cop/doctolib/one_operation_per_migration.rb
+- lib/rubocop/cop/doctolib_cops.rb
+- lib/rubocop/doctolib.rb
+- lib/rubocop/doctolib/inject.rb
+- lib/rubocop/doctolib/version.rb
+- rubocop-doctolib.gemspec
+homepage: https://github.com/doctolib/rubocop-doctolib
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/doctolib/rubocop-doctolib
+  source_code_uri: https://github.com/doctolib/rubocop-doctolib
+  changelog_uri: https://github.com/doctolib/rubocop-doctolib
+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.2.15
+signing_key:
+specification_version: 4
+summary: Doctolib’s custom cops
+test_files: []