gnurr 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3974d42c9302a023ce25057a3a1da60327bcf340
-  data.tar.gz: 88eeb9666d2c41c0cee93b81832332f2bc92a58d
+  metadata.gz: 6a1410c6508df47eca91d6925eef3e939f31d9d7
+  data.tar.gz: b86e3ad6538174203af4986a072416a0c6bab212
 SHA512:
-  metadata.gz: 61a83db2076c426c1902bfed82b57f07f60673903facc607164c1fbf41b5828395ab495400bc26937f095fb7fbe67e8616766b3666da585a8bb1942d86ae7658
-  data.tar.gz: 48b66de7de833b1c326100978175486a0b98dc54ca7d05d1afb3de1d913d0d503fa8223ca6ee610d99e18da18828e1e68795dd151de3ba4e3e5b1f21c25f87e4
+  metadata.gz: 2c8f93c2e60d0941e95c073d36bbfe0b5db367adb0c401cb3c1ca9e1dba07534b9a18298f0309eeb2e31ef4f3cac02ce67892ebe046a09bd103c0b1bcf98d022
+  data.tar.gz: 0f5cec29cb40f13bf85c688f90657ffa3b8459385e99f1c3c272613b5b137403f63ba17534b4cf91eb8bbdfd6b28975f298a49e12da381031a358d2561d996f8

data/README.md

@@ -11,24 +11,10 @@ Runs ESLint, SCSS-Lint, HAML-Lint, and Rubocop and returns info relevant to chan
 
 ## 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:
+Make sure you've installed the [Linters](#available-linters) you'd like to use.
 
 Add this line to your application's Gemfile:
 
