vlad-push 1.0.2 → 1.1.1

data/README.txt

@@ -13,14 +13,14 @@ Adds support to Vlad for pushing files to a remote server without SCM. (Really,
 
 == SYNOPSIS:
 
-  $ rake <env> vlad:push
-  $ rake <env> vlad:update
+  $ rake [env] vlad:push
+  $ rake [env] vlad:update
 
          ^-- if using environment tasks in deploy.rb
 
   or
 
-  $ rake <env> vlad:deploy
+  $ rake [env] vlad:deploy
 
          ^-- if using environment tasks in deploy.rb
 
@@ -33,6 +33,7 @@ Adds support to Vlad for pushing files to a remote server without SCM. (Really,
 
   set :deploy_to, "/web/root"
   set :repository, "/push/root"
+  set :extract_file, "#{application}-#{release_name}.tgz"
 
 == REQUIREMENTS:
 
@@ -40,16 +41,18 @@ Adds support to Vlad for pushing files to a remote server without SCM. (Really,
 
 == INSTALL:
 
-    $ sudo gem install vlad-push 
+    $ sudo gem install vlad-push
 
 == VARIABLES:
 
 repository::	        Vlad config param, should be set to a directory location
 			to use as repo on remote server(s)
                         <tt>:repository => "/tmp/repo"</tt>
-domain::	        See Vlad :domain variable
-scp_cmd::          	Defaults to <tt>scp</tt>
-ssh_flags::             See Vlad :ssh_flags variable
+extract_file::          Name of tarball that vlad-push will generate, we suggest changing this
+extract_dir::           Path to a directory that we will create the extract in, defaults to "/tmp"
+domain::	        See remote_task :domain variable
+ssh_flags::             See remote_task :ssh_flags variable
+rsync_flags::           See remote_task :rsync_flags variable
 
 == ACKKNOWLEDGEMENTS
 

data/lib/vlad/push.rb

@@ -1,60 +1,77 @@
 require 'vlad'
 
+# @author Joshua P. Mervine <jmervine@mervine.net>
+#
+# Please see {file:lib/vlad/push.rb Vlad::Push Source} for Rake task documentation.
 class Vlad::Push
-  VERSION = "1.0.2"
+  VERSION = "1.1.1"
 
+  # @attribute[rw]
+  # init Vlad::Push
   set :source, Vlad::Push.new
 
-  # default to be overwritten by deploy.rb as needed
-  set :repository,      "/tmp/repo"
-  set :scm,             :push
-  set :push_scp, "scp"
-  set :ssh_flags, ""
+  # @attribute[rw]
+  # set default repository
+  set :repository, "/tmp/repo"
+
+  # @attribute[rw]
+  # set default scm
+  set :scm, :push
+
+  # @attribute[rw]
+  # allow for overwriting release_name via command line
   set :release_name, ENV['RELEASE']||release_name
 
-  # telling vlad not to bother running checkout
-  # but this doesn't seem to work, I'll probably
-  # moving it to the Rakefile
+  # @attribute[rw]
+  # set default directory to build tarballs in
+  set :extract_dir, "/tmp"
+
+  # @attribute[rw]
+  # set default name of tarball generates, you should override this in your rakefile
+  set :extract_file, "vlad-push-extract-#{release_name}.tgz"
+
+  # Overwriting Vlad.checkout, to do nothing.
+  #
+  # @return [String] echo bash command
+  #
+  # @param revision [String] ignored
+  # @param destination [String] ignored
   def checkout(revision, destination)
     "echo '[vlad-push] skipping checkout, not needed without scm'"
   end
 
-  # overwrite vlad export to simply copied what was
-  # pushed from the 'repository' location to the 
+  # Overwrite Vlad.export to simply copied what was
+  # pushed from the 'repository' location to the
   # 'destination'
-  # * 'source' is for vlad support, but ignored
+  #
+  # @param source [String] ignored
+  # @param destination [String] target export folder
   def export(source, destination)
-    # ignoring source
     "cp -r #{repository} #{destination}"
   end
 
-  # telling vlad to use "repository" as "revision" just
-  # in case this method is needed
+  # Overwriting Vlad.revision
+  #
+  # @param revision [String] ignored
+  # @return [String] returning 'repository'
   def revision(revision)
     repository
   end
 
-  # push extracted and compressed files to 'host'
-  # this should be run once for each host by
-  # the rake task :push
-  def push(host)
-    [ "#{push_scp} #{ssh_flags.join(' ')}",
-      "/tmp/#{application}-#{release_name}.tgz",
-      "#{host}:/tmp/#{application}-#{release_name}.tgz"
-    ].join(" ")
-  end
-
-  # extract the remote compressed file on each host
+  # Extract the remote compressed file on each host
+  #
+  # @return [String] bash command to extract compressed archive on remote server
   def push_extract
     [ "if [ -e #{repository} ]; then rm -rf #{repository}; fi",
       "mkdir -p #{repository}",
       "cd #{repository}",
-      "tar -xzf /tmp/#{application}-#{release_name}.tgz"
+      "tar -xzf #{extract_dir}/#{extract_file}"
     ].join(" && ")
   end
 
-  # clean up old compressed archives both locally and
-  # remotely
+  # Clean up old compressed archives both locally and remotely
+  #
+  # @return [String] bash command to remove compressed archives
   def push_cleanup
     [ "rm -vrf /tmp/#{application}-*.tgz",
       [ "if [ -e #{repository} ]",
@@ -64,27 +81,34 @@ class Vlad::Push
     ].join(" && ")
   end
 
-  # compress the files in the current working directory 
+  # Compress the files in the current working directory
   # to be pushed to the remote server
+  #
+  # @return [String] bash command to compress current directory
   def compress
-    [ "tar -czf /tmp/#{application}-#{release_name}.tgz",
+    [ "tar -czf #{extract_dir}/#{extract_file}",
       '--exclude "\.git*"',
       '--exclude "\.svn*"',
       "."
-    ].join(" ") 
+    ].join(" ")
   end
 
-  # using :vlad namespace to make this part 
+  # Using :vlad namespace to make this part
   # of vlad in rake
   namespace :vlad do
 
-    desc "Push current working directory to remote servers."
-    remote_task :push do
+    desc "Built the extracted tarball to be pushed from the CWD"
+    task :create_extract do
       sh source.compress
-      # TODO: find a better way to ensure array for each
-      [domain].flatten.each do |host|
-        sh source.push(host)
-      end
+    end
+
+    # Run the following on specified environment:
+    # * Vlad::Push.compress
+    # * Vlad::Push.push
+    # * Vlad::Push.push_extract
+    desc "Push current working directory to remote servers."
+    remote_task :push => :create_extract do
+      rsync "#{extract_dir}/#{extract_file}", "#{target_host}:#{extract_dir}/#{extract_file}"
       run source.push_extract
     end
 
@@ -93,12 +117,16 @@ class Vlad::Push
       Rake::Task['vlad:push_cleanup'].invoke
     end
 
+    # Run the following on specified environment:
+    # * Vlad::Push.push_cleanup on local machine
+    # * Vlad::Push.push_cleanup on remote machines
     desc "Clean up archive files created by push. This will also be run by vlad:cleanup."
     remote_task :push_cleanup do
       sh source.push_cleanup
       run source.push_cleanup
     end
 
+    # Adding task to do both 'vlad:push' and 'vlad:update' rake tasks
     desc "Runs push and update"
     task :deploy do
       Rake::Task["vlad:push"].invoke
@@ -107,6 +135,6 @@ class Vlad::Push
 
   end
 
-end 
+end
 
 

data/test/test_vlad_push.rb

@@ -5,11 +5,12 @@ class TestVladPush < Test::Unit::TestCase
   def setup
     super
     @source = Vlad::Push.new
+    set :application, "testapp"
     set :repository, "/tmp/repo"
-    set :push_scp, "scp"
     set :ssh_flags, [ "-i", "~/.ssh/id_rsa_example" ]
     set :application, "testapp"
     set :release_name, "12345678910"
+    set :extract_file, "#{application}-#{release_name}.tgz"
   end
 
   def test_checkout
@@ -27,11 +28,6 @@ class TestVladPush < Test::Unit::TestCase
     assert_equal '/tmp/repo', out
   end
 
-  def test_push
-    cmd = @source.push 'example.com' 
-    assert_equal 'scp -i ~/.ssh/id_rsa_example /tmp/testapp-12345678910.tgz example.com:/tmp/testapp-12345678910.tgz', cmd
-  end
-
   def test_push_extract
     cmd = @source.push_extract
     assert_equal 'if [ -e /tmp/repo ]; then rm -rf /tmp/repo; fi && mkdir -p /tmp/repo && cd /tmp/repo && tar -xzf /tmp/testapp-12345678910.tgz', cmd

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vlad-push
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-03 00:00:00.000000000Z
+date: 2012-02-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vlad
-  requirement: &2151899840 !ruby/object:Gem::Requirement
+  requirement: &70325218998820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,18 +21,29 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151899840
+  version_requirements: *70325218998820
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70325218998280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70325218998280
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2151898680 !ruby/object:Gem::Requirement
+  requirement: &70325218997760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *2151898680
+  version_requirements: *70325218997760
 description: Adds support to Vlad for pushing files to a remote server without SCM.
   (Really, pre 1.x didn't work as expected.)
 email:
@@ -64,6 +75,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2321986802396206083
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: vlad-push
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Adds support to Vlad for pushing files to a remote server without SCM