graphshaper 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphshaper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lucas Dohmen
+
+MIT License
+
+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/README.md

@@ -0,0 +1,32 @@
+# Graphshaper
+
+Graphshaper can generate realistic, scale-free graphs of any size. The resulting graph can then be saved into different kinds of databases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'graphshaper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphshaper
+
+## Usage
+
+The commandline tool expects one argument: The number of nodes you want your generated graph to have. For example:
+
+    graphshaper 50
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes – don't forget to spec them with RSpec
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/bin/graphshaper

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'graphshaper'
+
+if ARGV.length == 0 || ARGV[0] == "--help"
+  puts "  Usage: graphshaper SIZE"
+else
+  inner_nodes = 20
+  number_of_nodes = ARGV[0].to_i
+  
+  graph = Graphshaper::UndirectedGraph.without_orphans_with_order_of 20, edge_creation_logger: STDOUT
+  (number_of_nodes - inner_nodes).times do
+    graph.add_vertex do |preferential_attachment|
+      preferential_attachment > rand
+    end
+  end
+end

data/graphshaper.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/graphshaper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Lucas Dohmen"]
+  gem.email         = ["me@moonglum.net"]
+  gem.description   = %q{Graphshaper generates graphs for databases}
+  gem.summary       = %q{Graphshaper can generate realistic, scale-free graphs of any size. The resulting graph can then be saved into different kinds of databases.}
+  gem.homepage      = "http://github.com/moonglum/graphshaper"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "graphshaper"
+  gem.require_paths = ["lib"]
+  gem.version       = Graphshaper::VERSION
+  
+  gem.add_development_dependency 'rspec'
+end

data/lib/graphshaper.rb

@@ -0,0 +1,5 @@
+require "graphshaper/version"
+require "graphshaper/undirected_graph"
+
+module Graphshaper
+end

data/lib/graphshaper/undirected_graph.rb

@@ -0,0 +1,111 @@
+require "set"
+
+module Graphshaper
+  class UndirectedGraph
+    # Create a graph with a given number of vertices
+    def initialize(number_of_vertices, options_hash = {})
+      @vertex_degrees = [0] * number_of_vertices
+      @edges = Set.new
+      @unconnected_vertices = Set.new (0...number_of_vertices).to_a
+      
+      if options_hash.has_key? :edge_creation_logger
+        @edge_creation_logger = options_hash[:edge_creation_logger]
+      end
+    end
+    
+    def UndirectedGraph.without_orphans_with_order_of(number_of_vertices, options_hash = {})
+      graph = self.new number_of_vertices, options_hash
+      
+      while graph.number_of_orphans > 0
+        a = rand(graph.order)
+        while a == (b = rand(graph.order)); end
+        
+        graph.add_edge a, b
+      end
+      
+      return graph
+    end
+    
+    # the number of vertices
+    def order
+      @vertex_degrees.length
+    end
+    
+    # the number of edges
+    def size
+      @edges.length
+    end
+    
+    def add_vertex(&block)
+      @vertex_degrees << 0
+      
+      new_vertex_id = @vertex_degrees.length - 1
+      if block_given? 
+        each_vertex_with_preferential_attachment do |vertex_id, preferential_attachment|
+          add_edge new_vertex_id, vertex_id if block.call(preferential_attachment)
+        end
+      end
+    end
+    
+    def add_edge(first_vertex_id, second_vertex_id)
+      if first_vertex_id == second_vertex_id
+        raise "No Self-Referential Edge"
+      elsif first_vertex_id >= order || second_vertex_id >= order
+        raise "ID doesn't exist"
+      else
+        @unconnected_vertices.delete first_vertex_id
+        @vertex_degrees[first_vertex_id] += 1
+        @unconnected_vertices.delete second_vertex_id
+        @vertex_degrees[second_vertex_id] += 1
+        @edges << [first_vertex_id, second_vertex_id].sort
+        
+        @edge_creation_logger << "#{first_vertex_id},#{second_vertex_id}\n" if @edge_creation_logger
+      end
+    end
+    
+    def edge_between?(first_vertex_id, second_vertex_id)
+      @edges.include? [first_vertex_id, second_vertex_id]
+    end
+    
+    # The number of vertices without edges
+    def number_of_orphans
+      @unconnected_vertices.length
+    end
+    
+    def vertex_degree_for(vertex_id)
+      @vertex_degrees[vertex_id]
+    end
+    
+    def degree_distribution
+      degree_distribution = []
+      @vertex_degrees.each do |vertex_degree|
+        if degree_distribution[vertex_degree]
+          degree_distribution[vertex_degree] += 1
+        else
+          degree_distribution[vertex_degree] = 1
+        end
+      end
+      degree_distribution
+    end
+    
+    def calculate_vertex_degree_for(vertex_id)
+      @vertex_degrees[vertex_id]
+    end
+    
+    def sum_of_all_degrees
+      @edges.length * 2
+    end
+    
+    def each_vertex_with_preferential_attachment(&block)
+      if sum_of_all_degrees > 0
+        preferential_attachments = @vertex_degrees.map { |degree| degree.round(1) / sum_of_all_degrees }
+        vertex_id = 0
+        preferential_attachments.each do |preferential_attachment|
+          block.call vertex_id, preferential_attachment
+          vertex_id += 1
+        end
+      end
+    end
+
+  end
+end

