repertoire 0.1.2 → 0.2.0

data/lib/repertoire/media/types.rb

@@ -1,5 +1,4 @@
-require 'repertoire/media/types/cvs'
-require 'repertoire/media/types/darcs'
+require 'repertoire/media/types/hg'
 require 'repertoire/media/types/git'
 require 'repertoire/media/types/svn'
 require 'repertoire/media/types/rsync'

data/lib/repertoire/repertoire.rb

@@ -1,24 +1,120 @@
+require 'repertoire/exceptions/repository_exists'
+require 'repertoire/exceptions/checkout_failed'
+require 'repertoire/exceptions/update_failed'
+require 'repertoire/repository'
 require 'repertoire/media'
 
+require 'fileutils'
+
 module Repertoire
   #
-  # See Media.checkout.
+  # Checkout the repository at the specified _options_. If a _block_
+  # is given, it will be passed a newly created Repository object
+  # for the checked out repository.
+  #
+  # _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 Repertoire.checkout(options={},&block)
-    Media.checkout(options,&block)
+    unless options[:uri]
+      raise(ArgumentError,"the :uri option must be specified",caller)
+    end
+
+    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,Repository.name(uri))
+      else
+        path = Repository.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
+      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
+
+    return Repository.new(path,handler,&block)
   end
 
   #
-  # See Media.update.
+  # Update the repository with the specified _options_. If a _block_
+  # is given, it will be passed a newly created Repository object
+  # for the updated repository.
+  #
+  # _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 Repertoire.update(options={},&block)
-    Media.update(options,&block)
+    unless options[:path]
+      raise(ArgumentError,"the :path option must be specified",caller)
+    end
+
+    path = File.expand_path(options[:path])
+    uri = options[:uri]
+    media = options[:media]
+
+    if media
+      handler = Media.get(media)
+    elsif uri
+      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
+
+    return Repository.new(path,handler,&block)
   end
 
   #
-  # See Media.delete.
+  # Delete the repository at the specified _path_. If a _block_ is
+  # given, it will be passed the _path_ before it is deleted.
   #
   def Repertoire.delete(path,&block)
-    Media.delete(path,&block)
+    path = File.expand_path(path)
+
+    block.call(path) if block
+    FileUtils.rm_r(path,:force => true, :secure => true)
+    return nil
   end
 end

data/lib/repertoire/repository.rb

@@ -1,4 +1,7 @@
 require 'repertoire/media'
+require 'repertoire/repository'
+
+require 'uri'
 
 module Repertoire
   class Repository
@@ -16,31 +19,93 @@ module Repertoire
     #
     #   Repository.new('path/to/repo',Media::SVN)
     #
-    #   Repository.new('path/to/svn_repo',Media::SVN) do |dir|
-    #     puts dir['**/']
+    #   Repository.new('path/to/svn_repo',Media::SVN) do |repo|
+    #     puts repo['**/']
     #   end
     #
     def initialize(path,media=nil,&block)
       @path = File.expand_path(path)
-      @media = nil
 
-      if media
-        if File.directory?(File.join(path,media.directory))
-          @media = media
-        end
+      begin
+        @media = (media || Media.guess_from_path(@path))
+      rescue Media::UnknownMedia
+        @media = nil
       end
 
       block.call(self) if block
     end
 
