rubomatic-html 1.0.0.pre.rc.1 → 1.0.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f2a32770e85334243d284515902d43d6b9ec393092ac0fed1b64427c89dd17
-  data.tar.gz: 16a9377107af3898f1ed1bf22032ae1b5a7aea3d329744005e83c4fd6b3b5a3f
+  metadata.gz: e6d3802d73770d3ccbae7d8e839acde0c32abfe1ef2c152055427314592ffa2e
+  data.tar.gz: f7178a5a78a6035d9753f857585b62d89715c8a4bc73ac14b0f6edeebb3384e2
 SHA512:
-  metadata.gz: 37fba14024cbbaea3e6ddb1375228c75b4a96714be1a0e6857afd6b107be8a55e6f647844ce283eab86275321c48024e0ab0cc77131ea7bc080bcbea2ed9fe0b
-  data.tar.gz: 96548eb6af14568262d2c5ac31dd651bc564e2a3f822f689f23c46f67faf99d82d8fb2623963c39ac1ea42a67c1648148aa535d464162f479957fae58bd80a85
+  metadata.gz: 7364fd3dc91a378fb3a8f90e6a6be658af69595e96dfd76aa31777860d872e8b1465a1a414d717cfb26c9e80a428b9cf18be481b5fdba73479ed5f63816c1319
+  data.tar.gz: ce4389c15e8c177e6b36aab2dca657af54dae5db0f8af505e2e081b6ca4ec859543438f58e67150b69b6b694b436219b31d6851f231607af6aff4fad674c8467

data/LICENSE.txt

@@ -1,20 +1,32 @@
-Copyright (c) 2023 Brands Insurance
+The Clear BSD License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2023 Brands Insurance Agency, Inc.
+All rights reserved.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+     * Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+     * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+     * Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from this
+     software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -44,6 +44,11 @@ app/views/shared/_global_email.html.erb
 app/views/shared/_global_email_text.text.erb
 ----
 
+== Departments
+
+* xref:./docs/cops/layout/README.adoc[``Layout``]
+* xref:./docs/cops/style/README.adoc[``Style``]
+
 == Changelog
 
 See xref:./CHANGELOG.adoc[CHANGELOG] see see changes

data/config/default.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+
+Layout/MultipleLineBreaks:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Style/PartialInstanceVariable:
+  Enabled: true

data/docs/cops/layout/README.adoc

@@ -0,0 +1,9 @@
+= Layout
+
+Layout cops check for stylistic whitespace in your code
+
+== Cops
+
+* xref:./line_length/README.adoc[``Layout/LineLength``]
+* xref:./multiple_line_breaks/README.adoc[``Layout/MultipleLineBreaks``]
+* xref:./trailing_whitespace/README.adoc[``Layout/TrailingWhitespace``]

data/docs/cops/layout/line_length/README.adoc

@@ -0,0 +1,29 @@
+= ``Layout/LineLength``
+
+== Description
+
+Alerts when you have lines in your ``html`` files longer than ``120`` characters
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<%= render({ partial: 'policies/equipment_policies/partials/index_table', locals: { company: company, profile: profile, policy: policy, unit: unit, active: active } }) %>
+
+<!-- Good -->
+<%=
+  render({
+    partial: 'policies/equipment_policies/partials/index_table',
+    locals: { company: company, profile: profile, policy: policy, unit: unit, active: active }
+  })
+%>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/136

data/docs/cops/layout/multiple_line_breaks/README.adoc

@@ -0,0 +1,29 @@
+= ``Layout/MultipleLineBreaks``
+
+== Description
+
+Alerts when you have multiple consecutive line breaks your ``html`` files
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<% a = 1 %>
+
+
+<% b = 2 %>
+
+<!-- Good -->
+<% a = 1 %>
+
+<% b = 2 %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* N/A

data/docs/cops/layout/trailing_whitespace/README.adoc

@@ -0,0 +1,24 @@
+= ``Layout/TrailingWhitespace``
+
+== Description
+
+Alerts when you have trailing whitespace in your ``html`` files
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad -->
+<% a = 1 %>[space]
+
+<!-- Good -->
+<% a = 1 %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/blob/main/ruby/RUBY_STYLE_GUIDE.adoc#no-trailing-whitespace

data/docs/cops/style/README.adoc

@@ -0,0 +1,7 @@
+= Style
+
+Style cops check for stylistic consistency of your code
+
+== Cops
+
+* xref:./partial_instance_variable/README.adoc[``Style/PartialInstanceVariable``]

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

@@ -0,0 +1,24 @@
+= ``Style/PartialInstanceVariable``
+
+== Description
+
+Instance variables should not be used within partials
+
+== Examples
+
+[source,rhtml]
+----
+<!-- Bad (app/views/profiles/partials/_show.html.erb) -->
+<%= @profile.id %>
+
+<!-- Bad (app/views/profiles/partials/_show.html.erb) -->
+<%= profile.id %>
+----
+
+== Configurable Attributes
+
+There are no configurable attributes
+
+== References
+
+* https://github.com/BrandsInsurance/expert-chainsaw/issues/466

data/exe/rubomatic-html

