gv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 17e83e14df49d9b53bb2d2d32106be45b59bcfde
-  data.tar.gz: 71612086bd7676a972c8f2de30e7017024694d5d
+SHA256:
+  metadata.gz: 92d208286b90fddbf8c5c1660c0ef7a9c571c4de2c798f2329456cda47b1b375
+  data.tar.gz: 247302d77d98a3709826893687b518e78bbb4c59bd7e187ab46f91c8bdbe77e2
 SHA512:
-  metadata.gz: 721459c62dd6543cc5a8510bcfc08c1abe87232dbaa621417537646d5f4b3196164b03027345b2580e00814d2a9d2dc4b5bb62812ede5fc9394023c07f67d962
-  data.tar.gz: fc708e42515acb0102f8ab9bd4d6ebea51d5bd02c8069000b1345b4ecc9e175098d9355b067aa491ac6b8f1900dc046cde4d71ca3db7ee14095cbd1be7be7b34
+  metadata.gz: 153040bdbaed5d91e3438cb2354203b1c1dd8ba0fe9e328d7b23fb3101f7160f5cea7277f23d27ff58b434e9b175044e203a5b517316400835e9b9bf4c75d584
+  data.tar.gz: 34b4de2d1454cfdd059ee0fac8f989820fc39322dd3e27eb4607363f8c4966a60886e3fd52fc45442d4168bf887e2efa6122c16b97930e7ef813560bf9eb1693

data/README.md

