captain_hoog 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76efe495daab6c9cb797d8655f422921bb5df37b
+  data.tar.gz: 4af041128e853f57f09fbc8f00f38abd75c91340
+SHA512:
+  metadata.gz: 83dca455c5b053422a4302622da2becb562c62a11ce45d5a07b363859b5caf9b813ebcd8a666c6b8d44e98dc052edeffcbd894abcf40324768b1c5b0efe401f1
+  data.tar.gz: 3d89084556792db6e51a56ab884065396ab41b3d074e36595c0d9f39ef0ee076f95c3a50d6876ba0e7ca185cb23cedca886243ec8dee66404b3c9f4394cbdf42

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in captain_hoog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Schmidt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# CaptainHoog
+
+Okay. That's not such a funny gem name. But it's a reference to Git and the subject
+of the gem: the Git Hooks.
+
+<img src="http://dyxygd30hex7h.cloudfront.net/sites/www.prismaticart.com/files/PRISMATIC_ADAM.jpg" height="450">
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'captain_hoog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install captain_hoog
+
+## Usage
+
+### Install the hook
+
+```
+githoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> --project_dir <PATH_TO_PROJECT>
+```
+
+**Please note:**  ```<PATH_TO_PLUGINS>``` and ```<PATH_TO_PROJECT>``` must be given as absolute paths.
+Also make sure to run this from your git repository's root folder.
+
+```GIT_HOOK_TYPE``` may be something like this
+
+* pre-commit (default)
+* pre-push
+* pre-rebase
+* pre-applypatch
+
+If the directory where pre-git test should be done, differs from the working directory adjust:
+
+```
+--project_dir
+```
+
+to your needs. You can omit this.
+
+```
+--plugins_dir
+```
+
+is not required anymore. If it's omited it will point to the actual directory you run the install script from. It should point to the directory you store the CaptainHoog plugins.
+
+_A note about plugin directories:_ All plugins must be placed in one directory. You can select which plugin is called from which Git hook later by defining it in the Hoogfile.
+
+### Removing the hook
+
+Remove a hook by using the
+
+```
+githoog remove --type <GIT_HOOK_TYPE>
+```
+
+command.
+
+where ```<GIT_HOOK_TYPE>``` is ```pre-commit``` by default.
+
+### The Hoogfile
+
+All plugin executable and ignoring power is configurable in the Hoogfile. The Hoogfile's name is ```hoogfile.yml``` and it will be installed in your Git root directory. If you install several hooks, the installer will ask you if you want to override the config file.
+
+The Hoogfile has several sections:
+
+* hook plugins per type
+* project dir
+* plugins dir
+
+Some options are predefined from your information you provided during installation:
+
+* project dir
+* plugins dir
+
+If this did not matches your need anymore, just pass the new paths in there.
+
+Captain Hoog is doing nothing by default. You have explicitly define which plugins it should run or which not. You do this per hook type. E.g. for ```pre-commit```:
+
+```
+pre-commit:
+  - cucumber
+  - rspec
+```
+
+So the plugins named **cucumber** and **rspec** are running before your commit applies to the index.
+
+
+
+### Migrating from pre 1.0 versions
+
+There is no migration path from previous versions. Just re-install and adjust the Hoogfile to your previous configuration.  
+
+### Writing plugins
+
+A CaptainHoog plugin is written with a very simple DSL that used with the following expressions:
+
+* ```test```
+* ```message```
+* ```helper```
+* ```run```
+
+Within ```test``` any stuff is done that either forces the commit to exit or
+to pass. Whatever you want to do like syntax checking, code style checking -
+implement it and make sure you return a boolean value.
+
+```message``` is used to define a notifiaction that is shown to the user if
+the test **fails**. This obviously must return a String.  
+
+You have to add a description (or name) to your plugin, this description (or name) will be used to check if the plugin should be executed or not by adding the plugins name to the section <hook plugins per type> of your Hoogfile.
+
+```rb
+git.describe 'sample' do |pre|
+
+  pre.test do
+    # do any test like code style guide, syntax checking...
+    # Must return a boolean value.
+  end
+
+  pre.message do
+    # Define a message string here that is shown if the test fails.
+  end
+
+end  
+```
+
+With ```helper``` you can extract some logic into a helper method that is useable anywhere
+in the plugin.
+
+```rb
+git.describe 'logger' do |pre|
+
+  pre.helper :collect_logger_outputs do
+    # do something
+  end
+
+  pre.test do
+    collect_logger_outputs.empty?
+  end
+
+  pre.message do
+   %q{ You have some logger outputs in your code! }
+  end
+end
+```
+
+If you don't want to test anything before commiting or pushing thus just running
+a command or something similiar, use the ```run``` method.
+
+```rb
+git.describe 'name of Git head' do |pre|
+
+  pre.run do
+    system "git show --name-only HEAD"
+  end
+
+end
+
+```
+
+## Last stuff
+
+Init and written by Daniel Schmidt (daniel.schmidt@gateprotect.com)
+
+Image "Captain Hook" © 2012 Brian Patterson

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/githoog

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'colorize'
+
+class GitHookInstall < Thor
+  include Thor::Actions
+
+  def self.exit_on_failure?
+    true
+  end
+
+  def self.source_root
+    File.join(File.dirname(__FILE__),"..", "lib", "captain_hoog", "templates")
+  end
+
+  class_option :type, type: :string, default: 'pre-commit'
+  class_option :project_dir, type: :string, default: Dir.getwd
+  class_option :plugins_dir, type: :string, default: Dir.getwd
+
+  desc "install","Installs the hook into your Git repository"
+  def install(*args)
+    check_if_git_present
+    check_if_option_present("plugins_dir")
+    # deprecated:
+    # "#{options[:plugins_dir]}/#{options[:type]}"
+    install_hook({ as: options[:type],
+                   context: {
+                     root_dir: Dir.getwd,
+                     plugins_dir: options[:plugins_dir],
+                     project_dir: options[:project_dir]
+                   }
+                })
+    puts "Installed hook as #{options[:type]} hook".green
+  end
+
+  desc "remove", "Removes a hook from your Git repository"
+  def remove(*args)
+    check_if_git_present
+    remove_hook(as: options[:type])
+    puts "The #{options[:type]} hook is removed.".green
+  end
+
+  option :from, type: :string, required: true
+  option :to, type: :string, required: true
+  desc "move", "Moves a hook from type to another"
+  def move(*args)
+    check_if_git_present
+    if options[:from] == options[:to]
+      puts "--from and --to arguments are the same".red
+      raise Thor::Error
+    else
+      move_hook(options)
+      puts "The #{options[:from]} hook is moved to #{options[:to]} hook.".green
+    end
+  end
+
+  private
+
+  def is_git_repository?
+   File.exists?(File.join(Dir.getwd, ".git"))
+ end
+
+  def install_hook(config)
+    opts        = config[:context]
+    opts[:type] = config[:as]
+    copy_config_file(opts)
+    template("install.erb",File.join(hooks_dir, config[:as]), opts)
+    FileUtils.chmod(0755,File.join(hooks_dir, config[:as]))
+  end
+
+  def remove_hook(config)
+    FileUtils.rm_rf(File.join(hooks_dir, config[:as]))
+  end
+
+  def move_hook(config)
+    from = File.join(hooks_dir, config[:from])
+    to   = File.join(hooks_dir, config[:to])
+    FileUtils.mv(from, to)
+  end
+
+  def hooks_dir
+    git_dir.join(".git", "hooks")
+  end
+
+  def git_dir
+    Pathname.new(Dir.getwd)
+  end
+
+  def check_if_git_present
+    if not is_git_repository?
+      puts "I can't detect a Git repository".red
+      raise Thor::Error
+    end
+  end
+
+  def check_if_option_present(type)
+    unless options.has_key?(type)
+      puts "No value provided for required options '--#{type}'".red
+      raise Thor::Error
+    end
+  end
+
+  def copy_config_file(opts={})
+    template('hoogfile.erb', git_dir.join('hoogfile.yml'), opts)
+  end
+
+end
+
+GitHookInstall.start(ARGV)

