rabbitt-githooks 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3e40cb17024ec5370eddeb7bb319bba3c375584b
-  data.tar.gz: 2c6e605e38d294cbc80bbbb6aa7b5b8b1e7bee46
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmVlMTFhYmNmYjA2YmM3NWJiMTA1YWNhMjk2MmE5ODhmZjQwZjZlYQ==
+  data.tar.gz: !binary |-
+    ZDQ3ZGMwYTI1MGY3NDc3ZmM2NTk0NGJkMjg1NjBlYWU5NTgyN2MwOQ==
 SHA512:
-  metadata.gz: fb6e899b1b945fca2df1ed0651f381359ba49c16868db5e19c96a0e052b33e5cf1fc8dead531aa571fbee00df546154740fbb264fb220ee3c4b770ebe7142a25
-  data.tar.gz: 5d713409381fe9e06f160f3bec990816f2f81813876ac32a64faf51b9e05e8f41ecc3ba060ca5b98b9d87412e4054b22a31cd3604af3c66b864cf741220548d9
+  metadata.gz: !binary |-
+    NDQ0YzkzNWQ4Yjc3NjQwYWYzNWQ5ZjIwZmM1MGZlOTQxYTJhNDFiODhjMTNl
+    ZWVkOGNmOTJhZmNhZGI1NjQ2ZDYxMTNiYzU5ZTA0MTFhMTUwODhkMmQ4MWZk
+    NzExZTY3MDQyNzAxMzNhMzA4MzU2YTdmOGE5YmUwOWQ1Y2E5YTI=
+  data.tar.gz: !binary |-
+    NDZiMTMyZDllMDZjZmE3Yjg2ZTcyODJiMWJkNDAzYjAxNDRjYjViYWY2ZjBm
+    YWRkNmY5MTc2ZGEyMGRlNDRiZmRiMjAzOGMyOGE0MTk5NDFhMmFlNDliODdj
+    N2I0MzI4NDY5MTkxNGFmMDhiMWIzZDFmMDA5MWE5NWVlYmFiY2I=

data/{hooks → .hooks}/formatting.rb

@@ -3,11 +3,11 @@ require 'githooks'
 RUBY_FILE_REGEXP = %r{^((app|lib)/.+\.rb|bin/.+)$}.freeze
 
 GitHooks::Hook.register 'pre-commit' do
-  commands 'scss-lint', :ruby, :rubocop
+  commands :ruby, :rubocop
 
-    section 'Standards' do
+  section 'Standards' do
     action 'Validate Ruby Syntax' do
-      limit(:type).to :modified, :added, :untracked
+      limit(:type).to :modified, :added, :untracked, :tracked
       limit(:path).to RUBY_FILE_REGEXP
 
       on_each_file do |file|
@@ -16,16 +16,16 @@ GitHooks::Hook.register 'pre-commit' do
     end
 
     action 'Validate Ruby Standards' do
-      limit(:type).to :modified, :added, :untracked
+      limit(:type).to :modified, :added, :untracked, :tracked
       limit(:path).to RUBY_FILE_REGEXP
 
       on_all_files do |files|
-        rubocop '-D', '--format', 'clang', files, strip_empty_lines: true
+        rubocop '-D', '--format', 'clang', files.collect(&:path), strip_empty_lines: true
       end
     end
 
     action 'No Leading Tabs in Ruby files' do
-      limit(:type).to :modified, :added, :untracked
+      limit(:type).to :modified, :added, :untracked, :tracked
       limit(:path).to RUBY_FILE_REGEXP
 
       on_each_file do |file|
@@ -40,14 +40,5 @@ GitHooks::Hook.register 'pre-commit' do
         end.empty?
       end
     end
-
-    action 'Validate CSS Syntax' do
-      limit(:type).to :modified, :added, :untracked
-      limit(:path).to %r{^(app|lib)/.+css$}
-
-      on_all_files do |files|
-        scss_lint files.collect(&:path)
-      end
-    end
   end
 end

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
-  Includes:
+  Include:
     - Rakefile
