repertoire 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 / 2008-01-17
+
+* Initial release.
+* Supports Subversion (SVN), Darcs, CVS and RSync repositories.
+

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/repertoire
+lib/repertoire.rb
+lib/repertoire/compat.rb
+lib/repertoire/extensions.rb
+lib/repertoire/extensions/uri.rb
+lib/repertoire/media.rb
+lib/repertoire/media/exceptions.rb
+lib/repertoire/media/exceptions/unknown_media.rb
+lib/repertoire/media/media.rb
+lib/repertoire/media/cvs.rb
+lib/repertoire/media/darcs.rb
+lib/repertoire/media/rsync.rb
+lib/repertoire/media/svn.rb
+lib/repertoire/version.rb
+test/test_repertoire.rb

data/README.txt

@@ -0,0 +1,44 @@
+R'epertoire
+    by Postmodern Modulus III
+    http://rubyforge.org/projects/repertoire/
+
+== DESCRIPTION:
+  
+R'epertoire is a Ruby library and utility for quickly checking-out and updating code-bases from various SCMs. R'epertoire currently supports Subversion, CVS, Git and even RSync.
+
+== FEATURES/PROBLEMS:
+  
+* Currently supports checking-out and updating from...
+ * Subversion (SVN)
+ * Darcs
+ * CVS
+ * RSync
+
+== INSTALL:
+
+  $ sudo gem install repertoire
+
+== LICENSE:
+
+The MIT License
+
+Copyright (c) 2008 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/repertoire/version.rb'
+
+Hoe.new('repertoire', Repertoire::VERSION) do |p|
+  p.rubyforge_name = 'repertoire'
+  p.author = 'Postmodern Modulus III'
+  p.email = 'postmodern.mod3@gmail.com'
+  p.summary = "R'epertoire is a Ruby library and utility for quickly checking-out and updating code-bases from various SCMs. R'epertoire currently supports Subversion, Darcs, CVS, and even RSync."
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/repertoire/compat.rb

@@ -0,0 +1,47 @@
+module Repertoire
+  module Compat
+    #
+    # Returns the native _platform_.
+    #
+    #   Compat.arch  #=> "linux"
+    #
+    def self.platform
+      RUBY_PLATFORM.split('-').last
+    end
+
+    #
+    # Returns an array representing the +PATH+ environment variable.
+    # If the +PATH+ environment variable is not setup, an empty array will
+    # be returned.
+    #
+    #   Compat.PATH  #=> ["/bin", "/usr/bin"]
+    #
+    def self.PATH
+      # return an empty array in case
+      # the PATH variable does not exist
+      return [] unless ENV['PATH']
+
+      if self.platform =~ /mswin32/
+        return ENV['PATH'].split(';')
+      else
+        return ENV['PATH'].split(':')
+      end
+    end
+
+    #
+    # Finds the program matching _name_ and returns it's full path.
+    # If the program was not found, +nil+ will be returned.
+    #
+    #   Compat.find_program('as')  #=> "/usr/bin/as"
+    #
+    def self.find_program(name)
+      self.PATH.each do |dir|
+        full_path = File.expand_path(File.join(dir,name))
+
+        return full_path if File.file?(full_path)
+      end
+
+      return nil
+    end
+  end
+end

data/lib/repertoire/extensions/uri.rb

@@ -0,0 +1,24 @@
+require 'uri'
+
+module URI
+  #
+  # Returns the +basename+ of the specified _uri_, unless the +basename+ is
+  # +'trunk'+ then the +basename+ of the parent directory within the _uri_
+  # is returned.
+  #
+  #   URI.repo_name('http://www.today.com/is/now') # => "now"
+  #
+  #   URI.repo_name('svn://svn.repo.com/var/svn/awesome/trunk') # =>
+  #   "awesome"
+  #
+  def URI.repo_name(uri)
+    path = URI.parse(uri).path
+    name = File.basename(path)
+
+    if name=='trunk' || name.empty?
+      name = File.basename(File.dirname(path))
+    end
+
+    return name
+  end
+end

data/lib/repertoire/extensions.rb

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

data/lib/repertoire/media/cvs.rb