data/captain_hoog.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'captain_hoog/version'
+
+Gem::Specification.new do |spec|
+  spec.name                 = "captain_hoog"
+  spec.version              = CaptainHoog::VERSION
+  spec.authors              = ["Daniel Schmidt"]
+  spec.email                = ["daniel.schmidt@adytonsystems.com"]
+  spec.summary              = %q{ Plugin based git-pre hook.}
+  spec.homepage             = ""
+  spec.license              = "MIT"
+  spec.post_install_message = %Q{
+    Thanks for installing the Pre-Git whatever hooker!
+
+    If you don't have already, please install the hook:
+
+    githoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> \
+      --project_dir <PATH_TO_PROJECT>
+  }
+
+
+  spec.files                = `git ls-files -z`.split("\x0")
+  spec.executables          = spec.files.grep(%r{^bin/}) { |f| File.basename(f)}
+  spec.test_files           = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths        = ["lib"]
+
+  spec.add_runtime_dependency "colorize", '~> 0.7', '>= 0.7.3'
+  spec.add_runtime_dependency "thor", '~> 0.19', '>= 0.19.1'
+  spec.add_runtime_dependency "terminal-table", '~> 1.4.5'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+end

data/features/failed_hook.feature

@@ -0,0 +1,14 @@
+Feature: Having a hook plugin that fails
+  In order to have a commit to take place
+  As developer that did something wrong
+  I want to see that the hook test failed
+
+  Scenario: Running a unsuccessful commit test
+    When I run `ruby pre-commit-fail`
+    Then it should fail with:
+      """
+      Commit failed. See errors below.
+
+      The test failed in with_git. Prevent you from doing anything.
+      """
+    And the exit status should be 1