@@ -1,24 +1,21 @@
 #!/usr/bin/env ruby
 
-require 'rubomatic-html'
+# frozen_string_literal: true
+
 require 'optparse'
+require 'rubomatic-html'
 
 options = {}
-parser = OptionParser.new do |parser|
+
+parsed = OptionParser.new do |parser|
   parser.on(
     '-l',
     '--linting-files comma,separated,list,of,files',
     Array,
     'List of files to lint. Defaults to check everything in app/views'
   )
-
-  parser.on(
-    '-i',
-    '--ignored-files comma,separated,list,of,files',
-    Array,
-    'List of files to ignore. Additionally ignores contents of .rubomatic_html_ignore'
-  )
 end
-parser.parse!(into: options)
 
-RubomaticHtml::Runner.new(options[:'linting-files'], options.fetch(:'ignored-files', [])).run
+parsed.parse!(into: options)
+
+RubomaticHtml::Runner.new(options[:'linting-files']).run

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

@@ -4,9 +4,10 @@ module RubomaticHtml
   module Cop
     module Layout
       class MultipleLineBreaks < RubomaticHtml::Cop::Base
-        # @return [Boolean]
+        # @return [Boolean] tracks multiple consecutive line breaks
         attr_accessor :prev_break
 
+        # :nodoc:
         def initialize(file)
           super
 
@@ -15,9 +16,9 @@ module RubomaticHtml
 
         # @see super
         def run_for_line(line, index)
-          if prev_break && line.size.zero?
+          if prev_break && line.empty?
             puts("#{file}:#{index}: has multiple line breaks")
-          elsif line.size.zero?
+          elsif line.empty?
             @prev_break = true
           else
             @prev_break = false

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

@@ -7,6 +7,7 @@ module RubomaticHtml
         # @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")

data/lib/rubomatic-html/version.rb

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

data/lib/rubomatic-html.rb

@@ -1,26 +1,23 @@
 # frozen_string_literal: true
 
-require_relative 'rubomatic-html/version'
 require_relative 'rubomatic-html/cop/cops'
+require_relative 'rubomatic-html/version'
+require 'yaml'
 
 module RubomaticHtml
   class Runner
     # @return [Array<String>]
     attr_accessor :files_to_lint
-    # @return [Array<String>]
-    attr_accessor :files_to_ignore
+    # @return [Hash]
+    attr_accessor :config
+
+    PROJECT_ROOT = Pathname.new(__dir__).parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG = ::YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     # @param linted_files [Array<String>]
-    # @param ignored_files [Array<String>]
     #
-    def initialize(linted_files, ignored_files)
-      files_to_ignore = Array(ignored_files)
-      ignore_file = '.rubomatic_html_ignore'
-
-      if File.exist?(ignore_file)
-        files_to_ignore += File.readlines(ignore_file, chomp: true)
-      end
-
+    def initialize(linted_files)
       files_to_lint = Array(linted_files)
 
       if files_to_lint.empty?
@@ -28,14 +25,38 @@ module RubomaticHtml
       end
 
       @files_to_lint = files_to_lint
-      @files_to_ignore = files_to_ignore
+
+      custom_config = ::YAML.safe_load('.rubomatic-html.yml').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 files_to_ignore.any? { |ignored| file.end_with?(ignored) }
+        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)
@@ -49,6 +70,10 @@ module RubomaticHtml
 
     private
 
+      # List of all cops available
+      #
+      # @return [Array<*>]
+      #
       def all_cops
         @all_cops ||= [
           RubomaticHtml::Cop::Layout::LineLength,
@@ -58,11 +83,25 @@ module RubomaticHtml
         ]
       end
 
+      # Runs all cops against a given file
+      #
+      # @param file [String]
+      #
+      # @return [void]
+      #
       def run_file(file)
-        cops = all_cops.map { |cop| cop.new(file) }
+        cops = all_cops.filter_map do |cop|
+          next unless config.dig(cop.to_s, :enabled)
+
+          cop.new(file)
+        end
 
         File.open(file).each_line(chomp: true).with_index(1) do |line, index|
-          cops.each { |cop| cop.run_for_line(line, index) }
+          cops.each do |cop|
+            next if config.dig(cop.to_s).fetch(:exclude, []).any? { |ignored| file.end_with?(ignored) }
+
+            cop.run_for_line(line, index)
+          end
         end
       end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubomatic-html
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.1
+  version: 1.0.0.pre.rc.2
 platform: ruby
 authors:
 - Brands Insurance
@@ -35,6 +35,13 @@ files:
 - CHANGELOG.adoc
 - LICENSE.txt
 - README.adoc
+- config/default.yml
+- docs/cops/layout/README.adoc
+- docs/cops/layout/line_length/README.adoc
+- docs/cops/layout/multiple_line_breaks/README.adoc
+- docs/cops/layout/trailing_whitespace/README.adoc
+- docs/cops/style/README.adoc
+- docs/cops/style/partial_instance_variable/README.adoc
 - exe/rubomatic-html
 - lib/rubomatic-html.rb
 - lib/rubomatic-html/cop/base.rb