goodcheck 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 655728b9b54f9f48689ab1537e36db901b6e0ce7
-  data.tar.gz: 58b694b053b4fdf26c96c4b7369d87fffdac05cb
+  metadata.gz: 1a38825ec6d8bc5b187a12a85f2ef8247e97b3d1
+  data.tar.gz: 533593b7f064c57417e2719e9831595d4de5f896
 SHA512:
-  metadata.gz: 3241668c77b0b0fcea6a1bf1db06002a2e4df90a91c1bab4013fc15fbb51d65a036e5da91a8e6938019aa59ff3552eb2d13f79b2bf533067d6e04cf62e5f3f8d
-  data.tar.gz: b5d60bbef44eef2f3c97b23dbcd8ae8f7cf4d2203dcdad431e86e675c9c123170ad79cba50e926c52a43c3e21e4f744d10d64a2c6397c8c9bea3f8ff499879b9
+  metadata.gz: b6bfeb6c399bcb7ea16c66e2a285c556b5838ef976328512ad773bc8e51a32b9551829551026389db4f2ab89ff9679d2fe59fcf6fbe394ece71524082f702dcd
+  data.tar.gz: 7ba0ded6e4fc1d395ef14012ecc399853a65751357d54a22c5f2b4e8e6b4f63bc47f0a727d82ea8c571ef8da20fa2969b47763260cdf823083531742ddf7f09f

data/CHANGELOG.md

@@ -2,7 +2,12 @@
 
 ## master
 
-## 1.1.0 (2018-06-16)
+## 1.2.0 (2018-06-29)
+
+* `case_insensitive` option is now renamed to `case_sensitive`. #4
+* Return analysis JSON object from JSON reporter. #13 (@aergonaut)
+
+## 1.1.0 (2018-05-16)
 
 * Support `{}` syntax in glob. #11
 * Add `case_insensitive` option for `token` pattern. #10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    goodcheck (1.1.0)
+    goodcheck (1.2.0)
       activesupport (~> 5.0)
       rainbow (~> 3.0.0)
       strong_json (~> 0.5.0)
@@ -35,4 +35,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.2

data/README.md

@@ -71,7 +71,7 @@ The *rule* hash contains the following keys.
 ### *pattern*
 
 A *pattern* can be a *literal pattern*, *regexp pattern*, *token pattern*, or a string.
-When a string is given, it is interpreted as a *literal pattern* with `case_insensitive: false`.
+When a string is given, it is interpreted as a *literal pattern* with `case_sensitive: true`.
 
 #### *literal pattern*
 
@@ -81,12 +81,12 @@ When a string is given, it is interpreted as a *literal pattern* with `case_inse
 id: com.sample.GitHub
 pattern:
   literal: Github
-  case_insensitive: false
+  case_sensitive: true
 message: Write GitHub, not Github
 ```
 
 All regexp meta characters included in the `literal` value will be escaped.
-`case_insensitive` is an optional key and the default is `false`.
+`case_sensitive` is an optional key and the default is `true`.
 
 #### *regexp pattern*
 
@@ -96,15 +96,15 @@ All regexp meta characters included in the `literal` value will be escaped.
 id: com.sample.digits
 pattern:
   regexp: \d{4,}
-  case_insensitive: true
+  case_sensitive: false
   multiline: false
 message: Insert delimiters when writing large numbers
 justification:
   - When you are not writing numbers, including phone numbers, zip code, ...
 ```
 
-It accepts two optional attributes, `case_insensitive` and `multiline`.
-The default values of `case_insensitive` and `multiline` are `false`.
+It accepts two optional attributes, `case_sensitive` and `multiline`.
+The default values of `case_sensitive` and `multiline` are `true` and `false` respectively.
 
 The regexp will be passed to `Regexp.compile`.
 The precise definition of regular expression can be found in the documentation for Ruby.
@@ -117,7 +117,7 @@ The precise definition of regular expression can be found in the documentation f
 id: com.sample.no-blink
 pattern:
   token: "<blink"
-  case_insensitive: true
+  case_sensitive: false
 message: Stop using <blink> tag
 glob: "**/*.html"
 justifications:
@@ -131,8 +131,8 @@ In that case, try using *regexp pattern*.
 The generated regexp of `<blink` is `<\s*blink\b`.
 It matches with `<blink />` and `< BLINK>`, but does not match with `https://www.chromium.org/blink`.
 
-It accepts one optional attribute, `case_insensitive`.
-The default value of `case_insensitive` is `false`.
+It accepts one optional attribute, `case_sensitive`.
+The default value of `case_sensitive` is `true`.
 
 ### *glob*
 

data/lib/goodcheck.rb

@@ -18,7 +18,6 @@ require "goodcheck/array_helper"
 require "goodcheck/analyzer"
 require "goodcheck/issue"
 require "goodcheck/rule"
-require "goodcheck/matcher"
 require "goodcheck/pattern"
 require "goodcheck/config"
 require "goodcheck/config_loader"

data/lib/goodcheck/commands/config_loading.rb

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

data/lib/goodcheck/config_loader.rb

@@ -5,10 +5,17 @@ module Goodcheck
     class InvalidPattern < StandardError; end
 
     Schema = StrongJSON.new do
