Class: SvnFixture::File

Inherits:
Object
  • Object
show all
Defined in:
lib/svn-fixture/file.rb

Overview

A File to be added to or edited within the Repository. Normally, this would done through Directory#file, in a block given to a Directory or Revision, for example:

SvnFixture.repo('repo_name') do
  revision(1, 'msg') do
    file('file.txt') do
      prop('name', 'value')
      body('Some Text')
    end
  end
end

In that case, Revision takes care of passing the ctx argument.

To call SvnFixture::File.new directly, you will need to set up a context (instance of Svn::Client::Context) and check out a working copy. SvnFixture.simple_context is a quick method for settin up a Context.

Assuming an existing checked out working copy:

ctx = SvnFixture.simple_context
f = SvnFixture::File.new(ctx, '/full/fs/path/to/file.txt')
f.prop('propname', 'Value')

Or, call #checkout on Context:

ctx = SvnFixture.simple_context
ctx.checkout('file:///repository/uri', '/fs/path/of/wc')
f = SvnFixture::File.new(ctx, '/full/fs/path/to/file.txt')
f.prop('propname', 'Value')

Direct Known Subclasses

Directory

Instance Method Summary collapse

Constructor Details

#initialize(ctx, path) ⇒ File

new is normally called through Directory#file (a block to a Revision is applied to the root Directory).

Arguments are:

  • ctx: An Svn::Client::Context, normally from Repository#ctx

  • path: The path (on the file system) of the File in the working copy



41
42
43
44
 
# File 'lib/svn-fixture/file.rb', line 41

def initialize(ctx, path)
  @ctx, @path = ctx, path
  @clean_path = path # Path without a trailing slash. Used by methods shared with Directory
end

Instance Method Details

#body(val) ⇒ Object

Set the content of a file



96
97
98
 
# File 'lib/svn-fixture/file.rb', line 96

def body(val)
  ::File.open(@path, 'w') { |f| f.write(val) }
end

#prop(name, value) ⇒ Object

Set a property for the file (see svnbook.red-bean.com/en/1.1/ch07s02.html):

  • name: The property name (must be “human-readable text”)

  • value: The value of the property.



50
51
52
 
# File 'lib/svn-fixture/file.rb', line 50

def prop(name, value)
  @ctx.propset(name, SvnFixture.svn_prop(value), @path)
end

#propdel(name) ⇒ Object

Remove a property from the directory

Parameters

name<String>

The property name



58
59
60
 
# File 'lib/svn-fixture/file.rb', line 58

def propdel(name)
  @ctx.propdel(name, @clean_path)
end

#props(hsh) ⇒ Object

Set all properties from a hash, deleting any existing that are not included in the hash. “svn:entry” properties are ignored, as these are handled internally by Subversion.

Parameters

hsh<Hash>

Properties to set (name => value)



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/svn-fixture/file.rb', line 68

def props(hsh)
  # Getting the proplist for a node that hasn't been committed doesn't
  # seem to work. This isn't a problem (there's no existing props to delete)
  # so just skip those.
  skip_deletes = false
  @ctx.status(@clean_path) do |path, status|
    skip_deletes = true if @clean_path == path && status.entry.add?
  end
  
  # Delete any that aren't in hash
  unless skip_deletes
    url = @ctx.url_from_path(@clean_path)
    existing = @ctx.proplist(@clean_path).find { |pl| pl.name == url }
    
    if existing
      existing.props.each_pair do |k, v|
        propdel(k) unless (hsh[k] || k =~ /\Asvn:entry/)
      end
    end
  end
  
  # Set props (except svn:entry)
  hsh.each do |k, v|
    prop(k, v) unless k =~ /\Asvn:entry/
  end
end