capnotify 0.1.0pre

data/spec/capnotify/plugin_spec.rb

@@ -0,0 +1,256 @@
+require 'spec_helper'
+
+describe Capnotify::Plugin do
+
+  # a proxy object to call methods on to detect what gets called in the plugin
+  class ProxyObject
+    class << self
+      @instance = nil
+    end
+
+    def self.instance
+      @instance ||= ProxyObject.new
+    end
+
+    def call_init; end
+    def call_unload; end
+  end
+
+  # a plugin for testing with
+  # wires up init and unload to the ProxyObject
+  module MyPlugin
+    def init
+      ProxyObject.instance.call_init
+    end
+
+    def unload
+      ProxyObject.instance.call_unload
+    end
+  end
+
+  let(:config) do
+    Capistrano::Configuration.new
+  end
+
+  before do
+    Capnotify.load_into(config)
+  end
+
+  after do
+    Capistrano::EXTENSIONS.keys.each do |ex|
+      Capistrano.remove_plugin(ex)
+    end
+  end
+
+  let(:capnotify) { config.capnotify }
+
+  context "#appname" do
+
+    context "when capnotify_appname is missing" do
+
+      before do
+        config.load do
+          unset :capnotify_appname
+        end
+      end
+
+      it "should return an empty string" do
+        capnotify.appname.should == ''
+      end
+    end
+
+  end
+
+  context "#load_plugin" do
+
+    it "should load the plugin into capistrano" do
+      config.load do
+        capnotify.load_plugin :my_plugin, MyPlugin
+      end
+
+      Capistrano::EXTENSIONS.keys.should include(:my_plugin)
+    end
+
+    it "should call init on the plugin" do
+      ProxyObject.instance.should_receive :call_init
+
+      config.load do
+        capnotify.load_plugin :my_plugin, MyPlugin
+      end
+
+    end
+
+  end
+
+  context "#unload_plugin" do
+
+    before do
+      config.load do
+        capnotify.load_plugin :my_plugin, MyPlugin
+      end
+    end
+
+    it "should call unload on the plugin if the plugin handles it" do
+      ProxyObject.instance.should_receive(:call_unload)
+
+      config.load do
+        capnotify.unload_plugin :my_plugin
+      end
+    end
+
+    it "should not blow up if the plugin does not handle #unload" do
+      MyPlugin.send(:undef_method, :unload)
+
+      lambda do
+        config.load do
+          capnotify.unload_plugin :my_plugin
+        end
+      end.should_not raise_error
+    end
+
+  end
+
+  context "#get_plugin" do
+
+    context "when plugin exists" do
+      before do
+        config.load do
+          capnotify.load_plugin :my_plugin, MyPlugin
+        end
+      end
+
+      it "should return the plugin" do
+        capnotify.send(:get_plugin, :my_plugin).should_not be_nil
+      end
+
+      it "should not raise an error" do
+        lambda { capnotify.send(:get_plugin, :my_plugin) }.should_not raise_error
+      end
+
+    end
+
+    context "when the plugin does not exist" do
+
+      it "should raise an error" do
+        lambda { capnotify.send(:get_plugin, :does_not_exist) }.should raise_error
+      end
+
+    end
+
+  end
+
+  context "#build_template" do
+
+    it "should not error when using a built-in html template" do
+      lambda { capnotify.build_template( capnotify.built_in_template_for('default_notification.html.erb') ) }.should_not raise_error
+    end
+
+    it "should not error when using a built-in text template" do
+      lambda { capnotify.build_template( capnotify.built_in_template_for('default_notification.txt.erb') ) }.should_not raise_error
+    end
+
+  end
+
+  context "#components" do
+    it "should return the components" do
+      capnotify.components.should === config.fetch(:capnotify_component_list)
+    end
+  end
+
+  context "#component" do
+    let!(:component) { Capnotify::Component.new(:test_component) }
+
+    before do
+      4.times do |i|
+        capnotify.components << Capnotify::Component.new("component_#{ i }")
+      end
+
+      capnotify.components << component
+    end
+
+    it "should return the component with the given name" do
+      capnotify.component(:test_component).should === component
+    end
+
+    it "should return nil if the requested component does not exist" do
+      capnotify.component(:fake_component).should be_nil
+    end
+  end
+
+  context "inserting components" do
+    let!(:component) { Capnotify::Component.new(:test_component) }
+
+    before do
+      capnotify.components.clear
+
+      # add components 0 - 3
+      4.times do |i|
+        capnotify.components << Capnotify::Component.new("component_#{ i }")
+      end
+    end
+
+    context "before" do
+
+      it "should insert the given component" do
+        expect { capnotify.insert_component_before(:component_2, component) }.to change { capnotify.components.count }.by(1)
+      end
+
+      it "should insert the given component in the correct place" do
+        capnotify.insert_component_before(:component_2, component)
+
+        capnotify.components.map(&:name)[2].should == component.name
+      end
+
+      it "should insert the component at the end if no component with given name exists" do
+        capnotify.insert_component_before(:this_component_does_not_exist, component)
+
+        capnotify.components.last.name.should == component.name
+      end
+
+    end
+
+    context "after" do
+
+      it "should insert the given component" do
+        expect { capnotify.insert_component_after(:component_2, component) }.to change { capnotify.components.count }.by(1)
+      end
+
+      it "should insert the given component in the correct place" do
+        capnotify.insert_component_after(:component_2, component)
+
+        capnotify.components.map(&:name)[3].should == component.name
+      end
+
+      it "should insert the component at the end if no component with given name exists" do
+        capnotify.insert_component_after(:this_component_does_not_exist, component)
+
+        capnotify.components.last.name.should == component.name
+      end
+    end
+
+  end
+
+  context "#delete_component" do
+    let!(:component) { Capnotify::Component.new(:test_component) }
+
+    before do
+      4.times do |i|
+        capnotify.components << Capnotify::Component.new("component_#{ i }")
+      end
+
+      capnotify.components << component
+    end
+
+    it "should not error out if you delete a non-existent component" do
+      lambda { capnotify.delete_component(:fake_component) }.should_not raise_error
+    end
+
+    it "should delete the given component" do
+      expect { capnotify.delete_component(:test_component) }.to change { capnotify.components.length }.by(-1)
+    end
+
+    it "should return the given deleted component" do
+      capnotify.delete_component(:test_component).should === capnotify.components
+    end
+  end
+end

data/spec/capnotify_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+describe Capnotify do
+
+  let(:config) do
+    Capistrano::Configuration.new
+  end
+
+  before do
+    Capnotify.load_into(config)
+  end
+
+  after do
+    Capistrano::EXTENSIONS.keys.each do |ex|
+      Capistrano.remove_plugin(ex)
+    end
+  end
+
+  let(:capnotify) { config.capnotify }
+
+  context "loading" do
+    it "should initialize capnotify.components" do
+      capnotify.components.should_not be_nil
+    end
+  end
+
+  context "built-in callbacks" do
+
+    before do
+      # there has to be a better way of doing this...
+      # create a MockObject to handle the callbacks
+      class MockObject
+      end
+      MockObject.stub!(:deploy_start => true)
+      MockObject.stub!(:deploy_complete => true)
+      MockObject.stub!(:migrate_start => true)
+      MockObject.stub!(:migrate_complete => true)
+      MockObject.stub!(:maintenance_page_up => true)
+      MockObject.stub!(:maintenance_page_down => true)
+
+      config.load do
+        # these don't get triggered unless something is defined.
+        on(:deploy_start) { MockObject.deploy_start }
+        on(:deploy_complete) { MockObject.deploy_complete }
+        on(:migrate_start) { MockObject.migrate_start }
+        on(:migrate_complete) { MockObject.migrate_complete }
+        on(:maintenance_page_up) { MockObject.maintenance_page_up }
+        on(:maintenance_page_down) { MockObject.maintenance_page_down }
+
+        # stub some tasks
+        namespace :deploy do
+          task(:default) {}
+          task(:migrate) {}
+          namespace :web do
+            task(:enable) {}
+            task(:disable) {}
+          end
+        end
+      end
+
+      config.trigger(:load)
+    end
+
+    context "deploy callbacks" do
+      it "should trigger :deploy_start before deploy" do
+        MockObject.should_receive(:deploy_start)
+        config.find_and_execute_task('deploy')
+      end
+
+      it "should trigger :deploy_complete after deploy" do
+        MockObject.should_receive(:deploy_complete)
+        config.find_and_execute_task('deploy')
+      end
+    end
+
+    context "migration callbacks" do
+      it "should trigger :migrate_start before deploy:migrate" do
+        MockObject.should_receive(:migrate_start)
+        config.find_and_execute_task('deploy:migrate')
+      end
+
+      it "should trigger :migrate_complete after deploy:migrate" do
+        MockObject.should_receive(:migrate_complete)
+        config.find_and_execute_task('deploy:migrate')
+      end
+    end
+
+    context "maintenance page callbacks" do
+      it "should trigger :maintenance_page_up before deploy:web:disable" do
+        MockObject.should_receive(:maintenance_page_up)
+        config.find_and_execute_task('deploy:web:disable')
+      end
+
+      it "should trigger :maintenance_page_down after deploy:web:enable" do
+        MockObject.should_receive(:maintenance_page_down)
+        config.find_and_execute_task('deploy:web:enable')
+      end
+    end
+
+  end
+
+  context "built-in messages" do
+
+    context "when application is not specified" do
+
+      before do
+        config.load do
+          set :stage, 'production'
+        end
+      end
+
+      it "should not raise an error" do
+        lambda { config.capnotify_appname }.should_not raise_error
+      end
+
+    end
+
+    context "when stage is not specified" do
+
+      before do
+        config.load do
+          set :application, 'MyApp'
+        end
+      end
+
+      it "should not raise an error" do
+        lambda { config.capnotify_appname }.should_not raise_error
+      end
+
+    end
+
+    context "when the user wants to override capnotify_appname" do
+      before do
+        config.load do
+          set :capnotify_appname, 'SimpleApp'
+        end
+      end
+
+      it "should return what the user overrode with" do
+        config.capnotify_appname.should == 'SimpleApp'
+      end
+
+    end
+
+    context "when both application and stage are specified" do
+
+      before do
+        config.load do
+          set :application, 'SimpleApp'
+          set :stage, 'production'
+        end
+      end
+
+      it "should not raise an error" do
+        lambda { config.capnotify_appname }.should_not raise_error
+      end
+
+      it "should include the application name" do
+        config.capnotify_appname.should match('SimpleApp')
+      end
+
+      it "should include the stage name" do
+        config.capnotify_appname.should match('production')
+      end
+
+    end
+
+  end
+
+  context "capnotify_disable_default_components" do
+
+    context "when it is set to true" do
+
+      before do
+        config.load do
+          set :capnotify_disable_default_components, true
+        end
+      end
+
+      it "should not have any plugins loaded by default" do
+        config.trigger(:load)
+        Capistrano::EXTENSIONS.keys.map(&:to_s).grep(/^capnotify_/).count.should == 0
+      end
+
+    end
+
+    context "when it is not set" do
+
+      it "should have defauilt plugins loaded by default" do
+        config.trigger(:load)
+        Capistrano::EXTENSIONS.keys.map(&:to_s).grep(/^capnotify_/).count.should > 0
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'awesome_print'
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'capistrano'
+require 'capnotify'
+require 'pry'
+
+def fixture_path(filename)
+  File.join( File.dirname(__FILE__), 'fixtures', filename )
+end
+

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: capnotify
+version: !ruby/object:Gem::Version
+  version: 0.1.0pre
+  prerelease: 5
+platform: ruby
+authors:
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+description: Extensible Capistrano notification system with helpers and sensible default
+  values for common notification tasks.
+email:
+- me@spike.cx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capnotify.gemspec
+- lib/capnotify.rb
+- lib/capnotify/component.rb
+- lib/capnotify/plugin.rb
+- lib/capnotify/plugin/details.rb
+- lib/capnotify/plugin/overview.rb
+- lib/capnotify/templates/_component.html.erb
+- lib/capnotify/templates/_component.txt.erb
+- lib/capnotify/templates/default_notification.html.erb
+- lib/capnotify/templates/default_notification.txt.erb
+- lib/capnotify/version.rb
+- spec/capnotify/component_spec.rb
+- spec/capnotify/plugin_spec.rb
+- spec/capnotify_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spikegrobstein/capnotify
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extensible Capistrano notification system.
+test_files:
+- spec/capnotify/component_spec.rb
+- spec/capnotify/plugin_spec.rb
+- spec/capnotify_spec.rb
+- spec/spec_helper.rb
+has_rdoc: