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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoOnAttribute < RubomaticHtml::Cop::Style::Base
+        # @return [String]
+        attr_accessor :html_attr
+
+        # @see super
+        def run_for_line(line, index)
+          # `onclick:` or `onclick=`
+          has_on_click = line.match?(/#{html_attr}[:=]/i)
+
+          # `:onclick=>` or `:onclick =>`
+          has_on_click ||= line.match?(/:#{html_attr} ?=>/i)
+
+          # `'onclick'=>` or `'onclick' =>`
+          has_on_click ||= line.match?(/'#{html_attr}' ?=>/i)
+
+          # `"onclick"=>` or `"onclick" =>`
+          has_on_click ||= line.match?(/"#{html_attr}" ?=>/i)
+
+          return unless has_on_click
+
+          puts("#{file}:#{index}: might use an #{html_attr} attribute")
+        end
+      end
+    end
+  end
+end

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