rubocop-g2 1.7.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b484fad7593fa6a699916c560ed8ec2b5d4926496168486b48ff6fff18492bb3
-  data.tar.gz: e4096d81c7896f473c6191e0f6f864f58d3a18e1872297ce2d32687400e78c2f
+  metadata.gz: a0d87aea83dd481168c720b74ef346eb287790b5fb361617e34926e2e594fdc6
+  data.tar.gz: 7af47137f5f989fdfe3143beb7662b94dc892ff7fb3f26594e55227fede04b1e
 SHA512:
-  metadata.gz: 1483423826e3a387185ac626fc3b41a86531cddb705c5c9a02695c4534dc1353ae8504227ed5fc973fb3e1f1bec7068deda047a099cbd4df2d45709ebffd9ea3
-  data.tar.gz: dafd8ef06fa641161e1eb9a0073a65de9ab78046adc79f1f9afbadf420d69aafd613244ad4c3e277e0de1b1e24473e911a208fdf4bb4377c77daaecd1916f012
+  metadata.gz: 12ffe75d1138d09a1d86f3eeb25752707f04897442059b1b8ddeca1b6bd1cc5365baabef0c45880a92b58df2a7e7ca96dd6a463235d7ad9f296e383a791a66d0
+  data.tar.gz: f86d5a5065034f92de4106e9ed94c16875354a5b83c276af5a1bd7c1582810f63958fac98c986bd5d1d5bd3435cdc5dcae623e4952c4629478df84808ebebd87

data/.github/workflows/build.yml

@@ -0,0 +1,7 @@
+name: Build
+on:
+  pull_request:
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml

data/.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Build
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+  release:
+    runs-on: ubuntu-22.04
+    needs: test
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build and publish gem
+      uses: g2crowd/gh-actions/actions/publish-gem@v1.0.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+on:
+  workflow_call:
+    inputs:
+      runs-on:
+        required: false
+        type: string
+        default: "ubuntu-22.04"
+      ruby-version:
+        required: false
+        type: string
+        default: '3.2.2'
+
+
+jobs:
+  test:
+    name: Run Specs
+    runs-on: ${{ inputs.runs-on }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ inputs.ruby-version }}
+          bundler-cache: true
+      - name: Run Specs
+        run: bundle exec rspec spec

data/.ruby-version

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.1
+ruby 3.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-g2 (1.7.0)
+    rubocop-g2 (1.9.2)
       rubocop (>= 0.82)
       rubocop-rails (>= 2.5)
       rubocop-rspec (>= 1.39)
