captain_hoog 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20706e2075b81505658a78f84f2097446876230d
-  data.tar.gz: 96c4216e0d8100cb9ce7025838f86ee8ab4f1dcb
+  metadata.gz: 71c7f0878efebe417bb2f84528cea22126380a8b
+  data.tar.gz: 467d29984360c62cf5d2a08b7b68d4f13d588515
 SHA512:
-  metadata.gz: 5a180f98657cccebf00748a150a86cac43200cf5a425e76573d1baa10f8a6408fc15f73e2daa40f1df0d9aef123cc29a4aa793f6bd342e66d45bdac2b614dfdb
-  data.tar.gz: b7bbbce673f95bfbc2d15591b9de576d988f811b75b4a33854c748bc95ff9a9ad14335ee74d427892de4a156a2b2efcee8150e2115e0afe9aac40f05617dd145
+  metadata.gz: 8ca444b46bf7e7a619892390562f54b7e49c9da97084e9c44ef8402248c74f53ad246051753aed683663be66a6216b8f7b5d830e74255532a4ffd7d73685d50c
+  data.tar.gz: a34a23f80e408a08d2ada2d1ce1b620e676648cc8fcaf9283b8792c65f307ab2ff490a596d1cf0ac30a8db553bf8bd9bc46b43da86529b9a8b510ee5a11206b7

data/Gemfile

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

data/README.md

@@ -1,6 +1,6 @@
 # CaptainHoog
 
