goodcheck 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a38825ec6d8bc5b187a12a85f2ef8247e97b3d1
-  data.tar.gz: 533593b7f064c57417e2719e9831595d4de5f896
+  metadata.gz: 4541711a6d0096718ec3099d059ea57c3af16b2b
+  data.tar.gz: 88619a7566f492738fd93213896edeaedc05a076
 SHA512:
-  metadata.gz: b6bfeb6c399bcb7ea16c66e2a285c556b5838ef976328512ad773bc8e51a32b9551829551026389db4f2ab89ff9679d2fe59fcf6fbe394ece71524082f702dcd
-  data.tar.gz: 7ba0ded6e4fc1d395ef14012ecc399853a65751357d54a22c5f2b4e8e6b4f63bc47f0a727d82ea8c571ef8da20fa2969b47763260cdf823083531742ddf7f09f
+  metadata.gz: 3226d5daece6e067f7ae2e123c3e43f4b2a7a0838e60cd92fef38f08721b3a91351782ed0a9c5d9ad96d38ad592355a3567e57eed292d7e053ede00f0874c3d5
+  data.tar.gz: eecdde8f34d52b0b4479df6c3a7b16228b2ac89b2cfd642f7f3e4820dc3ea1f3d0ec828779227144931748e744eb164ee5b5d37a7791084f603544a74806d5c2

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /.idea
+/Gemfile.lock

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.3.1 (2018-08-16)
+
+* Delete Gemfile.lock
+
+## 1.3.0 (2018-08-16)
+
+* Improved commandline option parsing #25 (@ybiquitous)
+* Skip loading dot-files #24 (@calancha)
+* Performance improvement on literal types #15 (@calancha)
+
 ## 1.2.0 (2018-06-29)
 
 * `case_insensitive` option is now renamed to `case_sensitive`. #4

data/README.md

@@ -46,7 +46,7 @@ rules:
       GitHub is GitHub, not Github
 
       You may misspelling the name of the service!
-    justifications:
+    justification:
       - When you mean a service different from GitHub
       - When GitHub is renamed
     glob:
@@ -120,7 +120,7 @@ pattern:
   case_sensitive: false
 message: Stop using <blink> tag
 glob: "**/*.html"
-justifications:
+justification:
   - If Lynx is the major target of the web site
 ```
 
@@ -128,11 +128,12 @@ It tries to tokenize the input and generates a regexp which matches sequence of
 The tokenization is heuristic and may not work well for your programming language.
 In that case, try using *regexp pattern*.
 
-The generated regexp of `<blink` is `<\s*blink\b`.
+The generated regexp of `<blink` is `<\s*blink\b/m`.
 It matches with `<blink />` and `< BLINK>`, but does not match with `https://www.chromium.org/blink`.
 
 It accepts one optional attribute, `case_sensitive`.
 The default value of `case_sensitive` is `true`.
+Note that the generated regexp is in multiline mode.
 
 ### *glob*
 

data/lib/goodcheck/cli.rb

@@ -48,7 +48,7 @@ module Goodcheck
         opts.on("-R RULE", "--rule=RULE") do |rule|
           rules << rule
         end
-        opts.on("--format=FORMAT") do |f|
+        opts.on("--format=<text|json> [default: 'text']") do |f|
           format = f
         end
       end.parse!(args)

data/lib/goodcheck/commands/check.rb

@@ -72,17 +72,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?
-          path.children.each do |child|
-            each_file(child, &block)
+          if !is_dotfile?(path) || is_dotfile?(path) && immediate
+            path.children.each do |child|
+              each_file(child, &block)
+            end
           end
         when path.file?
-          if path == config_path
-            # Skip config file unless explicitly given by command line
+          if path == config_path || is_dotfile?(path)
+            # Skip dotfiles/config file unless explicitly given by command line
             yield path if immediate
           else
             yield path

data/lib/goodcheck/config_loader.rb

@@ -55,7 +55,7 @@ module Goodcheck
 
     def load_rule(hash)
       id = hash[:id]
-      patterns = array(hash[:pattern]).map {|pat| load_pattern(pat) }
+      patterns = retrieve_patterns(hash)
       justifications = array(hash[:justification])
       globs = load_globs(array(hash[:glob]))
       message = hash[:message].chomp
@@ -65,6 +65,43 @@ module Goodcheck
       Rule.new(id: id, patterns: patterns, justifications: justifications, globs: globs, message: message, passes: passes, fails: fails)
     end
 
+    def combine_literal_patterns(patterns, case_sensitive:)
+      return nil if patterns.empty?
+      literals = patterns.map do |pat|
+        str = pat.is_a?(String) ? pat : pat[:literal].to_s
+        Regexp.escape(str)
+      end
+      Pattern.regexp(literals.join('|'),
+                     case_sensitive: case_sensitive,
+                     multiline: false)
+    end
+
+    def literal_pattern?(pattern)
+      pattern.is_a?(String) || pattern[:literal]
+    end
+
+    def select_literal_pattern(patterns, case_sensitive:)
+      patterns.select do |pat|
+        if case_sensitive
+          literal_pattern?(pat) && case_sensitive?(pat)
+        else
+          literal_pattern?(pat) && !case_sensitive?(pat)
+        end
+      end
+    end
+
+    def retrieve_patterns(hash)
+      pat_array = array(hash[:pattern])
+      non_literal = pat_array.reject { |pat| literal_pattern?(pat) }
+      patterns = non_literal.map { |pat| load_pattern(pat) }
+      [true, false].each do |boolean|
+        literal = select_literal_pattern(pat_array, case_sensitive: boolean)
+        comb_pat = combine_literal_patterns(literal, case_sensitive: boolean)
+        patterns << comb_pat if comb_pat
+      end
+      patterns
+    end
+
     def load_globs(globs)
       globs.map do |glob|
         case glob
@@ -100,6 +137,7 @@ module Goodcheck
     end
 
     def case_sensitive?(pattern)
+      return true if pattern.is_a?(String)
       case
       when pattern.key?(:case_sensitive)
         pattern[:case_sensitive]

data/lib/goodcheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,6 @@ files:
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    goodcheck (1.2.0)
-      activesupport (~> 5.0)
-      rainbow (~> 3.0.0)
-      strong_json (~> 0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    minitest (5.10.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    strong_json (0.5.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  goodcheck!
-  minitest (~> 5.0)
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.16.2