rabbitt-githooks 1.2.7

data/README.md

@@ -0,0 +1,4 @@
+githooks
+========
+
+GitHooks Gem

data/Rakefile

@@ -0,0 +1,19 @@
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'bundler/gem_tasks'

data/bin/githooks

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+if ENV['GITHOOKS_DEV']
+  $:.unshift(File.expand_path(File.join(File.expand_path(__FILE__), '/../../lib')))
+end
+require 'githooks'
+
+begin
+  GitHooks::CLI::Base.start(ARGV)
+rescue GitHooks::Error => e
+  puts e.message
+  exit 1
+end
+
+exit 0

data/bin/githooks-runner

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+if ENV['GITHOOKS_DEV']
+  $:.unshift(File.expand_path(File.join(File.expand_path(__FILE__), '/../../lib')))
+end
+require 'githooks'
+
+begin
+  GitHooks::Runner.run(
+    'args' => ARGV,
+    'hook' => ENV['GITHOOKS_HOOK']
+  )
+rescue GitHooks::Error => e
+  puts e.message
+  exit 1
+end
+exit 0

data/hooks/commit-messages.rb

@@ -0,0 +1,29 @@
+require 'githooks'
+
+SIMPLE_MESSAGES = /^\s*(blah|\.+|foo|bar|baz|nits?|)\s*$/
+
+GitHooks::Hook.register 'commit-msg' do
+  section 'Commit Message' do
+    action 'Message Length > 5 characters' do
+      on_argv do |args|
+        if args.empty?
+          $stderr.puts 'No commit message file passed in - are we executing in the commit-msg phase??'
+          return false
+        end
+
+        IO.read(args.first).size > 5 unless args.empty?
+      end
+    end
+
+    action 'Verify no simple commit messages' do
+      on_argv do |args|
+        if args.empty?
+          $stderr.puts 'No commit message file passed in - are we executing in the commit-msg phase??'
+          return false
+        end
+        # make sure there is at least one line that isn't a simple message
+        IO.read(args.first).split(/\n/).any? { |line| line !~ SIMPLE_MESSAGES }
+      end
+    end
+  end
+end

data/hooks/formatting.rb

@@ -0,0 +1,53 @@
+require 'githooks'
+
+RUBY_FILE_REGEXP = %r{^((app|lib)/.+\.rb|bin/.+)$}.freeze
+
+GitHooks::Hook.register 'pre-commit' do
+  commands 'scss-lint', :ruby, :rubocop
+
+    section 'Standards' do
+    action 'Validate Ruby Syntax' do
+      limit(:type).to :modified, :added, :untracked
+      limit(:path).to RUBY_FILE_REGEXP
+
+      on_each_file do |file|
+        ruby '-c', file.path, prefix_output: file.path
+      end
+    end
+
+    action 'Validate Ruby Standards' do
+      limit(:type).to :modified, :added, :untracked
+      limit(:path).to RUBY_FILE_REGEXP
+
+      on_all_files do |files|
+        rubocop '-D', '--format', 'clang', files, strip_empty_lines: true
+      end
+    end
+
+    action 'No Leading Tabs in Ruby files' do
+      limit(:type).to :modified, :added, :untracked
+      limit(:path).to RUBY_FILE_REGEXP
+
+      on_each_file do |file|
+        file.grep(/^[ ]*(\t+)/).tap do |matches|
+          matches.each do |line_number, line_text|
+            line_text.gsub!(/^[ ]*(\t+)/) do
+              underscores = '_' * $1.size
+              color_bright_red(underscores)
+            end
+            $stderr.printf "%s:%#{matches.last.first.to_s.size}d: %s\n", file.path, line_number, line_text
+          end
+        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/lib/githooks.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'pathname'
+require 'githooks/error'
+require 'githooks/core_ext'
+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'
+
+  class << self
+    attr_reader :debug, :verbose, :ignore_script
+
+    def debug?
+      return true if ENV['GITHOOKS_DEBUG']
+      return true if ARGV.include?('--debug')
+      return true if ARGV.include?('-d')
+      debug
+    end
+
+    def debug=(value)
+      @debug = !!value
+    end
+
+    def verbose?
+      return true if ENV['GITHOOKS_VERBOSE']
+      return true if ARGV.include?('--verbose')
+      return true if ARGV.include?('-v')
+      verbose
+    end
+
+    def verbose=(value)
+      @verbose = !!value
+    end
+
+    def ignore_script=(value)
+      @ignore_script = !!value
+    end
+
+    def hook_name
+      case GitHooks::HOOK_NAME.to_s
+        when 'githooks', 'irb', '', nil then 'pre-commit'
+        else GitHooks::HOOK_NAME
+      end
+    end
+  end
+
+  LIB_PATH = Pathname.new(__FILE__).dirname.realpath
+  GEM_PATH = LIB_PATH.parent
+  BIN_PATH = GEM_PATH + 'bin'
+
+  SCRIPT_PATH = Pathname.new($0)
+  SCRIPT_NAME = SCRIPT_PATH.basename.to_s
+  HOOK_NAME   = SCRIPT_NAME.to_s
+
+  if ARGV.include? '--ignore-script'
+    ARGV.delete('--ignore-script')
+    self.ignore_script = true
+  end
+end

