sankey 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jan Stępień
+
+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.rdoc

@@ -0,0 +1,11 @@
+= Sankey
+
+A small tool which generates Sankey diagrams.
+
+= Dependencies
+
+* {rmagick}[http://rmagick.rubyforge.org/]
+
+= Usage
+
+See +examples/coffee.rb+.

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'rake'
+
+desc "Run rdoc"
+task :rdoc do
+  print `rdoc -a -S -N -w 2 -U -o doc/rdoc README.rdoc lib`
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'sankey'
+    gemspec.summary = 'Sankey diagrams generator'
+    gemspec.description = 'A small tool which generates Sankey diagrams.'
+    gemspec.email = 'jstepien@users.sourceforge.net'
+    gemspec.homepage = "http://github.com/jstepien/sankey"
+    gemspec.authors = ['Jan Stępień']
+    gemspec.files.exclude '.gitignore'
+    gemspec.add_dependency 'rmagick'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/coffee.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -I../lib
+require 'sankey'
+require 'renderers/rvg'
+
+g = Sankey::Generator.new
+beans = Sankey::Reagent.new 100
+ground_coffee = Sankey::Reagent.new 100
+water = Sankey::Reagent.new 200
+beverage = Sankey::Reagent.new 280
+crema = Sankey::Reagent.new 20
+espresso_machine = Sankey::Process.new
+grinder = Sankey::Process.new
+beans.drain = grinder
+water.drain = espresso_machine
+ground_coffee.drain = espresso_machine
+ground_coffee.source = grinder
+beverage.source = espresso_machine
+crema.source = espresso_machine
+g.processes.push espresso_machine
+g.processes.push grinder
+g.go!
+p = Sankey::Renderers::RVG.new g.data, "espresso.png"
+p.render

data/lib/generator.rb

@@ -0,0 +1,233 @@
+require 'processvertex'
+require 'point'
+require 'imagedata'
+
+module Sankey
+  class Generator
+    attr_reader :processes, :data
+
+    ProcessWidth = 40
+    ProcessLayerStep = 100
+    ProcessSideStep = 50
+    Margin = 5
+    InputReagentsStep = 20
+    OutputReagentsStep = 20
+
+    def initialize
+      @processes = []
+    end
+
+    def go!
+      @processes_vertices = {}
+      @drawn_reagents = []
+      @vertices = []
+      @input_reagent_offset = Margin
+      @below_next_process_offset = {}
+      @process_input_offset = {}
+      @process_output_left_offset = {}
+      @process_output_right_offset = {}
+      get_max_distances_to_processes
+      to_be_drawn = []
+      input_reagents.each { |r| to_be_drawn.push r }
+      until to_be_drawn.empty? do
+        STDERR.puts "to draw"
+        to_be_drawn.each { |r| STDERR.puts "  " + r.to_s + " " + r.name }
+        not_drawn = []
+        to_be_drawn.each { |r| not_drawn += recursively_draw r }
+        to_be_drawn = not_drawn.uniq
+      end
+      make_coordinates_positive
+      w, h = get_size
+      @data = ImageData.new @vertices, w, h
+    end
+
+    private
+
+    # Moves all vertices so that there are no negative coordinates.
+    def make_coordinates_positive
+      min_y = @vertices[0].points[0].y
+      min_x = @vertices[0].points[0].x
+      @vertices.each do |v|
+        v.points.each do |p|
+          min_y = [min_y, p.y].min
+          min_x = [min_x, p.x].min
+        end
+      end
+      min_x -= Margin
+      STDERR.puts "Vector: #{-min_x} -#{-min_y}."
+      vector = [-min_x, -min_y]
+      @vertices.each do |v|
+        v.points.map! do |p|
+          p + vector
+        end
+      end
+    end
+
+    def get_max_distances_to_processes(reagent = nil, level = 0)
+      if reagent.nil?
+        @max_distances_to_processes = {}
+        input_reagents.each { |r| get_max_distances_to_processes r }
+      elsif !reagent.drain.nil?
+        new_level = level + 1
+        if @max_distances_to_processes[reagent.drain].nil? or
+          @max_distances_to_processes[reagent.drain] < new_level
+          @max_distances_to_processes[reagent.drain] = new_level
+        end
+        reagent.drain.output.each do |r|
+          get_max_distances_to_processes r, new_level
+        end
+      end
+    end
+
+    def draw_process(process)
+      layer = @max_distances_to_processes[process] - 1
+      height = process.total_reagents_mass
+      corner = Point.new (layer+1)*(ProcessLayerStep+ProcessWidth) + Margin,
+        Margin
+      v = ProcessVertex.new corner, corner + [0, height],
+        corner + [ProcessWidth, height], corner + [ProcessWidth, 0]
+      @vertices.push v
+      @processes_vertices[process] = v
+      # Initialize @below_next_process_offset
+      process.input.each do |r|
+        unless r.source.nil?
+          @below_next_process_offset[r.source] = Margin + height
+          break
+        end
+      end
+    end
+
+    def recursively_draw(reagent)
+      return [] if @drawn_reagents.include? reagent
+      STDERR.puts "    drawing " + reagent.name if reagent.name != ""
+      if reagent.drain.nil?
+        if reagent.source.is_first_in_output_queue reagent
+          draw_output_reagent reagent
+          reagent.source.remove_from_output_queue reagent
+        else
+          STDERR.puts "      later"
+          return [reagent]
+        end
+      elsif reagent.source.nil?
+        if reagent.drain.is_first_in_input_queue reagent
+          draw_input_reagent reagent
+          reagent.drain.remove_from_input_queue reagent
+        else
+          STDERR.puts "      later"
+          return [reagent]
+        end
+      else
+        if reagent.drain.is_first_in_input_queue(reagent) and
+            reagent.source.is_first_in_output_queue(reagent)
+          draw_middle_reagent reagent
+          reagent.source.remove_from_output_queue reagent
+          reagent.drain.remove_from_input_queue reagent
+        else
+          #STDERR.puts reagent.drain.is_first_in_input_queue(reagent)
+          #STDERR.puts reagent.source.is_first_in_output_queue(reagent)
+          STDERR.puts "      later"
+          return [reagent]
+        end
+      end
+      @drawn_reagents.push reagent
+      to_draw_later = []
+      unless reagent.drain.nil?
+        reagent.drain.output.each { |r| to_draw_later += recursively_draw r }
+      end
+      to_draw_later
+    end
+
+    def draw_middle_reagent(reagent)
+      left_height = reagent.source.total_reagents_mass *
+        reagent.source.fraction(reagent)
+      right_height = reagent.drain.total_reagents_mass *
+        reagent.drain.fraction(reagent)
+      [reagent.source, reagent.drain].each do |p|
+        draw_process p unless @processes_vertices.include? p
+      end
+      @process_input_offset[reagent.drain] ||= 0
+      @process_output_left_offset[reagent.source] ||= 0
+      left_corner = @processes_vertices[reagent.source].output_edge[:top] +
+        [0, @process_output_left_offset[reagent.source]]
+      right_corner = @processes_vertices[reagent.drain].input_edge[:top] +
+        [0, @process_input_offset[reagent.drain]]
+      v = Vertex.new
+      v.points.push left_corner
+      v.points.push left_corner + [0, left_height]
+      v.points.push right_corner + [0, right_height]
+      v.points.push right_corner
+      @vertices.push v
+      @process_input_offset[reagent.drain] += right_height
+      @process_output_left_offset[reagent.source] += left_height
+    end
+
+    def draw_input_reagent(reagent)
+      draw_process reagent.drain unless @processes_vertices.include? reagent.drain
+      height = reagent.drain.total_reagents_mass * reagent.drain.fraction(reagent)
+      @process_input_offset[reagent.drain] ||= 0
+      v = Vertex.new
+      if @process_input_offset[reagent.drain] == 0 and reagent.joins_later
+        left_corner = @processes_vertices[reagent.drain].input_edge[:top] +
+          [-ProcessSideStep, -height]
+      else
+        left_corner = Point.new Margin, @input_reagent_offset
+      end
+      v.points.push left_corner
+      v.points.push left_corner + [5, height / 2]
+      v.points.push left_corner + [0, height]
+      v.points.push @processes_vertices[reagent.drain].input_edge[:top] +
+        [0, @process_input_offset[reagent.drain] + height]
+      v.points.push @processes_vertices[reagent.drain].input_edge[:top] +
+        [0, @process_input_offset[reagent.drain]]
+      @vertices.push v
+      @input_reagent_offset += height + InputReagentsStep
+      @process_input_offset[reagent.drain] += height
+    end
+
+    def draw_output_reagent(reagent)
+      height = reagent.source.total_reagents_mass *
+        reagent.source.fraction(reagent)
+      @process_output_left_offset[reagent.source] ||= 0
+      @process_output_right_offset[reagent.source] ||= 0
+      right_offset = @process_output_right_offset[reagent.source] +
+        (@below_next_process_offset[reagent.source] ||= 0)
+      left_corner = @processes_vertices[reagent.source].output_edge[:top] +
+        [0, @process_output_left_offset[reagent.source]]
+      v = Vertex.new
+      v.points.push left_corner
+      v.points.push left_corner + [0, height]
+      v.points.push left_corner +
+        [ProcessLayerStep, right_offset + height]
+      v.points.push left_corner +
+        [ProcessLayerStep + 5, right_offset + height / 2]
+      v.points.push left_corner +
+        [ProcessLayerStep, right_offset]
+      @vertices.push v
+      @process_output_left_offset[reagent.source] += height
+      @process_output_right_offset[reagent.source] += height + InputReagentsStep
+    end
+
+    def input_reagents
+      return @input_reagents if defined? @input_reagents
+      @input_reagents = []
+      @processes.each do |process|
+        process.input.each do |reagent|
+          @input_reagents.push reagent if reagent.source.nil?
+        end
+      end
+      @input_reagents.uniq!
+      @input_reagents
+    end
+
+    def get_size
+      w = h = 0
+      @vertices.each do |vertex|
+        vertex.points.each do |point|
+          w = point.x + Margin if point.x + Margin > w
+          h = point.y + Margin if point.y + Margin > h
+        end
+      end
+      return w, h
+    end
+  end
+end

data/lib/imagedata.rb

@@ -0,0 +1,11 @@
+module Sankey
+  class ImageData
+    attr_reader :vertices, :width, :height
+
+    def initialize(vertices, width, height)
+      @vertices = vertices
+      @width = width
+      @height = height
+    end
+  end
+end

data/lib/point.rb

@@ -0,0 +1,20 @@
+module Sankey
+  class Point
+    attr_reader :x, :y
+
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+
+    def +(val)
+      if val.is_a? Array and 2 == val.count
+        x = val[0]
+        y = val[1]
+      else
+        throw "Invalid argument"
+      end
+      Point.new @x + x, @y + y
+    end
+	end
+end

data/lib/process.rb

@@ -0,0 +1,83 @@
+module Sankey
+  class Process
+    attr_reader :input, :output
+
+    def initialize
+      @input = []
+      @output = []
+      @input_reagents_queue = {}
+      @output_reagents_queue = {}
+    end
+
+    def fraction(reagent)
+      side = nil
+      [@output, @input].each { |io| side = io if io.include? reagent }
+      throw "Reagent isn't present in this process" if side.nil?
+      sum = 0
+      side.each { |r| sum += r.size }
+      reagent.size * 1.0 / sum
+    end
+
+    def total_reagents_mass
+      check_conservation_of_mass
+    end
+
+    def add_output(reagent, order = nil)
+      @output.push reagent
+      @output_reagents_queue[order] = reagent unless order.nil?
+    end
+
+    def add_input(reagent, order = nil)
+      @input.push reagent
+      @input_reagents_queue[order] = reagent unless order.nil?
+    end
+
+    def remove_from_input_queue(reagent)
+      key_to_be_removed = nil
+      @input_reagents_queue.each do |key, val|
+        key_to_be_removed = key if val == reagent
+      end
+      @input_reagents_queue.delete key_to_be_removed
+    end
+
+    def remove_from_output_queue(reagent)
+      key_to_be_removed = nil
+      @output_reagents_queue.each do |key, val|
+        key_to_be_removed = key if val == reagent
+      end
+      @output_reagents_queue.delete key_to_be_removed
+    end
+
+    def is_first_in_input_queue(reagent)
+      min_key = nil
+      return true unless @input_reagents_queue.values.include? reagent
+      @input_reagents_queue.each do |key, val|
+        #STDERR.puts "#{key} -> #{val.name}"
+        min_key ||= key
+        min_key = [min_key, key].min
+      end
+      @input_reagents_queue[min_key] == reagent
+    end
+
+    def is_first_in_output_queue(reagent)
+      min_key = nil
+      return true unless @output_reagents_queue.values.include? reagent
+      @output_reagents_queue.each do |key, val|
+        min_key ||= key
+        min_key = [min_key, key].min
+      end
+      @output_reagents_queue[min_key] == reagent
+    end
+
+  private
+
+    def check_conservation_of_mass
+      input_sum = output_sum = 0
+      @input.each { |r| input_sum += r.size }
+      @output.each { |r| output_sum += r.size }
+      throw 'Conservation of mass constraint failed: ' +
+        "#{input_sum} != #{output_sum}" if input_sum != output_sum
+      input_sum
+    end
+  end
+end

data/lib/processvertex.rb

@@ -0,0 +1,18 @@
+require 'vertex'
+
+module Sankey
+  class ProcessVertex < Vertex
+    def initialize(a, b, c, d)
+      super()
+      [a, b, c, d].each { |x| @points.push x }
+    end
+
+    def input_edge
+      {:bottom => @points[1], :top => @points[0]}
+    end
+
+    def output_edge
+      {:bottom => @points[2], :top => @points[3]}
+    end
+	end
+end

data/lib/reagent.rb

@@ -0,0 +1,40 @@
+module Sankey
+  class Reagent
+    attr_reader :size, :source, :drain, :name
+
+    def initialize(size, name = '')
+      @size = size
+      @name = name
+    end
+
+    def source=(process)
+      process.add_output self
+      @source = process
+    end
+
+    def drain=(process)
+      process.add_input self
+      @drain = process
+    end
+
+    def add_drain(process, order = nil)
+      process.add_input self, order
+      @drain = process
+    end
+
+    def add_source(process, order = nil)
+      process.add_output self, order
+      @source= process
+    end
+
+    def joins_later
+      drain.input.each do |r|
+        next if r == self
+        if r.source != nil
+          return true
+        end
+      end
+      false
+    end
+  end
+end

data/lib/renderers/renderer.rb

@@ -0,0 +1,7 @@
+module Sankey::Renderers
+  module Renderer
+    def render
+      throw 'Not implemented'
+    end
+	end
+end

data/lib/renderers/rvg.rb

@@ -0,0 +1,65 @@
+require 'renderers/renderer'
+require 'rvg/rvg'
+require 'imagedata'
+
+module Sankey::Renderers
+  class RVG
+    include Renderer
+    include Sankey
+
+    def initialize(data, filename = nil, args = {})
+      throw "data isn't ImageData" unless data.is_a? ImageData
+      @grid = args[:grid] || false
+      @vertices = data.vertices
+      @filename = filename
+      @width = args[:width] || data.width
+      @height = args[:height] || data.height
+      @width_ratio = 1.0 * @width / data.width
+      @height_ratio = 1.0 * @height / data.height
+    end
+
+    def render
+      canvas = Magick::ImageList.new
+      canvas.new_image(@width, @height)
+      draw_grid canvas if @grid
+      @vertices.each { |v| draw_vertex canvas, v }
+      if @filename.nil?
+        return canvas.to_blob { self.format = 'PNG' }
+      else
+        canvas.write @filename
+      end
+    end
+
+  private
+
+    def draw_grid(canvas)
+      grid = Magick::Draw.new
+      grid.stroke = 'lightgray'
+      grid.stroke_width = 1
+      0.upto @width/@grid/@width_ratio do |x|
+        grid.line @width_ratio*(x*@grid+@grid-1), 0,
+          (x*@grid+@grid-1)*@width_ratio, @height
+      end
+      0.upto @height/@grid/@height_ratio do |x|
+        grid.line 0, (x*@grid+@grid-1)*@height_ratio, @width,
+          (x*@grid+@grid-1)*@height_ratio
+      end
+      grid.draw canvas
+    end
+
+    def draw_vertex(canvas, v)
+      vertex = Magick::Draw.new
+      vertex.stroke = 'black'
+      vertex.stroke_width = 1
+      first_x = prev_x = v.points.first.x * @width_ratio
+      first_y = prev_y = v.points.first.y * @height_ratio
+      v.points.each do |p|
+        vertex.line prev_x, prev_y, p.x * @width_ratio, p.y * @height_ratio
+        prev_x = p.x * @width_ratio
+        prev_y = p.y * @height_ratio
+      end
+      vertex.line prev_x, prev_y, first_x, first_y
+      vertex.draw canvas
+    end
+  end
+end

data/lib/sankey.rb

@@ -0,0 +1,3 @@
+require 'process'
+require 'reagent'
+require 'generator'

data/lib/vertex.rb

@@ -0,0 +1,9 @@
+module Sankey
+  class Vertex
+    attr_reader :points
+
+    def initialize
+      @points = []
+    end
+	end
+end

data/sankey.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sankey}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan Stępień"]
+  s.date = %q{2010-02-18}
+  s.description = %q{A small tool which generates Sankey diagrams.}
+  s.email = %q{jstepien@users.sourceforge.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/coffee.rb",
+     "lib/generator.rb",
+     "lib/imagedata.rb",
+     "lib/point.rb",
+     "lib/process.rb",
+     "lib/processvertex.rb",
+     "lib/reagent.rb",
+     "lib/renderers/renderer.rb",
+     "lib/renderers/rvg.rb",
+     "lib/sankey.rb",
+     "lib/vertex.rb",
+     "sankey.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jstepien/sankey}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sankey diagrams generator}
+  s.test_files = [
+    "examples/coffee.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rmagick>, [">= 0"])
+    else
+      s.add_dependency(%q<rmagick>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rmagick>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: sankey
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- "Jan St\xC4\x99pie\xC5\x84"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A small tool which generates Sankey diagrams.
+email: jstepien@users.sourceforge.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/coffee.rb
+- lib/generator.rb
+- lib/imagedata.rb
+- lib/point.rb
+- lib/process.rb
+- lib/processvertex.rb
+- lib/reagent.rb
+- lib/renderers/renderer.rb
+- lib/renderers/rvg.rb
+- lib/sankey.rb
+- lib/vertex.rb
+- sankey.gemspec
+has_rdoc: true
+homepage: http://github.com/jstepien/sankey
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Sankey diagrams generator
+test_files: 
+- examples/coffee.rb