goodcheck 2.4.3 → 2.5.2

data/goodcheck.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_development_dependency "bundler", ">= 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-reporters", "~> 1.3.6"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4.2"
 
   spec.add_runtime_dependency "activesupport", ">= 4.0", "< 7.0"
-  spec.add_runtime_dependency "strong_json", "~> 1.1.0"
+  spec.add_runtime_dependency "strong_json", ">= 1.1", "< 2.2"
   spec.add_runtime_dependency "rainbow", "~> 3.0.0"
-  spec.add_runtime_dependency "httpclient", "~> 2.8.3"
+  spec.add_runtime_dependency "psych", ">= 3.1", "< 4.0" # NOTE: Needed for old Ruby versions (<= 2.5)
 end

data/goodcheck.yml

@@ -0,0 +1,10 @@
+import:
+  - https://raw.githubusercontent.com/sider/goodcheck-rules/master/rules/typo.yml
+  - https://raw.githubusercontent.com/sider/goodcheck-rules/master/rules/ruby.yml
+
+exclude:
+  - "**/build"
+  - "**/node_modules"
+  - "**/vendor"
+  - "**/*.{ico,pdf,png}"
+  - "**/yarn.lock"

data/lib/goodcheck.rb

@@ -5,11 +5,10 @@ require "yaml"
 require "json"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/integer/inflections"
-require "active_support/core_ext/regexp"
 require "active_support/tagged_logging"
 require "rainbow"
 require "digest/sha2"
-require "httpclient"
+require "net/http"
 
 require "goodcheck/version"
 require "goodcheck/logger"

data/lib/goodcheck/buffer.rb

@@ -3,9 +3,37 @@ module Goodcheck
     attr_reader :path
     attr_reader :content
 
+    DISABLE_LINE_PATTERNS = [
+      /\/\/ goodcheck-disable-line$/, #JS, Java, C, ...
+      /# goodcheck-disable-line$/, # Ruby, Python, PHP, ...
+      /-- goodcheck-disable-line$/, # Haskel, SQL, ...
+      /<!-- goodcheck-disable-line -->$/, # HTML, Markdown, ...
+      /\/\* goodcheck-disable-line \*\/$/, # CSS, SCSS,
+      /\{\s*\/\* goodcheck-disable-line \*\/\s*\}$/, # JSX, ...
+      /<%# goodcheck-disable-line %>$/, # ERB, ...
+      /' goodcheck-disable-line$/, # VB
+    ].freeze
+
+    DISABLE_NEXT_LINE_PATTERNS = [
+      /\/\/ goodcheck-disable-next-line$/, #JS, Java, C, ...
+      /# goodcheck-disable-next-line$/, # Ruby, Python, PHP, ...
+      /-- goodcheck-disable-next-line$/, # Haskel, SQL, ...
+      /<!-- goodcheck-disable-next-line -->$/, # HTML, Markdown, ...
+      /\/\* goodcheck-disable-next-line \*\/$/, # CSS, SCSS,
+      /\{\s*\/\* goodcheck-disable-next-line \*\/\s*\}$/, # JSX, ...
+      /<%# goodcheck-disable-next-line %>$/, # ERB, ...
+      /' goodcheck-disable-next-line$/, # VB
+    ].freeze
+
+    class << self
+        attr_accessor :DISABLE_LINE_PATTERNS
+        attr_accessor :DISABLE_NEXT_LINE_PATTERNS
+    end
+
     def initialize(path:, content:)
       @path = path
       @content = content
+      @line_ranges = nil
     end
 
     def line_ranges
@@ -23,6 +51,18 @@ module Goodcheck
 
       @line_ranges
     end
+    
+    def line_disabled?(line_number)
+      if line_number > 1
+        return true if DISABLE_NEXT_LINE_PATTERNS.any? { |pattern| line(line_number - 1).match?(pattern) } 
+      end
+
+      if line_number <= lines.length
+        return DISABLE_LINE_PATTERNS.any? { |pattern| line(line_number).match?(pattern) }
+      end
+
+      return false
+    end
 
     def location_for_position(position)
       line_index = line_ranges.bsearch_index do |range|
@@ -34,8 +74,12 @@ module Goodcheck
       end
     end
 
+    def lines
+      @lines ||= content.lines
+    end
+
     def line(line_number)
-      content.lines[line_number-1]
+      lines[line_number-1]
     end
 
     def position_for_location(line, column)

data/lib/goodcheck/cli.rb

@@ -18,7 +18,7 @@ module Goodcheck
       test: "Test your configuration",
       pattern: "Print regexp for rules",
       version: "Print version",
-      help: "Show goodcheck version and quit"
+      help: "Show help and quit"
     }
 
 
@@ -27,8 +27,12 @@ module Goodcheck
 
       if COMMANDS.key?(command)
         __send__(command, args)
+      elsif command == :"--version"
+        version(args)
       else
