ReinH-gitviz 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.1.2 Add option parsing
+
 v0.1.1 Add gemspec. Say hello to ReinH-gitviz gem.
 
 v0.1.0 Create GraphViz documents from your git history FTW

data/README.markdown

@@ -1,10 +1,16 @@
 GitViz
 ======
 
-The GitViz library creates GraphViz .dot format graphs from your git commit history.
+The GitViz library creates GraphViz dot format graphs from your git commit history.
 
     # From a git repository
-    $ gitviz master > master.dot
+    $ gitviz -O
+
+See gitviz -h for more info.
+
+## Get It ##
+
+    $ sudo gem install ReinH-gitviz
 
 ## Source Code ##
 

data/bin/gitviz

@@ -1,11 +1,58 @@
 #!/usr/bin/env ruby
 require 'rubygems'
+require 'optparse'
 require 'gitviz'
 
+BANNER = <<END
+Usage: gitviz [options] [ref]
+
+Description: Parses the given ref (default "master") of the current git
+repository and outputs its dot representation.
+
+Options:
+END
+
+options = {}
+
+op = OptionParser.new do |opts|
+  opts.banner = BANNER
+  
+  opts.on('--rankdir RANKDIR', 'Rank direction for the dot template. Default is TB (Top to Bottom)') do |rankdir|
+    options[:rankdir] = rankdir
+  end
+  
+  opts.on('-l', '--limit LIMIT', 'Limit the number of commits graphed. Default is no limit.') do |limit|
+    options[:limit] = limit.to_i
+  end
+  
+  opts.on('-O', 'Write to <ref>.dot file in current directory') do
+    options[:output] = true
+  end
+  
+  opts.on('-o NAME', 'Write to <NAME>.dot file in current directory') do |name|
+    options[:filename] = name
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end  
+end
+
 begin
-  $stdout.write GitViz::Digraph.new(ARGV)
-rescue GitViz::InvalidGitRefError => e
-  $stderr.write e.message
-  $stderr.write "\n"
-  Kernel.exit(1)
+  op.parse!(ARGV)
+  rev = ARGV.first || "master"
+  options[:filename] = rev if options[:output]
+  graph = GitViz::Digraph.new(rev, options)
+  if filename = options[:filename]
+    $stdout.puts "Writing to file #{filename}.dot"
+    File.open("#{filename}.dot", "w") {|f| f.write graph.to_s}
+  else
+    $stdout.puts graph
+  end
+  exit 0
+rescue Exception => e
+  raise e if e.is_a? SystemExit
+  $stderr.puts e.message
+  exit 1
 end

data/gitviz.gemspec

@@ -1,10 +1,10 @@
 
-# Gem::Specification for Gitviz-0.1.1
+# Gem::Specification for Gitviz-0.1.2
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{gitviz}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 

data/lib/gitviz/digraph.rb

@@ -1,9 +1,11 @@
 module GitViz
   class Digraph
-    def initialize(ref = "master")
-      raise GitViz::InvalidGitRefError.new("#{ref} is not a valid ref") unless GitViz::GitCommands::valid_ref?(ref)
+    def initialize(ref = "master", options = {})
+      raise GitViz::InvalidGitRefError.new("\"#{ref}\" is not a valid ref") unless GitViz::GitCommands::valid_ref?(ref)
       @ref = ref
+      @options = options
     end
+    attr_reader :ref
     
     def to_dot_graph
       str = digraph_head
@@ -20,18 +22,30 @@ module GitViz
     
     # Pretty object inspection
     def inspect
-      %Q{#<GitViz::Digraph "ref: #{@ref}">}
+      %Q{#<GitViz::Digraph "ref: #{ref}">}
     end
     
-    private    
+    private
+    
+    def rankdir
+      @options[:rankdir] || "TB"
+    end
+    
+    def limit
+      @options[:limit]
+    end
+    
+    # TODO: tail log output instead of slicing array
     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(' ')]}
+      heads_parents = heads_parents.map{|head, parents| [head, parents.split(' ')]}
+      heads_parents = heads_parents.first(limit) if limit
+      heads_parents
     end
     
     def digraph_head
-      "digraph {\n\trankdir=RL;\n"
+      "digraph {\n\trankdir=#{rankdir};\n"
     end
     
     def digraph_foot

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ReinH-gitviz
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Rein Henrichs