svn 0.1.0 → 0.2.0

data/lib/svn.rb

@@ -16,4 +16,12 @@ module Svn
   autoload :Root, 'svn/roots'
   autoload :Revision, 'svn/revisions'
   autoload :Diff, 'svn/diffs'
+
+  def self.create( path )
+    Repo.create( path )
+  end
+
+  def self.open( path )
+    Repo.open( path )
+  end
 end

data/lib/svn/errors.rb

@@ -7,10 +7,51 @@ module Svn
 
     class << self
 
+      ERROR_CLASSES = {}
+
+      # used to turn generic messages for unknown errors into class names
+      # e.g., "Repository creation failed" => 'RepositoryCreationFailedError'
+      def class_name_for( message )
+        message.split(/\s+/).each(&:capitalize!).join + 'Error'
+      end
+
+      def specific_error_class( c_error )
+        # if an error class is already set, return it. otherwise, create a new
+        # one from the error's generic message
+        (
+            get( c_error.code ) ||
+            add( c_error.code, class_name_for( c_error.generic_message ) )
+          )
+      end
+
+      def get( code )
+        ERROR_CLASSES[code]
+      end
+
+      def add( code, class_or_name )
+        klass = nil # keep in scope
+
+        if class_or_name.is_a? Class
+          klass = class_or_name
+        else
+          name = class_or_name
+          begin
+            # fetch an existing error class and save it for the error code
+            klass = Svn.const_get( name )
+          rescue NameError => err
+            # create the error class and return it
+            $stderr.puts "Creating #{name} for #{code}" if $debug_svn_errors
+            klass = Svn.const_set( name, Class.new( Svn::Error ) )
+          end
+        end
+
+        ERROR_CLASSES[code] = klass
+      end
+
       # checks error and raises an exception for error if necessary
-      def check_and_raise( err )
-        return if err.null?
-        raise Error.new( err )
+      def check_and_raise( err_ptr )
+        return if err_ptr.null?
+        raise specific_error_class( err_ptr ).new( err_ptr.message )
       end
 
       # returns a proc that calls check_and_raise
@@ -24,7 +65,7 @@ module Svn
 
     def initialize( message_or_c_error )
       if message_or_c_error.is_a? CError
-        super( message_or_c_error.best_message )
+        super( message_or_c_error.cause_message )
         @c_error = message_or_c_error
       else
         super( message_or_c_error )
@@ -33,9 +74,16 @@ module Svn
 
   end
 
