rabbitt-githooks 1.2.7

data/lib/githooks/commands/config.rb

@@ -0,0 +1,107 @@
+module GitHooks
+  module CLI
+    class Config < Thor
+      VALID_CONFIG_OPTIONS = %w( path script pre-run-execute post-run-execute )
+
+      # class_option :verbose, type: :boolean, desc: 'verbose output', default: false
+      # class_option :debug, type: :boolean, desc: 'debug output', default: false
+
+      class_option :global, aliases: '-G', type: :boolean, desc: 'use global config', default: false
+      class_option :hooks, { # rubocop:disable BracesAroundHashParameters
+        type: :array,
+        desc: 'choose specific hooks to affect',
+        enum: %w( pre-commit commit-msg )
+      }
+      class_option :repo, { # rubocop:disable BracesAroundHashParameters
+        aliases: '-r',
+        type: :string,
+        desc: 'Repository path to look up configuration values for.'
+      }
+
+      desc :get, 'display the value for a configuration option'
+      def get(option_name) # rubocop:disable MethodLength
+        unless VALID_CONFIG_OPTIONS.include? option_name
+          puts "Invalid option '#{option_name}': expected one of #{VALID_CONFIG_OPTIONS.join(', ')}"
+          return 1
+        end
+
+        GitHooks.verbose = true if options['verbose']
+        GitHooks.debug = true if options['debug']
+        options['repo'] ||= GitHooks::Repository.root_path
+
+        repo_data = GitHooks::Repository::Config.new.get(
+          option_name,
+          repo_path: options['repo'], global: options['global']
+        )
+        if repo_data.nil?
+          puts "Repository [#{options['repo']}] option '#{option_name}' is currently not set."
+          return
+        end
+        [repo_data].flatten.each do |value|
+          puts "#{option_name}: #{value || 'not set'}"
+        end
+      end
+
+      desc :set, 'Sets the configuration value '
+      method_option :'overwrite-all', { # rubocop:disable BracesAroundHashParameters
+        aliases: '-O',
+        type: :boolean,
+        desc: 'overwrite all existing values.',
+        default: false
+      }
+      def set(option_name, option_value)
+        GitHooks.verbose = true if options['verbose']
+        GitHooks.debug = true if options['debug']
+        options['repo'] ||= GitHooks::Repository.root_path
+
+        GitHooks::Repository::Config.new.set(
+          option_name,
+          option_value,
+          repo_path: options['repo'],
+          global: options['global'],
+          overwrite: options['overwrite-all']
+        ).status.success?
+      rescue ArgumentError => e
+        puts e.message
+      end
+
+      desc :unset, 'Unsets a configuration value'
+      def unset(option_name, option_value = nil)
+        GitHooks.verbose = true if options['verbose']
+        GitHooks.debug = true if options['debug']
+        options['repo'] ||= GitHooks::Repository.root_path
+
+        GitHooks::Repository::Config.new.unset(
+          option_name,
+          option_value,
+          repo_path: options['repo'],
+          global: options['global']
+        )
+      rescue ArgumentError => e
+        puts e.message
+      end
+
+      desc :list, 'Lists all githooks configuration values'
+      def list
+        puts options.inspect
+
+        GitHooks.verbose = true if options['verbose']
+        GitHooks.debug = true if options['debug']
+
+        options['repo'] ||= GitHooks::Repository.root_path
+        config = GitHooks::Repository::Config.new
+
+        githooks = config.list(global: options['global'], repo_path: options['repo'])['githooks']
+        githooks.each do |path, data|
+          puts "Repository #{path}:"
+          key_size, value_size = data.keys.collect(&:size).max, data.values.collect(&:size).max
+          data.each do |key, value|
+            [value].flatten.each do |v|
+              printf "    %-#{key_size}s : %-#{value_size}s\n", key, v
+            end
+          end
+        end if githooks
+      end
+    end
+  end
+end

data/lib/githooks/core_ext.rb

@@ -0,0 +1,23 @@
+=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_relative 'core_ext/array'
+require_relative 'core_ext/numbers'
+require_relative 'core_ext/string'
+require_relative 'core_ext/pathname'
+require_relative 'core_ext/process'

data/lib/githooks/core_ext/array.rb

@@ -0,0 +1,3 @@
+require_relative 'array/min_max'
+require_relative 'array/select_with_index'
+require_relative 'array/extract_options'