@@ -72,6 +58,16 @@ Usage: gnurr [options]
     -h, --help                       Prints this help
 ```
 
+## Available Linters
+
+Below are the currently-supported linters. They are not required by this
+gem and must be independently installed.
+
+- [ESLint] for JavaScript ([requires npm][npm-install])
+- [HAML-Lint] (~> 0.16.1) for HAML
+- [Rubocop] (~> 0.47.0) for Ruby
+- [SCSS-Lint] (~> 0.37.2) for SCSS
+
 ## Contributing
 
 1. Fork it ( https://github.com/bensaufley/gnurr/fork )

data/bin/gnurr

@@ -12,9 +12,26 @@ options = {
 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('-b', '--branch NAME',
+          'Base branch: branch to diff against (default: master)') do |v|
+    options[:branch] = v
+  end
+  opts.on('-e', '--expanded',
+          'Show lints for all changed files, not just changed lines (false',
+          'unless specified)') do
+    options[:expanded] = true
+  end
+  opts.on('-l', '--linters LIST',
+          'Linters to use (default: es,haml,ruby,scss (all))') do |v|
+    options[:linters] = v.split(',').map(&:to_sym)
+  end
+  opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+    options[:verbose] = v
+  end
+  opts.on('--version', 'Show version') do
+    puts Gnurr::VERSION
+    exit
+  end
 
   opts.on('-h', '--help', 'Prints this help') do
     puts opts

data/{linte.gemspec → gnurr.gemspec}

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.requirements += [
     'git',
-    'npm and eslint for JS linting'
+    'npm and eslint for JS linting',
+    'haml_lint for Ruby linting',
+    'scss_lint for SCSS linting',
+    'rubocop for Ruby linting'
   ]
 
   spec.required_ruby_version = '~> 2.3.0'
@@ -27,8 +30,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'colorize'
 end

data/lib/gnurr/cli.rb

@@ -0,0 +1,83 @@
+module Gnurr
+  # For outputting stuff using the command-line tool
+  module CLI
+    def print_messages
+      format_start
+      format_messages || format_all_clear
+      format_finish
+      messages
+    end
+
+    private
+
+    def format_all_clear
+      puts "#{left_bump(2)}#{"#{type.to_s.upcase} all clear! ✔"
+        .colorize(color: :light_green)}"
+    end
+
+    def format_messages
+      format_line_diffs if @options[:verbose]
+      return if messages.empty?
+      puts "#{left_bump(2)}Messages:".colorize(mode: :bold)
+      messages.each do |filename, messages|
+        messages.each do |message|
+          puts format_error(filename, message)
+        end
+      end
+      messages
+    end
+
+    def format_error(filename, message)
+      left_bump(3) +
+        filename.colorize(color: color) + ':' +
+        format_line(message) + ' ' +
+        format_severity(message) + ' ' +
+        message[:message] +
+        format_linter(message)
+    end
+
+    def format_finish
+      if @options[:verbose]
+        puts "#{left_bump}Done linting #{type.to_s.colorize(color)}\n"
+          .colorize(mode: :bold)
+      else
+        puts
+      end
+    end
+
+    def format_line(message)
+      line = message[:line].to_s
+      line += ':' + message[:column].to_s if message[:column]
+      line.colorize(:cyan)
+    end
+
+    def format_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 format_linter(message)
+      message[:linter] ? " (#{message[:linter]})".colorize(:cyan) : ''
+    end
+
+    def format_severity(message)
+      if message[:severity] == :error
+        '[E]'.colorize(:red)
+      else
+        '[W]'.colorize(:yellow)
+      end
+    end
+
+    def format_start
+      puts "#{left_bump}Linting #{type.to_s.colorize(color)}…"
+        .colorize(mode: :bold)
+    end
+  end
+end

data/lib/gnurr/es_linter.rb

@@ -21,18 +21,32 @@ module Gnurr
 
     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?)
-      ]
+    def file_path(file)
+      file['filePath']
+    end
+
+    def file_messages(file)
+      file['messages']
+    end
+
+    def requirements_met?
+      !`eslint -v`.nil?
+    rescue
+      false
     end
 
     def pwd
       @pwd ||= `printf $(pwd)`
     end
+
+    def standardize_message(message)
+      {
+        column: message['column'],
+        line: message['line'],
+        linter: message['ruleId'],
+        message: message['message'],
+        severity: message['severity'] == 2 ? :error : :warning
+      }
+    end
   end
 end

data/lib/gnurr/haml_linter.rb

@@ -18,5 +18,11 @@ module Gnurr
     def filter(file)
       File.extname(file) == '.haml'
     end
+
+    private
+
+    def requirements_met?
+      Gem::Specification.find_all_by_name('haml_lint').any?
+    end
   end
 end

data/lib/gnurr/helper.rb

@@ -0,0 +1,33 @@
+module Gnurr
+  # Miscellaneous helper methods for the gem
+  module Helper
+    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 left_bump(indent = 1)
+      '▎'.ljust(indent * 2).colorize(color: color)
+    end
+
+    def log_error(e)
+      if @options[:stdout]
+        puts "#{'ERROR'.colorize(:red)}: #{e}"
+        puts e.backtrace if @options[:verbose]
+      else
+        warn("Error: #{e}")
+      end
+    end
+  end
+end

data/lib/gnurr/linter.rb

@@ -1,51 +1,43 @@
+require 'gnurr/helper'
+require 'gnurr/cli'
+
 module Gnurr
   # Base linter class from which each linter extends
   class Linter
+    include Gnurr::Helper
+    include Gnurr::CLI
+
     def initialize(files, options)
+      raise "Dependency not available for #{type}" unless requirements_met?
       @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)
+    rescue => e
+      log_error(e)
     end
 
-    def errors(json)
-      return [] unless json && !json.empty?
-      json.map { |files| map_errors(files) }
-          .select { |_f, messages| messages && !messages.empty? }
+    def execute
+      @options[:stdout] ? print_messages : messages
     end
 
-    def puts_line_diffs
-      diffs = line_diffs
-      if diffs.empty?
-        puts "#{left_bump(2)}No changes.".colorize(mode: :bold)
+    def parse_messages(json)
+      return [] unless json.any?
+      messages = json.map { |files| map_errors(files) }
+                     .select { |_f, msgs| msgs && msgs.any? }
+      if @options[:expanded]
+        messages
       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
+        filter_messages(messages)
       end
     end
 
+    def filter_messages(messages)
+      messages.map do |filename, msgs|
+        msgs.reject! { |msg| !@files[filename].include?(msg[:line]) }
+        msgs.empty? ? nil : [filename, msgs]
+      end.reject(&:nil?)
+    end
+
     def line_diffs
       Hash[
         @files.map do |filename, lines|
@@ -55,68 +47,40 @@ module Gnurr
     end
 
     def relevant_messages
-      @messages ||= errors(JSON.parse(`git diff --name-only --diff-filter=ACMRTUXB #{@options[:branch]} #{@files.map(&:first).join(' ')} | xargs #{command}`))
+      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]
+      log_error(e)
+      {}
     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)
+    def requirements_met?
+      true # Set by subclasses
     end
 
-    def format_linter(message)
-      message[:linter] ? " (#{message[:linter]})".colorize(:cyan) : ''
-    end
-
-    def left_bump(indent = 1)
-      '▎'.ljust(indent * 2).colorize(color: color)
+    def map_errors(file)
+      [
+        file_path(file),
+        file_messages(file).map do |message|
+          standardize_message(message)
+        end.reject(&:nil?)
+      ]
     end
 