+  # create sensible names for known error classes
+  Error.add( 2, :PathNotFoundError )
+  Error.add( 20, :NotADirectoryError )
+  Error.add( 160006, :InvalidRevisionError )
+  Error.add( 165002, ArgumentError )
+  Error.add( 200011, :DirectoryNotEmptyError )
+
   class CError < FFI::ManagedStruct
     layout(
-        :apr_error, :int,
+        :error_code, :int,
         :message, :string,
         :child, :pointer,
         :pool, :pointer,
@@ -49,35 +97,74 @@ module Svn
       end
     end
 
-    # returns the most accurate message for an error
-    def best_message
-      # create a buffer, which may be used to hold the best message
-      buf = FFI::MemoryPointer.new( 1024 )
-      msg = C.best_message( self, buf, 1024 )
-
-      # return a duplicate of msg, since it may be stored in the buffer
-      # allocated above
-      msg.dup
-    end
-
     module C
       extend FFI::Library
       ffi_lib 'libsvn_subr-1.so.1'
 
       typedef CError.by_ref, :error
       typedef :int, :size
+      typedef :int, :error_code
 
       attach_function :best_message,
           :svn_err_best_message,
           [ :error, :buffer_inout, :size ],
           :string
 
+      attach_function :root_cause,
+          :svn_error_root_cause,
+          [ :error ],
+          :error
+
+      attach_function :generic_message,
+          :svn_strerror,
+          [ :error_code, :buffer_inout, :size ],
+          :string
+
       attach_function :clear,
           :svn_error_clear,
           [ :error ],
           :void
     end
 
+    copy_msg = Proc.new { |msg| msg.dup if msg }
+
+    bind_to C
+
+    MSG_BUFFER = FFI::MemoryPointer.new(1024)
+    # returns the error's specific message, if present, and the code's generic
+    # message otherwise
+    bind(
+        :best_message,
+        :before_return => copy_msg
+      ) { |this| [this, MSG_BUFFER, 1024] }
+
+    # returns the most specific error struct from this error chain
+    bind :root_cause
+
+    # returns the "generic" message for the error code
+    bind(
+        :generic_message,
+        :before_return => copy_msg
+      ) { |this| [ this[:error_code], MSG_BUFFER, 1024 ] }
+
+    # returns the most specific error message from this error chain
+    def cause_message
+      root_cause.best_message
+    end
+
+    # returns a combined message if there are children, or the best otherwise
+    def message
+      if self[:child].null?
+        best_message
+      else
+        "#{best_message}: #{cause_message}"
+      end
+    end
+
+    def code
+      self[:error_code]
+    end
+
   end
 
 end

data/lib/svn/repos.rb

@@ -23,26 +23,34 @@ module Svn #:nodoc:
       # assertions in SVN libs
       #++
       def open( path, parent=RootPool )
+        raise ArgumentError, 'Path cannot be nil' if path.nil?
+
         # get a new pool for all interactions with this repository
         pool = Pool.create( parent )
 
-        # TODO: we may need to call find_root_path for this, if C.open expects
-        # an exact repository root path
         out = FFI::MemoryPointer.new( :pointer )
 
+        # make sure the path is canonical: full path from / and no trailing /
+        final_path = File.expand_path( path.chomp(File::SEPARATOR) )
+
         Error.check_and_raise(
-            C.open( out, path.chomp(File::SEPARATOR), pool )
+            C.open( out, final_path, pool )
           )
 
         new( out.read_pointer, pool )
       end
 
       def create( path, parent=RootPool )
+        raise ArgumentError, 'Path cannot be nil' if path.nil?
+
         # get a new pool for all interactions with this repository
         pool = Pool.create( parent )
 
         out = FFI::MemoryPointer.new( :pointer )
 
+        # make sure the path is canonical: full path from / and no trailing /
+        final_path = File.expand_path( path.chomp(File::SEPARATOR) )
+
         Error.check_and_raise(
             C.create(
                 out, # an out pointer to the newly created repository
@@ -227,7 +235,7 @@ module Svn #:nodoc:
     end
 
     use_fs_and_add_pool = Proc.new { |out, this, *args|
-        [ out, fs, *args, pool ]
+        ([ out, fs ] + args) << pool
       }
 
     # use the above C module for the source of bound functions

data/lib/svn/roots.rb

@@ -85,7 +85,7 @@ module Svn #:nodoc:
 
     # helper procs for method binding
     test_c_true = Proc.new { |i| i == 1 }
-    add_pool = Proc.new { |out, this, *args| [ out, this, *args, pool ] }
+    add_pool = Proc.new { |out, this, *args| ([ out, this ] + args) << pool }
 
     # use the above C module for the source of bound functions
     bind_to C

data/lib/svn/transactions.rb

@@ -46,6 +46,12 @@ module Svn #:nodoc:
           :error
     end
 
+    # use the C module for all bound methods
+    bind_to C
+
+    bind :cancel!, :to => :cancel_transaction,
+        &add_pool
+
   end
 
 end

data/lib/svn/utils.rb

@@ -36,7 +36,7 @@ module Svn #:nodoc:
       end
 
       def new( *args )
-        @klass.new( *args, *@added_args )
+        @klass.new( *(args + @added_args) )
       end
 
       def from_native( ptr, ctx )
@@ -206,17 +206,22 @@ module Svn #:nodoc:
         # create a new method; blocks are used to re-arrange arguments
         define_method( name ) do |*args|
           # create new pointers for the specified out arguments
-          return_ptrs = return_types.map { |type| FFI::MemoryPointer.new( type ) }
+          return_ptrs = return_types.map { |type|
+            FFI::MemoryPointer.new( type )
+          }
+
+          # create the argument list for the function
+          call_args = return_ptrs.dup
+          call_args << self
+          call_args += args
 
           return_val = nil # keep it in scope
           if block
             # call the method with the arguments after re-arranging via block
-            return_val = meth.call( *instance_exec(
-                *return_ptrs, self, *args, &block
-              ) )
+            return_val = meth.call( *instance_exec( *call_args, &block ) )
           else
             # call the method with the standard argument order
-            return_val = meth.call( *return_ptrs, self, *args )
+            return_val = meth.call( *call_args )
           end
 
           # call the return check, if present
@@ -241,7 +246,7 @@ module Svn #:nodoc:
     end
 
     # extend FFI objects with the new helper methods
-    #FFI::Struct.extend Extensions
+    FFI::Struct.extend Extensions
     FFI::AutoPointer.extend Extensions
 
   end

data/spec/repo_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Svn::Repo do
+
+  context ".create" do
+
+    it "complains about nil paths" do
+      expect { Svn::Repo.create(nil) }.to raise_error(
+          ArgumentError, /cannot be nil/
+        )
+    end
+
+    it "will complain about already existing repositories" do
+      expect { Svn::Repo.create(test_repo_path) }.to raise_error(
+          ArgumentError, /existing repository/
+        )
+    end
+
+    it "will not overwrite an existing path" do
+      path = temp_path('existing')
+      FileUtils.mkdir_p(temp_path('existing', 'content'))
+      begin
+        expect { Svn::Repo.create(path) }.to raise_error(
+            Svn::DirectoryNotEmptyError, /exists/
+          )
+      ensure
+        FileUtils.rm_rf(path)
+      end
+    end
+
+    it "complains about invalid paths" do
+      expect {
+        invalid_path = temp_path( 'blah', 'blah', 'blah' )
+        Svn::Repo.create( invalid_path )
+      }.to( raise_error( Svn::PathNotFoundError) )
+    end
+
+    it "can create a new repository" do
+      path = temp_path('new_repo')
+      repo = Svn::Repo.create( path )
+      begin
+        repo.should be_a(Svn::Repo)
+        repo.null?.should be_false
+      ensure
+        FileUtils.rm_rf(path) if File.exists? path
+      end
+    end
+
+  end
+
+  context ".open" do
+
+    it "complains about nil paths" do
+      expect {
+        Svn::Repo.open(nil)
+      }.to raise_error( ArgumentError, /cannot be nil/ )
+    end
+
+    it "complains about invalid paths" do
+      expect {
+        Svn::Repo.open( temp_path( 'blah', 'blah' ) )
+      }.to( raise_error( Svn::PathNotFoundError ) )
+    end
+
+    it "complains about paths inside the repository" do
+      path = link_test_repo
+      begin
+        expect {
+          Svn::Repo.open( File.join( test_repo_path, 'trunk', 'blah' ) )
+        }.to( raise_error( Svn::PathNotFoundError ) )
+      ensure
+        unlink_test_repo(path)
+      end
+    end
+
+    it "can open an existing repository" do
+      path = link_test_repo
+      begin
+        repo = Svn::Repo.open(path)
+        repo.should be_a(Svn::Repo)
+        repo.null?.should be_false
+      ensure
+        unlink_test_repo( path )
+      end
+    end
+
+  end
+
+  context "#revision" do
+
+    before do
+      @path = link_test_repo
+      @repo = open_test( @path )
+    end
+
+    after do
+      unlink_test_repo( @path )
+    end
+
+    it "complains about invalid revision numbers" do
+      expect {
+        @repo.revision(10_000_000)
+      }.to raise_error( Svn::InvalidRevisionError )
+    end
+
+    it "opens valid revisions" do
+      rev = @repo.revision(0)
+      rev.should be_a( Svn::Revision )
+      rev.null?.should be_false
+      rev = @repo.revision(1)
+      rev.should be_a( Svn::Revision )
+      rev.null?.should be_false
+    end
+
+  end
+
+  context "#youngest" do
+    
+    before do
+      @path = link_test_repo
+      @repo = open_test( @path )
+    end
+
+    after do
+      unlink_test_repo( @path )
+    end
+
+    it "returns a revision" do
+      rev = @repo.youngest
+      rev.should be_a( Svn::Revision )
+      rev.null?.should be_false
+    end
+
+    it "is aliased as latest" do
+      rev = @repo.latest
+      rev.should be_a( Svn::Revision )
+      rev.null?.should be_false
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+# add the library path
+$LOAD_PATH.unshift File.join(__FILE__, '..', 'lib')
+require 'svn'
+
+# print error codes/classes that are dynamically generated to stderr.
+$debug_svn_errors = true
+
+# manage the test repo
+require 'tempfile'
+require 'fileutils'
+require 'zlib'
+require 'archive/tar/minitar'
+
+class Counter
+  def initialize
+    @num = 0
+  end
+
+  def next
+    @num += 1
+    @num
+  end
+end
+
+TEMP_PATH_BASE = File.join( Dir.tmpdir, "svn-#{Process.pid}" )
+TEST_REPO_TARBALL = File.join( File.dirname(__FILE__), '..', 'test', 'test_repo.tar.gz' )
+TEST_COUNTER = Counter.new
+
+ObjectSpace.define_finalizer(TEMP_PATH_BASE) do
+  FileUtils.rm_rf( File.join( Dir.tmpdir, "svn-#{Process.pid}" ) )
+end
+
+def temp_path( *parts )
+  File.join( TEMP_PATH_BASE, *parts )
+end
+
+def test_repo_path
+  temp_path( 'test_repo' )
+end
+
+# unpacks a fresh copy of the test repo tarball
+def unpack_test_repo
+  FileUtils.mkdir_p(TEMP_PATH_BASE)
+  gzip_stream = Zlib::GzipReader.new(File.open(TEST_REPO_TARBALL))
+  Archive::Tar::Minitar.unpack(gzip_stream, temp_path)
+end
+
+def link_test_repo
+  name = "test-#{TEST_COUNTER.next}"
+  link_path = temp_path(name)
+  FileUtils.ln_s(test_repo_path, link_path)
+  link_path
+end
+
+def unlink_test_repo( path )
+  FileUtils.rm( path )
+end
+
+def open_test( name )
+  Svn::Repo.open( test_repo_path )
+end
+
+def remove_test_repo
+  # clean up the temporary repository, if it is present
+  FileUtils.rm_rf test_repo_path if File.exists? test_repo_path
+end
+
+# make sure the test repo exists for all specs
+unpack_test_repo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-11 00:00:00.000000000Z
+date: 2012-04-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &15276700 !ruby/object:Gem::Requirement
+  requirement: &20726960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,29 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *15276700
+  version_requirements: *20726960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20726480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *20726480
+- !ruby/object:Gem::Dependency
+  name: archive-tar-minitar
+  requirement: &20726020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: *20726020
 description: 
 email: rdblue@gmail.com
 executables: []
@@ -29,21 +51,23 @@ extensions: []
 extra_rdoc_files:
 - README
 files:
-- lib/svn/misc.rb
-- lib/svn/pools.rb
-- lib/svn/apr_utils.rb
-- lib/svn/diffs.rb
+- lib/svn.rb
+- lib/svn/roots.rb
+- lib/svn/repos.rb
 - lib/svn/utils.rb
+- lib/svn/revisions.rb
+- lib/svn/diffs.rb
 - lib/svn/transactions.rb
 - lib/svn/logs.rb
-- lib/svn/roots.rb
-- lib/svn/repos.rb
 - lib/svn/streams.rb
-- lib/svn/errors.rb
-- lib/svn/revisions.rb
 - lib/svn/counted_strings.rb
-- lib/svn.rb
+- lib/svn/misc.rb
+- lib/svn/errors.rb
+- lib/svn/apr_utils.rb
+- lib/svn/pools.rb
 - README
+- spec/repo_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/codefoundry/svn
 licenses: []
 post_install_message: 
@@ -64,8 +88,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Ruby bindings for SVN based on FFI
-test_files: []
+summary: Ruby bindings for subversion (SVN) based on FFI
+test_files:
+- spec/repo_spec.rb
+- spec/spec_helper.rb