mina-hooks 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa553044d6d1d55d22dba9a45e4124f6d971644
+  data.tar.gz: 8f42095ef8b929d99910aa95bf4540ae32933697
+SHA512:
+  metadata.gz: 7b47d4d36bc8bb9e433fe9aa1d35a18edc2af331daf8773bdabe15f6a6f236f541837ed46d179cdbc678cb3f81be83c4eb114e06ec64addf1f510a6619e04743
+  data.tar.gz: 2bccac6b8502d061cf7aefc7732dbf779834d26d86cffeb85b8b1c96c97565b98096d4ed82816ac0986e46dfb1165570b3b852dfcf17d41fa99c30a4cf766c23

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "mina-hooks Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,6 @@
+### 0.1 / 2013-11-30
+
+* Initial release:
+  * Added README
+  * Added Mina::Hooks module
+  * Added tests

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "kramdown"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Don Morrison
+
+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,108 @@
+# mina-hooks
+
+* [Homepage](https://github.com/elskwid/mina-hooks#readme)
+* [Issues](https://github.com/elskwid/mina-hooks/issues)
+* [Documentation](http://rubydoc.info/gems/mina-hooks/frames)
+* [Email](mailto:don at elskwid.net)
+
+## Description
+
+Mina plugin to provide local task hooks that run before and after the mina
+commands.
+
+Mina uses a queueing system to create a deploy script that executes on the
+remote system but that leaves no way to know when the deploy has started or
+ended.
+
+`mina-hooks` gets around this limitation by defining a new `mina_cleanup!`
+method that does the following:
+
+* invoke each of the `before_mina_tasks`
+* delegate to the pre-existing `mina_cleanup!`
+* invoke each of the `after_mina_tasks`
+
+### Warning
+
+This is extremenly dependant on Mina internals so buyer beware. However,
+it's not a lot of code so we should be fine. It will all be just fine.
+
+## Features
+
+### Easily add tasks
+
+Helper methods to add tasks to the lists: (see Usage)
+
+  * `before_mina`
+  * `after_mina`
+
+### Access the task lists
+
+Lists of tasks to be run before and after the mina commands:
+
+  * `before_mina_tasks`
+  * `after_mina_tasks`
+
+### Output
+Prints confirmation that the hook is running
+
+* `<----- Invoke before mina tasks`
+* `<----- Invoke after mina tasks`
+
+Prints task list using Mina-style output if set to verbose
+
+* `>> tasks: some:task, some:other:task`
+
+### Still Just Rake
+
+Task invocation is still handled by Rake and operates under the same
+rules you've come to expect.
+
+## Usage
+
+```ruby
+require "mina/hooks"
+```
+
+### before_mina
+
+```ruby
+# Inside your deploy tasks ...
+
+before_mina :"some:task", :"some:other:task"
+before_mina :"task:added:later"
+
+puts before_mina_tasks.inspect
+# => [:"some:task", :"some:other:task", :"task:added:later"]
+
+# ...
+```
+
+### after_mina
+
+```ruby
+# Still inside your deploy tasks ...
+
+after_mina :"some:task", :"some:other:task"
+after_mina :"task:added:later", :"some:task"
+
+puts after_mina_tasks.inspect
+# => [:"some:task", :"some:other:task", :"task:added:later", :"some:task"]
+
+# ...
+```
+
+Because this is Rake, the above task `some:task` will only be invoked once.
+
+## Requirements
+
+  * [mina](https://github.com/nadarei/mina)
+
+## Install
+
+    $ gem install mina-hooks
+
+## Copyright
+
+Copyright (c) 2013 Don Morrison
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require "rubygems"
+
+begin
+  require "bundler"
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require "rake"
+
+require "rubygems/tasks"
+Gem::Tasks.new
+
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+require "yard"
+YARD::Rake::YardocTask.new
+task :doc => :yard

data/lib/mina/hooks.rb

@@ -0,0 +1,4 @@
+require "mina/hooks/version"
+require "mina/hooks/plugin"
+
+extend Mina::Hooks::Plugin

data/lib/mina/hooks/plugin.rb

@@ -0,0 +1,58 @@
+# Provides local task hooks that run before and after the mina_cleanup!.
+#
+# Uses `self.` to cope with the liberal `method_missing` usage in Mina.
+
+module Mina
+  module Hooks
+    module Plugin
+
+      def before_mina_tasks
+        @before_mina_tasks ||= []
+      end
+
+      def after_mina_tasks
+        @after_mina_tasks ||= []
+      end
+
+      def before_mina(*tasks)
+        @before_mina_tasks = self.before_mina_tasks + tasks
+      end
+
+      def after_mina(*tasks)
+        @after_mina_tasks = self.after_mina_tasks + tasks
+      end
+
+      def invoke_before_mina_tasks
+        print_local_status "Invoke before mina tasks"
+        print_task_list self.before_mina_tasks if verbose_mode?
+
+        self.before_mina_tasks.each { |task_name| invoke task_name }
+      end
+
+      def invoke_after_mina_tasks
+        print_local_status "Invoke after mina tasks"
+        print_task_list self.after_mina_tasks if verbose_mode?
+
+        self.after_mina_tasks.each { |task_name| invoke task_name }
+      end
+
+      def mina_cleanup!
+        self.invoke_before_mina_tasks
+        super if defined?(super)
+        self.invoke_after_mina_tasks
+      end
+
+      def print_task_list(tasks)
+        task_list = "tasks: #{tasks.join(", ")}"
+        puts "       #{color(">>", 32)} #{color(task_list, 32)}"
+      end
+
+      # Prints a status message. (`<-----`)
+      def print_local_status(msg)
+        puts ""  if verbose_mode?
+        puts "#{color('<-----', 32)} #{msg}"
+      end
+
+    end
+  end
+end

data/lib/mina/hooks/version.rb

@@ -0,0 +1,6 @@
+module Mina
+  module Hooks
+    # mina-hooks version
+    VERSION = "0.1"
+  end
+end

data/mina-hooks.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/mina/hooks/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "mina-hooks"
+  gem.version       = Mina::Hooks::VERSION
+  gem.summary       = %q{Mina plugin to provide local task hooks that run before and after the mina commands.}
+  gem.description   = %q{Mina plugin to provide local task hooks that run before and after the mina commands.}
+  gem.license       = "MIT"
+  gem.authors       = ["Don Morrison"]
+  gem.email         = "don@elskwid.net"
+  gem.homepage      = "https://github.com/elskwid/mina-hooks#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mina", "~> 0.3"
+
+  gem.add_development_dependency "bundler", "~> 1.2"
+  gem.add_development_dependency "minitest", "~> 5.0"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rubygems-tasks", "~> 0.2"
+  gem.add_development_dependency "yard", "~> 0.8"
+end

data/test/deploy.rb

@@ -0,0 +1,6 @@
+require "mina/hooks"
+
+desc "test hook task"
+task :deploy_test do
+  puts "test hooks"
+end

data/test/helper.rb

@@ -0,0 +1,71 @@
+require "rubygems"
+
+begin
+  require "bundler"
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require "mina"
+
+# create a regular class scope to test methods
+class MinaClass
+  require "mina/hooks"
+  extend Mina::Hooks::Plugin
+end
+
+# create a test mina app scope
+def mina_app
+  Rake.application.instance_eval do
+    init "mina"
+    require "mina/rake"
+    load "test/deploy.rb"
+
+    # list of tasks that were "invoked"
+    @invoked_tasks = []
+
+    # helper for invoked tasks
+    def invoked_tasks
+      @invoked_tasks
+    end
+
+    # fake invoke command for testing
+    def invoke(task)
+      invoked_tasks << task
+    end
+
+    # flag if cleanup method called
+    @cleanup_called = false
+
+    # helper for cleanup method
+    def cleanup_called
+      @cleanup_called
+    end
+
+    # fake mina_cleanup! command for testing
+    def mina_cleanup!
+      cleanup_called = true
+    end
+
+    return self
+  end
+end
+
+# create a task in the scope of the mina app
+def task(name = "test_task", &block)
+  mina_app.instance_eval do
+    define_task Rake::Task, name, &block
+  end
+end
+
+require "minitest/autorun"

data/test/hooks/plugin_test.rb

@@ -0,0 +1,133 @@
+require "helper"
+
+describe Mina::Hooks::Plugin do
+  describe "class scope" do
+    let(:klass) { MinaClass }
+
+    it "defines before_mina_tasks" do
+      assert_respond_to klass, :before_mina_tasks
+    end
+
+    it "defines after_mina_tasks" do
+      assert_respond_to klass, :after_mina_tasks
+    end
+
+    it "defines before_mina" do
+      assert_respond_to klass, :before_mina
+    end
+
+    it "defines after_mina" do
+      assert_respond_to klass, :after_mina
+    end
+
+    it "defines invoke_before_mina_tasks" do
+      assert_respond_to klass, :invoke_before_mina_tasks
+    end
+
+    it "defines invoke_after_mina_tasks" do
+      assert_respond_to klass, :invoke_after_mina_tasks
+    end
+
+    it "defines mina_cleanup!" do
+      assert_respond_to klass, :mina_cleanup!
+    end
+
+    it "defines print_task_list" do
+      assert_respond_to klass, :print_task_list
+    end
+
+    it "defines print_local_status" do
+      assert_respond_to klass, :print_local_status
+    end
+
+    describe "default task lists" do
+      it "before tasks" do
+        assert_equal klass.before_mina_tasks, []
+      end
+
+      it "after tasks" do
+        assert_equal klass.after_mina_tasks, []
+      end
+    end # default task lists
+  end # class scope
+
+  describe "rake/mina scope" do
+    describe "before mina" do
+      let(:task_list) { ["some:task", "some:other:task"] }
+
+      it "defines before_mina" do
+        task do
+          assert_respond_to self, :before_mina
+        end
+      end
+
+      it "adds tasks to the task list" do
+        task do
+          before_mina *task_list
+          assert_equal before_mina_tasks, task_list
+        end
+      end
+
+      it "adds more tasks to the list" do
+        task do
+          before_mina *task_list
+          before_mina "another:task"
+          assert_equal before_mina_tasks, (task_list + ["another:task"])
+        end
+      end
+    end # before mina
+
+    describe "after mina" do
+      let(:task_list) { ["after:task"] }
+
+      it "defines after_mina" do
+        task do
+          assert_respond_to self, :after_mina
+        end
+      end
+
+      it "adds tasks to the task list" do
+        task do
+          after_mina *task_list
+          assert_equal after_mina_tasks, task_list
+        end
+      end
+    end # after mina
+
+    describe "invoke tasks" do
+      let(:task_list) { ["first:task", "second:task", "third:task"]}
+
+      it "invokes before mina in order" do
+        task do
+          before_mina *task_list
+          invoke_before_mina_tasks
+          assert_equal invoked_tasks, task_list
+        end
+      end
+
+      it "invokes after mina in order" do
+        task do
+          after_mina *task_list
+          invoke_after_mina_tasks
+          assert_equal invoked_tasks, task_list
+        end
+      end
+    end # invoke tasks
+
+    describe "mina cleanup" do
+      let(:before_task_list) { ["before:task:one", "before:task:two"] }
+      let(:after_task_list)  { ["after:task:one", "after:task:two"]   }
+
+      it "invokes all tasks" do
+        task do
+          before_mina *before_task_list
+          after_mina *after_task_list
+          mina_cleanup!
+          assert cleanup_called
+          assert_equal invoked_tasks, (before_task_list + after_task_list)
+        end
+      end
+    end # mina cleanup
+
+  end # rake/mina scope
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: mina-hooks
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Don Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Mina plugin to provide local task hooks that run before and after the
+  mina commands.
+email: don@elskwid.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mina/hooks.rb
+- lib/mina/hooks/plugin.rb
+- lib/mina/hooks/version.rb
+- mina-hooks.gemspec
+- test/deploy.rb
+- test/helper.rb
+- test/hooks/plugin_test.rb
+homepage: https://github.com/elskwid/mina-hooks#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Mina plugin to provide local task hooks that run before and after the mina
+  commands.
+test_files:
+- test/deploy.rb
+- test/helper.rb
+- test/hooks/plugin_test.rb