gv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdabad8208f3857d6f16f16b5db3d7e005def7a2
+  data.tar.gz: 5e9d9f1993de38f9e43b80ac61e3f8d75e37c9c4
+SHA512:
+  metadata.gz: 8f74f1b224cf335ad1f9328379b1de48d176c169d82499faabe0fe9a2661791b62576dc7540d40719d1e79f4f474c2afbbf99a89263f6e8264b78609cecefaa8
+  data.tar.gz: 680ecfbd1bd2dd1269aaa43706eaa1f7513c1c9249c234e85bbabdeae61b426d05d2c428aba36043aaeb810c3f4f7049c3bc446e304cf810f8465b162f545ca1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 furunkel
+
+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,31 @@
+# GV
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gv
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gv/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.pattern = "spec/*_spec.rb"
+end

data/gv.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gv"
+  spec.version       = GV::VERSION
+  spec.authors       = ["furunkel"]
+  spec.email         = ["julian@linux4you.it"]
+  spec.summary       = %q{Graphviz for Ruby, using libgvc directly via FFI}
+  spec.homepage      = "https://github.com/furunkel/gv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "ffi"
+end

data/lib/gv.rb

@@ -0,0 +1,226 @@
+require 'gv/version'
+require 'ffi'
+
+module GV
+
+  module FFI
+    extend ::FFI::Library
+
+    ffi_lib 'gvc', 'cgraph', 'cgraph'
+
+    class AGraph < ::FFI::ManagedStruct
+      # dummy layout, only ever used by reference
+      layout :_1, :int,
+             :_2, :int
+
+      def self.release(ptr)
+        FFI.agclose(ptr) unless ptr.null?
+      end
+    end
+
+    typedef :pointer, :gvc
+    typedef :pointer, :ag_node
+    typedef :pointer, :ag_edge
+
+    attach_function :gvContext, [], :pointer
+    attach_function :gvFreeLayout, [:gvc, AGraph.by_ref], :int
+    attach_function :gvLayout, [:gvc, AGraph.by_ref, :string], :int
+
+    attach_function :gvRenderFilename, [:gvc, AGraph.by_ref, :string, :string], :int
+    attach_function :gvRenderData, [:gvc, AGraph.by_ref, :string, :pointer, :pointer], :int
+    attach_function :gvFreeRenderData, [:pointer], :void
+
+    attach_function :agmemread, [:string], AGraph.by_ref
+    attach_function :agopen, [:string, :long, :pointer], AGraph.by_ref
+    attach_function :agclose, [AGraph.by_ref], :int
+
+    attach_variable :Agundirected, :long
+    attach_variable :Agstrictundirected, :long
+    attach_variable :Agdirected, :long
+    attach_variable :Agstrictdirected, :long
+
+    attach_function :agnode, [AGraph.by_ref, :string, :int], :ag_node
+    attach_function :agedge, [AGraph.by_ref, :ag_node, :ag_node, :string, :int], :ag_edge
+    attach_function :agsubg, [AGraph.by_ref, :string, :int], :pointer
+
+    attach_function :agnameof, [:pointer], :string
+    attach_function :agraphof, [:pointer], :pointer
+
+    attach_function :agtail, [:ag_edge], :ag_node
+    attach_function :aghead, [:ag_edge], :ag_node
+    attach_function :agget, [:pointer, :string], :string
+
+    attach_function :agsafeset, [:pointer, :string, :string, :string], :pointer
+    attach_function :agstrdup_html, [:pointer, :string], :string
+    attach_function :agstrfree, [:pointer, :string], :int
+
+    attach_function :agisdirected, [AGraph.by_ref], :int
+    attach_function :agisstrict, [AGraph.by_ref], :int
+  end
+
+  class Component
+    @@gvc = FFI.gvContext()
+
+    attr_reader :graph
+
+    def hash
+      ptr.hash
+    end
+
+    def ==(other)
+      other.is_a?(Component) && ptr == other.ptr
+    end
+
+    alias :eql? :== 
+
+    def name
+      FFI.agnameof ptr
+    end
+
+    def []=(attr, value)
+      FFI.agsafeset(ptr, attr.to_s, value.to_s, "")
+    end
+
+    def [](attr)
+      FFI.agget(ptr, attr.to_s)
+    end
+
+    protected
+    attr_reader :ptr
+  end
+
+  class Node < Component
+    def initialize(graph, name_or_ptr)
+      @graph = graph
+      case name_or_ptr
+      when String
+        @ptr = FFI.agnode(graph.ptr, name_or_ptr, 1)
+      else
+        @ptr = name_or_ptr
+      end
+    end
+  end
+
+  class Edge < Component
+    def initialize(graph, name, tail, head)
+      @graph = graph
+
+      @ptr = FFI.agedge(graph.ptr, tail.ptr, head.ptr, name, 1)
+    end
+
+    def head
+      Node.new @graph, FFI.aghead(ptr)
+    end
+
+    def tail
+      Node.new @graph, FFI.agtail(ptr)
+    end
+  end
+
+  class BaseGraph < Component
+
+    def node(name, attrs = {})
+      component Node, [name], attrs
+    end
+
+    def edge(name, tail, head, attrs = {})
+      component Edge, [name, tail, head], attrs
+    end
+
+    def graph(name, attrs = {})
+      graph = component SubGraph, [name], attrs
+      yield graph if block_given?
+
+      graph
+    end
+
+    def directed?
+      FFI.agisdirected(ptr) == 1
+    end
+
+    def strict?
+      FFI.agisstrict(ptr) == 1
+    end
+
+    private
+    def component(klass, args, attrs = {})
+      comp = klass.new self, *args
+
+      attrs.each do |attr, value|
+        comp[attr] = value
+      end
+
+      comp
+    end
+
+  end
+
+  class SubGraph < BaseGraph
+    def initialize(graph, name)
+      @graph = graph
+      @ptr = FFI.agsubg(graph.ptr, name, 1)
+    end
+  end
+
+  class Graph < BaseGraph
+
+    class << self
+      private :new
+      def open(name, type = :directed, strict = :normal)
+        ag_type = case [type, strict]
+                    when [:directed, :normal] then FFI.Agdirected
+                    when [:undirected, :normal] then FFI.Agundirected
+                    when [:directed, :strict] then FFI.Agstrictdirected
+                    when [:undirected, :strict] then FFI.Agstrictundirected
+                    else
+                      raise ArgumentError, "invalid graph type #{[type, strict]}"
+                    end
+
+        graph = new(FFI.agopen(name, ag_type, ::FFI::Pointer::NULL))
+
+        if block_given?
+          yield graph
+        end
+
+        graph
+      end
+
+      def load(io)
+        data = if io.is_a? String
+          io
+        else
+          io.read
+        end
+        new FFI.agmemread(data)
+      end
+    end
+
+    def initialize(ptr)
+      @ptr = ptr
+    end
+
+    def write(filename, format = 'png', layout = 'dot')
+      FFI.gvLayout(@@gvc, ptr, layout.to_s)
+      FFI.gvRenderFilename(@@gvc, ptr, format.to_s, filename);
+      FFI.gvFreeLayout(@@gvc, ptr)
+    end
+
+    def render(format = 'png', layout = 'dot')
+      FFI.gvLayout(@@gvc, ptr, layout.to_s)
+
+      data_ptr = ::FFI::MemoryPointer.new(:pointer, 1)
+      len_ptr = ::FFI::MemoryPointer.new(:int, 1)
+
+      FFI.gvRenderData(@@gvc, ptr, format.to_s, data_ptr, len_ptr);
+      len = len_ptr.read_uint
+      data_ptr = data_ptr.read_pointer
+      
+      data = data_ptr.read_string_length len
+
+      FFI.gvFreeRenderData(data_ptr)
+      FFI.gvFreeLayout(@@gvc, ptr)
+
+      data
+    end
+  end
+end

