pulsar 0.0.5 → 0.0.6

data/README.md

@@ -1,49 +1,19 @@
 # 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)
+[![Code Climate](https://codeclimate.com/github/nebulab/pulsar.png)](https://codeclimate.com/github/nebulab/pulsar)
 
-NebuLab's central capistrano deploy resource.
+Pulsar is a little tool that helps with deploys. Its main purpose is building capfiles for [Capistrano](https://rubygems.org/gems/capistrano) 
+to run. It makes it easy to manage a large number of apps via a separate configuration repository.
 
+## Installation & Usage
 
-A quick example. To run any cap command for an application specified in a configuration repo you can run:
-
-```
-pulsar -c=<configuration-repo-git-url> <application> <stage> <capistrano_args>
-```
-
-A couple of concrete examples:
-
-```
-pulsar -c git@github.com:nebulab/deploy-configuration.git nebulab production --tasks
-
-pulsar -c git@github.com:nebulab/deploy-configuration.git nebulab staging # Deploy on staging
-
-pulsar -c git@github.com:nebulab/deploy-configuration.git farmavillage production deploy:check
-```
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'pulsar'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install pulsar
-
-## Usage
-
-TODO: Write usage instructions here
+Refer to the [GitHub Page](http://pulsar.nebulab.it).
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes with tests (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/lib/pulsar/commands/all.rb

@@ -2,4 +2,5 @@ module Pulsar
   autoload :MainCommand, "pulsar/commands/main"
   autoload :CapCommand, "pulsar/commands/cap"
   autoload :ListCommand, "pulsar/commands/list"
+  autoload :InitCommand, "pulsar/commands/init"
 end

data/lib/pulsar/commands/init.rb

@@ -0,0 +1,21 @@
+module Pulsar
+  class InitCommand < MainCommand
+    parameter "CONFIGURATION_PATH", "where to generate your configuration repository"
+
+    def execute
+      Bundler.with_clean_env do
+        destination_path = File.expand_path(configuration_path)
+
+        pulsar_cmd_path = File.expand_path(File.dirname(__FILE__))
+        init_repo_path = "#{pulsar_cmd_path}/../generators/init_repo"
+
+        init_repo_path += "/*" if File.directory?(destination_path)
+
+        run_cmd("cp -r #{init_repo_path} #{destination_path}", :verbose => verbose?)
+
+        puts "Your starter configuration repo is in #{destination_path.yellow}."
+        puts "Remember to run #{ "bundle install".red } to add the needed Gemfile.lock."
+      end
+    end
+  end
+end

data/lib/pulsar/commands/main.rb

@@ -17,5 +17,6 @@ module Pulsar
     #
     subcommand "cap", "build a capfile from configuration repo and execute the cap command on it", CapCommand
     subcommand "list", "list all available apps and environments which you can deploy", ListCommand
+    subcommand "init", "generate a new configuration repo with some basic recipes to use with pulsar", InitCommand
   end
 end

data/lib/pulsar/generators/init_repo/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'pulsar'
+gem 'capistrano'
+
+gem 'colored'
+gem 'spinning_cursor'

data/lib/pulsar/generators/init_repo/README.md

@@ -0,0 +1,4 @@
+Pulsar Configuration
+====================
+
+Pulsar deploy configurations

data/lib/pulsar/generators/init_repo/apps/base.rb

@@ -0,0 +1,41 @@
+#
+# Require everything and extend with additional modules
+#
+Bundler.require
+
+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 :cleanup, :rake
+end
+
+#
+# Put here shared configuration that should be a default
+# for all your apps
+#
+
+# set :scm, :git
+# set :repository, defer { "git@github.com:your_gh_user/#{application}.git" }
+# set :branch, "master"
+# set :port, 22
+# 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/lib/pulsar/generators/init_repo/apps/your_app/defaults.rb

@@ -0,0 +1,9 @@
+set :application, "your_app"
+
+load_recipes do
+  #
+  # Recipes you wish to include as defaults for both stages
+  # for example:
+  #
+  # rails :assets
+end

data/lib/pulsar/generators/init_repo/apps/your_app/production.rb

@@ -0,0 +1,12 @@
+server "your_app.com", :db, :web, :app, :primary => true
+
+set :stage, "production"
+
+load_recipes do
+  #
+  # Recipes you wish to include for production stage only
+  # for example:
+  #
+  # rails :fix_permissions, :symlink_db
+  # server :unicorn
+end

data/lib/pulsar/generators/init_repo/apps/your_app/recipes/custom_recipe.rb

@@ -0,0 +1,14 @@
+# 
+# Use this directory to include any file you whish to 
+# include whenever you run this app.
+#
+# You don't need to run the include_recipe method. 
+#
+# The filename can be whatever you want it to be.
+#
+# These recipes are considered custom and always appended
+# to the Capfile of this application.
+# 
+# production/ and staging/ directories will have recipes
+# which are automatically included only in such stages.
+#

data/lib/pulsar/generators/init_repo/apps/your_app/staging.rb

@@ -0,0 +1,12 @@
+server "staging.your_app.com", :db, :web, :app, :primary => true
+
+set :stage, "staging"
+
+load_recipes do
+  #
+  # Recipes you wish to include for staging stage only
+  # for example:
+  #
+  # server :passenger
+  # notify :campfire
+end

data/lib/pulsar/generators/init_repo/recipes/generic/cleanup.rb

@@ -0,0 +1,50 @@
+if logger.level == Capistrano::Logger::IMPORTANT
+  arrow = "→".yellow.bold
+  ok = "✓".green
+
+  before "deploy:update_code" do
+    SpinningCursor.start do
+      banner "#{arrow} Updating Code"
+      message "#{arrow} Updating Code #{ok}"
+    end
+  end
+
+  before "bundle:install" do
+    SpinningCursor.start do
+      banner "#{arrow} Installing Gems"
+      message "#{arrow} Installing Gems #{ok}"
+    end
+  end
+
+  before "deploy:assets:symlink" do
+    SpinningCursor.start do
+      banner "#{arrow} Symlinking Assets"
+      message "#{arrow} Symlinking Assets #{ok}"
+    end
+  end
+
+  before "deploy:assets:precompile" do
+    SpinningCursor.start do
+      banner "#{arrow} Compiling Assets"
+      message "#{arrow} Compiling Assets #{ok}"
+    end
+  end
+
+  before "deploy:create_symlink" do
+    SpinningCursor.start do
+      banner "#{arrow} Symlinking Application"
+      message "#{arrow} Symlinking Application #{ok}"
+    end
+  end
+
+  before "deploy:restart" do
+    SpinningCursor.start do
+      banner "#{arrow} Restarting Webserver"
+      message "#{arrow} Restarting Webserver #{ok}"
+    end
+  end
+
+  after "deploy" do
+    SpinningCursor.stop
+  end
+end

data/lib/pulsar/generators/init_repo/recipes/generic/rake.rb

@@ -0,0 +1,6 @@
+namespace :rake do
+  desc "Invoke your awesome rake tasks!"
+  task :invoke, :roles => :web do
+    run("cd #{deploy_to}/current && RAILS_ENV=#{rails_env} bundle exec rake #{ENV['ARGS']}")
+  end
+end

data/lib/pulsar/version.rb

@@ -1,3 +1,3 @@
 module Pulsar
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/pulsar/commands/init_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Pulsar::InitCommand do
+  let(:pulsar) { Pulsar::InitCommand.new("init") }
+
+  it "copies over the configuration repo" do
+    expect { pulsar.run(["#{tmp_path}/new-conf-repo"]) }.to change{ Dir.glob("#{tmp_path}/new-conf-repo").length }.by(1)
+  end
+end

data/spec/pulsar/commands/main_spec.rb

@@ -23,11 +23,12 @@ describe Pulsar::MainCommand do
   end
 
   context "subcommands" do
-    it "should be cap and list" do
+    it "should be cap and list and init" do
       help = pulsar.help
       help.should =~ /Subcommands:/
       help.should =~ /cap/
       help.should =~ /list/
+      help.should =~ /init/
     end
   end
 end

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ RSpec.configure do |config|
   config.include Helpers
   config.include OutputCapture
 
-  config.after(:suite) do
-    FileUtils.rm_r(Dir.glob("#{File.dirname(__FILE__)}/support/tmp/*"))
+  config.around(:each) do
+    FileUtils.rm_rf(Dir.glob("#{File.dirname(__FILE__)}/support/tmp/*"))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pulsar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -128,14 +128,28 @@ files:
 - lib/pulsar.rb
 - lib/pulsar/commands/all.rb
 - lib/pulsar/commands/cap.rb
+- lib/pulsar/commands/init.rb
 - lib/pulsar/commands/list.rb
 - lib/pulsar/commands/main.rb
+- lib/pulsar/generators/init_repo/Gemfile
+- lib/pulsar/generators/init_repo/README.md
+- lib/pulsar/generators/init_repo/apps/base.rb
+- lib/pulsar/generators/init_repo/apps/your_app/defaults.rb
+- lib/pulsar/generators/init_repo/apps/your_app/production.rb
+- lib/pulsar/generators/init_repo/apps/your_app/recipes/custom_recipe.rb
+- lib/pulsar/generators/init_repo/apps/your_app/recipes/production/.gitkeep
+- lib/pulsar/generators/init_repo/apps/your_app/recipes/staging/.gitkeep
+- lib/pulsar/generators/init_repo/apps/your_app/staging.rb
+- lib/pulsar/generators/init_repo/recipes/generic/cleanup.rb
+- lib/pulsar/generators/init_repo/recipes/generic/rake.rb
+- lib/pulsar/generators/init_repo/recipes/rails/.gitkeep
 - lib/pulsar/helpers/capistrano.rb
 - lib/pulsar/helpers/clamp.rb
 - lib/pulsar/tasks/.gitkeep
 - lib/pulsar/version.rb
 - pulsar.gemspec
 - spec/pulsar/commands/cap_spec.rb
+- spec/pulsar/commands/init_spec.rb
 - spec/pulsar/commands/list_spec.rb
 - spec/pulsar/commands/main_spec.rb
 - spec/pulsar/helpers/clamp_spec.rb
@@ -164,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3869526505221080668
+      hash: -1640336626814053383
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3869526505221080668
+      hash: -1640336626814053383
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -184,6 +198,7 @@ summary: A simple gem that parses capistrano configuration froma another (privat
   capistrano configurations in each app.
 test_files:
 - spec/pulsar/commands/cap_spec.rb
+- spec/pulsar/commands/init_spec.rb
 - spec/pulsar/commands/list_spec.rb
 - spec/pulsar/commands/main_spec.rb
 - spec/pulsar/helpers/clamp_spec.rb