goodcheck 0.1.0

data/lib/goodcheck/pattern.rb

@@ -0,0 +1,57 @@
+module Goodcheck
+  class Pattern
+    attr_reader :source
+    attr_reader :regexp
+
+    def initialize(source:, regexp:)
+      @source = source
+      @regexp = regexp
+    end
+
+    def self.literal(literal, case_insensitive:)
+      new(source: literal, regexp: Regexp.compile(Regexp.escape(literal), case_insensitive))
+    end
+
+    def self.regexp(regexp, case_insensitive:, multiline:)
+      options = 0
+      options |= Regexp::IGNORECASE if case_insensitive
+      options |= Regexp::MULTILINE if multiline
+
+      new(source: regexp, regexp: Regexp.compile(regexp, options))
+    end
+
+    def self.token(tokens)
+      new(source: tokens, regexp: compile_tokens(tokens))
+    end
+
+    def self.compile_tokens(source)
+      tokens = []
+      s = StringScanner.new(source)
+
+      until s.eos?
+        case
+        when s.scan(/\(|\)|\{|\}|\[|\]|\<|\>/)
+          tokens << Regexp.escape(s.matched)
+        when s.scan(/\s+/)
+          tokens << '\s+'
+        when s.scan(/(\p{Letter}|\w)+/)
+          tokens << Regexp.escape(s.matched)
+        when s.scan(%r{[!"#$%&'=\-^~¥\\|`@*:+;/?.,]+})
+          tokens << Regexp.escape(s.matched.rstrip)
+        when s.scan(/./)
+          tokens << Regexp.escape(s.matched)
+        end
+      end
+
+      if tokens.first =~ /\A\p{Letter}/
+        tokens.first.prepend('\b')
+      end
+
+      if tokens.last =~ /\p{Letter}\Z/
+        tokens.last << '\b'
+      end
+
+      Regexp.new(tokens.join('\s*').gsub(/\\s\*(\\s\+\\s\*)+/, '\s+'), Regexp::MULTILINE)
+    end
+  end
+end

data/lib/goodcheck/reporters/json.rb

@@ -0,0 +1,50 @@
+module Goodcheck
+  module Reporters
+    class JSON
+      attr_reader :stdout
+      attr_reader :stderr
+      attr_reader :issues
+
+      def initialize(stdout:, stderr:)
+        @stdout = stdout
+        @stderr = stderr
+        @issues = []
+      end
+
+      def analysis
+        stderr.puts "Starting analysis..."
+        yield
+
+        json = issues.map do |issue|
+          {
+            rule_id: issue.rule.id,
+            path: issue.path,
+            location: {
+              start_line: issue.location.start_line,
+              start_column: issue.location.start_column,
+              end_line: issue.location.end_line,
+              end_column: issue.location.end_column
+            },
+            message: issue.rule.message,
+            justifications: issue.rule.justifications
+          }
+        end
+        stdout.puts ::JSON.dump(json)
+      end
+
+      def file(path)
+        stderr.puts "Checking #{path}..."
+        yield
+      end
+
+      def rule(rule)
+        stderr.puts "  Checking #{rule.id}..."
+        yield
+      end
+
+      def issue(issue)
+        issues << issue
+      end
+    end
+  end
+end

data/lib/goodcheck/reporters/text.rb

@@ -0,0 +1,34 @@
+module Goodcheck
+  module Reporters
+    class Text
+      attr_reader :stdout
+
+      def initialize(stdout:)
+        @stdout = stdout
+      end
+
+      def analysis
+        yield
+      end
+
+      def file(path)
+        yield
+      end
+
+      def rule(rule)
+        yield
+      end
+
+      def issue(issue)
+        line = issue.buffer.line(issue.location.start_line).chomp
+        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 - end_column)
+        stdout.puts "#{issue.path}:#{issue.location.start_line}:#{colored_line}:\t#{issue.rule.message.lines.first.chomp}"
+      end
+    end
+  end
+end

data/lib/goodcheck/rule.rb

@@ -0,0 +1,21 @@
+module Goodcheck
+  class Rule
+    attr_reader :id
+    attr_reader :patterns
+    attr_reader :message
+    attr_reader :justifications
+    attr_reader :globs
+    attr_reader :passes
+    attr_reader :fails
+
+    def initialize(id:, patterns:, message:, justifications:, globs:, fails:, passes:)
+      @id = id
+      @patterns = patterns
+      @message = message
+      @justifications = justifications
+      @globs = globs
+      @passes = passes
+      @fails = fails
+    end
+  end
+end

data/lib/goodcheck/version.rb

@@ -0,0 +1,3 @@
+module Goodcheck
+  VERSION = "0.1.0"
+end

data/sample.yml

@@ -0,0 +1,28 @@
+rules:
+  - id: sample.debug_print
+    pattern:
+      - token: pp
+      - token: p
+    glob: "**/*.rb"
+    message: |
+      You should not use debug print
+    pass:
+      - render "app/views/welcome.html.erb"
+    fail:
+      - pp("Hello World")
+  - id: sample.index_zero
+    pattern:
+      - token: "[0]"
+    glob: "**/*.rb"
+    message: |
+      You can use #first instead of [0]
+    pass: array.first
+    fail: array[0]
+  - id: sample.closed_range
+    pattern:
+      - token: ...
+    glob: "**/*.rb"
+    message: |
+      Generally .. is better than ...
+    fail: 1...3
+    pass: 1..4

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: goodcheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: strong_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  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
+description: Regexp based customizable linter
+email:
+- matsumoto@soutaro.com
+executables:
+- goodcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/goodcheck
+- goodcheck.gemspec
+- lib/goodcheck.rb
+- lib/goodcheck/analyzer.rb
+- lib/goodcheck/array_helper.rb
+- lib/goodcheck/buffer.rb
+- lib/goodcheck/cli.rb
+- lib/goodcheck/commands/check.rb
+- lib/goodcheck/commands/config_loading.rb
+- lib/goodcheck/commands/init.rb
+- lib/goodcheck/commands/test.rb
+- lib/goodcheck/config.rb
+- lib/goodcheck/config_loader.rb
+- 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
+- lib/goodcheck/rule.rb
+- lib/goodcheck/version.rb
+- sample.yml
+homepage: https://github.com/sideci/goodcheck
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Regexp based customizable linter
+test_files: []