rubomatic-html 1.1.0.pre.rc.4 → 1.1.0.pre.rc.5

data/lib/rubomatic-html/inject.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  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

data/lib/rubomatic-html/runner.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'yaml'
+
+module RubomaticHtml
+  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)
+
+  class Config < RuboCop::Config
+  end
+
+  class ConfigLoader < RuboCop::ConfigLoader
+  end
+
+  class Error < StandardError
+  end
+
+  class Runner
+    # @return [Array<String>]
+    attr_accessor :files_to_lint
+    # @return [Hash]
+    attr_accessor :config
+
+    # @param linted_files [Array<String>]
+    #
+    def initialize(linted_files)
+      files_to_lint = Array(linted_files)
+
+      if files_to_lint.empty?
+        files_to_lint = Dir[File.join('app', 'views', '**', '*')]
+      end
+
+      @files_to_lint = files_to_lint
+
+      custom_config = ::YAML.safe_load(Pathname.new('.rubomatic-html.yml').read).freeze
+      config = {}
+      base_transformations = { 'Enabled' => :enabled, 'Exclude' => :exclude }
+
+      CONFIG.each do |cop_name, cop_config|
+        the_cop = all_cops.find { |cop| cop.name == cop_name }
+        transformations = base_transformations.merge(the_cop&.allowed_config_transform || {})
+        config[cop_name] = {}
+
+        transformations.each do |allowed_node, ruby_node|
+          config[cop_name][ruby_node] = cop_config[allowed_node] if cop_config.has_key?(allowed_node)
+
+          next unless custom_config.fetch(cop_name, {}).has_key?(allowed_node)
+
+          config[cop_name][ruby_node] = custom_config.dig(cop_name, allowed_node)
+        end
+
+        config[cop_name][:exclude] = Array(config[cop_name][:exclude])
+      end
+
+      @config = config
+    end
+
+    # Runs all cops against all files
+    #
+    # @return [void]
+    #
+    def run
+      all_config = config.fetch('AllCops')
+
+      files_to_lint.each do |file|
+        next if all_config.fetch(:exclude).any? { |ignored| file.end_with?(ignored) }
+
+        ext = File.extname(file)
+
+        next if ext.match?(/haml/i)
+
+        check_it = ext.match?(/html/i)
+        check_it ||= ext.match?(/erb\z/i)
+
+        next unless check_it
+
+        run_file(file)
+      end
+    end
+
+    private
+
+      # List of all cops available
+      #
+      # @return [Array<*>]
+      #
+      def all_cops
+        @all_cops ||= RubomaticHtml::Cop.constants.flat_map do |mod_name|
+          RubomaticHtml::Cop.const_get(mod_name).constants.filter_map do |klass_name|
+            klass = RubomaticHtml::Cop.const_get(mod_name).const_get(klass_name)
+
+            next if klass.abstract_cop?
+
+            klass
+          end
+        end
+      end
+
+      # Runs all cops against a given file
+      #
+      # @param file [String]
+      #
+      # @return [void]
+      #
+      def run_file(file)
+        cops = all_cops.filter_map do |cop|
+          cop_config = config.fetch(cop.name, {})
+
+          next unless cop_config.dig(:enabled)
+
+          cop.new(file, cop_config)
+        end
+
+        return if cops.empty?
+
+        File.open(file).each_line(chomp: true).with_index(1) do |line, index|
+          cops.each do |cop|
+            next if config.dig(cop.class.name).fetch(:exclude, []).any? { |ignored| file.end_with?(ignored) }
+
+            cop.run_for_line(line, index)
+          end
+        end
+      end
+  end
+end

data/lib/rubomatic-html/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  VERSION = '1.1.0-rc.5'
+end

data/lib/rubomatic-html.rb

@@ -1,3 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'rubomatic/html'
+require 'pathname'
+
+require_relative 'rubomatic-html/generator'
+require_relative 'rubomatic-html/runner'
+require_relative 'rubomatic-html/version'
+
+require_relative 'rubomatic-html/inject'
+
+RubomaticHtml::Inject.defaults!
+
+require_relative 'rubomatic-html/cop/cops'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rubomatic-html
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.rc.4
+  version: 1.1.0.pre.rc.5
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubomatic
+  name: rubocop-rubomatic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
+        version: 1.0.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.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.0'
 description: 
 email:
 - documents@brandsinsurance.com
@@ -41,19 +47,42 @@ files:
 - docs/cops/layout/multiple_line_breaks/README.adoc
 - docs/cops/layout/trailing_whitespace/README.adoc
 - docs/cops/style/README.adoc