+    #
+    # Returns the +basename+ of the specified _uri_, unless the +basename+ is
+    # +'trunk'+ then the +basename+ of the parent directory within the _uri_
+    # is returned.
+    #
+    #   Repertoire.name('http://www.today.com/is/now')
+    #   # => "now"
+    #
+    #   Repertoire.name('svn://svn.repo.com/var/svn/awesome/trunk')
+    #   # => "awesome"
+    #
+    def Repository.name(uri)
+      uri = URI(uri.to_s)
+
+      if uri.path.empty?
+        path = File::SEPARATOR
+      else
+        path = File.expand_path(uri.path)
+      end
+
+      name = File.basename(path)
+
+      if name == 'trunk'
+        name = File.basename(File.dirname(path))
+      elsif name =~ /\.git$/
+        name.gsub!(/\.git$/,'')
+      end
+
+      if (name.empty? || name == File::SEPARATOR)
+        name = uri.host
+      end
+
+      return name
+    end
+
+    #
+    # Returns the name of the media used for the repository. If the media
+    # could not be guessed, +nil+ will be returned.
+    #
+    def media_name
+      return @media.name if @media
+      return nil
+    end
+
+    #
+    # Update the repository.
+    #
+    def update(uri=nil)
+      if @media
+        @media.update(uri)
+        return true
+      end
+
+      return false
+    end
+
+    #
+    # Delete the repository.
+    #
+    def delete
+      Repertoire.delete(@path)
+    end
+
     #
     # Similar to <tt>Dir.glob</tt>, except the media's directory is omitted
     # from the returned results. If a _block_ is given, it will be passed
     # each resulting path.
     #
-    #   dir = Directory.new('path/to/my_svn')
-    #   dir.glob('sub_path/.svn/*') # => []
-    #   dir.glob('sub_path/**/') # => [...]
+    #   repo = Repository.new('path/to/my_svn')
+    #   repo.glob('sub_path/.svn/*') # => []
+    #   repo.glob('sub_path/**/') # => [...]
     #
     def glob(pattern,flags=0,&block)
       pattern = File.expand_path(File.join(@path,pattern))
@@ -90,12 +155,7 @@ module Repertoire
       !(directories(sub_path).empty?)
     end
 
-    #
-    # See glob.
-    #
-    def [](pattern='')
-      glob(pattern)
-    end
+    alias [] glob
 
     #
     # Returns the path of the directory in +String+ form.
@@ -113,8 +173,8 @@ module Repertoire
     def filter(paths)
       return paths unless @media
 
-      return paths.select do |path|
-        !(path.split(File::SEPARATOR).include?(@media.directory))
+      return paths.reject do |path|
+        path.split(File::SEPARATOR).include?(@media.directory)
       end
     end
 

data/lib/repertoire/version.rb

@@ -1,3 +1,4 @@
 module Repertoire
-  VERSION = '0.1.2'
+  # Repertoire version
+  VERSION = '0.2.0'
 end

data/spec/compat_spec.rb

@@ -0,0 +1,31 @@
+require 'repertoire/compat'
+
+require 'spec_helper'
+
+describe Compat do
+  it "should have a list of directories that contain programs" do
+    Compat.paths.any? { |dir|
+      File.directory?(dir)
+    }.should == true
+  end
+
+  it "should be able to find programs" do
+    File.executable?(Compat.find_program('dir')).should == true
+  end
+
+  it "should be able to run programs" do
+    Compat.sh('dir').should_not == false
+  end
+
+  it "should raise ProgramNotFound when running missing programs" do
+    lambda {
+      Compat.sh('obviously_not_there')
+    }.should raise_error(ProgramNotFound)
+  end
+
+  it "should raise CommandFailed when the program fails" do
+    lambda {
+      Compat.sh('dir','obviously_missing_dir')
+    }.should raise_error(CommandFailed)
+  end
+end

data/spec/helpers/repository/dir/file.txt

@@ -0,0 +1 @@
+hello again

data/spec/helpers/repository/dir/file2.txt

@@ -0,0 +1 @@
+hello yet again

data/spec/helpers/repository/file.txt

@@ -0,0 +1 @@
+hello

data/spec/helpers/repository.rb

@@ -0,0 +1 @@
+REPOSITORY_PATH = File.join(File.dirname(__FILE__),'repository')

data/spec/media/media_spec.rb

