ReinH-gitviz 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.1.0 Create GraphViz documents from your git history FTW
+
+v0.0.1 Basic DOT file generation

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Rein Henrichs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,12 @@
+bin/gitviz
+CHANGELOG
+lib/gitviz/digraph.rb
+lib/gitviz/errors.rb
+lib/gitviz/git_commands.rb
+lib/gitviz.rb
+LICENSE
+Manifest
+README.markdown
+spec/gitviz_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.markdown

@@ -0,0 +1,17 @@
+GitViz
+======
+
+The GitViz library creates GraphViz .dot format graphs from your git commit history.
+
+    # From a git repository
+    $ gitviz master > master.dot
+
+## Source Code ##
+
+Main repository is at [http://github.com/ReinH/gitviz](http://github.com/ReinH/gitviz)
+
+## Contributors: ##
+* [Rein Henrichs](http://github.com/ReinH)
+
+## Special Thanks ##
+* jengelh on irc.freenode.com/git

data/bin/gitviz

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gitviz'
+
+begin
+  $stdout.write GitViz::Digraph.new(ARGV)
+rescue GitViz::InvalidGitRefError => e
+  $stderr.write e.message
+  $stderr.write "\n"
+  Kernel.exit(1)
+end

data/gitviz.gemspec

@@ -0,0 +1,38 @@
+
+# Gem::Specification for Gitviz-0.1.0
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{gitviz}
+  s.version = "0.1.0"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [""]
+  s.date = %q{2008-04-27}
+  s.default_executable = %q{gitviz}
+  s.description = %q{}
+  s.email = %q{}
+  s.executables = ["gitviz"]
+  s.extra_rdoc_files = ["bin/gitviz", "CHANGELOG", "lib/gitviz/digraph.rb", "lib/gitviz/errors.rb", "lib/gitviz/git_commands.rb", "lib/gitviz.rb", "LICENSE", "README.markdown"]
+  s.files = ["bin/gitviz", "CHANGELOG", "lib/gitviz/digraph.rb", "lib/gitviz/errors.rb", "lib/gitviz/git_commands.rb", "lib/gitviz.rb", "LICENSE", "Manifest", "README.markdown", "spec/gitviz_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "gitviz.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gitviz", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{gitviz}
+  s.rubygems_version = %q{1.0.1}
+  s.summary = %q{}
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'echoe'
+# Echoe.new('gitviz')#  do |p|
+# #   p.author  = "Rein Henrichs"
+# #   p.email   = "reinh@reinh.com"
+# #   p.summary = "GitViz generates DOT files from git commit graphs for GraphViz and great justice."
+# #   p.url     = "http://github.com/reinh/gitviz"
+# # end

data/lib/gitviz.rb

@@ -0,0 +1,3 @@
+require 'gitviz/errors'
+require 'gitviz/git_commands'
+require 'gitviz/digraph'

data/lib/gitviz/digraph.rb

@@ -0,0 +1,46 @@
+module GitViz
+  class Digraph
+    def initialize(ref = "master")
+      raise GitViz::InvalidGitRefError.new("#{ref} is not a valid ref") unless GitViz::GitCommands::valid_ref?(ref)
+      @ref = ref
+    end
+    
+    def to_dot_graph
+      str = digraph_head
+      
+      heads_parents.each do |head, parents|
+        parents.each do |parent|
+          str << digraph_edge(head, parent)
+        end
+      end
+      
+      str << digraph_foot
+    end
+    alias_method :to_s, :to_dot_graph
+    
+    # Pretty object inspection
+    def inspect
+      %Q{#<GitViz::Digraph "ref: #{@ref}">}
+    end
+    
+    private    
+    def heads_parents
+      heads_parents_log = GitViz::GitCommands::git :log, @ref, "--pretty=format:\"<%h><%p>\""
+      heads_parents = heads_parents_log.map{|line| line.scan(/^<(.*?)><(.*?)>/).flatten}
+      heads_parents.map{|head, parents| [head, parents.split(' ')]}
+    end
+    
+    def digraph_head
+      "digraph {\n\trankdir=RL;\n"
+    end
+    
+    def digraph_foot
+      "};\n"
+    end
+    
+    def digraph_edge(to, from)
+      "\t\"#{to}\" -> \"#{from}\";\n"
+    end
+  end
+
+end

data/lib/gitviz/errors.rb

@@ -0,0 +1,4 @@
+module GitViz
+  class InvalidGitRefError < StandardError
+  end
+end

data/lib/gitviz/git_commands.rb

@@ -0,0 +1,14 @@
+module GitViz
+  module GitCommands
+    class << self
+      # Thank you grit
+      def git(cmd, *args)
+        `git #{cmd} #{args.join(' ')}`.chomp
+      end
+    
+      def valid_ref?(ref)
+        not (git "show-ref", ref).empty?
+      end
+    end
+  end
+end

data/spec/gitviz_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class Git; include GitViz::GitCommands; end
+
+describe GitViz::GitCommands do
+  before(:each) do
+    @g = Git.new
+  end
+  describe "git command" do
+    it "gets the git version" do
+      GitViz::GitCommands.git(:version).should =~ /^git version [\d\.a-z]*$/
+    end
+  end
+end
+
+describe GitViz::Digraph do
+  describe "initialized with a valid reference" do  
+    before(:each) do
+      GitViz::GitCommands.should_receive(:valid_ref?).and_return(true)
+      @d = GitViz::Digraph.new
+      @log_string = "<123456><abcdef fedcba>"
+      @heads_parents = [["123456", ["abcdef", "fedcba"]]]
+    end
+    
+    it "has a pretty inspect" do
+      @d.inspect.should == %Q{#<GitViz::Digraph "ref: master">}
+    end
+  
+    it "takes heads and their parents from the log" do
+      GitViz::GitCommands.should_receive(:git).with(:log, "master", "--pretty=format:\"<%h><%p>\"").and_return(@log_string)
+      @d.send(:heads_parents).should == @heads_parents
+    end
+  
+    it "creates a dot graph from the heads and their parents" do
+      @d.should_receive(:heads_parents).and_return(@heads_parents)
+    
+      @d.to_dot_graph.should == "digraph {\n\trankdir=TB;\n\t\"123456\" -> \"abcdef\";\n\t\"123456\" -> \"fedcba\";\n};\n"
+    end
+  end
+  
+  describe "initialized with an invalid reference" do
+    before(:each) do
+      GitViz::GitCommands.should_receive(:valid_ref?).and_return(false)
+    end
+    it "raises an error" do
+      initializing_invalid_digraph = lambda { GitViz::Digraph.new("invalid")}
+      
+      initializing_invalid_digraph.should raise_error(GitViz::InvalidGitRefError)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'gitviz'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ReinH-gitviz
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- ""
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-27 00:00:00 -07:00
+default_executable: gitviz
+dependencies: []
+
+description: ""
+email: ""
+executables: 
+- gitviz
+extensions: []
+
+extra_rdoc_files: 
+- bin/gitviz
+- CHANGELOG
+- lib/gitviz/digraph.rb
+- lib/gitviz/errors.rb
+- lib/gitviz/git_commands.rb
+- lib/gitviz.rb
+- LICENSE
+- README.markdown
+files: 
+- bin/gitviz
+- CHANGELOG
+- lib/gitviz/digraph.rb
+- lib/gitviz/errors.rb
+- lib/gitviz/git_commands.rb
+- lib/gitviz.rb
+- LICENSE
+- Manifest
+- README.markdown
+- spec/gitviz_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- gitviz.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Gitviz
+- --main
+- README.markdown
+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: gitviz
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+