gold 0.3.1

data/History.txt

@@ -0,0 +1,16 @@
+== 0.3.1 2009-10-02
+
+* 1 major enhancement:
+  * Storing 'settings' in the projects .git directory
+  * Added 'rebase' method.
+  * Made a gem
+
+== 0.2.0 2009-09-08
+
+* 1 major enhancement:
+  * Added 'add_dev' and 'setup' methods
+
+== 0.1.0 2009-09-06
+
+* 1 major enhancement:
+  * Initial alpha release

data/README.txt

@@ -0,0 +1,67 @@
+== SUMMARY:
+
+Gold is a simple executable that helps git teamwork.
+
+== DESCRIPTION:
+
+This is the workflow we use when developing zena.
+
+The main idea is that developers work on feature branches on their fork and send an
+email to the reviewer when work is ready. The reviewer pulls from these branches,
+checks that all is good and either apply the commits to the gold master or abort.
+
+There is a script called 'gold' that helps use this workflow once the remote references
+are added.
+
+Any questions ? Ask zena's mailing list: http://zenadmin.org/en/community
+
+                                     ~~
+
+== Workflow:
+
+You need to update the Settings in the 'gold' script to match your own project and emails.
+
+Developer setup
+---------------
+
+1. login on github (John)
+2. fork sandbox
+3. on local machine, clone your own fork
+> git clone git@github.com:john/PROJECT.git
+> cd PROJECT
+> gold setup
+
+Working on new 'floppy' feature
+-------------------------------
+
+[John] (developer, on his own fork)
+> git checkout gold
+> git pull
+> git checkout -b floppy
+> commit, commit
+# propose
+> gold propose
+
+[reviewer]
+# only if john is not a remote yet
+> gold add_dev john
+# review
+> gold review john/floppy
+# fail
+> gold fail
+
+[John]
+> reset, commit, squash, etc
+# propose again
+> gold propose
+
+[reviewer]
+# review
+> gold review john/floppy
+# ok
+> gold ok
+
+[John]
+# cleanup
+> git co floppy
+> gold cleanup

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+PROJ.name = 'gold'
+PROJ.summary = 'Gold is a simple executable that helps git teamwork.'
+PROJ.authors = 'Gaspard Bucher'
+PROJ.email = 'gaspard@teti.ch'
+PROJ.url = 'http://zenadmin.org/574'
+PROJ.version = '0.3.1'
+PROJ.rubyforge.name = 'gold'
+
+PROJ.spec.opts << '--color'
+PROJ.gem.files = ['History.txt', 'README.txt', 'bin/gold', 'Rakefile', 'lib/gold.rb']

data/bin/gold

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gold'
+
+Gold.run ARGV

data/lib/gold.rb

@@ -0,0 +1,282 @@
+require 'fileutils'
+require 'tempfile'
+require 'yaml'
+
+# Sending mail not working on mac os x ?
+# http://www.macosxhints.com/article.php?story=20081217161612647
+
+# install
+# > sudo cp gold /usr/local/bin/
+# > chmod a+x /usr/local/bin/gold
+
+# TODO: move Settings inside each project ?
+
+class Gold
+
+  DefaultSettings = {
+    'gold_branch'     => 'gold',                  # name of local branch tracking gold master (in developer's local git)
+    'gold_remote'     => 'zena',                  # name of remote 'gold' reference project
+    'gold_repository' => 'git://github.com/zena/zena.git',
+    'developer_name'  => 'john',                  # developer's name (same as github account)
+    'developer_email' => 'developer@example.com', # developer's email
+    'reviewer'        => 'reviewer@example.com'   # reviewer's email
+  }
+
+  SettingsMessages = {
+    '1. gold_branch'     => 'name of local branch that will track gold master',
+    '2. gold_remote'     => 'name of remote gold master',
+    '3. gold_repository' => 'remote repository',
+    '4. developer_name'  => 'developer\'s account on remote repository',
+    '5. developer_email' => 'developer\'s email',
+    '6. reviewer'        => 'reviewer\'s email'
+  }
+
+  DefaultSettings.keys.each do |k|
+    define_method(k) do
+      settings[k]
+    end
+  end
+
+  def self.run(args)
+    self.new.run(args)
+  end
+
+  def run(args)
+    case args[0]
+    when 'add_dev'
+      add_dev args[1], args[2]
+    when 'check', 'review'
+      review args[1]
+    when 'propose'
+      propose args[1]
+    when 'settings'
+      create_settings_file
+    else
+      if args[0] && self.respond_to?(args[0])
+        send(args[0])
+      else
+        show_usage
+      end
+    end
+  end
+
+  def setup
+    return error("Could not create settings file #{settings_path.inspect}.") unless create_settings_file
+    return error("Could create remote #{gold_remote}.") unless system("git remote add #{gold_remote} #{gold_repository}")
+    return error("Could not fetch #{gold_remote}.") unless system("git fetch #{gold_remote}")
+    return error("Could not create #{gold_branch} branch.") unless system("git checkout --track -b #{gold_branch} #{gold_remote}/master")
+  end
+
+  def rebase
+    branch = current_branch
+    return error("Could not find current branch.") unless branch
+    return error("You cannot rebase the #{gold_branch} branch !") if branch == gold_branch
+    return error("You cannot rebase the master branch !") if branch == 'master'
+    return error("Could not checkout #{gold_branch}.") unless system("git checkout #{gold_branch}")
+    return error("Could not pull #{gold_branch}.") unless system("git pull")
+    return error("Could not checkout #{branch}.") unless system("git checkout #{branch}")
+    return error("Could not rebase --interactive #{gold_branch}.") unless system("git rebase --interactive #{gold_branch}")
+  end
+
+  def propose(msg)
+    branch = current_branch
+    return error("Could not find current branch.") unless branch
+    return error("You cannot propose the #{gold_branch} branch !") if branch == gold_branch
+    return error("You cannot propose the master branch !") if branch == 'master'
+    return error("Could not checkout #{gold_branch}.") unless system("git checkout #{gold_branch}")
+    return error("Could not pull #{gold_branch}.") unless system("git pull")
+    return error("Could not checkout #{branch}.") unless system("git checkout #{branch}")
+    return error("Could not rebase #{branch} with #{gold_branch}.") unless system("git rebase #{gold_branch}")
+    return error("Could not push #{branch} to origin.") unless system("git push origin +#{branch}")
+    subject = "#{gold_remote}: review #{developer_name}/#{branch}"
+    tmpf = Tempfile.new('gold_msg')
+    tmpf.write %Q{From:#{developer_email}
+Subject:#{subject}
+
+============
+gold review #{developer_name}/#{branch}
+============
+
+#{msg}
+}
+    tmpf.close
+    return error("Could not send email to #{reviewer}.") unless system("sendmail -F '#{developer_name}' #{reviewer} < #{tmpf.path}")
+    tmpf.delete
+    puts "Mail sent to #{reviewer}"
+  end
+
+  def add_dev(name, repo = nil)
+    return error("Missing 'developer name' parameter.") unless name
+    repo ||= "#{gold_repository.split('/')[0..2].join('/')}/#{name}/#{gold_remote}.git"
+    return error("Could add developer #{name} (#{repo}).") unless system("git remote add #{name} #{repo}")
+    return error("Could not fetch #{name}.") unless system("git fetch #{name}")
+  end
+
+  def review(remote_branch)
+    return error("Missing 'remote_branch' parameter.") unless remote_branch
+    return error("'remote_branch' format should be remote/branch.") unless remote_branch =~ /^(.+)\/(.+)$/
+    remote, branch = $1, $2
+    return error("Could not checkout master.") unless system("git co master")
+    return error("Could not checkout #{remote}_#{branch}.") unless system("git co -b #{remote}_#{branch}")
+    return error("Could not pull #{remote_branch}.") unless system("git pull #{remote} #{branch}")
+    return error("Could not rebase.") unless system("git rebase master")
+    system("git diff master | $EDITOR")
+    true
+  end
+
+  def ok
+    branch = current_branch
+    return error("Could not find current branch.") unless branch
+    return error("Could not rebase.") unless system("git rebase master")
+    return error("Could not checkout master.") unless system("git co master")
+    return error("Could not fast-forward merge #{branch} into master.") unless system("git merge --ff #{branch}")
+    return error("Could not delete #{branch}.") unless system("git branch -d #{branch}")
+    puts "-------------------\n\nSuccessfully applied #{branch} to golden master !\n\nPlease git push when you are ready."
+  end
+
+  def fail
+    branch = current_branch
+    return error("Could not find current branch.") unless branch
+    return error("You cannot 'fail' master !") unless branch != 'master'
+    return error("Could not checkout master.") unless system("git co master")
+    return nil unless remove(branch, true)
+  end
+
+  def cleanup
+    branch = current_branch
+    return error("Could not find current branch.") unless branch
+    return error("You cannot 'cleanup' master or #{gold_branch} !") if branch == 'master' || branch == gold_branch
+    return error("Could not checkout #{gold_branch}.") unless system("git co #{gold_branch}")
+    return error("Could not pull #{gold_remote}.") unless system("git pull #{gold_remote}")
+    return error("Could not checkout #{branch}.") unless system("git co #{branch}")
+    return error("Could rebase on top of #{gold_branch}.") unless system("git rebase #{gold_branch}")
+    return error("Could not checkout #{gold_branch}.") unless system("git co #{gold_branch}")
+    return nil unless remove(branch)
+    return error("Could not clear remote branch.") unless system("git push origin :#{branch}")
+  end
+
+
+  private
+
+    def error(msg)
+      puts msg
+      nil
+    end
+
+    def current_branch
+      branch = nil
+      `git branch`.split("\n").each do |b|
+        if b =~ /^\*\s+(.+)$/
+          branch = $1
+          break
+        end
+      end
+      branch
+    end
+
+    def remove(branch, force=false)
+      print "Remove branch #{branch} ? (y,N) "
+      yn = STDIN.gets
+      if yn.downcase.strip == 'y'
+        return error("Could not delete #{branch}.") unless system("git branch -#{force ? 'D' : 'd'} #{branch}")
+        true
+      else
+        return error("Could not checkout #{branch}.") unless system("git co #{branch}")
+        false
+      end
+    end
+
+    def create_settings_file
+      FileUtils::mkpath(File.dirname(settings_path)) unless File.exist?(File.dirname(settings_path))
+      defaults = settings
+      new_settings = {}
+      SettingsMessages.keys.sort.each do |key|
+        real_key = key.gsub(/\A.*? /,'')
+        print "#{SettingsMessages[key]} (#{defaults[real_key]}): "
+        value = STDIN.gets.chomp
+        new_settings[real_key] = value == '' ? DefaultSettings[real_key] : value
+      end
+      File.open(settings_path, 'wb') do |f|
+        f.puts YAML::dump(new_settings)
+      end
+      puts "New settings written to '#{settings_path}'"
+      true
+    end
+
+    def settings
+      @settings ||= begin
+        if File.exist?(settings_path)
+          YAML::load(File.read(settings_path))
+        else
+          DefaultSettings
+        end
+      end
+    end
+
+    def settings_path
+      @settings_path ||= begin
+        path = File.expand_path('.').split('/')
+        while path != []
+          if File.exist?(File.join(path + ['.git']))
+            break
+          else
+            path.pop
+          end
+        end
+        (path + ['.git', 'gold.yml']).flatten.join('/')
+      end
+    end
+
+    def show_usage
+      error(%Q{
+Usage:
+
+Reviewer
+========
+
+Add a new developer reference
+-----------------------------
+> gold add_dev john
+or
+> gold add_dev john git://github.com/john/foo.git
+
+Checkout a remote branch and view diff
+--------------------------------------
+> gold check john/floppy
+
+Include commits into master branch
+----------------------------------
+(on the new feature branch created by previous 'review')
+> gold ok
+
+The code is not ready yet, cleanup
+----------------------------------
+(on the new feature branch created by previous 'review')
+> gold fail
+
+Developer
+=========
+
+Setup
+-----
+> gold setup
+> gold settings
+
+Rebase on top of latest gold
+----------------------------
+(on the new feature branch)
+> gold rebase
+
+Propose branch
+--------------
+(on the new feature branch)
+> gold propose
+
+Cleanup after commit acceptation
+--------------------------------
+(on the new feature branch)
+> gold cleanup
+
+})
+    end
+end

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF