goodcheck 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95c2a7244c21b8436b9b3069df313871905d2544
-  data.tar.gz: e2137ec229279936f5abed87dabff5a8dcd083ad
+  metadata.gz: bbd50cb641f78725c89b7543fad72cc682f89212
+  data.tar.gz: 3bfa5512cdd20c4401e6ebfbb25d32e471bb1bbe
 SHA512:
-  metadata.gz: 77025fef5bebc19bf8638f3aee6f9777e4bc6cfbb1b41ab0dd0e04b60190c33947d0b6a06ed053e136e80573bb05f71c240e0d036699544c53ab65e323fa5b7e
-  data.tar.gz: 93d155f4a8cbd50ec80412713c80ec7093a00de0635cad25db8451a37970ab20609ffc0b14d851e523d8a7a6480d30f71628873fd152c7968738ed4fc3c75473
+  metadata.gz: 9c9f1ae3060429088686d073c579e24b675c0e4e03461e9ccdc8b7b230e9f1c09f2f78c471cc7fe2f233ae58bc5d21fc6caadfdd94bd75b44529bc248a8abbe9
+  data.tar.gz: 860f1810b61143bb3f3a7a09fff042919c8e82876e9c4cfb5e0f2131f4993d36d324b3a64aa20493dca3497e56e671300cb26a33ba6848672d6ffec06eca7c21

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.6.0 (2019-05-08)
+
+* Add `not` pattern rule [#49](https://github.com/sider/goodcheck/pull/49)
+
 ## 1.5.1 (2019-05-08)
 
 * Regexp matching improvements

data/lib/goodcheck/analyzer.rb

@@ -10,23 +10,30 @@ module Goodcheck
 
     def scan(&block)
       if block_given?
-        issues = []
-
         regexp = Regexp.union(*rule.patterns.map(&:regexp))
-        scanner = StringScanner.new(buffer.content)
 
-        while true
-          case
-          when scanner.scan_until(regexp)
-            text = scanner.matched
-            range = (scanner.pos - text.bytesize) .. scanner.pos
-            issues << Issue.new(buffer: buffer, range: range, rule: rule, text: text)
-          else
-            break
+        unless rule.negated?
+          issues = []
+
+          scanner = StringScanner.new(buffer.content)
+
+          while true
+            case
+            when scanner.scan_until(regexp)
+              text = scanner.matched
+              range = (scanner.pos - text.bytesize) .. scanner.pos
+              issues << Issue.new(buffer: buffer, range: range, rule: rule, text: text)
+            else
+              break
+            end
           end
-        end
 
-        issues.each(&block)
+          issues.each(&block)
+        else
+          unless regexp =~ buffer.content
+            yield Issue.new(buffer: buffer, range: nil, rule: rule, text: text)
+          end
+        end
       else
         enum_for(:scan)
       end

data/lib/goodcheck/config_loader.rb

@@ -20,7 +20,7 @@ module Goodcheck
       let :encoding, enum(*Encoding.name_list.map {|name| literal(name) })
       let :glob, object(pattern: string, encoding: optional(encoding))
 
-      let :rule, object(
+      let :positive_rule, object(
         id: string,
         pattern: enum(array(pattern), pattern),
         message: string,
@@ -30,6 +30,18 @@ module Goodcheck
         fail: optional(enum(array(string), string))
       )
 
+      let :negative_rule, object(
+        id: string,
+        not: object(pattern: enum(array(pattern), pattern)),
+        message: string,
+        justification: optional(enum(array(string), string)),
+        glob: optional(enum(array(enum(glob, string)), glob, string)),
+        pass: optional(enum(array(string), string)),
+        fail: optional(enum(array(string), string))
+      )
+
+      let :rule, enum(positive_rule, negative_rule)
+
       let :rules, array(rule)
 
       let :import_target, string
@@ -99,20 +111,25 @@ module Goodcheck
       Goodcheck.logger.debug "Loading rule: #{hash[:id]}"
 
       id = hash[:id]
-      patterns = retrieve_patterns(hash)
+      patterns, negated = retrieve_patterns(hash)
       justifications = array(hash[:justification])
       globs = load_globs(array(hash[:glob]))
       message = hash[:message].chomp
       passes = array(hash[:pass])
       fails = array(hash[:fail])
 
-      Rule.new(id: id, patterns: patterns, justifications: justifications, globs: globs, message: message, passes: passes, fails: fails)
+      Rule.new(id: id, patterns: patterns, justifications: justifications, globs: globs, message: message, passes: passes, fails: fails, negated: negated)
     end
 
     def retrieve_patterns(hash)
-      array(hash[:pattern]).map do |pat|
-        load_pattern(pat)
+      if hash.is_a?(Hash) && hash.key?(:not)
+        negated = true
+        hash = hash[:not]
+      else
+        negated = false
       end
+
+      [array(hash[:pattern]).map {|pat| load_pattern(pat) }, negated]
     end
 
     def load_globs(globs)

data/lib/goodcheck/issue.rb

@@ -17,13 +17,15 @@ module Goodcheck
     end
 
     def location
-      unless @location
-        start_line, start_column = buffer.location_for_position(range.begin)
-        end_line, end_column = buffer.location_for_position(range.end)
-        @location = Location.new(start_line: start_line, start_column: start_column, end_line: end_line, end_column: end_column)
-      end
+      if range
+        unless @location
+          start_line, start_column = buffer.location_for_position(range.begin)
+          end_line, end_column = buffer.location_for_position(range.end)
+          @location = Location.new(start_line: start_line, start_column: start_column, end_line: end_line, end_column: end_column)
+        end
 
-      @location
+        @location
+      end
     end
   end
 end

data/lib/goodcheck/reporters/json.rb

@@ -15,14 +15,15 @@ module Goodcheck
         yield
 
         json = issues.map do |issue|
+          location = issue.location
           {
             rule_id: issue.rule.id,
             path: issue.path,
-            location: {
-              start_line: issue.location.start_line,
-              start_column: issue.location.start_column,
-              end_line: issue.location.end_line,
-              end_column: issue.location.end_column
+            location: location && {
+              start_line: location.start_line,
+              start_column: location.start_column,
+              end_line: location.end_line,
+              end_column: location.end_column
             },
             message: issue.rule.message,
             justifications: issue.rule.justifications

data/lib/goodcheck/reporters/text.rb

@@ -20,14 +20,18 @@ module Goodcheck
       end
 
       def issue(issue)
-        line = issue.buffer.line(issue.location.start_line)
-        end_column = if issue.location.start_line == issue.location.end_line
-                       issue.location.end_column
-                     else
-                       line.bytesize
-                     end
-        colored_line = line.byteslice(0, issue.location.start_column) + Rainbow(line.byteslice(issue.location.start_column, end_column - issue.location.start_column)).red + line.byteslice(end_column, line.bytesize)
-        stdout.puts "#{issue.path}:#{issue.location.start_line}:#{colored_line.chomp}:\t#{issue.rule.message.lines.first.chomp}"
+        if issue.location
+          line = issue.buffer.line(issue.location.start_line)
+          end_column = if issue.location.start_line == issue.location.end_line
+                         issue.location.end_column
+                       else
+                         line.bytesize
+                       end
+          colored_line = line.byteslice(0, issue.location.start_column) + Rainbow(line.byteslice(issue.location.start_column, end_column - issue.location.start_column)).red + line.byteslice(end_column, line.bytesize)
+          stdout.puts "#{issue.path}:#{issue.location.start_line}:#{colored_line.chomp}:\t#{issue.rule.message.lines.first.chomp}"
+        else
+          stdout.puts "#{issue.path}:-:#{issue.buffer.line(1).chomp}:\t#{issue.rule.message.lines.first.chomp}"
+        end
       end
     end
   end

data/lib/goodcheck/rule.rb

@@ -8,7 +8,7 @@ module Goodcheck
     attr_reader :passes
     attr_reader :fails
 
-    def initialize(id:, patterns:, message:, justifications:, globs:, fails:, passes:)
+    def initialize(id:, patterns:, message:, justifications:, globs:, fails:, passes:, negated:)
       @id = id
       @patterns = patterns
       @message = message
@@ -16,6 +16,11 @@ module Goodcheck
       @globs = globs
       @passes = passes
       @fails = fails
+      @negated = negated
+    end
+
+    def negated?
+      @negated
     end
   end
 end

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/sample.yml

@@ -10,6 +10,7 @@ rules:
       Maybe, you are misspelling.
     pass: GitHub
     fail: Github
+
   - id: sample.debug_print
     pattern:
       - token: pp
@@ -22,5 +23,35 @@ rules:
     fail:
       - pp("Hello World")
 
+  - id: sample.html
+    not:
+      pattern:
+        - token: <meta charset="utf-8"
+        - token: <meta charset="UTF-8"
+    message: |
+      Use UTF-8 (no BOM).
+    glob: "**/*.html"
+    pass:
+      - |
+        <html>
+          <meta charset="utf-8"/>
+        </html>
+      - |
+        <html>
+          <meta charset="utf-8"></meta>
+        </html>
+      - |
+        <html>
+          <meta charset="UTF-8"></meta>
+        </html>
+    fail:
+      - |
+        <html>
+          <meta charset="iso-8859-1">
+        </html>
+      - |
+        <html>
+        </html>
+
 import:
   - https://gist.githubusercontent.com/soutaro/6362c89acd7d6771ae6ebfc615be402d/raw/7f04b973c2c8df70783cd7deb955ab95d1375b2d/sample.yml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Soutaro Matsumoto