data/features/installing_hook.feature

@@ -0,0 +1,35 @@
+Feature: Installing a Git hook with the gem
+  In order to use the plugin based Git hook
+  As developer
+  I want to run the install script
+
+  Scenario: Not having a Git directory
+    Given I am in a directory that isnt a Git repository
+    When I run the install script with "pre-commit" type flag
+    Then it should fail with:
+      """
+      I can't detect a Git repository
+      """
+
+  Scenario Outline: Having a Git repository and installing hook
+    Given I am in a directory that is a Git repository
+    When I run the install script with "<Hook>" type flag
+    Then it should pass with:
+      """
+      Installed hook as <Hook> hook
+      """
+    And a "<Hook>" hook file exists
+    And a hook config file exists
+    And the config file includes the "plugins" directory
+    And the config file includes the "project" directory
+
+    Examples:
+      | Hook |
+      | pre-commit |
+      | pre-push |
+      | pre-rebase |
+      | post-update |
+      | commit-msg |
+      | applypatch-msg |
+      | post-update |
+      | pre-applypatch |

data/features/moving_hooks.feature

@@ -0,0 +1,34 @@
+Feature: Moving a Git hook with the gem to another hook type
+  In order to move an installed hook to another hook type
+  As developer
+  I want to move the hook with the script
+
+  Scenario: Not having a Git repository
+    Given I am in a directory that isnt a Git repository
+    When I run the move script with "pre-commit" from flag and "pre-push" to flag
+    Then it should fail with:
+      """
+      I can't detect a Git repository
+      """
+
+  Scenario Outline: Having a Git repository and moving a hook
+    Given I am in a directory that is a Git repository
+    And a "<From>" is present
+    And I run the move script with "<From>" from flag and "<To>" to flag
+    Then it should pass with:
+      """
+      The <From> hook is moved to <To> hook
+      """
+    And a "<To>" hook file exists
+    And a "<From>" hook file did not exists
+
+    Examples:
+      |From             | To             |
+      | pre-commit      | pre-push       |
+      | pre-push        | pre-rebase     |
+      | pre-rebase      | post-update    |
+      | post-update     | commit-msg     |
+      | commit-msg      | applypatch-msg |
+      | applypatch-msg  | post-update    |
+      | post-update     | pre-applypatch |
+      | pre-applypatch  | pre-commit     | 

data/features/passed_hook.feature

@@ -0,0 +1,12 @@
+Feature: Having a hook plugin that passed
+  In order to have a commit to take place
+  As developer
+  I want to see the hook test passed
+
+  Scenario: Running a successful commit test
+    When I run `ruby pre-commit-pass`
+    Then it should pass with:
+      """
+      All tests passed. No reason to prevent the commit.
+      """
+    And the exit status should be 0

data/features/removing_hook.feature

@@ -0,0 +1,33 @@
+Feature: Removing a Git hook with the gem
+  In order to remove an installed hook
+  As developer
+  I want to remove the hook with the script
+
+  Scenario: Not having a Git repository
+    Given I am in a directory that isnt a Git repository
+    When I run the remove script with "pre-commit" type flag
+    Then it should fail with:
+      """
+      I can't detect a Git repository
+      """
+
+  Scenario Outline: Having a Git repository and removing a hook
+    Given I am in a directory that is a Git repository
+    And a "<Hook>" is present
+    And I run the remove script with "<Hook>" type flag
+    Then it should pass with:
+      """
+      The <Hook> hook is removed.
+      """
+    And a "<Hook>" hook file did not exists
+
+    Examples:
+      | Hook |
+      | pre-commit |
+      | pre-push |
+      | pre-rebase |
+      | post-update |
+      | commit-msg |
+      | applypatch-msg |
+      | post-update |
+      | pre-applypatch |

data/features/support/env.rb

@@ -0,0 +1,43 @@
+require 'cucumber'
+require 'aruba/cucumber'
+
+require 'rspec/expectations'
+
+FIXTURES_PATH = File.expand_path(File.join(File.dirname(__FILE__),
+                             "..",
+                             "..",
+                             "spec",
+                             "fixtures"))
+
+Before do
+  $git_fixture_dir_exists ||= false
+  @dirs = [FIXTURES_PATH]
+  ["no_git", "with_git"].each do |dir|
+    git_path = File.join(FIXTURES_PATH, dir)
+    FileUtils.mkdir_p(git_path)
+    if dir.eql?("with_git")
+      Dir.chdir(git_path)
+      `git init .`
+    end
+  end
+  $git_fixture_dir_exists = true
+end
+
+
+After do
+  FileUtils.rm_rf(File.join(FIXTURES_PATH, 'with_git', 'hoogfile.yml'))
+  %w{ pre-commit
+      pre-push
+      pre-rebase
+      post-update
+      commit-msg
+      applypatch-msg
+      post-update
+      pre-applypatch }.each do |hook_type|
+    FileUtils.rm_rf(File.join(FIXTURES_PATH,
+                              "with_git",
+                              ".git",
+                              "hooks",
+                              hook_type))
+  end
+end

data/features/support/steps/hooks_steps.rb

@@ -0,0 +1,63 @@
+When(/^I run a commit hook that might succeeds$/) do
+  hook_path = File.expand_path(File.join(File.dirname(__FILE__),
+                               "..",
+                               "..",
+                               "..",
+                               "spec",
+                               "fixtures"))
+  FileUtils.chdir(hook_path)
+
+end
+
+When(/^I run the install script with "(.*?)" type flag$/) do |commit_type|
+  @dir = git_project_path.to_s
+  run_simple(unescape("ruby #{bin_path}/bin/githoog install --type #{commit_type} --plugins_dir #{@dir}"),
+            false)
+end
+
+When(/^I run the remove script with "(.*?)" type flag$/) do |commit_type|
+  run_simple(unescape("ruby #{bin_path}/bin/githoog remove --type #{commit_type} --plugins_dir /home"),
+            false)
+end
+
+Given(/^I am in a directory that isnt a Git repository$/) do
+  not_git_repo = "no_git"
+  cd(not_git_repo)
+end
+
+Given(/^I am in a directory that is a Git repository$/) do
+  git_repo = "with_git"
+  cd(git_repo)
+end
+
+Then(/^a "(.*?)" hook file exists$/) do |hook_type|
+  expect(File.exists?(hooks_path(hook_type))).to be true
+end
+
+Given(/^a "(.*?)" is present$/) do |hook_type|
+  FileUtils.touch(hooks_path(hook_type))
+end
+
+Then(/^a "(.*?)" hook file did not exists$/) do |hook_type|
+  expect(File.exists?(hooks_path(hook_type))).to be false
+end
+
+When(/^I run the move script with "(.*?)" from flag and "(.*?)" to flag$/) do |from, to|
+  cmd = "ruby #{bin_path}/bin/githoog move --from #{from} --to #{to}"
+  run_simple(unescape(cmd), false)
+end
+
+When(/^I run the install script without "(.*?)" flag$/) do |type_flag|
+  cmd = "ruby #{bin_path}/bin/githoog install"
+  run_simple(unescape(cmd),false)
+end
+
+Then(/^a hook config file exists$/) do
+  expect(File.exists?(hook_config_file_path)).to be true
+end
+
+Then(/^the config file includes the "(.*?)" directory$/) do |config_path|
+  config = YAML.load_file(hook_config_file_path)
+  expect(config).to have_key("#{config_path}_dir")
+  expect(config["#{config_path}_dir"]).to include @dir
+end

data/features/support/world.rb

@@ -0,0 +1,30 @@
+module FileWorld
+  def bin_path
+    File.expand_path(File.join(File.dirname(__FILE__),
+                               "..",
+                               ".."))
+  end
+
+  def git_project_path
+    f = File.expand_path(File.join(File.dirname(__FILE__),
+                                 "..",
+                                 "..",
+                                 "spec",
+                                 "fixtures",
+                                 "with_git"))
+    Pathname.new(f)
+  end
+
+  def hooks_path(type)
+    path = git_project_path.join(".git",
+                                 "hooks",
+                                 type)
+    path
+  end
+
+  def hook_config_file_path
+    git_project_path.join('hoogfile.yml')
+  end
+end
+
+World(FileWorld)

data/lib/captain_hoog/delegatable.rb

@@ -0,0 +1,33 @@
+module CaptainHoog
+  module Delegatable
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      def delegate_to(target_object)
+        define_method :delegate_to do
+          self.instance_variable_get("@#{target_object}")
+        end
+      end
+    end
+
+    module InstanceMethods
+
+      def method_missing(method_name, *args, &block)
+        if delegate_to.respond_to?(method_name)
+          delegate_to.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private=false)
+        delegate_to.respond_to?(method_name) || super
+      end
+    end
+  end
+end