piston 1.3.0 → 1.3.1

data/CHANGELOG

@@ -1,57 +1,67 @@
-*SVN*
-
-2007-01-22 1.3.0
-* Piston status shows the revision number of locked repositories.  Thanks to
-  Chris Wanstrath <http://errtheblog.com/>.
-* New piston switch subcommand to switch repository locations.  Thanks to
-  Greg Spurrier for the prompt which resulted in finally implementing this.
-
-2006-11-20 1.2.1
-* Import subcommand would fail with a "svn: Explicit target required
-  ('vendor/rails' interpreted as prop value)" error.  This was a minor
-  error in the import code.  Reported by Daniel N.
-* The import subcommand could import another revision than what was intended,
-  if HEAD was updated while the import is in progress.
-
-2006-11-17 1.2.0
-* New status subcommand.  Shows M if locally or remotely modified. Applies to
-  one, many, all folders.  This subcommand *requires* the use of a Subversion
-  1.2.0 client.  Thanks to Chris Wanstrath for the inspiration.  His Rake
-  tasks are available at http://errtheblog.com/post/38.
-* Minor patch by Miguel Ibero Carreras to make Subversion always use the
-  C locale, instead of the current one.  This allows Piston to be used
-  with internationalized versions of Subversion.  David Bittencourt later
-  reported the same problem.  Thanks!
-* Better handle how update finds it's latest local revision to prevent
-  conflicts.  If you had never locally changed your vendor repositories,
-  this fix will change nothing for you.  This helps prevent local conflicts
-  if you had ever applied a local patch.
-  *CAVEAT*: See the release announcement at
-            http://blog.teksol.info/articles/2006/11/17/piston-1-2-0-status-better-update
-            for a required local operation.
-
-2006-08-30 1.1.1
-* Add contrib/piston [Michael Schuerig]
-* Non-recursively add the root directory of the managed folder then set Piston
-  properties before adding the contents of the managed folder.  This is to
-  help ease work along if an inconsistent EOL is encountered during the
-  import.  The user can finish the import by svn add'ing the rest of the
-  folder until all files are added.  Piston properties will already have been
-  set.
-
-2006-08-26 1.1.0
-* New 'convert' subcommand converts existing svn:externals to Piston managed
-  folders.  Thanks to Dan Kubb for the idea.
-* update now recursively finds the folders to process.  It bases it's search
-  on the presence or absence of the piston:root property.
-* Changed lock and unlock messages to be more detailed.
-
-2006-08-24 1.0.1
-* Corrected minor bug where the core extensions were in core_ext/core_ext
-  instead of being in core_ext.
-* Require the parent working copy path be at HEAD before importing / updating.
-* Don't do unnecessary merges if the file had not changed prior to the update.
-* During the update, if adding a folder, do an svn mkdir instead of a cp_r.
-
-2006-08-24 1.0.0
-* Initial version
+*SVN*
+
+2007-03-09 1.3.1
+* piston switch would fail if the branch from which we are reading had been
+  deleted.
+* piston switch had a major bug.  It did not update the piston:root property
+  to remember the new repository root.  Reported and fixed by Graeme
+  Mathieson.
+* piston switch errors out early if not provided with the right arguments.
+  Thanks to Graeme Mathieson for the info and patch.
+* New internal command parser.  No visible external changes.
+
+2007-01-22 1.3.0
+* Piston status shows the revision number of locked repositories.  Thanks to
+  Chris Wanstrath <http://errtheblog.com/>.
+* New piston switch subcommand to switch repository locations.  Thanks to
+  Greg Spurrier for the prompt which resulted in finally implementing this.
+
+2006-11-20 1.2.1
+* Import subcommand would fail with a "svn: Explicit target required
+  ('vendor/rails' interpreted as prop value)" error.  This was a minor
+  error in the import code.  Reported by Daniel N.
+* The import subcommand could import another revision than what was intended,
+  if HEAD was updated while the import is in progress.
+
+2006-11-17 1.2.0
+* New status subcommand.  Shows M if locally or remotely modified. Applies to
+  one, many, all folders.  This subcommand *requires* the use of a Subversion
+  1.2.0 client.  Thanks to Chris Wanstrath for the inspiration.  His Rake
+  tasks are available at http://errtheblog.com/post/38.
+* Minor patch by Miguel Ibero Carreras to make Subversion always use the
+  C locale, instead of the current one.  This allows Piston to be used
+  with internationalized versions of Subversion.  David Bittencourt later
+  reported the same problem.  Thanks!
+* Better handle how update finds it's latest local revision to prevent
+  conflicts.  If you had never locally changed your vendor repositories,
+  this fix will change nothing for you.  This helps prevent local conflicts
+  if you had ever applied a local patch.
+  *CAVEAT*: See the release announcement at
+            http://blog.teksol.info/articles/2006/11/17/piston-1-2-0-status-better-update
+            for a required local operation.
+
+2006-08-30 1.1.1
+* Add contrib/piston [Michael Schuerig]
+* Non-recursively add the root directory of the managed folder then set Piston
+  properties before adding the contents of the managed folder.  This is to
+  help ease work along if an inconsistent EOL is encountered during the
+  import.  The user can finish the import by svn add'ing the rest of the
+  folder until all files are added.  Piston properties will already have been
+  set.
+
+2006-08-26 1.1.0
+* New 'convert' subcommand converts existing svn:externals to Piston managed
+  folders.  Thanks to Dan Kubb for the idea.
+* update now recursively finds the folders to process.  It bases it's search
+  on the presence or absence of the piston:root property.
+* Changed lock and unlock messages to be more detailed.
+
+2006-08-24 1.0.1
+* Corrected minor bug where the core extensions were in core_ext/core_ext
+  instead of being in core_ext.
+* Require the parent working copy path be at HEAD before importing / updating.
+* Don't do unnecessary merges if the file had not changed prior to the update.
+* During the update, if adding a folder, do an svn mkdir instead of a cp_r.
+
+2006-08-24 1.0.0
+* Initial version

