captain_hoog 1.0

data/spec/lib/captain_hoog/git_spec.rb

@@ -0,0 +1,185 @@
+require 'spec_helper'
+
+describe CaptainHoog::Git do
+
+  describe "DSL" do
+
+    subject{ CaptainHoog::Git.new }
+
+    it "has #test method" do
+      expect(subject).to respond_to(:test)
+    end
+
+    it "has #message method" do
+      expect(subject).to respond_to(:message)
+    end
+
+    it "has #env method" do
+      expect(subject).to respond_to(:env)
+    end
+
+    it "has #env= method" do
+      expect(subject).to respond_to(:env=)
+    end
+
+    it "has #helper method" do
+      expect(subject).to respond_to(:helper)
+    end
+
+    it "has #render_table method" do
+      expect(subject).to respond_to(:render_table)
+    end
+
+    it "has #run method" do
+      expect(subject).to respond_to(:run)
+    end
+
+    describe "#test" do
+
+      context "returning a non boolean value" do
+        before do
+          subject.test do
+            "Hello"
+          end
+        end
+        it "raises error" do
+          expect do
+            subject.execute
+          end.to raise_error(CaptainHoog::Errors::TestResultNotValidError)
+        end
+
+      end
+
+      context "returning a boolean value" do
+
+        it "did not raises an error" do
+          expect do
+            subject.test do
+              false
+            end
+          end.not_to raise_error
+        end
+
+      end
+    end
+
+    describe "#message" do
+
+      context "returning not a String" do
+
+        it "raises an error" do
+          expect do
+            subject.message do
+              1
+            end
+          end.to raise_error(CaptainHoog::Errors::MessageResultNotValidError)
+        end
+      end
+
+      context "returning a String" do
+
+        it "raises not an error" do
+          expect do
+            subject.message do
+              "Foo"
+            end
+          end.not_to raise_error
+        end
+
+      end
+
+    end
+
+    describe "#helper" do
+
+      let(:git){ CaptainHoog::Git.new }
+
+      before do
+        git.helper :my_helper do
+          "foo"
+        end
+      end
+
+      it "defines a helper method with a given name" do
+        expect(git).to respond_to(:my_helper)
+      end
+
+      it "evaluates the helper" do
+        expect(git.my_helper).to eq 'foo'
+      end
+
+      context "passing variables to the helper" do
+
+        before do
+          git.helper :my_helper_with_vars do |a|
+            a
+          end
+
+          git.helper :setter= do |a|
+
+          end
+        end
+
+        it "variables will be evaluated" do
+          expect do
+            git.my_helper_with_vars
+          end.to raise_error ArgumentError
+          expect do
+            git.setter=22
+          end.to_not raise_error
+          expect(git.my_helper_with_vars(19)).to eq 19
+        end
+
+      end
+
+      describe "integrated in a plugin" do
+
+        let(:code) do
+          path =File.join(File.dirname(__FILE__),
+                          "..",
+                          "..",
+                          "fixtures",
+                          "code",
+                          "helper.rb")
+          File.read(path)
+        end
+
+        it "provides access directly to the helper" do
+          plugin = CaptainHoog::Plugin.new(code, "")
+
+          expect do
+            plugin.eval_plugin
+            plugin.execute
+          end.to_not raise_error
+
+          plugin.eval_plugin
+          expect(plugin.execute[:message]).to eq "It's 12."
+        end
+
+      end
+
+    end
+
+    describe "#run" do
+
+      it "sets @test_result to true" do
+        subject.run do
+          "hello"
+        end
+        expect(subject.instance_variable_get(:@test_result)).to be true
+      end
+
+      it "evaluates the given block" do
+        subject.run do
+          subject.helper :foo_run do
+            12
+          end
+        end
+        subject.execute
+        expect(subject).to respond_to(:foo_run)
+      end
+
+    end
+  end
+
+end