data/lib/graphshaper/version.rb

@@ -0,0 +1,3 @@
+module Graphshaper
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'graphshaper'

data/spec/undirected_graph_spec.rb

@@ -0,0 +1,162 @@
+require "spec_helper"
+require "stringio" # for testing the logger
+
+describe Graphshaper::UndirectedGraph do
+  it "should create a graph with a given number of vertices and no edges" do
+    graph = Graphshaper::UndirectedGraph.new 5
+    graph.order.should ==(5)
+    graph.size.should ==(0)
+  end
+  
+  it "should create a graph with a logger for edge creation" do
+    edge_creation_logger = StringIO.new
+    graph = Graphshaper::UndirectedGraph.new 5, edge_creation_logger: edge_creation_logger
+    
+    graph.add_edge 1,3
+    graph.add_edge 2,3
+    edge_creation_logger.string.should ==("1,3\n2,3\n")
+  end
+  
+  describe "initialized graph" do
+    before :each do
+      @graph = Graphshaper::UndirectedGraph.new 5
+    end
+    
+    it "should be able to add new vertices" do
+      expect { @graph.add_vertex }.to change{ @graph.order }.by(1)
+    end
+    
+    it "should add a vertex with two existing ids" do
+      expect { @graph.add_edge 0, 1 }.to change{ @graph.size }.by(1)
+    end
+    
+    it "shouldn't add a vertex if one of the ids doesn't exist" do
+      expect { @graph.add_edge 0, 5}.to raise_error(RuntimeError, "ID doesn't exist")
+    end
+    
+    it "should answer the question if there is an edge between two vertices with false if they are not" do
+      @graph.edge_between?(0,1).should be_false
+    end
+    
+    it "should answer the question if there is an edge between two vertices with true if they are" do
+      @graph.add_edge 0,1
+      @graph.edge_between?(0,1).should be_true
+    end
+    
+    it "shouldn't add an edge that has already been added" do
+      @graph.add_edge 0,1
+      expect { @graph.add_edge 0, 1 }.to change{ @graph.size }.by(0)
+    end
+    
+    it "shouldn't add an edge that has already been added - independent of direction" do
+      @graph.add_edge 0,1
+      expect { @graph.add_edge 1,0 }.to change{ @graph.size }.by(0)
+    end
+    
+    it "should not add an edge where the first and second vertex are the same" do
+      expect { @graph.add_edge 0, 0}.to raise_error(RuntimeError, "No Self-Referential Edge")
+    end
+    
+    it "should return the graph's order for the number of orphans for a graph without vertices" do
+      @graph.number_of_orphans.should ==(@graph.order)
+    end
+    
+    it "should return 0 for the number of orphans for a graph connected in a circle" do
+      circle_array = (0...5).to_a
+      circle_array.zip(circle_array.rotate).each do |vertex_a, vertex_b|
+        @graph.add_edge vertex_a, vertex_b
+      end
+    end
+    
+    it "should calculate the vertex degree" do
+      expect { @graph.add_edge 0,1 }.to change { @graph.vertex_degree_for 1}.by(1)
+    end
+    
+    it "should calculate the degree distribution" do
+      @graph.degree_distribution.should ==[5]
+      @graph.add_edge 0,1
+      @graph.add_edge 1,2
+      @graph.degree_distribution.should ==[2,2,1]
+    end
+  end
+  
+  describe "random generated graph without orphans" do
+    before :each do
+      @graph = Graphshaper::UndirectedGraph.without_orphans_with_order_of 15
+    end
+    
+    it "should have the correct order" do
+      @graph.order.should ==(15)
+    end
+    
+    it "should have no orphans" do
+      @graph.number_of_orphans.should ==(0)
+    end
+  end
+  
+  describe "calculating the vertex's degree and preferential attachment" do
+    before :each do
+      @graph = Graphshaper::UndirectedGraph.new 5
+    end
+    
+    it "should calculate the degree of 0 for every vertex in a graph without edges" do
+      5.times do |vertex_id|
+        @graph.calculate_vertex_degree_for(vertex_id).should ==0
+      end
+    end
+    
+    it "should calculate the degree for a vertex with two edges" do
+      @graph.add_edge 0,1
+      @graph.add_edge 1,2
+      @graph.calculate_vertex_degree_for(1).should ==2
+    end
+    
+    it "should calculate the sum of all degrees" do
+      @graph.add_edge 0,1
+      @graph.add_edge 1,2
+      @graph.sum_of_all_degrees.should ==4
+    end
+    
+    it "should provide an iterator for preferential attachments that sums up to 0 for a graph without edges" do
+      sum = 0
+      @graph.each_vertex_with_preferential_attachment do |vertex_id, preferential_attachment|
+        sum += preferential_attachment
+      end
+      sum.should ==0
+    end
+    
+    it "should calculate the preferential attachments in a way that their sum is always 1 when there is at least one edge" do
+      sum = 0
+      @graph.add_edge 0,1
+      @graph.each_vertex_with_preferential_attachment do |vertex_id, preferential_attachment|
+        sum += preferential_attachment
+      end
+      sum.should ==1
+    end
+    
+    it "should add up the preferential attachments to one even if edges are added in the block" do
+      sum = 0
+      @graph.add_edge 0,1
+      @graph.each_vertex_with_preferential_attachment do |vertex_id, preferential_attachment|
+        @graph.add_edge 1,3 if @graph.size < 2
+        sum += preferential_attachment
+      end
+      sum.should ==1
+    end
+    
+    it "should add a vertex to the graph with edges according to preferential attachment" do
+      @graph.add_edge 0,1
+      
+      # Two nodes with preferential_attachment of 0.5, all others with 0
+      @graph.add_vertex do |preferential_attachment|
+        preferential_attachment > 0.4
+      end
+      
+      # One more node
+      @graph.order.should ==(6)
+      
+      # Two additional edges
+      @graph.size.should ==(3)
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: graphshaper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Dohmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70255506366760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255506366760
+description: Graphshaper generates graphs for databases
+email:
+- me@moonglum.net
+executables:
+- graphshaper
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/graphshaper
+- graphshaper.gemspec
+- lib/graphshaper.rb
+- lib/graphshaper/undirected_graph.rb
+- lib/graphshaper/version.rb
+- spec/spec_helper.rb
+- spec/undirected_graph_spec.rb
+homepage: http://github.com/moonglum/graphshaper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Graphshaper can generate realistic, scale-free graphs of any size. The resulting
+  graph can then be saved into different kinds of databases.
+test_files:
+- spec/spec_helper.rb
+- spec/undirected_graph_spec.rb