@@ -0,0 +1,79 @@
+require 'repertoire/media'
+
+describe Media do
+  it "should have media types" do
+    Media.types.should_not be_empty
+  end
+
+  it "should support Rsync media" do
+    Media.supports?('rsync').should == true
+  end
+
+  it "should support SubVersion media" do
+    Media.supports?('svn').should == true
+  end
+
+  it "should support Mercurial media" do
+    Media.supports?('hg').should == true
+  end
+
+  it "should support Git media" do
+    Media.supports?('git').should == true
+  end
+
+  it "should provide access to media types via Symbols" do
+    Media.get(:svn).should == Media::SVN
+  end
+
+  it "should provide access to media types via Strings" do
+    Media.get('svn').should == Media::SVN
+  end
+
+  it "should raise an UnknownMedia exception for missing Media" do
+    lambda {
+      Media.get('nothing')
+    }.should raise_error(Media::UnknownMedia)
+  end
+
+  it "should provide URI schemes which represent media types" do
+    Media.schemes.should_not be_empty
+  end
+
+  it "should support the svn: URI scheme" do
+    Media.supports_scheme?('svn').should == true
+  end
+
+  it "should support the svn+ssh: URI scheme" do
+    Media.supports_scheme?('svn+ssh').should == true
+  end
+
+  it "should support the git: URI scheme" do
+    Media.supports_scheme?('git').should == true
+  end
+
+  it "should provide directory names which are used by media types" do
+    Media.directories.should_not be_empty
+  end
+
+  it "should recognize the .svn directory" do
+    Media.recognizes_directory?('.svn').should == true
+  end
+
+  it "should recognize the .hg directory" do
+    Media.recognizes_directory?('.hg').should == true
+  end
+
+  it "should recognize the .git directory" do
+    Media.recognizes_directory?('.git').should == true
+  end
+
+  it "should guess media types via a URI" do
+    Media.guess_from_uri('svn+ssh://www.example.com/').should == Media::SVN
+  end
+
+  it "should raise an UnknownMedia exception for unknown URIs" do
+    lambda {
+      Media.guess_from_uri('new://www.example.com/')
+    }.should raise_error(Media::UnknownMedia)
+  end
+end

data/spec/media/type_spec.rb

@@ -0,0 +1,36 @@
+require 'repertoire/media/type'
+
+require 'spec_helper'
+require 'tmpdir'
+
+describe Media::Type do
+  it "should have a default name" do
+    Media::Type.name.should be_nil
+  end
+
+  it "should have default schemes" do
+    Media::Type.schemes.should be_empty
+  end
+
+  it "should have a default directory" do
+    Media::Type.directory.should be_nil
+  end
+
+  it "should be able to change the current working directory" do
+    current = Dir.pwd
+    Media::Type.cd(Dir.tmpdir)
+
+    Dir.pwd.should == Dir.tmpdir
+    Dir.chdir(current)
+  end
+
+  it "should be able to switch the current working directory" do
+    current = Dir.pwd
+
+    Media::Type.switch_dir(Dir.tmpdir) do
+      Dir.pwd.should == Dir.tmpdir
+    end
+
+    Dir.pwd.should == current
+  end
+end

data/spec/media/types/git_spec.rb

@@ -0,0 +1,17 @@
+require 'repertoire/media/types/git'
+
+require 'spec_helper'
+
+describe Media::Git do
+  it "should have a name" do
+    Media::Git.name.should == :git
+  end
+
+  it "should have recognized schemes" do
+    Media::Git.schemes.should == ['git']
+  end
+
+  it "should recognize a directory" do
+    Media::Git.directory.should == '.git'
+  end
+end

data/spec/media/types/hg_spec.rb

@@ -0,0 +1,13 @@
+require 'repertoire/media/types/hg'
+
+require 'spec_helper'
+
+describe Media::Hg do
+  it "should have a name" do
+    Media::Hg.name.should == :hg
+  end
+
+  it "should recognize a directory" do
+    Media::Hg.directory.should == '.hg'
+  end
+end