data/README

@@ -1,128 +1,134 @@
-Piston is a utility that enables merge tracking of remote repositories.
-This is similar to <tt>svn:externals</tt>, except you have a local copy of
-the files, which you can modify at will.  As long as the changes are
-mergeable, you should have no problems.
-
-This tool has a similar purpose than svnmerge.py which you can find in the
-contrib/client-side folder of the main Subversion repository at
-http://svn.collab.net/repos/svn/trunk/contrib/client-side/svnmerge.py.
-The main difference is that Piston is designed to work with remote
-repositories.  Another tool you might want to look at, SVK, situated at
-http://svk.elixus.org.
-
-From Wikipedia's Piston page (http://en.wikipedia.org/wiki/Piston):
-  In general, a piston is a sliding plug that fits closely inside the bore
-  of a cylinder.
-
-  Its purpose is either to change the volume enclosed by the cylinder, or
-  to exert a force on a fluid inside the cylinder.
-
-For this utility, I retain the second meaning, "to exert a force on a fluid
-inside the cylinder."  Piston forces the content of a remote repository
-location back into our own.
-
-= Installation
-
-Nothing could be simpler:
-
- $ gem install --include-dependencies piston
-
-
-= Usage
-
-First, you need to import the remote repository location:
-
- $ piston import http://dev.rubyonrails.org/svn/rails/trunk vendor/rails
- Exported r4720 from 'http://dev.rubyonrails.org/svn/rails/trunk' to 'vendor/rails'
-
- $ svn commit -m "Importing local copy of Rails"
-
-When you want to get the latest changes from the remote repository location:
-
- $ piston update vendor/rails
- Updated 'vendor/rails' to r4720.
-
- $ svn commit -m "Updates vendor/rails to the latest revision"
-
-You can prevent a local Piston-managed folder from updating by using the
-+lock+ subcommand:
-
- $ piston lock vendor/rails
- 'vendor/rails' locked at r4720.
-
-When you want to update again, you unlock:
-
- $ piston unlock vendor/rails
- 'vendor/rails' unlocked.
-
-
-= Contributions
-
-== Bash Shell Completion Script
-
-Michael Schuerig contributed a Bash shell completion script.  You should copy
-+contrib/piston+ from your gem repository to the appropriate folder.  Michael
-said:
-
-  I've put together a bash completion function for piston. On Debian, I
-  just put it in /etc/bash_completion.d, alternatively, the contents can
-  be copied to ~/.bash_completion. I don't know how things are organized
-  on other Unix/Linux systems.
-
-
-= Caveats
-
-== Speed
-
-This tool is SLOW.  The update process particularly so.  I use a brute force
-approach.  Subversion cannot merge from remote repositories, so instead I
-checkout the folder at the initial revision, and then run svn update and
-parse the results of that to determine what changes have occured.
-
-If a local copy of a file was changed, it's changes will be merged back in.
-If that introduces a conflict, Piston will not detect it.  The commit will be
-rejected by Subversion anyway.
-
-== Copies / Renames
-
-Piston *does not* track copies.  Since Subversion does renames in two
-phases (copy + delete), that is what Piston does.
-
-== Local Operations Only
-
-Piston only works if you have a working copy.  It also never commits your
-working copy directly.  You are responsible for reviewing the changes and
-applying any pending fixes.
-
-== Remote Repository UUID
-
-Piston caches the remote repository UUID, allowing it to know if the remote
-repos is still the same.  Piston refuses to work against a different
-repository than the one we checked out from originally.
-
-
-= Subversion Properties Used
-
-* <tt>piston:uuid</tt>: The remote repository's UUID, which we always confirm
-  before doing any operations.
-* <tt>piston:root</tt>: The repository root URL from which this Piston folder
-  was exported from.
-* <tt>piston:remote-revision</tt>: The <tt>Last Changed Rev</tt> of the remote
-  repository.
-* <tt>piston:local-revision</tt>: The <tt>Last Changed Rev</tt> of the Piston
-  managed folder, to enable us to know if we need to do any merging.
-* <tt>piston:locked</tt>: The revision at which this folder is locked.  If
-  this property is set and non-blank, Piston will skip the folder with
-  an appropriate message.
-
-
-= Dependencies
-
-Piston depends on the following libraries:
-
-* yaml
-* getoptlong
-* uri
-* fileutils
-
-These dependencies are all included in a stock 1.8.4 Ruby distribution.
+Piston is a utility that eases vendor branch management.
+This is similar to <tt>svn:externals</tt>, except you have a local copy of
+the files, which you can modify at will.  As long as the changes are
+mergeable, you should have no problems.
+
+This tool has a similar purpose than svnmerge.py which you can find in the
+contrib/client-side folder of the main Subversion repository at
+http://svn.collab.net/repos/svn/trunk/contrib/client-side/svnmerge.py.
+The main difference is that Piston is designed to work with remote
+repositories.  Another tool you might want to look at, SVK, which you can find
+at http://svk.elixus.org/.
+
+From Wikipedia's Piston page (http://en.wikipedia.org/wiki/Piston):
+  In general, a piston is a sliding plug that fits closely inside the bore
+  of a cylinder.
+
+  Its purpose is either to change the volume enclosed by the cylinder, or
+  to exert a force on a fluid inside the cylinder.
+
+For this utility, I retain the second meaning, "to exert a force on a fluid
+inside the cylinder."  Piston forces the content of a remote repository
+location back into our own.
+
+
+= Installation
+
+Nothing could be simpler:
+
+ $ gem install --include-dependencies piston
+
+
+= Usage
+
+First, you need to import the remote repository location:
+
+ $ piston import http://dev.rubyonrails.org/svn/rails/trunk vendor/rails
+ Exported r4720 from 'http://dev.rubyonrails.org/svn/rails/trunk' to 'vendor/rails'
+
+ $ svn commit -m "Importing local copy of Rails"
+
+When you want to get the latest changes from the remote repository location:
+
+ $ piston update vendor/rails
+ Updated 'vendor/rails' to r4720.
+
+ $ svn commit -m "Updates vendor/rails to the latest revision"
+
+You can prevent a local Piston-managed folder from updating by using the
++lock+ subcommand:
+
+ $ piston lock vendor/rails
+ 'vendor/rails' locked at r4720.
+
+When you want to update again, you unlock:
+
+ $ piston unlock vendor/rails
+ 'vendor/rails' unlocked.
+
+If the branch you are following moves, you should use the switch subcommand:
+
+ $ piston import http://dev.rubyonrails.org/svn/rails/branches/1-2-pre-release vendor/rails
+ $ svn commit vendor/rails
+
+ # Vendor branch is renamed, let's follow it
+ $ piston switch http://dev.rubyonrails.org/svn/rails/branches/1-2-stable vendor/rails
+
+
+= Contributions
+
+== Bash Shell Completion Script
+
+Michael Schuerig contributed a Bash shell completion script.  You should copy
++contrib/piston+ from your gem repository to the appropriate folder.  Michael
+said:
+
+  I've put together a bash completion function for piston. On Debian, I
+  just put it in /etc/bash_completion.d, alternatively, the contents can
+  be copied to ~/.bash_completion. I don't know how things are organized
+  on other Unix/Linux systems.
+
+
+= Caveats
+
+== Speed
+
+This tool is SLOW.  The update process particularly so.  I use a brute force
+approach.  Subversion cannot merge from remote repositories, so instead I
+checkout the folder at the initial revision, and then run svn update and
+parse the results of that to determine what changes have occured.
+
+If a local copy of a file was changed, it's changes will be merged back in.
+If that introduces a conflict, Piston will not detect it.  The commit will be
+rejected by Subversion anyway.
+
+== Copies / Renames
+
+Piston *does not* track copies.  Since Subversion does renames in two
+phases (copy + delete), that is what Piston does.
+
+== Local Operations Only
+
+Piston only works if you have a working copy.  It also never commits your
+working copy directly.  You are responsible for reviewing the changes and
+applying any pending fixes.
+
+== Remote Repository UUID
+
+Piston caches the remote repository UUID, allowing it to know if the remote
+repos is still the same.  Piston refuses to work against a different
+repository than the one we checked out from originally.
+
+
+= Subversion Properties Used
+
+* <tt>piston:uuid</tt>: The remote repository's UUID, which we always confirm
+  before doing any operations.
+* <tt>piston:root</tt>: The repository root URL from which this Piston folder
+  was exported from.
+* <tt>piston:remote-revision</tt>: The <tt>Last Changed Rev</tt> of the remote
+  repository.
+* <tt>piston:local-revision</tt>: The <tt>Last Changed Rev</tt> of the Piston
+  managed folder, to enable us to know if we need to do any merging.
+* <tt>piston:locked</tt>: The revision at which this folder is locked.  If
+  this property is set and non-blank, Piston will skip the folder with
+  an appropriate message.
+
+
+= Dependencies
+
+Piston depends on the following libraries:
+
+* yaml
+* uri
+* fileutils

data/bin/piston

@@ -7,6 +7,4 @@ rescue LoadError
 end
 
 require 'piston'
-require 'piston/ui/command_line'
-
-Piston::Ui::CommandLine.start
+PistonCommandLineProcessor.parse_and_execute

data/contrib/piston

@@ -6,7 +6,7 @@ _piston()
   COMPREPLY=()
   cur=${COMP_WORDS[COMP_CWORD]}
 
-  commands='update convert help unlock lock import'
+  commands='update convert help unlock lock import switch'
 
   if [[ $COMP_CWORD -eq 1 ]] ; then
     if [[ "$cur" == -* ]]; then

data/lib/piston/command.rb

@@ -2,7 +2,16 @@ module Piston
   # The base class which all commands subclass to obtain services from.
   class Command
     attr_accessor :revision, :dry_run, :quiet, :verbose, :force, :lock,
-                  :recursive, :logging_stream, :show_updates
+                  :recursive, :show_updates
+    attr_reader :args
+    attr_writer :logging_stream
+
+    def initialize(non_options, options)
+      @args = non_options
+      options.each do |option, value|
+        self.send("#{option}=", value)
+      end
+    end
 
     # Execute this command.  The arguments are pre-processed to expand any
     # wildcards using Dir#[].  This is because the Windows shell does not

