svn-transform 0.1.0

data/examples/svn-transform/dir_example.rb

@@ -0,0 +1,56 @@
+require 'example_helper'
+
+describe SvnTransform::Dir do
+  before(:each) do
+    @dir = SvnTransform::Dir.example
+  end
+  
+  describe '#initialize' do
+    it 'should set #path' do
+      @dir.path.should be_kind_of(Pathname)
+      @dir.path.to_s.should == '/path/to/dir'
+    end
+    
+    it 'should set #entries (extracted from node_data)' do
+      @dir.entries.should == {'entry.txt' => nil}
+    end
+    
+    it 'should set #repos' do
+      @dir.repos.should == :repos # Actually, a Svn::Ra::Session
+    end
+    
+    it 'should set #fixture_dir' do
+      @dir.fixture_dir.should == :fixture_dir # Actually, a SvnFixture::Directory
+    end
+    
+    it 'should set #properties (extracted from node_data)' do
+      @dir.properties.should == {'prop:svn' => 'property value'}
+    end
+    
+    it 'should set #rev_num' do
+      @dir.rev_num.should == 10
+    end
+    
+    it 'should set #rev_props' do
+      @dir.rev_props.should == {'svn:author' => 'me'}
+    end
+  end
+  
+  describe '#basename' do
+    it 'should return the basename of the path' do
+      @dir.basename.should == 'dir'
+    end
+  end
+  
+  describe '#properties=' do
+    it "should reject an Argument that doesn't respond to #each_pair" do
+      lambda { @dir.properties = 'properties' }.should raise_error(ArgumentError)
+      @dir.properties.should == {'prop:svn' => 'property value'}
+    end
+    
+    it 'should set @properties' do
+      @dir.properties = {'diffprop' => 'value'}
+      @dir.properties.should == {'diffprop' => 'value'}
+    end
+  end
+end

data/examples/svn-transform/file_example.rb

@@ -0,0 +1,71 @@
+require 'example_helper'
+
+describe SvnTransform::File do
+  before(:each) do
+    @file = SvnTransform::File.example
+  end
+  
+  describe '#initialize' do
+    it 'should set #path' do
+      @file.path.should be_kind_of(Pathname)
+      @file.path.to_s.should == '/path/to/file.txt'
+    end
+    
+    it 'should set #body (extracted from node_data)' do
+      @file.body.should == 'body of file'
+    end
+    
+    it 'should set #properties (extracted from node_data)' do
+      @file.properties.should == {'prop:svn' => 'property value'}
+    end
+    
+    it 'should set #rev_num' do
+      @file.rev_num.should == 10
+    end
+    
+    it 'should set #rev_props' do
+      @file.rev_props.should == {'svn:author' => 'me'}
+    end
+  end
+  
+  describe '#basename' do
+    it 'should return the basename of the path' do
+      @file.basename.should == 'file.txt'
+    end
+  end
+  
+  describe '#basename=' do
+    it 'should update the path' do
+      @file.basename = 'app.exe'
+      @file.path.should == Pathname.new('/path/to/app.exe')
+      @file.basename.should == 'app.exe'
+    end
+  end
+  
+  describe '#body=' do
+    it 'should set @body' do
+      @file.body = 'new body'
+      @file.body.should == 'new body'
+    end
+  end
+  
+  describe '#properties=' do
+    it "should reject an Argument that doesn't respond to #each_pair" do
+      lambda { @file.properties = 'properties' }.should raise_error(ArgumentError)
+      @file.properties.should == {'prop:svn' => 'property value'}
+    end
+    
+    it 'should set @properties' do
+      @file.properties = {'diffprop' => 'value'}
+      @file.properties.should == {'diffprop' => 'value'}
+    end
+  end
+  
+  describe '#skip!' do
+    it 'should set #skip? to true' do
+      @file.skip?.should be_false
+      @file.skip!
+      @file.skip?.should be_true
+    end
+  end
+end

data/examples/svn-transform/transform/extension_example.rb

