captain_hoog 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76efe495daab6c9cb797d8655f422921bb5df37b
-  data.tar.gz: 4af041128e853f57f09fbc8f00f38abd75c91340
+  metadata.gz: 90a0156f2d2ceb92d76f79340d5def6d7a7322cb
+  data.tar.gz: da5dd7da0c3059b88fcc4be4d207fee81ac5911a
 SHA512:
-  metadata.gz: 83dca455c5b053422a4302622da2becb562c62a11ce45d5a07b363859b5caf9b813ebcd8a666c6b8d44e98dc052edeffcbd894abcf40324768b1c5b0efe401f1
-  data.tar.gz: 3d89084556792db6e51a56ab884065396ab41b3d074e36595c0d9f39ef0ee076f95c3a50d6876ba0e7ca185cb23cedca886243ec8dee66404b3c9f4394cbdf42
+  metadata.gz: 85516122ffae7b7c311f68d7cffa4067b06d0078e4d0ddc0e1b1dd20b9b59266ed84407fef622115afce0d34561bcbd422b9c5cd613d2388388d2aaa9fb7a231
+  data.tar.gz: 06a158fa3f4cb7ddce69300e84d0b2120fd948e6a9434fec005e08f60b8575a69b0b5fceb59b1d8cf71213a50719b0d1ae9f161a8cd910d4ed0dc61d4c558f04

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0

data/README.md

@@ -51,7 +51,7 @@ to your needs. You can omit this.
 
 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.
+_A note about plugin directories:_ To have more than one plugin directory used, just add as many plugin directories as you want do the ```plugins_dir``` section in the Hoogfile. You can select which plugin is called from which Git hook later by defining it in the Hoogfile.
 
 ### Removing the hook
 
@@ -92,8 +92,6 @@ pre-commit:
 
 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.  
