goodcheck 2.4.4 → 2.6.0

data/lib/goodcheck/import_loader.rb

@@ -1,13 +1,23 @@
 module Goodcheck
   class ImportLoader
-    class UnexpectedSchemaError < StandardError
+    class UnexpectedSchemaError < Error
       attr_reader :uri
 
       def initialize(uri)
+        super("Unexpected URI schema: #{uri.scheme}")
         @uri = uri
       end
     end
 
+    class FileNotFound < Error
+      attr_reader :path
+
+      def initialize(path)
+        super("No such a file: #{path}")
+        @path = path
+      end
+    end
+
     attr_reader :cache_path
     attr_reader :expires_in
     attr_reader :force_download
@@ -24,20 +34,26 @@ module Goodcheck
       uri = URI.parse(name)
 
       case uri.scheme
-      when nil, "file"
-        load_file uri, &block
+      when nil
+        load_file name, &block
+      when "file"
+        load_file uri.path, &block
       when "http", "https"
         load_http uri, &block
       else
-        raise UnexpectedSchemaError.new("Unexpected URI schema: #{uri.class.name}")
+        raise UnexpectedSchemaError.new(uri)
       end
     end
 
-    def load_file(uri)
-      path = (config_path.parent + uri.path)
-
-      begin
-        yield path.read
+    def load_file(path)
+      files = Dir.glob(File.join(config_path.parent.to_path, path), File::FNM_DOTMATCH | File::FNM_EXTGLOB).sort
+      if files.empty?
+        raise FileNotFound.new(path)
+      else
+        files.each do |file|
+          Goodcheck.logger.info "Reading file: #{file}"
+          yield File.read(file)
+        end
       end
     end
 
@@ -71,7 +87,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 +101,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/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "2.4.4"
+  VERSION = "2.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.6.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,20 +120,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.3
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -162,54 +148,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Dockerfile
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- cheatsheet.pdf
-- docusaurus/.dockerignore
-- docusaurus/.gitignore
-- docusaurus/Dockerfile
-- docusaurus/docker-compose.yml
-- docusaurus/docs/commands.md
-- docusaurus/docs/configuration.md
-- docusaurus/docs/development.md
-- docusaurus/docs/getstarted.md
-- docusaurus/docs/rules.md
-- docusaurus/website/README.md
-- docusaurus/website/core/Footer.js
-- docusaurus/website/package.json
-- docusaurus/website/pages/en/index.js
-- docusaurus/website/pages/en/versions.js
-- docusaurus/website/sidebars.json
-- docusaurus/website/siteConfig.js
-- docusaurus/website/static/css/code-block-buttons.css
-- docusaurus/website/static/css/custom.css
-- docusaurus/website/static/img/favicon.ico
-- docusaurus/website/static/js/code-block-buttons.js
-- docusaurus/website/versioned_docs/version-1.0.0/commands.md
-- docusaurus/website/versioned_docs/version-1.0.0/configuration.md
-- docusaurus/website/versioned_docs/version-1.0.0/development.md
-- docusaurus/website/versioned_docs/version-1.0.0/getstarted.md
-- 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
-- docusaurus/website/versions.json
-- docusaurus/website/yarn.lock
 - exe/goodcheck
-- goodcheck.gemspec
-- goodcheck.yml
 - lib/goodcheck.rb
 - lib/goodcheck/analyzer.rb
 - lib/goodcheck/array_helper.rb
@@ -222,6 +164,8 @@ files:
 - lib/goodcheck/commands/test.rb
 - lib/goodcheck/config.rb
 - lib/goodcheck/config_loader.rb
+- lib/goodcheck/error.rb
+- lib/goodcheck/exit_status.rb
 - lib/goodcheck/glob.rb
 - lib/goodcheck/home_path.rb
 - lib/goodcheck/import_loader.rb
@@ -234,17 +178,11 @@ files:
 - lib/goodcheck/rule.rb
 - lib/goodcheck/trigger.rb
 - lib/goodcheck/version.rb
-- logo/GoodCheck Horizontal.pdf
-- logo/GoodCheck Horizontal.png
-- logo/GoodCheck Horizontal.svg
-- logo/GoodCheck logo.png
-- logo/GoodCheck vertical.png
-- sample.yml
 homepage: https://github.com/sider/goodcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -259,8 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Regexp based customizable linter
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/vendor/bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.idea
-/Gemfile.lock
-/.ruby-version
-.DS_Store

data/.rubocop.yml

@@ -1,5 +0,0 @@
-# We don't use RuboCop.
-# If you really believe a Cop should be enabled, open pull requests for each Cop and explain why it matters.
-
-AllCops:
-  DisabledByDefault: true

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-script:
-  - bundle exec rake
-  - bundle exec rake docs:build
-branches:
-  only:
-    - master