+        stderr.puts "Invalid command: #{command}" if command
         help(args)
+        1
       end
     rescue => exn
       stderr.puts exn.inspect
@@ -80,7 +84,7 @@ module Goodcheck
       if args.empty?
         targets << Pathname(".")
       else
-        targets.push *args.map {|arg| Pathname(arg) }
+        args.each {|arg| targets << Pathname(arg) }
       end
 
       reporter = case format

data/lib/goodcheck/commands/check.rb

@@ -1,6 +1,8 @@
 module Goodcheck
   module Commands
     class Check
+      DEFAULT_EXCLUSIONS = [".git", ".svn", ".hg"].freeze
+
       attr_reader :config_path
       attr_reader :rules
       attr_reader :targets
@@ -34,6 +36,7 @@ module Goodcheck
               reporter.rule(rule) do
                 analyzer = Analyzer.new(rule: rule, buffer: buffer, trigger: trigger)
                 analyzer.scan do |issue|
+                  next if issue.location && buffer.line_disabled?(issue.location.start_line)
                   if reported_issues.add?(issue)
                     issue_reported = true
                     reporter.issue(issue)
@@ -82,24 +85,23 @@ module Goodcheck
         end
       end
 
-      def is_dotfile?(path)
-        /\A\.[^.]+/.match?(path.basename.to_s)
-      end
-
       def each_file(path, immediate: false, &block)
         case
         when path.symlink?
           # noop
         when path.directory?
-          if immediate || (!is_dotfile?(path) && !excluded?(path))
+          case
+          when DEFAULT_EXCLUSIONS.include?(path.basename.to_s)
+            # noop
+          when immediate || !excluded?(path)
             path.children.each do |child|
               each_file(child, &block)
             end
           end
         when path.file?
           case
-          when path == config_path || is_dotfile?(path)
-            # Skip dotfiles/config file unless explicitly given by command line
+          when path == config_path
+            # Skip the config file unless explicitly given by command line
             yield path if immediate
           when excluded?(path)
             # Skip excluded files unless explicitly given by command line

data/lib/goodcheck/commands/config_loading.rb

@@ -5,7 +5,7 @@ module Goodcheck
 
       def load_config!(force_download:, cache_path:)
         import_loader = ImportLoader.new(cache_path: cache_path, force_download: force_download, config_path: config_path)
-        content = JSON.parse(JSON.dump(YAML.load(config_path.read, config_path.to_s)), symbolize_names: true)
+        content = JSON.parse(JSON.dump(YAML.load(config_path.read, filename: config_path.to_s)), symbolize_names: true)
         loader = ConfigLoader.new(path: config_path, content: content, stderr: stderr, import_loader: import_loader)
         @config = loader.load
       end

data/lib/goodcheck/commands/test.rb

@@ -22,6 +22,11 @@ module Goodcheck
         handle_config_errors stderr do
           load_config!(cache_path: cache_dir_path, force_download: force_download)
 
+          if config.rules.empty?
+            stdout.puts "No rules."
+            return 0
+          end
+
           validate_rule_uniqueness or return 1
           validate_rules or return 1
 
@@ -44,7 +49,8 @@ module Goodcheck
           stdout.puts "  OK!👍"
           true
         else
-          stdout.puts(Rainbow("  Found #{duplicated_ids.size} duplications.😞").red)
+          count = duplicated_ids.size
+          stdout.puts(Rainbow("  Found #{count} #{'duplication'.pluralize(count)}.😞").red)
           duplicated_ids.each do |id|
             stdout.puts "    #{id}"
           end
@@ -54,10 +60,13 @@ module Goodcheck
 
       def validate_rules
         test_pass = true
+        success_count = 0
+        failure_count = 0
+        failed_rule_ids = Set[]
 
         config.rules.each do |rule|
           if rule.triggers.any? {|trigger| !trigger.passes.empty? || !trigger.fails.empty?}
-            stdout.puts "Testing rule #{rule.id}..."
+            stdout.puts "Testing rule #{Rainbow(rule.id).cyan}..."
 
             rule_ok = true
 
@@ -82,7 +91,8 @@ module Goodcheck
                   rule_ok = false
 
                   pass_errors.each do |_, index|
-                    stdout.puts "    #{(index+1).ordinalize} pass example matched.😱"
+                    stdout.puts "    #{(index+1).ordinalize} #{Rainbow('pass').green} example matched.😱"
+                    failed_rule_ids << rule.id
                   end
                 end
 
@@ -91,7 +101,8 @@ module Goodcheck
                   rule_ok = false
 
                   fail_errors.each do |_, index|
-                    stdout.puts "    #{(index+1).ordinalize} fail example didn't match.😱"
+                    stdout.puts "    #{(index+1).ordinalize} #{Rainbow('fail').red} example didn't match.😱"
+                    failed_rule_ids << rule.id
                   end
                 end
               end