@@ -0,0 +1,48 @@
+require 'example_helper'
+
+describe SvnTransform::Transform::Extension do
+  before(:each) do
+    @file = SvnTransform::File.example
+    @klass = SvnTransform::Transform::Extension
+    @transform = @klass.new(@file, {:txt => :markdown})
+  end
+  
+  describe '#initialize' do
+    it 'should set @file' do
+      @transform.instance_variable_get(:@file).should be(@file)
+    end
+    
+    it 'should set @extensions (as strings preceded with dot)' do
+      @transform.instance_variable_get(:@extensions).should == {".txt" => ".markdown"}
+    end
+  end
+  
+  describe '#run' do
+    it 'should return false if no changes made' do
+      @file.basename = 'file.other'
+      @transform.run.should be_false
+      @file.basename.should == 'file.other'
+    end
+    
+    it 'should return true and update @file.basename if changes made' do
+      @file.basename = 'file.txt'
+      @transform.run.should be_true
+      @file.basename.should == 'file.markdown'
+    end
+    
+    it 'should process multiple extension options' do
+      @transform = @klass.new(@file, {:txt => :markdown, :ruby => :rb})
+      @file.basename = 'file.txt'
+      @transform.run.should be_true
+      @file.basename.should == 'file.markdown'
+      
+      @file.basename = 'file.ruby'
+      @transform.run.should be_true
+      @file.basename.should == 'file.rb'
+      
+      @file.basename = 'file'
+      @transform.run.should be_false
+      @file.basename.should == 'file'
+    end
+  end
+end

data/examples/svn-transform/transform/newline_example.rb

@@ -0,0 +1,51 @@
+require 'example_helper'
+
+describe SvnTransform::Transform::Newline do
+  before(:each) do
+    @file = SvnTransform::File.example
+    @klass = SvnTransform::Transform::Newline
+    @transform = @klass.new(@file, "<br \/>\n")
+  end
+  
+  describe '#initialize' do
+    it 'should set @file' do
+      @transform.instance_variable_get(:@file).should be(@file)
+    end
+    
+    it 'should set @newline' do
+      @transform.instance_variable_get(:@newline).should == "<br \/>\n"
+      @klass.new(@file).instance_variable_get(:@newline).should == "\n"
+    end
+  end
+  
+  describe '#all_to_lf' do
+    it 'should convert CRs and CRLFs to LFs' do
+      str = "\nabc\r\n\n\rdef\r\rghi\r\n\r\n\njkl\r"
+      @transform.__send__(:all_to_lf, str).should ==
+          "\nabc\n\n\ndef\n\nghi\n\n\njkl\n"
+    end
+  end
+  
+  describe '#run' do
+    it 'should return false if no changes made' do
+      input = "\r\nabc\r\n"
+      @file.body = input
+      @klass.new(@file, @klass::CRLF).run.should be_false
+      @file.body.should be(input)
+    end
+    
+    it 'should return true and update @file.body if changes made' do
+      input = "\r\nabc\r\n"
+      @file.body = input
+      @klass.new(@file).run.should be_true
+      @file.body.should == "\nabc\n"
+    end
+    
+    it 'should replace all newlines with @newline' do
+      input = "\r\nabc\r\n\n\n\r"
+      @file.body = input
+      @klass.new(@file, "NL").run.should be_true
+      @file.body.should == "NLabcNLNLNLNL"
+    end
+  end
+end

data/examples/svn-transform/transform/noop_example.rb

@@ -0,0 +1,15 @@
+require 'example_helper'
+
+describe SvnTransform::Transform::Noop do
+  before(:each) do
+    @file = SvnTransform::File.example
+  end
+  
+  it 'should do nothing' do
+    untouched = SvnTransform::File.example
+    SvnTransform::Transform::Noop.new(@file).run.should be_false
+    @file.body.should == untouched.body
+    @file.basename.should == untouched.basename
+    @file.properties.should == untouched.properties
+  end
+end

data/examples/svn-transform/transform/props_to_yaml_example.rb

