svn_branch 0.2.1

data/History.txt

@@ -0,0 +1,8 @@
+== 0.2.1 2007-06-17
+
+* Fixed up svn:branch:merge_to_trunk
+
+== 0.0.2 2007-06-10
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/svn_branch.rb
+lib/svn_branch/version.rb
+lib/tasks/create.rake
+lib/tasks/merge.rake
+scripts/txt2html
+setup.rb
+test/test_helper.rb
+test/test_svn_branch.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,6 @@
+README for svn_branch
+=====================
+
+A collection of rake tasks to automate the svn functions within a project, with special support for rails projects.
+
+For example, the creation of new branch, plus for rails apps, a new database.yml and new databases for development and test, for the branch.

data/Rakefile

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'svn_branch', 'version')
+
+AUTHOR = 'nicwilliams'  # can also be an array of Authors
+EMAIL = "drnicwilliams@gmail.com"
+GEM_NAME = 'svn_branch' # what ppl will type to install your gem
+config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+RUBYFORGE_USERNAME = config["username"]
+RUBYFORGE_PROJECT = 'drnicutilities' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "svn_branch"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = SvnBranch::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'svn_branch documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = p.paragraphs_of("README.txt", 1..1).join("\n\n")
+  p.email = EMAIL
+  p.summary = p.paragraphs_of("README.txt", 1..2).join("\n\n")
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [['gemsonrails', '>=0.5.0']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "\#{RUBYFORGE_PROJECT}/\#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{config["username"]}@rubyforge.org"
+  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release]
+
+desc 'Create website and install gem locally'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end

data/lib/svn_branch/version.rb

@@ -0,0 +1,9 @@
+module SvnBranch #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/svn_branch.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'svn_branch/**/*.rb')].sort.each { |lib| require lib }

data/lib/tasks/create.rake