data/spec/media/types/rsync_spec.rb

@@ -0,0 +1,17 @@
+require 'repertoire/media/types/rsync'
+
+require 'spec_helper'
+
+describe Media::Rsync do
+  it "should have a name" do
+    Media::Rsync.name.should == :rsync
+  end
+
+  it "should have recognized schemes" do
+    Media::Rsync.schemes.should == ['rsync']
+  end
+
+  it "should not recognize a directory" do
+    Media::Rsync.directory.should be_nil
+  end
+end

data/spec/media/types/svn_spec.rb

@@ -0,0 +1,17 @@
+require 'repertoire/media/types/svn'
+
+require 'spec_helper'
+
+describe Media::SVN do
+  it "should have a name" do
+    Media::SVN.name.should == :svn
+  end
+
+  it "should have recognized schemes" do
+    Media::SVN.schemes.should == ['svn', 'svn+ssh']
+  end
+
+  it "should recognize a directory" do
+    Media::SVN.directory.should == '.svn'
+  end
+end

data/spec/repertoire_spec.rb

@@ -0,0 +1,9 @@
+require 'repertoire/version'
+
+require 'spec_helper'
+
+describe Repertoire do
+  it "should have a VERSION constant" do
+    Repertoire.const_defined?('VERSION').should == true
+  end
+end

data/spec/repository_spec.rb

@@ -0,0 +1,78 @@
+require 'repertoire/repository'
+require 'repertoire/media/types/hg'
+
+require 'spec_helper'
+require 'helpers/repository'
+
+describe Repository do
+  describe "name" do
+    before(:all) do
+      @host = 'www.example.com'
+      @url_prefix = "http://#{@host}"
+    end
+
+    it "should return a repository name from a URI" do
+      Repository.name("#{@url_prefix}/repo").should == 'repo'
+    end
+
+    it "should ignore trunk/ postfixes" do
+      Repository.name("#{@url_prefix}/repo/trunk").should == 'repo'
+    end
+
+    it "should ignore .git postfixes" do
+      Repository.name("#{@url_prefix}/repo.git").should == 'repo'
+    end
+
+    it "should use the hostname if the URI path is empty" do
+      Repository.name(@url_prefix).should == @host
+    end
+
+    it "should use the hostname if the URI path is the root" do
+      Repository.name("#{@url_prefix}/").should == @host
+    end
+
+    it "should use the hostname if the URI path becomes empty" do
+      Repository.name("#{@url_prefix}/trunk").should == @host
+    end
+
+    it "should prevent against directory traversal" do
+      Repository.name("#{@url_prefix}/..").should == @host
+    end
+  end
+
+  describe "file access" do
+    before(:all) do
+      @repo = Repository.new(REPOSITORY_PATH,Media::Hg)
+    end
+
+    it "should have paths" do
+      paths = @repo.glob('**/*').map { |path| File.basename(path) }
+
+      paths.include?('file.txt').should == true
+      paths.include?('dir').should == true
+      paths.include?('file2.txt').should == true
+    end
+
+    it "should have top level files" do
+      @repo.files.map { |path| File.basename(path) }.should == [
+        'file.txt'
+      ]
+    end
+
+    it "should have top level directories" do
+      @repo.directories.map { |path| File.basename(path) }.should == [
+        'dir'
+      ]
+    end
+  end
+
+  it "should be able to guess the media typa from the path" do
+    repo = Repository.new(REPOSITORY_PATH)
+    repo.media.should == Media::Hg
+  end
+
+  it "should provide the media name of the repository" do
+    repo = Repository.new(REPOSITORY_PATH,Media::Hg)
+    repo.media_name.should == :hg
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+
+require 'repertoire/version'
+
+include Repertoire

data/tasks/spec.rb

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs += ['lib', 'spec']
+  t.spec_opts = ['--colour', '--format', 'specdoc']
+end
+
+task :default => :spec