@@ -104,10 +115,27 @@ module Goodcheck
 
             if rule_ok
               stdout.puts "  OK!🎉"
+              success_count += 1
+            else
+              failure_count += 1
             end
           end
         end
 
+        unless failed_rule_ids.empty?
+          stdout.puts ""
+          stdout.puts "Failed rules:"
+          failed_rule_ids.each do |rule_id|
+            stdout.puts "  - #{Rainbow(rule_id).background(:red)}"
+          end
+        end
+
+        rule_count = success_count + failure_count
+        stdout.puts ""
+        stdout.puts ["Tested #{rule_count} #{'rule'.pluralize(rule_count)}",
+                     Rainbow("#{success_count} #{'success'.pluralize(success_count)}").green,
+                     Rainbow("#{failure_count} #{'failure'.pluralize(failure_count)}").red].join(", ")
+
         test_pass
       end
 

data/lib/goodcheck/config_loader.rb

@@ -241,7 +241,7 @@ module Goodcheck
 
       Goodcheck.logger.tagged import do
         import_loader.load(import) do |content|
-          json = JSON.parse(JSON.dump(YAML.load(content, import)), symbolize_names: true)
+          json = JSON.parse(JSON.dump(YAML.load(content, filename: import)), symbolize_names: true)
 
           Schema.rules.coerce json
           load_rules(rules, json)
@@ -360,7 +360,7 @@ module Goodcheck
         when ::Regexp
           Pattern::Regexp.new(source: pattern,
                               regexp: pat,
-                              multiline: pat.multiline?,
+                              multiline: pat.options & ::Regexp::MULTILINE == ::Regexp::MULTILINE,
                               case_sensitive: !pat.casefold?)
         end
       when Hash

data/lib/goodcheck/glob.rb

@@ -9,7 +9,7 @@ module Goodcheck
     end
 
     def test(path)
-      path.fnmatch?(pattern, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+      path.fnmatch?(pattern, File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH)
     end
 
     def ==(other)

data/lib/goodcheck/import_loader.rb

@@ -71,7 +71,7 @@ module Goodcheck
       if download
         path.rmtree if path.exist?
         Goodcheck.logger.info "Downloading content..."
-        content = HTTPClient.new.get_content(uri)
+        content = http_get uri
         Goodcheck.logger.debug "Downloaded content: #{content[0, 1024].inspect}#{content.size > 1024 ? "..." : ""}"
         yield content
         write_cache uri, content
@@ -85,5 +85,21 @@ module Goodcheck
       path = cache_path + cache_name(uri)
       path.write(content)
     end
+
+    # @see https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html#class-Net::HTTP-label-Following+Redirection
+    def http_get(uri, limit = 10)
+      raise ArgumentError, "Too many HTTP redirects" if limit == 0
+
+      res = Net::HTTP.get_response URI(uri)
+      case res
+      when Net::HTTPSuccess
+        res.body
+      when Net::HTTPRedirection
+        location = res['Location']
+        http_get location, limit - 1
+      else
+        raise "Error: HTTP GET #{uri.inspect} #{res.inspect}"
+      end
+    end
   end
 end

data/lib/goodcheck/issue.rb

@@ -10,6 +10,7 @@ module Goodcheck
       @range = range
       @rule = rule
       @text = text
+      @location = nil
     end
 
     def path

data/lib/goodcheck/trigger.rb

@@ -12,6 +12,8 @@ module Goodcheck
       @passes = passes
       @fails = fails
       @negated = negated
+      @by_pattern = false
+      @skips_fail_examples = false
     end
 
     def by_pattern!

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "2.4.3"
+  VERSION = "2.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.2
 platform: ruby
 authors:
 - Soutaro Matsumoto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +90,22 @@ dependencies:
   name: strong_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -115,19 +121,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: '4.0'
 description: Regexp based customizable linter
 email:
 - matsumoto@soutaro.com
@@ -136,9 +148,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -175,6 +189,7 @@ files:
 - docusaurus/website/versioned_docs/version-1.0.0/rules.md
 - docusaurus/website/versioned_docs/version-1.0.2/rules.md
 - docusaurus/website/versioned_docs/version-2.4.0/configuration.md
+- docusaurus/website/versioned_docs/version-2.4.3/rules.md
 - docusaurus/website/versioned_sidebars/version-1.0.0-sidebars.json
 - docusaurus/website/versioned_sidebars/version-1.0.2-sidebars.json
 - docusaurus/website/versioned_sidebars/version-2.4.0-sidebars.json
@@ -182,6 +197,7 @@ files:
 - docusaurus/website/yarn.lock
 - exe/goodcheck
 - goodcheck.gemspec
+- goodcheck.yml
 - lib/goodcheck.rb
 - lib/goodcheck/analyzer.rb
 - lib/goodcheck/array_helper.rb
@@ -216,7 +232,7 @@ homepage: https://github.com/sider/goodcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Regexp based customizable linter
 test_files: []