svn-transform 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jared E. Morgan
+
+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/README.rdoc

@@ -0,0 +1,101 @@
+= svn-transform
+
+SvnTransform allows you to recreate a Subversion repository, and make some 
+changes to it in the process. It is particularly designed to allow altering
+the content, properties or name of files; changes at the directory level are
+possible but more likely to cause errors.
+
+The library seems to be working for my purposes, but the more moves, deletes,
+copies, etc involved, the more likely this is to just miss something. In other
+words, don't just throw out the old repository; you may need it.
+
+== Use cases
+
+Some reasons you might want to use SvnTransform:
+
+1. Change file extensions to suit a particular library (.txt to .markdown; See
+   Transforms::Extension)
+2. Move Subversion properties on files to YAML at the beginning of the file
+   (See Transforms::PropsToYaml), for example, before migrating to git.
+3. Change Windows style newlines to Unix style throughout repository history
+   (See Transforms::Newline)
+4. Remove a password from a file.
+5. Create a new repository based on another repo to which you have read but not 
+   write and/or admin access (keep the full history of an abandoned project).
+
+== Usage
+
+The simplest case is a copy without any transformations:
+
+    require 'svn-transform'
+    transform = SvnTransform.new('svn://example.com/existing_repo', 'my_copy')
+    transform.convert
+
+SvnTransform includes a method for comparing two repositories on the local 
+filesystem (it just runs a recursive diff with some options):
+
+    SvnTransform.compare('/path/to/existing', '/path/to/new')
+
+I recommend (where reasonable) before you run a real transform, run a direct 
+copy, followed by .compare, as it might alert you that there's something about 
+the particular repository that SvnTransform may not handle well. There's a few 
+things to be aware of here:
+
+- Subversion svn:entry properties (or some portion of them) seem to be affected
+  by the past history of the repository, so one difference can produce a lot
+  of differences in the repository.
+- Folder structures may be different depending on the version of Subversion
+  running when the existing repo was created versus the conversion.
+
+A basic copy can be useful, but the key element of SvnTransform is the ability
+to make (some) changes throughout the entire history. A transform can be either
+be a class or a block. Each file (or directory), at each revision where it is 
+modified in some way, is given as an SvnTransform::File (or 
+SvnTransform::Dir) to each transform, which can alter the basename, body 
+and/or properties of the file prior to its being committed to the new 
+Repository.
+
+- A class should have an #initialize method which accepts a SvnTransform::File 
+  (or Dir) as the first argument and which responds to #run.
+- A block that accepts one argument (a SvnTransform::File or Dir).
+
+See SvnTransform::File or SvnTransform::Dir for the methods available,
+which include various metadata about the node/revision and the ability to make
+changes prior to the commit.
+
+Use either SvnTransform#file_transform or #dir_transform to add the transform
+(they are processed in order added).
+
+Several Transform classes are included (see classes in the SvnTransform::Transform
+module). Below is an example using the Transform::Extension class and a block.
+
+    transform = SvnTransform.new('file:///svn/myrepo', 'transformed_repo')
+    transform.file_transform(SvnTransform::Transform::Extension, {:md => :markdown})
+    transform.file_transform do |file|
+      # Add leading newline to files name "newline.rb"
+      if 'newline.rb' == file.basename
+        file.body = "\n" + file.body
+      end
+    end
+    transform.convert
+
+== Installation
+
+Gem is hosted on gemcutter (http://gemcutter.org)
+
+    gem install svn-transform
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jared E. Morgan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "svn-transform"
+    gem.summary = %Q{Copy Subversion repository, with the ability to alter files}
+    gem.description = <<EOF
+Given a Subversion repository, svn-transform creates a new repo that is by 
+default identical, but allows changes to files, for example all or some of the 
+properties on each file can be moved from the properties to YAML prepended to 
+the body of the file. Primarily useful prior to conversions to other repository 
+types such as git.
+EOF
+    gem.email = "jmorgan@morgancreative.net"
+    gem.homepage = "http://github.com/jm81/svn-props-to-yaml"
+    gem.authors = ["Jared Morgan"]
+    gem.add_dependency('svn-fixture', '= 0.2.0')
+    gem.add_development_dependency "spicycode-micronaut"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'micronaut/rake_task'
+Micronaut::RakeTask.new(:examples) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.ruby_opts << '-rrubygems -Ilib -Iexamples'
+end
+
+Micronaut::RakeTask.new(:rcov) do |examples|
+  examples.pattern = 'examples/**/*_example.rb'
+  examples.rcov_opts = '-rrubygems -Ilib -Iexamples'
+  examples.rcov = true
+end
+
+task :examples => :check_dependencies
+
+task :default => :examples
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "svn-props-to-yaml #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/example_helper.rb

@@ -0,0 +1,31 @@
+require 'micronaut'
+require 'svn-transform'
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+Micronaut.configure do |c|
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+end
+
+def (SvnTransform::File).example
+  SvnTransform::File.new(
+    '/path/to/file.txt', # Actually a Pathname
+    ['body of file', {'prop:svn' => 'property value'}],
+    10,
+    {'svn:author' => 'me'}
+  )
+end
+
+def (SvnTransform::Dir).example
+  SvnTransform::Dir.new(
+    '/path/to/dir', # Actually a Pathname
+    [{'entry.txt' => nil}, {'prop:svn' => 'property value'}],
+    10,
+    {'svn:author' => 'me'},
+    :repos, # Actually a Svn::Ra::Session
+    :fixture_dir
+  )
+end

data/examples/fixtures/dir_props.rb

@@ -0,0 +1,29 @@
+# For text PropsToYaml for Directories
+
+SvnFixture.repo('dir_props') do
+  revision(1, 'create dirs') do
+    dir 'noprops'
+    
+    dir 'svnprops' do
+      prop 'one', 'o'
+      prop 'two', 't'
+    end
+    
+    dir 'yamlprops' do
+      file 'meta.yml' do
+        body "---\none: yaml\n"
+      end
+    end
+    
+    dir 'bothprops' do
+      prop 'one', 'o'
+      
+      file 'meta.yml' do
+        body "---\none: yaml\ntwo: yaml"
+      end
+    end
+  end
+  
+end
+
+SvnFixture.repo('dir_props').commit

data/examples/fixtures/original.rb

@@ -0,0 +1,86 @@
+# Original repository for conversion
+
+SvnFixture.repo('original') do
+  revision(1, 'Create articles directory',
+           :date => Time.parse("2009-01-01")) do
+    dir 'articles'
+  end
+  
+  revision 2, 'Create articles about computers and philosophy', :date => '2009-01-02' do
+    dir 'articles' do
+      prop 'ws:title', 'Articles'
+      
+      file 'philosophy.txt' do
+        prop 'ws:title', 'Philosophy'
+        prop 'ws:published_at', '2009-07-01 12:00:00'
+        body 'My philosophy is to eat a lot of salsa!'
+      end
+      
+      file 'computers.txt' do
+        prop 'ws:title', 'Computers'
+        prop 'ws:published_at', '2009-07-01 12:00:00'
+        body 'Computers do not like salsa so much.'
+      end
+    end
+  end
+  
+  revision 3, 'Change text of articles, with different newline styles', :author => "author", :date => '2009-01-03' do
+    dir 'articles' do
+      file 'philosophy.txt' do
+        body "My philosophy is \n\nto eat a lot of salsa!\n"
+      end
+      
+      file 'computers.txt' do
+        body "Computers do not \r\n\r\nlike salsa so much."
+      end
+    
+      file 'old-apple.txt' do
+        body "One line.\r  Two line.\r"
+      end
+    end
+  end
+  
+  revision 4, 'Add some YAML props', :date => '2009-01-04' do
+    dir 'articles' do
+      file 'philosophy.txt' do
+        body "---\ntitle: New Philosophy\n---\n\nMy philosophy is \n\nto eat a lot of salsa!\n"
+      end
+      
+      file 'computers.txt' do
+        body "---\r\neol: CRLF\r\n\---\r\n\r\ncomputers do not \r\nlike salsa so much."
+      end
+    end
+  end
+  
+  revision 5, 'Add a directory property', :date => '2009-01-05' do
+    dir 'articles' do
+      prop 'ws:name', 'Articles'
+    end
+  end
+  
+  revision 6, 'Add property with different prefix', :date => '2009-01-06' do
+    dir 'articles' do
+      file 'computers.txt' do
+        prop 'alt:title', 'Computers'
+      end
+    end
+  end
+  
+  revision 7, 'Moves and copies', :date => '2009-01-07' do
+    dir 'articles' do
+      move 'philosophy.txt', 'phil.txt'
+      copy 'computers.txt', 'computations.txt'
+    end
+  end
+  
+  revision 8, 'Revise properties', :date => '2009-01-08' do
+    dir 'articles' do
+      file 'computers.txt' do
+        prop 'ws:published_at', '2009-08-01 12:00:00'
+        prop 'alt:title', 'Computers'
+      end
+    end
+  end
+end
+
+SvnFixture.repo('original').commit

data/examples/fixtures/result.rb

@@ -0,0 +1,105 @@
+=begin
+Expected result. Transform are
+@transform.file_transform(
+  SvnTransform::Transform::PropsToYaml,
+  [['ws:tags', 'topics'], [/\Aws:(.*)\Z/, '\1']]
+)
+@transform.dir_transform(
+  SvnTransform::Transform::PropsToYaml,
+  [['ws:tags', 'topics'], [/\Aws:(.*)\Z/, '\1']] # TODO tags aren't tested
+)
+@transform.file_transform(
+  SvnTransform::Transform::Newline
+)
+@transform.file_transform(
+  SvnTransform::Transform::Extension,
+  :txt => :md
+)
+=end
+
+SvnFixture.repo('result') do
+  revision(1, 'Create articles directory',
+           :date => Time.parse("2009-01-01")) do
+    dir 'articles'
+  end
+  
+  revision 2, 'Create articles about computers and philosophy', :date => '2009-01-02' do
+    dir 'articles' do
+      file 'meta.yml' do
+        body "--- \ntitle: Articles\n"
+      end
+      
+      file 'philosophy.md' do
+        body "--- \ntitle: Philosophy\npublished_at: 2009-07-01 12:00:00\n\---\n\nMy philosophy is to eat a lot of salsa!"
+      end
+      
+      file 'computers.md' do
+        body "--- \ntitle: Computers\npublished_at: 2009-07-01 12:00:00\n---\n\nComputers do not like salsa so much."
+      end
+    end
+  end
+  
+  revision 3, 'Change text of articles, with different newline styles', :author => "author", :date => '2009-01-03' do
+    dir 'articles' do
+      file 'philosophy.md' do
+        body "--- \ntitle: Philosophy\npublished_at: 2009-07-01 12:00:00\n\---\n\nMy philosophy is \n\nto eat a lot of salsa!\n"
+      end
+      
+      file 'computers.md' do
+        body "--- \ntitle: Computers\npublished_at: 2009-07-01 12:00:00\n---\n\nComputers do not \n\nlike salsa so much."
+      end
+    
+      file 'old-apple.md' do
+        body "One line.\n  Two line.\n"
+      end
+    end
+  end
+  
+  revision 4, 'Add some YAML props', :date => '2009-01-04' do
+    dir 'articles' do
+      file 'philosophy.md' do
+        # Subversion property overrides new yaml prop (TODO is this ideal?)
+        body "--- \ntitle: Philosophy\npublished_at: 2009-07-01 12:00:00\n---\n\nMy philosophy is \n\nto eat a lot of salsa!\n"
+      end
+      
+      file 'computers.md' do
+        body "--- \ntitle: Computers\neol: CRLF\npublished_at: 2009-07-01 12:00:00\n---\n\ncomputers do not \nlike salsa so much."
+      end
+    end
+  end
+  
+  revision 5, 'Add a directory property', :date => '2009-01-05' do
+    dir 'articles' do
+      file 'meta.yml' do
+        body "--- \nname: Articles\ntitle: Articles\n"
+      end
+    end
+  end
+  
+  revision 6, 'Add property with different prefix', :date => '2009-01-06' do
+    dir 'articles' do
+      file 'computers.md' do
+        prop 'alt:title', 'Computers'
+        body "--- \ntitle: Computers\neol: CRLF\npublished_at: 2009-07-01 12:00:00\n---\n\ncomputers do not \nlike salsa so much."
+      end
+    end
+  end
+  
+  revision 7, 'Moves and copies', :date => '2009-01-07' do
+    dir 'articles' do
+      move 'philosophy.md', 'phil.md'
+      copy 'computers.md', 'computations.md'
+    end
+  end
+  
+  revision 8, 'Revise properties', :date => '2009-01-08' do
+    dir 'articles' do
+      file 'computers.md' do
+        prop 'alt:title', 'Computers'
+        body "--- \ntitle: Computers\neol: CRLF\npublished_at: 2009-08-01 12:00:00\n---\n\ncomputers do not \nlike salsa so much."
+      end
+    end
+  end
+end
+
+SvnFixture.repo('result').commit