svn-transform 0.1.0

data/lib/svn-transform/transform/extension.rb

@@ -0,0 +1,41 @@
+class SvnTransform
+  module Transform
+    # Convert file extensions
+    class Extension
+      # Initialize Extension Transform.
+      #
+      # ==== Parameters
+      # file<SvnTransform::File>:: File at a given revision
+      # extensions<~each_pair>:: A Hash of old => new extension
+      # 
+      # ==== Example
+      #
+      #    SvnTransform::Transform::Extension.new(@file,
+      #      {:txt => :markdown, :ruby => :rb}
+      #    )
+      # 
+      def initialize(file, extensions)
+        @file = file
+        @extensions = {}
+        (extensions || {}).each_pair do |existing, change_to|
+          @extensions[".#{existing}"] = ".#{change_to}"
+        end
+      end
+      
+      # Check if this @file has one of the extensions (matches a key). If so,
+      # change its extension.
+      #
+      # ==== Returns
+      # True, False:: indicating whether a change was made.
+      def run
+        @extensions.each_pair do |existing, change_to|
+          if @file.path.extname == existing
+            @file.basename = @file.basename.gsub(/#{existing}\Z/, change_to)
+            return true
+          end
+        end
+        return false
+      end
+    end
+  end
+end

data/lib/svn-transform/transform/newline.rb

@@ -0,0 +1,50 @@
+class SvnTransform
+  module Transform
+    # Transform all newlines to use a given sequence. For example, a repository
+    # some files using CRLF and some using LF could be transformed so that all
+    # files through all revisions use LF.
+    class Newline
+      LF = "\n"
+      CRLF = "\r\n"
+      CR = "\r"
+      
+      # Initialize Newline Transform.
+      #
+      # ==== Parameters
+      # file<SvnTransform::File>:: File at a given revision
+      # newline<String>:: What to replace newlines with (defaults to \n)
+      def initialize(file, newline = LF)
+        @file = file
+        @newline = newline
+      end
+      
+      # Run the transform. It first converts all newlines (LF, CRLF and CR) to
+      # LF, then replaces LF if needed.
+      #
+      # ==== Returns
+      # True, False:: indicating whether a change was made.
+      def run
+        body = @file.body.dup
+        # Replace CR and CRLF
+        body = all_to_lf(body)
+        # Replace LFs with newline if needed
+        body.gsub!(LF, @newline) unless LF == @newline
+        
+        if body != @file.body
+          @file.body = body
+          return true
+        else
+          return false
+        end
+      end
+      
+      private
+      
+      # Ensure all newlines are represented by LF
+      def all_to_lf(body)
+        # Replace CRLF's, then lone CR's
+        return body.gsub(CRLF, LF).gsub(CR, LF)
+      end
+    end # Newline
+  end # Transform
+end # SvnTransform

data/lib/svn-transform/transform/noop.rb

@@ -0,0 +1,28 @@
+class SvnTransform
+  module Transform
+    # A Transform class that does nothing. Useful for classes to inherit from
+    # that don't need any special initialize logic, and as an ultra-simple
+    # example.
+    class Noop
+      # Initialize Noop Transform.
+      #
+      # ==== Parameters
+      # file<SvnTransform::File>:: File at a given revision
+      # args<Array>:: Splat of other args, all ignored
+      def initialize(file, *args)
+        @file = file
+        @args = args
+      end
+      
+      # Run the transform. In this case it does nothing. In actual transforms,
+      # it would alter the @file (#body, #basename, and/or #properties) in
+      # some way, probably only if a condition met.
+      #
+      # ==== Returns
+      # False:: indicating that nothing was done.
+      def run
+        return false
+      end
+    end
+  end
+end

data/lib/svn-transform/transform/props_to_yaml.rb

@@ -0,0 +1,134 @@
+require 'yaml'
+
+class SvnTransform
+  module Transform
+    # Move svn properties to YAML Front matter (or, for directories, to a YAML
+    # file). This is particularly intended to assist when converting a 
+    # Subversion repository to another SCM that doesn't have arbitrary 
+    # per-node properties (or whose conversion tools ignore them).
+    #
+    # See +new+ (+initialize+) for options
+    class PropsToYaml
+      # Default filename for yaml file holding directory properties
+      DEFAULT_YAML_FILE = 'meta.yml'
+      
+      # Initialize with node, instructions and options
+      #
+      # ==== Parameters
+      # node<SvnTransform::File, SvnTransform::Directory>:
+      #   The file or directory to be transformed
+      # instructions<Array of Array, Symbol>:
+      #   - :all (default) will move all svn properties to YAML Front Matter
+      #     (except svn:entry props)
+      #   - An Array of Arrays. The first element of the inner Array is a Regex
+      #     or String to be matched against. The second element is an action
+      #     to take for those properties that match (using === operator).
+      #     Actions can be:
+      #     - :move : Just move the property to YAML
+      #     - :delete : Remove from svn properties, don't add to YAML
+      #     - String : gsub replacement string
+      # 
+      # ==== Options
+      # :yaml_file<String>::
+      #   Filename for directory YAML properties (defaults to DEFAULT_YAML_FILE)
+      def initialize(node, instructions = :all, options = {})
+        @node = node
+        @instructions = instructions
+        @instructions = [[/\A(?!svn:entry)/]] if @instructions == :all
+        @yaml_file = options[:yaml_file] || DEFAULT_YAML_FILE
+        @dirty = false
+      end
+      
+      def run
+        if file?
+          body_less_yaml = has_yaml_props? ? yaml_split[1] : @node.body
+        end
+        @yaml_props = yaml_properties
+        @svn_props = @node.properties
+        
+        @node.properties.each do |prop_key, prop_val|
+          process_property(prop_key, prop_val)
+        end
+        
+        if @dirty
+          if file?
+            @node.body = @yaml_props.empty? ? body_less_yaml :
+              (@yaml_props.to_yaml + "---\n\n" + body_less_yaml)
+          else
+            @node.fixture_dir.file(@yaml_file).body(@yaml_props.to_yaml)
+          end
+          @node.properties = @svn_props
+          return true
+        else
+          return false
+        end
+      end
+      
+      def process_property(prop_key, prop_val)
+        @instructions.each do |matcher, action|
+          action ||= :move
+          if matcher === prop_key
+            @svn_props.delete(prop_key)
+            @dirty = true
+            case action
+            when :delete
+              return true # Do nothing
+            when :move
+              new_key = prop_key
+            else # A string, hopefully
+              new_key = prop_key.gsub(matcher, action)
+            end
+            @yaml_props[new_key] = prop_val
+            return true
+          end
+        end
+        return false
+      end
+      
+      private
+      
+      # Is the node a File?
+      def file?
+        @node.kind_of?(SvnTransform::File)
+      end
+      
+      # Is the node a Directory?
+      def directory?
+        !file?
+      end
+      
+      # Get YAML properties. For a directory, these are stored in 
+      # @options[:yaml_file], for a file, they are stored at the beginning of 
+      # the file: the first line will bec and the YAML will end before a 
+      # line containing "..." or "---".
+      def yaml_properties
+        if directory?
+          yaml_path = ::File.join(@node.path, @yaml_file)
+          @node.repos.stat(yaml_path, @node.rev_num) ?
+            YAML.load(@node.repos.file(yaml_path, @node.rev_num)[0]) :
+            {}
+        else
+          has_yaml_props? ?
+            YAML.load(yaml_split[0]) :
+            {}
+        end
+      end
+      
+      # Determine if file has yaml properties, by checking if the file starts
+      # with three leading dashes
+      def has_yaml_props?
+        file? && @node.body[0..2] == "---"
+      end
+      
+      # Split a file between properties and body at a line with three dots.
+      # Left trim the body and there may have been blank lines added for
+      # clarity.
+      def yaml_split
+        body = @node.body.gsub("\r", "")
+        ary = body.split(/\n\.\.\.\n|\n---\n/,2)
+        ary[1] = ary[1].lstrip
+        ary
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: svn-transform
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jared Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: svn-fixture
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: spicycode-micronaut
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  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.
+
+email: jmorgan@morgancreative.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/example_helper.rb
+- examples/fixtures/dir_props.rb
+- examples/fixtures/original.rb
+- examples/fixtures/result.rb
+- examples/svn-transform/dir_example.rb
+- examples/svn-transform/file_example.rb
+- examples/svn-transform/transform/extension_example.rb
+- examples/svn-transform/transform/newline_example.rb
+- examples/svn-transform/transform/noop_example.rb
+- examples/svn-transform/transform/props_to_yaml_example.rb
+- examples/svn-transform_example.rb
+- lib/svn-transform.rb
+- lib/svn-transform/dir.rb
+- lib/svn-transform/file.rb
+- lib/svn-transform/session.rb
+- lib/svn-transform/transform/extension.rb
+- lib/svn-transform/transform/newline.rb
+- lib/svn-transform/transform/noop.rb
+- lib/svn-transform/transform/props_to_yaml.rb
+has_rdoc: true
+homepage: http://github.com/jm81/svn-props-to-yaml
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Copy Subversion repository, with the ability to alter files
+test_files: 
+- examples/example_helper.rb
+- examples/fixtures/dir_props.rb
+- examples/fixtures/original.rb
+- examples/fixtures/result.rb
+- examples/svn-transform/dir_example.rb
+- examples/svn-transform/file_example.rb
+- examples/svn-transform/transform/extension_example.rb
+- examples/svn-transform/transform/newline_example.rb
+- examples/svn-transform/transform/noop_example.rb
+- examples/svn-transform/transform/props_to_yaml_example.rb
+- examples/svn-transform_example.rb