dogviz 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d93013b0cc858fbd5459c5fc0794cc334df4ab7f
-  data.tar.gz: ee353c1dfe91e9b10901d2305944806b62f3e5c8
+  metadata.gz: 31b3d809039b6fea6187610fe47505f1cf0639db
+  data.tar.gz: 7583c3283f29685564c878ed13c2ba7ede152cf5
 SHA512:
-  metadata.gz: 76aa31f77889f81eae728587e3660ed9650b09a04a1fced9fe87699631870a73f98f62f0acfccb9af84399b7f68c380f177df846ce13aa2458e99561061c4499
-  data.tar.gz: 7fa12c43c393cb7714e697bebdece5fb387d72df776a96aea8ec794932b56593158b906c9bb8e68e2999dd893174cea158e2e92b76c8a5968062b7cdc02e867c
+  metadata.gz: e4f8f6c9cd2008a5505209b94e2ce954e2b60b9aa11bcd163b99be003a1f2bc58410373715645c813ef6830db98c0a8ce244db9cc2e5db83631aad5192eba1e7
+  data.tar.gz: fe9f06499d86dd083df1bbaf26051e3b50876b011fbb740ade31254e97469a0e40454398c6c37f703aafc91c38450aabfae1cb1e8b18c52afbb9fc9cd9f22d65

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "vendor/bundle"
+BUNDLE_DISABLE_SHARED_GEMS: "true"

data/.gitignore

@@ -4,3 +4,4 @@ coverage
 sys.rb
 dogviz*gem
 Gemfile.lock
+vendor/

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.4.1

data/lib/dogviz/container.rb

@@ -9,7 +9,7 @@ module Dogviz
     include Parent
 
     attr_reader :parent
-    attr_reader :name, :id, :node, :render_id, :render_type, :render_options, :children
+    attr_reader :name, :id, :node, :render_type, :render_options, :children
 
     def initialize(parent, name, options = {})
       @children = []
@@ -23,8 +23,9 @@ module Dogviz
       init_rollup options
 
       setup_render_attributes label: name
+      default_bounded_option(options)
 
-      @render_options = options.merge inherited_render_options
+      @render_options = options.merge(inherited_render_options)
 
       parent.register name, self
     end
@@ -56,18 +57,12 @@ module Dogviz
 
     def do_render_subgraph(renderer)
       @render_type = :subgraph
-      render_id = cluster_prefix + id
-      attributes = @attributes
-      @render_id = render_id
-      @subgraph = renderer.render_subgraph(parent, render_id, render_options, attributes)
+      @subgraph = renderer.render_subgraph(parent, id, render_options.merge(@attributes))
     end
 
     def do_render_node(renderer)
       @render_type = :node
-      @render_id = id
-      render_id = @render_id
-      attributes = @attributes
-      renderer.render_node(parent, render_id, render_options, attributes)
+      renderer.render_node(parent, id, render_options.merge(@attributes))
     end
 
     def init_rollup(options)
@@ -76,13 +71,12 @@ module Dogviz
       options.delete(:rollup)
     end
 
-    def cluster_prefix
-      is_cluster = true
-      if @render_options.has_key? :cluster
-        is_cluster = @render_options[:cluster]
-        @render_options.delete :cluster
+    def default_bounded_option(options)
+      bounded = true
+      if options.has_key? :bounded
+        bounded = options[:bounded]
       end
-      cluster_prefix = (is_cluster ? 'cluster_' : '')
+      options[:bounded] = bounded
     end
   end
 end

data/lib/dogviz/graphviz_renderer.rb

@@ -10,6 +10,7 @@ module Dogviz
       @graph[hints]
       @subgraphs = {}
       @nodes = {}
+      @rendered_subgraph_ids = {}
     end
 
     def render_edge(from, other, options)
@@ -20,34 +21,45 @@ module Dogviz
       edge
     end
 
-    def render_node(parent, id, options, attributes)
-      clean_node_options options
-      default_options = {:shape => 'box', :style => ''}
-      node = parent_node(parent).add_nodes(id, default_options.merge(options))
-      apply_render_attributes node, attributes
+    def render_node(parent, id, attributes)
+      clean_node_attributes attributes
+      default_attributes = {:shape => 'box', :style => ''}
+      merged_attributes = default_attributes.merge(attributes)
+      node = parent_node(parent).add_nodes(id, merged_attributes)
     end
 