@@ -0,0 +1,137 @@
+require 'example_helper'
+
+describe SvnTransform::Transform::PropsToYaml do
+  before(:each) do
+    @klass = SvnTransform::Transform::PropsToYaml
+    @file = SvnTransform::File.example
+    @file.body = "Body Only\n"
+    @file.properties = {'title' => 'Hello', 'prop:one' => 'o', 'prop:two' => 't'}
+  end
+  
+  describe '#run (file)' do
+    it 'should move all if instruction is :all' do
+      @klass.new(@file, :all).run.should be_true
+      @file.body.should == "--- \ntitle: Hello\nprop:two: t\nprop:one: o\n---\n\nBody Only\n"
+      @file.properties.should == {}
+    end
+    
+    it 'should add to existing Yaml props' do
+      @file.body = "--- \nnewprop: hi\n---\n\nBody Only\n"
+      @klass.new(@file, :all).run.should be_true
+      @file.body.should == "--- \ntitle: Hello\nprop:two: t\nnewprop: hi\nprop:one: o\n---\n\nBody Only\n"
+      @file.properties.should == {}
+      
+      @file.body = "---\nnewprop: hi\n...\nBody Only\n"
+      @file.properties = {'title' => 'Hello', 'prop:one' => 'o', 'prop:two' => 't'}
+      @klass.new(@file, :all).run.should be_true
+      @file.body.should == "--- \ntitle: Hello\nprop:two: t\nnewprop: hi\nprop:one: o\n---\n\nBody Only\n"
+      @file.properties.should == {}
+    end
+    
+    it 'should override existing Yaml props that conflict with Svn props' do
+      @file.body =  "---\nnewprop: hi\ntitle: World\n...\nBody Only\n"
+      @klass.new(@file, :all).run.should be_true
+      @file.body.should == "--- \ntitle: Hello\nprop:two: t\nnewprop: hi\nprop:one: o\n---\n\nBody Only\n"
+    end
+    
+    it 'should match a string' do
+      @klass.new(@file, [['title', 'newtitle']]).run.should be_true
+      @file.body.should == "--- \nnewtitle: Hello\n---\n\nBody Only\n"
+      @file.properties.should == {'prop:one' => 'o', 'prop:two' => 't'}
+    end
+    
+    it 'should match a regex' do
+      @klass.new(@file, [[/\Aprop:(.*)\Z/, 'p-\1']]).run.should be_true
+      @file.body.should == "--- \np-two: t\np-one: o\n---\n\nBody Only\n"
+      @file.properties.should == {'title' => 'Hello'}
+    end
+    
+    it 'should move props' do
+      @klass.new(@file, [[/prop/, :move]]).run.should be_true
+      @file.body.should == "--- \nprop:two: t\nprop:one: o\n---\n\nBody Only\n"
+      @file.properties.should == {'title' => 'Hello'}
+    end
+    
+    it 'should delete props' do
+      @klass.new(@file, [[/prop/, :delete]]).run.should be_true
+      @file.body.should == "Body Only\n"
+      @file.properties.should == {'title' => 'Hello'}
+    end
+    
+    it 'should not add empty yaml to body' do
+      @klass.new(@file, [['nothing', :move]]).run.should be_false
+      @file.body.should == "Body Only\n"
+      @file.properties.should == {'title' => 'Hello', 'prop:one' => 'o', 'prop:two' => 't'}
+    end
+    
+    it 'should return false if nothing happens' do
+      @klass.new(@file, [['nothing', :move]]).run.should be_false
+      @file.body.should == "Body Only\n"
+      @file.properties.should == {'title' => 'Hello', 'prop:one' => 'o', 'prop:two' => 't'}
+    end
+    
+    it 'should handle multiple instructions' do
+      @file.body = "---\ntitle: Hello\nyaml_only: yaml\n---\nBody Only\n"
+      @file.properties = {'ws:title' => 'Hello World', 'ws:published' => 'y', 'ws:tags' => 'this; that'}
+      @klass.new(@file, [['ws:tags', 'topics'], [/\Aws:(.*)\Z/, '\1']]).run.should be_true
+      @file.body.should == "--- \ntitle: Hello World\npublished: y\ntopics: this; that\nyaml_only: yaml\n---\n\nBody Only\n"
+      @file.properties.should == {}
+    end
+  end
+  
+  describe '#run (directory)' do
+    # The best way I can see to test this is just run a full example.
+    it 'should move properties to YAML file' do
+      load 'fixtures/dir_props.rb'
+      in_repo = SvnFixture.repo('dir_props')
+      transform = SvnTransform.new(in_repo.uri, 'dir_props_out')
+      transform.dir_transform(@klass, :all)
+      transform.convert
+      
+      out_sess = SvnTransform::Session.new(SvnFixture.repo('dir_props_out').uri)
+      repo = out_sess.session
+      repo.stat('noprops/meta.yml', 1).should be_nil
+      
+      repo.dir('svnprops', 1)[1]['one'].should be_nil
+      repo.dir('svnprops', 1)[1]['two'].should be_nil
+      repo.stat('svnprops/meta.yml', 1).should_not be_nil
+      repo.file('svnprops/meta.yml', 1)[0].should == "--- \ntwo: t\none: o\n"
+      
+      repo.dir('yamlprops', 1)[1]['one'].should be_nil
+      repo.dir('yamlprops', 1)[1]['two'].should be_nil
+      repo.file('yamlprops/meta.yml', 1)[0].should == "---\none: yaml\n"
+      
+      repo.dir('bothprops', 1)[1]['one'].should be_nil
+      repo.dir('bothprops', 1)[1]['two'].should be_nil
+      repo.file('bothprops/meta.yml', 1)[0].should == "--- \ntwo: yaml\none: o\n"
+      
+      SvnFixture.repo('dir_props').destroy
+      SvnFixture.repo('dir_props_out').destroy
+    end
+  end
+  
+  describe 'yaml_split' do
+    def get_split
+      @klass.new(@file, :all).__send__(:yaml_split)[1]
+    end
+    
+    it 'should split out yaml (end with ---)' do
+      @file.body = "---\none: two\nthree: four\n---\n\nBody"
+      get_split.should == 'Body'
+    end
+    
+    it 'should remove yaml (end with ...)' do
+      @file.body = "---\none: two\nthree: four\n...\n\nBody"
+      get_split.should == 'Body'
+    end
+    
+    it 'should handle newlines well' do
+      @file.body = "---\r\none: two\r\nthree: four\r\n---\r\n\r\nBody"
+      get_split.should == 'Body'
+      @file.body = "--- \r\none: two\r\nthree: four\r\n\n---\r\n\r\n\n\nBody"
+      get_split.should == 'Body'
+      @file.body = "---     \n\none: two\nthree: four\n\n...\n\nBody"
+      get_split.should == 'Body'
+    end
+  end
+end