data/spec/lib/captain_hoog/plugin_list_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe CaptainHoog::PluginList do
+  describe 'instance methods' do
+    it 'provides #plugins method' do
+      expect(described_class.new).to respond_to(:plugins)
+    end
+
+    it 'provides #has?' do
+      expect(described_class.new).to respond_to(:has?)
+    end
+
+    describe '#plugins' do
+
+      let(:plugin_dir_path) do
+        File.join(File.dirname(__FILE__),
+                  '..', '..',
+                  'fixtures',
+                  'plugins',
+                  'test_plugins',
+                  'passing')
+      end
+
+      let(:config) do
+        {
+          'exclude' => %w(mat git log),
+          'pre-commit' => %w(rspec),
+          'plugins_dir' => plugin_dir_path
+        }
+      end
+
+      subject do
+        described_class.new(config: config)
+      end
+
+      it 'returns available plugins' do
+        expect(subject.plugins).to eq %w(rspec)
+      end
+
+    end
+  end
+end

data/spec/lib/captain_hoog/plugin_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe CaptainHoog::Plugin do
+
+  let(:code) do
+    <<-CODE
+
+    git.describe "rspec" do |pre|
+      pre.helper :test_helper do
+        env.variable
+      end
+
+      pre.test do
+        false
+      end
+
+      pre.message do
+        "Test failed."
+      end
+    end
+
+    CODE
+  end
+
+  let(:env) do
+    env = CaptainHoog::Env.new
+    env[:variable] = 12
+    env
+  end
+
+  let(:plugin) do
+    CaptainHoog::Plugin.new(code, env)
+  end
+
+  it "provides access to the DSL" do
+    expect(plugin).to respond_to(:git)
+  end
+
+  it "provides access to the env" do
+    expect(plugin).to respond_to(:env)
+  end
+
+  describe "#initialize" do
+
+    it "prepares git" do
+      expect(plugin.instance_variable_get(:@git)).to_not be nil
+    end
+
+    it "assigns the plugin environment" do
+      expect(plugin.instance_variable_get(:@env)).to \
+        be_instance_of(CaptainHoog::Env)
+    end
+
+    it "assigns the plugin code" do
+      expect(plugin.instance_variable_get(:@code)).to eq code
+    end
+  end
+
+  context "evaluating a plugin" do
+
+    it "provides a #eval_plugin method" do
+      expect(plugin).to respond_to(:eval_plugin)
+    end
+
+    describe "#eval_plugin" do
+      before do
+        plugin.eval_plugin
+      end
+
+      it "evaluates the code abd provides #test_helper" do
+        expect(plugin).to respond_to(:test_helper) #be_instance_of(Hash)
+      end
+
+    end
+
+    describe '#execute' do
+
+      before do
+        plugin.eval_plugin
+      end
+
+      describe "the returning hash" do
+
+        subject { plugin.execute }
+
+        it "includes the test result at the :result key" do
+          expect(subject).to have_key(:result)
+          expect(subject[:result]).to be false
+        end
+
+        it "includes the test failure message at the :message key" do
+          expect(subject).to have_key(:message)
+          expect(subject[:message]).to eq "Test failed."
+        end
+
+      end
+    end
+
+  end
+
+end