-    def render_subgraph(parent, id, options, attributes)
-      subgraph = parent_node(parent).add_graph(id, options)
-      apply_render_attributes subgraph, attributes
+    def render_subgraph(parent, id, attributes)
+      if (attributes[:bounded] == true) then
+        rendered_id = 'cluster_' + id
+      else
+        rendered_id = id
+      end
+      @rendered_subgraph_ids[id] = rendered_id
+
+      subgraph = parent_node(parent).add_graph(rendered_id, clean_subgraph_attributes(attributes.clone))
       @subgraphs[id] = subgraph
       subgraph
     end
 
     private
 
-    def clean_node_options(options)
-      options.delete(:rank)
-      options.delete(:cluster)
-      options
+    def clean_node_attributes(attributes)
+      attributes.delete(:rank)
+      attributes.delete(:bounded)
+      attributes
+    end
+
+    def clean_subgraph_attributes(attributes)
+      attributes.delete(:bounded)
+      attributes
     end
 
     def parent_node(parent)
-      return graph unless parent.respond_to?(:render_id)
-      node = graph.search_node(parent.render_id)
+      return graph if parent.root?
+      node = graph.search_node(parent.id)
       return node unless node.nil?
-      subgraph = @subgraphs[parent.render_id]
-      raise "couldn't find node or graph: #{parent.render_id}, out of graphs: #{graph_ids}" if subgraph.nil?
+      subgraph = @subgraphs[parent.id]
+      raise "couldn't find node or graph: #{parent.id}, out of graphs: #{graph_ids}" if subgraph.nil?
       subgraph
     end
 

data/lib/dogviz/logical_container.rb

@@ -2,7 +2,7 @@ require_relative 'container'
 module Dogviz
   class LogicalContainer < Container
     def initialize(parent, name, options)
-      super parent, name, options.merge(cluster: false)
+      super parent, name, options.merge(bounded: false)
     end
   end
 end

data/lib/dogviz/nominator.rb

@@ -2,7 +2,7 @@ module Dogviz
   module Nominator
     def nominate(names_to_nominees)
       names_to_nominees.each { |name, nominee|
-        self.class.send(:define_method, name) do
+        define_singleton_method name do
           nominee
         end
       }

data/lib/dogviz/parent.rb

@@ -34,5 +34,9 @@ module Dogviz
       @children << child
       child
     end
+
+    def root?
+      not respond_to?(:parent)
+    end
   end
 end

data/lib/dogviz/sigma_graph_hash.rb

@@ -18,8 +18,8 @@ module Dogviz
 
     def get_json_filename(type_to_filename)
       type = type_to_filename.keys.first
-      raise StandardError.new('json output only supported') unless type == :json
+      raise StandardError.new("json output only supported, not #{type}") unless type == :json
       type_to_filename[type]
     end
   end
-end
+end

data/lib/dogviz/sigma_renderer.rb

@@ -12,8 +12,14 @@ module Dogviz
       SigmaGraphHash.new(nodes: nodes, edges: edges)
     end
 
-    def render_node(parent, id, render_options, attributes)
+    def render_node(parent, id, attributes)
       @nodes << {id: id, label: id}
+      @edges << {
+          id: "#{parent.id}->#{id}",
+          type: 'containment',
+          source: parent.id,
+          target: id
+      } unless parent.root?
     end
 
     def render_edge(from, to, options)
@@ -25,8 +31,22 @@ module Dogviz
       }
     end
 
+    def render_subgraph(parent, id, attributes)
+      @nodes << {id: container_label(id), type: 'container', label: container_label(id)}
+      @edges << {
+          id: "#{container_label parent.id}->#{container_label id}",
+          type: 'containment',
+          source: container_label(parent.id),
+          target: container_label(id)
+      } unless parent.root?
+    end
+
     private
 
+    def container_label(id)
+      id
+    end
+
     attr_reader :nodes, :edges
   end
-end
+end

data/lib/dogviz/thing.rb

@@ -43,6 +43,9 @@ module Dogviz
       other
     end
 
+    alias_method :to, :points_to
+    alias_method :to_all, :points_to_all
+
     def render(renderer)
       do_render_node(renderer) unless in_rollup? || in_skip?
     end
@@ -56,9 +59,7 @@ module Dogviz
     private
 
     def do_render_node(renderer)
