erb_lint 0.0.26 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82be0f658ce3baab1198821bebab48ed006b10be
-  data.tar.gz: b7362a45f4b3a1c33f2fcc5be16c147fce73e04d
+  metadata.gz: '068550383b58968cb644751f43444a984065ac9c'
+  data.tar.gz: 78c31c8ce1a65a13a8b8a168437fa4142191d132
 SHA512:
-  metadata.gz: bb77c4fb3259e5bf91f6881cd573c328959c79c931ac5e8b1a589050a74d8b3167e651df93d40340f2080532f1121d65eddf4d6d8ef481a93d92e61d744e76d8
-  data.tar.gz: efabfee67363da1cd91591d7acd37098c06ae51da74e1d12a653e0d02965c82c5b996b839f2ba3c823830b7063ea6ee512ed16c73b6c063f3a98639f9f90f646
+  metadata.gz: 01530ffea26264a299ee8b0460887927e738479fd1f23dfda161877d2b391b0050cc6e7f880382becdba1b4e3f7310174e449886fd6d2047c59507e05a5cb7c1
+  data.tar.gz: 67c4dba8e9214bc5cbc11beed301d9fc5eaf09bbf6b4046038fcdc15173879b1165c82af351d9e4915c08a88dd209cc093e2e58ee8dcf074039c751b1fd7bb37

data/lib/erb_lint/cli.rb

@@ -6,7 +6,7 @@ require 'active_support/inflector'
 require 'optparse'
 require 'psych'
 require 'yaml'
-require 'colorize'
+require 'rainbow'
 
 module ERBLint
   class CLI
@@ -37,7 +37,9 @@ module ERBLint
 
       load_config
 
-      if lint_files.empty?
+      if !@files.empty? && lint_files.empty?
+        success!("no files found...\n")
+      elsif lint_files.empty?
         success!("no files given...\n#{option_parser}")
       end
 
@@ -57,7 +59,7 @@ module ERBLint
         rescue => e
           puts "Exception occured when processing: #{relative_filename(filename)}"
           puts e.message
-          puts e.backtrace.join("\n").red
+          puts Rainbow(e.backtrace.join("\n")).red
           puts
         end
       end
@@ -65,25 +67,27 @@ module ERBLint
       if @stats.corrected > 0
         corrected_found_diff = @stats.found - @stats.corrected
         if corrected_found_diff > 0
-          warn "#{@stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files".red
+          warn Rainbow(
+            "#{@stats.corrected} error(s) corrected and #{corrected_found_diff} error(s) remaining in ERB files"
+          ).red
         else
-          puts "#{@stats.corrected} error(s) corrected in ERB files".green
+          puts Rainbow("#{@stats.corrected} error(s) corrected in ERB files").green
         end
       elsif @stats.found > 0
-        warn "#{@stats.found} error(s) were found in ERB files".red
+        warn Rainbow("#{@stats.found} error(s) were found in ERB files").red
       else
-        puts "No errors were found in ERB files".green
+        puts Rainbow("No errors were found in ERB files").green
       end
 
       @stats.found == 0
     rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, ExitWithFailure => e
-      warn e.message.red
+      warn Rainbow(e.message).red
       false
     rescue ExitWithSuccess => e
       puts e.message
       true
     rescue => e
-      warn "#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}".red
+      warn Rainbow("#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}").red
       false
     end
 
@@ -120,7 +124,7 @@ module ERBLint
       @stats.found += runner.offenses.size
       runner.offenses.each do |offense|
         puts <<~EOF
-          #{offense.message}#{' (not autocorrected)'.red if autocorrect?}
+          #{offense.message}#{Rainbow(' (not autocorrected)').red if autocorrect?}
           In file: #{relative_filename(filename)}:#{offense.line_range.begin}
 
         EOF
@@ -139,10 +143,10 @@ module ERBLint
 
     def load_config
       if File.exist?(config_filename)
-        config = RunnerConfig.new(file_loader.yaml(config_filename))
+        config = RunnerConfig.new(file_loader.yaml(config_filename), file_loader)
         @config = RunnerConfig.default.merge(config)
       else
-        warn "#{config_filename} not found: using default config".yellow
+        warn Rainbow("#{config_filename} not found: using default config").yellow
         @config = RunnerConfig.default
       end
       @config.merge!(runner_config_override)