data/Dockerfile

@@ -1,13 +0,0 @@
-FROM rubylang/ruby:2.6.3-bionic
-
-ENV DEBIAN_FRONTEND=noninteractive
-
-RUN mkdir /goodcheck
-WORKDIR /goodcheck
-COPY . /goodcheck/
-RUN rake install
-
-RUN mkdir /work
-WORKDIR /work
-
-ENTRYPOINT ["goodcheck"]

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in goodcheck.gemspec
-gemspec

data/Rakefile

@@ -1,50 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
-
-namespace :docker do
-  task :build do
-    sh 'docker', 'build', '-t', 'sider/goodcheck:dev', '.'
-  end
-end
-
-namespace :docs do
-  desc "Install dependencies for the documentation website"
-  task :install_deps do
-    on_docs_dir do
-      sh "yarn", "install"
-    end
-  end
-
-  desc "Build the documentation website"
-  task :build => [:install_deps] do
-    on_docs_dir do
-      sh "yarn", "run", "build"
-    end
-  end
-
-  desc "Update the version of the documentation website"
-  task :update_version => [:install_deps] do
-    on_docs_dir do
-      sh "yarn", "run", "version", Goodcheck::VERSION
-    end
-  end
-
-  desc "Publish the documentation website"
-  task :publish => [:build] do
-    on_docs_dir do
-      sh "yarn", "run", "publish-gh-pages"
-    end
-  end
-
-  def on_docs_dir(&block)
-    Dir.chdir "docusaurus/website", &block
-  end
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "goodcheck"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docusaurus/.dockerignore

@@ -1,2 +0,0 @@
-*/node_modules
-*.log

data/docusaurus/.gitignore

@@ -1,12 +0,0 @@
-.DS_Store
-
-node_modules
-
-lib/core/metadata.js
-lib/core/MetadataBlog.js
-
-website/translated_docs
-website/build/
-website/package-lock.json
-website/node_modules
-website/i18n/*

data/docusaurus/Dockerfile

@@ -1,10 +0,0 @@
-FROM node:8.11.4
-
-WORKDIR /app/website
-
-EXPOSE 3000 35729
-COPY ./docs /app/docs
-COPY ./website /app/website
-RUN yarn install
-
-CMD ["yarn", "start"]

data/docusaurus/docker-compose.yml

@@ -1,18 +0,0 @@
-version: "3"
-
-services:
-  docusaurus:
-    build: .
-    ports:
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website

data/docusaurus/docs/commands.md

@@ -1,69 +0,0 @@
----
-id: commands
-title: Commands
-sidebar_label: Commands
----
-
-
-## `goodcheck init [options]`
-
-The `init` command generates an example of a configuration file.
-
-Available options are:
-
-* `-c=[CONFIG]`, `--config=[CONFIG]` to specify the configuration file name to generate.
-* `--force` to allow overwriting of an existing config file.
-
-## `goodcheck check [options] targets...`
-
-The `check` command checks your programs under `targets...`.
-You can pass:
-
-* Directory paths, or
-* Paths to files.
-
-When you omit `targets`, it checks all files in `.`.
-
-Available options are:
-
-* `-c [CONFIG]`, `--config=[CONFIG]` to specify the configuration file.
-* `-R [rule]`, `--rule=[rule]` to specify the rules you want to check.
-* `--format=[text|json]` to specify output format.
-* `-v`, `--verbose` to be verbose.
-* `--debug` to print all debug messages.
-* `--force` to ignore downloaded caches.
-
-`goodcheck check` exits with:
-
-* `0` when it does not find any matching text fragment.
-* `2` when it finds some matching text.
-* `1` when it finds some error.
-
-You can check its exit status to identify if the tool finds some pattern or not.
-
-## `goodcheck test [options]`
-
-The `test` command tests rules.
-The test contains:
-
-* Validation of rule `id` uniqueness.
-* If `pass` examples does not match with any of `pattern`s.
-* If `fail` examples matches with some of `pattern`s.
-
-Use `test` command when you add a new rule to be sure you are writing rules correctly.
-
-Available options are:
-
-* `-c [CONFIG]`, `--config=[CONFIG]` to specify the configuration file.
-* `-v`, `--verbose` to be verbose.
-* `--debug` to print all debug messages.
-* `--force` to ignore downloaded caches
-
-## `goodcheck pattern [options] ids...`
-
-The `pattern` command prints the regular expressions generated from the patterns.
-The command is for debugging patterns, especially token patterns.
-
-The available option is:
-
-* `-c [CONFIG]`, `--config=[CONFIG]` to specify the configuration file.