-      render_options = @render_options
-      attributes = @attributes
-      renderer.render_node(parent, id, render_options, attributes)
+      renderer.render_node(parent, id, @render_options.merge(@attributes))
     end
 
     def setup_render_edge(other, options)

data/lib/dogviz/version.rb

@@ -1,3 +1,3 @@
 module Dogviz
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

data/tests/graph_checking.rb

@@ -3,6 +3,10 @@ module GraphChecking
     subgraphs.map(&:id)
   end
 
+  def subgraph_ids_without_cluster_prefixes
+    subgraph_ids.map {|id| id.gsub /^cluster_/, '' }
+  end
+
   def subgraph(id)
     subgraphs.find {|sub| sub.id == id }
   end

data/tests/test_container.rb

@@ -30,7 +30,7 @@ module Tests
     def test_container_exposes_inherited_render_options_from_parent
       inheritable_options = {fontname: 'glyphoz'}
       parent.render_options = inheritable_options
-      assert_equal inheritable_options, Container.new(parent, 'container').render_options
+      assert_equal 'glyphoz', Container.new(parent, 'container').render_options[:fontname]
     end
   end
 end

data/tests/test_dogviz_functionally.rb

@@ -52,5 +52,16 @@ module Tests
       assert_equal ['chases', 'follows', 'parents', 'ignores'], graph.names_of.edges
     end
 
+    def test_allows_rank_specification
+      sys = Family.new
+      sys.logical_container 'sinker', rank: 'sink'
+
+      sys.output dot: outfile('dot')
+
+      dotspec = File.read outfile('dot')
+
+      assert_match /rank=sink/, dotspec
+    end
+
   end
 end

data/tests/test_dogviz_graph.rb

@@ -115,11 +115,17 @@ class TestDogvizGraph < Test::Unit::TestCase
   end
 
   class Dog
+    def initialize(name)
+      @name = name.to_s
+    end
+    def inspect
+      "dog #{@name}"
+    end
   end
   def test_nominate_elevates_values_as_method_on_group
     group = sys.group('g')
 
-    dog = Dog.new
+    dog = Dog.new 'a'
 
     group.nominate foobar: :any_value, dog: dog
 
@@ -127,6 +133,20 @@ class TestDogvizGraph < Test::Unit::TestCase
     assert_equal dog, group.dog
   end
 
+  def test_nominates_with_same_name_on_different_containers_work_together
+    group1 = sys.group('g1')
+    group2 = sys.group('g2')
+
+    dog1 = Dog.new 1
+    dog2 = Dog.new 2
+
+    group1.nominate dog: dog1
+    group2.nominate dog: dog2
+
+    assert_equal dog1, group1.dog
+    assert_equal dog2, group2.dog
+  end
+
   def test_nominate_from_delegates_multiple_accessors
     outer = sys.group('outer')
     nested = outer.group('nested')

data/tests/test_dogviz_graphviz_rendering.rb

@@ -56,17 +56,17 @@ class TestDogvizGraphvizRendering < Test::Unit::TestCase
 
     graph
 
-    assert_equal([top.render_id, nested.render_id], subgraph_ids)
+    assert_equal([top.id, nested.id], subgraph_ids_without_cluster_prefixes)
 
-    top_subgraph = subgraph(top.render_id)
-    nested_subgraph = subgraph(nested.render_id)
+    top_subgraph = subgraph('cluster_' + top.id)
+    nested_subgraph = subgraph('cluster_' + nested.id)
 
     assert_equal(top_thing.id, top_subgraph.get_node(top_thing.id).id)
     assert_equal(nested_thing.id, nested_subgraph.get_node(nested_thing.id).id)
     assert_nil(top_subgraph.get_node(nested_thing.id), 'should not be in other container')
     assert_nil(nested_subgraph.get_node(top_thing.id), 'should not be in other container')
   end
-
+  
   def test_point_into_target_in_container
     container = sys.container('container')
     target = container.thing('target')
@@ -348,4 +348,22 @@ class TestDogvizGraphvizRendering < Test::Unit::TestCase
     assert_equal('thread->haystack_nested_hidden_away_needle', connections)
   end
 
