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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7c76016bb1d33526a70bf322a25f55569c3d93a50bf3795bd7d4ded5c99fd7
-  data.tar.gz: c7e5015c673fab3d8c42cbafc3b3355a660c0786d1a5775a1797d838fd2f324d
+  metadata.gz: 3d985a291d36eb06963475488bcad31d4ef42b5287f39d8c471b51ac364d19fa
+  data.tar.gz: e940e2f30fa3c4d11ddb100838063b1e4d5ac34e27659e594d19ab82adc5e2c3
 SHA512:
-  metadata.gz: 305f5ad46e7711590c445f3b60edfa27960cfd985012b9929901c94b5137af2d1a9e70c173439420302dd29f3b72a1f3dddce3f8c8cbdbe02117bfaf6a0ed6ea
-  data.tar.gz: dd716790e59ac5c9fdca784ddddeb3d9231b6022862cd7ebd02887a5636a3646cf137521d7b6e509fdb58ce9e236fb605c4ff4f9bbb9f29b6f43107fb006e976
+  metadata.gz: 4452adb9001087bf0d0c7aa7d4faee2992fdb827b3267bf9159cb3f5b218405b437200d832b2915c249f2c23f61a7f29005fb6d38b0f5b0f4b24a3528d16ff8f
+  data.tar.gz: 74e8d74a3aeddc5e00123a080718eb8d63df37d77a2eac0f6bbe1d581a977eec0cd9915e43824ef5e95e1bdec0f0624176de63099bb43eb5163131185a217ad1

data/exe/rubomatic-html

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

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

@@ -0,0 +1,42 @@
+# 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/layout/base.rb

@@ -0,0 +1,19 @@
+# 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

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rubomatic
+  module Html
+    module Cop
+      module Layout
+        class LineLength < Rubomatic::Html::Cop::Layout::Base
+          # Name for the cop
+          #
+          # @return [String]
+          #
+          def self.name
+            [department, 'LineLength'].join('/')
+          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
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Rubomatic
+  module Html
+    module Cop
+      module Layout
+        class MultipleLineBreaks < Rubomatic::Html::Cop::Layout::Base
+          # @return [Boolean] tracks multiple consecutive line breaks
+          attr_accessor :prev_break
+
+          # Name for the cop
+          #
+          # @return [String]
+          #
+          def self.name
+            [department, 'MultipleLineBreaks'].join('/')
+          end
+
+          # :nodoc:
+          def initialize(file)
+            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
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rubomatic
+  module Html
+    module Cop
+      module Layout
+        class TrailingWhitespace < Rubomatic::Html::Cop::Layout::Base
+          # Name for the cop
+          #
+          # @return [String]
+          #
+          def self.name
+            [department, 'TrailingWhitespace'].join('/')
+          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
+end

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rubomatic
+  module Html
+    module Cop
+      module Style
+        class PartialInstanceVariable < Rubomatic::Html::Cop::Style::Base
+          # Name for the cop
+          #
+          # @return [String]
+          #
+          def self.name
+            [department, 'PartialInstanceVariable'].join('/')
+          end
+
+          # @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")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubomatic/html/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubomatic
+  module Html
+    VERSION = '1.1.0-rc.1'
+  end
+end

data/lib/rubomatic/html.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'html/cop/cops'
+require_relative 'html/version'
+require 'yaml'
+
+module Rubomatic
+  module Html
+    class Runner
+      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
+
+      # @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 = {}
+
+        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 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 ||= [
+            Rubomatic::Html::Cop::Layout::LineLength,
+            Rubomatic::Html::Cop::Layout::MultipleLineBreaks,
+            Rubomatic::Html::Cop::Layout::TrailingWhitespace,
+            Rubomatic::Html::Cop::Style::PartialInstanceVariable
+          ]
+        end
+
+        # Runs all cops against a given file
+        #
+        # @param file [String]
+        #
+        # @return [void]
+        #
+        def run_file(file)
+          cops = all_cops.filter_map do |cop|
+            next unless config.dig(cop.name, :enabled)
+
+            cop.new(file)
+          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
+end

data/lib/rubomatic-html.rb

@@ -1,113 +1,3 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require_relative 'rubomatic-html/cop/cops'
-require_relative 'rubomatic-html/version'
-require 'yaml'
-
-module RubomaticHtml
-  class Runner
-    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
-
-    # @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 = {}
-
-      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 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::Layout::LineLength,
-          RubomaticHtml::Cop::Layout::MultipleLineBreaks,
-          RubomaticHtml::Cop::Layout::TrailingWhitespace,
-          RubomaticHtml::Cop::Style::PartialInstanceVariable
-        ]
-      end
-
-      # Runs all cops against a given file
-      #
-      # @param file [String]
-      #
-      # @return [void]
-      #
-      def run_file(file)
-        cops = all_cops.filter_map do |cop|
-          next unless config.dig(cop.name, :enabled)
-
-          cop.new(file)
-        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
+require_relative 'rubomatic/html'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubomatic-html
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre.rc.1
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubomatic
@@ -44,15 +44,16 @@ files:
 - docs/cops/style/partial_instance_variable/README.adoc
 - exe/rubomatic-html
 - 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.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
 homepage: https://github.com/BrandsInsurance/expert-chainsaw/
 licenses:
 - MIT
@@ -72,9 +73,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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.15
 signing_key: 

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module RubomaticHtml
-  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

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

@@ -1,17 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module RubomaticHtml
-  module Cop
-    module Layout
-      class LineLength < RubomaticHtml::Cop::Layout::Base
-        # Name for the cop
-        #
-        # @return [String]
-        #
-        def self.name
-          [department, 'LineLength'].join('/')
-        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

@@ -1,38 +0,0 @@
-# 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
-
-        # Name for the cop
-        #
-        # @return [String]
-        #
-        def self.name
-          [department, 'MultipleLineBreaks'].join('/')
-        end
-
-        # :nodoc:
-        def initialize(file)
-          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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module RubomaticHtml
-  module Cop
-    module Layout
-      class TrailingWhitespace < RubomaticHtml::Cop::Layout::Base
-        # Name for the cop
-        #
-        # @return [String]
-        #
-        def self.name
-          [department, 'TrailingWhitespace'].join('/')
-        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

@@ -1,17 +0,0 @@
-# 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/partial_instance_variable.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RubomaticHtml
-  module Cop
-    module Style
-      class PartialInstanceVariable < RubomaticHtml::Cop::Style::Base
-        # Name for the cop
-        #
-        # @return [String]
-        #
-        def self.name
-          [department, 'PartialInstanceVariable'].join('/')
-        end
-
-        # @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")
-        end
-      end
-    end
-  end
-end

data/lib/rubomatic-html/version.rb

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