@@ -0,0 +1,86 @@
+namespace :svn do
+  namespace :branch do
+    desc 'Creates a new branch using NAME=branch_name [APP_NAME=app_name]'
+    task :create => :environment do
+      require 'highline'
+      
+
+      puts "Usage: NAME=branch_name" and next unless name = ENV['NAME']
+
+      svn_info = `svn info`
+      puts "Not under svn; ignoring request" and next unless svn_info
+      repo_root = (svn_info.match(/^Repository Root:\s(.*)$/) || [nil,nil])[1]
+      repo_curr = (svn_info.match(/^URL:\s(.*)$/) || [nil,nil])[1]
+      puts "ERROR: cannot find Repository Root via `svn info`" and next unless repo_root
+      puts "ERROR: cannot find URL via `svn info`" and next unless repo_curr
+      puts "Repository Root: #{repo_root}"
+      puts "Checkout URL:    #{repo_curr}"
+      puts "ERROR: svn project is not setup for branching (needs trunk,branches,tags subfolders)" and next if repo_root == repo_curr
+      puts "ERROR: only perform this operation from the trunk checkout" and next if repo_curr.sub(repo_root, '') != '/trunk'
+    
+      app_name = ENV['APP_NAME']
+      app_name ||= repo_root.split('/').last
+    
+      curr_path = Dir.pwd
+      target_path = File.join(curr_path, '..', "#{app_name}_#{name}")
+      repo_branch = File.join(repo_root, 'branches', name)
+      puts "Current path:    #{curr_path}"
+      puts "*Branch path:    #{target_path}"
+
+      puts "*Repos branch:   #{repo_branch}"
+
+      trunk_database_yml = File.read(File.join(curr_path, 'config/database.yml'))
+      config = YAML.load(trunk_database_yml)
+      adapter = config["development"]["adapter"]
+      puts "Adapter:         #{adapter}"
+      
+      unless %w[postgresql mysql].include? adapter
+        puts "ERROR: Adapter #{adapter} not yet supported. Please ask for it - drnicwilliams@gmail.com"
+        next
+      end
+      question = HighLine.new
+      puts "Quitting." and next unless question.agree("Create branch? [y/N]", true)
+      
+      repo_from = repo_curr # TODO allow task to be called from non-trunk to clone branches
+      repo_to   = repo_branch
+      puts `svn copy #{repo_curr} #{repo_to}`
+      puts `svn co #{repo_to} #{target_path}`
+      
+      # Now clone the trunk/config/database.yml and gsub(/#{app_name}/,"#{app_name}_#{name}")
+      # get database adapter type
+      # now create dev + test dbs
+      if adapter == 'postgresql'
+        createdb = "createdb -E utf8"
+        createdb += " --username=#{config["development"]["username"]} --password" if config["development"]["username"]
+      elsif adapter == 'mysql'
+        createdb = "mysqladmin"
+        createdb += " -u #{config["development"]["username"]} " +
+          "-p" if config["development"]["username"]        
+        createdb += " create"
+      end
+      createdb += " %s"
+      %w[development test].each do |db_type|
+        db_name = "#{app_name}_#{name}_#{db_type}"
+        puts expr = createdb % db_name
+        puts `#{expr}`
+      end
+      
+      puts "Creating config/database.yml from existing version..."
+      File.open(File.join(target_path, "config/database.yml"),'w') do |f|
+        f.write(trunk_database_yml.gsub(/database:\s+#{app_name}/,"database: #{app_name}_#{name}"))
+      end
+      
+      puts "Creating #{target_path}/log folder if necessary..."
+      FileUtils.mkdir_p File.join(target_path, 'log')
+      
+      Dir.chdir target_path do
+        
+        exprs = ["rake db:migrate", "rake db:test:clone", "rake test"]
+        exprs.each do |expr|
+          puts expr
+          puts `#{expr}`
+        end
+      end
+    end
+  end
+end

data/lib/tasks/merge.rake

@@ -0,0 +1,72 @@
+namespace :svn do
+  namespace :branch do
+    desc 'Merges the trunk into this branch'
+    task :merge_to_branch do
+      require 'highline'
+      
+      # Ideas on merging come from http://svnbook.red-bean.com/en/1.0/ch04s04.html
+      
+      svn_info = `svn info`
+      puts "Not under svn; ignoring request" and next unless svn_info
+      repo_root = (svn_info.match(/^Repository Root:\s(.*)$/) || [nil,nil])[1]
+      repo_curr = (svn_info.match(/^URL:\s(.*)$/) || [nil,nil])[1]
+      branch_name = repo_curr.split('/').last
+
+      repo_trunk = "#{repo_root}/trunk"
+      svn_info_trunk = `svn info #{repo_trunk}`
+      puts "SVN path #{repo_trunk} does not exist; cannot perform branch - contact Dr Nic" and next unless svn_info_trunk
+      unless svn_info_trunk[/Last Changed Rev:\s(\d+)/]
+        puts "Cannot find 'Last Changed Rev: xxx' in `svn info #{repo_trunk}`"
+        return
+      end
+      trunk_version = $1.to_i
+      
+      # look in props for previous merge version, else get original branch version
+      # or look for rXXX:YYY in log comments, and use that version, e.g. YYY+1
+      if `svn log --verbose --stop-on-copy`[/r(\d+)\s/]
+        branch_version = $1.to_i
+        puts "Branch #{branch_name} created at version #{branch_version}; never merged with trunk yet."
+      end
+      
+      puts "Merging changes btw r#{branch_version}:#{trunk_version} from trunk into this branch..."
+      
+      puts merge = "svn merge -r #{branch_version}:#{trunk_version} #{repo_trunk}"
+      puts `#{merge}`
+      
+      puts status = "svn status"
+      puts `#{status}`
+      
+      puts "1) Now fix up any 'C' conflicts and remove the temporary files"
+      puts "2) Fix up your migrations (may need to rollback and put new migrations at the end of the list)"
+      puts "3) svn commit -m \"Merged trunk changes into #{branch_name}; r#{branch_version}:#{trunk_version}\""
+    end
+  
+    desc 'Merge branch back into trunk; run from trunk'
+    task :merge_to_trunk do
+      puts "Usage: NAME=branch_name" and next unless name = ENV['NAME']
+    
+      svn_info = `svn info`
+      puts "Not under svn; ignoring request" and next unless svn_info
+      repo_root = (svn_info.match(/^Repository Root:\s(.*)$/) || [nil,nil])[1]
+      repo_curr = (svn_info.match(/^URL:\s(.*)$/) || [nil,nil])[1]
+      branch_name = repo_curr.split('/').last
+      repo_branch = "#{repo_root}/branches/#{name}"
+      
+      # get the last r(\d+) number
+      svn_log = `svn log --verbose --stop-on-copy #{repo_branch}`
+      branch_rev = svn_log.scan(/^r(\d+)\s/).last
+      # merge branch_rev:HEAD
+      puts merge = "svn merge -r #{branch_rev}:HEAD #{repo_branch}"
+      puts `#{merge}`
+      
+      # fix conflicts
+      
+      puts "1) Now fix up any 'C' conflicts and remove the temporary files"
+      puts "2) Fix up your migrations (may need to increment branch migrations forward)"
+      puts "3) rake db:migrate"
+      puts "4) rake db:test:clone"
+      puts "5) rake"
+      puts "6) svn commit -m \"Merged branch changes from #{branch_name}; r#{branch_rev}:HEAD\""
+    end
+  end
+end

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/svn_branch/version.rb'
+
+version  = SvnBranch::VERSION::STRING
+download = 'http://rubyforge.org/projects/svn_branch'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</
>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)