rubocop-notarize 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e88427bedb060da993a5298de0e254c37464dc06f9872e9cc1a168028cb19aa
+  data.tar.gz: 4d6e4110abad01aefd90c6c65024f56c4cc86dd7e11cd1de1a6dda9dcf3adb6a
+SHA512:
+  metadata.gz: ec74d694353490b849ce5b71a93a8b0d1587c4cde410a7c8b4070ce65cc4276643799272a7a7557480ec3d53c8c22ecd4fb0270167e7a30c1affd28673a28353
+  data.tar.gz: df7ab0e1f2c20d5d136f2db6c657e60eaa52e20f705a3f2a6ffaa7d961e0a1e94213b47311125c6b7d10ee1297377d184789c57f9834b536535fc959786eb732

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/.idea/
+/_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,16 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-notarize.rb'
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+ruby '3.2.2'
+
+# Specify your gem's dependencies in rubocop-notarize.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    rubocop-notarize (0.1.7)
+      rubocop (>= 0.92)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.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 (13.0.6)
+    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.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.4)
+      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)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  rubocop-notarize!
+  rubocop-rake
+  rubocop-rspec
+
+RUBY VERSION
+   ruby 3.2.2p53
+
+BUNDLED WITH
+   2.4.20

data/README.md

@@ -0,0 +1,36 @@
+# Rubocop::Notarize
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/notarize`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-notarize', github: 'notarize/rubocop-notarize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-notarize
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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`. 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 tags, 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/[USERNAME]/rubocop-notarize.
+

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+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/notarize_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/notarize'
+
+# 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,29 @@
+Performance/DisableReload:
+  Description: 'Disallow users to call .reload on an ActiveRecord object'
+  Enabled: true
+  VersionAdded: '0.1.5'
+
+Performance/RequireFileOpenBlock:
+  Description: 'Enforce opening files with a block to ensure the file gets closed.'
+  Enabled: true
+  VersionAdded: '0.1.5'
+
+Security/DisableChdir:
+  Description: 'Disallow users to call chdir with a block'
+  Enabled: true
+  VersionAdded: '0.1.7'
+
+Sidekiq/RequireSidekiqTestingInlineBlock:
+  Description: 'Prevent Sidekiq Testing settings from leaking into other specs'
+  Enabled: true
+  VersionAdded: '0.1.6'
+
+Style/DisableProgrammaticEnumValue:
+  Description: 'Disallow users to create enums with an each_value statement'
+  Enabled: true
+  VersionAdded: '0.1.5'
+
+Style/GraphCamelize:
+  Description: 'Do not use the GraphQL camelize option as we always want the default value (true).'
+  Enabled: true
+  VersionAdded: '0.1.5'

data/lib/rubocop/cop/notarize_cops.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'performance/disable_reload'
+require_relative 'performance/require_file_open_block'
+require_relative 'style/disable_programmatic_enum_value'
+require_relative 'style/graph_camelize'
+require_relative 'sidekiq/require_sidekiq_testing_inline_block'
+require_relative 'security/disable_chdir'