@@ -1,10 +1,10 @@
 [![Gem Version](https://badge.fury.io/rb/gv.svg)](https://badge.fury.io/rb/gv)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/furunkel/gv/master/frames)
+[![Inline docs](http://inch-ci.org/github/furunkel/gv.svg?branch=master)](http://inch-ci.org/github/furunkel/gv)
 [![Build Status](https://travis-ci.org/furunkel/gv.svg?branch=master)](https://travis-ci.org/furunkel/gv)
 
-# GV
+# Graphviz FFI
 
-Ruby bindings for libgvc (Graphviz) using FFI.
+Ruby bindings for libcgraph and libgvc (Graphviz) using FFI.
 
 ## Installation
 
@@ -49,6 +49,7 @@ graph = GV::Graph.load File.open('g.dot')
 # render graph
 graph.render
 ```
+See the [documentation](http://www.rubydoc.info/gems/gv) for details.
 
 ## Contributing
 

data/gv.gemspec

@@ -4,23 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gv/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gv"
+  spec.name          = 'gv'
   spec.version       = GV::VERSION
-  spec.authors       = ["furunkel"]
-  spec.email         = ["julian@linux4you.it"]
+  spec.authors       = ['furunkel']
+  spec.email         = ['furunkel@polyadic.com']
   spec.summary       = %q{Graphviz for Ruby, using libgvc via FFI}
-  spec.homepage      = "https://github.com/furunkel/gv"
-  spec.license       = "MIT"
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "yard"
+  spec.add_dependency 'ffi', '>= 1.11'
 
-  spec.add_dependency "ffi"
+  spec.add_development_dependency 'bundler', '>= 2'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'yard', '>= 0.9'
+  spec.add_development_dependency 'minitest', '>= 5.8'
+  spec.add_development_dependency 'minitest-reporters', '> 1.1'
+  spec.add_development_dependency 'rubocop', '>= 0.41'
 end

data/lib/gv/version.rb

@@ -1,3 +1,3 @@
 module GV
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/gv.rb

@@ -2,25 +2,22 @@ require 'gv/version'
 require 'ffi'
 
 module GV
-
-  module LibCGraph
+  module Libcgraph
     extend FFI::Library
 
     ffi_lib 'cgraph'
 
     class AGraph < FFI::AutoPointer
       def self.release(ptr)
-        LibCGraph.agclose(ptr) unless ptr.null?
+        Libcgraph.agclose(ptr) unless ptr.null?
       end
     end
 
-
     typedef :pointer, :ag_node
     typedef :pointer, :ag_edge
 
-
     attach_function :agmemread, [:string], AGraph
-    attach_function :agopen, [:string, :long, :pointer], AGraph
+    attach_function :agopen, %i[string long pointer], AGraph
     attach_function :agclose, [AGraph], :int
 
     attach_variable :Agundirected, :long
@@ -37,36 +34,37 @@ module GV
 
     attach_function :agtail, [:ag_edge], :ag_node
     attach_function :aghead, [:ag_edge], :ag_node
-    attach_function :agget, [:pointer, :string], :string
+    attach_function :agget, %i[pointer string], :string
 
-    attach_function :agsafeset, [:pointer, :string, :string, :string], :pointer
+    attach_function :agsafeset, %i[pointer string string string], :pointer
     attach_function :agstrdup_html, [AGraph, :string], :pointer
     attach_function :agstrfree, [AGraph, :pointer], :int
 
     attach_function :agisdirected, [AGraph], :int
     attach_function :agisstrict, [AGraph], :int
   end
-  private_constant :LibCGraph
+  private_constant :Libcgraph
 
-  module LibGVC
+  module Libgvc
     extend FFI::Library
     ffi_lib 'gvc'
 
     typedef :pointer, :gvc
 
     attach_function :gvContext, [], :pointer
-    attach_function :gvFreeLayout, [:gvc, LibCGraph::AGraph], :int
-    attach_function :gvLayout, [:gvc, LibCGraph::AGraph, :string], :int
+    attach_function :gvFreeLayout, [:gvc, Libcgraph::AGraph], :int
+    attach_function :gvLayout, [:gvc, Libcgraph::AGraph, :string], :int
 
-    attach_function :gvRenderFilename, [:gvc, LibCGraph::AGraph, :string, :string], :int
-    attach_function :gvRenderData, [:gvc, LibCGraph::AGraph, :string, :pointer, :pointer], :int
+    attach_function :gvRenderFilename, [:gvc, Libcgraph::AGraph, :string, :string], :int
+    attach_function :gvRenderData, [:gvc, Libcgraph::AGraph, :string, :pointer, :pointer], :int
     attach_function :gvFreeRenderData, [:pointer], :void
   end
-  private_constant :LibGVC
+  private_constant :Libgvc
 
+  # Common super-class for edges, nodes and graphs
   class Component
     # @!visibility private
-    @@gvc = LibGVC.gvContext()
+    @@gvc = Libgvc.gvContext
 
     # @return [Graph, SubGraph] the graph this component belongs to
     attr_reader :graph
@@ -75,9 +73,9 @@ module GV
     # @param string [String] the HTML to parse
     # @return [Object] a HTML label
     def html(string)
-      ptr = LibCGraph.agstrdup_html(graph.ptr, string)
+      ptr = Libcgraph.agstrdup_html(graph.ptr, string)
       string = ptr.read_string
-      LibCGraph.agstrfree graph.ptr, ptr
+      Libcgraph.agstrfree graph.ptr, ptr
 
       string
     end
@@ -90,11 +88,11 @@ module GV
       other.is_a?(Component) && ptr == other.ptr
     end
 
-    alias :eql? :== 
+    alias eql? ==
 
     # @return [String] the component's name
     def name
-      LibCGraph.agnameof ptr
+      Libcgraph.agnameof ptr
     end
 
     # Sets an attribute
@@ -102,7 +100,7 @@ module GV
     # @see http://www.graphviz.org/doc/info/attrs.html Node, Edge and Graph Attributes
     # @param value [Object] attribute value
     def []=(attr, value)
-      LibCGraph.agsafeset(ptr, attr.to_s, value.to_s, "")
+      Libcgraph.agsafeset(ptr, attr.to_s, value.to_s, '')
     end
 
     # Retrieves the value of an attribute
@@ -110,48 +108,52 @@ module GV
     # @see http://www.graphviz.org/doc/info/attrs.html Node, Edge and Graph Attributes
     # @return [Object] the attribute value
     def [](attr)
-      LibCGraph.agget(ptr, attr.to_s)
+      Libcgraph.agget(ptr, attr.to_s)
     end
 
     protected
+
     attr_reader :ptr
   end
 
+  # Represents a node in the graph
   class Node < Component
     def initialize(graph, name_or_ptr)
       @graph = graph
-      case name_or_ptr
-      when String
-        @ptr = LibCGraph.agnode(graph.ptr, name_or_ptr, 1)
-      else
-        @ptr = name_or_ptr
-      end
+      @ptr =
+        case name_or_ptr
+        when String
+          Libcgraph.agnode(graph.ptr, name_or_ptr, 1)
+        else
+          name_or_ptr
+        end
     end
   end
 
+  # Represents a connection between nodes
   class Edge < Component
     def initialize(graph, name, tail, head)
       @graph = graph
 
-      @ptr = LibCGraph.agedge(graph.ptr, tail.ptr, head.ptr, name, 1)
+      @ptr = Libcgraph.agedge(graph.ptr, tail.ptr, head.ptr, name, 1)
     end
 
     # @return [Node] the head node of the edge
     def head
-      Node.new @graph, LibCGraph.aghead(ptr)
+      Node.new @graph, Libcgraph.aghead(ptr)
     end
 
     # @return [Node] the tail node of the edge
     def tail
-      Node.new @graph, LibCGraph.agtail(ptr)
+      Node.new @graph, Libcgraph.agtail(ptr)
     end
   end
 
+  # Common super-class for graphs and sub-graphs
   class BaseGraph < Component
-
     # Creates a new node
     # @param name [String] the name (identifier) of the node
-    # @param attrs [Hash{String, Symbol => Object}] the attributes 
+    # @param attrs [Hash{String, Symbol => Object}] the attributes
     # to associate with this node
     # @see http://www.graphviz.org/doc/info/attrs.html Node, Edge and Graph Attributes
     # @return [Node] the newly created node
@@ -186,15 +188,16 @@ module GV
 
     # @return whether this graph is directed
     def directed?
-      LibCGraph.agisdirected(ptr) == 1
+      Libcgraph.agisdirected(ptr) == 1
     end
 
     # @return whether this graph is strict
     def strict?
-      LibCGraph.agisstrict(ptr) == 1
+      Libcgraph.agisstrict(ptr) == 1
     end
 
     private
+
     def component(klass, args, attrs = {})
       comp = klass.new self, *args
 
@@ -204,18 +207,18 @@ module GV
 
       comp
     end
-
   end
 
+  # Represents a sub-graph
   class SubGraph < BaseGraph
     def initialize(graph, name)
       @graph = graph
-      @ptr = LibCGraph.agsubg(graph.ptr, name, 1)
+      @ptr = Libcgraph.agsubg(graph.ptr, name, 1)
     end
   end
 
+  # Represents a toplevel graph
   class Graph < BaseGraph
-
     class << self
       private :new
 
@@ -227,19 +230,21 @@ module GV
       # @return [Graph] the newly created graph
       def open(name, type = :directed, strictness = :normal)
         ag_type = case [type, strictness]
-                    when [:directed, :normal] then LibCGraph.Agdirected
-                    when [:undirected, :normal] then LibCGraph.Agundirected
-                    when [:directed, :strict] then LibCGraph.Agstrictdirected
-                    when [:undirected, :strict] then LibCGraph.Agstrictundirected
-                    else
-                      raise ArgumentError, "invalid graph type #{[type, strictness]}"
-                    end
-
-        graph = new(LibCGraph.agopen(name, ag_type, FFI::Pointer::NULL))
-
-        if block_given?
-          yield graph
-        end
+                  when %i[directed normal]
+                    Libcgraph.Agdirected
+                  when %i[undirected normal]
+                    Libcgraph.Agundirected
+                  when %i[directed strict]
+                    Libcgraph.Agstrictdirected
+                  when %i[undirected strict]
+                    Libcgraph.Agstrictundirected
+                  else
+                    raise ArgumentError, "invalid graph type #{[type, strictness]}"
+                  end
+
+        graph = new(Libcgraph.agopen(name, ag_type, FFI::Pointer::NULL))
+
+        yield graph if block_given?
 
         graph
       end
@@ -249,11 +254,11 @@ module GV
       # @return the newly loaded graph
       def load(io)
         data = if io.is_a? String
-          io
-        else
-          io.read
-        end
-        new LibCGraph.agmemread(data)
+                 io
+               else
+                 io.read
+               end
+        new Libcgraph.agmemread(data)
       end
     end
 
@@ -271,9 +276,9 @@ module GV
     # @param layout [String] the layout to use, e.g. 'dot' or 'neato' etc.
     # @return [nil]
     def save(filename, format = 'png', layout = 'dot')
-      LibGVC.gvLayout(@@gvc, ptr, layout.to_s)
-      LibGVC.gvRenderFilename(@@gvc, ptr, format.to_s, filename);
-      LibGVC.gvFreeLayout(@@gvc, ptr)
+      Libgvc.gvLayout(@@gvc, ptr, layout.to_s)
+      Libgvc.gvRenderFilename(@@gvc, ptr, format.to_s, filename)
+      Libgvc.gvFreeLayout(@@gvc, ptr)
 
       nil
     end
@@ -283,19 +288,19 @@ module GV
     # @param layout [String] the layout to use, e.g. 'dot' or 'neato' etc.
     # @return [String] the rendered graph in the given format
     def render(format = 'png', layout = 'dot')
-      LibGVC.gvLayout(@@gvc, ptr, layout.to_s)
+      Libgvc.gvLayout(@@gvc, ptr, layout.to_s)
 
       data_ptr = FFI::MemoryPointer.new(:pointer, 1)
       len_ptr = FFI::MemoryPointer.new(:int, 1)
 
-      LibGVC.gvRenderData(@@gvc, ptr, format.to_s, data_ptr, len_ptr);
+      Libgvc.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 len
 
-      LibGVC.gvFreeRenderData(data_ptr)
-      LibGVC.gvFreeLayout(@@gvc, ptr)
+      Libgvc.gvFreeRenderData(data_ptr)
+      Libgvc.gvFreeLayout(@@gvc, ptr)
 
       data
     end

data/spec/graph_spec.rb

@@ -1,36 +1,37 @@
 require_relative 'spec_helper'
+require 'tmpdir'
 
 include GV
 
 describe Graph do
   describe :open do
-    it "creates a new graph" do
+    it 'creates a new graph' do
       graph = Graph.open 'test'
-      graph.directed?.must_equal true
-      graph.strict?.must_equal false
+      assert graph.directed?
+      refute graph.strict?
 
       graph = Graph.open 'test', :directed, :strict
-      graph.strict?.must_equal true
-      graph.directed?.must_equal true
+      assert graph.strict?
+      assert graph.directed?
     end
 
-    it "takes a block" do
+    it 'takes a block' do
       Graph.open 'test' do |g|
-        g.directed?.must_equal true
-        g.strict?.must_equal false
+        assert g.directed?
+        refute g.strict?
       end
     end
   end
 
   describe :load do
-    it "loads graph from file" do
+    it 'loads graph from file' do
       f = lambda do |filename|
         graph = Graph.load filename
-        graph.directed?.must_equal true
-        graph.strict?.must_equal false
-        graph.name.must_equal 'g'
+        assert graph.directed?
+        refute graph.strict?
+        assert_equal 'g', graph.name
       end
- 
+
       filename = File.join(__dir__, 'simple_graph.dot')
       file = File.open filename
       f.call file
@@ -45,12 +46,12 @@ describe Graph do
       @graph = Graph.open 'test'
     end
 
-    it "creates a new node" do
-      @graph.node('test').must_be_kind_of Node
+    it 'creates a new node' do
+      assert_kind_of Node, @graph.node('test')
     end
 
-    it "sets given attributes" do
-      @graph.node('test', color: 'green')[:color].must_equal 'green'
+    it 'sets given attributes' do
+      assert_equal 'green', @graph.node('test', color: 'green')[:color]
     end
   end
 
@@ -59,23 +60,22 @@ describe Graph do
       @graph = Graph.open 'test'
     end
 
-    it "creates a new sub graph" do
-      @graph.sub_graph('test').must_be_kind_of SubGraph
+    it 'creates a new sub graph' do
+      assert_kind_of SubGraph, @graph.sub_graph('test')
     end
 
-    it "sets given attributes" do
-      @graph.sub_graph('test', color: 'green')[:color].must_equal 'green'
+    it 'sets given attributes' do
+      assert_equal 'green', @graph.sub_graph('test', color: 'green')[:color]
     end
 
-    it "takes a block" do
+    it 'takes a block' do
       graph = @graph.sub_graph('test') do |g|
         g[:color] = 'green'
       end
-      graph[:color].must_equal 'green'
+      assert_equal 'green', graph[:color]
     end
   end
 
-
   describe :edge do
     before do
       @graph = Graph.open 'test'
@@ -83,35 +83,38 @@ describe Graph do
       @tail = @graph.node 'tail'
     end
 
-    it "creates a new edge" do
-      @graph.edge('test', @tail, @head).must_be_kind_of Edge
+    it 'creates a new edge' do
+      assert_kind_of Edge, @graph.edge('test', @tail, @head)
     end
 
-    it "sets given attributes" do
-      @graph.edge('test', @tail, @head, color: 'green')[:color].must_equal 'green'
+    it 'sets given attributes' do
+      assert_equal 'green', @graph.edge('test', @tail, @head, color: 'green')[:color]
     end
   end
 
   describe :save do
-    it "renders the graph to the given filename" 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.save filename
-      File.file?(filename).must_equal true 
-      File.unlink filename
+      Tempfile.create(%w(gv_test .png)) do |file|
+        graph.save file.path
+        assert_equal true, File.file?(file.path)
+      end
     end
   end
 
   describe :render do
-    it "renders the graph to a string" do
+    it 'renders the graph to a string' do
       graph = Graph.open 'test'
-      graph.edge 'e', graph.node('A'), graph.node('B', shape: 'polygon', label: graph.html('<b>bold</b>'))
+      graph.edge 'e', graph.node('A'),
+                 graph.node('B', shape: 'polygon',
+                                 label: graph.html('<b>bold</b>'))
+
       data = graph.render
 
       graph = nil
       GC.start
-      data.must_be_kind_of String
+      assert_kind_of String, data
 
       File.write 'spec/render.png', data
     end
@@ -127,17 +130,17 @@ describe Edge do
   end
 
   it 'gives access to head and tail' do
-    @edge.head.must_equal @head
-    @edge.tail.must_equal @tail
+    assert_equal @head, @edge.head
+    assert_equal @tail, @edge.tail
   end
 
   it 'gives access to name' do
-    @edge.name.must_equal 'test'
+    assert_equal 'test', @edge.name
   end
 
   it 'gives access to attributes' do
-    @edge[:color].must_equal nil
+    assert_nil @edge[:color]
     @edge[:color] = 'green'
-    @edge[:color].must_equal 'green'
+    assert_equal 'green', @edge[:color]
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
 require 'gv'
-require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/autorun'
+
+Minitest::Reporters.use!

metadata

@@ -1,88 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: gv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - furunkel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2'
 - !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
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '0.41'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.41'
 description: 
 email:
-- julian@linux4you.it
+- furunkel@polyadic.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -120,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Graphviz for Ruby, using libgvc via FFI
@@ -130,4 +157,3 @@ test_files:
 - spec/render.png
 - spec/simple_graph.dot
 - spec/spec_helper.rb
-has_rdoc: