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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f52910879670f3735917444c9f07cdd5e48482e86eee31dfba5e9ef5a07d6592
-  data.tar.gz: b17f6e50c324ebe35f6c17eff1bb3668dfe7c83c4eb1ef80bae75dd37e370e58
+  metadata.gz: fd0788abe92f1ce7b30f70b80dca3989326ffa0964089f2808f521b431fbc5d2
+  data.tar.gz: 330b67698bd843a99d5d73fcbfdcfa06d08e83d75f06d4b60bf024ad2ead084d
 SHA512:
-  metadata.gz: f3ec93a413b3b553b534b9930ac33cd3a012b74cbd896c6cf4a2db34c367c40737a7ccdbcdf7a01cf5f45e8b64c4c95a11f8391e48ad464b9a2306ccdaf8611a
-  data.tar.gz: accb7976c86bf9f8fad66fb5db53f1586d33879ef8f5a1bbb9193e97369150fc5006e6ca19d000774451dce7e679259d473b8d6088c0b6c1e64a12ed2a1cac7b
+  metadata.gz: 3a82588b0c97eccdb4e134c83632336a6a17756433854a9fadb5f4c8903a1854cb18bb9eca6e1e21d265c08c11128aaa0764c8ead18cb19fe956dfcad840a5eb
+  data.tar.gz: 82941e83f8c42590ce369de7850af9fce9da621b459162ce36fa3a2a306bb2bc258439915d0e79720334449a8d2571a0ce420f1b03690520f1c7c1e5a495b6ae

data/CHANGELOG.adoc

@@ -1,3 +1,27 @@
-== 0.1.0
+== 1.1.0
+
+=== New Cops
+
+* Added ``Style/NoOnClick``
+* Added ``Style/NoOnBeforeUnload``
+* Added ``Style/NoOnClick``
+* Added ``Style/NoOnDrag``
+* Added ``Style/NoOnLoad``
+* Added ``Style/NoOnUnload``
+* Added ``Style/NoOnWheel``
+* Added ``Style/NoFieldsFor``
+* Added ``Style/NoFormFor``
+* Added ``Style/NoFormTag``
+
+=== New Options
+
+* Added ``AllowedIdentifiers`` option to ``Style/PartialInstanceVariable``
+
+== 1.0.1
+
+* Fix
+** No need to ``require 'bundler/setup'`` in script
+
+== 1.0.0
 
 * Initial release

data/config/default.yml

@@ -10,5 +10,33 @@ Layout/MultipleLineBreaks:
 Layout/TrailingWhitespace:
   Enabled: true
 
+Style/NoFieldsFor:
+  Enabled: true
+
+Style/NoFormFor:
+  Enabled: true
+
+Style/NoFormTag:
+  Enabled: true
+
+Style/NoOnBeforeUnload:
+  Enabled: true
+
+Style/NoOnClick:
+  Enabled: true
+
+Style/NoOnDrag:
+  Enabled: true
+
+Style/NoOnLoad:
+  Enabled: true
+
+Style/NoOnUnload:
+  Enabled: true
+
+Style/NoOnWheel:
+  Enabled: true
+
 Style/PartialInstanceVariable:
   Enabled: true
+  AllowedIdentifiers: [ ]

data/docs/cops/style/README.adoc

@@ -4,4 +4,13 @@ Style cops check for stylistic consistency of your code
 
 == Cops
 
+* xref:./no_fields_for/README.adoc[``Style/NoFieldsFor``]
+* xref:./no_form_for/README.adoc[``Style/NoFormFor``]
+* xref:./no_form_tag/README.adoc[``Style/NoFormTag``]
+* xref:./no_on_before_unload/README.adoc[``Style/NoOnBeforeUnload``]
+* xref:./no_on_click/README.adoc[``Style/NoOnClick``]
+* xref:./no_on_drag/README.adoc[``Style/NoOnDrag``]
+* xref:./no_on_load/README.adoc[``Style/NoOnLoad``]
+* xref:./no_on_unload/README.adoc[``Style/NoOnUnload``]
+* xref:./no_on_wheel/README.adoc[``Style/NoOnWheel``]
 * xref:./partial_instance_variable/README.adoc[``Style/PartialInstanceVariable``]

