rubocop-rhino-project 0.20.0.alpha.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d1e3753b313df9f9f1890d4af12074b96c0f7fe843e52d71e252f351e5ede79
+  data.tar.gz: 55693f13ed9852996e5fd026d76fe4d5bbdfcf24e9d551d3691d41ca8b33fcb8
+SHA512:
+  metadata.gz: fb134e396dd3ff56d92c27e6e2212f991abb34b9fa3abaa583b25b4d1722ba9d8662da8f633619526422872dfb85e9fe53be208a7c71621e3cdf81bd4234ebca
+  data.tar.gz: 22a5209ac3c8171e456574d02476a0e4be7b3f1377816bf5ec42ec554e6fe5c9dcd403ea1352e8295131d10715d045dfda9979aef35f387614d273d07f1e10e0

data/config/default.yml

@@ -0,0 +1,21 @@
+# Common configuration.
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Exclude:
+    - app/assets/**/*
+    - bin/*
+    # Exclude db/schema.rb and db/[CONFIGURATION_NAMESPACE]_schema.rb by default.
+    # See: https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application
+    - db/*schema.rb
+    - log/**/*
+    - public/**/*
+    - storage/**/*
+
+RhinoProject/DuplicateRhinoReferences:
+  Description: ''
+  Enabled: true
+  SafeAutoCorrect: false

data/lib/rubocop/cop/rhino_project/duplicate_rhino_references.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RhinoProject
+      # Don't call `rhino_references` method more than once in the same class.
+      #
+      #
+      # @example
+      #   # bad
+      #   class Blog < ApplicationRecord
+      #     belongs_to :user
+      #     belongs_to :category
+      #
+      #     rhino_references %i[user]
+      #     rhino_references %i[user category]
+      #   end
+      #
+      #   # good
+      #   class Blog < ApplicationRecord
+      #     belongs_to :user
+      #     belongs_to :category
+      #
+      #     rhino_references %i[user category]
+      #   end
+      #
+      class DuplicateRhinoReferences < Base
+        MSG = "Avoid calling `rhino_references` method more than once in the same class."
+
+        def_node_search :rhino_references_call, "(send nil? :rhino_references (array ...))"
+
+        def on_class(node)
+          check_for_multiple_calls(node)
+        end
+
+        private
+          def check_for_multiple_calls(node)
+            rhino_references_calls = rhino_references_call(node)
+
+            return if rhino_references_calls.count <= 1
+
+            rhino_references_calls.each do |offending_call|
+              add_offense(offending_call, message: MSG)
+            end
+          end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rhino_project_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rhino_project/duplicate_rhino_references"