@@ -9,30 +9,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.4)
+    activesupport (7.0.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.10)
+    base64 (0.1.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.3)
-    i18n (1.10.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.2.3)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.1)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.3.1)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -46,27 +51,36 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.3)
-    rubocop (1.28.2)
+    rubocop (1.56.1)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-rails (2.14.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rails (2.20.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rspec (2.10.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby

data/lib/rubocop/cop/g2/ban_global_methods.rb

@@ -0,0 +1,52 @@
+module RuboCop
+  module Cop
+    module G2
+      class BanGlobalMethods < RuboCop::Cop::Cop
+        MSG = 'Do not define top-level methods.'.freeze
+
+        def_node_matcher :const_block?, <<~PATTERN
+          (block (send (const _ _) _+) _ _)
+        PATTERN
+
+        def_node_matcher :eval_block?, <<~PATTERN
+          (block (send _ /(class|instance)_eval/ _*) _ _)
+        PATTERN
+
+        def_node_matcher :describe_block?, <<~PATTERN
+          (block (send _ :describe _*) _ _)
+        PATTERN
+
+        def on_def(node)
+          node.each_ancestor do |ancestor|
+            return if ancestor.class_type? || ancestor.module_type?
+            return if const_block?(ancestor)
+            return if describe_block?(ancestor)
+
+            if eval_block?(ancestor)
+              evaled_obj = ancestor.children.first.receiver
+              return unless evaled_obj.nil? || evaled_obj.self_type?
+            end
+          end
+
+          add_offense node, message: MSG
+        end
+        alias on_defs on_def
+
+        def_node_matcher :define_method?, <<~PATTERN
+          (send _ /define_(singleton_)?method/ _)
+        PATTERN
+
+        def_node_matcher :send_define_method?, <<~PATTERN
+          (send _ /(public_)?send/ (_ /define_(singleton_)?method/) _)
+        PATTERN
+
+        def on_send(node)
+          return unless define_method?(node) || send_define_method?(node)
+          return unless node.receiver.nil? || node.receiver.self_type?
+
+          on_def(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/migrations/change.rb

@@ -0,0 +1,39 @@
+require 'rubocop/cop/mixin/migrations_helper'
+require_relative 'check_existence'
+
+module RuboCop
+  module Cop
+    module G2
+      module Migrations
+        class Change < RuboCop::Cop::Cop
+          include RuboCop::Cop::MigrationsHelper
+
+          MSG = 'Replace `change` with `up` and `down` migration methods when using schema methods that should check existence'.freeze
+
+          def on_def(node)
+            return unless should_add_offense?(node)
+
+            add_offense node
+          end
+
+          private
+
+          def should_add_offense?(node)
+            node.method_name == :change &&
+              in_migration?(node) &&
+              includes_methods_with_existence_check?(node)
+          end
+
+          def includes_methods_with_existence_check?(node)
+            node.descendants.any?(&method(:method_with_existence_check?))
+          end
+
+          def method_with_existence_check?(node)
+            node.type == :send &&
+              RuboCop::Cop::G2::Migrations::CheckExistence::RESTRICT_ON_SEND.include?(node.method_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/migrations/check_existence.rb

@@ -0,0 +1,98 @@
+require 'rubocop/cop/mixin/migrations_helper'
+
+module RuboCop
+  module Cop
+    module G2
+      module Migrations
+        class CheckExistence < RuboCop::Cop::Cop
+          include RuboCop::Cop::MigrationsHelper
+
+          method_map = {
+            add_belongs_to: :remove_belongs_to,
+            add_check_constraint: :remove_check_constraint,
+            add_column: :remove_column,
+            add_foreign_key: :remove_foreign_key,
+            add_index: :remove_index,
+            add_reference: :remove_reference,
+            add_timestamps: :remove_timestamps,
+            create_join_table: :drop_join_table,
+            create_table: :drop_table
+          }
+
+          CONSTRUCTIVE_METHODS = method_map.keys.freeze
+          DESTRUCTIVE_METHODS = method_map.values.freeze
+          IF_EXISTS_MSG = 'Use `if_exists: true` option'.freeze
+          IF_NOT_EXISTS_MSG = 'Use `if_not_exists: true` option'.freeze
+          WITH_OPTIONS_NODE_TYPES = %i(block send).freeze
+
+          RESTRICT_ON_SEND = (CONSTRUCTIVE_METHODS + DESTRUCTIVE_METHODS).freeze
+
+          def on_send(node)
+            return unless in_migration?(node)
+
+            error = check_for_errors(node)
+            return unless error
+
+            add_offense node, message: error
+          end
+
+          private
+
+          def check_for_errors(node)
+            if constructive?(node)
+              check_if_not_exists(node)
+            elsif destructive?(node)
+              check_if_exists(node)
+            end
+          end
+
+          def constructive?(node)
+            CONSTRUCTIVE_METHODS.include? node.method_name
+          end
+
+          def destructive?(node)
+            DESTRUCTIVE_METHODS.include? node.method_name
+          end
+
+          def check_if_not_exists(node)
+            check_kwargs node, :if_not_exists, IF_NOT_EXISTS_MSG
+          end
+
+          def check_if_exists(node)
+            check_kwargs node, :if_exists, IF_EXISTS_MSG
+          end
+
+          def check_kwargs(node, arg_name, msg)
+            valid_kwarg = true_kwarg(arg_name)
+            return if has_kwarg?(node, valid_kwarg)
+
+            node.each_ancestor do |ancestor|
+              next unless is_with_options_call?(ancestor)
+
+              with_options_call = ancestor.type == :block ? ancestor.children.first : ancestor
+              return if has_kwarg?(with_options_call, valid_kwarg)
+            end
+
+            msg
+          end
+
+          def true_kwarg(arg_name)
+            s(:pair, s(:sym, arg_name), s(:true))
+          end
+
+          def is_with_options_call?(node)
+            WITH_OPTIONS_NODE_TYPES.include?(node.type) &&
+              node.method_name == :with_options
+          end
+
+          def has_kwarg?(node, check_kwarg)
+            node.arguments.any? do |arguments|
+              arguments.type == :hash &&
+                arguments.descendants.include?(check_kwarg)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/g2/migrations.rb

@@ -0,0 +1,2 @@
+require_relative 'migrations/change'
+require_relative 'migrations/check_existence'

data/lib/rubocop/g2/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module G2
-    VERSION = '1.7.0'.freeze
+    VERSION = '1.9.2'.freeze
   end
 end

data/lib/rubocop_g2.rb

@@ -8,3 +8,5 @@ require_relative 'rubocop/cop/g2/raw_connection_execute'
 require_relative 'rubocop/cop/g2/safe_connection_handling'
 require_relative 'rubocop/cop/g2/aggregates_model_boundary'
 require_relative 'rubocop/cop/g2/accessible_icons'
+require_relative 'rubocop/cop/g2/migrations'
+require_relative 'rubocop/cop/g2/ban_global_methods'

data/rubocop-g2.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = "https://github.com/g2crowd/#{spec.name}"
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.required_ruby_version = '>= 2.7'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-g2
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Paul Mannino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -115,8 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".tool-versions"
 - Gemfile
 - Gemfile.lock
@@ -129,7 +133,11 @@ files:
 - lib/rubocop/cop/g2/accessible_icons.rb
 - lib/rubocop/cop/g2/aggregates_model_boundary.rb
 - lib/rubocop/cop/g2/ban_decorators.rb
+- lib/rubocop/cop/g2/ban_global_methods.rb
 - lib/rubocop/cop/g2/ban_sidekiq_worker.rb
+- lib/rubocop/cop/g2/migrations.rb
+- lib/rubocop/cop/g2/migrations/change.rb
+- lib/rubocop/cop/g2/migrations/check_existence.rb
 - lib/rubocop/cop/g2/predicate_memoization.rb
 - lib/rubocop/cop/g2/raw_connection_execute.rb
 - lib/rubocop/cop/g2/safe_connection_handling.rb
@@ -139,6 +147,8 @@ files:
 homepage: https://g2.com
 licenses: []
 metadata:
+  homepage_uri: https://g2.com
+  source_code_uri: https://github.com/g2crowd/rubocop-g2
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -155,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Custom cops for G2.