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

data/lib/rubomatic-html/generator.rb

@@ -0,0 +1,330 @@
+# frozen_string_literal: true
+
+require_relative 'generator/dept_readme_injector'
+# require_relative 'generator/require_file_injector'
+
+require_relative 'generator/cop_readme_injector'
+
+module RubomaticHtml
+  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 RubomaticHtml
+        module Cop
+          module %{department}
+            class %{cop_name} < RubomaticHtml::Cop::%{department}::Base
+              class << self
+                # @see super
+                def abstract_cop?
+                  false
+                end
+
+                # @see super
+                def name
+                  [department, '%{cop_name}'].join('/')
+                end
+              end
+
+              # @see super
+              def run_for_line(line, index)
+                # TODO: Implement the cop in here.
+              end
+            end
+          end
+        end
+      end
+    RUBY
+    SPEC_TEMPLATE = <<~SPEC
+      # frozen_string_literal: true
+
+      RSpec.describe RubomaticHtml::Cop::%{department}::%{cop_name}, :config do
+        let(:config) { RubomaticHtml::Config.new }
+
+        # TODO: Write test code
+        #
+        # For example
+        it 'registers an offense when using `#bad_method`' do
+          expect_offense(<<~RHTML)
+            bad_method
+            ^^^^^^^^^^ Use `#good_method` instead of `#bad_method`.
+          RHTML
+        end
+
+        it 'does not register an offense when using `#good_method`' do
+          expect_no_offenses(<<~RHTML)
+            good_method
+          RHTML
+        end
+      end
+    SPEC
+    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,rhtml]
+      ----
+      <!-- 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)
+      @base_gen = RuboCop::Cop::Generator.new(name, output: output)
+    end
+
+    # @see RuboCop::Cop::generator method
+    def write_source
+      write_unless_file_exists(source_path, generated_source)
+    end
+
+    # @see RuboCop::Cop::generator method
+    def write_spec
+      write_unless_file_exists(spec_path, generated_spec)
+    end
+
+    # @see RuboCop::Cop::generator method
+    def generated_source
+      generate(SOURCE_TEMPLATE)
+    end
+
+    # @see RuboCop::Cop::generator method
+    def generated_spec
+      generate(SPEC_TEMPLATE)
+    end
+
+    # @see RuboCop::Cop::generator method
+    def source_path
+      File.join(
+        'lib',
+        'rubomatic-html',
+        'cop',
+        snake_case(badge.department.to_s),
+        "#{snake_case(badge.cop_name.to_s)}.rb"
+      )
+    end
+
+    # @see RuboCop::Cop::generator method
+    def spec_path
+      File.join(
+        'spec',
+        'rubomatic-html',
+        'cop',
+        snake_case(badge.department.to_s),
+        "#{snake_case(badge.cop_name.to_s)}_spec.rb"
+      )
+    end
+
+    # @see RuboCop::Cop::generator method
+    def inject_require(root_file_path:)
+      RuboCop::Cop::Generator::RequireFileInjector.new(source_path: source_path, root_file_path: root_file_path).inject
+    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
+
+      # @return [String]
+      def department
+        badge.department_name
+      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

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'
+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
 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
@@ -73,9 +102,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.15
 signing_key: 

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