+- docs/cops/style/no_fields_for/README.adoc
+- docs/cops/style/no_form_for/README.adoc
+- docs/cops/style/no_form_tag/README.adoc
+- docs/cops/style/no_on_before_unload/README.adoc
+- docs/cops/style/no_on_click/README.adoc
+- docs/cops/style/no_on_drag/README.adoc
+- docs/cops/style/no_on_load/README.adoc
+- docs/cops/style/no_on_unload/README.adoc
+- docs/cops/style/no_on_wheel/README.adoc
 - docs/cops/style/partial_instance_variable/README.adoc
 - exe/rubomatic-html
 - lib/rubomatic-html.rb
-- lib/rubomatic/html.rb
-- lib/rubomatic/html/cop/base.rb
-- lib/rubomatic/html/cop/cops.rb
-- lib/rubomatic/html/cop/layout/base.rb
-- lib/rubomatic/html/cop/layout/line_length.rb
-- lib/rubomatic/html/cop/layout/multiple_line_breaks.rb
-- lib/rubomatic/html/cop/layout/trailing_whitespace.rb
-- lib/rubomatic/html/cop/style/base.rb
-- lib/rubomatic/html/cop/style/partial_instance_variable.rb
-- lib/rubomatic/html/version.rb
+- lib/rubomatic-html/cop/base.rb
+- lib/rubomatic-html/cop/cops.rb
+- lib/rubomatic-html/cop/layout/base.rb
+- lib/rubomatic-html/cop/layout/line_length.rb
+- lib/rubomatic-html/cop/layout/multiple_line_breaks.rb
+- lib/rubomatic-html/cop/layout/trailing_whitespace.rb
+- lib/rubomatic-html/cop/style/base.rb
+- lib/rubomatic-html/cop/style/no_fields_for.rb
+- lib/rubomatic-html/cop/style/no_form_for.rb
+- lib/rubomatic-html/cop/style/no_form_tag.rb
+- lib/rubomatic-html/cop/style/no_on_attribute.rb
+- lib/rubomatic-html/cop/style/no_on_before_unload.rb
+- lib/rubomatic-html/cop/style/no_on_click.rb
+- lib/rubomatic-html/cop/style/no_on_drag.rb
+- lib/rubomatic-html/cop/style/no_on_load.rb
+- lib/rubomatic-html/cop/style/no_on_unload.rb
+- lib/rubomatic-html/cop/style/no_on_wheel.rb
+- lib/rubomatic-html/cop/style/partial_instance_variable.rb
+- lib/rubomatic-html/generator.rb
+- lib/rubomatic-html/generator/cop_readme_injector.rb
+- lib/rubomatic-html/generator/dept_readme_injector.rb
+- lib/rubomatic-html/inject.rb
+- lib/rubomatic-html/runner.rb
+- lib/rubomatic-html/version.rb
 homepage: https://github.com/BrandsInsurance/expert-chainsaw/
 licenses:
 - MIT

data/lib/rubomatic/html/cop/base.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      class Base
-        # @return [String]
-        attr_accessor :file
-
-        # Name for cop
-        #
-        # @return [String]
-        #
-        def self.name
-          'Base'
-        end
-
-        # :nodoc:
-        def initialize(file)
-          @file = file
-        end
-
-        private
-
-          # Outputs filename:line_number locations of HTML files that trigger the cop
-          #
-          # @param _line [String] the line in the html
-          # @param _index [Integer] the 1-index of the line
-          #
-          # @return [void]
-          #
-          def run_for_line(_line, _index)
-            error_message = <<~TEXT
-            Warning: Method `run_for_line` needs overridden! Some cops may not display failing messages.
-            TEXT
-
-            puts("\e[33m#{error_message}\e[0m")
-          end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/cops.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'layout/base'
-require_relative 'layout/line_length'
-require_relative 'layout/multiple_line_breaks'
-require_relative 'layout/trailing_whitespace'
-require_relative 'style/base'
-require_relative 'style/partial_instance_variable'

