goodcheck 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15aefd3f98836effe7e8ebb411d6429a34f52106
-  data.tar.gz: e14fe493d3aa80f2efb184cd1b219804c240eb1f
+  metadata.gz: 655728b9b54f9f48689ab1537e36db901b6e0ce7
+  data.tar.gz: 58b694b053b4fdf26c96c4b7369d87fffdac05cb
 SHA512:
-  metadata.gz: 1ce2020afbd45f6b8d67f35d2245b086d54d7f001d759b8cf04f75cc3b563f38ed09d042ff4b73f5e77c352f0438c7ce5becd0f438de43b24fbb1694bbf81498
-  data.tar.gz: 042523304df5f10a8d614184df04f2b6c0d88c2a951353a542e9040b487902e1454b6d71ce00c7f477948fe23f509c7f619cd68e94e2feabbbf75433a53d0e3b
+  metadata.gz: 3241668c77b0b0fcea6a1bf1db06002a2e4df90a91c1bab4013fc15fbb51d65a036e5da91a8e6938019aa59ff3552eb2d13f79b2bf533067d6e04cf62e5f3f8d
+  data.tar.gz: b5d60bbef44eef2f3c97b23dbcd8ae8f7cf4d2203dcdad431e86e675c9c123170ad79cba50e926c52a43c3e21e4f744d10d64a2c6397c8c9bea3f8ff499879b9

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master
 
+## 1.1.0 (2018-06-16)
+
+* Support `{}` syntax in glob. #11
+* Add `case_insensitive` option for `token` pattern. #10
+
 ## 1.0.0 (2018-02-22)
 
 * Stop resolving realpath for symlinks. #6

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:2.5.0-stretch
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -y && \
+    apt-get install -y locales task-english && \
+    rm -rf /var/lib/apt/lists/*
+RUN echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && \
+    locale-gen en_US.UTF-8 && \
+    update-locale en_US.UTF-8
+ENV LC_ALL=en_US.UTF-8 \
+    LANG=en_US.UTF-8 \
+    LANGUAGE=en_US.UTF-8
+
+RUN mkdir /goodcheck
+WORKDIR /goodcheck
+COPY . /goodcheck/
+RUN bundle install && bundle exec rake install
+
+RUN mkdir /work
+WORKDIR /work

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    goodcheck (1.0.0)
+    goodcheck (1.1.0)
       activesupport (~> 5.0)
       rainbow (~> 3.0.0)
       strong_json (~> 0.5.0)
@@ -9,20 +9,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.0.5)
-    i18n (0.9.1)
+    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.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS

data/README.md

@@ -20,6 +20,8 @@ $ gem install goodcheck
 
 Or you can use `bundler`!
 
+If you would not like to install Goodcheck to system (e.g. you would not like to install Ruby 2.4 or higher), you can use a docker image. [See below](#docker-image).
+
 ## Quickstart
 
 ```bash
@@ -42,7 +44,7 @@ rules:
     pattern: Github
     message: |
       GitHub is GitHub, not Github
-      
+
       You may misspelling the name of the service!
     justifications:
       - When you mean a service different from GitHub
@@ -72,7 +74,7 @@ A *pattern* can be a *literal pattern*, *regexp pattern*, *token pattern*, or a
 When a string is given, it is interpreted as a *literal pattern* with `case_insensitive: false`.
 
 #### *literal pattern*
- 
+
 *literal pattern* allows you to construct a regexp which matches exactly to the `literal` string.
 
 ```yaml
@@ -102,7 +104,7 @@ justification:
 ```
 
 It accepts two optional attributes, `case_insensitive` and `multiline`.
-The default value of `case_insensitive` and `multiline` are `true` and `false` correspondingly.
+The default values of `case_insensitive` and `multiline` are `false`.
 
 The regexp will be passed to `Regexp.compile`.
 The precise definition of regular expression can be found in the documentation for Ruby.
@@ -115,7 +117,8 @@ The precise definition of regular expression can be found in the documentation f
 id: com.sample.no-blink
 pattern:
   token: "<blink"
-message: Stop using <blink> tag 
+  case_insensitive: true
+message: Stop using <blink> tag
 glob: "**/*.html"
 justifications:
   - If Lynx is the major target of the web site
@@ -128,6 +131,9 @@ 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`.
+
 ### *glob*
 
 A *glob* can be a string, or a hash.
@@ -189,6 +195,19 @@ Available options is:
 
 * `-c [CONFIG]`, `--config=[CONFIG]` to specify the configuration file.
 
+## Docker image
+
+You can use a docker image to use Goodcheck.
+
+```bash
+$ git clone https://github.com/sideci/goodcheck
+$ cd goodcheck
+$ docker build -t goodcheck:latest .
+
+$ cd /path/to/your/project
+$ docker run -it --rm -v "$(pwd):/work" goodcheck:latest goodcheck check
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -8,3 +8,9 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+namespace :docker do
+  task :build do
+    sh 'docker', 'build', '-t', 'goodcheck:latest', '.'
+  end
+end

data/lib/goodcheck/config.rb

@@ -13,7 +13,7 @@ module Goodcheck
             if rule.globs.empty?
               [rule, nil]
             else
-              glob = rule.globs.find {|glob| path.fnmatch?(glob.pattern, File::FNM_PATHNAME) }
+              glob = rule.globs.find {|glob| path.fnmatch?(glob.pattern, File::FNM_PATHNAME | File::FNM_EXTGLOB) }
               if glob
                 [rule, glob]
               end

data/lib/goodcheck/config_loader.rb

@@ -7,7 +7,7 @@ module Goodcheck
     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)
+      let :token_pattern, object(token: string, case_insensitive: boolean?)
       let :pattern, enum(regexp_pattern, literal_pattern, token_pattern, string)
 
       let :encoding, enum(*Encoding.name_list.map {|name| literal(name) })
@@ -82,7 +82,8 @@ module Goodcheck
           Pattern.regexp(regexp, case_insensitive: ci, multiline: multiline)
         when pattern[:token]
           tok = pattern[:token]
-          Pattern.token(tok)
+          ci = pattern[:case_insensitive]
+          Pattern.token(tok, case_insensitive: ci)
         end
       end
     end

data/lib/goodcheck/pattern.rb

@@ -20,11 +20,11 @@ module Goodcheck
       new(source: regexp, regexp: Regexp.compile(regexp, options))
     end
 
-    def self.token(tokens)
-      new(source: tokens, regexp: compile_tokens(tokens))
+    def self.token(tokens, case_insensitive:)
+      new(source: tokens, regexp: compile_tokens(tokens, case_insensitive: case_insensitive))
     end
 
-    def self.compile_tokens(source)
+    def self.compile_tokens(source, case_insensitive:)
       tokens = []
       s = StringScanner.new(source)
 
@@ -51,7 +51,10 @@ module Goodcheck
         tokens.last << '\b'
       end
 
-      Regexp.new(tokens.join('\s*').gsub(/\\s\*(\\s\+\\s\*)+/, '\s+'), Regexp::MULTILINE)
+      options = Regexp::MULTILINE
+      options |= Regexp::IGNORECASE if case_insensitive
+
+      Regexp.new(tokens.join('\s*').gsub(/\\s\*(\\s\+\\s\*)+/, '\s+'), options)
     end
   end
 end

data/lib/goodcheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE