pre-commit 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 146ff306168faa568a2db1614600c154eb8790c1
-  data.tar.gz: 76fd5d6e65008b287bc813ad2e42fc5a87541bba
+  metadata.gz: 3b3925dbdc545f62cd3ac2f1ecc78e95f79ba2be
+  data.tar.gz: 3fb7a0973a89765ac6ddd1898c8a2d379759ad6b
 SHA512:
-  metadata.gz: 384ffcb1c896628d770dff7cb4350441dfbea8d1b8f01b49292b724b44fea8a1c3aaead9b4756565669c310bf96bdf120cca8ba728a452d4194073833f40e622
-  data.tar.gz: a877a6837d4511adbc62b971d631017c6dbb209d379c0df5998b2d01b992a3834daac0143d35bf9eabbc3e5bcf856d558346885c6158e23e7e32d2b46c4834b5
+  metadata.gz: 052c70e54f7833c4adb7094cdfd73ea90664046f8af25d9a8c2cb50a933de025bad522a7872c23e08639ba485f5a43d36ec037117d3d6297a2f422daa13938e6
+  data.tar.gz: e6d37cbb422edd64b9714947904452963e9e1272dccbb2a98886646e8b75e2a6846ba67fcac40aa20e1a95025242d8565289b2b6be250a5f2053d941052cc2ed

data/README.md

@@ -86,10 +86,11 @@ Example `config/pre_commit.yml`:
 
 ## Configuration providers
 
-`pre-commit` comes with 3 configuration providers:
+`pre-commit` comes with 4 configuration providers:
 
 - `default` - basic settings, read only
 - `git` - reads configuration from `git config pre-commit.*`, allow local update
 - `yaml` - reads configuration from `/etc/pre-commit.yml`, `$HOME/.pre-commit.yml` and `config/pre-commit.yml`, allows `config/pre-commit.yml` updates
+- `env` - reads configuration from environment variables
 
 ## [Contributing](CONTRIBUTING.md)

data/lib/plugins/pre_commit/checks/coffeelint.rb

@@ -9,12 +9,20 @@ module PreCommit
         staged_files = staged_files.grep(/\.coffee$/)
         return if staged_files.empty?
 
-        args = staged_files.join(' ')
+        args = (config_file_flag + staged_files).join(' ')
 
         stdout, stderr, result = Open3.capture3("coffeelint #{args}")
         stdout + stderr unless result.success?
       end
 
+      def config_file_flag
+        config_file ? ['-f', config_file] : []
+      end
+
+      def alternate_config_file
+        'coffeelint.json'
+      end
+
       def self.description
         "Runs coffeelint to detect errors"
       end

data/lib/plugins/pre_commit/checks/jshint.rb

@@ -4,8 +4,8 @@ module PreCommit
   module Checks
     class Jshint < Js
 
-      def config
-        if config_file = [ENV['JSHINT_CONFIG'], ".jshintrc"].compact.detect { |f| File.exist?(f) }
+      def js_config
+        if config_file
           ExecJS.exec("return (#{File.read(config_file)});")
         else
           {}
@@ -14,13 +14,17 @@ module PreCommit
 
       def run_check(file)
         context = ExecJS.compile(File.read(linter_src))
-        context.call("JSHINT", File.read(file), config, config["globals"])
+        context.call("JSHINT", File.read(file), js_config, js_config["globals"])
       end
 
       def linter_src
         File.expand_path("../../../../pre-commit/support/jshint/jshint.js", __FILE__)
       end
 
+      def alternate_config_file
+        ".jshintrc"
+      end
+
       def self.description
         "Checks javascript files with JSHint."
       end

data/lib/plugins/pre_commit/checks/rubocop.rb

@@ -20,21 +20,8 @@ module PreCommit
       else
         staged_files = staged_files.grep(/\.rb$/)
         return if staged_files.empty?
-        config_file = config.get('rubocop.config')
-
-        args = staged_files
-        if !config_file.empty?
-          if !File.exist? config_file
-            $stderr.puts "Warning: rubocop config file '" + config_file + "' does not exist"
-            $stderr.puts "Set the path to the config file using:"
-            $stderr.puts "\tgit config pre-commit.rubocop.config 'path/relative/to/git/dir/rubocop.yml'"
-            $stderr.puts "Or in 'config/pre-commit.yml':"
-            $stderr.puts "\trubocop.config: path/relative/to/git/dir/rubocop.yml"
-            $stderr.puts "rubocop will use its default configuration or look for a .rubocop.yml file\n\n"
-          else
-            args = ['-c', config_file] + args
-          end
-        end
+
+        args = config_file_flag + staged_files
 
         success, captured = capture { ::Rubocop::CLI.new.run(args) == 0 }
         captured unless success
@@ -50,6 +37,14 @@ module PreCommit
         $stderr = stderr
       end
 
+      def config_file_flag
+        config_file ? ['-c', config_file] : []
+      end
+
+      def alternate_config_file
+        '.rubocop.yml'
+      end
+
       def self.description
         "Runs rubocop to detect errors."
       end

data/lib/plugins/pre_commit/configuration/providers/env.rb

@@ -0,0 +1,26 @@
+module PreCommit
+  class Configuration
+    class Providers
+
+      class Env
+        def self.priority
+          30
+        end
+
+        def [](name)
+          ENV[key(name)]
+        end
+
+        def update(name, value)
+          ENV[key(name)] = value
+        end
+
+      private
+
+        def key(name)
+          name.to_s.upcase.split('.').join('_')
+        end
+      end
+    end
+  end
+end

data/lib/pre-commit/checks/plugin.rb

@@ -1,6 +1,11 @@
+require 'plugins/pluginator/extensions/conversions'
+require 'pre-commit/checks/plugin/config_file'
+
 module PreCommit
   module Checks
     class Plugin
+      include Pluginator::Extensions::Conversions
+
       attr_accessor :pluginator, :config
 
       def initialize(pluginator, config, list)
@@ -8,6 +13,21 @@ module PreCommit
         @config     = config
         @list       = list
       end
+
+      def name
+        class2string(class2name(self.class))
+      end
+
+    private
+
+      def config_file
+        @config_file ||= ConfigFile.new(name, config, alternate_config_file)
+        @config_file.location
+      end
+
+      def alternate_config_file
+        ''
+      end
     end
   end
 end

data/lib/pre-commit/checks/plugin/config_file.rb

@@ -0,0 +1,68 @@
+module PreCommit
+  module Checks
+    class Plugin
+      class ConfigFile
+        def initialize(name, config, alternate_location)
+          @name = name
+          @config = config
+          @alternate_location = alternate_location
+        end
+
+        def location
+          return @location if defined?(@location)
+
+          @location = location_from_config || location_from_alternate
+        end
+
+      private
+        attr_reader :name, :config, :alternate_location
+
+        def location_from_config
+          location_from(config_location, true)
+        end
+
+        def location_from_alternate
+          location_from(alternate_location)
+        end
+
+        def location_from(location, show_usage = false)
+          if location && !location.empty?
+            if File.exist?(location)
+              location
+            else
+              usage if show_usage
+              nil
+            end
+          end
+        end
+
+        def config_location
+          @config_location ||= config.get(property_name)
+        end
+
+        def property_name
+          "#{name}.config"
+        end
+
+        def environment_variable_name
+          "#{name.upcase}_CONFIG"
+        end
+
+        def yaml_property_name
+          property_name.gsub(/_/, '.')
+        end
+
+        def usage
+          $stderr.puts "Warning: #{name} config file '#{config_location}' does not exist"
+          $stderr.puts "Set the path to the config file using:"
+          $stderr.puts "\tgit config pre-commit.#{property_name} 'path/relative/to/git/dir/#{name}.config'"
+          $stderr.puts "Or in 'config/pre-commit.yml':"
+          $stderr.puts "\t#{yaml_property_name}: path/relative/to/git/dir/#{name}.config"
+          $stderr.puts "Or set the environment variable:"
+          $stderr.puts "\texport #{environment_variable_name}='path/relative/to/git/dir/#{name}.config'"
+          $stderr.puts "#{name} will look for a configuration file in the project root or use its default behavior.\n\n"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: pre-commit
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Shajith Chacko, Josh Lubaway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !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: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   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'
 description: A git pre-commit hook written in ruby with a few more tricks up its sleeve
@@ -102,7 +102,6 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- README.md
 - bin/pre-commit
 - lib/plugins/pluginator/extensions/find_check.rb
 - lib/plugins/pre_commit/checks/before_all.rb
@@ -130,19 +129,20 @@ files:
 - lib/plugins/pre_commit/checks/ruby_symbol_hashrockets.rb
 - lib/plugins/pre_commit/checks/tabs.rb
 - lib/plugins/pre_commit/checks/whitespace.rb
-- lib/plugins/pre_commit/configuration/providers/README.md
 - lib/plugins/pre_commit/configuration/providers/default.rb
+- lib/plugins/pre_commit/configuration/providers/env.rb
 - lib/plugins/pre_commit/configuration/providers/git.rb
 - lib/plugins/pre_commit/configuration/providers/git_old.rb
+- lib/plugins/pre_commit/configuration/providers/README.md
 - lib/plugins/pre_commit/configuration/providers/yaml.rb
-- lib/pre-commit.rb
-- lib/pre-commit/checks.rb
 - lib/pre-commit/checks/grep.rb
 - lib/pre-commit/checks/js.rb
+- lib/pre-commit/checks/plugin/config_file.rb
 - lib/pre-commit/checks/plugin.rb
+- lib/pre-commit/checks.rb
 - lib/pre-commit/cli.rb
-- lib/pre-commit/configuration.rb
 - lib/pre-commit/configuration/providers.rb
+- lib/pre-commit/configuration.rb
 - lib/pre-commit/installer.rb
 - lib/pre-commit/list_evaluator.rb
 - lib/pre-commit/plugins_list.rb
@@ -153,32 +153,34 @@ files:
 - lib/pre-commit/support/jslint/lint.js
 - lib/pre-commit/utils/git_conversions.rb
 - lib/pre-commit/utils/staged_files.rb
+- lib/pre-commit.rb
 - templates/hooks/automatic
 - templates/hooks/default
 - templates/hooks/manual
+- README.md
 homepage: http://github.com/jish/pre-commit
 licenses:
 - Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
 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.2.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 3
 summary: A slightly better git pre-commit hook