data/lib/rubocop/rhino_project/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RhinoProject
+    # 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, unset_nil: false)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rhino_project/schema_loader/schema.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RhinoProject
+    module SchemaLoader
+      # Represent db/schema.rb
+      class Schema
+        attr_reader :tables, :add_indices
+
+        def initialize(ast)
+          @tables = []
+          @add_indices = []
+
+          build!(ast)
+        end
+
+        def table_by(name:)
+          tables.find do |table|
+            table.name == name
+          end
+        end
+
+        def add_indices_by(table_name:)
+          add_indices.select do |add_index|
+            add_index.table_name == table_name
+          end
+        end
+
+        private
+          def build!(ast)
+            raise "Unexpected type: #{ast.type}" unless ast.block_type?
+            return unless ast.body
+
+            each_table(ast) do |table_def|
+              next unless table_def.method?(:create_table)
+
+              @tables << Table.new(table_def)
+            end
+
+            # Compatibility for Rails 4.2.
+            each_add_index(ast) do |add_index_def|
+              @add_indices << AddIndex.new(add_index_def)
+            end
+          end
+
+          def each_table(ast)
+            case ast.body.type
+            when :begin
+              ast.body.children.each do |node|
+                next unless node.block_type? && node.method?(:create_table)
+
+                yield(node)
+              end
+            else
+              yield ast.body
+            end
+          end
+
+          def each_add_index(ast)
+            ast.body.children.each do |node|
+              next unless node.respond_to?(:send_type?)
+              next if !node&.send_type? || !node.method?(:add_index)
+
+              yield(node)
+            end
+          end
+      end
+
+      # Represent a table
+      class Table
+        attr_reader :name, :columns, :indices
+
+        def initialize(node)
+          @name = node.send_node.first_argument.value
+          @columns = build_columns(node)
+          @indices = build_indices(node)
+        end
+
+        def with_column?(name:)
+          @columns.any? { |c| c.name == name }
+        end
+
+        private
+          def build_columns(node)
+            each_content(node).filter_map do |child|
+              next unless child&.send_type?
+              next if child.method?(:index)
+
+              Column.new(child)
+            end
+          end
+
+          def build_indices(node)
+            each_content(node).filter_map do |child|
+              next unless child&.send_type?
+              next unless child.method?(:index)
+
+              Index.new(child)
+            end
+          end
+
+          def each_content(node, &block)
+            return enum_for(__method__, node) unless block
+
+            case node.body&.type
+            when :begin
+              node.body.children.each(&block)
+            else
+              yield(node.body)
+            end
+          end
+      end
+
+      # Represent a column
+      class Column
+        attr_reader :name, :type, :not_null
+
+        def initialize(node)
+          @name = node.first_argument.str_content
+          @type = node.method_name
+          @not_null = nil
+
+          analyze_keywords!(node)
+        end
+
+        private
+          def analyze_keywords!(node)
+            pairs = node.last_argument
+            return unless pairs.hash_type?
+
+            pairs.each_pair do |k, v|
+              @not_null = !v.true_type? if k.value == :null
+            end
+          end
+      end
+
+      # Represent an index
+      class Index
+        attr_reader :name, :columns, :expression, :unique
+
+        def initialize(node)
+          @columns, @expression = build_columns_or_expr(node.first_argument)
+          @unique = nil
+
+          analyze_keywords!(node)
+        end
+
+        private
+          def build_columns_or_expr(columns)
+            if columns.array_type?
+              [columns.values.map(&:value), nil]
+            else
+              [[], columns.value]
+            end
+          end
+
+          def analyze_keywords!(node)
+            pairs = node.last_argument
+            return unless pairs.hash_type?
+
+            pairs.each_pair do |k, v|
+              case k.value
+              when :name
+                @name = v.value
+              when :unique
+                @unique = true
+              end
+            end
+          end
+      end
+
+      # Represent an `add_index`
+      class AddIndex < Index
+        attr_reader :table_name
+
+        def initialize(node)
+          super(node)
+
+          @table_name = node.first_argument.value
+          @columns, @expression = build_columns_or_expr(node.arguments[1])
+          @unique = nil
+
+          analyze_keywords!(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rhino_project/schema_loader.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RhinoProject
+    # It loads db/schema.rb and return Schema object.
+    # Cops refers database schema information with this module.
+    module SchemaLoader
+      extend self
+
+      # It parses `db/schema.rb` and return it.
+      # It returns `nil` if it can't find `db/schema.rb`.
+      # So a cop that uses the loader should handle `nil` properly.
+      #
+      # @return [Schema, nil]
+      def load(target_ruby_version, parser_engine)
+        return @load if defined?(@load)
+
+        @load = load!(target_ruby_version, parser_engine)
+      end
+
+      def reset!
+        return unless instance_variable_defined?(:@load)
+
+        remove_instance_variable(:@load)
+      end
+
+      def db_schema_path
+        path = Pathname.pwd
+        until path.root?
+          schema_path = path.join("db/schema.rb")
+          return schema_path if schema_path.exist?
+
+          path = path.join("../").cleanpath
+        end
+
+        nil
+      end
+
+      private
+        def load!(target_ruby_version, parser_engine)
+          path = db_schema_path
+          return unless path
+
+          ast = RuboCop::ProcessedSource.new(File.read(path), target_ruby_version, path, parser_engine:).ast
+
+          Schema.new(ast) if ast
+        end
+    end
+  end
+end

data/lib/rubocop/rhino_project/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubocopRhinoProject
+  # Returns the currently loaded version of Rhino core as a +Gem::Version+.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 20
+    TINY  = 0
+    PRE   = "alpha.0"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/rubocop/rhino_project.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop Rails project namespace
+  module RhinoProject
+    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, permitted_classes: [Regexp, Symbol]).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-rhino-project.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rack/utils"
+require "active_support/inflector"
+require "active_support/core_ext/object/blank"
+
+require_relative "rubocop/rhino_project"
+require_relative "rubocop/rhino_project/version"
+require_relative "rubocop/rhino_project/inject"
+require_relative "rubocop/rhino_project/schema_loader"
+require_relative "rubocop/rhino_project/schema_loader/schema"
+
+RuboCop::RhinoProject::Inject.defaults!
+
+require_relative "rubocop/cop/rhino_project_cops"
+
+RuboCop::Cop::Style::HashExcept.minimum_target_ruby_version(2.0)

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rhino-project
+version: !ruby/object:Gem::Version
+  version: 0.20.0.alpha.0
+platform: ruby
+authors:
+- JP Rosevear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ''
+email:
+- jp@codalio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/default.yml
+- lib/rubocop-rhino-project.rb
+- lib/rubocop/cop/rhino_project/duplicate_rhino_references.rb
+- lib/rubocop/cop/rhino_project_cops.rb
+- lib/rubocop/rhino_project.rb
+- lib/rubocop/rhino_project/inject.rb
+- lib/rubocop/rhino_project/schema_loader.rb
+- lib/rubocop/rhino_project/schema_loader/schema.rb
+- lib/rubocop/rhino_project/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []