rango 0.0.3

data/support/hooks/pre-rebase

@@ -0,0 +1,169 @@
+#!/bin/sh
+#
+# Copyright (c) 2006, 2008 Junio C Hamano
+#
+# The "pre-rebase" hook is run just before "git-rebase" starts doing
+# its job, and can prevent the command from running by exiting with
+# non-zero status.
+#
+# The hook is called with the following parameters:
+#
+# $1 -- the upstream the series was forked from.
+# $2 -- the branch being rebased (or empty when rebasing the current branch).
+#
+# This sample shows how to prevent topic branches that are already
+# merged to 'next' branch from getting rebased, because allowing it
+# would result in rebasing already published history.
+
+publish=next
+basebranch="$1"
+if test "$#" = 2
+then
+	topic="refs/heads/$2"
+else
+	topic=`git symbolic-ref HEAD` ||
+	exit 0 ;# we do not interrupt rebasing detached HEAD
+fi
+
+case "$topic" in
+refs/heads/??/*)
+	;;
+*)
+	exit 0 ;# we do not interrupt others.
+	;;
+esac
+
+# Now we are dealing with a topic branch being rebased
+# on top of master.  Is it OK to rebase it?
+
+# Does the topic really exist?
+git show-ref -q "$topic" || {
+	echo >&2 "No such branch $topic"
+	exit 1
+}
+
+# Is topic fully merged to master?
+not_in_master=`git-rev-list --pretty=oneline ^master "$topic"`
+if test -z "$not_in_master"
+then
+	echo >&2 "$topic is fully merged to master; better remove it."
+	exit 1 ;# we could allow it, but there is no point.
+fi
+
+# Is topic ever merged to next?  If so you should not be rebasing it.
+only_next_1=`git-rev-list ^master "^$topic" ${publish} | sort`
+only_next_2=`git-rev-list ^master           ${publish} | sort`
+if test "$only_next_1" = "$only_next_2"
+then
+	not_in_topic=`git-rev-list "^$topic" master`
+	if test -z "$not_in_topic"
+	then
+		echo >&2 "$topic is already up-to-date with master"
+		exit 1 ;# we could allow it, but there is no point.
+	else
+		exit 0
+	fi
+else
+	not_in_next=`git-rev-list --pretty=oneline ^${publish} "$topic"`
+	perl -e '
+		my $topic = $ARGV[0];
+		my $msg = "* $topic has commits already merged to public branch:\n";
+		my (%not_in_next) = map {
+			/^([0-9a-f]+) /;
+			($1 => 1);
+		} split(/\n/, $ARGV[1]);
+		for my $elem (map {
+				/^([0-9a-f]+) (.*)$/;
+				[$1 => $2];
+			} split(/\n/, $ARGV[2])) {
+			if (!exists $not_in_next{$elem->[0]}) {
+				if ($msg) {
+					print STDERR $msg;
+					undef $msg;
+				}
+				print STDERR " $elem->[1]\n";
+			}
+		}
+	' "$topic" "$not_in_next" "$not_in_master"
+	exit 1
+fi
+
+exit 0
+
+################################################################
+
+This sample hook safeguards topic branches that have been
+published from being rewound.
+
+The workflow assumed here is:
+
+ * Once a topic branch forks from "master", "master" is never
+   merged into it again (either directly or indirectly).
+
+ * Once a topic branch is fully cooked and merged into "master",
+   it is deleted.  If you need to build on top of it to correct
+   earlier mistakes, a new topic branch is created by forking at
+   the tip of the "master".  This is not strictly necessary, but
+   it makes it easier to keep your history simple.
+
+ * Whenever you need to test or publish your changes to topic
+   branches, merge them into "next" branch.
+
+The script, being an example, hardcodes the publish branch name
+to be "next", but it is trivial to make it configurable via
+$GIT_DIR/config mechanism.
+
+With this workflow, you would want to know:
+
+(1) ... if a topic branch has ever been merged to "next".  Young
+    topic branches can have stupid mistakes you would rather
+    clean up before publishing, and things that have not been
+    merged into other branches can be easily rebased without
+    affecting other people.  But once it is published, you would
+    not want to rewind it.
+
+(2) ... if a topic branch has been fully merged to "master".
+    Then you can delete it.  More importantly, you should not
+    build on top of it -- other people may already want to
+    change things related to the topic as patches against your
+    "master", so if you need further changes, it is better to
+    fork the topic (perhaps with the same name) afresh from the
+    tip of "master".
+
+Let's look at this example:
+
+		   o---o---o---o---o---o---o---o---o---o "next"
+		  /       /           /           /
+		 /   a---a---b A     /           /
+		/   /               /           /
+	       /   /   c---c---c---c B         /
+	      /   /   /             \         /
+	     /   /   /   b---b C     \       /
+	    /   /   /   /             \     /
+    ---o---o---o---o---o---o---o---o---o---o---o "master"
+
+
+A, B and C are topic branches.
+
+ * A has one fix since it was merged up to "next".
+
+ * B has finished.  It has been fully merged up to "master" and "next",
+   and is ready to be deleted.
+
+ * C has not merged to "next" at all.
+
+We would want to allow C to be rebased, refuse A, and encourage
+B to be deleted.
+
+To compute (1):
+
+	git-rev-list ^master ^topic next
+	git-rev-list ^master        next
+
+	if these match, topic has not merged in next at all.
+
+To compute (2):
+
+	git-rev-list master..topic
+
+	if this is empty, it is fully merged to "master".

data/support/hooks/prepare-commit-msg

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by git-commit with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples.  The first comments out the
+# "Conflicts:" part of a merge commit.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+case "$2,$3" in
+  merge,)
+    perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   perl -i.bak -pe '
+#      print "\n" . `git diff --cached --name-status -r`
+#	 if /^#/ && $first++ == 0' "$1" ;;
+
+  *) ;;
+esac
+
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

data/tasks/hooks.thor

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+class Hooks < Thor
+  # TODO: force option
+  desc "all", "Install all git hooks"
+  def all
+    if File.directory?(".git/hooks")
+      abort "You must remove .git/hooks first"
+    else
+      # do not symlink them, otherwise git will add samples
+      # FIXME: permissions
+      FileUtils.cp_r("support/hooks", ".git/hooks")
+    end
+  end
+
+  desc "install [*hooks]", "Install given git hook"
+  def install(*names)
+    names.each do |name|
+      if File.file?(".git/hooks/#{name}")
+        abort "File .git/hooks/#{name} already exists. Please remove it first."
+      else
+        FileUtils.cp("support/hooks/#{name}", ".git/hooks/#{name}")
+      end
+    end
+  end
+end

data/tasks/package.thor

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+require "fileutils"
+require "rubygems/user_interaction"
+require "rubygems/builder"
+
+class Gem < Thor
+  self.default_task(:package)
+
+  desc "package", "Package the gem"
+  def package
+    load("rango.gemspec")
+    spec = Rango::SPECIFICATION
+    FileUtils.mkdir_p(File.join(Dir.pwd, "pkg"))
+    ::Gem::Builder.new(spec).build
+    FileUtils.mv(spec.file_name, File.join(Dir.pwd, "pkg", spec.file_name))
+  end
+
+  desc "install", "Package and install the gem."
+  def install
+    self.package
+    puts %x[gem install #{Dir["pkg/*.gem"].last}]
+  end
+
+  desc "uninstall", "Uninstall the gem."
+  def uninstall
+    puts %x[gem uninstall rango -a -x]
+  end
+end
+
+class Gemspec < Thor
+  desc "validate", "Validate gemspec"
+  def validate
+    require "rubygems/specification"
+    data = File.read("rango.gemspec")
+    spec = nil
+
+    if data !~ %r{!ruby/object:Gem::Specification}
+      Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+    else
+      spec = YAML.load(data)
+    end
+
+    spec.validate
+
+    puts spec
+    puts "OK"
+  end
+end

data/tasks/release.thor

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+require_relative "../lib/rango"
+load "#{File.dirname(__FILE__)}/yardoc.thor"
+
+class Release < Thor
+  desc "all", "Run all the tasks related with releasing new version."
+  def all(password)
+    print "Have you updated version and codename in lib/rango.rb? [y/N] "
+    exit unless STDIN.readline.chomp.downcase.eql?("y")
+    self.doc
+    self.tmbundle
+    Gem.new.package
+    self.tag
+    self.rubyforge
+    self.twitter(password)
+  end
+
+  desc "doc", "Freeze documentation."
+  def doc
+    puts "Freezing documentation ..."
+    Yardoc.new.generate
+    freezed_dir = "doc/#{Rango::VERSION}"
+    %x[cp -R doc/head #{freezed_dir}]
+    %x[git add #{freezed_dir}]
+    %x[git commit #{freezed_dir} -m "Documentation for version #{Rango::VERSION} freezed."]
+    puts "Documentation freezed to #{freezed_dir}"
+  rescue
+    puts "Documentation generation failed."
+  end
+
+  desc "tag", "Create Git tag for this version and push it to GitHub."
+  def tag
+    puts "Creating new git tag #{Rango::VERSION} with description #{Rango::CODENAME} and pushing it online ..."
+    %x[git tag -a -m 'Version #{Rango::VERSION} "#{Rango::CODENAME}"' #{Rango::VERSION}]
+    %x[git push --tags]
+    puts "Tag #{Rango::VERSION} was created and pushed to GitHub."
+  end
+
+  desc "rubyforge", "Push sources to RubyForge."
+  def rubyforge
+    # ATM RubyForge seems to not work correctly with SSH keys
+    # puts "Pushing sources to RubyForge ..."
+    # %x[git push rubyforge master]
+    # %x[git push --tags]
+
+    puts "Pushing packages to RubyForge ..."
+    %x[rubyforge login]
+    file = Dir["pkg/*.gem"].last
+    # args: rubyforge_project gem_name gem_version gem_file
+    # sh %x[rubyforge add_release rango rango #{Rango::VERSION} #{file}]
+    # sh %x[rubyforge add_file rango rango #{Rango::VERSION} #{file}]
+  end
+
+  desc "tmbundle", "Upgrade the TextMate bundle."
+  def tmbundle
+    puts "Updating the TextMate bundle ..."
+    bundle = "Rango.tmbundle"
+    %x[rm -rf support/#{bundle}]
+    %x[cp -R "#{ENV["HOME"]}/Library/Application\ Support/TextMate/Bundles/#{bundle}" support/]
+    %x[git add support/#{bundle}]
+    %x[git commit support/Rango.tmbundle -m "Updated Rango TextMate bundle."]
+  end
+  
+  desc "twitter", "Send message to Twitter"
+  def twitter(password)
+    puts "Message have been sent to Twitter"
+    require "twitter"
+    message = "Rango #{Rango::VERSION} have been just released! Install via RubyGems from RubyForge or GitHub!"
+    %x[curl --basic --user RangoProject:#{password} --data status="#{message}" ]
+  end
+end

data/tasks/repair.thor

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+# TODO: run it as git hook before commit
+class Repair < Thor
+  desc "all", "Repair encoding, shebang and whitespace"
+  def all
+    self.encoding
+    self.shebang
+    self.whitespace
+    self.eof
+  end
+
+  desc "encoding", "Add missing coding declaration"
+  def encoding
+    ruby_files do |file, lines, original|
+      unless lines[0].match(/^# coding: utf-8\s*$/)
+        puts "Added missing coding declaration to #{file}"
+        lines.insert(0, "# coding: utf-8\n\n")
+        self.save(file, lines)
+      end
+    end
+  end
+
+  desc "shebang", "Add missing shebang and do it executable if it isn't"
+  def shebang
+    root = File.join(File.dirname(__FILE__), "..")
+    Dir["#{root}/bin/*"].each do |file|
+      lines = File.readlines(file)
+      # is executable but hasn't shebang
+      if File.executable?(file) && ! lines[0].match(/^#!/)
+        # TODO
+      # isn't executable and has shebang
+      elsif ! File.executable?(file)
+        system("chmod +x '#{file}'")
+      end
+    end
+  end
+
+  desc "whitespace", "Remove extra whitespace"
+  def whitespace
+    ruby_files do |file, lines, original|
+      lines = original.map { |line| line.chomp(" ") }
+      if original != lines
+        puts "Removed extra whitespace from #{file}"
+        self.save(file, lines)
+      end
+    end
+  end
+
+  desc "eof", "Add missing \\n to the end of files"
+  def eof
+    ruby_files do |file, lines, original|
+      unless original.last.match(/\n$/)
+        puts "Added missing \\n to the end of #{file}"
+        self.save(file, lines)
+      end
+    end
+  end
+
+  protected
+  def save(file, lines)
+    File.open(file, "w") do |file|
+      file.puts(lines)
+    end
+  end
+
+  def ruby_files(&block)
+    root = File.dirname(__FILE__)
+    Dir["#{root}/**/*.{rb,ru,thor}"].each do |file|
+      original = File.readlines(file)
+      lines = original.each { |line| line.chomp }
+      block.call(file, lines, original)
+    end
+  end
+end

data/tasks/spec.thor

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+class Spec < Thor
+  def initialize
+    gem "rspec"
+    require "spec/autorun"
+  end
+  desc "rango [path]", "Run Rango specs"
+  def rango(path = "spec")
+    spec(path, "--options", "spec/spec.opts")
+  end
+
+  desc "stubs", "Create stubs of all library files."
+  def stubs
+    Dir.glob("lib/**/*.rb").each do |file|
+      specfile = file.sub(/^lib/, "spec").sub(/\.rb$/, '_spec.rb')
+      unless File.exist?(specfile)
+        %x[mkdir -p #{File.dirname(specfile)}]
+        %x[touch #{specfile}]
+        puts "Created #{specfile}"
+      end
+    end
+    (Dir.glob("spec/rango/**/*.rb") + ["spec/rango_spec.rb"]).each do |file|
+      libfile = file.sub(/spec/, "lib").sub(/_spec\.rb$/, '.rb')
+      if !File.exist?(libfile) && File.zero?(file)
+        %x[rm #{file}]
+        puts "Removed empty file #{file}"
+      elsif !File.exist?(libfile)
+        puts "File exists just in spec, not in lib: #{file}"
+      end
+    end
+  end
+
+  def spec(*argv)
+    ARGV.clear
+    ARGV.push(*argv)
+    ::Spec::Runner::CommandLine.run
+  end
+end