repertoire 0.1.2 → 0.2.0

data/History.txt

@@ -1,3 +1,18 @@
+== 0.2.0 / 2009-03-26
+
+* Refactored Repertoire::Media::Type.
+  * Added the cd method.
+  * Added the switch_dir method.
+* Refactored Repertoire::Repository.
+  * Added Repository#update.
+  * Added Repository#delete.
+* Removed support for CVS.
+* Removed support for Darcs.
+* Fixed a bug in Git.update.
+* Fixed various typos.
+* Added support for Mercurial (Hg).
+* Added specs.
+
 == 0.1.2 / 2008-05-01
 
 * Added Media support for Git.

data/Manifest.txt

@@ -4,28 +4,41 @@ README.txt
 Rakefile
 lib/repertoire.rb
 lib/repertoire/compat.rb
-lib/repertoire/extensions.rb
-lib/repertoire/extensions/meta.rb
-lib/repertoire/extensions/meta/object.rb
-lib/repertoire/extensions/uri.rb
 lib/repertoire/exceptions.rb
 lib/repertoire/exceptions/program_not_found.rb
 lib/repertoire/exceptions/command_failed.rb
+lib/repertoire/exceptions/repository_exists.rb
+lib/repertoire/exceptions/checkout_failed.rb
+lib/repertoire/exceptions/update_failed.rb
 lib/repertoire/media.rb
 lib/repertoire/media/exceptions.rb
 lib/repertoire/media/exceptions/unknown_media.rb
-lib/repertoire/media/exceptions/repository_exists.rb
-lib/repertoire/media/exceptions/checkout_failed.rb
-lib/repertoire/media/exceptions/update_failed.rb
+lib/repertoire/media/extensions.rb
+lib/repertoire/media/extensions/meta.rb
+lib/repertoire/media/extensions/meta/object.rb
 lib/repertoire/media/media.rb
 lib/repertoire/media/type.rb
 lib/repertoire/media/types.rb
-lib/repertoire/media/types/cvs.rb
-lib/repertoire/media/types/darcs.rb
+lib/repertoire/media/types/hg.rb
 lib/repertoire/media/types/git.rb
 lib/repertoire/media/types/rsync.rb
 lib/repertoire/media/types/svn.rb
 lib/repertoire/repository.rb
 lib/repertoire/repertoire.rb
 lib/repertoire/version.rb
-test/test_repertoire.rb
+tasks/spec.rb
+spec/helpers/repository.rb
+spec/helpers/repository/.hg/.keep
+spec/helpers/repository/file.txt
+spec/helpers/repository/dir/file.txt
+spec/helpers/repository/dir/file2.txt
+spec/spec_helper.rb
+spec/compat_spec.rb
+spec/repository_spec.rb
+spec/media/type_spec.rb
+spec/media/media_spec.rb
+spec/media/types/hg_spec.rb
+spec/media/types/git_spec.rb
+spec/media/types/rsync_spec.rb
+spec/media/types/svn_spec.rb
+spec/repertoire_spec.rb

data/README.txt

@@ -1,32 +1,57 @@
 = R'epertoire
 
 * http://repertoire.rubyforge.org/
-* Postmodern Modulus III (postmodern.mod3@gmail.com)
+* http://github.com/postmodern/repertoire/
+* Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:
   
 R'epertoire is a Ruby library for quickly checking-out and updating
 code-bases from various SCMs. R'epertoire currently supports Subversion,
-CVS, Git and even RSync.
+Git, Mercurial and even RSync.
 
 == FEATURES/PROBLEMS:
   
 * Currently supports checking-out and updating from:
-  * Subversion (SVN)
+  * Mercurial (Hg)
   * Git
-  * Darcs
-  * CVS
   * RSync
+  * Subversion (SVN)
 
 == INSTALL:
 
   $ sudo gem install repertoire
 
+== EXAMPLES:
+
+* Checkout a repository using a URI:
+
+  Repertoire.checkout(
+    :uri => 'svn://rubyforge.org/var/svn/repertoire/trunk',
+    :path => 'repertoire'
+  )
+
+* Checkout a repository of a specific media type:
+
+  Repertoire.checkout(
+    :uri => 'http://repertoire.rubyforge.org/svn/trunk',
+    :media => :svn,
+    :path => 'repertoire'
+  )
+
+* Update a previously checked-out repository:
+
+  Repertoire.update(:path => 'repertoire')
+
+* Update a previously checked-out repository of a specific media type:
+
+  Repertoire.update(:path => 'path/to/rsynced_data', :media => :rsync)
+
 == LICENSE:
 
 The MIT License
 
-Copyright (c) 2008 Hal Brodigan
+Copyright (c) 2008-2009 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,11 +2,12 @@
 
 require 'rubygems'
 require 'hoe'
+require './tasks/spec.rb'
 require './lib/repertoire/version.rb'
 
 Hoe.new('repertoire', Repertoire::VERSION) do |p|
   p.rubyforge_name = 'repertoire'
-  p.developer('Postmodern Modulus III','postmodern.mod3@gmail.com')
+  p.developer('Postmodern','postmodern.mod3@gmail.com')
   p.remote_rdoc_dir = ''
 end
 

data/lib/repertoire/compat.rb

@@ -17,9 +17,10 @@ module Repertoire
     # If the +PATH+ environment variable is not setup, an empty array will
     # be returned.
     #
-    #   Compat.PATH  #=> ["/bin", "/usr/bin"]
+    #   Compat.paths
+    #   #=> ["/bin", "/usr/bin"]
     #
-    def self.PATH
+    def self.paths
       # return an empty array in case
       # the PATH variable does not exist
       return [] unless ENV['PATH']
@@ -38,7 +39,7 @@ module Repertoire
     #   Compat.find_program('as')  #=> "/usr/bin/as"
     #
     def self.find_program(name)
-      self.PATH.each do |dir|
+      self.paths.each do |dir|
         full_path = File.expand_path(File.join(dir,name))
 
         return full_path if File.file?(full_path)

data/lib/repertoire/exceptions/program_not_found.rb

@@ -1,4 +1,4 @@
 module Repertoire
-  class CommandNotFound < RuntimeError
+  class ProgramNotFound < RuntimeError
   end
 end

data/lib/repertoire/exceptions.rb

@@ -1,2 +1,5 @@
 require 'repertoire/exceptions/program_not_found'
 require 'repertoire/exceptions/command_failed'
+require 'repertoire/exceptions/repository_exists'
+require 'repertoire/exceptions/checkout_failed'
+require 'repertoire/exceptions/update_failed'

data/lib/repertoire/media/exceptions/unknown_media.rb

@@ -1,4 +1,6 @@
 module Repertoire
-  class UnknownMedia < RuntimeError
+  module Media
+    class UnknownMedia < RuntimeError
+    end
   end
 end

data/lib/repertoire/media/exceptions.rb

@@ -1,4 +1 @@
 require 'repertoire/exceptions/unknown_media'
-require 'repertoire/exceptions/repository_exists'
-require 'repertoire/exceptions/checkout_failed'
-require 'repertoire/exceptions/update_failed'

data/lib/repertoire/{extensions → media/extensions}/meta/object.rb

@@ -6,16 +6,16 @@ class Object # :nodoc:
 
   # A class_eval version of meta_eval
   def metaclass_eval(&blk); metaclass.class_eval(&blk); end
+
+  # A class_def version of meta_def
+  def metaclass_def(name, &blk)
+    metaclass_eval { define_method(name, &blk) }
+  end
   
   # Adds methods to a metaclass
   def meta_def(name, &blk)
     meta_eval { define_method(name, &blk) }
   end
-
-  # Adds class methods to a metaclass
-  def metaclass_def(name, &blk)
-    metaclass_eval { define_method(name, &blk) }
-  end
   
   # Defines an instance method within a class
   def class_def(name, &blk)

data/lib/repertoire/media/extensions/meta.rb

@@ -0,0 +1 @@
+require 'repertoire/media/extensions/meta/object'

data/lib/repertoire/media/extensions.rb

@@ -0,0 +1 @@
+require 'repertoire/extensions/meta'

data/lib/repertoire/media/media.rb

@@ -1,10 +1,4 @@
 require 'repertoire/media/exceptions/unknown_media'
-require 'repertoire/media/exceptions/repository_exists'
-require 'repertoire/media/exceptions/checkout_failed'
-require 'repertoire/media/exceptions/update_failed'
-require 'repertoire/extensions/uri'
-
-require 'fileutils'
 
 module Repertoire
   module Media
@@ -30,7 +24,7 @@ module Repertoire
       name = name.to_sym
 
       unless Media.supports?(name)
-        raise(UnknownMedia,"media type #{name.dump} is not registered",caller)
+        raise(UnknownMedia,"media type #{name} is not registered",caller)
       end
 
       return Media.types[name]
@@ -114,9 +108,7 @@ module Repertoire
     # specified _uri_.
     #
     def Media.guess_from_uri(uri)
-      scheme = URI(uri).scheme
-
-      return [scheme, Media.supports_scheme(scheme)]
+      Media.supports_scheme(URI(uri).scheme)
     end
 
     #
@@ -133,110 +125,5 @@ module Repertoire
 
       raise(UnknownMedia,"the media type for #{path.dump} is unknown",caller)
     end
-
-    #
-    # Checkout the repository at the specified _options_. If a _block_
-    # is given, it will be passed the path of the local repository
-    # after the repository is successfully checked out.
-    #
-    # _options_ must contain the following key:
-    # <tt>:uri</tt>:: The URI of the repository to checkout.
-    #
-    # _options_ may also contain the additional keys:
-    # <tt>:path</tt>:: Path to checkout the repository to.
-    # <tt>:media</tt>:: The media type of the repository. Defaults to the
-    #                   value of Media.get_for_uri.
-    # <tt>:into</tt>:: Checkout the repository into the given directory.
-    #                  Cannot be used with <tt>:path</tt>.
-    #
-    def Media.checkout(options={},&block)
-      uri = options[:uri].to_s
-      path = options[:path]
-      into = options[:into]
-      media = options[:media]
-
-      unless path
-        if into
-          into = File.expand_path(into)
-
-          unless File.directory?(into)
-            FileUtils.mkdir_p(into)
-          end
-
-          path = File.join(into,URI.repo_name(uri))
-        else
-          path = URI.repo_name(uri)
-        end
-      end
-
-      path = File.expand_path(path)
-      if File.exists?(path)
-        raise(RepositoryExists,"the repository #{path.dump} already exists",caller)
-      end
-
-      if media
-        handler = Media.get(media)
-      else
-        media, handler = Media.guess_from_uri(uri)
-      end
-
-      begin
-        handler.checkout(uri,path)
-      rescue CommandFailed
-        raise(CheckoutFailed,"failed to checkout the repository located at #{uri.dump}",caller)
-      end
-
-      block.call(path,media,uri) if block
-      return {:path => path, :media => media, :uri => uri}
-    end
-
-    #
-    # Update the repository with the specified _options_. If a _block_
-    # is given, it will be passed the path of the local repository
-    # after the repository is successfully updated.
-    #
-    # _options_ must contain the following keys:
-    # <tt>:path</tt>:: The path of the repository to update.
-    #
-    # _options_ may also contain the additional keys:
-    # <tt>:uri</tt>:: The URI to update against.
-    # <tt>:media</tt>:: The type of the repository. Defaults to
-    #                   Media.guess_from_uri if <tt>:uri</tt> is given,
-    #                   otherwise Media.guess_from_path.
-    #
-    def Media.update(options={},&block)
-      path = File.expand_path(options[:path])
-      uri = options[:uri]
-      media = options[:media]
-
-      if media
-        handler = Media.get(media)
-      elsif uri
-        media, handler = Media.guess_from_uri(uri)
-      else
-        handler = Media.guess_from_path(path)
-      end
-
-      begin
-        handler.update(path,uri)
-      rescue CommandFailed
-        raise(UpdateFailed,"failed to update the repository at #{path.dump}",caller)
-      end
-
-      block.call(media,path,uri) if block
-      return {:media => media, :path => path, :uri => uri}
-    end
-
-    #
-    # Delete the repository at the specified _path_. If a _block_ is
-    # given, it will be passed the _path_ before it is deleted.
-    #
-    def Media.delete(path,&block)
-      path = File.expand_path(path)
-
-      block.call(path) if block
-      FileUtils.rm_r(path.to_s,:force => true, :secure => true)
-      return nil
-    end
   end
 end

data/lib/repertoire/media/type.rb

@@ -1,84 +1,102 @@
+require 'repertoire/media/extensions/meta'
 require 'repertoire/media/media'
-require 'repertoire/extensions/meta'
 require 'repertoire/compat'
 
 module Repertoire
   module Media
-    module Type
-      def self.included(base)
-        base.meta_def(:name) do
-          @name ||= nil
-        end
+    class Type
+      #
+      # The name of the Media Type.
+      #
+      def self.name
+        nil
+      end
 
-        base.meta_def('name=') do |name|
-          @name = name.to_sym
-        end
+      #
+      # The supports URI schemes of the Media Type.
+      #
+      def self.schemes
+        []
+      end
 
-        base.meta_def(:schemes) do
-          @schemes ||= []
-        end
+      #
+      # The directory which is used by the Media Type to store metadata.
+      #
+      def self.directory
+        nil
+      end
 
-        base.meta_def(:directory) do
-          @directory ||= nil
-        end
+      protected
 
-        base.meta_def('directory=') do |dir|
-          @directory = dir.to_s
-        end
+      #
+      # Register a Media type with the specified _names_.
+      #
+      #   known_as :svn
+      #
+      def self.known_as(name)
+        name = name.to_sym
+
+        meta_def(:name) { name }
+
+        Media.types[name] = self
+      end
+
+      #
+      # Register a Media type for the specified _schemes_.
+      #
+      #   uses_schemes 'svn'
+      #
+      #   uses_schemes 'svn', 'svn+ssh'
+      #
+      def self.uses_schemes(*schemes)
+        meta_def(:schemes) { schemes }
 
-        base.module_eval do
-
-          protected
-
-          #
-          # Register a Media type with the specified _names_.
-          #
-          #   known_as :svn
-          #
-          def self.known_as(name)
-            name = name.to_sym
-
-            self.name = name
-            Media.types[name] = self
-          end
-
-          #
-          # Register a Media type for the specified _schemes_.
-          #
-          #   uses_schemes 'cvs'
-          #
-          #   uses_schemes 'svn', 'svn+ssh'
-          #
-          def self.uses_schemes(*schemes)
-            schemes.each do |scheme|
-              scheme = scheme.to_s
-
-              self.schemes << scheme
-              Media.schemes[scheme] = self
-            end
-          end
-
-          #
-          # Registers a Media type that uses the directory of the specified
-          # _name_ to store media information.
-          #
-          #   uses_directory '.svn'
-          #
-          def self.uses_directory(name)
-            name = name.to_s
-
-            self.directory = name
-            Media.directories[name] = self
-          end
-
-          #
-          # See Compat.sh.
-          #
-          def self.sh(program,*args)
-            Compat.sh(program,*args)
-          end
+        schemes.each do |scheme|
+          scheme = scheme.to_s
+
+          Media.schemes[scheme] = self
         end
       end
+
+      #
+      # Registers a Media type that uses the directory of the specified
+      # _name_ to store media information.
+      #
+      #   uses_directory '.svn'
+      #
+      def self.uses_directory(name)
+        name = name.to_s
+
+        meta_def(:directory) { name }
+
+        Media.directories[name] = self
+      end
+
+      #
+      # Changes the current working directory to the specified _path_.
+      #
+      def self.cd(path)
+        Dir.chdir(path.to_s)
+      end
+
+      #
+      # Switches to the specified _path_, calls the given _block_ and then
+      # switches back to the previous directory.
+      #
+      def self.switch_dir(path,&block)
+        current = Dir.pwd
+        
+        cd path
+        block.call if block
+        cd current
+      end
+
+      #
+      # See Compat.sh.
+      #
+      def self.sh(program,*args)
+        Compat.sh(program,*args)
+      end
     end
   end
 end

data/lib/repertoire/media/types/git.rb

@@ -2,9 +2,7 @@ require 'repertoire/media/type'
 
 module Repertoire
   module Media
-    class Git
-
-      include Type
+    class Git < Type
 
       known_as :git
 
@@ -12,18 +10,20 @@ module Repertoire
       uses_directory '.git'
 
       #
-      # Checks out the Git repository located at the specified _uri_ into the
-      # specified _path_.
+      # Checks out the Git repository located at the specified _uri_ into
+      # the specified _path_.
       #
       def self.checkout(uri,path)
-        sh('git','clone',uri,path)
+        sh 'git', 'clone', uri, path
       end
 
       #
       # Updated the Git repository located at the specified _path_.
       #
       def self.update(path,uri=nil)
-        sh('git','pull',path)
+        switch_dir(path) do
+          sh 'git', 'pull'
+        end
       end
 
     end

data/lib/repertoire/media/types/hg.rb

@@ -0,0 +1,30 @@
+require 'repertoire/media/type'
+
+module Repertoire
+  module Media
+    class Hg < Type
+
+      known_as :hg
+
+      uses_directory '.hg'
+
+      #
+      # Checks out the Mercurial repository located at the specified _uri_
+      # into the specified _path_.
+      #
+      def self.checkout(uri,path)
+        sh 'hg', 'clone', uri, path
+      end
+
+      #
+      # Updated the Mercurial repository located at the specified _path_.
+      #
+      def self.update(path,uri=nil)
+        switch_dir(path) do
+          sh 'hg', 'pull', '-u'
+        end
+      end
+
+    end
+  end
+end

data/lib/repertoire/media/types/rsync.rb

@@ -2,9 +2,7 @@ require 'repertoire/media/type'
 
 module Repertoire
   module Media
-    class Rsync
-
-      include Type
+    class Rsync < Type
 
       known_as :rsync
 
@@ -15,15 +13,15 @@ module Repertoire
       # the specified _path_.
       #
       def self.checkout(uri,path)
-        sh('rsync','-av',uri,path)
+        sh 'rsync', '-av', uri, path
       end
 
       #
-      # Updated the Rsync repository located at the specified _path_ with the
-      # remote repository at the specified _uri_.
+      # Updated the Rsync repository located at the specified _path_ with
+      # the remote repository at the specified _uri_.
       #
       def self.update(path,uri)
-        sh('rsync','-av','--delete-after',uri,path)
+        sh 'rsync', '-av', '--delete-after', uri, path
       end
 
     end

data/lib/repertoire/media/types/svn.rb

@@ -2,9 +2,7 @@ require 'repertoire/media/type'
 
 module Repertoire
   module Media
-    class SVN
-
-      include Type
+    class SVN < Type
 
       known_as :svn
 
@@ -12,18 +10,18 @@ module Repertoire
       uses_directory '.svn'
 
       #
-      # Checks out the SVN repository located at the specified _uri_ into the
-      # specified _path_.
+      # Checks out the SVN repository located at the specified _uri_ into
+      # the specified _path_.
       #
       def self.checkout(uri,path)
-        sh('svn','co',uri,path)
+        sh 'svn', 'co', uri, path
       end
 
       #
       # Updated the SVN repository located at the specified _path_.
       #
       def self.update(path,uri=nil)
-        sh('svn','up',path)
+        sh 'svn', 'up', path
       end
 
     end