-      let :regexp_pattern, object(regexp: string, case_insensitive: boolean?, multiline: boolean?)
-      let :literal_pattern, object(literal: string, case_insensitive: boolean?)
-      let :token_pattern, object(token: string, case_insensitive: boolean?)
-      let :pattern, enum(regexp_pattern, literal_pattern, token_pattern, string)
+      let :deprecated_regexp_pattern, object(regexp: string, case_insensitive: boolean?, multiline: boolean?)
+      let :deprecated_literal_pattern, object(literal: string, case_insensitive: boolean?)
+      let :deprecated_token_pattern, object(token: string, case_insensitive: boolean?)
+
+      let :regexp_pattern, object(regexp: string, case_sensitive: boolean?, multiline: boolean?)
+      let :literal_pattern, object(literal: string, case_sensitive: boolean?)
+      let :token_pattern, object(token: string, case_sensitive: boolean?)
+
+      let :pattern, enum(regexp_pattern, literal_pattern, token_pattern,
+                         deprecated_regexp_pattern, deprecated_literal_pattern, deprecated_token_pattern,
+                         string)
 
       let :encoding, enum(*Encoding.name_list.map {|name| literal(name) })
       let :glob, object(pattern: string, encoding: optional(encoding))
@@ -30,10 +37,14 @@ module Goodcheck
 
     attr_reader :path
     attr_reader :content
+    attr_reader :stderr
+    attr_reader :printed_warnings
 
-    def initialize(path:, content:)
+    def initialize(path:, content:, stderr:)
       @path = path
       @content = content
+      @stderr = stderr
+      @printed_warnings = Set.new
     end
 
     def load
@@ -68,24 +79,43 @@ module Goodcheck
     def load_pattern(pattern)
       case pattern
       when String
-        Pattern.literal(pattern, case_insensitive: false)
+        Pattern.literal(pattern, case_sensitive: true)
       when Hash
         case
         when pattern[:literal]
-          ci = pattern[:case_insensitive]
+          cs = case_sensitive?(pattern)
           literal = pattern[:literal]
-          Pattern.literal(literal, case_insensitive: ci)
+          Pattern.literal(literal, case_sensitive: cs)
         when pattern[:regexp]
           regexp = pattern[:regexp]
-          ci = pattern[:case_insensitive]
+          cs = case_sensitive?(pattern)
           multiline = pattern[:multiline]
-          Pattern.regexp(regexp, case_insensitive: ci, multiline: multiline)
+          Pattern.regexp(regexp, case_sensitive: cs, multiline: multiline)
         when pattern[:token]
           tok = pattern[:token]
-          ci = pattern[:case_insensitive]
-          Pattern.token(tok, case_insensitive: ci)
+          cs = case_sensitive?(pattern)
+          Pattern.token(tok, case_sensitive: cs)
         end
       end
     end
+
+    def case_sensitive?(pattern)
+      case
+      when pattern.key?(:case_sensitive)
+        pattern[:case_sensitive]
+      when pattern.key?(:case_insensitive)
+        print_warning_once "👻 `case_insensitive` option is deprecated. Use `case_sensitive` option instead."
+        !pattern[:case_insensitive]
+      else
+        true
+      end
+    end
+
+    def print_warning_once(message)
+      unless printed_warnings.include?(message)
+        stderr.puts "[Warning] " + message
+        printed_warnings << message
+      end
+    end
   end
 end

data/lib/goodcheck/pattern.rb

@@ -8,23 +8,23 @@ module Goodcheck
       @regexp = regexp
     end
 
-    def self.literal(literal, case_insensitive:)
-      new(source: literal, regexp: Regexp.compile(Regexp.escape(literal), case_insensitive))
+    def self.literal(literal, case_sensitive:)
+      new(source: literal, regexp: Regexp.compile(Regexp.escape(literal), !case_sensitive))
     end
 
-    def self.regexp(regexp, case_insensitive:, multiline:)
+    def self.regexp(regexp, case_sensitive:, multiline:)
       options = 0
-      options |= Regexp::IGNORECASE if case_insensitive
+      options |= Regexp::IGNORECASE unless case_sensitive
       options |= Regexp::MULTILINE if multiline
 
       new(source: regexp, regexp: Regexp.compile(regexp, options))
     end
 
-    def self.token(tokens, case_insensitive:)
-      new(source: tokens, regexp: compile_tokens(tokens, case_insensitive: case_insensitive))
+    def self.token(tokens, case_sensitive:)
+      new(source: tokens, regexp: compile_tokens(tokens, case_sensitive: case_sensitive))
     end
 
-    def self.compile_tokens(source, case_insensitive:)
+    def self.compile_tokens(source, case_sensitive:)
       tokens = []
       s = StringScanner.new(source)
 
@@ -52,7 +52,7 @@ module Goodcheck
       end
 
       options = Regexp::MULTILINE
-      options |= Regexp::IGNORECASE if case_insensitive
+      options |= Regexp::IGNORECASE unless case_sensitive
 
       Regexp.new(tokens.join('\s*').gsub(/\\s\*(\\s\+\\s\*)+/, '\s+'), options)
     end

data/lib/goodcheck/reporters/json.rb

@@ -30,6 +30,7 @@ module Goodcheck
           }
         end
         stdout.puts ::JSON.dump(json)
+        json
       end
 
       def file(path)

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,6 @@ files:
 - lib/goodcheck/glob.rb
 - lib/goodcheck/issue.rb
 - lib/goodcheck/location.rb
-- lib/goodcheck/matcher.rb
 - lib/goodcheck/pattern.rb
 - lib/goodcheck/reporters/json.rb
 - lib/goodcheck/reporters/text.rb
@@ -155,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Regexp based customizable linter

data/lib/goodcheck/matcher.rb

@@ -1,21 +0,0 @@
-module Goodcheck
-  class Matcher
-    attr_reader :path
-    attr_reader :src
-    attr_reader :rule
-
-    def initialize(path:, src:, rule:)
-      @path = path
-      @src = src
-      @rule = rule
-    end
-
-    def each
-      if block_given?
-
-      else
-        enum_for :each
-      end
-    end
-  end
-end