git-svn-mirror 0.1

data/LICENSE

@@ -0,0 +1,4 @@
+© Eloy Duran <eloy.de.enige@gmail.com>
+You may use these works, ‘as is’, for anything.
+If you include this plus copyright notice.
+But without warranty.

data/README.md

@@ -0,0 +1,98 @@
+git-svn-mirror
+--------------
+
+A command-line tool that automates the task of creating a GIT mirror for a SVN
+repo, and keeping it up-to-date.
+
+Install
+-------
+
+This tool is packaged as a Ruby Gem, install it by running the following:
+
+	$ gem install git-svn-mirror
+
+Configure the ‘workbench’
+-------------------------
+
+To mirror a SVN repo, first the local ‘workbench’ repo has to be configured.
+This ‘workbench’ is the GIT repo where the SVN revisions will be stored and
+from where these revisions will be pushed to the remote mirror GIT repo.
+
+Start by creating the directory:
+
+	$ mkdir -p /path/to/workbench
+
+Then initialize the ‘workbench’:
+
+	$ cd /path/to/workbench
+	$ git-svn-mirror init --from=http://svn-host/repo_root --to=git@git-host:user/mirror.git
+
+This will create a ‘bare’ GIT repo, configure the SVN and GIT remotes, fetch
+the revisions from the SVN remote, and compact the ‘workbench’ by running the
+GIT garbage collector.
+
+It can often be handy to supply an authors file, with the <tt>--authors-file</tt>
+option, which is used to migrate user names to GIT names and email addresses.
+The entries in this file should look like:
+
+	svn-user-name = User Name <user@example.com>
+
+Update mirror
+-------------
+
+To push the latest changes from the SVN repo to the GIT repo, run the following
+command from the ‘workbench’ repo:
+
+	$ git-svn-mirror update
+
+Or by specifying the path(s) to one or more ‘workbench’ repos:
+
+	$ git-svn-mirror update /path/to/workbench1 /path/to/workbench2
+
+You will probably normally not want to perform this step by hand. You can solve
+this by adding this command as a cron job, in which case you can silence the
+tool with the <tt>--silent</tt> option.
+
+‘init’ help banner
+----------------
+
+	Usage: git-svn-mirror init [mandatory options] [options]
+	
+	  Mandatory options are --from and --to.
+	
+	    --from URI                   The location of the SVN repository that is to be mirrored.
+	    --to URI                     The location of the GIT repository that is the mirror.
+	    --workbench PATH             The location of the workbench repository. Defaults to the current work dir.
+	    --authors-file PATH          An optional authors file used to migrate SVN usernames to GIT's format.
+	-s, --silent                     Silent mode.
+
+‘update’ help banner
+--------------------
+
+	Usage: git-svn-mirror update [options] [workbench1] [workbench2] ...
+	
+	  Defaults to the current work dir if none is given.
+	
+	-s, --silent                     Silent mode.
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][fk] git-svn-mirror
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][is] with a link to your branch
+5. That’s it!
+
+License In Three Lines (LITL)
+-----------------------------
+
+	© Eloy Duran <eloy.de.enige@gmail.com>
+	You may use these works, ‘as is’, for anything.
+	If you include this plus copyright notice.
+	But without warranty.
+
+[fk]: http://help.github.com/forking/
+[is]: http://github.com/alloy/git-svn-mirror/issues

data/TODO

@@ -0,0 +1,2 @@
+* error checking and reporting
+* optimize by not trying to push if there were no updates

data/bin/git-svn-mirror

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'git-svn-mirror'
+
+_, success = GitSVNMirror.run(ARGV)
+exit(1) unless success