data/lib/rubocop/cop/performance/disable_reload.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # Limit use of reloads
+      # If you want to update an association then append/pop off the association in memory
+      # If you want to
+      # @example EnforcedStyle: bar (default)
+      #   # Description of the `bar` style.
+      #
+      #   # bad
+      #   Book.create(shelf_id: shelf.id)
+      #   shelf.reload.books
+      #
+      #   # good
+      #   book = Book.create(shelf_id: shelf.id)
+      #   shelf.books << book
+      #
+      class DisableReload < Base
+        MSG = 'Update the model in memory instead of calling .reload'
+
+        def_node_matcher :reload_call?, <<~PATTERN
+          (send (...) :reload)
+        PATTERN
+
+        def on_send(node)
+          return unless reload_call?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/performance/require_file_open_block.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # Enforce passing a block to File.open to ensure the file is closed after use.
+      #
+      # @example RequireFileOpenBlock: true (default)
+      #
+      #   # bad
+      #   file = File.open(file_path)
+      #   body = file.read
+      #   file.close
+      #
+      #   # good
+      #   body = File.open(file_path) { |file| file.read }
+      #
+      class RequireFileOpenBlock < Base
+        MSG = 'Use File.open with a block to ensure the file is closed after use.'
+
+        def_node_matcher :open_call?, <<~PATTERN
+          (send (...) :open ...)
+        PATTERN
+
+        def on_send(node)
+          add_offense(node) if open_call?(node) && !node.parent.is_a?(RuboCop::AST::BlockNode)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/security/disable_chdir.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Security
+      # Block usage of Dir.chdir due to its thread unsafe nature
+      #
+      # @example BlockChdir: true (default)
+      #
+      #   # bad
+      #   Dir.chdir(...) do
+      #     ...
+      #   end
+      #
+      #   # bad
+      #   chdir ... do
+      #     ...
+      #   end
+      #
+      #   # good
+      #   Use exact path or create and call method in target dir instead
+      #
+      class DisableChdir < Base
+        MSG = 'Avoid using Dir.chdir due to thread safety issues'
+
+        def_node_matcher :chdir?, <<~PATTERN
+          (send {(const nil? :Dir) nil?} :chdir _)
+        PATTERN
+
+        def on_block(node)
+          return unless chdir?(node.send_node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sidekiq/require_sidekiq_testing_inline_block.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # Enforce passing a block to Sidekiq::Testing.inline! to ensure setting does not leak to other specs
+      # (https://github.com/sidekiq/sidekiq/wiki/Testing#testing-workers-inline)
+      #
+      # @example RequireSidekiqTestingInlineBlock: true (default)
+      #
+      #   # bad
+      #   Sidekiq::Testing.inline!
+      #   described_class.call
+      #
+      #   # good
+      #   Sidekiq::Testing.inline! { described_class.call }
+      #
+      class RequireSidekiqTestingInlineBlock < Base
+        MSG = 'Use Sidekiq::Testing.inline! with a block to ensure setting does not leak'
+
+        def_node_matcher :open_call?, <<~PATTERN
+          (send (...) :inline! ...)
+        PATTERN
+
+        def on_send(node)
+          add_offense(node) if open_call?(node) && !node.parent.is_a?(RuboCop::AST::BlockNode)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/disable_programmatic_enum_value.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Do not assign GraphQL Enums programmatically.
+      # Doing so obfuscates changes to clients that break when new Enums are added.
+      #
+      # @example DisableProgrammaticEnumValue:
+      #
+      #   # bad
+      #   RubyEnum.each_value { |type| enum_value type }
+      #
+      #   # good
+      #   enum_value RubyEnum::TYPE
+      class DisableProgrammaticEnumValue < Base
+        MSG = 'Do not assign graphql enums programmatically.'
+
+        def_node_matcher :each_value?, <<~PATTERN
+          (send (...) :each_value)
+        PATTERN
+
+        def_node_matcher :each?, <<~PATTERN
+          (send (...) :each)
+        PATTERN
+
+        def on_block(node)
+          return unless each_value?(node.send_node) || each?(node.send_node)
+          return unless invalid_children?(node.body)
+
+          add_offense(node)
+        end
+
+        private
+
+        def invalid_children?(node)
+          return false unless node.is_a?(::AST::Node)
+
+          if node.send_type?
+            %i[enum_value value].include?(node.method_name)
+          else
+            node.children.any? { |child| invalid_children?(child) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/graph_camelize.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Do not use the GraphQL camelize option as we always want the default value (true).
+      #
+      # @example GraphCamelize: true (default)
+      #
+      #   # bad
+      #   field :updated_at, String, null: true, camelize: false
+      #
+      #   # good
+      #   field :updated_at, String, null: true
+      #
+      class GraphCamelize < Base
+        extend AutoCorrector
+
+        MSG = 'Do not use the camelize option.'
+        RESTRICT_ON_SEND = %i[argument field].freeze
+        INCORRECT_OPTION = 'camelize'
+
+        def on_send(node)
+          node.children.each do |argument|
+            next unless argument.respond_to?(:type) && argument.type == :hash
+
+            argument.children.each do |pair|
+              next unless pair.key.value.to_s == INCORRECT_OPTION
+
+              add_offense(pair) do |corrector|
+                corrector.remove(get_range_to_remove(pair))
+              end
+            end
+          end
+        end
+
+        private
+
+        def get_range_to_remove(node)
+          left_node = node.left_sibling || node.parent&.left_sibling
+          begin_pos = left_node&.source_range&.end_pos || node.source_range.begin_pos
+          end_pos = node.source_range.end_pos
+          Parser::Source::Range.new(node.source_range.source_buffer, begin_pos, end_pos)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/notarize/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 Notarize
+    # 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/notarize/version.rb

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

data/lib/rubocop/notarize.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rubocop/notarize/version'
+require 'yaml'
+
+module RuboCop
+  module Notarize
+    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-notarize.rb

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

data/rubocop-notarize.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/notarize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-notarize'
+  spec.version       = RuboCop::Notarize::VERSION
+  spec.authors       = ['Arturo Gonzalez', 'Matthew Murphy', 'Jérémie Charrier']
+
+  spec.summary       = 'Create Linting rules for Notarize platform'
+  spec.description   = 'Custom linting rules for Notarize Ruby platform'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2.2')
+
+  # 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', '>= 0.92'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-notarize
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Arturo Gonzalez
+- Matthew Murphy
+- Jérémie Charrier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.92'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.92'
+description: Custom linting rules for Notarize Ruby platform
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-notarize.rb
+- lib/rubocop/cop/notarize_cops.rb
+- lib/rubocop/cop/performance/disable_reload.rb
+- lib/rubocop/cop/performance/require_file_open_block.rb
+- lib/rubocop/cop/security/disable_chdir.rb
+- lib/rubocop/cop/sidekiq/require_sidekiq_testing_inline_block.rb
+- lib/rubocop/cop/style/disable_programmatic_enum_value.rb
+- lib/rubocop/cop/style/graph_camelize.rb
+- lib/rubocop/notarize.rb
+- lib/rubocop/notarize/inject.rb
+- lib/rubocop/notarize/version.rb
+- rubocop-notarize.gemspec
+homepage:
+licenses: []
+metadata:
+  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: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Create Linting rules for Notarize platform
+test_files: []