data/docs/cops/style/no_fields_for/README.adoc

@@ -0,0 +1,28 @@
+= ``Style/NoFieldsFor``
+
+== Description
+
+``fields_for`` should be replaced with ``fields``
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<%= fields_for(:policies, policy, { index: policy.id }) do |pol_form| %>
+  <!-- Content -->
+<% end %>
+
+<!-- Good -->
+<%= fields(:policies, model: policy, index: policy.id) do |pol_form| %>
+  <!-- Content -->
+<% end %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/rubomatic-html/issues/8

data/docs/cops/style/no_form_for/README.adoc

@@ -0,0 +1,28 @@
+= ``Style/NoFormFor``
+
+== Description
+
+``form_for`` should be replaced with ``form_with``
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<%= form_for(policy) do |pol_form| %>
+  <!-- Content -->
+<% end %>
+
+<!-- Good -->
+<%= form_with(model: policy) do |pol_form| %>
+  <!-- Content -->
+<% end %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/rubomatic-html/issues/8

data/docs/cops/style/no_form_tag/README.adoc

@@ -0,0 +1,28 @@
+= ``Style/NoFormTag``
+
+== Description
+
+``form_tag`` should be replaced with ``form_with``
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<%= form_tag(policy_path(policy)) do %>
+  <!-- Content -->
+<% end %>
+
+<!-- Good -->
+<%= form_with(url: policy_path(policy)) do |form_helper| %>
+  <!-- Content -->
+<% end %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/rubomatic-html/issues/8