@@ -0,0 +1,32 @@
+require 'repertoire/media/media'
+
+module Repertoire
+  class CVS < Media
+
+    uses_schemes 'cvs'
+
+    #
+    # Returns +true+ if the repository located at the specified _path_
+    # contains the +CVS+ directory, returns +false+ otherwise.
+    #
+    def self.is_repo?(path)
+      File.directory?(File.join(path,'CVS'))
+    end
+
+    #
+    # Checks out the CVS repository located at the specified _uri_ into the
+    # specified _path_.
+    #
+    def self.checkout(uri,path)
+      sh('cvs','-d',path,'co',uri)
+    end
+
+    #
+    # Updated the CVS repository located at the specified _path_.
+    #
+    def self.update(path,uri=nil)
+      sh('cvs','up',path)
+    end
+
+  end
+end

data/lib/repertoire/media/darcs.rb

@@ -0,0 +1,32 @@
+require 'repertoire/media/media'
+
+module Repertoire
+  class Darcs < Media
+
+    uses_schemes 'darcs'
+
+    #
+    # Returns +true+ if the repository located at the specified _path_
+    # contains the +_darcs+ directory, returns +false+ otherwise.
+    #
+    def self.is_repo?(path)
+      File.directory?(File.join(path,'_darcs'))
+    end
+
+    #
+    # Checks out the Darcs repository located at the specified _uri_ into
+    # the specified _path_.
+    #
+    def self.checkout(uri,path=nil)
+      sh('darcs','get','--partial',uri,path)
+    end
+
+    #
+    # Updated the Darcs repository located at the specified _path_.
+    #
+    def self.update(uri,path)
+      sh('darcs','pull','-a',path)
+    end
+
+  end
+end

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

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

data/lib/repertoire/media/exceptions.rb

@@ -0,0 +1,2 @@
+require 'repertoire/exceptions/unknown_media'
+require 'repertoire/exceptions/program_not_found'

data/lib/repertoire/media/media.rb

@@ -0,0 +1,134 @@
+require 'repertoire/media/exceptions/unknown_media'
+require 'repertoire/media/exceptions/program_not_found'
+require 'repertoire/extensions/uri'
+require 'repertoire/compat'
+
+require 'fileutils'
+
+module Repertoire
+  class Media
+
+    #
+    # Returns the Hash of all registered Media types.
+    #
+    def Media.types
+      @types ||= {}
+    end
+
+    #
+    # Returns +true+ if a Media type was registered for the specified
+    # _scheme_, returns +false+ otherwise.
+    #
+    def Media.supported?(scheme)
+      Media.types.has_key?(scheme.to_s)
+    end
+
+    #
+    # Get the Media type that was registered for the specified _scheme_.
+    #
+    def Media.get(scheme)
+      unless Media.supported?(scheme)
+        raise(UnknownMedia,"media type #{scheme.dump} is unsupported",caller)
+      end
+
+      return Media.types[scheme]
+    end
+
+    #
+    # Get the Media type that was registered for the scheme of the
+    # specified _uri_.
+    #
+    def Media.get_for_uri(uri)
+      Media.get(URI.parse(uri).scheme)
+    end
+
+    #
+    # Attempts to determine the correct Media type for the specified _path_.
+    #
+    def Media.guess(path)
+      path = File.expand_path(path)
+
+      Media.types.values.uniq.each do |media|
+        if media.respond_to?(:is_repo?)
+          return media if media.is_repo?(path)
+        end
+      end
+
+      raise(UnknownMedia,"the media type for #{path.dump} is unknown",caller)
+    end
+
+    #
+    # Checkout the repository at the specified _uri_ and the given _path_.
+    #
+    def Media.checkout(uri,path=nil)
+      if path
+        path = File.expand_path(path)
+      else
+        path = URI.repo_name(uri)
+      end
+
+      return Media.get_for_uri(uri).checkout(uri,path)
+    end
+
+    #
+    # Update the repository at the specified _path_ and the given _uri_.
+    # If _uri_ is not given Repertoire will attempt to guess the media
+    # type of the repository, see Media.guess.
+    #
+    def Media.update(path,uri=nil)
+      path = File.expand_path(path)
+
+      if uri.nil?
+        media = Media.guess(path)
+      else
+        media = Media.get_for_uri(uri)
+      end
+
+      return media.update(path,uri)
+    end
+
+    #
+    # Delete the repository at the specified _path_.
+    #
+    def Media.delete(path)
+      FileUtils.rm_r(path.to_s,:force => true, :secure => true)
+    end
+
+    protected
+
+    #
+    # 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|
+        Media.types[scheme.to_s] = self
+      end
+    end
+
+    #
+    # Runs the command specified by _program_ and the given _args_.
+    # If _program_ cannot be found on the system, a ProgramNotFound
+    # exception will be raised.
+    #
+    #   sh('ls','-la','/')
+    #
+    def self.sh(program,*args)
+      program = program.to_s
+
+      program_path = Compat.find_program(program)
+      unless program_path
+        raise(ProgramNotFound,"the program #{program.dump} was not found",caller)
+      end
+
+      # stringify the args
+      args = args.map { |arg| arg.to_s }
+
+      return system(program_path,*args)
+    end
+
+  end
+end