@@ -164,6 +168,7 @@ module ERBLint
         Dir[pattern].select { |filename| !excluded?(filename) }
       else
         @files
+          .map { |f| Dir.exist?(f) ? Dir[File.join(f, DEFAULT_LINT_ALL_GLOB)] : f }
           .map { |f| f.include?('*') ? Dir[f] : f }
           .flatten
           .map { |f| File.expand_path(f, Dir.pwd) }

data/lib/erb_lint/file_loader.rb

@@ -10,19 +10,14 @@ module ERBLint
     end
 
     def yaml(filename)
-      YAML.safe_load(read_content(filename), [Regexp], [], false, filename) || {}
-    rescue Psych::SyntaxError
-      {}
+      YAML.safe_load(read_content(filename), [Regexp, Symbol], [], false, filename) || {}
     end
 
     private
 
-    def join(filename)
-      File.join(base_path, filename)
-    end
-
     def read_content(filename)
-      File.read(join(filename))
+      path = File.expand_path(filename, base_path)
+      File.read(path)
     end
   end
 end

data/lib/erb_lint/linters/hard_coded_string.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require "set"
 require 'better_html/tree/tag'
 require 'active_support/core_ext/string/inflections'
 
@@ -11,20 +11,25 @@ module ERBLint
 
       ForbiddenCorrector = Class.new(StandardError)
       MissingCorrector = Class.new(StandardError)
+      MissingI18nLoadPath = Class.new(StandardError)
 
       ALLOWED_CORRECTORS = %w(
         I18nCorrector
-        RuboCop::I18nCorrector
+        RuboCop::Corrector::I18n::HardCodedString
       )
 
+      NON_TEXT_TAGS = Set.new(%w(script style xmp iframe noembed noframes listing))
+      BLACK_LISTED_TEXT = Set.new(%w(       ))
+
       class ConfigSchema < LinterConfig
         property :corrector, accepts: Hash, required: false, default: {}
+        property :i18n_load_path, accepts: String, required: false, default: ''
       end
       self.config_schema = ConfigSchema
 
       def run(processed_source)
         hardcoded_strings = processed_source.ast.descendants(:text).each_with_object([]) do |text_node, to_check|
-          next if javascript?(processed_source, text_node)
+          next if non_text_tag?(processed_source, text_node)
 
           offended_strings = text_node.to_a.select { |node| relevant_node(node) }
           offended_strings.each do |offended_string|
@@ -58,11 +63,10 @@ module ERBLint
         string = offense.source_range.source
         return unless klass = load_corrector
         return unless string.strip.length > 1
-
-        corrector = klass.new(processed_source.filename, offense.source_range)
+        corrector = klass.new(processed_source.filename, corrector_i18n_load_path, offense.source_range)
         node = RuboCop::AST::StrNode.new(:str, [string])
         corrector.autocorrect(node, tag_start: '<%= ', tag_end: ' %>')
-      rescue MissingCorrector
+      rescue MissingCorrector, MissingI18nLoadPath
         nil
       end
 
@@ -70,7 +74,7 @@ module ERBLint
 
       def check_string?(str)
         string = str.gsub(/\s*/, '')
-        string.length > 1 && !%w(&nbsp;).include?(string)
+        string.length > 1 && !BLACK_LISTED_TEXT.include?(string)
       end
 
       def load_corrector
@@ -81,7 +85,11 @@ module ERBLint
         corrector_name.safe_constantize
       end
 
-      def javascript?(processed_source, text_node)
+      def corrector_i18n_load_path
+        @config['corrector'].fetch('i18n_load_path') { raise MissingI18nLoadPath }
+      end
+
+      def non_text_tag?(processed_source, text_node)
         ast = processed_source.parser.ast.to_a
         index = ast.find_index(text_node)
 
@@ -90,7 +98,7 @@ module ERBLint
         if previous_node.type == :tag
           tag = BetterHtml::Tree::Tag.from_node(previous_node)
 
-          tag.name == "script" && !tag.closing?
+          NON_TEXT_TAGS.include?(tag.name) && !tag.closing?
         end
       end
 

data/lib/erb_lint/linters/no_javascript_tag_helper.rb

@@ -23,11 +23,12 @@ module ERBLint
           next if indicator == '#'
           source = code_node.loc.source
 