data/docs/cops/style/no_on_before_unload/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnBeforeUnload``
+
+== Description
+
+``onbeforeunload`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<body onbeforeunload="alert('Hello')">Beforeunload me</body>
+<%= content_tag(:body, 'Beforeunload me', onbeforeunload: "alert('Hello')") %>
+<%= content_tag(:body, 'Beforeunload me', 'onbeforeunload' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<body>Beforeunload me</body>
+<%= content_tag(:body, 'Beforeunload me') %>
+<%= content_tag(:body, 'Beforeunload me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/docs/cops/style/no_on_click/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnClick``
+
+== Description
+
+``onclick`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<button type="button" onclick="alert('Hello')">Click me</button>
+<%= button_tag('Click me', onclick: "alert('Hello')") %>
+<%= button_tag('Click me', 'onclick' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<button type="button">Click me</button>
+<%= button_tag('Click me') %>
+<%= button_tag('Click me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/docs/cops/style/no_on_drag/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnDrag``
+
+== Description
+
+``ondrag`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<div ondrag="alert('Hello')">Drag me</div>
+<%= content_tag(:div, 'Drag me', ondrag: "alert('Hello')") %>
+<%= content_tag(:div, 'Drag me', 'ondrag' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<div>Drag me</div>
+<%= content_tag(:div, 'Drag me') %>
+<%= content_tag(:div, 'Drag me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/docs/cops/style/no_on_load/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnLoad``
+
+== Description
+
+``onload`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<body onload="alert('Hello')">Load me</body>
+<%= content_tag(:body, 'Load me', onload: "alert('Hello')") %>
+<%= content_tag(:body, 'Load me', 'onload' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<body>Load me</body>
+<%= content_tag(:body, 'Load me') %>
+<%= content_tag(:body, 'Load me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/docs/cops/style/no_on_unload/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnUnload``
+
+== Description
+
+``onunload`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<body onunload="alert('Hello')">Unload me</body>
+<%= content_tag(:body, 'Unload me', onunload: "alert('Hello')") %>
+<%= content_tag(:body, 'Unload me', 'onunload' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<body>Unload me</body>
+<%= content_tag(:body, 'Unload me') %>
+<%= content_tag(:body, 'Unload me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/docs/cops/style/no_on_wheel/README.adoc

@@ -0,0 +1,29 @@
+= ``Style/NoOnWheel``
+
+== Description
+
+``onwheel`` attributes should not be used
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<div onwheel="alert('Hello')">Wheel me</div>
+<%= content_tag(:div, 'Wheel me', onwheel: "alert('Hello')") %>
+<%= content_tag(:div, 'Wheel me', 'onwheel' => "alert('Hello')") %>
+
+<!-- Good -->
+<!-- Write code in javascript file to call alert('Hello') -->
+<div>wheel me</div>
+<%= content_tag(:div, 'Wheel me') %>
+<%= content_tag(:div, 'Wheel me') %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/234

data/exe/rubomatic-html

@@ -18,4 +18,4 @@ end
 
 parsed.parse!(into: options)
 
-Rubomatic::Html::Runner.new(options[:'linting-files']).run
+RubomaticHtml::Runner.new(options[:'linting-files']).run

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    class Base
+      # @return [String]
+      attr_accessor :file
+      # @return [Hash]
+      attr_accessor :config
+
+      class << self
+        # @return [Boolean]
+        def abstract_cop?
+          true
+        end
+
+        # Name for cop
+        #
+        # @return [String]
+        #
+        def name
+          'Base'
+        end
+
+        # Returns a hash whose keys represent the allowed config options and the values transform them from YML to ruby
+        #
+        # @return [Hash]
+        #
+        def allowed_config_transform
+          {}.freeze
+        end
+      end
+
+      # :nodoc:
+      def initialize(file, config)
+        @file = file
+        @config = config
+      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

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

@@ -0,0 +1,19 @@
+# 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/no_fields_for'
+require_relative 'style/no_form_for'
+require_relative 'style/no_form_tag'
+require_relative 'style/no_on_attribute'
+require_relative 'style/no_on_before_unload'
+require_relative 'style/no_on_click'
+require_relative 'style/no_on_drag'
+require_relative 'style/no_on_load'
+require_relative 'style/no_on_unload'
+require_relative 'style/no_on_wheel'
+require_relative 'style/partial_instance_variable'

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class LineLength < RubomaticHtml::Cop::Layout::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'LineLength'].join('/')
+          end
+        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

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class MultipleLineBreaks < RubomaticHtml::Cop::Layout::Base
+        # @return [Boolean] tracks multiple consecutive line breaks
+        attr_accessor :prev_break
+
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'MultipleLineBreaks'].join('/')
+          end
+        end
+
+        # :nodoc:
+        def initialize(...)
+          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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class TrailingWhitespace < RubomaticHtml::Cop::Layout::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'TrailingWhitespace'].join('/')
+          end
+        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

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoFieldsFor < RubomaticHtml::Cop::Style::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoFieldsFor'].join('/')
+          end
+        end
+
+        # @see super
+        def run_for_line(line, index)
+          return unless line.match?(/fields_for/i)
+
+          puts("#{file}:#{index}: calls `fields_for`. Use `fields` instead")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoFormFor < RubomaticHtml::Cop::Style::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoFormFor'].join('/')
+          end
+        end
+
+        # @see super
+        def run_for_line(line, index)
+          return unless line.match?(/form_for/i)
+
+          puts("#{file}:#{index}: calls `form_for`. Use `form_with` instead")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class NoFormTag < RubomaticHtml::Cop::Style::Base
+        class << self
+          # @see super
+          def abstract_cop?
+            false
+          end
+
+          # @see super
+          def name
+            [department, 'NoFormTag'].join('/')
+          end
+        end
+
+        # @see super
+        def run_for_line(line, index)
+          return unless line.match?(/form_tag/i)
+
+          puts("#{file}:#{index}: calls `form_tag`. Use `form_with` instead")
+        end
+      end
+    end
+  end
+end