data/git-svn-mirror.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-svn-mirror}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eloy Duran"]
+  s.date = %q{2010-10-11}
+  s.default_executable = %q{git-svn-mirror}
+  s.description = %q{A command-line tool that automates the task of creating a GIT mirror for a SVN repo, and keeping it up-to-date.}
+  s.email = %q{eloy.de.enige@gmail.com}
+  s.executables = ["git-svn-mirror"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md",
+     "TODO"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "TODO",
+     "bin/git-svn-mirror",
+     "git-svn-mirror.gemspec",
+     "lib/git-svn-mirror.rb"
+  ]
+  s.homepage = %q{http://github.com/alloy/git-svn-mirror}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A command-line tool that automates the task of creating a GIT mirror for a SVN repo, and keeping it up-to-date.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/git-svn-mirror.rb

@@ -0,0 +1,147 @@
+require 'optparse'
+
+class GitSVNMirror
+  VERSION = "0.1"
+
+  attr_accessor :from, :to, :workbench, :authors_file, :silent
+
+  def self.run(argv)
+    mirror = new
+    status = case argv.shift
+             when 'init'   then init(mirror, argv)
+             when 'update' then update(mirror, argv)
+             else
+               puts "Usage: git-svn-mirror [init|update]"
+               false
+             end
+    [mirror, status]
+  end
+
+  def self.option_parser(mirror, argv)
+    opts = OptionParser.new do |o|
+      yield(o)
+      o.on('-s', '--silent',  'Silent mode.')       { mirror.silent = true }
+      o.on('-v', '--version', 'Print the version.') { puts VERSION; exit }
+    end
+    opts.parse!(argv)
+    opts
+  end
+
+  def self.init(mirror, argv)
+    opts = option_parser(mirror, argv) do |o|
+      o.banner = "Usage: git-svn-mirror init [mandatory options] [options]"
+      o.separator "\n  Mandatory options are --from and --to.\n\n"
+      o.on('--from URI',          'The location of the SVN repository that is to be mirrored.')                  { |uri| mirror.from = uri }
+      o.on('--to URI',            'The location of the GIT repository that is the mirror.')                      { |uri| mirror.to = uri }
+      o.on('--workbench PATH',    'The location of the workbench repository. Defaults to the current work dir.') { |wb|  mirror.workbench = wb }
+      o.on('--authors-file PATH', 'An optional authors file used to migrate SVN usernames to GIT\'s format.')    { |af|  mirror.authors_file = af }
+    end
+
+    if mirror.from && mirror.to
+      if !File.exist?(mirror.workbench)
+        puts "[!] Given workbench path does not exist."
+        false
+      else
+        if mirror.authors_file && !File.exist?(mirror.authors_file)
+          puts "[!] Given authors file does not exist."
+          false
+        else
+          mirror.init
+          true
+        end
+      end
+    else
+      puts opts
+      false
+    end
+  end
+
+  def self.update(mirror, argv)
+    opts = option_parser(mirror, argv) do |o|
+      o.banner = "Usage: git-svn-mirror update [options] [workbench1] [workbench2] ..."
+      o.separator "\n  Defaults to the current work dir if none is given.\n\n"
+    end
+
+    if argv.empty?
+      mirror.update
+    else
+      argv.each do |workbench|
+        mirror.workbench = workbench
+        mirror.update
+      end
+    end
+    true
+  end
+
+  def init
+    log "* Configuring mirror workbench at `#{workbench}'"
+    sh "git init --bare"
+
+    sh "git svn init --stdlayout --prefix=svn/ #{from}"
+    sh "git config --add svn.authorsfile '#{authors_file}'" if authors_file
+
+    sh "git remote add origin #{to}"
+    sh "git config --add remote.origin.push 'refs/remotes/svn/*:refs/heads/*'"
+
+    fetch
+    log "* Running garbage collection"
+    sh "git gc"
+
+    log "The mirror workbench has been configured. To push to the remote GIT repo,",
+        "and possibly as a cron job, run the following command:",
+        "",
+        "  $ git-svn-mirror update '#{workbench}'"
+  end
+
+  def update
+    fetch
+    push
+  end
+
+  def fetch
+    log "* Fetching from SVN repo at `#{from}'"
+    sh "git svn fetch"
+  end
+
+  def push
+    log "* Pushing to GIT repo at `#{to}'"
+    sh "git push origin"
+  end
+
+  def from
+    @from ||= config("svn-remote.svn.url")
+  end
+
+  def to
+    @to ||= config("remote.origin.url")
+  end
+
+  def workbench=(path)
+    @workbench = File.expand_path(path)
+  end
+
+  def workbench
+    @workbench ||= Dir.pwd
+  end
+
+  def authors_file=(path)
+    @authors_file = File.expand_path(path)
+  end
+
+  def log(*str)
+    puts("\n#{str.join("\n")}\n\n") unless @silent
+  end
+
+  def config(key)
+    value = sh("git config --get #{key}", true)
+    value unless value.empty?
+  end
+
+  def sh(command, capture = false)
+    Dir.chdir(workbench) do
+      command = "env GIT_DIR='#{workbench}' #{command}"
+      command += (@silent ? " > /dev/null 2>&1" : " 1>&2") unless capture
+      `#{command}`.strip
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: git-svn-mirror
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Eloy Duran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-11 00:00:00 +02:00
+default_executable: git-svn-mirror
+dependencies: []
+
+description: A command-line tool that automates the task of creating a GIT mirror for a SVN repo, and keeping it up-to-date.
+email: eloy.de.enige@gmail.com
+executables: 
+- git-svn-mirror
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- TODO
+files: 
+- LICENSE
+- README.md
+- TODO
+- bin/git-svn-mirror
+- git-svn-mirror.gemspec
+- lib/git-svn-mirror.rb
+has_rdoc: true
+homepage: http://github.com/alloy/git-svn-mirror
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A command-line tool that automates the task of creating a GIT mirror for a SVN repo, and keeping it up-to-date.
+test_files: []
+