data/lib/repertoire/media/rsync.rb

@@ -0,0 +1,25 @@
+require 'repertoire/media/media'
+
+module Repertoire
+  class Rsync < Media
+
+    uses_schemes 'rsync'
+
+    #
+    # Checks out the Rsync repository located at the specified _uri_ into
+    # the specified _path_.
+    #
+    def self.checkout(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_.
+    #
+    def self.update(path,uri)
+      sh('rsync','-av','--delete-after',uri,path)
+    end
+
+  end
+end

data/lib/repertoire/media/svn.rb

@@ -0,0 +1,32 @@
+require 'repertoire/media/media'
+
+module Repertoire
+  class SVN < Media
+
+    uses_schemes 'svn', 'svn+ssh'
+
+    #
+    # Returns +true+ if the repository located at the specified _path_
+    # contains the +.svn+ directory, returns +false+ otherwise.
+    #
+    def self.is_repo?(path)
+      File.directory?(File.join(path,'.svn'))
+    end
+
+    #
+    # Checks out the SVN repository located at the specified _uri_ into the
+    # specified _path_.
+    #
+    def self.checkout(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)
+    end
+
+  end
+end

data/lib/repertoire/media.rb

@@ -0,0 +1,5 @@
+require 'repertoire/media/media'
+require 'repertoire/media/svn'
+require 'repertoire/media/darcs'
+require 'repertoire/media/cvs'
+require 'repertoire/media/rsync'

data/lib/repertoire/version.rb

@@ -0,0 +1,3 @@
+module Repertoire
+  VERSION = '0.1.0'
+end

data/lib/repertoire.rb

@@ -0,0 +1,2 @@
+require 'repertoire/media'
+require 'repertoire/version'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: repertoire
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern Modulus III
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "== FEATURES/PROBLEMS:  * Currently supports checking-out and updating from... * Subversion (SVN) * Darcs * CVS * RSync  == INSTALL:  $ sudo gem install repertoire  == LICENSE:"
+email: postmodern.mod3@gmail.com
+executables: 
+- repertoire
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/repertoire
+- lib/repertoire.rb
+- lib/repertoire/compat.rb
+- lib/repertoire/extensions.rb
+- lib/repertoire/extensions/uri.rb
+- lib/repertoire/media.rb
+- lib/repertoire/media/exceptions.rb
+- lib/repertoire/media/exceptions/unknown_media.rb
+- lib/repertoire/media/media.rb
+- lib/repertoire/media/cvs.rb
+- lib/repertoire/media/darcs.rb
+- lib/repertoire/media/rsync.rb
+- lib/repertoire/media/svn.rb
+- lib/repertoire/version.rb
+- test/test_repertoire.rb
+has_rdoc: true
+homepage: "    by Postmodern Modulus III"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: repertoire
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: R'epertoire is a Ruby library and utility for quickly checking-out and updating code-bases from various SCMs. R'epertoire currently supports Subversion, Darcs, CVS, and even RSync.
+test_files: 
+- test/test_repertoire.rb