rubocop-brands_insurance 0.0.2.pre.rc.4 → 0.0.2.pre.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a31e7b878d8cb36894cdd1e93f6aa08defa73245c4cdb250adb9b0331576db
-  data.tar.gz: 82a85cd60c35ae33e4dabd2722a74fb4c43ced895a791a452d76b870a1423f6c
+  metadata.gz: a2c30f388ac393017855ac647ce55cc32500677db42e4a1326a4c7fbe369944f
+  data.tar.gz: bb492e4da95e8c54da9371d2a4ed6f9fd0219e754211e0f71d3c8e6eafbbade1
 SHA512:
-  metadata.gz: 9aff2fde024a978f66c774a8eec2e288734eebb4beacc3b20753beee77477eb82fddae6ed93867a0809f6202b35e95c757c554e2d18da4cdd4a662f4368b4b12
-  data.tar.gz: 6dd36698038d0db7526372c20df0026e1e1d1e77e315fddeca384a7d5f8b63672f80a1e459aac42dce73da6c4254b9af56ef69c0a0d973c102461aa8af51edcd
+  metadata.gz: 6d33b942f577abed0010d3ed388d0e561a1e7d84b649fdd92063b7aa586af958a1252db56e38ed727ac43f10874b2bd751cd579085f9623d81cf5791d0fc6d5f
+  data.tar.gz: 2154fb919f9d708c69736ca616b751fe03e5cc68cb3f416123a02d123d2bbeb39974245c4382e09d3d8e121a6651a5548e955ef1d6e7fabadab62161100fca9b

data/LICENSE.txt

@@ -1,5 +1,7 @@
 Copyright (c) 2012-23 Brands Insurance
 
+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

data/config/default.yml

@@ -1,4 +1,4 @@
 BrandsInsurance/Style/DisallowedMethods:
   Description: 'Disallows the usage of `#abort` and `#tap` methods'
-  Enabled: pending
+  Enabled: true
   VersionAdded: '<<next>>'

data/lib/rubocop/brands_insurance/inject.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
 module RuboCop
   module BrandsInsurance
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
     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

data/lib/rubocop/brands_insurance/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module BrandsInsurance
-    VERSION = '0.0.2-rc.4'
+    VERSION = '0.0.2-rc.5'
   end
 end

data/lib/rubocop/brands_insurance.rb

@@ -5,11 +5,12 @@ require 'yaml'
 
 module RuboCop
   module BrandsInsurance
-    class Error < StandardError; end
-    # Your code goes here...
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    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
+    CONFIG = ::YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end

data/lib/rubocop/cop/brands_insurance/generator/cop_readme_injector.rb

@@ -6,7 +6,7 @@ module RuboCop
       class Generator
         class CopReadmeInjector < DeptReadmeInjector
           TEMPLATE =
-            '* xref:./%<cop_folder>s/README.adoc[``%<department>s/%<cop>s``]'
+            '* xref:./%{cop_folder}/README.adoc[``%{department}/%{cop}``]'
 
           # :nodoc:
           def initialize(badge:, **kwargs)
@@ -17,8 +17,10 @@ module RuboCop
 
           private
 
+            # @return [String]
             attr_reader :cop
 
+            # @see super
             def new_readme_entry
               format(TEMPLATE, {
                 department_folder: snake_case(department),
@@ -28,6 +30,7 @@ module RuboCop
               })
             end
 
+            # @see super
             def line_is_good?(line)
               return true if super
 
@@ -37,6 +40,7 @@ module RuboCop
               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

data/lib/rubocop/cop/brands_insurance/generator/dept_readme_injector.rb

@@ -5,7 +5,7 @@ module RuboCop
     module BrandsInsurance
       class Generator
         class DeptReadmeInjector
-          TEMPLATE = '* xref:./docs/cops/%<department_folder>s/README.adoc[``%<department>s``]'
+          TEMPLATE = '* xref:./docs/cops/%{department_folder}/README.adoc[``%{department}``]'
 
           # :nodoc:
           def initialize(readme_file_path:, badge:, department:)
@@ -15,13 +15,19 @@ module RuboCop
             @output = output
           end
 
-          # :nodoc:
-          def inject
+          # 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}")
+              readme_entries.push(new_readme_entry)
             end
 
             File.write(readme_file_path, readme_entries.join(''))
@@ -31,12 +37,27 @@ module RuboCop
 
           private
 