data/lib/githooks/core_ext/array/extract_options.rb

@@ -0,0 +1,5 @@
+class Array
+  def extract_options
+    last.is_a?(Hash) ? pop : {}
+  end
+end

data/lib/githooks/core_ext/array/min_max.rb

@@ -0,0 +1,37 @@
+=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_relative '../numbers/infinity'
+
+class Array
+  def min(&block)
+    collection = block_given? ? collect { |obj| yield obj } : self
+    collection.inject(Infinity) do |min, num|
+      min = num < min ? num : min
+      min
+    end
+  end
+
+  def max(&block)
+    collection = block_given? ? collect { |obj| yield obj } : self
+    collection.inject(0) do |max, num|
+      max = num > max ? num : max
+      max
+    end
+  end
+end

data/lib/githooks/core_ext/array/select_with_index.rb

@@ -0,0 +1,13 @@
+class Array
+  def select_with_index(regexp = nil, &block)
+    [].tap do |collection|
+      each_with_index do |node, index|
+        if regexp.is_a? Regexp
+          collection << [index, node] if node =~ regexp
+        elsif block_given?
+          collection << [index, node] if yield(node)
+        end
+      end
+    end
+  end
+end

data/lib/githooks/core_ext/numbers.rb

@@ -0,0 +1 @@
+require_relative 'numbers/infinity'

data/lib/githooks/core_ext/numbers/infinity.rb

@@ -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
+
+Infinity = 1.0 / 0 unless defined? Infinity

data/lib/githooks/core_ext/pathname.rb

@@ -0,0 +1,27 @@
+require 'pathname'
+
+if RUBY_ENGINE == 'jruby'
+  class Pathname
+    def realpath(basedir = nil)
+      unless (path = java_realpath(basedir)).exist?
+        fail Errno::ENOENT, path.to_s
+      end
+      path
+    end
+
+    def realdirpath(basedir = nil)
+      java_realpath(basedir)
+    end
+
+    def java_realpath(basedir = nil)
+      if basedir && !@path.start_with?('/')
+        path = self.class.new(basedir).realpath + @path
+      else
+        path = @path.to_s
+      end
+
+      self.class.new java.io.File.new(path.to_s).canonical_path
+    end
+    private :java_realpath
+  end
+end

data/lib/githooks/core_ext/process.rb

@@ -0,0 +1,7 @@
+class Process::Status
+  def failed?
+    !success?
+  end
+  alias_method :fail?, :failed?
+  alias_method :failure?, :failed?
+end

data/lib/githooks/core_ext/string.rb

@@ -0,0 +1,3 @@
+require_relative 'string/git_option_path_split'
+require_relative 'string/inflections'
+require_relative 'string/strip_empty_lines'

data/lib/githooks/core_ext/string/git_option_path_split.rb

@@ -0,0 +1,6 @@
+class String
+  def git_option_path_split
+    section, *subsection, option = split('.')
+    [section, subsection.join('.'), option]
+  end
+end

data/lib/githooks/core_ext/string/inflections.rb

@@ -0,0 +1,67 @@
+=begin
+  Mostly borrowed from Rails' ActiveSupport::Inflections
+=end
+
+class String
+  def constantize
+    names = split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    names.inject(Object) do |obj, name|
+      obj.const_defined?(name) ? obj.const_get(name) : obj.const_missing(name)
+    end
+  rescue NameError => e
+    raise unless e.message =~ /uninitialized constant/
+  end
+
+  def camelize
+    dup.camelize!
+  end
+
+  def camelize!
+    tap do
+      gsub!('-', '_')
+      sub!(/^[a-z\d]*/, &:capitalize)
+      gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+      gsub!('/', '::')
+    end
+  end
+
+  def underscore
+    dup.underscore!
+  end
+
+  def underscore!
+    tap do
+      gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      tr!('-', '_')
+      downcase!
+    end
+  end
+
+  def titleize
+    dup.titleize!
+  end
+  alias_method :titlize, :titleize
+
+  def titleize!
+    tap do
+      replace(
+        split(/\b/).collect(&:capitalize).join
+      )
+    end
+  end
+  alias_method :titlize!, :titleize!
+
+  def dasherize
+    dup.dasherize!
+  end
+
+  def dasherize!
+    tap do
+      underscore!
+      gsub!(/_/, '-')
+    end
+  end
+end

data/lib/githooks/core_ext/string/strip_empty_lines.rb