-[![Build Status](https://travis-ci.org/GateprotectGmbH/captain_hoog.svg)](https://travis-ci.org/GateprotectGmbH/captain_hoog)
+[![Build Status](https://travis-ci.org/GateprotectGmbH/captain_hoog.svg)](https://travis-ci.org/GateprotectGmbH/captain_hoog) [![Code Climate](https://codeclimate.com/github/GateprotectGmbH/captain_hoog/badges/gpa.svg)](https://codeclimate.com/github/GateprotectGmbH/captain_hoog)
 
 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.
@@ -26,10 +26,14 @@ Or install it yourself as:
 ### Install the hook
 
 ```
-githoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> --project_dir <PATH_TO_PROJECT>
+hoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> --project_dir <PATH_TO_PROJECT>
 ```
 
+Captain Hoog will install also a global ```.hoog``` directory in ```$HOME```. It will
+also pull the default hookins. If you don't want to have this pulled, use the ```--skip-hookins``` flags. 
+
 **Please note:**  ```<PATH_TO_PLUGINS>``` and ```<PATH_TO_PROJECT>``` must be given as absolute paths.
+```<PATH_TO_PLUGINS>``` and ```<PATH_TO_PROJECT>``` are also optional.
 Also make sure to run this from your git repository's root folder.
 
 ```GIT_HOOK_TYPE``` may be something like this
@@ -60,7 +64,7 @@ _A note about plugin directories:_ To have more than one plugin directory used,
 Remove a hook by using the
 
 ```
-githoog remove --type <GIT_HOOK_TYPE>
+hoog remove --type <GIT_HOOK_TYPE>
 ```
 
 command.
@@ -126,6 +130,10 @@ git.describe 'sample' do |pre|
 
   pre.message do
     # Define a message string here that is shown if the test fails.
+    # The message is printed out in red per default. If you don't want
+    # a color pass color: :none to the helper method. Or if you want a
+    # specific color, the color as symbol:
+    # pre.message(color: :none) do ....
   end
 
 end  
@@ -165,6 +173,20 @@ end
 
 ```
 
+Within all expressions you can use the ```env``` variable which provides you the 
+context the plugin is run in:
+
+```rb
+git.describe 'output the plugin context' do |pre|
+
+  pre.run do
+    puts env.context # might be 'pre-commit, pre-push etc ... 
+  end
+
+end
+
+```
+
 **Plugin file structure**
 
 A common way to organize plugins is:
@@ -197,22 +219,22 @@ end
 
 ## Test Support
 
-### Sandbox 
+### Sandbox
 
 For testing purposes, Captain Hoog uses some kind of sandboxing. You're able to use the sandbox directly (you have to do this by now for any other test frameworks than RSpec).
 
-Using the sandbox is easy: 
+Using the sandbox is easy:
 
 ```ruby
 sandbox = CaptainHoog::Test::Sandbox.new(plugin_code, cfg)
 sandbox.run
 # then have full access to the plugin by using sandbox.plugin
-``` 
+```
 
-You have to pass the plugin as String or File object and a configuration hash to the sandbox. 
+You have to pass the plugin as String or File object and a configuration hash to the sandbox.
 The configuration hash might consist of a global (the ```env```) and a plugin specific configuration (marked by using the plugins name as key).
 
-Example: 
+Example:
 
 ```rb
 plugin_code = <<-PLUGIN
@@ -245,11 +267,11 @@ cfg = {
 sandbox = CaptainHoog::Test::Sandbox.new(plugin_code, cfg)
 sandbox.run
 sandbox.plugin.result[:test] # => true
-sandbox.plugin.foo_helper # => 12 
+sandbox.plugin.foo_helper # => 12
 sandbox.plugin.result[:message] # => Fun
 ```
 
-**Note** that the sandbox will not provide you some fake file system. 
+**Note** that the sandbox will not provide you some fake file system.
 
 ### Frameworks
 
@@ -263,25 +285,25 @@ Require test support by using
 require 'captain_hoog/test'
 ```
 
-There is no configuration needed, Captain Hoog will detect if you're using Rspec. 
+There is no configuration needed, Captain Hoog will detect if you're using Rspec.
 
-Then - as usual - add a ```describe``` block. Within this block you have access to a block helper: 
+Then - as usual - add a ```describe``` block. Within this block you have access to a block helper:
 
 ```rb
-with_plugin :<PLUGIN_NAME>, config: <HASH>, silence: <true|false> do 
+with_plugin :<PLUGIN_NAME>, config: <HASH>, silence: <true|false> do
 	# ....
 end
 ```
 
-|Argument| Description| 
+|Argument| Description|
 |:-------|:-----------|
 |PLUGIN_NAME | Plugin - as String or File object (given as a ```let``` or method) |
 |config | plugin configuration, see **Sandbox** section for details. |
 |silence | Truthy or falsy value, silences the plugin output |
 
-With ```with_plugin``` you have full access to the Captain Hoog plugin by using ```plugin```. 
+With ```with_plugin``` you have full access to the Captain Hoog plugin by using ```plugin```.
 
-A full example: 
+A full example:
 
 ```rb
 require 'rspec'
@@ -332,7 +354,7 @@ describe 'Test for hook' do
 end
 ```
 
-### Other Test Frameworks (MiniTest, TestUnit ...) 
+### Other Test Frameworks (MiniTest, TestUnit ...)
 
 You have to use the sandbox directly. See an example using MiniTest below.
 
@@ -383,6 +405,6 @@ end
 
 ## Last stuff
 
-Init and written by Daniel Schmidt (daniel.schmidt@gateprotect.com)
+Init and written by Daniel Schmidt (daniel-a.schmidt@rohde-schwarz.com)
 
 Image "Captain Hook" © 2012 Brian Patterson

data/bin/hoog

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'captain_hoog'
+
+CaptainHoog::Cli::Hoog.start(ARGV)

data/captain_hoog.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
     If you don't have already, please install the hook:
 
-    githoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> \
+    hoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> \
       --project_dir <PATH_TO_PROJECT>
   }
   spec.required_ruby_version = '>= 2.0'
@@ -30,11 +30,13 @@ Gem::Specification.new do |spec|
   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_runtime_dependency "git", '~> 1.2.9.1'
 
   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"
+  spec.add_development_dependency "aruba", "0.6.1"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
 end

data/features/init.feature

@@ -0,0 +1,16 @@
+Feature: Init a Captain Hoog environment
+  In order to bootstrap a Captain Hoog environment
+  As a developer
+  I want to init the environment with a init script
+
+  Background:
+    Given I run the init script with a custom home path
+
+  Scenario: Not having the environment bootstraped before
+    Then the init script outputs "Initializing treasury"
+    Then it should create a .hoog directory
+    And inside the .hoog directory a treasury directory exists
+
+  Scenario: Having the environment already bootstrapped
+    Given I run the init script with a custom home path
+    Then the init script outputs "Treasury already exists. Skipping."

data/features/pull.feature

@@ -0,0 +1,11 @@
+Feature: Pull a plugin repository into the treasury
+  In order to use plugins from a global location
+  As a developer
+  I want to add plugins to the treasury
+
+  Background:
+    Given I run the init script with a custom home path
+
+  Scenario: Pulling an existing repository
+    Given I pull a plugin repository into the treasury
+    Then the repository is installed in the treasury

data/features/support/env.rb

@@ -2,7 +2,6 @@ require 'cucumber'
 require 'aruba/cucumber'
 
 require 'rspec/expectations'
-
 SPEC_PATH = File.expand_path(File.join(File.dirname(__FILE__),
                              "..",
                              "..",
@@ -10,8 +9,9 @@ SPEC_PATH = File.expand_path(File.join(File.dirname(__FILE__),
 
 FIXTURES_PATH  = File.join(SPEC_PATH, "fixtures")
 HOOK_SPEC_PATH = File.join(SPEC_PATH, "hooks")
-
+  
 Before do
+  @aruba_timeout_seconds = 5
   $git_fixture_dir_exists ||= false
   @dirs = [FIXTURES_PATH]
   ["no_git", "with_git"].each do |dir|
@@ -30,6 +30,7 @@ end
 
 
 After do
+  FileUtils.rm_rf(File.join(FIXTURES_PATH, '.hoog'))
   FileUtils.rm_rf(File.join(FIXTURES_PATH, 'with_git', 'hoogfile.yml'))
   %w{ pre-commit
       pre-push
@@ -44,6 +45,6 @@ After do
                               ".git",
                               "hooks",
                               hook_type))
-    FileUtils.rm_rf(HOOK_SPEC_PATH)
+    FileUtils.rm_rf(HOOK_SPEC_PATH)         
   end
 end

data/features/support/steps/hooks_steps.rb

@@ -1,23 +1,18 @@
 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)
+  @cmd =  "bundle exec #{bin_path}/bin/#{executable} install --type #{commit_type} "
+  @cmd += "--plugins_dir #{@dir}"
+  run_simple(unescape(@cmd), 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)
+  @cmd =  "bundle exec #{bin_path}/bin/#{executable} remove --type #{commit_type} "
+  @cmd += "--plugins_dir /home"
+  run_simple(unescape(@cmd),false)
 end
 
 Given(/^I am in a directory that isnt a Git repository$/) do
@@ -51,12 +46,12 @@ Then(/^I should see the current version$/) do
 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}"
+  cmd = "bundle exec #{bin_path}/bin/#{executable} 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"
+  cmd = "bundle exec #{bin_path}/bin/#{executable} install"
   run_simple(unescape(cmd),false)
 end
 
@@ -102,3 +97,41 @@ Then(/^I should see the test is passing with "([^"]*)" example and "([^"]*)" fai
     expect(output).to match(/\d+ runs, #{success_count} assertions, #{failure_count} failures/)
   end
 end
+
+Given(/^I run the init script with a custom home path$/) do
+  @cmd = "bundle exec #{bin_path}/bin/#{executable} init --home #{hook_path}"
+  run_simple(unescape(@cmd),false)
+end
+
+Then(/^it should create a \.hoog directory$/) do
+  expect(File.exists?(File.join(hook_path, '.hoog'))).to be true
+end
+
+Then(/^inside the \.hoog directory a treasury directory exists$/) do
+  expect(File.exists?(treasury_path)).to be true
+end
+
+Then(/^the init script outputs "(.*?)"$/) do |line|
+  expect(output_from(@cmd)).to include line
+end
+
+Then(/^I get this scripts output$/) do
+  puts output_from(@cmd)
+end
+
+When(/^I run a hoog named "(.*?)"$/) do |cmd|
+  @cmd = cmd
+  run_simple(unescape(@cmd), false)
+end
+
+Given(/^I pull a plugin repository into the treasury$/) do
+  repo_url = hook_git_repo_path
+  @cmd = "bundle exec #{bin_path}/bin/#{executable} treasury pull #{repo_url}"
+  @cmd += " --home #{treasury_path}"
+  run_simple(unescape(@cmd), false)
+end
+
+Then(/^the repository is installed in the treasury$/) do
+  step "I get this scripts output"
+  expect(File.exist?(File.join(treasury_path, 'neverland'))).to be true
+end

data/features/support/world.rb

@@ -1,6 +1,18 @@
 require 'pathname'
 
 module FileWorld
+  def executable
+    'hoog'
+  end
+
+  def hook_path
+    File.expand_path(File.join(File.dirname(__FILE__),
+                      "..",
+                      "..",
+                      "spec",
+                      "fixtures"))
+  end
+
   def bin_path
     File.expand_path(File.join(File.dirname(__FILE__),
                                "..",
@@ -24,6 +36,14 @@ module FileWorld
     path
   end
 
+  def treasury_path
+    File.join(hook_path, '.hoog', 'treasury')
+  end
+
+  def hook_git_repo_path
+    File.join(hook_path, 'neverland.git')
+  end
+
   def hook_config_file_path
     git_project_path.join('hoogfile.yml')
   end
@@ -41,7 +61,7 @@ module FileWorld
                           "#{name}.rb"))
     write_file(spec_name, file_content)
   end
-  
+
 end
 
 World(FileWorld)

data/features/testing.feature

@@ -6,6 +6,15 @@ Feature: Testing a hook plugin
   Scenario: Testing a hook plugin with RSpec
     Given I wrote a spec "divide_spec" containing:
       """
+      require 'bundler'
+      require 'bundler/inline'
+
+      gemfile do
+        gem 'captain_hoog', path: File.expand_path('../../..', __FILE__)
+        gem 'rspec'
+        gem 'minitest'
+      end
+
       require 'rspec'
       require 'captain_hoog/test'
 
@@ -60,6 +69,15 @@ Feature: Testing a hook plugin
   Scenario: Testing a hook plugin with Minitest
     Given I wrote a test "divide_test" containing:
     """
+    require 'bundler'
+    require 'bundler/inline'
+
+    gemfile do
+      gem 'captain_hoog', path: File.expand_path('../../..', __FILE__)
+      gem 'rspec'
+      gem 'minitest'
+    end
+    
     gem 'minitest'
     require 'minitest/autorun'
     require 'minitest/unit'

data/features/version.feature

@@ -1,8 +1,8 @@
 Feature: Getting the gems version number printed to stdout
-  In order to get the version printed out to stdout 
+  In order to get the version printed out to stdout
   As developer
-  I want to type in githoog --version to know about the current version 
+  I want to type in hoog --version to know about the current version
 
   Scenario: Getting the version printed to stdout
-    Given I type in "githoog --version"
+    Given I type in "hoog --version"
     Then I should see the current version

data/lib/captain_hoog/cli/git.rb

@@ -0,0 +1,26 @@
+module CaptainHoog
+  module Cli
+    module Git
+      module_function
+
+      def is_git_repository?
+       File.exist?(File.join(Dir.getwd, ".git"))
+      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
+    end
+  end
+end