+  def test_can_use_to_method_to_point_to_things
+    a = sys.thing 'a'
+    b = sys.thing 'b'
+    c = sys.thing 'c'
+    a.to(b).to(c)
+
+    assert_equal('a->b b->c', connections)
+  end
+
+  def test_can_use_to_all_method_to_point_to_things
+    a = sys.thing 'a'
+    b = sys.thing 'b'
+    c = sys.thing 'c'
+    a.to_all b, c
+
+    assert_equal('a->b a->c', connections)
+  end
+
 end

data/tests/test_dogviz_sigma_rendering.rb

@@ -23,6 +23,55 @@ class TestDogvizSigmaRendering < Test::Unit::TestCase
     assert_equal({nodes: [ { id: 'a', label: 'a' }], edges: []}, graph)
   end
 
+  def test_includes_containers_with_appropriate_types
+    sys.container('c').thing('a')
+
+    graph = sys.render(:sigma)
+
+    assert_equal({
+                     nodes: [
+                         { id: 'c', type: 'container', label: 'c' },
+                         { id: 'c_a', label: 'c_a' }
+                     ],
+                     edges: [
+                         {
+                             id: 'c->c_a',
+                             type: 'containment',
+                             source: 'c',
+                             target: 'c_a'
+                         }
+                     ]
+                 }, graph)
+  end
+
+  def test_includes_nested_containers_modelled_with_containment_edges
+    sys.container('c').container('cc').thing('x')
+
+    graph = sys.render(:sigma)
+
+    assert_equal({
+                     nodes: [
+                         { id: 'c', type: 'container', label: 'c' },
+                         { id: 'c_cc', type: 'container', label: 'c_cc' },
+                         { id: 'c_cc_x', label: 'c_cc_x' }
+                     ],
+                     edges: [
+                         {
+                             id: 'c->c_cc',
+                             type: 'containment',
+                             source: 'c',
+                             target: 'c_cc'
+                         },
+                         {
+                             id: 'c_cc->c_cc_x',
+                             type: 'containment',
+                             source: 'c_cc',
+                             target: 'c_cc_x'
+                         }
+                     ]
+                 }, graph)
+  end
+
   def test_renders_two_linked_nodes
     sys.thing('a').points_to sys.thing('b')
 
@@ -54,15 +103,15 @@ class TestDogvizSigmaRendering < Test::Unit::TestCase
   end
 
   def test_output_requires_type
-    assert_raise_with_message(StandardError, /provide hash/) {
+    assert_raise_message(/provide hash/) {
       sys.render(:sigma).output 'file'
     }
   end
 
   def test_json_only_output
-    assert_raise_with_message(StandardError, /json.*only/) {
+    assert_raise_message(/json.*only/) {
       sys.render(:sigma).output xml: 'xmlfile'
     }
   end
 
-end
+end

data/tests/test_thing.rb

@@ -6,9 +6,9 @@ module Tests
     include Dogviz
 
     class StubRenderer
-      attr_reader :last_node_options, :last_edge_options
-      def render_node(parent, id, render_options, attributes)
-        @last_node_options = render_options.merge attributes
+      attr_reader :last_node_attributes, :last_edge_options
+      def render_node(parent, id, attributes)
+        @last_node_attributes = attributes
       end
       def render_edge(from, other, options)
         @last_edge_options = options
@@ -45,7 +45,7 @@ module Tests
 
       thing.render renderer
 
-      assert_equal 'funky-font', renderer.last_node_options[:fontname]
+      assert_equal 'funky-font', renderer.last_node_attributes[:fontname]
     end
 
     def test_thing_edges_rendered_with_inherited_fontname

data/todo.txt

@@ -1,7 +1,9 @@
-* render generic output (sigma.js json) for ingestion -> unity
-* move from inheritance -> better encaps
+* spike 'autostrap': automatically strap-on reader methods using normalised name
+* [DONE] render generic output (sigma.js json) for ingestion -> space-dog
 * sort out fore vs back color
-* move out any graphviz specifics from main models, e.g. colorize
+* [DONE] move 'cluster_' prefix to graphviz renderer
 * clean up init options + render attributes - not v clear / overlapping
-* separate style from domain-specific elements (can use same view-manipulation selection mechanisms)
 * make style attributes well defined -> less leaky + explicit graphviz passthroughs
+* separate style from domain-specific elements (can use same view-manipulation selection mechanisms)
+* move out any graphviz specifics from main models, e.g. colorize
+* move from inheritance -> better encaps

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogviz
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - damned
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: domain object graph visualisation