data/spec/lib/captain_hoog/pre_git_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe CaptainHoog::PreGit do
+
+  describe "class methods" do
+
+    subject{ CaptainHoog::PreGit }
+
+    it "provides #run" do
+      expect(subject).to respond_to(:run)
+    end
+
+    it "provides #project_dir getter" do
+      expect(subject).to respond_to(:project_dir)
+    end
+
+    it "provides #project_dir setter" do
+      expect(subject).to respond_to(:project_dir=)
+    end
+
+    it "provides #plugins_dir getter" do
+      expect(subject).to respond_to(:plugins_dir)
+    end
+
+    it "provides #plugins_dir setter" do
+      expect(subject).to respond_to(:plugins_dir=)
+    end
+
+    it "provides #configure" do
+      expect(subject).to respond_to(:configure)
+    end
+
+    describe "#configure" do
+      let(:plugins_path) do
+        File.join(File.dirname(__FILE__),
+                  "..",
+                  "..",
+                  "fixtures",
+                  "plugins",
+                  "test_plugins")
+      end
+
+      before do
+        subject.configure do |config|
+          config.headline_on_success = "Success!"
+          config.headline_on_failure = "Failure!"
+          config.project_dir = File.dirname(__FILE__)
+          config.plugins_dir = plugins_path
+          config.suppress_headline = true
+        end
+      end
+
+      it "let you define the success headline message" do
+        expect(CaptainHoog::PreGit.headline_on_success).to eq "Success!"
+      end
+
+      it "let you define the failure headline message" do
+        expect(CaptainHoog::PreGit.headline_on_failure).to eq "Failure!"
+      end
+
+      it "let you define the project_dir" do
+        expect(CaptainHoog::PreGit.project_dir).to eq File.dirname(__FILE__)
+      end
+
+      it "let you define the plugins dir" do
+        expect(CaptainHoog::PreGit.plugins_dir).to eq plugins_path
+      end
+
+    end
+
+    describe "#run" do
+
+      let(:plugins_list) do
+        Class.new do
+          def plugins
+            %w(simple)
+          end
+
+          def has?(plugin)
+            plugins.include?(plugin.plugin_name)
+          end
+        end.new
+      end
+
+      it "returns an instance of CaptainHoog::PreGit" do
+        expect(CaptainHoog::PreGit.run(plugins_list: plugins_list)).to \
+                                            be_instance_of(CaptainHoog::PreGit)
+      end
+
+      it 'affects only configured plugins' do
+        pre_git = CaptainHoog::PreGit.run(plugins_list:plugins_list)
+        expect(pre_git.instance_variable_get(:@results).size).to eq 1
+      end
+
+    end
+
+  end
+
+  describe "instance methods" do
+
+    it "provides #plugins_eval" do
+      expect(subject).to respond_to(:plugins_eval)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+ENV["PREGIT_ENV"] = "test"
+
+require 'captain_hoog'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }

data/spec/support/matchers/be_subclass_of.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :be_subclass_of do |super_class|
+  match do |child_class|
+    child_class.superclass == super_class
+  end
+
+  failure_message do |child_class|
+    "expected the #{child_class} class to be a subclass of #{super_class}"
+  end
+
+  description do
+    "expected a class to be a subclass of #{super_class}."
+  end
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: captain_hoog
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Daniel Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- daniel.schmidt@adytonsystems.com
+executables:
+- githoog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/githoog
+- captain_hoog.gemspec
+- features/failed_hook.feature
+- features/installing_hook.feature
+- features/moving_hooks.feature
+- features/passed_hook.feature
+- features/removing_hook.feature
+- features/support/env.rb
+- features/support/steps/hooks_steps.rb
+- features/support/world.rb
+- lib/captain_hoog.rb
+- lib/captain_hoog/delegatable.rb
+- lib/captain_hoog/dependencies.rb
+- lib/captain_hoog/env.rb
+- lib/captain_hoog/errors.rb
+- lib/captain_hoog/errors/dsl_errors.rb
+- lib/captain_hoog/git.rb
+- lib/captain_hoog/helper_table.rb
+- lib/captain_hoog/plugin.rb
+- lib/captain_hoog/plugin_list.rb
+- lib/captain_hoog/pre_git.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/plugins/shared/passing/simple_shared.rb
+- spec/fixtures/plugins/test_plugins/failing/simple.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/plugin_list_spec.rb
+- spec/lib/captain_hoog/plugin_spec.rb
+- spec/lib/captain_hoog/pre_git_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_subclass_of.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n    Thanks for installing the Pre-Git whatever hooker!\n\n
+  \   If you don't have already, please install the hook:\n\n    githoog install --type
+  <GIT_HOOK_TYPE> --plugins_dir <PATH_TO_PLUGINS>       --project_dir <PATH_TO_PROJECT>\n
+  \ "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Plugin based git-pre hook.
+test_files:
+- features/failed_hook.feature
+- features/installing_hook.feature
+- features/moving_hooks.feature
+- features/passed_hook.feature
+- features/removing_hook.feature
+- features/support/env.rb
+- features/support/steps/hooks_steps.rb
+- features/support/world.rb
+- spec/fixtures/code/helper.rb
+- spec/fixtures/plugins/shared/passing/simple_shared.rb
+- spec/fixtures/plugins/test_plugins/failing/simple.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/plugin_list_spec.rb
+- spec/lib/captain_hoog/plugin_spec.rb
+- spec/lib/captain_hoog/pre_git_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_subclass_of.rb
+has_rdoc: