vlad-hg 2.0.2 → 2.1.0

data/History.txt

@@ -1,3 +1,10 @@
+=== 2.1.0 / 2010-06-04
+
+* 1 major enhancement
+
+  * Add support for deploying with a patch queue. Useful e.g. for setting up a
+    staging site with minor changes to the production configuration.
+
 === 2.0.2 / 2009-08-28
 
 * 1 minor enhancement

data/Manifest.txt

@@ -3,5 +3,7 @@ Manifest.txt
 README.txt
 Rakefile
 lib/vlad/mercurial.rb
+lib/vlad/mercurial_queue.rb
 test/test_vlad_mercurial.rb
+test/test_vlad_mercurial_queue.rb
 test/vlad_test_case.rb

data/README.txt

@@ -7,12 +7,15 @@
 == DESCRIPTION:
 
 Mercurial support for Vlad. Using it is as simple as passing
-<tt>:scm => :mercurial</tt> to Vlad when loading it up (see Synopsis below).
+<tt>:scm => :mercurial</tt> to Vlad when loading it up.
 
 == FEATURES/PROBLEMS:
 
 * Plug it in, it works.
 
+* Supports deploying a patch queue on top of the deployed site (uses Mercurial
+  Queues extension). See documentation below.
+
 == SYNOPSIS
 
     # lib/tasks/vlad.rake
@@ -25,17 +28,70 @@ Mercurial support for Vlad. Using it is as simple as passing
 == REQUIREMENTS:
 
 * Vlad[http://rubyhitsquad.com/Vlad_the_Deployer.html]
+
 * Mercurial[http://mercurial.selenic.com/]
 
+* Mercurial Queues[http://mercurial.selenic.com/wiki/MqExtension] extension
+  enabled if using patch queue deployment (bundled with Mercurial, disabled by
+  default)
+
 == INSTALL:
 
 * sudo gem install vlad-hg
 
+== PATCH QUEUES:
+
++vlad-hg+ supports deploying from a patch queue repository on top of the main
+site repository. This is useful e.g. for deploying a staging site with minor
+configuration changes from the production site. To use it, pass <tt>:scm => 
+:mercurial_queue</tt> to Vlad.load instead of <tt>:scm => :mercurial</tt>.
+
+For example, say your repository is at http://example.com/hg/my-site and
+you're deploying to http://my-site.example.com/. You want to set up a staging
+site with your latest trunk code at http://my-staging-site.example.com/, so
+that you can test your changes before deploying to the live site. You set up a
+patch queue repository with the staging configuration like so:
+
+    $ hg qinit -c                     # make the patch queue version-controlled
+    $ hg qnew -m 'staging configuration' staging.patch
+    ...configure for staging database, etc...
+    $ hg qrefresh
+    $ hg qcommit -m 'commit current patch queue'
+
+You now have a repository in <working repo>/.hg/patches that contains your
+configuration changes. You can clone this repository to your canonical
+repository location:
+
+    $ hg clone .hg/patches http://example.com/hg/my-site/.hg/patches   # first time
+    $ hg push -R .hg/patches http://example.com/hg/my-site/.hg/patches # push subsequent changes
+
+Now when you run <tt>rake vlad:update</tt>, it will update the repository on the
+server and push all the patches in the queue (<tt>hg qpush -a</tt>) before
+exporting the release directory.
+
++vlad-hg+ can also use a patch queue in a location other than
+<repository>/.hg/patches. To do this, it adds the +queue_repo+ variable. For
+example, say you want to keep your patch queue at
+http://example.com/hg/my-staging-site. You would have this in
++config/deploy.rb+:
+
+    set :repository, "http://example.com/hg/my-site"
+    set :queue_repo, "http://example.com/hg/my-staging-site"
+
+and you would push your patch queue like so:
+
+    $ hg push -R .hg/patches http://example.com/hg/my-staging-site
+
+To use a revision _of the patch queue_ other than +tip+, specify the
++queue_revision+ variable:
+
+    set :queue_revision, "deadbeefd00d"
+
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Ryan Davis and the rest of the Ruby Hit Squad
+Copyright (c) 2010 Kevin Bullock and the rest of the Ruby Hit Squad
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,9 +4,9 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.spec 'vlad-hg' do
-  self.rubyforge_name = 'hitsquad'
-
+  rubyforge_name = 'hitsquad'
   developer 'Kevin R. Bullock', 'kbullock@ringworld.org'
+  extra_deps << ['vlad', '~> 2.0']
 end
 
 # vim: syntax=Ruby

data/lib/vlad/mercurial.rb

@@ -3,7 +3,7 @@ require 'vlad'
 module Vlad
   class Mercurial
 
-    VERSION = '2.0.2'.freeze
+    VERSION = '2.1.0'.freeze
 
     set :source, Vlad::Mercurial.new
     set :hg_cmd, "hg"
@@ -16,8 +16,9 @@ module Vlad
     def checkout(revision, destination)
       revision = 'tip' if revision =~ /^head$/i
 
-      [ "if [ ! -d #{destination}/.hg ]; then #{hg_cmd} init #{destination}; fi",
-        "#{hg_cmd} pull -R #{destination} #{repository}",
+      # These all get executed after a "cd #{scm_path}"
+      [ "if [ ! -d .hg ]; then #{hg_cmd} init; fi",
+        "#{hg_cmd} pull #{repository}",
         "#{hg_cmd} update #{revision}"
       ].join(' && ')
     end
@@ -30,7 +31,7 @@ module Vlad
     def export(revision, destination)
       revision = 'tip' if revision =~ /^head$/i
 
-      "#{hg_cmd} archive -R #{scm_path} -r #{revision} #{destination}"
+      "#{hg_cmd} archive -r #{revision} #{destination}"
     end
 
     ##
@@ -38,7 +39,7 @@ module Vlad
     # into a mercurial changeset ID.
 
     def revision(revision)
-      "`#{hg_cmd} identify -R #{repository} -r #{revision} | cut -f1 -d\\ `"
+      "`#{hg_cmd} identify -r #{revision} | cut -f1 -d\\ `"
     end
 
   end

data/lib/vlad/mercurial_queue.rb

@@ -0,0 +1,53 @@
+require 'vlad'
+
+module Vlad
+  class MercurialQueue
+
+    set :source, Vlad::MercurialQueue.new
+    set :hg_cmd, "hg"
+    set :queue_repo do
+      "#{repository}/.hg/patches"
+    end
+    set :queue_revision, "tip"
+
+    ##
+    # Returns the command that will check out +revision+ from the
+    # repository into directory +destination+.  +revision+ can be any
+    # changeset ID or equivalent (e.g. branch, tag, etc...)
+
+    def checkout(revision, destination)
+      revision = 'tip' if revision =~ /^head$/i
+
+      commands = []
+      commands << "if [ ! -d .hg ]; then #{hg_cmd} init; fi"
+      commands << "if [ ! -d .hg/patches/.hg ]; then #{hg_cmd} qinit -c; fi"
+      commands << "#{hg_cmd} pull #{repository}"
+      commands << "#{hg_cmd} pull -R .hg/patches #{queue_repo}"
+      commands << "#{hg_cmd} qpop -a"
+      commands << "#{hg_cmd} update #{revision}"
+      commands << "#{hg_cmd} update -R .hg/patches #{queue_revision}"
+      commands << "#{hg_cmd} qpush -a"
+      commands.join(' && ')
+    end
+
+    ##
+    # Returns the command that will export +revision+ from the repository into
+    # the directory +destination+.
+    # Expects to be run from +scm_path+ after Vlad::Mercurial#checkout
+
+    def export(revision, destination)
+      revision = 'tip' if revision =~ /^head$/i
+
+      "#{hg_cmd} archive -r qtip #{destination}"
+    end
+
+    ##
+    # Returns a command that maps human-friendly revision identifier +revision+
+    # into a mercurial changeset ID.
+
+    def revision(revision)
+      "`#{hg_cmd} identify -r #{revision} | cut -f1 -d\\ `"
+    end
+
+  end
+end

data/test/test_vlad_mercurial.rb

@@ -12,8 +12,8 @@ class TestVladMercurial < MiniTest::Unit::TestCase
   def test_checkout
     cmd = @scm.checkout 'head', '/path/to/scm'
 
-    expected = "if [ ! -d /path/to/scm/.hg ]; then hg init /path/to/scm; fi " \
-               "&& hg pull -R /path/to/scm http://repo/project " \
+    expected = "if [ ! -d .hg ]; then hg init; fi " \
+               "&& hg pull http://repo/project " \
                "&& hg update tip"
 
     assert_equal expected, cmd
@@ -21,12 +21,13 @@ class TestVladMercurial < MiniTest::Unit::TestCase
 
   def test_export
     cmd = @scm.export 'head', '/path/to/release'
-    assert_equal 'hg archive -R /path/to/scm -r tip /path/to/release', cmd
+    assert_equal 'hg archive -r tip /path/to/release', cmd
   end
 
   def test_revision
-    cmd = @scm.revision('tip')
-    expected = "`hg identify -R http://repo/project | cut -f1 -d\\ `"
+    # 0x0000_0000_0000 is the changeset ID for the root revision of all hg repos
+    cmd = @scm.revision('000000000000')
+    expected = "`hg identify -r 000000000000 | cut -f1 -d\\ `"
     assert_equal expected, cmd
   end
 end

data/test/test_vlad_mercurial_queue.rb

@@ -0,0 +1,77 @@
+require 'test/vlad_test_case'
+require 'vlad'
+require 'vlad/mercurial_queue'
+
+class TestVladMercurialQueue < MiniTest::Unit::TestCase
+
+  def setup
+    @scm = Vlad::MercurialQueue.new
+    set :repository,      "http://repo/project"
+    set :deploy_to,       "/path/to"
+    set(:queue_repo)    { "#{repository}/.hg/patches" }
+    set :queue_revision,  "tip"
+  end
+
+  def test_checkout
+    cmd = @scm.checkout 'head', '/path/to/scm'
+
+    expected = "if [ ! -d .hg ]; then hg init; fi " \
+               "&& if [ ! -d .hg/patches/.hg ]; then hg qinit -c; fi " \
+               "&& hg pull http://repo/project " \
+               "&& hg pull -R .hg/patches http://repo/project/.hg/patches " \
+               "&& hg qpop -a " \
+               "&& hg update tip " \
+               "&& hg update -R .hg/patches tip " \
+               "&& hg qpush -a"
+
+    assert_equal expected, cmd
+  end
+
+  def test_export
+    cmd = @scm.export 'head', '/path/to/release'
+    assert_equal 'hg archive -r qtip /path/to/release', cmd
+  end
+
+  def test_revision
+    cmd = @scm.revision('tip')
+    expected = "`hg identify -r tip | cut -f1 -d\\ `"
+    assert_equal expected, cmd
+  end
+
+  def test_alternate_patch_queue_path
+    set :queue_repo, 'http://repo/project-patched'
+
+    # only need to test #checkout
+    cmd = @scm.checkout 'head', '/path/to/scm'
+
+    expected = "if [ ! -d .hg ]; then hg init; fi " \
+               "&& if [ ! -d .hg/patches/.hg ]; then hg qinit -c; fi " \
+               "&& hg pull http://repo/project " \
+               "&& hg pull -R .hg/patches http://repo/project-patched " \
+               "&& hg qpop -a " \
+               "&& hg update tip " \
+               "&& hg update -R .hg/patches tip " \
+               "&& hg qpush -a"
+
+    assert_equal expected, cmd
+  end
+
+  def test_queue_revision
+    set :queue_revision, "deadbeefd00d"
+
+    # only need to test #checkout
+    cmd = @scm.checkout 'head', '/path/to/scm'
+
+    expected = "if [ ! -d .hg ]; then hg init; fi " \
+               "&& if [ ! -d .hg/patches/.hg ]; then hg qinit -c; fi " \
+               "&& hg pull http://repo/project " \
+               "&& hg pull -R .hg/patches http://repo/project/.hg/patches " \
+               "&& hg qpop -a " \
+               "&& hg update tip " \
+               "&& hg update -R .hg/patches deadbeefd00d " \
+               "&& hg qpush -a"
+
+    assert_equal expected, cmd
+  end
+
+end

metadata

@@ -1,51 +1,73 @@
 --- !ruby/object:Gem::Specification 
 name: vlad-hg
 version: !ruby/object:Gem::Version 
-  version: 2.0.2
+  hash: 11
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Kevin R. Bullock
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDOjCCAiKgAwIBAgIBADANBgkqhkiG9w0BAQUFADBDMREwDwYDVQQDDAhrYnVs
-  bG9jazEZMBcGCgmSJomT8ixkARkWCXJpbmd3b3JsZDETMBEGCgmSJomT8ixkARkW
-  A29yZzAeFw0wOTA4MjAwNDEwMjdaFw0xMDA4MjAwNDEwMjdaMEMxETAPBgNVBAMM
-  CGtidWxsb2NrMRkwFwYKCZImiZPyLGQBGRYJcmluZ3dvcmxkMRMwEQYKCZImiZPy
-  LGQBGRYDb3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvNCKfA7a
-  TB9FzMq44OB7OMyqMVQd5tidOup6qGnOugrsGxtnj5sb9hhVqgpd1AsplKePq6/4
-  mhTX/C8/CxCc1N7K+GLnxdW3nzz/wIluDp8mP1u7gJjrzLu149FGBW5s5crB79e6
-  lKk8cFaz/7ghSSlZpDgEGxdZQZeqBnbVX2+WyBrK6yYBv1pwlotkxLjg8zP1a02m
-  cJrTt0kj83CJ4cMwtkCEb0aBAbnvMGfjobdew3auWaTBRutVc4lY+2H7HOIIi/Vn
-  1xr6lDMzlf9RwRPO85W0Hq7K0yLfr1Uzafc1/jWPlSfvpG9zDnxsToEKpGDRYv5Y
-  T2Pdplh2Vaf3rwIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-  HQ4EFgQU0vF/SuWG8e+ZlAeaE16N+RhcQzYwDQYJKoZIhvcNAQEFBQADggEBAC2g
-  1R3O0O5H3z/JuY/tI3Og8vjheSfkAMZbof+7MHnz3Svx0zd0MxW1KQ734COeZh4+
-  OdRHsKhcduPQFfcCSbWrzMQ8vJ4b4Un96uInX/kyrpyF/Z4M/TrxIacMce8CqQxv
-  zCylQ9qzAd2b2/+kqy5LN4yMmCE/PuUY/5erRAlSBjEuStLXveW5v8iTW8Pv9ImM
-  G30TVf5a1GnF5TXqUhsJqZSzJoxcvAh7/xvD02AjkK7GtHf3cagv7Xc9aoWwhJFQ
-  Ra/Gve3n6G11qNpHFh/Ga4M1qkyetuRhdSXiYBM6sxwT6Hkm2scPjIzCHgUfI0rK
-  5V3Udl4ET3bsEOJ+8xs=
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2009-08-28 00:00:00 -05:00
+date: 2010-06-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: vlad
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id003
 description: |-
   Mercurial support for Vlad. Using it is as simple as passing
-  <tt>:scm => :mercurial</tt> to Vlad when loading it up (see Synopsis below).
+  <tt>:scm => :mercurial</tt> to Vlad when loading it up.
 email: 
 - kbullock@ringworld.org
 executables: []
@@ -62,7 +84,9 @@ files:
 - README.txt
 - Rakefile
 - lib/vlad/mercurial.rb
+- lib/vlad/mercurial_queue.rb
 - test/test_vlad_mercurial.rb
+- test/test_vlad_mercurial_queue.rb
 - test/vlad_test_case.rb
 has_rdoc: true
 homepage: http://hitsquad.rubyforge.org/vlad-hg/
@@ -75,23 +99,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: hitsquad
-rubygems_version: 1.3.5
+rubyforge_project: vlad-hg
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Mercurial support for Vlad
 test_files: 
 - test/test_vlad_mercurial.rb
+- test/test_vlad_mercurial_queue.rb

data.tar.gz.sig

@@ -1 +0,0 @@
-T�oux�\E�;��y�w��`�c������xa θ���/��O/)���$[elP�'m�5���>�;s��UO�<&#V~^�{|��;F�����XWh��%�������J��eew�/�Q��R�:a>�~~���w���&��S���ۇSU�0�V�DE�c҇N����ΤT�_������c�أ{w.��s��[צ�O�/���ɍ�ԥ���]�g���V^b)��D�� ?='N�/Zb�>�l�	�_߮(�z