graphshaper 0.2.1 → 0.2.2

data/README.md

@@ -20,9 +20,17 @@ Or install it yourself as:
 
 ## Usage
 
-The commandline tool expects one argument: The number of vertices you want your generated graph to have. This will result in two CSV files containing your vertices and edges. For example:
+The commandline tool expects one argument: The number of vertices you want your generated graph to have. This is how to use it:
 
-    graphshaper 50
+    graphshaper [options] size
+
+You can use the following options:
+
+* `-a`, `--avocado`: Store the graph in a local AvocadoDB instance
+* `-l`, `--log`: Store the graph in two CSV files for nodes and edges
+* `-d`, `--dot`: Store the graph in the dot format
+* `-p`, `--png`: Export the graph as a PNG (you need to install graphviz for that – circo is used for the layout)
+* `--version`: Show version
 
 You can also use the library in your Ruby Code. You can find the documentation [here](http://rubydoc.info/github/moonglum/graphshaper).
 

data/bin/graphshaper

@@ -1,40 +1,95 @@
 #!/usr/bin/env ruby
 
 require 'graphshaper'
+require 'optparse'
 
-if ARGV.length == 0 || ARGV[0] == "--help"
-  puts "  Usage: graphshaper SIZE"
-elsif ARGV[0].to_i < 21
-  puts "Please choose a size of at least 21"
-else
-  number_of_vertices = ARGV[0].to_i
-  inner_vertices = 20
-  
-  vertex_output_file = File.new "vertices.csv", "w"
-  edge_output_file = File.new "edges.csv", "w"
-  logger = Graphshaper::LoggingAdapter.new vertex_output_file, edge_output_file
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: graphshaper [options] size"
   
-  avocado_db = Graphshaper::AvocadoDbAdapter.new "vertices", "edges"
+  opts.on("-a", "--avocado", "Store the graph in a local AvocadoDB instance") do |avocado|
+    options[:avocado] = avocado
+  end
   
-  start_time = Time.now
-  graph = Graphshaper::UndirectedGraph.without_orphans_with_order_of inner_vertices, adapters: [logger, avocado_db]
-  (number_of_vertices - inner_vertices).times do
-    graph.add_vertex do |preferential_attachment|
-      preferential_attachment > rand
-    end
+  opts.on("-l", "--log", "Store the graph in two CSV files for nodes and edges") do |log|
+    options[:log] = log
   end
-  end_time = Time.now
   
-  ellapsed_time = end_time - start_time
+  opts.on("-d", "--dot", "Store the graph in the dot format") do |dot|
+    options[:dot] = dot
+  end
   
-  puts "#{graph.order} vertices (saved to vertices.csv)"
-  puts "#{graph.size} edges (saved to edges.csv)"
+  opts.on("-p", "--png", "Export the graph as a PNG (graphviz must be installed)") do |png|
+    options[:dot] = png
+    options[:png] = png
+  end
   
-  if ellapsed_time < 2
-    puts "Generated and saved in about one second"
-  elsif ellapsed_time < 60
-    puts "Generated and saved in about #{ellapsed_time.round} seconds"
-  else
-    puts "Generated and saved in about #{ellapsed_time.round / 60} minutes and #{ellapsed_time.round % 60} seconds"
+  opts.on_tail("--version", "Show version") do
+    puts Graphshaper::VERSION
+    exit
   end
+  
+  opts.parse!
+end
+
+if ARGV.length == 0
+  puts "Please enter a size for your graph."
+  exit
+end
+
+number_of_vertices = ARGV.first.to_i
+inner_vertices = 20
+  
+adapters = []
+open_files = []
+  
+if options[:log]
+  vertex_output_file = File.new "vertices.csv", "w"
+  open_files << vertex_output_file
+  edge_output_file = File.new "edges.csv", "w"
+  open_files << edge_output_file
+  adapters << Graphshaper::LoggingAdapter.new(vertex_output_file, edge_output_file)
 end
+
+if options[:avocado]
+  adapters << Graphshaper::AvocadoDbAdapter.new("vertices", "edges")
+end
+
+if options[:dot]
+  dot_output_file = File.new "generated_graph.dot", "w"
+  open_files << dot_output_file
+  dot_adapter = Graphshaper::DotAdapter.new(dot_output_file)
+  adapters << dot_adapter
+end
+
+start_time = Time.now
+
+graph = Graphshaper::UndirectedGraph.without_orphans_with_order_of inner_vertices, adapters: adapters
+(number_of_vertices - inner_vertices).times do
+  graph.add_vertex { |preferential_attachment| preferential_attachment > rand }
+end
+
+dot_adapter.close if options[:dot]
+
+ellapsed_time = Time.now - start_time
+
+print "#{graph.order} vertices and #{graph.size} edges generated"
+
+print " and saved into AvocadoDB" if options[:avocado]
+print " and logged" if options[:log]
+print " and generated as a dot" if options[:dot]
+
+open_files.each { |file| file.close }
+
+if options[:png]
+  system('circo -Tpng generated_graph.dot -o generated_graph.png')
+end
+
+if ellapsed_time < 2
+  puts " in about one second"
+elsif ellapsed_time < 60
+  puts " in about #{ellapsed_time.round} seconds"
+else
+  puts " in about #{ellapsed_time.round / 60} minutes and #{ellapsed_time.round % 60} seconds"
+end

data/lib/graphshaper/adapters/dot_adapter.rb

@@ -0,0 +1,20 @@
+module Graphshaper
+  class DotAdapter
+    def initialize(output_file)
+      @output_file = output_file
+      @output_file << "digraph genereated_graph { \n  rankdir=LR;\n  node [shape = circle];\n  edge [dir=none];\n"
+    end
+    
+    def close
+      @output_file << "}"
+    end
+    
+    def add_edge(edge_id, in_id, out_id)
+      @output_file << "  #{in_id} -> #{out_id} [ label = \"#{edge_id}\" ];\n"
+    end
+    
+    def add_vertex(vertex_id)
+      @output_file << "  #{vertex_id};\n"
+    end
+  end
+end

data/lib/graphshaper/version.rb

@@ -1,3 +1,3 @@
 module Graphshaper
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/graphshaper.rb

@@ -2,6 +2,7 @@ require "graphshaper/version"
 require "graphshaper/undirected_graph"
 require "graphshaper/adapters/avocadodb_adapter"
 require "graphshaper/adapters/logging_adapter"
+require "graphshaper/adapters/dot_adapter"
 
 module Graphshaper
 end

data/spec/adapters/dot_adapter_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Graphshaper::DotAdapter do
+  before :each do
+    @output_file = double()
+    @output_file.stub :<<
+  end
+  
+  it "should write a header into the file" do
+    @output_file.should_receive(:<<).with("digraph genereated_graph { \n  rankdir=LR;\n  node [shape = circle];\n  edge [dir=none];\n")
+    Graphshaper::DotAdapter.new @output_file
+  end
+  
+  describe "initialized Dot Adapter" do
+    before :each do
+      @dot_adapter = Graphshaper::DotAdapter.new @output_file
+    end
+    
+    it "should be closeable" do
+      @output_file.should_receive(:<<).with("}")
+      @dot_adapter.close
+    end
+    
+    it "should write an edge in the correct format" do
+      @output_file.should_receive(:<<).with("  1 -> 2 [ label = \"0\" ];\n")
+      @dot_adapter.add_edge(0,1,2)
+    end
+    
+    it "should write a vertex in the correct format" do
+      @output_file.should_receive(:<<).with("  15;\n")
+      @dot_adapter.add_vertex(15)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphshaper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70277557670180 !ruby/object:Gem::Requirement
+  requirement: &70255428363860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70277557670180
+  version_requirements: *70255428363860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70277557669680 !ruby/object:Gem::Requirement
+  requirement: &70255428363360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70277557669680
+  version_requirements: *70255428363360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70277557669220 !ruby/object:Gem::Requirement
+  requirement: &70255428362900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70277557669220
+  version_requirements: *70255428362900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70277557668760 !ruby/object:Gem::Requirement
+  requirement: &70255428362440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70277557668760
+  version_requirements: *70255428362440
 description: Generate realistic graphs
 email:
 - me@moonglum.net
@@ -73,9 +73,11 @@ files:
 - graphshaper.gemspec
 - lib/graphshaper.rb
 - lib/graphshaper/adapters/avocadodb_adapter.rb
+- lib/graphshaper/adapters/dot_adapter.rb
 - lib/graphshaper/adapters/logging_adapter.rb
 - lib/graphshaper/undirected_graph.rb
 - lib/graphshaper/version.rb
+- spec/adapters/dot_adapter_spec.rb
 - spec/adapters/logging_adapter_spec.rb
 - spec/spec_helper.rb
 - spec/undirected_graph_spec.rb
@@ -104,6 +106,7 @@ signing_key:
 specification_version: 3
 summary: Graphshaper can generate realistic, scale-free graphs of any size.
 test_files:
+- spec/adapters/dot_adapter_spec.rb
 - spec/adapters/logging_adapter_spec.rb
 - spec/spec_helper.rb
 - spec/undirected_graph_spec.rb