-            attr_reader :readme_file_path, :badge, :department, :output
+            # @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),
@@ -44,6 +65,10 @@ module RuboCop
               })
             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)
@@ -52,6 +77,10 @@ module RuboCop
               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?
@@ -59,10 +88,18 @@ module RuboCop
               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')

data/lib/rubocop/cop/brands_insurance/generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative './generator/dept_readme_injector'
+
 require_relative './generator/cop_readme_injector'
 
 module RuboCop
@@ -53,8 +54,8 @@ module RuboCop
 
           module RuboCop
             module Cop
-              module %<department>s
-                class %<cop_name>s < Base
+              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.
@@ -82,12 +83,10 @@ module RuboCop
             end
           end
         RUBY
-        README_ADDED_MESSAGE =
-          '[modify] A link for the %<dept_vs_cop>s has been added into ' \
-          '%<readme_file_path>s.'
+        README_ADDED_MESSAGE = '[modify] A link for the %{dept_vs_cop} has been added into %{readme_file_path}.'
 
         DEPT_README_TEMPLATE = <<~ADOC
-          = %<department>s
+          = %{department}
 
           Describe the department here
 
@@ -95,7 +94,7 @@ module RuboCop
 
         ADOC
         COP_README_TEMPLATE = <<~ADOC
-          = ``%<department>s/%<cop_name>s``
+          = ``%{department}/%{cop_name}``
 
           == Description
 
@@ -128,6 +127,7 @@ module RuboCop
           https://github.com/BrandsInsurance/expert-chainsaw/issues
         ADOC
 
+        # :nodoc:
         def initialize(name, output: $stdout)
           name = ['BrandsInsurance', name].join('/') unless name.start_with?('BrandsInsurance/')
 
@@ -157,16 +157,31 @@ module RuboCop
           @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.exists?(dept_docs_path)
+          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(
@@ -175,11 +190,16 @@ module RuboCop
             department: department
           )
 
-          injector.inject do
+          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(
@@ -188,25 +208,41 @@ module RuboCop
             department: department
           )
 
-          injector.inject do
+          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 Brands prefix
+          #
+          # @return [String]
+          #
           def department
             badge.department_name.gsub('BrandsInsurance/', '')
           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,
@@ -215,6 +251,10 @@ module RuboCop
             })
           end
 
+          # Path to <department>/README.adoc
+          #
+          # @return [String]
+          #
           def dept_docs_path
             File.join(
               'docs',
@@ -224,12 +264,16 @@ module RuboCop
             )
           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)}",
+              snake_case(badge.cop_name.to_s),
               'README.adoc'
             )
           end

data/lib/rubocop/cop/brands_insurance/style/disallowed_methods.rb

@@ -4,28 +4,6 @@ module RuboCop
   module Cop
     module BrandsInsurance
       module Style
-        # @example EnforcedStyle: foo
-        #   # Description of the `foo` style.
-        #
-        #   # bad
-        #   abort
-        #
-        #   # bad
-        #   abort(args)
-        #
-        #   # bad
-        #   tap {}
-        #
-        #   # bad
-        #   tap do
-        #   end
-        #
-        #   # good
-        #   raise
-        #
-        #   # good
-        #   raise(args)
-        #
         class DisallowedMethods < RuboCop::Cop::Base
           # 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
@@ -34,7 +12,7 @@ module RuboCop
           MESSAGES = {
             abort: 'Use `#raise` instead of `#abort`.',
             tap: 'Do not use `#tap`'
-          }
+          }.freeze
 
           # `on_send` will only be called if the method name is in this list
           RESTRICT_ON_SEND = %i[abort tap].freeze
@@ -49,7 +27,10 @@ module RuboCop
             (send nil? :tap ...)
           PATTERN
 
-          # :nodoc:
+          # The main logic method of the cop
+          #
+          # @return [void]
+          #
           def on_send(node)
             message =
               if using_abort?(node)

data/lib/rubocop-brands_insurance.rb

@@ -3,9 +3,9 @@
 require 'rubocop'
 
 require_relative 'rubocop/brands_insurance'
-require_relative 'rubocop/cop/brands_insurance/generator'
 require_relative 'rubocop/brands_insurance/inject'
 require_relative 'rubocop/brands_insurance/version'
+require_relative 'rubocop/cop/brands_insurance/generator'
 
 RuboCop::BrandsInsurance::Inject.defaults!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-brands_insurance
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre.rc.4
+  version: 0.0.2.pre.rc.5
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop