pulsar 0.0.3 → 0.0.4

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+!tmp/.gitkeep

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+before_install: gem install bundler --pre
+script: "DISPLAY=:99.0 bundle exec rspec spec"
+notifications:
+  email:
+    - kennyadsl@gmail.com
+    - mtylty@gmail.com
+branches:
+  only:
+    - master
+rvm:
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,5 +1,8 @@
 # Pulsar
 
+[![Build Status](https://secure.travis-ci.org/nebulab/pulsar.png?branch=master)](http://travis-ci.org/nebulab/pulsar) 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/nebulab/pulsar)
+
 NebuLab's central capistrano deploy resource.
 
 

data/lib/pulsar/commands/cap.rb

@@ -1,9 +1,13 @@
 module Pulsar
   class CapCommand < MainCommand
     option [ "-k", "--keep-capfile" ], :flag,
-                                       "don't remove the generated capfile in the /tmp/ directory",
+                                       "don't remove the generated capfile in the TMP DIR directory",
                                        :default => false
 
+    option [ "-r", "--keep-repo" ], :flag,
+                                    "don't remove the downloaded configuration repository from the TMP DIR directory",
+                                    :default => false
+
     option [ "-l", "--log-level" ], "LOG LEVEL",
                                     "how much output will Capistrano print out. Can be any of: important, info, debug",
                                     :default => "important"
@@ -16,6 +20,14 @@ module Pulsar
                                       "specify a branch for the configuration repository",
                                       :default => "master"
 
+    option [ "-d", "--tmp-dir" ], "TMP DIR",
+                                  "a directory where to put the configuration repo to build capfile with",
+                                  :default => "/tmp/pulsar"
+
+    option [ "-s", "--skip-cap-run" ], :flag,
+                                       "do everything pulsar does (build a Capfile) but don't run the cap command",
+                                       :default => false
+
     parameter "APPLICATION", "the application which you would like to deploy"
     parameter "ENVIRONMENT", "the environment on which you would like to deploy" do |env|
       %w(production staging development).include?(env) ? env : raise(ArgumentError)
@@ -31,11 +43,13 @@ module Pulsar
         create_capfile
         build_capfile(target)
 
-        cap_args = [tasks_list].flatten.join(" ")
-        run_capistrano(cap_args)
+        unless skip_cap_run?
+          cap_args = [tasks_list].flatten.join(" ")
+          run_capistrano(cap_args)
+        end
 
         remove_capfile unless keep_capfile?
-        remove_repo
+        remove_repo unless keep_repo?
       end
     end
   end

data/lib/pulsar/commands/list.rb

@@ -1,9 +1,13 @@
 module Pulsar
   class ListCommand < MainCommand
     option [ "-k", "--keep-capfile" ], :flag, 
-                                       "don't remove the generated capfile in the /tmp/ directory",
+                                       "don't remove the generated capfile in the TMP DIR directory",
                                        :default => false
 
+    option [ "-r", "--keep-repo" ], :flag,
+                                    "don't remove the downloaded configuration repository from the TMP DIR directory",
+                                    :default => false
+
     option [ "-c", "--conf-repo" ], "REPO URL",
                                     "a git repository with deploy configurations, mainly apps and recipes",
                                     :required => true
@@ -12,6 +16,10 @@ module Pulsar
                                       "specify a branch for the configuration repository",
                                       :default => "master"
 
+    option [ "-d", "--tmp-dir" ], "TMP DIR",
+                                  "a directory where to put the configuration repo to build capfile with",
+                                  :default => "/tmp/pulsar"
+
     def execute
       Bundler.with_clean_env do
         fetch_repo
@@ -19,7 +27,7 @@ module Pulsar
         list_apps
 
         remove_capfile unless keep_capfile?
-        remove_repo
+        remove_repo unless keep_repo?
       end
     end
   end

data/lib/pulsar/helpers/capistrano.rb

@@ -12,9 +12,9 @@ module Pulsar
         end
 
         def method_missing(meth, *args, &block)
-          if File.directory?("#{config_path}/recipes/#{meth}")
+          if File.directory?("#{ENV['CONFIG_PATH']}/recipes/#{meth}")
             args.each do |arg|
-              @cap_conf.load("#{config_path}/recipes/#{meth}/#{arg}.rb")
+              @cap_conf.load("#{ENV['CONFIG_PATH']}/recipes/#{meth}/#{arg}.rb")
             end
           else
             super

data/lib/pulsar/helpers/clamp.rb

@@ -18,17 +18,22 @@ module Pulsar
       end
 
       def bundle_install
-        FileUtils.cd(config_path, :verbose => verbose?) do
+        cd(config_path, :verbose => verbose?) do
           run_cmd("bundle install --quiet", :verbose => verbose?)
         end
       end
 
       def capfile_path
-        @capfile_name ||= "/tmp/pulsar/capfile-#{Time.now.strftime("%Y-%m-%d-%H%M%S")}"
+        @capfile_name ||= "#{tmp_dir}/capfile-#{time_to_deploy}"
+      end
+
+      def cd(path, opts, &block)
+        puts "Directory: #{path.white}".yellow if opts[:verbose]
+        FileUtils.cd(path) { yield }
       end
 
       def config_path
-        @configuration_path ||= "/tmp/pulsar/conf_repo"
+        @configuration_path ||= "#{tmp_dir}/conf-repo-#{time_to_deploy}"
       end
 
       def create_capfile
@@ -36,7 +41,22 @@ module Pulsar
       end
 
       def fetch_repo
-        repo = !conf_repo.include?(':') ? "git@github.com:#{conf_repo}.git" : conf_repo
+        if conf_repo =~ /\A[a-zA-Z-]+\/[a-zA-Z-]+\Z/
+          fetch_git_repo("git@github.com:#{conf_repo}.git")
+        else
+          fetch_directory_repo(conf_repo)
+        end
+      end
+
+      def fetch_directory_repo(repo)
+        if File.directory?("#{repo}/.git")
+          fetch_git_repo(repo)
+        else
+          run_cmd("cp -rp #{repo} #{config_path}", :verbose => verbose?)
+        end
+      end
+
+      def fetch_git_repo(repo)
         git_options = "--quiet --depth=1 --branch #{conf_branch}"
         run_cmd("git clone #{git_options} #{repo} #{config_path}", :verbose => verbose?)
       end
@@ -87,7 +107,7 @@ module Pulsar
               end
             end
 
-            puts "#{app_name}: #{app_envs.join(', ')}"
+            puts "#{app_name.cyan}: #{app_envs.map(&:magenta).join(', ')}"
           end
         end
       end
@@ -101,14 +121,21 @@ module Pulsar
       end
 
       def run_capistrano(args)
-        FileUtils.cd(config_path, :verbose => verbose?) do
-          run_cmd("bundle exec cap --file #{capfile_path} #{args}", :verbose => verbose?)
+        cd(config_path, :verbose => verbose?) do
+          run_cmd("CONFIG_PATH=#{config_path} bundle exec cap --file #{capfile_path} #{args}", :verbose => verbose?)
         end
       end
 
+      def rm_rf(path, opts)
+        puts "Remove: #{path.white}".yellow if opts[:verbose]
+        FileUtils.rm_rf(path)
+      end
+
       def run_cmd(cmd, opts)
-        puts cmd if opts[:verbose]
+        puts "Command: #{cmd.white}".yellow if opts[:verbose]
         system(cmd)
+
+        raise "Command #{cmd} Failed" if $? != 0
       end
 
       def set_log_level
@@ -121,6 +148,15 @@ module Pulsar
 
         run_cmd(cmd, :verbose => verbose?)
       end
+
+      def time_to_deploy
+        @now ||= Time.now.strftime("%Y-%m-%d-%H%M%S-s#{rand(9999)}")
+      end
+
+      def touch(file, opts)
+        puts "Touch: #{file.white}".yellow if opts[:verbose]
+        FileUtils.touch(file)
+      end
     end
   end
 end

data/lib/pulsar/version.rb

@@ -1,3 +1,3 @@
 module Pulsar
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/pulsar.rb

@@ -1,8 +1,9 @@
 require "pulsar/version"
 
 module Pulsar
-  require 'bundler'
   require "clamp"
+  require "bundler"
+  require "colored"
   require "pulsar/helpers/clamp"
   require "pulsar/helpers/capistrano"
   require "pulsar/commands/all"

data/pulsar.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "clamp", "~> 0.5"
   gem.add_dependency "bundler", "~> 1.2"
+  gem.add_dependency "colored", "~> 1.2"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 2.12"

data/spec/pulsar/commands/cap_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Pulsar::CapCommand do
+  let(:pulsar) { Pulsar::CapCommand.new("cap") }
+
+  it "builds a Capfile file in tmp dir" do
+    expect { pulsar.run(full_cap_args + dummy_app) }.to change{ Dir.glob("#{tmp_path}/capfile-*").length }.by(1)
+  end
+
+  it "copies a the repo over to temp directory" do
+    expect { pulsar.run(full_cap_args + %w(--keep-repo) + dummy_app) }.to change{ Dir.glob("#{tmp_path}/conf-repo*").length }.by(1)
+  end
+
+  it "copies a the repo when there is a dir with same name" do
+    system("mkdir #{tmp_path}/conf-repo")
+    expect { pulsar.run(full_cap_args + %w(--keep-repo) + dummy_app) }.to change{ Dir.glob("#{tmp_path}/conf-repo*").length }.by(1)
+  end
+
+  context "--conf-repo option" do
+    it "is required" do
+      expect { pulsar.parse([""]) }.to raise_error(Clamp::UsageError)
+    end
+
+    it "supports directories" do
+      expect { pulsar.run(full_cap_args + dummy_app) }.not_to raise_error(Errno::ENOENT)
+    end
+  end
+
+  context "--tmp-dir option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--tmp-dir dummy_tmp) + dummy_app) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+
+  context "--keep-capfile option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--keep-capfile) + dummy_app) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+
+  context "--skip-cap-run option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--skip-cap-run) + dummy_app) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+
+  context "--keep-repo option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--keep-repo) + dummy_app) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+end

data/spec/pulsar/commands/list_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Pulsar::ListCommand do
+  let(:pulsar) { Pulsar::ListCommand.new("list") }
+
+  it "copies a the repo over to temp directory" do
+    expect { pulsar.run(full_list_args + %w(--keep-repo)) }.to change{ Dir.glob("#{tmp_path}/conf-repo*").length }.by(1)
+  end
+
+  it "copies a the repo when there is a dir with same name" do
+    system("mkdir #{tmp_path}/conf-repo")
+    expect { pulsar.run(full_list_args + %w(--keep-repo)) }.to change{ Dir.glob("#{tmp_path}/conf-repo*").length }.by(1)
+  end
+
+  context "--conf-repo option" do
+    it "is required" do
+      expect { pulsar.parse([""]) }.to raise_error(Clamp::UsageError)
+    end
+    
+    it "supports directories" do
+      expect { pulsar.run(full_list_args) }.not_to raise_error(Errno::ENOENT)
+    end
+  end
+
+  context "--tmp-dir option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--tmp-dir dummy_tmp)) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+
+  context "--keep-capfile option" do
+    it "is supported" do
+      expect { pulsar.parse(base_args + %w(--keep-capfile)) }.to_not raise_error(Clamp::UsageError)
+    end
+  end
+end

data/spec/pulsar/commands/main_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Pulsar::MainCommand do
+  let(:pulsar) { Pulsar::MainCommand.new("") }
+
+  context "--version option" do
+    before do
+      begin
+        pulsar.parse(["--version"])
+      rescue SystemExit => e
+        @system_exit = e
+      end
+    end
+
+    it "shows version" do
+      stdout.should include(Pulsar::VERSION)
+    end
+
+    it "exits with a zero status" do
+      @system_exit.should_not be_nil
+      @system_exit.status.should == 0
+    end
+  end
+
+  context "subcommands" do
+    it "should be cap and list" do
+      help = pulsar.help
+      help.should =~ /Subcommands:/
+      help.should =~ /cap/
+      help.should =~ /list/
+    end
+  end
+end

data/spec/pulsar/helpers/clamp_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Pulsar::Helpers::Clamp do
+  include Pulsar::Helpers::Clamp
+
+  context "run_cmd" do
+    it "raises exception if command fails" do
+      expect { run_cmd("return 1", {}) }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,29 +1,21 @@
 require "rspec"
+require "stringio"
+require "fileutils"
 require "pulsar"
-require 'stringio'
+require "pulsar/commands/main"
+
+#
+# Require all helper modules
+# 
+Dir[File.join(File.dirname(__FILE__), 'support/modules/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
   config.mock_with :rr
-end
 
-module OutputCapture
-  def self.included(target)
-    target.before do
-      $stdout = @out = StringIO.new
-      $stderr = @err = StringIO.new
-    end
-
-    target.after do
-      $stdout = STDOUT
-      $stderr = STDERR
-    end
-  end
+  config.include Helpers
+  config.include OutputCapture
 
-  def stdout
-    @out.string
+  config.after(:suite) do
+    FileUtils.rm_r(Dir.glob("#{File.dirname(__FILE__)}/support/tmp/*"))
   end
-
-  def stderr
-    @err.string
-  end
-end
+end

data/spec/support/dummy_conf/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Require from local gem
+gem 'pulsar', :path => '../../../../'

data/spec/support/dummy_conf/apps/base.rb

@@ -0,0 +1,44 @@
+#
+# Require and extend with additional modules
+#
+require 'pulsar'
+
+extend Pulsar::Helpers::Capistrano
+
+#
+# Load deploy capistrano recipe
+#
+load 'deploy'
+
+#
+# Configure libraries/recipes from Gemfile
+#
+require 'bundler/capistrano'
+
+#
+# Load default recipes
+#
+load_recipes do
+  generic :notify, :cleanup, :rake
+end
+
+#
+# Put here shared configuration that should be by default
+#
+set :scm, :git
+
+set :ssh_options, { :forward_agent => true }
+
+set :default_run_options, { :pty => true }
+
+set :deploy_to, defer { "/var/www/#{application}" }
+
+set :deploy_via, :remote_cache
+
+set :user, "www-data"
+
+set :use_sudo, false
+
+set :rake, "bundle exec rake"
+
+set :rails_env, defer { "#{stage}" }

data/spec/support/dummy_conf/apps/dummy_app/defaults.rb

@@ -0,0 +1,5 @@
+set :application, "dummy_app"
+
+load_recipes do
+  generic :recipe
+end

data/spec/support/dummy_conf/apps/dummy_app/production.rb

@@ -0,0 +1,3 @@
+server "dummy.it", :db, :web, :app, :primary => true
+
+set :stage, "production"

data/spec/support/dummy_conf/apps/dummy_app/staging.rb

@@ -0,0 +1,3 @@
+server "staging.dummy.it", :db, :web, :app, :primary => true
+
+set :stage, "staging"

data/spec/support/dummy_conf/recipes/generic/recipe.rb

@@ -0,0 +1,3 @@
+#
+# This is a dummy generic recipe
+#

data/spec/support/modules/helpers.rb

@@ -0,0 +1,25 @@
+module Helpers
+  def base_args
+    [ "--conf-repo", dummy_conf_path ]
+  end
+
+  def full_cap_args
+    base_args + [ "--tmp-dir", tmp_path, "--keep-capfile", "--skip-cap-run" ]
+  end
+
+  def full_list_args
+    base_args + [ "--tmp-dir", tmp_path, "--keep-capfile" ]
+  end
+
+  def dummy_conf_path
+    File.join(File.dirname(__FILE__), "..", "dummy_conf")
+  end
+
+  def tmp_path
+    File.join(File.dirname(__FILE__), "..", "tmp")
+  end
+
+  def dummy_app
+    [ "dummy_app", "production" ]
+  end
+end

data/spec/support/modules/output_capture.rb

@@ -0,0 +1,21 @@
+module OutputCapture
+  def self.included(target)
+    target.before do
+      $stdout = @out = StringIO.new
+      $stderr = @err = StringIO.new
+    end
+
+    target.after do
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
+
+  def stdout
+    @out.string
+  end
+
+  def stderr
+    @err.string
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pulsar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -44,6 +44,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +119,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -118,8 +135,21 @@ files:
 - lib/pulsar/tasks/.gitkeep
 - lib/pulsar/version.rb
 - pulsar.gemspec
-- spec/pulsar/commands_spec.rb
+- spec/pulsar/commands/cap_spec.rb
+- spec/pulsar/commands/list_spec.rb
+- spec/pulsar/commands/main_spec.rb
+- spec/pulsar/helpers/clamp_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_conf/Gemfile
+- spec/support/dummy_conf/apps/base.rb
+- spec/support/dummy_conf/apps/dummy_app/defaults.rb
+- spec/support/dummy_conf/apps/dummy_app/production.rb
+- spec/support/dummy_conf/apps/dummy_app/recipes/.gitkeep
+- spec/support/dummy_conf/apps/dummy_app/staging.rb
+- spec/support/dummy_conf/recipes/generic/recipe.rb
+- spec/support/modules/helpers.rb
+- spec/support/modules/output_capture.rb
+- spec/support/tmp/.gitkeep
 homepage: https://github.com/nebulab/pulsar
 licenses: []
 post_install_message: 
@@ -134,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1849999196866319529
+      hash: 1088010047728925566
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1849999196866319529
+      hash: 1088010047728925566
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -153,5 +183,18 @@ summary: A simple gem that parses capistrano configuration froma another (privat
   repository providing a simple solution to managing multiple systems without installing
   capistrano configurations in each app.
 test_files:
-- spec/pulsar/commands_spec.rb
+- spec/pulsar/commands/cap_spec.rb
+- spec/pulsar/commands/list_spec.rb
+- spec/pulsar/commands/main_spec.rb
+- spec/pulsar/helpers/clamp_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_conf/Gemfile
+- spec/support/dummy_conf/apps/base.rb
+- spec/support/dummy_conf/apps/dummy_app/defaults.rb
+- spec/support/dummy_conf/apps/dummy_app/production.rb
+- spec/support/dummy_conf/apps/dummy_app/recipes/.gitkeep
+- spec/support/dummy_conf/apps/dummy_app/staging.rb
+- spec/support/dummy_conf/recipes/generic/recipe.rb
+- spec/support/modules/helpers.rb
+- spec/support/modules/output_capture.rb
+- spec/support/tmp/.gitkeep

data/spec/pulsar/commands_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe Pulsar::MainCommand do
-  include OutputCapture
-
-  context "with required arguments" do
-    before do
-      @pulsar = Pulsar::CapCommand.new("cap")
-      @pulsar.parse(%w(-c repo.com project development))
-    end
-
-    it "should set variables correctly" do
-      @pulsar.conf_repo.should == "repo.com"
-      @pulsar.application.should == "project"
-      @pulsar.environment.should == "development"
-    end
-  end
-end