gnurr 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67dd4c735c0af29c5c40a74d9b25241e723172e4
-  data.tar.gz: cd92ee12536108edb616fc4dff5ea0e62d04a7bb
+  metadata.gz: ec8dc0ae5118bc1e00b8ac8831c5a48e133fa857
+  data.tar.gz: c1b3154f7600edcc0073cf1bc94bac6a067caf30
 SHA512:
-  metadata.gz: bd4cd3f9f819d4337b2763d0e1b4a3aeac3386285e0a8d7551a77b9326966a98af2ccabded9138394341a6fd30ef3b9a27d3a09658d26ac9b34f487645b9ef73
-  data.tar.gz: cdb97a4c2f40696efcda774e10811545fd21afc43942e94bdcdf5d109d952d756cb85771adf5991523b7569900ae3a04081440b7dd26b6f72efc8f3dbd30dc4c
+  metadata.gz: a441515d7b3fd646d64ebae22d92f22ec0044d32219cf866560b3deaa6349671712a7752adc1d449801866a27e3a7bbe4155d8836e53c2b40b37979323880c21
+  data.tar.gz: cbef0d8c7e1a8c0f411aad2820b6580029aa133dc7ed1057f1472fef2d19d5850af5ce7240b0b0183c8953139c9ddd7cbaa8192ba73c4639481279c369649ac6

data/README.md

@@ -41,8 +41,10 @@ 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))
+# base: Base reference: branch, SHA, etc for diff (default: master)
+# expanded: Show lints for all changed files, not just changed lines
+#   (false unless specified)
+# linters: Linters to use (default: es,haml,ruby,scss (all))
 # verbose: turn on verbose mode
 gnurr.execute
 ```
@@ -52,9 +54,12 @@ In your shell:
 ```sh
 $ gnurr --help
 Usage: gnurr [options]
-    -b, --branch NAME                Base branch: branch to diff against (default: master)
+    -b, --base NAME                  Base reference: branch, SHA, etc for diff (default: master)
+    -e, --expanded                   Show lints for all changed files, not just changed lines (false
+                                     unless specified)
     -l, --linters LIST               Linters to use (default: es,haml,ruby,scss (all))
-    -v, --verbose                    Verbose mode (false unless specified)
+    -v, --[no-]verbose               Run verbosely
+        --version                    Show version
     -h, --help                       Prints this help
 ```
 

data/bin/gnurr

@@ -14,7 +14,7 @@ option_parser = OptionParser.new do |opts|
 
   opts.on('-b', '--base NAME',
           'Base reference: branch, SHA, etc for diff (default: master)') do |v|
-    options[:branch] = v
+    options[:base] = v
   end
 
   opts.on('-e', '--expanded',

data/gnurr.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.requirements += [
     'git',
     'npm and eslint for JS linting',
-    'haml_lint for Ruby linting',
+    'haml_lint for HAML linting',
     'scss_lint for SCSS linting',
     'rubocop for Ruby linting'
   ]

data/lib/gnurr.rb

@@ -1,9 +1,3 @@
 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/cli.rb

@@ -1,6 +1,11 @@
+require 'colorize'
+require 'gnurr/helper'
+
 module Gnurr
   # For outputting stuff using the command-line tool
   module CLI
+    include Gnurr::Helper
+
     def print_messages
       format_start
       format_messages || format_all_clear

data/lib/gnurr/git.rb

@@ -1,6 +1,10 @@
+require 'gnurr/helper'
+
 module Gnurr
   # For handling/reading Git output
   module Git
+    include Gnurr::Helper
+
     private
 
     def extract_lines(diffs)
@@ -12,14 +16,14 @@ module Gnurr
 
     def full_file_diff
       return @diff if @diff
-      diff = `git diff #{@options[:branch]} --name-only --diff-filter=ACMRTUXB`
+      diff = `git diff #{@options[:base]} --name-only --diff-filter=ACMRTUXB`
                .split("\n")
                .map { |file| [file, file_diffs(file)] }
       @diff = Hash[diff.select { |_k, v| v && v.any? }]
     end
 
     def file_diffs(file)