data/lib/githooks/action.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+=begin
+Copyright (C) 2013 Carl P. Corliss
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require 'stringio'
+require 'open3'
+
+module GitHooks
+  class Action
+    include TerminalColors
+
+    attr_reader :title, :section, :on, :limiters, :success, :errors, :warnings
+    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 = []
+
+      instance_eval(&block)
+
+      waiting!
+    end
+
+    def manifest
+      @manifest ||= section.hook.manifest.filter(@limiters)
+    end
+
+    def colored_title
+      status_colorize title
+    end
+
+    def state_symbol
+      return status_colorize('?') unless finished?
+      status_colorize success? ? '✓' : 'X'
+    end
+
+    %w(finished running waiting).each do |method|
+      define_method(:"#{method}?") { @status == method.to_sym }
+      define_method(:"#{method}!") { @status = method.to_sym }
+    end
+
+    def status_colorize(text)
+      return color_dark_cyan(text) unless finished?
+      success? ? color_bright_green(text) : color_bright_red(text)
+    end
+
+    def run # rubocop:disable MethodLength
+      warnings, errors = StringIO.new, StringIO.new
+
+      begin
+        running!
+        $stdout, $stderr = warnings, errors
+        @success &= @on.call
+      rescue => error
+        errors.puts "Exception thrown during action call: #{error.class.name}: #{error.message}"
+
+        if !GitHooks.debug?
+          hooks_files = error.backtrace.select! { |line| line =~ %r{/hooks/} }
+          hooks_files.collect! { |line| line.split(':')[0..1].join(':') }
+          errors.puts "  -> in hook file:line, #{hooks_files.join("\n\t")}" unless hooks_files.empty?
+        else
+          errors.puts "\t#{error.backtrace.join("\n\t")}"
+        end
+
+        @success = false
+      ensure
+        @errors, @warnings = [errors, warnings].collect do |io|
+          io.rewind
+          io.read.split(/\n/)
+        end
+
+        $stdout, $stderr = STDOUT, STDERR
+        finished!
+      end
+
+      @success
+    end
+
+    def method_missing(method, *args, &block)
+      command = section.hook.find_command(method)
+      return super unless command
+      run_command(command, *args, &block)
+    end
+
+    # DSL Methods
+
+    def limit(what)
+      Repository::Limiter.new(what).tap do |limiter|
+        @limiters << limiter
+      end
+    end
+
+    def on_each_file(&block)
+      @on = -> { manifest.collect { |file| block.call(file) }.all? }
+    end
+
+    def on_all_files(&block)
+      @on = ->() { block.call manifest }
+    end
+
+    def on_argv(&block)
+      @on = ->() { block.call section.hook.args }
+    end
+
+    def on(*args, &block)
+      @on = ->() { block.call(*args) }
+    end
+
+  private
+
+    def run_command(command, *args, &block)
+      options = args.extract_options
+      prefix  = options.delete(:prefix_output)
+      args << options
+
+      command.execute(*args, &block).tap do |res|
+        res.output.split(/\n/).each do |line|
+          $stdout.puts prefix ? "#{prefix}: #{line}" : line
+        end
+
+        res.error.split(/\n/).each do |line|
+          $stderr.puts prefix ? "#{prefix}: #{line}" : line
+        end
+      end.status.success?
+    end
+  end
+end