@@ -111,7 +109,7 @@ 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
+```message``` is used to define a notification 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.
@@ -165,6 +163,27 @@ end
 
 ```
 
+
+**Plugin specific configurations**
+
+Sometimes a plugin needs specific configurations that not match the use of a helper method. You can add plugin configurations to your Hoogfile by adding a section that is named after the plugin. Let's say there is a plugin called 'clear logs' that needs a 'truncate_line_numbers' configuration. The Hoogfile section would look like:
+
+```yaml
+clear logs:
+  truncate_line_numbers: 100
+```
+
+You are able to access this configuration within your plugin by using the ```config``` method:
+
+```rb
+git.describe 'clear logs' do |pre|
+  pre.run do
+    system "sed -i '#{config.truncate_line_numbers},$ d' development.log"
+  end
+end
+```
+
+
 ## Last stuff
 
 Init and written by Daniel Schmidt (daniel.schmidt@gateprotect.com)

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/bin/githoog

@@ -2,6 +2,7 @@
 
 require 'thor'
 require 'colorize'
+require 'pathname'
 
 class GitHookInstall < Thor
   include Thor::Actions

data/captain_hoog.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name                 = "captain_hoog"
   spec.version              = CaptainHoog::VERSION
   spec.authors              = ["Daniel Schmidt"]
-  spec.email                = ["daniel.schmidt@adytonsystems.com"]
+  spec.email                = ["daniel.schmidt@gateprotect.com"]
   spec.summary              = %q{ Plugin based git-pre hook.}
   spec.homepage             = ""
   spec.license              = "MIT"
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
     githoog install --type <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS> \
       --project_dir <PATH_TO_PROJECT>
   }
+  spec.required_ruby_version = '>= 2.0'
 
 
   spec.files                = `git ls-files -z`.split("\x0")

data/changelog.md

@@ -0,0 +1,15 @@
+## 1.0.1 (2015-05-06)
+
+Features:
+
+  - support ERB (embedded Ruby) in Hoogfile.yml
+  - support multiple plugin directories
+  - support for specific plugin/hookin configurations
+
+Bugfixes:
+
+  - fix githoog install by requiring 'pathname'
+
+Notes:
+
+  - minimum Ruby version is 2.0

data/features/support/world.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module FileWorld
   def bin_path
     File.expand_path(File.join(File.dirname(__FILE__),

data/lib/captain_hoog/config/hook_types.yml

@@ -0,0 +1,8 @@
+- pre-push
+- pre-commit
+- applypatch-msg
+- post-update
+- pre-applypatch
+- pre-rebase
+- prepare-commit-msg
+- update

data/lib/captain_hoog/core_ext/hash.rb

@@ -0,0 +1,12 @@
+class Hash
+  def stringify_keys
+    reduce({}) do |hash, (key, value)|
+      new_value = if value.respond_to?(:stringify_keys)
+        value.stringify_keys
+      else
+        value
+      end
+      hash.merge(key.to_s => new_value)
+    end
+  end
+end

data/lib/captain_hoog/core_ext.rb

@@ -0,0 +1 @@
+require "captain_hoog/core_ext/hash"

data/lib/captain_hoog/dependencies.rb

@@ -1,2 +1,5 @@
 require 'colorize'
 require 'terminal-table'
+require 'yaml'
+require 'ostruct'
+require 'erb'

data/lib/captain_hoog/hoogfile.rb

@@ -0,0 +1,48 @@
+module CaptainHoog
+  class Hoogfile < Struct
+
+    def self.read(path)
+      self.send(:new,path)
+    end
+
+    singleton_class.send(:alias_method, :config, :read)
+
+    private_class_method :new
+
+    def initialize(path)
+      @path = path
+      super(hoogfile)
+    end
+
+    def plugins_config
+      # select all plugin config into an env hash
+      config = self.to_h.reduce({}) do |plugins_env_hash, (item_key, item_value)|
+        unless reserved_keys.include?(item_key)
+          plugins_env_hash.update(item_key => item_value)
+        end
+      end
+      CaptainHoog::Struct.new(config)
+    end
+    alias_method :plugins_env, :plugins_config
+
+    private
+
+    def hoogfile
+      config              = File.read(File.join(@path, 'hoogfile.yml'))
+      data                = ERB.new(config).result
+      interpreted_config  = YAML.load(data)
+      raise StandardError if interpreted_config.key?(:plugins_config)
+      interpreted_config
+    end
+
+    def hook_types
+      @hook_types ||= YAML.load_file(File.join(File.dirname(__FILE__),
+                                              'config',
+                                              'hook_types.yml'))
+    end
+
+    def reserved_keys
+      hook_types + %w(project_dir plugins_dir)
+    end
+  end
+end

data/lib/captain_hoog/plugin.rb

@@ -42,6 +42,14 @@ module CaptainHoog
       }
     end
 
+    # Public: Provides access to the configuration section in the hoogfile
+    # with the plugin's name.
+    #
+    # Returns the value of the key.
+    def config
+      Struct.new(env[:plugins_config].send(git.plugin_name))
+    end
+
     private
 
     def eigenplugin

data/lib/captain_hoog/pre_git.rb

@@ -7,7 +7,8 @@ module CaptainHoog
                     :plugins_dir,
                     :headline_on_success,
                     :headline_on_failure,
-                    :suppress_headline
+                    :suppress_headline,
+                    :plugins_conf
     end
 
     # Public: Runs the hook.
@@ -29,15 +30,9 @@ module CaptainHoog
     end
 
     def initialize(plugins_list = nil)
-      env           = prepare_env
       @plugins      = []
       @plugins_list = plugins_list
-      if self.class.plugins_dir
-        read_plugins_from_dir(self.class.plugins_dir, env)
-      end
-      if shared_plugins_dir_present?
-        read_plugins_from_dir(shared_plugins_dir, env)
-      end
+      prepare_plugins
     end
 
     # Public: Evaluates all plugins that are found in plugins_dir.
@@ -72,7 +67,8 @@ module CaptainHoog
 
     def prepare_env
       env = Env.new
-      env[:project_dir] = self.class.project_dir
+      env[:project_dir]    = self.class.project_dir
+      env[:plugins_config] = self.class.plugins_conf
       env
     end
 
@@ -116,7 +112,15 @@ module CaptainHoog
     def read_plugins_from_dir(dir, env)
       Dir["#{dir}/**/**.rb"].each do |plugin|
         code = File.read(plugin)
-        @plugins << Plugin.new(code,env)
+        @plugins << Plugin.new(code, env)
+      end
+    end
+
+    def prepare_plugins
+      env         = prepare_env
+      plugins_dir = self.class.plugins_dir
+      (plugins_dir.is_a?(Array) ? plugins_dir : Array(plugins_dir)).each do |dir|
+        read_plugins_from_dir(dir, env)
       end
     end
 

data/lib/captain_hoog/struct/hoog_struct.rb

@@ -0,0 +1,26 @@
+module CaptainHoog
+  class Struct < ::OpenStruct
+
+    def fetch(key, default = nil)
+      if not self.respond_to?(key)
+        raise IndexError unless default
+        return default
+      else
+        self.public_send(key)
+      end
+    end
+
+    def method_missing(method_name, *args, &block)
+      if self.to_h.respond_to?(method_name)
+        self.to_h.stringify_keys.send(method_name.to_s, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      self.to_h.respond_to?(method_name) || super
+    end
+
+  end
+end

data/lib/captain_hoog/templates/hoogfile.erb

@@ -36,4 +36,5 @@
 project_dir: "<%= config[:project_dir] %>"
 # path to plugins
 # This is going into env.
-plugins_dir: "<%= config[:plugins_dir] %>"
+plugins_dir:
+  - "<%= config[:plugins_dir] %>"

data/lib/captain_hoog/templates/install.erb

@@ -1,15 +1,14 @@
 #!/usr/bin/env ruby
 require 'captain_hoog'
-require 'yaml'
 
 # read config
-hoog_config = YAML.load_file(File.join('<%= config[:root_dir] %>',
-                                       'hoogfile.yml'))
+hoog_config = CaptainHoog::Hoogfile.config('<%= config[:root_dir] %>')
 
 # Adjust settings
 CaptainHoog::PreGit.configure do |config|
-  config.plugins_dir      = hoog_config['plugins_dir']
-  config.project_dir      = hoog_config['project_dir']
+  config.plugins_dir      = hoog_config.plugins_dir
+  config.project_dir      = hoog_config.project_dir
+  config.plugins_conf     = hoog_config.plugins_env
   #config.headline_on_success = "All is fine."
   #config.headline_on_failure = "Oops. Something went wrong"
 end

data/lib/captain_hoog/version.rb

@@ -1,3 +1,3 @@
 module CaptainHoog
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/lib/captain_hoog.rb

@@ -1,5 +1,6 @@
 require "captain_hoog/version"
 require "captain_hoog/dependencies"
+require "captain_hoog/core_ext"
 require "captain_hoog/errors"
 require "captain_hoog/delegatable"
 require "captain_hoog/helper_table"
@@ -8,6 +9,8 @@ require "captain_hoog/git"
 require "captain_hoog/plugin"
 require "captain_hoog/pre_git"
 require "captain_hoog/plugin_list"
+require "captain_hoog/struct/hoog_struct"
+require "captain_hoog/hoogfile"
 
 module CaptainHoog
   # Your code goes here...

data/spec/fixtures/config/cucumber/hoogfile.yml

@@ -0,0 +1,13 @@
+plugins_dir:
+  - <%=  File.expand_path(File.join(File.dirname(__FILE__),
+                                            "plugins",
+                                            "test_plugins",
+                                            "passing")) %>
+
+project_dir: <%= File.expand_path(File.join(File.dirname(__FILE__),"with_git" )) %>
+
+pre-commit:
+  - simple
+
+simple:
+  runtime_count: <%= a = 0; 12.times { |i| a += 1 }; a %>

data/spec/fixtures/config/spec/hoogfile.yml

@@ -0,0 +1,6 @@
+plugins_dir:
+  - <%= File.expand_path(File.join(File.dirname(__FILE__),
+                                  'spec', 'fixtures','plugins')) %>
+
+foo plugin:
+  bar: hello

data/spec/fixtures/plugins/test_plugins/passing/pure/foo.rb

@@ -0,0 +1,11 @@
+git.describe "foo" do |pre|
+
+  pre.test do
+    true
+  end
+
+  pre.message do
+    "The what test failed. Prevent you from doing anything."
+  end
+
+end

data/spec/fixtures/plugins/test_plugins/passing/simple.rb

@@ -1,7 +1,7 @@
 git.describe "simple" do |pre|
 
   pre.test do
-    true
+    config.runtime_count / 12 == 1
   end
 
   pre.message do

data/spec/fixtures/pre-commit-pass

@@ -1,25 +1,17 @@
 #!/usr/bin/env ruby
 require 'captain_hoog'
+cucumber_hoogfile = File.expand_path(File.join(File.dirname(__FILE__),
+                                               "config", "cucumber"))
 
-plugins_path = File.expand_path(File.join(File.dirname(__FILE__),
-                                          "plugins",
-                                          "test_plugins",
-                                          "passing"))
-
-hoog_config = {
-  'exclude' => [],
-  'plugins_dir' => plugins_path,
-  'project_dir' => 'with_git',
-  'pre-commit' => ['simple']
-}
+hoog_config = CaptainHoog::Hoogfile.config(cucumber_hoogfile)
 
 plugin_list = CaptainHoog::PluginList.new('pre-commit',
                                           config: hoog_config)
-
 # Adjust settings
 CaptainHoog::PreGit.configure do |config|
   config.plugins_dir      = hoog_config['plugins_dir']
   config.project_dir      = hoog_config['project_dir']
+  config.plugins_conf     = hoog_config.plugins_env
 end
 
 CaptainHoog::PreGit.run(plugins_list: plugin_list)

data/spec/lib/captain_hoog/hoogfile_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe CaptainHoog::Hoogfile do
+  let(:path) do
+    File.expand_path(File.join(File.dirname(__FILE__),
+                              '..', '..','fixtures', 'config', 'spec'))
+  end
+
+  let(:plugins_dir) do
+    File.expand_path(File.join(File.dirname(__FILE__),
+                              '..', '..','fixtures', 'plugins'))
+  end
+
+  describe 'class methods' do
+    it 'provides .read' do
+      expect(described_class).to respond_to(:read)
+    end
+
+    it 'provides .config' do
+      expect(described_class).to respond_to(:config)
+    end
+
+    describe '.new' do
+      it 'is not callable' do
+        expect do
+          described_class.new
+        end.to raise_error NoMethodError
+      end
+    end
+
+    describe '.read' do
+
+      subject{ described_class.read(path) }
+
+      it 'returns an instance of Hoogfile' do
+        expect(subject).to be_instance_of(CaptainHoog::Hoogfile)
+      end
+
+      it 'evaluates erb' do
+        expect(subject.plugins_dir).to include(plugins_dir)
+        expect(subject.plugins_env).to have_key('foo plugin')
+        expect(subject.plugins_env['foo plugin']).to be_instance_of(Hash)
+        expect(subject.plugins_env['foo plugin']).to have_key('bar')
+      end
+    end
+
+    describe 'instance methods' do
+
+      subject{ described_class.read(path) }
+
+      it 'provides #fetch' do
+        expect(subject).to respond_to(:fetch)
+      end
+
+      describe 'fetch' do
+        it 'returns the value for a given key' do
+          expect(subject.fetch(:plugins_dir)).to include(plugins_dir)
+        end
+
+        it 'returns default value if give isnt found' do
+          expect(subject.fetch(:foo, [])).to eq []
+        end
+
+        it 'raises an error if no default value is given and key not exists' do
+          expect do
+            subject.fetch(:foo)
+          end.to raise_error IndexError
+        end
+      end
+    end
+  end
+end

data/spec/lib/captain_hoog/plugin_list_spec.rb

@@ -21,11 +21,20 @@ describe CaptainHoog::PluginList do
                   'passing')
       end
 
+      let(:shared_plugin_dir) do
+        File.join(File.dirname(__FILE__),
+                  '..', '..',
+                  'fixtures',
+                  'plugins',
+                  'shared',
+                  'passing')
+      end
+
       let(:config) do
         {
           'exclude' => %w(mat git log),
-          'pre-commit' => %w(rspec),
-          'plugins_dir' => plugin_dir_path
+          'pre-commit' => %w(rspec shared),
+          'plugins_dir' => [plugin_dir_path, shared_plugin_dir]
         }
       end
 
@@ -34,7 +43,7 @@ describe CaptainHoog::PluginList do
       end
 
       it 'returns available plugins' do
-        expect(subject.plugins).to eq %w(rspec)
+        expect(subject.plugins).to eq %w(rspec shared)
       end
 
     end

data/spec/lib/captain_hoog/pre_git_spec.rb

@@ -32,12 +32,14 @@ describe CaptainHoog::PreGit do
 
     describe "#configure" do
       let(:plugins_path) do
-        File.join(File.dirname(__FILE__),
+        [File.join(File.dirname(__FILE__),
                   "..",
                   "..",
                   "fixtures",
                   "plugins",
-                  "test_plugins")
+                  "test_plugins",
+                  "passing",
+                  "pure")]
       end
 
       before do
@@ -73,7 +75,7 @@ describe CaptainHoog::PreGit do
       let(:plugins_list) do
         Class.new do
           def plugins
-            %w(simple)
+            %w(foo)
           end
 
           def has?(plugin)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captain_hoog
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -136,19 +136,21 @@ dependencies:
         version: '0'
 description: 
 email:
-- daniel.schmidt@adytonsystems.com
+- daniel.schmidt@gateprotect.com
 executables:
 - githoog
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/githoog
 - captain_hoog.gemspec
+- changelog.md
 - features/failed_hook.feature
 - features/installing_hook.feature
 - features/moving_hooks.feature
@@ -158,6 +160,9 @@ files:
 - features/support/steps/hooks_steps.rb
 - features/support/world.rb
 - lib/captain_hoog.rb
+- lib/captain_hoog/config/hook_types.yml
+- lib/captain_hoog/core_ext.rb
+- lib/captain_hoog/core_ext/hash.rb
 - lib/captain_hoog/delegatable.rb
 - lib/captain_hoog/dependencies.rb
 - lib/captain_hoog/env.rb
@@ -165,20 +170,26 @@ files:
 - lib/captain_hoog/errors/dsl_errors.rb
 - lib/captain_hoog/git.rb
 - lib/captain_hoog/helper_table.rb
+- lib/captain_hoog/hoogfile.rb
 - lib/captain_hoog/plugin.rb
 - lib/captain_hoog/plugin_list.rb
 - lib/captain_hoog/pre_git.rb
+- lib/captain_hoog/struct/hoog_struct.rb
 - lib/captain_hoog/templates/hoogfile.erb
 - lib/captain_hoog/templates/install.erb
 - lib/captain_hoog/version.rb
 - spec/fixtures/code/helper.rb
+- spec/fixtures/config/cucumber/hoogfile.yml
+- spec/fixtures/config/spec/hoogfile.yml
 - spec/fixtures/plugins/shared/passing/simple_shared.rb
 - spec/fixtures/plugins/test_plugins/failing/simple.rb
+- spec/fixtures/plugins/test_plugins/passing/pure/foo.rb
 - spec/fixtures/plugins/test_plugins/passing/simple.rb
 - spec/fixtures/pre-commit-fail
 - spec/fixtures/pre-commit-pass
 - spec/lib/captain_hoog/env_spec.rb
 - spec/lib/captain_hoog/git_spec.rb
+- spec/lib/captain_hoog/hoogfile_spec.rb
 - spec/lib/captain_hoog/plugin_list_spec.rb
 - spec/lib/captain_hoog/plugin_spec.rb
 - spec/lib/captain_hoog/pre_git_spec.rb
@@ -199,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -221,13 +232,17 @@ test_files:
 - features/support/steps/hooks_steps.rb
 - features/support/world.rb
 - spec/fixtures/code/helper.rb
+- spec/fixtures/config/cucumber/hoogfile.yml
+- spec/fixtures/config/spec/hoogfile.yml
 - spec/fixtures/plugins/shared/passing/simple_shared.rb
 - spec/fixtures/plugins/test_plugins/failing/simple.rb
+- spec/fixtures/plugins/test_plugins/passing/pure/foo.rb
 - spec/fixtures/plugins/test_plugins/passing/simple.rb
 - spec/fixtures/pre-commit-fail
 - spec/fixtures/pre-commit-pass
 - spec/lib/captain_hoog/env_spec.rb
 - spec/lib/captain_hoog/git_spec.rb
+- spec/lib/captain_hoog/hoogfile_spec.rb
 - spec/lib/captain_hoog/plugin_list_spec.rb
 - spec/lib/captain_hoog/plugin_spec.rb
 - spec/lib/captain_hoog/pre_git_spec.rb