@@ -0,0 +1,9 @@
+class String
+  def strip_empty_lines!
+    replace(split(/\n/).reject(&:empty?).join("\n"))
+  end
+
+  def strip_empty_lines
+    dup.strip_empty_lines!
+  end
+end

data/lib/githooks/error.rb

@@ -0,0 +1,10 @@
+module GitHooks
+  class Error < StandardError
+    class NotAGitRepo < GitHooks::Error; end
+    class Registration < GitHooks::Error; end
+    class TestsFailed < GitHooks::Error; end
+    class AlreadyAttached < GitHooks::Error; end
+    class NotAttached < GitHooks::Error; end
+    class InvalidPhase < GitHooks::Error; end
+  end
+end

data/lib/githooks/hook.rb

@@ -0,0 +1,159 @@
+# 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_relative 'system_utils'
+
+module GitHooks
+  class Hook
+    VALID_PHASES = %w{ pre-commit commit-msg }.freeze
+
+    @__phases__ = {}
+    @__mutex__  = Mutex.new
+
+    class << self
+      def instances # rubocop:disable TrivialAccessors
+        @__phases__
+      end
+      alias_method :phases, :instances
+
+      def instance(phase = 'pre-commit')
+        phase = phase.to_s
+        unless VALID_PHASES.include? phase
+          valid_phases = VALID_PHASES.collect(&:inspect).join(', ')
+          fail ArgumentError, "Hook phase (#{phase.inspect}) must be one of #{valid_phases}"
+        end
+
+        return phases[phase] if phases[phase]
+
+        @__mutex__.synchronize do
+          return phases[phase] if phases[phase]
+          phases[phase] = new(phase)
+        end
+      end
+      private :instance
+
+      alias_method :[], :instance
+      private :[]
+
+      def method_missing(method, *args, &block)
+        return super unless instance.public_methods.include? method
+        instance.public_send(method, *args, &block)
+      end
+
+      def register(phase, &block)
+        fail ArgumentError, 'Missing required block to #register' unless block_given?
+        self[phase].instance_eval(&block)
+      end
+    end
+
+    attr_reader :sections, :phase, :repository, :repository_path
+    attr_accessor :args, :unstaged, :untracked
+
+    def initialize(phase)
+      @phase     = phase
+      @sections  = []
+      @commands  = []
+      @args      = []
+      @unstaged  = false
+      @untracked = false
+
+      repository_path = Dir.getwd # rubocop:disable UselessAssignment
+    end
+
+    def repository_path=(path)
+      @repository = Repository.new(path)
+    end
+
+    def manifest(options = {})
+      @manifest ||= Manifest.new(self)
+    end
+
+    def run
+      # only run sections that have actions matching files in the manifest
+      runable_sections = @sections.select { |section| !section.actions.empty? }
+      runable_sections.collect { |section| section.run }.all?
+    end
+
+    def method_missing(method, *args, &block)
+      command = find_command(method)
+      return super unless command
+      command.execute(*args, &block)
+    end
+
+    def setup_command(name, options = {})
+      name    = name.to_s.to_sym
+
+      @commands << SystemUtils::Command.new(
+        name,
+        path: options.delete(:path),
+        aliases: options.delete(:aliases) || options.delete(:alias)
+      )
+    end
+    private :setup_command
+
+    def find_command(name)
+      @commands.select { |command| command.aliases.include? name.to_s }.first
+    end
+
+    # DSL methods
+
+    def command(name, options = {})
+      setup_command name, options
+    end
+
+    def commands(*names)
+      return @commands if names.empty?
+      names.each { |name| command name }
+    end
+
+    def section(name, &block)
+      @sections << Section.new(name, self, &block)
+      self
+    end
+
+    class Manifest
+      attr_reader :hook
+      private :hook
+
+      def initialize(hook)
+        @hook = hook
+      end
+
+      def repo
+        @hook.repository
+      end
+
+      def manifest
+        @files ||= repo.manifest(
+          untracked: hook.untracked,
+          unstaged:  hook.unstaged
+        )
+      end
+
+      def filter(limiters)
+        manifest.dup.tap do |files|
+          limiters.each do |limiter|
+            puts "Limiter [#{limiter.type}] -> (#{limiter.only.inspect}) match against: " if GitHooks.debug?
+            limiter.limit(files)
+          end
+        end
+      end
+    end
+  end
+end