giraffe 0.0.1

data/README

@@ -0,0 +1,31 @@
+= Giraffe
+
+Generate graphs of the partials your Rails app uses    
+
+== Install
+
+    $ gem install giraffe
+
+== Dependencies
+
+* ruby-graphviz
+* graphviz
+
+== Usage
+    
+    g = Giraffe.new("/path/to/app/views")
+    g.generate("graph.png")
+    
+Or, more succinctly:
+    
+    Giraffe.generate("/path/to/app/views", "graph.png")
+
+== giraffe commandline
+
+    $ giraffe /path/to/app/views/ graph.png
+    
+== Todo
+
+It's pretty naive at the moment, doesn't deal with anything other than partials included by name etc...
+
+Could do with being a bit more intelligent.

data/bin/giraffe

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'lib/giraffe.rb'
+
+path, out = ARGV
+
+abort "please specify a template path and output image (giraffe /path/to/templates out.png)" unless path && out
+
+Giraffe.generate(path, out)
+
+puts "done"

data/lib/giraffe.rb

@@ -0,0 +1,71 @@
+require 'graphviz'
+
+class Giraffe
+  
+  PARTIAL_REGEX = /render\W+:partial\W+=>\W+"([\w\/]+)"/
+  
+  def self.generate(path, outfile)
+    new(path).generate(outfile)
+  end
+  
+  def initialize(path)
+    @path  = path
+    @graph = GraphViz.new(:G, :type => :digraph)
+    @nodes = {}
+  end
+  
+  def generate(outfile)
+    Dir.chdir(@path) do
+      Dir.glob("**/*.*").each do |file|
+        parse_file(file)
+      end
+    end
+    write_graph(outfile)
+  end
+  
+  def write_graph(outfile)
+    @graph.output( :png => outfile )      
+  end
+  
+  def parse_file(path)
+    File.open(path, 'r').each_line do |line|
+      if match = line.match(PARTIAL_REGEX)
+        add_edge(normalize(path), find_template(partial_path(path, match[1])))        
+      end
+    end
+  end
+  
+  private
+  
+  def partial_path(container, partial)    
+    unless partial.include? "/"
+      normalize(File.join(File.dirname(container), "_#{partial}"))
+    else
+      normalize(File.join(File.dirname(partial), "_#{File.basename(partial)}"))
+    end    
+  end
+  
+  def normalize(path)
+    File.expand_path(path, "/")
+  end
+  
+  def find_template(name)
+    "#{name}#{template_type(name)}"
+  end
+  
+  def template_type(name)
+    full_path = File.join(@path, name)
+    if template = Dir.glob("#{full_path}.*")[0]
+      template.match(/(\..+$)/)[1]
+    end
+  end
+  
+  def add_edge(template, partial)
+    @graph.add_edge(add_node(template), add_node(partial))
+  end
+  
+  def add_node(path)
+    @nodes[path] ||= @graph.add_node(path)
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: giraffe
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Richard Livsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-graphviz
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Generate graphs of your Rails app's partials
+email: richard@livsey.org
+executables: 
+- giraffe
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- lib/giraffe.rb
+has_rdoc: true
+homepage: http://github.com/rlivsey/giraffe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails template graphing
+test_files: []
+