data/lib/rubomatic/html/cop/layout/base.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Layout
-        class Base < Rubomatic::Html::Cop::Base
-          # Department for cop
-          #
-          # @return [String]
-          #
-          def self.department
-            'Layout'
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/layout/line_length.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Layout
-        class LineLength < Rubomatic::Html::Cop::Layout::Base
-          # Name for the cop
-          #
-          # @return [String]
-          #
-          def self.name
-            [department, 'LineLength'].join('/')
-          end
-
-          # @see super
-          def run_for_line(line, index)
-            return if line.size <= 120
-
-            puts("#{file}:#{index}: is over 120 characters")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/layout/multiple_line_breaks.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Layout
-        class MultipleLineBreaks < Rubomatic::Html::Cop::Layout::Base
-          # @return [Boolean] tracks multiple consecutive line breaks
-          attr_accessor :prev_break
-
-          # Name for the cop
-          #
-          # @return [String]
-          #
-          def self.name
-            [department, 'MultipleLineBreaks'].join('/')
-          end
-
-          # :nodoc:
-          def initialize(file)
-            super
-
-            @prev_break = false
-          end
-
-          # @see super
-          def run_for_line(line, index)
-            if prev_break && line.empty?
-              puts("#{file}:#{index}: has multiple line breaks")
-            elsif line.empty?
-              @prev_break = true
-            else
-              @prev_break = false
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/layout/trailing_whitespace.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Layout
-        class TrailingWhitespace < Rubomatic::Html::Cop::Layout::Base
-          # Name for the cop
-          #
-          # @return [String]
-          #
-          def self.name
-            [department, 'TrailingWhitespace'].join('/')
-          end
-
-          # @see super
-          def run_for_line(line, index)
-            return unless line.match?(/\s\z/i)
-
-            puts("#{file}:#{index}: has trailing whitespace")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/style/base.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Style
-        class Base < Rubomatic::Html::Cop::Base
-          # Department for cop
-          #
-          # @return [String]
-          #
-          def self.department
-            'Style'
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/cop/style/partial_instance_variable.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    module Cop
-      module Style
-        class PartialInstanceVariable < Rubomatic::Html::Cop::Style::Base
-          # Name for the cop
-          #
-          # @return [String]
-          #
-          def self.name
-            [department, 'PartialInstanceVariable'].join('/')
-          end
-
-          # @see super
-          def run_for_line(line, index)
-            return unless File.basename(file).match?(/^_/i)
-
-            return unless line.match?(/@/i)
-
-            puts("#{file}:#{index}: might use an instance variable")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic/html/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Rubomatic
-  module Html
-    VERSION = '1.1.0-rc.4'
-  end
-end

data/lib/rubomatic/html.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-require_relative 'html/cop/cops'
-require_relative 'html/version'
-require 'yaml'
-
-module Rubomatic
-  module Html
-    class Runner
-      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
-
-      # @return [Array<String>]
-      attr_accessor :files_to_lint
-      # @return [Hash]
-      attr_accessor :config
-
-      # @param linted_files [Array<String>]
-      #
-      def initialize(linted_files)
-        files_to_lint = Array(linted_files)
-
-        if files_to_lint.empty?
-          files_to_lint = Dir[File.join('app', 'views', '**', '*')]
-        end
-
-        @files_to_lint = files_to_lint
-
-        custom_config = ::YAML.safe_load(Pathname.new('.rubomatic-html.yml').read).freeze
-
-        config = {}
-
-        CONFIG.each do |cop, cop_config|
-          config[cop] = {}
-          config[cop][:enabled] = cop_config['Enabled']
-          config[cop][:exclude] = Array(cop_config['Exclude'])
-
-          if custom_config.fetch(cop, {}).has_key?('Enabled')
-            config[cop][:enabled] = custom_config[cop]['Enabled']
-          end
-
-          if custom_config.fetch(cop, {}).has_key?('Exclude')
-            config[cop][:exclude] = Array(custom_config[cop]['Exclude'])
-          end
-        end
-
-        @config = config
-      end
-
-      # Runs all cops against all files
-      #
-      # @return [void]
-      #
-      def run
-        all_config = config.fetch('AllCops')
-
-        files_to_lint.each do |file|
-          next if all_config.fetch(:exclude).any? { |ignored| file.end_with?(ignored) }
-
-          ext = File.extname(file)
-
-          next if ext.match?(/haml/i)
-
-          check_it = ext.match?(/html/i)
-          check_it ||= ext.match?(/erb\z/i)
-
-          next unless check_it
-
-          run_file(file)
-        end
-      end
-
-      private
-
-        # List of all cops available
-        #
-        # @return [Array<*>]
-        #
-        def all_cops
-          @all_cops ||= [
-            Rubomatic::Html::Cop::Layout::LineLength,
-            Rubomatic::Html::Cop::Layout::MultipleLineBreaks,
-            Rubomatic::Html::Cop::Layout::TrailingWhitespace,
-            Rubomatic::Html::Cop::Style::PartialInstanceVariable
-          ]
-        end
-
-        # Runs all cops against a given file
-        #
-        # @param file [String]
-        #
-        # @return [void]
-        #
-        def run_file(file)
-          cops = all_cops.filter_map do |cop|
-            next unless config.dig(cop.name, :enabled)
-
-            cop.new(file)
-          end
-
-          return if cops.empty?
-
-          File.open(file).each_line(chomp: true).with_index(1) do |line, index|
-            cops.each do |cop|
-              next if config.dig(cop.class.name).fetch(:exclude, []).any? { |ignored| file.end_with?(ignored) }
-
-              cop.run_for_line(line, index)
-            end
-          end
-        end
-    end
-  end
-end