data/lib/githooks/cli.rb

@@ -0,0 +1,93 @@
+require 'thor'
+
+module GitHooks
+  module CLI
+    autoload :Config, 'githooks/commands/config'
+
+    class Base < Thor
+      class_option :verbose, aliases: '-v', type: :boolean, desc: 'verbose output', default: false
+      class_option :debug, aliases: '-d', type: :boolean, desc: 'debug output', default: false
+
+      # githook attach [--hook <hook1,hookN>] [--script <path> | --path <path>] [--bootstrap <path>]
+      #   --  attaches the listed hooks (or all if none specified) to the githook runner
+      #       optionally sets the script XOR path
+      desc :attach, 'attach githooks to repository hooks'
+      method_option :bootstrap, type: :string, desc: 'Path to bootstrap script', default: nil
+      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
+      method_option :hooks, { # rubocop:disable BracesAroundHashParameters
+        type: :array,
+        desc: 'Path to repo to run tests on',
+        enum: Hook::VALID_PHASES,
+        default: Hook::VALID_PHASES
+      }
+      def attach
+        GitHooks.verbose = !!options['verbose']
+        GitHooks.debug = !!options['debug']
+
+        unless options['script'] || options['path']
+          fail ArgumentError, %q|Neither 'path' nor 'script' were specified - please provide at least one.|
+        end
+
+        Runner.attach(options)
+      end
+
+      # githook dettach [--hook <hook1,hookN>]
+      #   --  detaches the listed hooks, or all hooks if none specified
+      desc :detach, 'detach githooks from repository hooks'
+      method_option :repo, aliases: '-r', type: :string, desc: 'Path to repo to run tests on', default: Dir.getwd
+      method_option :hooks, { # rubocop:disable BracesAroundHashParameters
+        type: :array,
+        desc: 'Path to repo to run tests on',
+        enum: Hook::VALID_PHASES,
+        default: Hook::VALID_PHASES
+      }
+      def detach
+        GitHooks.verbose = !!options['verbose']
+        GitHooks.debug = !!options['debug']
+        Runner.detach(options['repo'], options['hooks'])
+      end
+
+      # githook list [--hook <hook1,hook2,hookN>]
+      #   --  lists tests for the given hook(s), or all hooks if none specified
+      desc :list, 'list tests assigned to given repository hooks'
+      method_option :repo, aliases: '-r', type: :string, desc: 'Path to repo to run tests on', default: Dir.getwd
+      def list
+        GitHooks.verbose = !!options['verbose']
+        GitHooks.debug = !!options['debug']
+        Runner.list(options['repo'])
+      end
+
+      # githooks run [--hook <hook1,hookN>] [--[un]staged] [--args -- one two three ... fifty]
+      #   --  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 :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
+      method_option :'skip-pre', type: :boolean, desc: 'Skip PreRun Scripts', default: false
+      method_option :'skip-post', type: :boolean, desc: 'Skip PostRun Scripts', default: false
+      method_option :'skip-bundler', type: :boolean, desc: %Q|Don't load bundler gemfile|, default: false
+      method_option :args, type: :array, desc: 'Args to pass to pre/post scripts and main testing script', default: []
+      def execute(*args)
+        GitHooks.verbose = !!options['verbose']
+        GitHooks.debug = !!options['debug']
+
+        opts = (options).dup
+        if opts['untracked'] && !opts['unstaged']
+          warn %q|--untracked requires --unstaged. Dropping option --untracked...|
+          opts['untracked'] = false
+        end
+
+        GitHooks::Runner.run(opts)
+      end
+
+      desc :config, 'manage githooks configuration'
+      subcommand :config, Config
+    end
+  end
+end