data/lib/piston/commands/convert.rb

@@ -3,7 +3,7 @@ require 'piston/commands/import'
 module Piston
   module Commands
     class Convert < Piston::Command
-      def run(args)
+      def run
         if args.empty? then
           svn(:propget, '--recursive', 'svn:externals').each_line do |line|
             next unless line =~ /^([^ ]+)\s-\s/
@@ -65,24 +65,14 @@ module Piston
         "Converts existing svn:externals into Piston managed folders"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-convert: #{help}
+      def self.detailed_help
+        <<EOF
 usage: convert [DIR [...]]
 
   Converts folders which have the svn:externals property set to Piston managed 
   folders.
-
-  Valid options:
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
-
-      def self.aliases
-        %w(convert)
-      end
     end
   end
 end

data/lib/piston/commands/import.rb

@@ -1,7 +1,7 @@
 module Piston
   module Commands
     class Import < Piston::Command
-      def run(args)
+      def run
         raise Piston::CommandError, "Missing REPOS_URL argument" if args.empty?
 
         repos, dir = args.shift, args.shift
@@ -53,28 +53,19 @@ module Piston
         "Prepares a folder for merge tracking"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-import (init): #{help}
+      def self.detailed_help
+        <<EOF
 usage: import REPOS_URL [DIR]
 
   Exports the specified REPOS_URL (which must be a Subversion repository) to
   DIR, defaulting to the last component of REPOS_URL if DIR is not present.
 
   If the local folder already exists, this command will abort with an error.
-
-  Valid options:
-      -r [--revision] arg   : Start merge tracking at ARG instead of HEAD
-      --lock                : Close down and lock the folder from future
-                              updates immediately
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
 
       def self.aliases
-        %w(import init)
+        %w(init)
       end
     end
   end

data/lib/piston/commands/lock.rb

@@ -1,7 +1,7 @@
 module Piston
   module Commands
     class Lock < Piston::Command
-      def run(args)
+      def run
         raise Piston::CommandError, "No targets to run against" if args.empty?
 
         args.each do |dir|
@@ -15,23 +15,13 @@ module Piston
         "Lock one or more folders to their current revision"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-lock: #{help}
+      def self.detailed_help
+        <<EOF
 usage: lock DIR [DIR [...]]
 
   Locked folders will not be updated to the latest revision when updating.
-
-  Valid options:
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
-
-      def self.aliases
-        %w(lock)
-      end
     end
   end
 end

data/lib/piston/commands/status.rb

@@ -3,7 +3,7 @@ require 'pp'
 module Piston
   module Commands
     class Status < Piston::Command
-      def run(args)
+      def run
         # First, find the list of pistoned folders
         folders = svn(:propget, '--recursive', Piston::ROOT, *args)
         repos = Hash.new
@@ -49,9 +49,8 @@ module Piston
         "Determines the current status of each pistoned directory"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-status: #{help}
+      def self.detailed_help
+        <<EOF
 usage: status [DIR [DIR...]]
 
   Shows the status of one, many or all pistoned folders.  The status is
@@ -63,16 +62,11 @@ usage: status [DIR [DIR...]]
 
   The second column's values are blanks, unless the --show-updates is passed.
     M:  Remotely modified since importing
-
-  Valid options:
-      --show-updates        : Queries the remote repositories to determine
-                              if they have been updated from our revision.
-
 EOF
       end
 
       def self.aliases
-        %w(status st)
+        %w(st)
       end
     end
   end

data/lib/piston/commands/switch.rb

@@ -1,9 +1,11 @@
 module Piston
   module Commands
     class Switch < Piston::Command
-      def run(args)
+      def run
         new_root, dir = args.shift, args.shift
         raise Piston::CommandError, "Expected two arguments only to switch.  Unrecognized arguments: #{args.inspect}" unless args.empty?
+        raise Piston::CommandError, "Expected a new vendor repository URL." if new_root.nil?
+        raise Piston::CommandError, "Expected a directory to update." if dir.nil?
         switch(dir, new_root)
       end
 
@@ -34,7 +36,7 @@ module Piston
         raise Piston::CommandError unless uuid == new_info['Repository UUID']
 
         logging_stream.puts "  Fetching remote repository's latest revision and UUID"
-        info = YAML::load(svn(:info, repos))
+        info = YAML::load(svn(:info, "#{repos}@#{remote_revision}"))
         return skip(dir, "Repository UUID changed\n  Expected #{uuid}\n  Found    #{info['Repository UUID']}\n  Repository: #{repos}") unless uuid == info['Repository UUID']
 
         new_remote_rev = new_info['Last Changed Rev'].to_i
@@ -43,7 +45,7 @@ module Piston
         revisions = (remote_revision .. (revision || new_remote_rev))
 
         logging_stream.puts "  Restoring remote repository to known state at r#{revisions.first}"
-        svn :checkout, '--ignore-externals', '--quiet', '--revision', revisions.first, repos, dir.tmp
+        svn :checkout, '--ignore-externals', '--quiet', '--revision', revisions.first, "#{repos}@#{remote_revision}", dir.tmp
 
         logging_stream.puts "  Updating remote repository to #{new_repos}@#{revisions.last}"
         updates = svn :switch, '--revision', revisions.last, new_repos, dir.tmp
@@ -92,6 +94,7 @@ module Piston
         FileUtils.rm_rf dir.tmp
 
         logging_stream.puts "  Updating Piston properties"
+        svn :propset, Piston::REPOS, new_repos, dir
         svn :propset, Piston::REMOTE_REV, revisions.last, dir
         svn :propset, Piston::LOCAL_REV, new_local_rev, dir
         svn :propset, Piston::LOCKED, revisions.last, dir if lock
@@ -112,9 +115,8 @@ module Piston
         "Switches a single directory to a new repository root"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-switch: #{help}
+      def self.detailed_help
+        <<EOF
 usage: switch NEW_REPOSITORY_ROOT DIR
 
   This operation changes the remote location from A to B, keeping local
@@ -125,19 +127,11 @@ usage: switch NEW_REPOSITORY_ROOT DIR
   Piston will refuse to update a folder if it has pending updates.  Run
   'svn update' on the target folder to update it before running Piston
   again.
-
-    Valid options:
-      -r [--revision] arg   : Update to ARG instead of HEAD
-      --lock                : Close down and lock the folder from future
-                              updates immediately
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
 
       def self.aliases
-        %w(switch sw)
+        %w(sw)
       end
     end
   end

data/lib/piston/commands/unlock.rb

@@ -1,7 +1,7 @@
 module Piston
   module Commands
     class Unlock < Piston::Command
-      def run(args)
+      def run
         raise Piston::CommandError, "No targets to run against" if args.empty?
         svn :propdel, Piston::LOCKED, *args
         args.each do |dir|
@@ -13,24 +13,14 @@ module Piston
         "Undoes the changes enabled by lock"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-unlock: #{help}
+      def self.detailed_help
+        <<EOF
 usage: unlock DIR [DIR [...]]
 
   Unlocked folders are free to be updated to the latest revision when
   updating.
-
-  Valid options:
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
-
-      def self.aliases
-        %w(unlock)
-      end
     end
   end
 end

data/lib/piston/commands/update.rb

@@ -3,7 +3,7 @@ require 'find'
 module Piston
   module Commands
     class Update < Piston::Command