data/lib/gv/version.rb

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

data/spec/graph_spec.rb

@@ -0,0 +1,143 @@
+require_relative 'spec_helper'
+
+include GV
+
+describe Graph do
+  describe :open do
+    it "creates a new graph" do
+      graph = Graph.open 'test'
+      graph.directed?.must_equal true
+      graph.strict?.must_equal false
+
+      graph = Graph.open 'test', :directed, :strict
+      graph.strict?.must_equal true
+      graph.directed?.must_equal true
+    end
+
+    it "takes a block" do
+      graph = Graph.open 'test' do |g|
+        g.directed?.must_equal true
+        g.strict?.must_equal false
+      end
+    end
+  end
+
+  describe :load do
+    it "loads graph from file" do
+      f = lambda do |f|
+        graph = Graph.load f
+        graph.directed?.must_equal true
+        graph.strict?.must_equal false
+        graph.name.must_equal 'g'
+      end
+ 
+      filename = File.join(__dir__, 'simple_graph.dot')
+      file = File.open filename
+      f.call file
+      file.close
+
+      f.call File.read(filename)
+    end
+  end
+
+  describe :node do
+    before do
+      @graph = Graph.open 'test'
+    end
+
+    it "creates a new node" do
+      @graph.node('test').must_be_kind_of Node
+    end
+
+    it "sets given attributes" do
+      @graph.node('test', color: 'green')[:color].must_equal 'green'
+    end
+  end
+
+  describe :graph do
+    before do
+      @graph = Graph.open 'test'
+    end
+
+    it "creates a new subgraph" do
+      @graph.graph('test').must_be_kind_of SubGraph
+    end
+
+    it "sets given attributes" do
+      @graph.graph('test', color: 'green')[:color].must_equal 'green'
+    end
+
+    it "takes a block" do
+      graph = @graph.graph('test') do |g|
+        g[:color] = 'green'
+      end
+      graph[:color].must_equal 'green'
+    end
+  end
+
+
+  describe :edge do
+    before do
+      @graph = Graph.open 'test'
+      @head = @graph.node 'head'
+      @tail = @graph.node 'tail'
+    end
+
+    it "creates a new edge" do
+      @graph.edge('test', @tail, @head).must_be_kind_of Edge
+    end
+
+    it "sets given attributes" do
+      @graph.edge('test', @tail, @head, color: 'green')[:color].must_equal 'green'
+    end
+  end
+
+  describe :write do
+    it "renders the graph to the given filename" do
+      graph = Graph.open 'test'
+      graph.edge 'e', graph.node('A'), graph.node('B')
+      filename = File.join Dir.tmpdir, Dir::Tmpname.make_tmpname(['gv_test', '.png'], nil)
+      graph.write filename
+      File.file?(filename).must_equal true 
+      File.unlink filename
+    end
+  end
+
+  describe :render do
+    it "renders the graph to a string" do
+      graph = Graph.open 'test'
+      graph.edge 'e', graph.node('A'), graph.node('B', shape: 'polygon')
+      data = graph.render
+
+      graph = nil
+      GC.start
+      data.must_be_kind_of String
+
+      File.write 'spec/render.png', data
+    end
+  end
+end
+
+describe Edge do
+  before do
+    @graph = Graph.open 'test'
+    @head = @graph.node 'head'
+    @tail = @graph.node 'tail'
+    @edge = Edge.new @graph, 'test', @tail, @head
+  end
+
+  it 'gives access to head and tail' do
+    @edge.head.must_equal @head
+    @edge.tail.must_equal @tail
+  end
+
+  it 'gives access to name' do
+    @edge.name.must_equal 'test'
+  end
+
+  it 'gives access to attributes' do
+    @edge[:color].must_equal nil
+    @edge[:color] = 'green'
+    @edge[:color].must_equal 'green'
+  end
+end

data/spec/simple_graph.dot

@@ -0,0 +1,6 @@
+digraph g {
+  A1 -> B1;
+  A2 -> B2;
+  A3 -> B3;
+}
+ 

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'gv'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: gv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- furunkel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- julian@linux4you.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gv.gemspec
+- lib/gv.rb
+- lib/gv/version.rb
+- spec/graph_spec.rb
+- spec/render.png
+- spec/simple_graph.dot
+- spec/spec_helper.rb
+homepage: https://github.com/furunkel/gv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Graphviz for Ruby, using libgvc directly via FFI
+test_files:
+- spec/graph_spec.rb
+- spec/render.png
+- spec/simple_graph.dot
+- spec/spec_helper.rb