data/examples/svn-transform_example.rb

@@ -0,0 +1,148 @@
+require 'example_helper'
+
+describe "SvnTransform" do
+  describe '#convert' do
+    it 'should make full conversion correctly' do
+      SvnFixture::Repository.instance_variable_set(:@repositories, {})
+      load File.dirname(__FILE__) + '/fixtures/original.rb'
+      load File.dirname(__FILE__) + '/fixtures/result.rb'
+      in_repo = SvnFixture.repo('original')
+      # Update rev 0 date in result
+      r0_date = in_repo.ctx.revprop_list(in_repo.uri, 0)[0]['svn:date']
+      SvnFixture.repo('result').repos.fs.set_prop('svn:date', SvnFixture.svn_time(r0_date), 0)
+      
+      @transform = SvnTransform.new(in_repo.uri, 'transformed')
+      
+      @transform.file_transform(
+        SvnTransform::Transform::PropsToYaml,
+        [['ws:tags', 'topics'], [/\Aws:(.*)\Z/, '\1']]
+      )
+      @transform.dir_transform(
+        SvnTransform::Transform::PropsToYaml,
+        [['ws:tags', 'topics'], [/\Aws:(.*)\Z/, '\1']]
+      )
+      @transform.file_transform(
+        SvnTransform::Transform::Newline
+      )
+      @transform.file_transform(
+        SvnTransform::Transform::Extension,
+        :txt => :md
+      )
+      
+      @transform.convert
+      SvnTransform.compare(SvnFixture.repo('result').repos_path, SvnFixture.repo('transformed').repos_path).should be_true
+      SvnFixture.repo('original').destroy
+      SvnFixture.repo('result').destroy
+      SvnFixture.repo('transformed').destroy
+    end
+  end
+  
+  describe 'direct copy' do
+    it 'should make a MOL copy' do
+      SvnFixture::Repository.instance_variable_set(:@repositories, {})
+      load File.dirname(__FILE__) + '/fixtures/original.rb'
+      in_repo = SvnFixture.repo('original')
+      SvnTransform.new(in_repo.uri, 'directcopy').convert
+      SvnTransform.compare(in_repo.repos_path, SvnFixture.repo('directcopy').repos_path).should be_true
+      SvnFixture.repo('original').destroy
+      SvnFixture.repo('directcopy').destroy
+    end
+  end
+  
+  describe '#file_transform' do
+    before(:each) do
+      @svn_t = SvnTransform.new('in', 'out')
+      @svn_t.file_transform(Object)
+    end
+    
+    it 'should add a [Class, args] Array to the @file_transforms Array' do
+      @svn_t.file_transform(Class, 'a', 1)
+      @svn_t.instance_variable_get(:@file_transforms).should ==
+          [[Object, []], [Class, ['a', 1]]]
+    end
+    
+    it 'should add a block to the @file_transforms Array' do
+      @svn_t.file_transform { |file| p file }
+      @svn_t.instance_variable_get(:@file_transforms)[1].should be_kind_of(Proc)
+    end
+    
+    it 'should raise an Error if neither is provided' do
+      lambda { @svn_t.file_transform }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '#process_file_transforms' do
+    before(:each) do
+      @svn_t = SvnTransform.new('in', 'out')
+      @file = SvnTransform::File.example
+      
+      @klass = Class.new do
+        def initialize(file, arg1 = nil, arg2 = nil)
+          @file = file
+          @arg1 = arg1
+          @arg2 = arg2
+        end
+        def run
+          if @arg2
+            @file.body += " #{@arg2}"
+          else
+            @file.body = "body from transform Class"
+          end
+        end
+      end
+    end
+    
+    it 'should run +file+ through each file_transform' do
+      @svn_t.file_transform do |file|
+        file.properties['other'] = 'other_val'
+      end
+      @svn_t.file_transform(@klass)
+      @svn_t.file_transform(@klass, 'ARG1', 'ARG2')
+      @svn_t.__send__(:process_file_transforms, @file)
+      
+      @file.body.should == 'body from transform Class ARG2'
+      @file.properties.should ==
+          {'prop:svn' => 'property value', 'other' => 'other_val'}
+    end
+  end
+  
+  describe '#dir_transform' do
+    before(:each) do
+      @svn_t = SvnTransform.new('in', 'out')
+      @svn_t.dir_transform(Object)
+    end
+    
+    it 'should add a [Class, args] Array to the @dir_transforms Array' do
+      @svn_t.dir_transform(Class, 'a', 1)
+      @svn_t.instance_variable_get(:@dir_transforms).should ==
+        [[Object, []], [Class, ['a', 1]]]
+    end
+    
+    it 'should add a block to the @dir_transforms Array' do
+      @svn_t.dir_transform { |dir| p dir }
+      @svn_t.instance_variable_get(:@dir_transforms)[1].should be_kind_of(Proc)
+    end
+    
+    it 'should raise an Error if neither is provided' do
+      lambda { @svn_t.dir_transform }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '#process_dir_transforms' do
+    before(:each) do
+      @svn_t = SvnTransform.new('in', 'out')
+      @dir = SvnTransform::Dir.example
+    end
+  
+    it 'should run +dir+ through each dir_transform' do
+      @svn_t.dir_transform do |dir|
+        dir.properties['other'] = 'other_val'
+      end
+      
+      @svn_t.__send__(:process_dir_transforms, @dir)
+      
+      @dir.properties.should ==
+         {'prop:svn' => 'property value', 'other' => 'other_val'}
+    end
+  end
+end