-      def run(args)
+      def run
         (args.empty? ? find_targets : args).each do |dir|
           update dir
         end
@@ -121,9 +121,8 @@ module Piston
         "Updates all or specified folders to the latest revision"
       end
 
-      def self.detailed_help(stream)
-        stream.puts <<EOF
-update: #{help}
+      def self.detailed_help
+        <<EOF
 usage: update [DIR [...]]
 
   This operation has the effect of downloading all remote changes back to our
@@ -134,19 +133,11 @@ usage: update [DIR [...]]
   Piston will refuse to update a folder if it has pending updates.  Run
   'svn update' on the target folder to update it before running Piston
   again.
-
-    Valid options:
-      -r [--revision] arg   : Update to ARG instead of HEAD
-      --lock                : Close down and lock the folder from future
-                              updates immediately
-      --verbose             : Show Subversion commands and results as they
-                              are executed
-
 EOF
       end
 
       def self.aliases
-        %w(update up)
+        %w(up)
       end
     end
   end

data/lib/piston/version.rb

@@ -2,7 +2,7 @@ module Piston
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 3
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/piston.rb

@@ -18,8 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-# $HeadURL: svn+ssh://fbos@rubyforge.org/var/svn/piston/tags/1.3.0/lib/piston.rb $
-# $Id: piston.rb 70 2007-01-22 20:33:35Z fbos $
+# $HeadURL: svn+ssh://fbos@rubyforge.org/var/svn/piston/branches/1.3.1/lib/piston.rb $
+# $Id: piston.rb 86 2007-03-01 16:33:06Z fbos $
 
 require 'yaml'
 require 'uri'
@@ -30,6 +30,13 @@ Dir[File.join(PISTON_ROOT, 'core_ext', '*.rb')].each do |file|
   require file
 end
 
+require "piston/version"
+require File.join(PISTON_ROOT, "transat", "parser")
+require File.join(PISTON_ROOT, 'piston', 'command')
+Dir[File.join(PISTON_ROOT, "piston", "commands", "*.rb")].each do |file|
+  require file.gsub(PISTON_ROOT, "")[1..-4]
+end
+
 module Piston
   ROOT        = "piston:root"
   UUID        = "piston:uuid"
@@ -38,6 +45,23 @@ module Piston
   LOCKED      = "piston:locked"
 end
 
-require File.join(PISTON_ROOT, 'piston', 'command')
-require File.join(PISTON_ROOT, 'piston', 'command_error')
-require File.join(PISTON_ROOT, 'piston', 'ui', 'command_line')
+PistonCommandLineProcessor = Transat::Parser.new do
+  program_name "Piston"
+  version [Piston::VERSION::STRING]
+
+  option :verbose, :short => :v, :default => true, :message => "Show subversion commands and results as they are executed"
+  option :quiet, :short => :q, :default => false, :message => "Do not output any messages except errors"
+  option :revision, :short => :r, :param_name => "REVISION", :type => :int
+  option :show_updates, :short => :u, :message => "Query the remote repository for out of dateness information"
+  option :lock, :short => :l, :message => "Close down and lock the imported directory from further changes"
+  option :dry_run, :message => "Does not actually execute any commands"
+  option :force, :message => "Force the command to run, even if Piston thinks it would cause a problem"
+
+  command :switch, Piston::Commands::Switch, :valid_options => %w(lock dry_run force revision quiet verbose)
+  command :update, Piston::Commands::Update, :valid_options => %w(lock dry_run force revision quiet verbose)
+  command :import, Piston::Commands::Import, :valid_options => %w(lock dry_run force revision quiet verbose)
+  command :convert, Piston::Commands::Convert, :valid_options => %w(lock verbose dry_run)
+  command :unlock, Piston::Commands::Unlock, :valid_options => %w(force dry_run verbose)
+  command :lock, Piston::Commands::Lock, :valid_options => %w(force dry_run revision verbose)
+  command :status, Piston::Commands::Status, :valid_options => %w(show_updates verbose)
+end

data/lib/transat/parser.rb

@@ -0,0 +1,189 @@
+require "optparse"
+
+module Transat
+  class VersionNeeded < StandardError; end
+
+  class HelpNeeded < StandardError
+    attr_reader :command
+
+    def initialize(command)
+      @command = command
+    end
+  end
+
+  class NoCommandGiven < StandardError
+    def message
+      "No command given"
+    end
+  end
+
+  class UnknownOptions < StandardError
+    attr_reader :command
+
+    def initialize(command, unrecognized_options)
+      @command, @unrecognized_options = command, unrecognized_options
+    end
+
+    def message
+      "Command #{@command} does not accept options #{@unrecognized_options.join(", ")}"
+    end
+  end
+
+  class UnknownCommand < StandardError
+    def initialize(command, parser)
+      @command, @parser = command, parser
+    end
+
+    def message
+      "Unknown command: #{@command.inspect}"
+    end
+  end
+
+  class BaseCommand
+    attr_reader :non_options, :options
+    def initialize(non_options, options)
+      @non_options, @options = non_options, options
+    end
+  end
+
+  class VersionCommand < BaseCommand
+    def run
+      raise VersionNeeded
+    end
+  end
+
+  class HelpCommand < BaseCommand
+    def run
+      raise HelpNeeded.new(non_options.first)
+    end
+  end
+
+  class Parser
+    def initialize(&block)
+      @valid_options, @received_options, @commands = [], {}, {}
+      @option_parser = OptionParser.new
+
+      command(:help, Transat::HelpCommand)
+      command(:version, Transat::VersionCommand)
+      instance_eval(&block) if block_given?
+    end
+
+    def option(name, options={})
+      options[:long] = name.to_s.gsub("_", "-") unless options[:long]
+      @valid_options << name
+      @received_options[name] = nil
+
+      opt_args = []
+      opt_args << "-#{options[:short]}" if options.has_key?(:short)
+      opt_args << "--#{options[:long] || name}"
+      opt_args << "=#{options[:param_name]}" if options.has_key?(:param_name)
+      opt_args << options[:message]
+      case options[:type]
+      when :int, :integer
+        opt_args << Integer
+      when :float
+        opt_args << Float
+      when nil
+        # NOP
+      else
+        raise ArgumentError, "Option #{name} has a bad :type parameter: #{options[:type].inspect}"
+      end
+
+      @option_parser.on(*opt_args.compact) do |value|
+        @received_options[name] = value
+      end
+    end
+
+    def command(name, klass, options={})
+      @commands[name.to_s] = options.merge(:class => klass)
+    end
+
+    def parse_and_execute(args=ARGV)
+      begin
+        command, non_options = parse(args)
+        execute(command, non_options)
+      rescue HelpNeeded
+        $stderr.puts usage($!.command)
+        exit 1
+      rescue VersionNeeded
+        puts "#{program_name} #{version}"
+        exit 0
+      rescue NoCommandGiven, UnknownOptions, UnknownCommand
+        $stderr.puts "ERROR: #{$!.message}"
+        $stderr.puts usage($!.respond_to?(:command) ? $!.command : nil)
+        exit 1
+      end
+    end
+
+    def parse(args)
+      non_options = @option_parser.parse(args)
+      command = non_options.shift
+      raise NoCommandGiven unless command
+      return command, non_options
+    end
+
+    def execute(command, non_options)
+      found = false
+      @commands.each do |command_name, options|
+        command_klass = options[:class]
+        aliases = [command_name]
+        aliases += command_klass.aliases if command_klass.respond_to?(:aliases)
+        return command_klass.new(non_options, @received_options).run if aliases.include?(command)
+      end
+
+      raise UnknownCommand.new(command, self)
+    end
+
+    def usage(command=nil)
+      message = []
+
+      if command then
+        command_klass = @commands[command][:class]
+        help =
+          if command_klass.respond_to?(:aliases) then
+            "#{command} (#{command_klass.aliases.join(", ")})"
+          else
+            "#{command}"
+          end
+        help = "#{help}: #{command_klass.help}" if command_klass.respond_to?(:help)
+        message << help
+        message << command_klass.detailed_help if command_klass.respond_to?(:detailed_help)
+        message << ""
+        message << "Valid options:"
+        @option_parser.summarize(message)
+      else
+        message << "usage: #{program_name.downcase} <SUBCOMMAND> [OPTIONS] [ARGS...]"
+        message << "Type '#{program_name.downcase} help <SUBCOMMAND>' for help on a specific subcommand."
+        message << "Type '#{program_name.downcase} version' to get this program's version."
+        message << ""
+        message << "Available subcommands are:"
+        @commands.sort.each do |command, options|
+          command_klass = options[:class]
+          if command_klass.respond_to?(:aliases) then
+            message << "  #{command} (#{command_klass.aliases.join(", ")})"
+          else
+            message << "  #{command}"
+          end
+        end
+      end
+
+      message.map {|line| line.chomp}.join("\n")
+    end
+
+    def program_name(value=nil)
+      value ? @program_name = value : @program_name
+    end
+
+    def version(value=nil)
+      if value then
+        @version = value.respond_to?(:join) ? value.join(".") : value
+      else
+        @version
+      end
+    end
+
+    def self.parse_and_execute(args=ARGV, &block)
+      self.new(&block).parse_and_execute(args)
+    end
+  end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0.8
+rubygems_version: 0.9.2
 specification_version: 1
 name: piston
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
-date: 2007-01-22 00:00:00 +00:00
+  version: 1.3.1
+date: 2007-03-09 00:00:00 -05:00
 summary: Piston is a utility that enables merge tracking of remote repositories.
 require_paths: 
 - lib
