dogviz 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c23418b41abd8b0f615a020215d9968d0fc4721
-  data.tar.gz: 6d551216ea306d8a32a2ea800185cea191d3a4b9
+  metadata.gz: f52b08f82c2ec0119948a8fbf396929b2a6acffc
+  data.tar.gz: 775a8100eff08d29605903ec9023aa0033d9bec2
 SHA512:
-  metadata.gz: 59c857b69bf82a837eb7415e3e4ed3e7fffba9a368e46665efef66a603015d79eb7ae23764b5cc706fb90997d161263270a1b9062d86a239354078df5171acb2
-  data.tar.gz: a623e7f949b62d1998167796e14d6fb386625a10839dc0ac2aad62faf410c4fcc6a944d75c53134e9e5db8b3c23afc83935ca23e96f4bbb2726b31958630e2a5
+  metadata.gz: e23bb1161e281cafc883f1a0b2021b1c17863b290c6c946a55ccc55cdd2c341a0e3be6161999e37695f5444b816a741eaf89ce7ef2e57969aaf2836d0d44f84f
+  data.tar.gz: ac257f552ae52796cad6d490fbea55c27ba71b15bc182b717626387485f959467179f170a351f2c1e2eb510631f8f1a701dd421ca87822e0f9c17b05352c3038

data/dogviz.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'colorize', '~> 0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
 
   spec.add_dependency 'ruby-graphviz', '~> 1'
 end

data/lib/dogviz/version.rb

@@ -1,3 +1,3 @@
 module Dogviz
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/dogviz.rb

@@ -8,9 +8,6 @@ module Dogviz
       parts += name.split /\s/
       parts.join '_'
     end
-    def graph
-      parent.graph
-    end
     def root
       ancestors.last
     end
@@ -36,6 +33,15 @@ module Dogviz
       @rollup = true
       self
     end
+    def skip!
+      @skip = true
+      self
+    end
+
+    def skip?
+      @skip
+    end
+
     def under_rollup?
       ancestors.any? &:rollup?
     end
@@ -88,6 +94,7 @@ module Dogviz
       @id = create_id(name, parent)
       @pointers = []
       @rollup = false
+      @skip = false
       @edge_heads = []
 
       rollup! if options[:rollup]
@@ -105,10 +112,6 @@ module Dogviz
       renderer.render_node(parent, id, render_options, attributes)
     end
 
-    def node
-      graph.find_node(id)
-    end
-
     def points_to_all(*others)
       others.each {|other|
         points_to other
@@ -117,16 +120,11 @@ module Dogviz
 
     def points_to(other, options = {})
       setup_render_edge(other, options)
-    end
-
-    def pointees
-      pointers.map {|e|
-        e[:other]
-      }
+      other
     end
 
     def render(renderer)
-      do_render_node(renderer) unless in_rollup?
+      do_render_node(renderer) unless in_rollup? || skip?
     end
 
     def render_edges(renderer)
@@ -159,14 +157,40 @@ module Dogviz
         from = from.parent
       end
 
-      return if from == self && from.in_rollup?
+      return if from.skip?
 
+      return if from == self && from.in_rollup?
       return if from == other
-      return if edge_heads.include? other
+      return if already_added_connection?(other)
 
-      edge_heads << other
-      render_options = pointer[:options]
-      renderer.render_edge(from, other, render_options)
+      if other.skip?
+        others = resolve_skipped_others other
+      else
+        others = [other]
+      end
+
+      others.each do |other|
+        edge_heads << other
+        render_options = pointer[:options]
+        renderer.render_edge(from, other, render_options)
+      end
+    end
+
+    def already_added_connection?(other)
+      edge_heads.include? other
+    end
+
+    def resolve_skipped_others(skipped)
+      resolved = []
+      skipped.pointers.each {|pointer|
+        next_in_line = pointer[:other]
+        if next_in_line.skip?
+          resolved += resolve_skipped_others next_in_line
+        else
+          resolved << next_in_line
+        end
+      }
+      resolved
     end
   end
 
@@ -182,6 +206,7 @@ module Dogviz
       @parent = parent
       @name = name
       @id = create_id(name, parent)
+      @skip = false
 
       init_rollup options
 
@@ -215,14 +240,6 @@ module Dogviz
       }
     end
 
-    def node
-      if render_type == :node
-        graph.find_node(render_id)
-      elsif render_type == :subgraph
-        @subgraph
-      end
-    end
-
     private
 
     def do_render_subgraph(renderer)
@@ -337,10 +354,6 @@ module Dogviz
       @rendered = false
     end
 
-    def node
-      graph
-    end
-
     def output(*args)
       render
       out = graph.output *args

data/tests/setup_tests.rb

@@ -0,0 +1,3 @@
+require "test/unit"
+require_relative '../lib/dogviz'
+SimpleCov.root('..') if Object.const_defined?('SimpleCov')

data/tests/svg_graph.rb

@@ -0,0 +1,72 @@
+require 'nokogiri'
+
+module Tests
+  class NamesAccessor
+    def initialize(graph)
+      @graph = graph
+    end
+    def containers
+      names @graph.container_nodes
+    end
+    def things
+      names @graph.thing_nodes
+    end
+    def edges
+      names @graph.edge_nodes
+    end
+
+    private
+    attr_reader :graph
+
+    def names(nodes)
+      nodes.map { |g|
+        g.css('text').text
+      }
+    end
+  end
+
+  class SvgGraph
+    def self.parse_file(svg_filename)
+      SvgGraph.new File.read(svg_filename)
+    end
+
+    def initialize(svg)
+      @doc = Nokogiri::XML(svg) {|config| config.noblanks }
+    end
+
+    def title
+      title_prefix = '<!-- Title: '
+      title_end = ' Pages: '
+      title_node_text = comments.find { |c|
+        c.to_s.start_with? title_prefix
+      }.to_s
+      title_node_text.gsub(title_prefix, '').split(title_end).first
+    end
+
+    def container_nodes
+      @doc.css 'g.cluster'
+    end
+
+    def thing_nodes
+      @doc.css 'g.node'
+    end
+
+    def edge_nodes
+      @doc.css 'g.edge'
+    end
+
+    def names_of
+      NamesAccessor.new self
+    end
+
+    def to_s
+      @doc.to_xml indent: 2
+    end
+
+    private
+
+    def comments
+      @doc.children.select &:comment?
+    end
+  end
+end

data/tests/test_dogviz_functionally.rb

@@ -0,0 +1,45 @@
+require_relative 'setup_tests'
+require_relative 'svg_graph'
+
+module Tests
+  class TestDogvizFunctionally < Test::Unit::TestCase
+
+    def svg_outfile
+      '/tmp/dogviz_functional_test.svg'
+    end
+
+    def setup
+      File.delete svg_outfile if File.exist?(svg_outfile)
+    end
+
+    include Dogviz
+    def test_outputs_svg_graph
+
+      sys = System.new 'family'
+
+      house = sys.container 'household'
+
+      cat = house.thing 'cat'
+      dog = house.thing 'dog'
+
+      mum = house.thing 'mum'
+      son = house.thing 'son'
+
+      mum.points_to son, name: 'parents'
+      son.points_to mum, name: 'respects'
+
+      cat.points_to dog, name: 'chases'
+      dog.points_to son, name: 'follows'
+
+      sys.output svg: svg_outfile
+
+      graph = SvgGraph.parse_file svg_outfile
+
+      assert_include graph.title, 'family'
+      assert_equal ['household'], graph.names_of.containers
+      assert_equal ['cat', 'dog', 'son', 'mum'], graph.names_of.things
+      assert_equal ['chases', 'follows', 'parents', 'respects'], graph.names_of.edges
+    end
+
+  end
+end

data/tests/{test_sisvis_graph.rb → test_dogviz_graph.rb}

@@ -1,6 +1,4 @@
-require "test/unit"
-
-require_relative '../lib/dogviz'
+require_relative 'setup_tests'
 
 class TestDogvizGraph < Test::Unit::TestCase
   include Dogviz
@@ -80,4 +78,12 @@ class TestDogvizGraph < Test::Unit::TestCase
     })
   end
 
+  def test_root
+    group = sys.group('g')
+    nested_group = group.group('nested group')
+    thing1 = group.thing('n1')
+
+    assert_equal sys, thing1.root
+  end
+
 end

data/tests/{test_sisvis_graphviz_rendering.rb → test_dogviz_graphviz_rendering.rb}

@@ -1,6 +1,4 @@
-require "test/unit"
-
-require_relative '../lib/dogviz'
+require_relative 'setup_tests'
 
 class TestDogvizGraphvizRendering < Test::Unit::TestCase
   include Dogviz
@@ -171,6 +169,110 @@ class TestDogvizGraphvizRendering < Test::Unit::TestCase
     assert_equal('entry->group group->exit', connections)
   end
 
+  def test_skip_one_thing_with_one_onward_connection
+    a = sys.thing('a')
+    b = sys.thing('b')
+    c = sys.thing('c')
+
+    a.points_to b
+    b.points_to c
+
+    b.skip!
+
+    assert_equal('a->c', connections)
+  end
+
+  def test_skip_one_thing_with_multiple_onward_connections
+    a = sys.thing('a')
+    b = sys.thing('b')
+    out1 = sys.thing('out1')
+    out2 = sys.thing('out2')
+
+    a.points_to b
+    b.points_to_all out1, out2
+
+    b.skip!
+
+    assert_equal('a->out1 a->out2', connections)
+  end
+
+  def test_skip_one_thing_with_multiple_inward_connections
+    in1 = sys.thing('in1')
+    in2 = sys.thing('in2')
+    skipper = sys.thing('skipper')
+    out = sys.thing('out')
+
+    in1.points_to skipper
+    in2.points_to skipper
+    skipper.points_to out
+
+    skipper.skip!
+
+    assert_equal('in1->out in2->out', connections)
+  end
+
+  def test_skip_one_thing_with_multiple_inward_and_outward_connections
+    in1 = sys.thing('in1')
+    in2 = sys.thing('in2')
+    skipper = sys.thing('skipper')
+    out1 = sys.thing('out1')
+    out2 = sys.thing('out2')
+
+    in1.points_to skipper
+    in2.points_to skipper
+    skipper.points_to out1
+    skipper.points_to out2
+
+    skipper.skip!
+
+    assert_equal('in1->out1 in1->out2 in2->out1 in2->out2', connections)
+  end
+
+  def test_skip_multiple_things_with_one_onward_connection
+    start = sys.thing('start')
+    skip1 = sys.thing('skip1')
+    skip2 = sys.thing('skip2')
+    skip3 = sys.thing('skip3')
+    finish = sys.thing('finish')
+
+    start.points_to(skip1).points_to(skip2).points_to(skip3).points_to finish
+
+    skip1.skip!
+    skip2.skip!
+    skip3.skip!
+
+    assert_equal('start->finish', connections)
+  end
+
+  def test_skip_multiple_things_with_multiple_onward_connections
+    start = sys.thing('start')
+    skip1 = sys.thing('skip1')
+    skip2 = sys.thing('skip2')
+    skip3 = sys.thing('skip3')
+    skipX = sys.thing('skip_x')
+    skipY = sys.thing('skip_y')
+    finish1 = sys.thing('finish1')
+    finish2 = sys.thing('finish2')
+
+    start.points_to(skip1).points_to(skip2)
+    skip2.points_to(skip3).points_to(skipX).points_to finish1
+    skip2.points_to(skipY).points_to finish2
+
+    skip1.skip!
+    skip2.skip!
+    skip3.skip!
+    skipX.skip!
+    skipY.skip!
+
+    assert_equal('start->finish1 start->finish2', connections)
+  end
+
+  def test_skipped_thing_will_not_be_rendered
+    sys.thing('a').skip!
+
+    assert_nil find('a')
+  end
+
   def test_find_thing
     sys.group('top').thing('needle')
 
@@ -227,10 +329,6 @@ class TestDogvizGraphvizRendering < Test::Unit::TestCase
     }.join sep
   end
 
-  def connected_ids
-    (edges.map(&:tail_node) + edges.map(&:head_node)).uniq
-  end
-
   def edges
     graph.each_edge
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogviz
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - damned
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +104,6 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -99,8 +112,11 @@ files:
 - examples/website_domain.rb
 - lib/dogviz.rb
 - lib/dogviz/version.rb
-- tests/test_sisvis_graph.rb
-- tests/test_sisvis_graphviz_rendering.rb
+- tests/setup_tests.rb
+- tests/svg_graph.rb
+- tests/test_dogviz_functionally.rb
+- tests/test_dogviz_graph.rb
+- tests/test_dogviz_graphviz_rendering.rb
 homepage: https://github.com/damned/dogviz
 licenses:
 - MIT

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dogviz (0.0.3)
-      ruby-graphviz (~> 1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    colorize (0.7.7)
-    multi_json (1.8.4)
-    rake (10.1.0)
-    ruby-graphviz (1.2.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.10)
-  colorize (~> 0)
-  dogviz!
-  rake (~> 10.0)
-  simplecov (~> 0)
-
-BUNDLED WITH
-   1.10.6