-  Excludes:
+  Exclude:
     - test.rb
     - bin/**
 
@@ -34,9 +34,9 @@ RegexpLiteral:
 DotPosition:
   Enabled: false
 
-MethodLength:
+Style/MethodLength:
   CountComments: false
-  Max: 15
+  Max: 20
 
 ParameterLists:
   Max: 5
@@ -71,3 +71,17 @@ EmptyLinesAroundAccessModifier:
 EndAlignment:
   AlignWith: variable
 
+Style/DoubleNegation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false

data/Gemfile.lock

@@ -1,36 +1,41 @@
 PATH
   remote: .
   specs:
-    rabbitt-githooks (1.2.7)
+    rabbitt-githooks (1.3.0)
       colorize (~> 0.5.8)
       thor (~> 0.18)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (1.1.0)
+    ast (2.0.0)
     colorize (0.5.8)
     diff-lcs (1.2.5)
     json (1.8.1)
-    parser (2.1.7)
-      ast (~> 1.1)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
     rainbow (2.0.0)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
+    rake (10.3.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.1)
+    rspec-expectations (2.99.1)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rubocop (0.18.1)
+    rspec-mocks (2.99.1)
+    rubocop (0.23.0)
       json (>= 1.7.7, < 2)
-      parser (~> 2.1.3)
+      parser (~> 2.1.9)
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-lint (2.0.1)
+      parser (~> 2.1, >= 2.1.1)
+      slop (~> 3.4, >= 3.4.7)
+    ruby-progressbar (1.5.1)
     slop (3.5.0)
     thor (0.19.1)
 
@@ -43,3 +48,4 @@ DEPENDENCIES
   rake (~> 10.1)
   rspec (~> 2.14)
   rubocop (~> 0.18)
+  ruby-lint (~> 2.0.1)

data/README.md

@@ -1,4 +1,110 @@
-githooks
-========
+rabbitt-githooks
+================
+
+# GitHooks
+
+Githooks provides a framework for creating standard pre-commit and commit-msg hooks for your git repository. These hooks run
+client side (not on a remote server), and can be used to validate your commits (actual deltas and commit messages), reducing
+the possibility of broken commits (or bad commit messages) making it into your repository.
+
+## Installation
+
+1. gem install rabbitt-githooks
+2. add rabbitt-githooks to the development group of your project's Gemfile
+2. setup your `project` to use githooks:
+
+```
+cd /path/to/project
+mkdir commit-hooks
+githooks attach --path /path/to/commit-hooks
+```
+
+With the hooks installed, you can run the checks against your staged or unstaged deltas before you commit, or just commit
+your deltas and have the checks run automatically.
+
+## Creating Tests
+
+### Tests Path
+
+All tests should be located under the path that was defined when attaching githooks to your project. In the following
+examples we'll assume a project root of `/work/projects/railsapp` and a hooks path of `/work/projects/railsapp/.hooks`.
+
+### Registration
+
+All hooks must be registered via ```GitHooks::Hook.register <PHASE>, <BLOCK>```
+
+### Commands
+### Sections
+### Actions
+#### Limiters (aka filters)
+#### on* (action executors)
+
+<dl>
+  <dt><strong>on_each_file(&block)</strong></dt>
+  <dd></dd>
+  <dt><strong>on_all_files(&block)</strong></dt>
+  <dd></dd>
+  <dt><strong>on_argv(&block)</strong></dt>
+  <dd></dd>
+</dl>
+
+#### pre-commit vs commit-msg
+
+## Command-Line Usage
+
+### Listing Attached Tests
+To view the list of checks currently attached to your repository:
+
+```
+$ cd /path/to/cms ; githooks list
+
+Main Testing Library with Tests (in execution order):
+  Tests loaded from:
+    /Users/jdoe/work/repos/myproject/commit-hooks
+
+  Phase PreCommit:
+      1: Standards
+        1: Validate Ruby Syntax
+          Limiter 1: :type -> [:modified, :added]
+          Limiter 2: :path -> /^(app|lib)\/.+\.rb$/
+        2: No Leading Spaces in Ruby files
+          Limiter 1: :type -> [:modified, :added]
+          Limiter 2: :path -> /^(app|lib)\/.+\.rb$/
+        3: Validate CSS Syntax
+          Limiter 1: :type -> [:modified, :added]
+          Limiter 2: :path -> /^(app|lib)\/.+css$/
+  Phase CommitMsg:
+      1: Commit Message
+        1: Message Length > 5 characters
+        2: Verify no simple commit messages
+```
+
+### Manually Running Tests
+
+To run the pre-commit hook on unstaged deltas, run the following command:
+
+```
+$ cd /path/to/cms ; githooks exec --unstaged
+===== PreCommit :: Standards =====
+  1. [ X ] Validate Ruby Syntax
+    X app/models/element.rb:245: syntax error, unexpected keyword_end, expecting end-of-input
+  2. [ X ] No Leading Spaces in Ruby files
+    X app/models/element.rb:4: _______# something here
+    X app/models/element.rb:5: __a = 1
+    X app/models/element.rb:6: ____
+  3. [ X ] Validate CSS Syntax
+    X app/assets/stylesheets/application.css.scss:4 [W] Prefer single quoted strings
+    X app/assets/stylesheets/application.css.scss:8 [W] Use // comments everywhere
+    X app/assets/stylesheets/application.css.scss:10 [W] Line should be indented 1 spaces, but was indented 2 spaces
+    X app/assets/stylesheets/application.css.scss:19 [W] Each selector in a comma sequence should be on its own line
+    X app/assets/stylesheets/application.css.scss:20 [W] Properties should be sorted in alphabetical order, with vendor-prefixed extensions before the standardized CSS property
+    X app/assets/stylesheets/application.css.scss:22 [W] `0.75` should be written without a leading zero as `.75`
+    X app/assets/stylesheets/application.css.scss:23 [W] `border: 0;` is preferred over `border: none;`
+    X app/assets/stylesheets/elements.css.scss:35 [W] Commas in function arguments should be followed by a single space
+    X app/assets/stylesheets/elements.css.scss:35 [W] Colon after property should be followed by 1 space instead of 0 spaces
+    X app/assets/stylesheets/elements.css.scss:35 [W] Commas in function arguments should be followed by a single space
+
+Commit failed due to errors listed above.
+Please fix and attempt your commit again.
+```
 
-GitHooks Gem

data/bin/githooks

@@ -12,4 +12,4 @@ rescue GitHooks::Error => e
   exit 1
 end
 
-exit 0
+exit 0

data/bin/githooks-runner

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# rubocop:disable Style/FileName
 
 if ENV['GITHOOKS_DEV']
   $:.unshift(File.expand_path(File.join(File.expand_path(__FILE__), '/../../lib')))

data/lib/githooks.rb

@@ -25,17 +25,17 @@ require 'githooks/version'
 module GitHooks
   AUTHOR = 'Carl P. Corliss <rabbitt@gmail.com>'
 
-  autoload :Config,            'githooks/config'
-  autoload :CommandRunner,     'githooks/command'
-  autoload :Command,           'githooks/command'
-  autoload :CLI,               'githooks/cli'
-  autoload :Hook,              'githooks/hook'
-  autoload :Section,           'githooks/section'
-  autoload :Action,            'githooks/action'
-  autoload :Repository,        'githooks/repository'
-  autoload :Runner,            'githooks/runner'
-  autoload :SystemUtils,       'githooks/system_utils'
-  autoload :TerminalColors,    'githooks/terminal_colors'
+  autoload :Config,         'githooks/config'
+  autoload :CommandRunner,  'githooks/command'
+  autoload :Command,        'githooks/command'
+  autoload :CLI,            'githooks/cli'
+  autoload :Hook,           'githooks/hook'
+  autoload :Section,        'githooks/section'
+  autoload :Action,         'githooks/action'
+  autoload :Repository,     'githooks/repository'
+  autoload :Runner,         'githooks/runner'
+  autoload :SystemUtils,    'githooks/system_utils'
+  autoload :TerminalColors, 'githooks/terminal_colors'
 
   class << self
     attr_reader :debug, :verbose, :ignore_script

data/lib/githooks/action.rb

@@ -19,25 +19,28 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 require 'stringio'
 require 'open3'
+require 'set'
 
 module GitHooks
-  class Action
+  class Action # rubocop:disable Style/ClassLength
     include TerminalColors
 
-    attr_reader :title, :section, :on, :limiters, :success, :errors, :warnings
+    attr_reader :title, :section, :on, :limiters
+    attr_reader :success, :errors, :warnings, :benchmark
     private :section, :on
     alias_method :success?, :success
 
     def initialize(title, section, &block)
       fail ArgumentError, 'Missing required block' unless block_given?
 
-      @title    = title
-      @section  = section
-      @on       = nil
-      @limiters = []
-      @success  = true
-      @errors   = []
-      @warnings = []
+      @title     = title
+      @section   = section
+      @on        = nil
+      @limiters  = Set.new
+      @success   = true
+      @errors    = []
+      @warnings  = []
+      @benchmark = 0
 
       instance_eval(&block)
 
@@ -73,6 +76,7 @@ module GitHooks
       begin
         running!
         $stdout, $stderr = warnings, errors
+        time_start = Time.now
         @success &= @on.call
       rescue => error
         errors.puts "Exception thrown during action call: #{error.class.name}: #{error.message}"
@@ -87,6 +91,7 @@ module GitHooks
 
         @success = false
       ensure
+        @benchmark = Time.now - time_start
         @errors, @warnings = [errors, warnings].collect do |io|
           io.rewind
           io.read.split(/\n/)
@@ -107,8 +112,8 @@ module GitHooks
 
     # DSL Methods
 
-    def limit(what)
-      Repository::Limiter.new(what).tap do |limiter|
+    def limit(type)
+      (find_limiter(type) || Repository::Limiter.new(type)).tap do |limiter|
         @limiters << limiter
       end
     end
@@ -131,6 +136,10 @@ module GitHooks
 
   private
 
+    def find_limiter(type)
+      @limiters.select { |l| l.type == type }.first
+    end
+
     def run_command(command, *args, &block)
       options = args.extract_options
       prefix  = options.delete(:prefix_output)

data/lib/githooks/cli.rb

@@ -59,13 +59,14 @@ module GitHooks
         Runner.list(options['repo'])
       end
 
-      # githooks run [--hook <hook1,hookN>] [--[un]staged] [--args -- one two three ... fifty]
+      # githooks execute [--[no-]staged] [--tracked] [--untracked] [--args -- one two three ...]
       #   --  runs the selected hooks (or pre-commit, if none specified) passing
       #       the argument list to the script
 
       desc :execute, 'Runs the selected hooks, passing the argument list to the script'
-      method_option :unstaged, aliases: '-U', type: :boolean, desc: 'test unstaged files', default: false
-      method_option :untracked, aliases: '-T', type: :boolean, desc: 'test unstaged files', default: false
+      method_option :staged, aliases: '-S', type: :boolean, desc: 'test staged files', default: nil
+      method_option :tracked, aliases: '-A', type: :boolean, desc: 'test all tracked files', default: false
+      method_option :untracked, aliases: '-T', type: :boolean, desc: 'test untracked files', default: false
       method_option :script, aliases: '-s', type: :string, desc: 'Path to script to run', default: nil
       method_option :path, aliases: '-p', type: :string, desc: 'Path to library of tests', default: nil
       method_option :repo, aliases: '-r', type: :string, desc: 'Path to repo to run tests on', default: Dir.getwd
@@ -78,11 +79,19 @@ module GitHooks
         GitHooks.debug = !!options['debug']
 
         opts = (options).dup
-        if opts['untracked'] && !opts['unstaged']
-          warn %q|--untracked requires --unstaged. Dropping option --untracked...|
-          opts['untracked'] = false
+
+        if opts['staged']
+          if opts['tracked']
+            warn %q|--tracked conflicts with --staged. Dropping --tracked...|
+            opts['tracked'] = false
+          elsif opts['untracked']
+            warn %q|--untracked conflicts with --staged. Dropping --untracked...|
+            opts['untracked'] = false
+          end
         end
 
+        opts['staged'] = !(opts['tracked'] || opts['untracked']) if opts['staged'].nil?
+
         GitHooks::Runner.run(opts)
       end