@@ -37,23 +37,22 @@ files:
 - bin/piston
 - lib/core_ext
 - lib/piston
+- lib/transat
 - lib/piston.rb
 - lib/core_ext/string.rb
 - lib/core_ext/range.rb
 - lib/piston/commands
-- lib/piston/ui
-- lib/piston/command_error.rb
 - lib/piston/command.rb
+- lib/piston/command_error.rb
 - lib/piston/version.rb
+- lib/piston/commands/convert.rb
 - lib/piston/commands/switch.rb
 - lib/piston/commands/update.rb
-- lib/piston/commands/help.rb
+- lib/piston/commands/status.rb
 - lib/piston/commands/lock.rb
 - lib/piston/commands/import.rb
 - lib/piston/commands/unlock.rb
-- lib/piston/commands/convert.rb
-- lib/piston/commands/status.rb
-- lib/piston/ui/command_line.rb
+- lib/transat/parser.rb
 test_files: []
 
 rdoc_options: []

data/lib/piston/commands/help.rb

@@ -1,44 +0,0 @@
-module Piston
-  module Commands
-    class Help < Piston::Command
-      def run(targets=nil)
-        command = targets.shift
-
-        return help_on_command(command) if command
-        general_help
-      end
-
-      def help_on_command(command_name)
-        begin
-          require File.join(PISTON_ROOT, 'piston', 'commands', command_name)
-          command = Piston::Commands.const_get(command_name.capitalize)
-          command.detailed_help(logging_stream)
-        rescue LoadError
-          logging_stream.puts "No help available for '#{command_name}'"
-          general_help
-        end
-      end
-
-      def general_help
-        logging_stream.puts "Available commands are:"
-        commands = Array.new
-        Dir[File.join(PISTON_ROOT, 'piston', 'commands', '*.rb')].each do |file|
-          require file
-          commands << Piston::Commands.const_get(File.basename(file).gsub(/\.rb$/, '').capitalize)
-        end
-
-        commands.each do |command|
-          logging_stream.printf "  %-12s %s\n", command.aliases.first, command.help
-        end
-      end
-
-      def self.help
-        "Returns detailed help on a specific command"
-      end
-
-      def self.aliases
-        %w(help)
-      end
-    end
-  end
-end

data/lib/piston/ui/command_line.rb

@@ -1,72 +0,0 @@
-require 'getoptlong'
-
-module Piston
-  module Ui
-    module CommandLine
-      def self.start
-        opts = ::GetoptLong.new(
-          [ '--revision', '-r', GetoptLong::REQUIRED_ARGUMENT ],
-          [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
-          [ '--dry-run', GetoptLong::NO_ARGUMENT ],
-          [ '--quiet', '-q', GetoptLong::NO_ARGUMENT ],
-          [ '--verbose', '-v', GetoptLong::NO_ARGUMENT ],
-          [ '--show-updates', '-u', GetoptLong::NO_ARGUMENT ],
-          [ '--lock', GetoptLong::NO_ARGUMENT ],
-          [ '--force', '-f', GetoptLong::NO_ARGUMENT ],
-          [ '--version', GetoptLong::NO_ARGUMENT ]
-        )
-
-        options = Hash.new
-
-        opts.each do |opt, arg|
-          case opt
-          when '--revision'
-            options[:revision] = arg.to_i
-
-          when '--help'
-            return help
-
-          when '--version'
-            require 'piston/version'
-            puts "Piston #{Piston::VERSION::STRING}"
-            puts "Copyright 2006, Francois Beausoleil"
-            puts "\nSee the LICENSE file for details"
-            exit
-
-          when /--([-\w]+)$/
-            options[$1.gsub('-', '_').to_sym] = true
-          end
-        end
-
-        return help if ARGV.empty?
-
-        command_name = ARGV.shift.downcase
-        begin
-          require File.join(PISTON_ROOT, 'piston', 'commands', command_name)
-        rescue LoadError
-          return help
-        end
-
-        command_class = Piston::Commands.const_get("#{command_name.capitalize}")
-        command = command_class.new
-        options.each do |key, value|
-          command.send "#{key}=", value
-        end
-
-        begin
-          command.execute(ARGV)
-        rescue Piston::CommandError
-          $stderr.puts "ERROR: #{$!.message}"
-          exit 1
-        end
-      end
-
-      def self.help
-        require File.join(PISTON_ROOT, 'piston', 'commands', 'help')
-        Piston::Commands::Help.new.run(ARGV)
-      end
-    end
-  end
-end
-
-Piston::Ui::CommandLine.start if $0 == __FILE__