-    def map_errors(errors)
-      # Empty: filled by subclasses
+    def messages
+      @messages ||= parse_messages(relevant_messages)
     end
 
-    def standardize(message, column, line, linter, description, severity, error)
+    def standardize_message(message)
       {
-        column: message[column],
-        line: message[line],
-        linter: message[linter],
-        message: message[description],
-        severity: message[severity] == error ? :error : :warning
+        column: message['column'],
+        line: message['line'],
+        linter: message['linter'],
+        message: message['message'],
+        severity: message['severity'] == 'error' ? :error : :warning
       }
     end
   end

data/lib/gnurr/processor.rb

@@ -8,12 +8,13 @@ module Gnurr
       scss: ScssLinter
     }.freeze
 
-    def initialize(options)
-      if options[:linters] && !options[:linters].empty?
+    def initialize(options = {})
+      if options[:linters] && options[:linters].any?
         options[:linters] = LINTERS.keys & options[:linters]
       end
       @options = {
         branch: 'master',
+        expanded: false,
         linters: LINTERS.keys,
         stdout: false,
         verbose: false
@@ -23,32 +24,37 @@ module Gnurr
     def execute
       lints = {}
       @options[:linters].each do |type|
-        lints[type] = LINTERS[type].new(diffs, @options)
-        lints[type].pretty_print if @options[:stdout]
+        begin
+          lints[type] = LINTERS[type].new(git_diffs, @options)
+          lints[type].execute
+        rescue => e
+          lints[type] = e.inspect
+        end
       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
+    def git_diffs
+      return @diff if @diff
+      diff = `git diff #{@options[:branch]} --name-only --diff-filter=ACMRTUXB`
+             .split("\n")
+             .map { |file| [file, file_diffs(file)] }
+      @diff = Hash[diff.select { |_k, v| v && v.any? }]
     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)
+    def file_diffs(file)
+      diffs = `git diff --unified=0 #{@options[:branch]} #{file} \
+              | egrep '\\+[0-9]+(,[1-9][0-9]*)? '`
+      line_diffs(diffs.split("\n"))
     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? }]
+    def line_diffs(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
   end
 end

data/lib/gnurr/ruby_base_linter.rb

@@ -3,23 +3,21 @@ require 'gnurr/linter'
 module Gnurr
   # Class from which Haml and Ruby extend
   class RubyBaseLinter < Linter
-    def errors(json)
-      super(json['files'])
+    private
+
+    def file_path(file)
+      file['path']
     end
 
-    private
+    def file_messages(file)
+      file['offenses']
+    end
 
-    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?)
-      ]
+    def messages
+      @messages ||= parse_messages(relevant_messages['files'])
     end
 
-    def standardize(message)
+    def standardize_message(message)
       {
         column: message['location']['column'], # nil in haml-lint
         line: message['location']['line'],

data/lib/gnurr/ruby_linter.rb

@@ -22,5 +22,11 @@ module Gnurr
     def eligible_files
       @eligible_files ||= `rubocop -L`.split("\n")
     end
+
+    private
+
+    def requirements_met?
+      Gem::Specification.find_all_by_name('rubocop').any?
+    end
   end
 end

data/lib/gnurr/scss_linter.rb

@@ -21,15 +21,26 @@ module Gnurr
 
     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?)
-      ]
+    def file_path(params)
+      params[0]
+    end
+
+    def file_messages(params)
+      params[1]
+    end
+
+    def requirements_met?
+      Gem::Specification.find_all_by_name('scss_lint').any?
+    end
+
+    def standardize_message(message)
+      {
+        column: message['column'],
+        line: message['line'],
+        linter: message['linter'],
+        message: message['reason'],
+        severity: message['severity'] == 'error' ? :error : :warning
+      }
     end
   end
 end

data/lib/gnurr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnurr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ben Saufley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,47 +67,19 @@ dependencies:
       - !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
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.37.2
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: '0'
 description: Runs ESLint, SCSS-Lint, HAML-Lint, and Rubocop and returns info relevant
   to changed lines as reported by git.
 email:
@@ -123,16 +95,18 @@ files:
 - README.md
 - Rakefile
 - bin/gnurr
+- gnurr.gemspec
 - lib/gnurr.rb
+- lib/gnurr/cli.rb
 - lib/gnurr/es_linter.rb
 - lib/gnurr/haml_linter.rb
+- lib/gnurr/helper.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
@@ -154,8 +128,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - git
 - npm and eslint for JS linting
+- haml_lint for Ruby linting
+- scss_lint for SCSS linting
+- rubocop for Ruby linting
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Diff-specific linter