gnurr 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3974d42c9302a023ce25057a3a1da60327bcf340
+  data.tar.gz: 88eeb9666d2c41c0cee93b81832332f2bc92a58d
+SHA512:
+  metadata.gz: 61a83db2076c426c1902bfed82b57f07f60673903facc607164c1fbf41b5828395ab495400bc26937f095fb7fbe67e8616766b3666da585a8bb1942d86ae7658
+  data.tar.gz: 48b66de7de833b1c326100978175486a0b98dc54ca7d05d1afb3de1d913d0d503fa8223ca6ee610d99e18da18828e1e68795dd151de3ba4e3e5b1f21c25f87e4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gnurr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Ben Saufley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Gnurr
+
+### _n._ The substance that collects over time in the bottoms of pockets or cuffs of trousers; pocket lint.
+
+[![Gem Version](https://badge.fury.io/rb/gnurr.svg)](https://badge.fury.io/rb/gnurr)
+[![Code Climate](https://codeclimate.com/github/bensaufley/gnurr/badges/gpa.svg)](https://codeclimate.com/github/bensaufley/gnurr)
+[![Test Coverage](https://codeclimate.com/github/bensaufley/gnurr/badges/coverage.svg)](https://codeclimate.com/github/bensaufley/gnurr/coverage)
+[![Issue Count](https://codeclimate.com/github/bensaufley/gnurr/badges/issue_count.svg)](https://codeclimate.com/github/bensaufley/gnurr)
+
+Runs ESLint, SCSS-Lint, HAML-Lint, and Rubocop and returns info relevant to changed lines as reported by git.
+
+## Installation
+
+**This gem is not yet hosted elsewhere.** To install, clone the repo, then
+`cd` into that directory and build the gem.
+
+```bash
+$ git clone https://github.com/bensaufley/gnurr
+$ bundle install
+…
+$ rake install
+```
+
+If you intend to use [ESLint], be sure to [install that in npm][npm-install].
+The other linters – [HAML-Lint], [Rubocop], and [SCSS-Lint] – are all listed as
+gem dependencies.
+
+As this gem is built to work with your git diffs, it does also require git.
+If you've managed to execute the above code, you're already there.
+
+### Eventually, you'll be able to:
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'gnurr', group: :development, require :false
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install gnurr
+```
+
+## Usage
+
+In Ruby:
+
+```rb
+gnurr = Gnurr::Processor.new(options)
+# Options:
+# branch: base branch to diff (default: master)
+# linters: which linters to run (default: es,haml,ruby,scss (all))
+# verbose: turn on verbose mode
+gnurr.execute
+```
+
+In your shell:
+
+```sh
+$ gnurr --help
+Usage: gnurr [options]
+    -b, --branch NAME                Base branch: branch to diff against (default: master)
+    -l, --linters LIST               Linters to use (default: es,haml,ruby,scss (all))
+    -v, --verbose                    Verbose mode (false unless specified)
+    -h, --help                       Prints this help
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/bensaufley/gnurr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[ESLint]: http://eslint.org
+[HAML-Lint]: https://github.com/brigade/haml-lint
+[Rubocop]: https://github.com/bbatsov/rubocop
+[SCSS-Lint]: https://github.com/brigade/scss-lint
+[npm-install]: http://eslint.org/docs/user-guide/getting-started

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/gnurr

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'gnurr'
+require 'optparse'
+
+options = {
+  stdout: true
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: gnurr [options]'
+
+  opts.on('-b', '--branch NAME', 'Base branch: branch to diff against (default: master)') { |v| options[:branch] = v }
+  opts.on('-l', '--linters LIST', 'Linters to use (default: es,haml,ruby,scss (all))') { |v| options[:linters] = v.split(',').map(&:to_sym) }
+  opts.on('-v', '--verbose', 'Verbose mode (false unless specified)') { options[:verbose] = true }
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  option_parser.parse!
+rescue OptionParser::InvalidOption => error
+  puts "Gnurr doesn't recognize that #{error}"
+  exit
+rescue OptionParser::AmbiguousOption => error
+  puts "That's an #{error}"
+  exit
+end
+
+linter = Gnurr::Processor.new(options)
+
+linter.execute

data/lib/gnurr.rb

@@ -0,0 +1,9 @@
+require 'gnurr/version'
+require 'json'
+require 'colorize'
+
+require 'gnurr/es_linter'
+require 'gnurr/haml_linter'
+require 'gnurr/ruby_linter'
+require 'gnurr/scss_linter'
+require 'gnurr/processor'

data/lib/gnurr/es_linter.rb

@@ -0,0 +1,38 @@
+require 'gnurr/linter'
+
+module Gnurr
+  # ES/JS Linter
+  class EsLinter < Linter
+    def type
+      :es
+    end
+
+    def color
+      :red
+    end
+
+    def command
+      'eslint -f json'
+    end
+
+    def filter(file)
+      File.extname(file) == '.js'
+    end
+
+    private
+
+    def map_errors(file)
+      [
+        file['filePath'],
+        file['messages'].map do |message|
+          next unless @files[file['filePath'].sub("#{pwd}/", '')].include?(message['line'])
+          standardize(message, 'column', 'line', 'ruleId', 'message', 'severity', 2)
+        end.reject(&:nil?)
+      ]
+    end
+
+    def pwd
+      @pwd ||= `printf $(pwd)`
+    end
+  end
+end

data/lib/gnurr/haml_linter.rb

@@ -0,0 +1,22 @@
+require 'gnurr/ruby_base_linter'
+
+module Gnurr
+  # HAML Linter
+  class HamlLinter < RubyBaseLinter
+    def type
+      :haml
+    end
+
+    def color
+      :magenta
+    end
+
+    def command
+      'haml-lint -r json'
+    end
+
+    def filter(file)
+      File.extname(file) == '.haml'
+    end
+  end
+end

data/lib/gnurr/linter.rb

@@ -0,0 +1,123 @@
+module Gnurr
+  # Base linter class from which each linter extends
+  class Linter
+    def initialize(files, options)
+      @options = options
+      @files = Hash[files.select { |file, _lines| filter(file) }]
+      @messages = {} if @files.empty?
+      relevant_messages
+    end
+
+    def format_errors
+      puts_line_diffs if @options[:verbose]
+      return if relevant_messages.empty?
+      puts "#{left_bump(2)}Messages:".colorize(mode: :bold)
+      relevant_messages.each do |filename, messages|
+        messages.each do |message|
+          puts left_bump(3) + format_error(filename, message)
+        end
+      end
+      relevant_messages
+    end
+
+    def format_error(filename, message)
+      filename.colorize(color: color) + ':' +
+        format_line(message) + ' ' +
+        format_severity(message) + ' ' +
+        message[:message] +
+        format_linter(message)
+    end
+
+    def errors(json)
+      return [] unless json && !json.empty?
+      json.map { |files| map_errors(files) }
+          .select { |_f, messages| messages && !messages.empty? }
+    end
+
+    def puts_line_diffs
+      diffs = line_diffs
+      if diffs.empty?
+        puts "#{left_bump(2)}No changes.".colorize(mode: :bold)
+      else
+        puts "#{left_bump(2)}Lines changed:".colorize(mode: :bold)
+        diffs.each do |filename, lines|
+          puts "#{left_bump(3)}#{filename}:#{lines.join(', ').colorize(:cyan)}"
+        end
+      end
+    end
+
+    def line_diffs
+      Hash[
+        @files.map do |filename, lines|
+          [filename, array_to_ranges(lines)]
+        end
+      ]
+    end
+
+    def relevant_messages
+      @messages ||= errors(JSON.parse(`git diff --name-only --diff-filter=ACMRTUXB #{@options[:branch]} #{@files.map(&:first).join(' ')} | xargs #{command}`))
+    rescue => e
+      if @options[:stdout]
+        puts "#{'ERROR'.colorize(:red)}: #{e}"
+        puts e.backtrace if @options[:verbose]
+      else
+        warn("Error: #{e}")
+      end
+      @messages = {}
+    end
+
+    def pretty_print
+      puts "#{left_bump}Linting #{@type.to_s.colorize(color)}…".colorize(mode: :bold)
+      format_errors || puts("#{left_bump(2)}#{"#{@type.to_s.upcase} all clear! ✔".colorize(color: :light_green)}")
+      puts "#{left_bump}Done linting #{@type.to_s.colorize(color)}\n".colorize(mode: :bold) if @options[:verbose]
+    end
+
+    private
+
+    def array_to_ranges(array)
+      array = array.compact.uniq.sort
+      ranges = []
+      return ranges if array.empty?
+      left = array.first
+      right = nil
+      array.each do |obj|
+        if right && obj != right.succ
+          ranges << Range.new(left, right)
+          left = obj
+        end
+        right = obj
+      end
+      ranges + [Range.new(left, right)]
+    end
+
+    def format_line(message)
+      (message[:line].to_s + (message[:column] ? ':' + message[:column].to_s : '')).colorize(:cyan)
+    end
+
+    def format_severity(message)
+      message[:severity] == :error ? '[E]'.colorize(:red) : '[W]'.colorize(:yellow)
+    end
+
+    def format_linter(message)
+      message[:linter] ? " (#{message[:linter]})".colorize(:cyan) : ''
+    end
+
+    def left_bump(indent = 1)
+      '▎'.ljust(indent * 2).colorize(color: color)
+    end
+
+    def map_errors(errors)
+      # Empty: filled by subclasses
+    end
+
+    def standardize(message, column, line, linter, description, severity, error)
+      {
+        column: message[column],
+        line: message[line],
+        linter: message[linter],
+        message: message[description],
+        severity: message[severity] == error ? :error : :warning
+      }
+    end
+  end
+end

data/lib/gnurr/processor.rb

@@ -0,0 +1,54 @@
+module Gnurr
+  # Main class for execution
+  class Processor
+    LINTERS = {
+      es: EsLinter,
+      haml: HamlLinter,
+      ruby: RubyLinter,
+      scss: ScssLinter
+    }.freeze
+
+    def initialize(options)
+      if options[:linters] && !options[:linters].empty?
+        options[:linters] = LINTERS.keys & options[:linters]
+      end
+      @options = {
+        branch: 'master',
+        linters: LINTERS.keys,
+        stdout: false,
+        verbose: false
+      }.merge(options)
+    end
+
+    def execute
+      lints = {}
+      @options[:linters].each do |type|
+        lints[type] = LINTERS[type].new(diffs, @options)
+        lints[type].pretty_print if @options[:stdout]
+      end
+      lints
+    end
+
+    private
+
+    def extract_line_sets(diffs)
+      diffs.map do |lines|
+        nums = lines.match(/^.+\+(?<from>[0-9]+)(,(?<len>[0-9]+))? .+$/)
+        Range.new(nums[:from].to_i, nums[:from].to_i + nums[:len].to_i)
+      end.map(&:to_a).flatten
+    end
+
+    def line_diffs(file)
+      diffs = `git diff --unified=0 #{@options[:branch]} #{file} | egrep '\\+[0-9]+(,[1-9][0-9]*)? '`.split("\n")
+      extract_line_sets(diffs)
+    end
+
+    def diffs
+      return @diff if @diff
+      diff = `git diff #{@options[:branch]} --name-only --diff-filter=ACMRTUXB`
+             .split("\n")
+             .map { |file| [file, line_diffs(file)] }
+      @diff = Hash[diff.select { |_k, v| v && !v.empty? }]
+    end
+  end
+end

data/lib/gnurr/ruby_base_linter.rb

@@ -0,0 +1,32 @@
+require 'gnurr/linter'
+
+module Gnurr
+  # Class from which Haml and Ruby extend
+  class RubyBaseLinter < Linter
+    def errors(json)
+      super(json['files'])
+    end
+
+    private
+
+    def map_errors(file)
+      [
+        file['path'],
+        file['offenses'].map do |message|
+          next unless @files[file['path']].include?(message['location']['line'])
+          standardize(message)
+        end.reject(&:nil?)
+      ]
+    end
+
+    def standardize(message)
+      {
+        column: message['location']['column'], # nil in haml-lint
+        line: message['location']['line'],
+        linter: message['cop_name'], # nil in haml-lint
+        message: message['message'],
+        severity: message['severity'] == 'error' ? :error : :warning
+      }
+    end
+  end
+end

data/lib/gnurr/ruby_linter.rb

@@ -0,0 +1,26 @@
+require 'gnurr/ruby_base_linter'
+
+module Gnurr
+  # Ruby Linter
+  class RubyLinter < RubyBaseLinter
+    def type
+      :ruby
+    end
+
+    def color
+      :yellow
+    end
+
+    def command
+      'rubocop -f json'
+    end
+
+    def filter(file)
+      eligible_files.include?(file)
+    end
+
+    def eligible_files
+      @eligible_files ||= `rubocop -L`.split("\n")
+    end
+  end
+end

data/lib/gnurr/scss_linter.rb

@@ -0,0 +1,35 @@
+require 'gnurr/linter'
+
+module Gnurr
+  # SASS Linter
+  class ScssLinter < Linter
+    def type
+      :scss
+    end
+
+    def color
+      :blue
+    end
+
+    def command
+      'scss-lint -f JSON'
+    end
+
+    def filter(file)
+      File.extname(file) == '.scss'
+    end
+
+    private
+
+    def map_errors(params)
+      filename, messages = params
+      [
+        filename,
+        messages.map do |message|
+          next unless @files[filename].include?(message['line'])
+          standardize(message, 'column', 'line', 'linter', 'reason', 'severity', 'error')
+        end.reject(&:nil?)
+      ]
+    end
+  end
+end

data/lib/gnurr/version.rb

@@ -0,0 +1,3 @@
+module Gnurr
+  VERSION = '0.2.1'.freeze
+end

data/linte.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gnurr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gnurr'
+  spec.version       = Gnurr::VERSION
+  spec.authors       = ['Ben Saufley']
+  spec.email         = ['contact@bensaufley.com']
+  spec.summary       = 'Diff-specific linter'
+  spec.description   = 'Runs ESLint, SCSS-Lint, HAML-Lint, and Rubocop and returns info relevant to changed lines as reported by git.'
+  spec.homepage      = 'http://github.com/bensaufley/gnurr'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.requirements += [
+    'git',
+    'npm and eslint for JS linting'
+  ]
+
+  spec.required_ruby_version = '~> 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'git', '~> 1.3.0'
+  spec.add_development_dependency 'colorize'
+  spec.add_development_dependency 'haml_lint', '~> 0.16.1'
+  spec.add_development_dependency 'scss_lint', '~> 0.47.0'
+  spec.add_development_dependency 'rubocop', '~> 0.37.2'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: gnurr
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Ben Saufley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: scss_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+description: Runs ESLint, SCSS-Lint, HAML-Lint, and Rubocop and returns info relevant
+  to changed lines as reported by git.
+email:
+- contact@bensaufley.com
+executables:
+- gnurr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gnurr
+- lib/gnurr.rb
+- lib/gnurr/es_linter.rb
+- lib/gnurr/haml_linter.rb
+- lib/gnurr/linter.rb
+- lib/gnurr/processor.rb
+- lib/gnurr/ruby_base_linter.rb
+- lib/gnurr/ruby_linter.rb
+- lib/gnurr/scss_linter.rb
+- lib/gnurr/version.rb
+- linte.gemspec
+homepage: http://github.com/bensaufley/gnurr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- git
+- npm and eslint for JS linting
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Diff-specific linter
+test_files: []