-          ruby_node = begin
-            BetterHtml::TestHelper::RubyNode.parse(source)
-          rescue ::Parser::SyntaxError
-            nil
-          end
+          ruby_node =
+            begin
+              BetterHtml::TestHelper::RubyNode.parse(source)
+            rescue ::Parser::SyntaxError
+              nil
+            end
           next unless ruby_node
           send_node = ruby_node.descendants(:send).first
           next unless send_node&.method_name?(:javascript_tag)

data/lib/erb_lint/linters/rubocop.rb

@@ -147,7 +147,7 @@ module ERBLint
       def base_configs(inherit_from)
         regex = URI::DEFAULT_PARSER.make_regexp(%w(http https))
         configs = Array(inherit_from).compact.map do |base_name|
-          if base_name =~ /\A#{regex}\z/
+          if base_name.match?(/\A#{regex}\z/)
             RuboCop::ConfigLoader.load_file(RuboCop::RemoteConfig.new(base_name, Dir.pwd))
           else
             config_from_hash(@file_loader.yaml(base_name))

data/lib/erb_lint/runner_config.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
+require 'erb_lint/runner_config_resolver'
+
 module ERBLint
   class RunnerConfig
     class Error < StandardError; end
 
-    def initialize(config = nil)
+    def initialize(config = nil, file_loader = nil)
       @config = (config || {}).dup.deep_stringify_keys
+
+      resolver.resolve_inheritance_from_gems(@config, @config.delete('inherit_gem'))
+      resolver.resolve_inheritance(@config, file_loader) if file_loader
+      @config.delete("inherit_from")
     end
 
     def to_hash
@@ -71,5 +77,9 @@ module ERBLint
       config_hash['exclude'].concat(global_exclude) if config_hash['exclude'].is_a?(Array)
       config_hash
     end
+
+    def resolver
+      @resolver ||= ERBLint::RunnerConfigResolver.new
+    end
   end
 end

data/lib/erb_lint/runner_config_resolver.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2012-18 Bozhidar Batsov
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# 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.
+
+module ERBLint
+  class RunnerConfigResolver
+    def resolve_inheritance(hash, file_loader)
+      inherited_files = Array(hash['inherit_from'])
+      base_configs(file_loader, inherited_files).reverse_each do |base_config|
+        base_config.each do |k, v|
+          next unless v.is_a?(Hash)
+          v = v.deep_merge(hash[k]) if hash.key?(k)
+          hash[k] = v
+        end
+      end
+    end
+
+    def resolve_inheritance_from_gems(hash, gems)
+      (gems || {}).each_pair do |gem_name, config_path|
+        raise(ArgumentError, "can't inherit configuration from the erb-lint gem") if gem_name == 'erb-lint'
+
+        hash['inherit_from'] = Array(hash['inherit_from'])
+        Array(config_path).reverse_each do |path|
+          # Put gem configuration first so local configuration overrides it.
+          hash['inherit_from'].unshift gem_config_path(gem_name, path)
+        end
+      end
+    end
+
+    private
+
+    def gem_config_path(gem_name, relative_config_path)
+      spec = Gem::Specification.find_by_name(gem_name)
+      File.join(spec.gem_dir, relative_config_path)
+    rescue Gem::LoadError => e
+      raise Gem::LoadError, "Unable to find gem #{gem_name}; is the gem installed? #{e}"
+    end
+
+    def base_configs(file_loader, inherit_from)
+      configs = Array(inherit_from).compact.map do |f|
+        inherited_file = File.expand_path(f, file_loader.base_path)
+        file_loader.yaml(inherited_file)
+      end
+      configs.compact
+    end
+  end
+end

data/lib/erb_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ERBLint
-  VERSION = '0.0.26'
+  VERSION = '0.0.27'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.27
 platform: ruby
 authors:
 - Justin Chan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,6 +159,7 @@ files:
 - lib/erb_lint/processed_source.rb
 - lib/erb_lint/runner.rb
 - lib/erb_lint/runner_config.rb
+- lib/erb_lint/runner_config_resolver.rb
 - lib/erb_lint/utils/block_map.rb
 - lib/erb_lint/utils/offset_corrector.rb
 - lib/erb_lint/utils/ruby_to_erb.rb
@@ -175,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="