rubocop-rubomatic-rails 1.0.0.pre.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81d4d4ca3524d84f641ed222926213621eb8156278b11774d452bae4a0e0ce00
+  data.tar.gz: d262405ee2f10aa76415f8b0e389b92f567654b179259712a10233c43b3df98d
+SHA512:
+  metadata.gz: bd49d1eac544dafff939d3fbe2e7fba64d04c7669feb79cb449578c904a73136a73703a44d0b34ee553ba73a4019da807bf32c2b7d32f4258b3170e907733b82
+  data.tar.gz: a4d7ce4985153279b5543a97cf675005b745ccf3e3c170172a1c0640604d3dcea97792dfbea89706663c0205399f5c4d9d8a570f80d66888e591cf2c3d8778f6

data/CHANGELOG.adoc

@@ -0,0 +1,9 @@
+== 1.0.0
+
+* Initial renaming migration
+** Replaced rubomatic-rails
+
+=== Dependencies
+
+* `rubocop-rubomatic@1.0.0`
+* `rubocop-rails@2.18.0`

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Brands Insurance Agency, Inc.
+
+Copyright for portions of project Rubocop are held by Bozhidar Batsov and other contributors, as part of project Rubocop.
+
+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.adoc

@@ -0,0 +1,86 @@
+= Rubomatic
+
+Gem for shared rails rubocop config and custom rails cops for BrandsInsurance
+
+Put your Ruby code in the file ``lib/rubocop/rubomatic-rails``.
+To experiment with that code, run
+``bin/console`` for an interactive prompt.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'rubocop-rubomatic-rails', require: false
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-rubomatic-rails
+
+== Usage
+
+Add the following to your ``.rubocop.yml`` config file
+
+[source,yaml]
+----
+inherit_gem:
+  rubocop-rubomatic-rails: config/rubocop.yml
+----
+
+If you need to override a setting:
+
+[source,yaml]
+----
+# Add to Naming/VariableNumber.AllowedIdentifiers
+inherit_gem:
+  rubocop-rubomatic-rails: config/rubocop.yml
+
+Naming/VariableNumber:
+  inherit_mode:
+    merge:
+      - AllowedIdentifiers
+  AllowedIdentifiers:
+    - street_2
+----
+
+[source,yaml]
+----
+# Completely override Naming/VariableNumber.AllowedIdentifiers
+inherit_gem:
+  rubocop-rubomatic-rails: config/rubocop.yml
+
+Naming/VariableNumber:
+  inherit_mode:
+    override:
+      - AllowedIdentifiers
+  AllowedIdentifiers:
+    - street_2
+----
+
+== Custom Cops
+
+Add ``RubomaticRails/*`` cops to your ``.rubocop.yml`` config file
+
+[source,yaml]
+----
+RubomaticRails/Style/DisallowedMethods:
+  Enabled: true
+----
+
+== Departments
+
+None yet
+
+== Contributing
+
+See xref:./CONTRIBUTING.adoc[CONTRIBUTING] for how to add your own rule
+
+== Changelog
+
+See xref:./CHANGELOG.adoc[CHANGELOG] see see changes

data/lib/rubocop/cop/rubomatic-rails/generator/cop_readme_injector.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RubomaticRails
+      class Generator
+        class CopReadmeInjector < DeptReadmeInjector
+          TEMPLATE =
+            '* xref:./%{cop_folder}/README.adoc[``%{department}/%{cop}``]'
+
+          # :nodoc:
+          def initialize(badge:, **kwargs)
+            super(badge: badge, **kwargs)
+
+            @cop = badge.cop_name
+          end
+
+          private
+
+            # @return [String]
+            attr_reader :cop
+
+            # @see super
+            def new_readme_entry
+              format(TEMPLATE, {
+                department_folder: snake_case(department),
+                cop_folder: snake_case(cop),
+                department: department,
+                cop: cop
+              })
+            end
+
+            # @see super
+            def line_is_good?(line)
+              return true if super
+
+              matches = line.match(target_regex)
+              return false if matches.nil?
+
+              department == matches[:department] && cop < matches[:cop]
+            end
+
+            # @see super
+            def target_regex
+              %r{\* xref:\./docs/cops/[a-z_]+/[a-z_]+/README\.adoc\[``(?<department>[a-zA-Z_]+)/(?<cop>[a-zA-Z_]+)``\]}
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rubomatic-rails/generator/dept_readme_injector.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RubomaticRails
+      class Generator
+        class DeptReadmeInjector
+          TEMPLATE = '* xref:./docs/cops/%{department_folder}/README.adoc[``%{department}``]'
+
+          # :nodoc:
+          def initialize(readme_file_path:, badge:, department:)
+            @readme_file_path = readme_file_path
+            @badge = badge
+            @department = department
+            @output = output
+          end
+
+          # Performs the actual string injection into the file
+          # modified version of `inject` from RuboCop::Cop::Generator::ConfigurationInjector
+          # Named `inject_string` becuase rubocop thought when called it was `Array#inject`
+          #
+          # @return [void]
+          #
+          def inject_string
+            target_line = find_target_line
+
+            if target_line
+              readme_entries.insert(target_line, "#{new_readme_entry}\n")
+            else
+              readme_entries.push(new_readme_entry)
+            end
+
+            File.write(readme_file_path, readme_entries.join(''))
+
+            yield if block_given?
+          end
+
+          private
+
+            # @return [String]
+            attr_reader :readme_file_path
+            # @return [RuboCop::Cop::Badge]
+            attr_reader :badge
+            # @return [String]
+            attr_reader :department
+            # @return [*] Default $stdout
+            attr_reader :output
+
+            # Lines in <department>/README.adoc
+            #
+            # @return [Array<String>]
+            #
+            def readme_entries
+              @readme_entries ||= File.readlines(readme_file_path)
+            end
+
+            # Modified version from Rubocop::Cop::Generator::ConfigurationInjector
+            #
+            # @return [String]
+            #
+            def new_readme_entry
+              format(TEMPLATE, {
+                department_folder: snake_case(department),
+                department: department
+              })
+            end
+
+            # Modified version from Rubocop::Cop::Generator::ConfigurationInjector
+            #
+            # @return [Integer, Nil]
+            #
+            def find_target_line
+              readme_entries.find.with_index do |line, index|
+                return index if line_is_good?(line)
+              end
+
+              return nil
+            end
+
+            # Determines if the given line is the same type we're trying to add and if it's alphabetically before
+            #
+            # @return [Boolean]
+            #
+            def line_is_good?(line)
+              matches = line.match(target_regex)
+              return false if matches.nil?
+
+              department < line.match(target_regex)[:department]
+            end
+
+            # Regex to look for in the readme
+            #
+            # @return [Regexp]
+            #
+            def target_regex
+              %r{\* xref:\./docs/cops/[a-z_]+/README\.adoc\[``(?<department>[a-zA-Z_]+)``\]}
+            end
+
+            # Copied from Rubocop::Cop::Generator
+            #
+            # @return [String]
+            #
+            def snake_case(camel_case_string)
+              camel_case_string
+                .gsub('RSpec', 'Rspec')
+                .gsub(%r{([^A-Z/])([A-Z]+)}, '\1_\2')
+                .gsub(%r{([A-Z])([A-Z][^A-Z\d/]+)}, '\1_\2')
+                .downcase
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rubomatic-rails/generator.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+require_relative './generator/dept_readme_injector'
+
+require_relative './generator/cop_readme_injector'
+
+module RuboCop
+  module Cop
+    module RubomaticRails
+      class Generator
+        COP_DOC = <<~RUBY
+          # TODO: Write cop description and example of bad / good code. For every
+          # `SupportedStyle` and unique configuration, there needs to be examples.
+          # Examples must have valid Ruby syntax. Do not use upticks.
+          #
+          # @safety
+          #   Delete this section if the cop is not unsafe (`Safe: false` or
+          #   `SafeAutoCorrect: false`), or use it to explain how the cop is
+          #   unsafe.
+          #
+          # @example EnforcedStyle: bar (default)
+          #   # Description of the `bar` style.
+          #
+          #   # bad
+          #   bad_bar_method
+          #
+          #   # bad
+          #   bad_bar_method(args)
+          #
+          #   # good
+          #   good_bar_method
+          #
+          #   # good
+          #   good_bar_method(args)
+          #
+          # @example EnforcedStyle: foo
+          #   # Description of the `foo` style.
+          #
+          #   # bad
+          #   bad_foo_method
+          #
+          #   # bad
+          #   bad_foo_method(args)
+          #
+          #   # good
+          #   good_foo_method
+          #
+          #   # good
+          #   good_foo_method(args)
+          #
+        RUBY
+        SOURCE_TEMPLATE = <<~RUBY
+          # frozen_string_literal: true
+
+          module RuboCop
+            module Cop
+              module %{department}
+                class %{cop_name} < Base
+                  # TODO: Implement the cop in here.
+                  #
+                  # In many cases, you can use a node matcher for matching node pattern.
+                  # See https://github.com/rubocop/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb
+                  #
+                  # For example
+                  MSG = 'Use `#good_method` instead of `#bad_method`.'
+
+                  # TODO: Don't call `on_send` unless the method name is in this list
+                  # If you don't need `on_send` in the cop you created, remove it.
+                  RESTRICT_ON_SEND = %%i[bad_method].freeze
+
+                  # @!method bad_method?(node)
+                  def_node_matcher :bad_method?, <<~PATTERN
+                    (send nil? :bad_method ...)
+                  PATTERN
+
+                  def on_send(node)
+                    return unless bad_method?(node)
+
+                    add_offense(node)
+                  end
+                end
+              end
+            end
+          end
+        RUBY
+        README_ADDED_MESSAGE = '[modify] A link for the %{dept_vs_cop} has been added into %{readme_file_path}.'
+
+        DEPT_README_TEMPLATE = <<~ADOC
+          = %{department}
+
+          Describe the department here
+
+          == Cops
+
+        ADOC
+        COP_README_TEMPLATE = <<~ADOC
+          = ``%{department}/%{cop_name}``
+
+          == Description
+
+          Add a description here
+
+          == Examples
+
+          [source,ruby]
+          ----
+          # Bad
+          # Add a bad example here
+
+          # Good
+          # Add a good example here
+          ----
+
+          == Configurable Attributes
+
+          |===
+          |Name |Default value |Configurable values
+
+          |Max
+          |120
+          |Integer
+
+          |===
+
+          == References
+
+          https://github.com/BrandsInsurance/expert-chainsaw/issues
+        ADOC
+
+        # :nodoc:
+        def initialize(name, output: $stdout)
+          name = ['RubomaticRails', name].join('/') unless name.start_with?('RubomaticRails/')
+
+          unless name.count('/') == 2
+            raise(
+              [
+                'You must provide a single department under RubomaticRails i.e. RubomaticRails/Department/CopName',
+                'or Department/CopName'
+              ].join(' ')
+            )
+          end
+
+          @base_gen = RuboCop::Cop::Generator.new(name, output: output)
+        end
+
+        # Calls methods in the base class
+        #
+        # @return [*]
+        #
+        def method_missing(...)
+          @base_gen.__send__(...)
+        end
+
+        # `self` responds to `method_name` if `@base_gen` does
+        #
+        def respond_to_missing?(method_name, include_private = false)
+          @base_gen.respond_to?(method_name, include_private)
+        end
+
+        # Creates the department readme if it doesn't exist
+        # Modified version of `wirte_source` from RuboCop::Cop::Generator
+        #
+        # @return [void]
+        #
+        def write_dept_readme
+          return if File.exist?(dept_docs_path)
+
+          write_unless_file_exists(dept_docs_path, generated_dept_docs)
+        end
+
+        # Creates the cop readme if it doesn't exist
+        # Modified version of `wirte_source` from RuboCop::Cop::Generator
+        #
+        # @return [void]
+        #
+        def write_cop_readme
+          write_unless_file_exists(docs_path, generated_cop_docs)
+        end
+
+        # Injects the, possibly new, department readme link into the base readme
+        # Modified version of `inject_config` from RuboCop::Cop::Generator
+        #
+        # @return [void]
+        #
+        def inject_dept_readme(readme_file_path: 'README.adoc')
+          # Add this dept to base readme if not already there
+          injector = DeptReadmeInjector.new(
+            readme_file_path: readme_file_path,
+            badge: badge,
+            department: department
+          )
+
+          injector.inject_string do
+            output.puts(format(README_ADDED_MESSAGE, readme_file_path: readme_file_path, dept_vs_cop: 'department'))
+          end
+        end
+
+        # Injects the new cop readme link into the department readme
+        # Modified version of `inject_config` from RuboCop::Cop::Generator
+        #
+        # @return [void]
+        #
+        def inject_cop_readme(readme_file_path: dept_docs_path)
+          # Add this cop to the dept readme
+          injector = CopReadmeInjector.new(
+            readme_file_path: readme_file_path,
+            badge: badge,
+            department: department
+          )
+
+          injector.inject_string do
+            output.puts(format(README_ADDED_MESSAGE, readme_file_path: readme_file_path, dept_vs_cop: 'cop'))
+          end
+        end
+
+        private
+
+          # The rubocop department without the RubomaticRails prefix
+          #
+          # @return [String]
+          #
+          def department
+            badge.department_name.gsub('RubomaticRails/', '')
+          end
+
+          # Modified version of `generated_source` from Rubocop::Cop::Generator
+          #
+          # @return [String]
+          #
+          def generated_dept_docs
+            generate_readme(DEPT_README_TEMPLATE)
+          end
+
+          # Modified version of `generated_source` from Rubocop::Cop::Generator
+          #
+          # @return [String]
+          #
+          def generated_cop_docs
+            generate_readme(COP_README_TEMPLATE)
+          end
+
+          # Modified version from Rubocop::Cop::Generator
+          #
+          # @return [String]
+          #
+          def generate_readme(template)
+            format(template, {
+              department: department,
+              cop_name: badge.cop_name,
+              cop_folder: snake_case(badge.cop_name.to_s)
+            })
+          end
+
+          # Path to <department>/README.adoc
+          #
+          # @return [String]
+          #
+          def dept_docs_path
+            File.join(
+              'docs',
+              'cops',
+              snake_case(department),
+              'README.adoc'
+            )
+          end
+
+          # Path to <department>/<cop>/README.adoc
+          #
+          # @return [String]
+          #
+          def docs_path
+            File.join(
+              'docs',
+              'cops',
+              snake_case(department),
+              snake_case(badge.cop_name.to_s),
+              'README.adoc'
+            )
+          end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rubomatic_rails_cops.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/rubocop/rubomatic-rails/inject.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RubomaticRails
+    module Inject
+      # This was a generated method from https://github.com/rubocop/rubocop-extension-generator
+      #
+      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/rubomatic-rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RubomaticRails
+    VERSION = '1.0.0-rc.1'
+  end
+end

data/lib/rubocop/rubomatic-rails.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'rubomatic-rails/version'
+require 'yaml'
+
+module RuboCop
+  module RubomaticRails
+    class Error < StandardError
+    end
+
+    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-rubomatic-rails.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/cop/rubomatic-rails/generator'
+require_relative 'rubocop/rubomatic-rails'
+require_relative 'rubocop/rubomatic-rails/inject'
+require_relative 'rubocop/rubomatic-rails/version'
+
+RuboCop::RubomaticRails::Inject.defaults!
+
+require_relative 'rubocop/cop/rubomatic_rails_cops'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rubomatic-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.rc.1
+platform: ruby
+authors:
+- Brands Insurance
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: rubomatic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: 
+email:
+- documents@brandsinsurance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- lib/rubocop-rubomatic-rails.rb
+- lib/rubocop/cop/rubomatic-rails/generator.rb
+- lib/rubocop/cop/rubomatic-rails/generator/cop_readme_injector.rb
+- lib/rubocop/cop/rubomatic-rails/generator/dept_readme_injector.rb
+- lib/rubocop/cop/rubomatic_rails_cops.rb
+- lib/rubocop/rubomatic-rails.rb
+- lib/rubocop/rubomatic-rails/inject.rb
+- lib/rubocop/rubomatic-rails/version.rb
+homepage: https://github.com/BrandsInsurance/rubomatic-rails/
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/BrandsInsurance/rubomatic-rails/
+  source_code_uri: https://github.com/BrandsInsurance/rubomatic-rails
+  changelog_uri: https://github.com/BrandsInsurance/rubomatic-rails/blob/main/CHANGELOG.adoc
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Shared rails rubocop config for BrandsInsurance
+test_files: []