-      diffs = `git diff --unified=0 #{@options[:branch]} #{file} \
+      diffs = `git diff --unified=0 #{@options[:base]} #{escaped_filename(file)} \
               | egrep '\\+[0-9]+(,[1-9][0-9]*)? '`
       extract_lines(diffs.split("\n"))
     end

data/lib/gnurr/helper.rb

@@ -1,3 +1,5 @@
+require 'colorize'
+
 module Gnurr
   # Miscellaneous helper methods for the gem
   module Helper
@@ -17,6 +19,10 @@ module Gnurr
       ranges + [Range.new(left, right)]
     end
 
+    def escaped_filename(filename)
+      filename.sub(/(\s)/,'\\\\\1')
+    end
+
     def left_bump(indent = 1)
       '▎'.ljust(indent * 2).colorize(color: color)
     end

data/lib/gnurr/linter.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 require 'gnurr/helper'
 require 'gnurr/cli'
 require 'gnurr/git'
@@ -10,7 +12,12 @@ module Gnurr
     include Gnurr::Git
 
     def initialize(options)
-      @options = options
+      @options = {
+        base: 'master',
+        expanded: false,
+        stdout: false,
+        verbose: false
+      }.merge(options)
       raise "Dependency not available for #{type}" unless requirements_met?
     rescue => e
       log_error(e)
@@ -71,7 +78,7 @@ module Gnurr
 
     def escaped_files
       files.map do |file, _lines|
-        file.sub(/(\s)/, '\\\\\1')
+        escaped_filename(file)
       end
     end
 
@@ -96,7 +103,7 @@ module Gnurr
       false # Can't lint from base class
     end
 
-    def standardize_message(message)
+    def standardize_message(_message)
       raise 'Can\'t standardize on base Linter class'
     end
   end

data/lib/gnurr/linters/es_linter.rb

@@ -0,0 +1,58 @@
+require 'gnurr/linter'
+
+module Gnurr
+  module Linters
+    # 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 file_path(file)
+        file['filePath']
+      end
+
+      def file_messages(file)
+        file['messages']
+      end
+
+      def relative_filename(filename)
+        filename.sub(%r{^#{pwd}/}, '')
+      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
+end

data/lib/gnurr/linters/haml_linter.rb

@@ -0,0 +1,32 @@
+require 'gnurr/linters/ruby_based_linters'
+
+module Gnurr
+  module Linters
+    # HAML Linter
+    class HamlLinter
+      include Gnurr::Linters::RubyBasedLinters
+
+      def type
+        :haml
+      end
+
+      def color
+        :magenta
+      end
+
+      def command
+        'haml-lint -r json'
+      end
+
+      def filter(file)
+        File.extname(file) == '.haml'
+      end
+
+      private
+
+      def requirements_met?
+        Gem::Specification.find_all_by_name('haml_lint').any?
+      end
+    end
+  end
+end

data/lib/gnurr/linters/ruby_based_linters.rb

@@ -0,0 +1,33 @@
+require 'gnurr/linter'
+
+module Gnurr
+  module Linters
+    # Class from which Haml and Ruby extend
+    module RubyBasedLinters
+      private
+
+      def file_path(file)
+        file['path']
+      end
+
+      def file_messages(file)
+        file['offenses']
+      end
+
+      def messages
+        return @messages = {} if files.empty?
+        @messages ||= parse_messages(relevant_messages['files'])
+      end
+
+      def standardize_message(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
+end

data/lib/gnurr/linters/ruby_linter.rb

@@ -0,0 +1,36 @@
+require 'gnurr/linters/ruby_based_linters'
+
+module Gnurr
+  module Linters
+    # Ruby Linter
+    class RubyLinter < Linter
+      include Gnurr::Linters::RubyBasedLinters
+
+      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
+
+      private
+
+      def requirements_met?
+        Gem::Specification.find_all_by_name('rubocop').any?
+      end
+    end
+  end
+end

data/lib/gnurr/linters/scss_linter.rb

@@ -0,0 +1,48 @@
+require 'gnurr/linter'
+
+module Gnurr
+  module Linters
+    # 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 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
+end

data/lib/gnurr/processor.rb

@@ -1,37 +1,42 @@
+require 'gnurr/linters/es_linter'
+require 'gnurr/linters/haml_linter'
+require 'gnurr/linters/ruby_linter'
+require 'gnurr/linters/scss_linter'
+
 module Gnurr
   # Main class for execution
   class Processor
     LINTERS = {
-      es: EsLinter,
-      haml: HamlLinter,
-      ruby: RubyLinter,
-      scss: ScssLinter
+      es: Gnurr::Linters::EsLinter,
+      haml: Gnurr::Linters::HamlLinter,
+      ruby: Gnurr::Linters::RubyLinter,
+      scss: Gnurr::Linters::ScssLinter
     }.freeze
 
     def initialize(options = {})
-      if options[:linters] && options[:linters].any?
-        options[:linters] = LINTERS.keys & options[:linters]
+      @options = options
+      if @options[:linters] && options[:linters].any?
+        @options[:linters] = LINTERS.keys & @options[:linters]
+      else
+        @options[:linters] = LINTERS.keys
       end
-      @options = {
-        branch: 'master',
-        expanded: false,
-        linters: LINTERS.keys,
-        stdout: false,
-        verbose: false
-      }.merge(options)
     end
 
     def execute
-      lints = {}
+      @lints ||= {}
       @options[:linters].each do |type|
         begin
-          lints[type] = LINTERS[type].new(@options)
-          lints[type].execute
+          @lints[type] = LINTERS[type].new(@options)
+          @lints[type].execute
         rescue => e
-          lints[type] = e.inspect
+          @lints[type] = e.inspect
         end
       end
-      lints
+      @lints
+    end
+
+    def lints
+      @lints ||= {}
     end
   end
 end

data/lib/gnurr/version.rb

@@ -1,3 +1,3 @@
 module Gnurr
-  VERSION = '0.2.5'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnurr
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Saufley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,15 +72,15 @@ files:
 - gnurr.gemspec
 - lib/gnurr.rb
 - lib/gnurr/cli.rb
-- lib/gnurr/es_linter.rb
 - lib/gnurr/git.rb
-- lib/gnurr/haml_linter.rb
 - lib/gnurr/helper.rb
 - lib/gnurr/linter.rb
+- lib/gnurr/linters/es_linter.rb
+- lib/gnurr/linters/haml_linter.rb
+- lib/gnurr/linters/ruby_based_linters.rb
+- lib/gnurr/linters/ruby_linter.rb
+- lib/gnurr/linters/scss_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
 homepage: http://github.com/bensaufley/gnurr
 licenses:
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - git
 - npm and eslint for JS linting
-- haml_lint for Ruby linting
+- haml_lint for HAML linting
 - scss_lint for SCSS linting
 - rubocop for Ruby linting
 rubyforge_project: 

data/lib/gnurr/es_linter.rb

@@ -1,56 +0,0 @@
-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 file_path(file)
-      file['filePath']
-    end
-
-    def file_messages(file)
-      file['messages']
-    end
-
-    def relative_filename(filename)
-      filename.sub(%r{^#{pwd}/}, '')
-    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

@@ -1,28 +0,0 @@
-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
-
-    private
-
-    def requirements_met?
-      Gem::Specification.find_all_by_name('haml_lint').any?
-    end
-  end
-end

data/lib/gnurr/ruby_base_linter.rb

@@ -1,31 +0,0 @@
-require 'gnurr/linter'
-
-module Gnurr
-  # Class from which Haml and Ruby extend
-  class RubyBaseLinter < Linter
-    private
-
-    def file_path(file)
-      file['path']
-    end
-
-    def file_messages(file)
-      file['offenses']
-    end
-
-    def messages
-      return @messages = {} if files.empty?
-      @messages ||= parse_messages(relevant_messages['files'])
-    end
-
-    def standardize_message(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

@@ -1,32 +0,0 @@
-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
-
-    private
-
-    def requirements_met?
-      Gem::Specification.find_all_by_name('rubocop').any?
-    end
-  end
-end

data/lib/gnurr/scss_linter.rb

@@ -1,46 +0,0 @@
-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 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