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

data/lib/rubomatic-html/cop/style/no_on_before_unload.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnBeforeUnload < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnBeforeUnload'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'onbeforeunload'
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/cop/style/no_on_click.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnClick < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnClick'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'onclick'
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/cop/style/no_on_drag.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnDrag < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnDrag'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'ondrag'
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/cop/style/no_on_load.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnLoad < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnLoad'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'onload'
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/cop/style/no_on_unload.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnUnload < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnUnload'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'onunload'
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/cop/style/no_on_wheel.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnWheel < RubomaticHtml::Cop::Style::NoOnAttribute
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoOnWheel'].join('/')
+          end
+        end
+
+        def initialize(...)
+          super(...)
+
+          @html_attr = 'onwheel'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class PartialInstanceVariable < RubomaticHtml::Cop::Style::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'PartialInstanceVariable'].join('/')
+          end
+
+          # @see super
+          def allowed_config_transform
+            super.merge({ 'AllowedIdentifiers' => :allowed_identifiers }).freeze
+          end
+        end
+
+        # @see super
+        def run_for_line(line, index)
+          return unless File.basename(file).match?(/^_/i)
+
+          return unless line.match?(/@/i)
+
+          return if allowed_identifiers.any? { |ai| line[/@.+/].start_with?(ai) }
+
+          puts("#{file}:#{index}: uses an instance variable")
+        end
+
+        private
+
+          # @return [Array<String>]
+          def allowed_identifiers
+            @allowed_identifiers ||= Array(config.dig(:allowed_identifiers))
+          end
+      end
+    end
+  end
+end

data/lib/rubomatic-html/generator/cop_readme_injector.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  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:\./[a-z_]+/README\.adoc\[``(?<department>[a-zA-Z_]+)/(?<cop>[a-zA-Z_]+)``\]}
+        end
+    end
+  end
+end

data/lib/rubomatic-html/generator/dept_readme_injector.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  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
+        if readme_entries.none?("#{new_readme_entry}\n")
+          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
+        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_index do |line|
+            line_is_good?(line)
+          end
+        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

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