goodcheck 2.5.0 → 2.7.0

data/lib/goodcheck/reporters/json.rb

@@ -44,6 +44,10 @@ module Goodcheck
       def issue(issue)
         issues << issue
       end
+
+      def summary
+        # noop
+      end
     end
   end
 end

data/lib/goodcheck/reporters/text.rb

@@ -5,6 +5,8 @@ module Goodcheck
 
       def initialize(stdout:)
         @stdout = stdout
+        @file_count = 0
+        @issue_count = 0
       end
 
       def analysis
@@ -12,6 +14,7 @@ module Goodcheck
       end
 
       def file(path)
+        @file_count += 1
         yield
       end
 
@@ -20,21 +23,49 @@ module Goodcheck
       end
 
       def issue(issue)
+        @issue_count += 1
+
+        message = 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}"
+          start_line = issue.location.start_line
+          start_column = issue.location.start_column
+          start_column_index = start_column - 1
+          line = issue.buffer.line(start_line)
+          column_size = if issue.location.one_line?
+                          issue.location.column_size
+                        else
+                          line.bytesize - start_column
+                        end
+          stdout.puts "#{Rainbow(issue.path).cyan}:#{start_line}:#{start_column}: #{message}"
+          stdout.puts line.chomp
+          stdout.puts (" " * start_column_index) + Rainbow("^" + "~" * (column_size - 1)).yellow
         else
-          line = issue.buffer.line(1)&.chomp
-          line = line ? Rainbow(line).red : '-'
-          stdout.puts "#{issue.path}:-:#{line}:\t#{issue.rule.message.lines.first.chomp}"
+          stdout.puts "#{Rainbow(issue.path).cyan}:-:-: #{message}"
         end
       end
+
+      def summary
+        files = case @file_count
+                when 0
+                  "no files"
+                when 1
+                  "1 file"
+                else
+                  "#{@file_count} files"
+                end
+        issues = case @issue_count
+                 when 0
+                   Rainbow("no issues").green
+                 when 1
+                   Rainbow("1 issue").red
+                 else
+                   Rainbow("#{@issue_count} issues").red
+                 end
+
+        stdout.puts ""
+        stdout.puts "#{files} inspected, #{issues} detected"
+      end
     end
   end
 end

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "2.5.0"
+  VERSION = "2.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,64 +28,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
+        version: '0.18'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: strong_json
   requirement: !ruby/object:Gem::Requirement
@@ -110,30 +104,22 @@ dependencies:
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -162,55 +148,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Dockerfile
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- benchmark/gc.c
-- 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
@@ -223,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
@@ -235,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
@@ -260,8 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Regexp based customizable linter
 test_files: []

data/.github/workflows/test.yml

@@ -1,37 +0,0 @@
-name: Test
-
-on: [push]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - run: bundle install --jobs=4 --retry=3 --path=vendor/bundle
-      - run: bundle exec rake
-
-  build-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: 2.7
-      - run: bundle install --jobs=4 --retry=3 --path=vendor/bundle
-      - run: bundle exec rake docs:build
-
-  benchmark:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: 2.7
-      - run: bundle install --jobs=4 --retry=3 --path=vendor/bundle
-      - run: bundle exec rake benchmark:run[10000]

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/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,70 +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
-
-namespace :benchmark do
-  desc "Run benchmark"
-  task :run, [:n] do |_task, args|
-    require "benchmark"
-    require_relative "lib/goodcheck"
-    require_relative "lib/goodcheck/cli"
-
-    target_file = File.join(__dir__, "benchmark", "gc.c")
-
-    n = Integer(args[:n] || 1000)
-    puts "n = #{n}"
-
-    Benchmark.bm do |x|
-      x.report do
-        n.times { Goodcheck::CLI.new(stdout: STDOUT, stderr: STDERR).run(["check", target_file]) }
-      end
-    end
-  end
-end