rubomatic-html 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f93d8b1bd52c69097c04559276f39987693aca36f73cbd4f1d64f835426d0e33
-  data.tar.gz: 276af7014cc5aafcbdc1e98df823850eb1516ab128421b6490b1c71084d331f6
+  metadata.gz: de42c63dd8d7c9614c542c944569dc5605ec8203ecdeabafe10e1830968f6430
+  data.tar.gz: 8f145a25cde91e5b60e173f9d14ace922bfb0a88ccc6200b925afc4397afd95b
 SHA512:
-  metadata.gz: e1b07226346996ebb43ee9ae0be08175eb70dccb2725271c19cd628431039cb4ede751866b45c9f8799278082498cdc08c8d57df91d7f2e508892de3247d4702
-  data.tar.gz: ceae777ae5ad633569dab21ad02427738fab8cfaae146514837dce86c090f239e803dfafecdd5bf0bb63074e11e14547f891c661d6dd684d5f22869f4fe285c7
+  metadata.gz: cf883c5d6f31d92b2a16809f0a2fa7c34ce364e5bf98dd9bcb7977a3404ba21422e74f5282652d87766c38783fe6e4f54cbdfe4dfd7257a8308d53c81ea45681
+  data.tar.gz: 8aa6620bed7ef566f79d8d0053ceed56ee9b60a84307c9653b3a43bbdbc0988fbdbe38dceb420063ff4269d0082af225d0647657015e2de3fb2f38e7e2f35ccd

data/README.adoc

@@ -1,6 +1,8 @@
 = RubomaticHtml
 
-Gem for shared html linting for BrandsInsurance
+Gem for shared html linting for BrandsInsurance.
+
+Make sure ran from project root
 
 == Installation
 

data/exe/rubomatic-html

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'rubomatic-html'
+require 'optparse'
+
+options = {}
+parser = 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 .lint_html_ignore'
+  )
+end
+parser.parse!(into: options)
+
+RubomaticHtml::Runner.new(options[:'linting-files'], options.fetch(:'ignored-files', [])).run

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    class Base
+      # @return [String]
+      attr_accessor :file
+
+      # :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)
+        end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'layout/line_length'
+require_relative 'layout/trailing_whitespace'
+require_relative 'style/partial_instance_variable'

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class LineLength < RubomaticHtml::Cop::Base
+        # @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,29 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class MultipleLineBreaks < RubomaticHtml::Cop::Base
+        # @return [Boolean]
+        attr_accessor :prev_break
+
+        def initialize(file)
+          super
+
+          @prev_break = false
+        end
+
+        # @see super
+        def run_for_line(line, index)
+          if prev_break && line.size.zero?
+            puts("#{file}:#{index}: has multiple line breaks")
+          elsif line.size.zero?
+            @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,16 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Layout
+      class TrailingWhitespace < RubomaticHtml::Cop::Base
+        # @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/partial_instance_variable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubomaticHtml
+  module Cop
+    module Style
+      class PartialInstanceVariable < RubomaticHtml::Cop::Base
+        # @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 +1,5 @@
 # frozen_string_literal: true
 
 module RubomaticHtml
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/rubomatic_html.rb

@@ -1,6 +1,69 @@
 # frozen_string_literal: true
 
 require_relative 'rubomatic-html/version'
+require_relative 'rubomatic-html/cop/cops'
 
 module RubomaticHtml
+  class Runner
+    # @return [Array<String>]
+    attr_accessor :files_to_lint
+    # @return [Array<String>]
+    attr_accessor :files_to_ignore
+
+    # @param linted_files [Array<String>]
+    # @param ignored_files [Array<String>]
+    #
+    def initialize(linted_files, ignored_files)
+      files_to_ignore = Array(ignored_files)
+      ignore_file = '.lint_html_ignore'
+
+      if File.exist?(ignore_file)
+        files_to_ignore += File.readlines(ignore_file, chomp: true)
+      end
+
+      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
+      @files_to_ignore = files_to_ignore
+    end
+
+    def run
+      files_to_lint.each do |file|
+        next if files_to_ignore.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
+
+      def all_cops
+        @all_cops ||= [
+          RubomaticHtml::Cop::Layout::LineLength,
+          RubomaticHtml::Cop::Layout::MultipleLineBreaks,
+          RubomaticHtml::Cop::Layout::TrailingWhitespace,
+          RubomaticHtml::Cop::Style::PartialInstanceVariable
+        ]
+      end
+
+      def run_file(file)
+        cops = all_cops.map { |cop| cop.new(file) }
+
+        File.open(file).each_line(chomp: true).with_index(1) do |line, index|
+          cops.each { |cop| cop.run_for_line(line, index) }
+        end
+      end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubomatic-html
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubomatic
@@ -24,30 +24,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-brands_insurance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 description: 
 email:
 - documents@brandsinsurance.com
-executables: []
+executables:
+- rubomatic-html
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.adoc
 - LICENSE.txt
 - README.adoc
+- exe/rubomatic-html
+- lib/rubomatic-html/cop/base.rb
+- lib/rubomatic-html/cop/cops.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/partial_instance_variable.rb
 - lib/rubomatic-html/version.rb
 - lib/rubomatic_html.rb
 homepage: https://github.com/BrandsInsurance/expert-chainsaw/