dogviz 0.0.14 → 0.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +81 -3
- data/examples/dogfood.rb +41 -10
- data/examples/dogviz-generated.jpg +0 -0
- data/examples/dogviz-generated.svg +88 -0
- data/examples/dogviz-rolled-up-generated.jpg +0 -0
- data/lib/dogviz/version.rb +1 -1
- data/lib/dogviz.rb +1 -1
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bbfb239fb484b38461f0003396c7459aa9b54aa4
|
|
4
|
+
data.tar.gz: 3ac9a25d79b5838a2532fbcac613070d2f89a077
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1301654d2ddc911a7a9e5a35bf06c5b3124da5666e211385e2b2a780476e5c27a0553469f61ea9d1dc9247d5efffe0738a507cc33a73b4f54f9c23b80fefb79f
|
|
7
|
+
data.tar.gz: 693c62d589103d987de7ddef5787e5e042047bd3d928b0107d67e8e7655cfcec435985eef64c2b8c76a1bde451393c50556fcd0db336718dd8661a448af1b5d7
|
data/README.md
CHANGED
|
@@ -1,6 +1,84 @@
|
|
|
1
1
|
# dogviz
|
|
2
|
-
domain object graph visualisation built on graphviz
|
|
2
|
+
A domain object graph (**DOG**) visualisation built on [ruby-graphviz](https://github.com/glejeune/Ruby-Graphviz) and hence [Graphviz](http://www.graphviz.org/)
|
|
3
|
+
|
|
4
|
+
## Features
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
gem install dogviz
|
|
9
|
+
ruby examples/dogfood.rb
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
Here is the diagram rendered by running the [dogfood example](examples/dogfood.rb)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
Use the simple DSL to build your domain graph of *things* which can be in *containers*, which in turn can be nested.
|
|
18
|
+
|
|
19
|
+
*Things* can point to other *things*.
|
|
20
|
+
|
|
21
|
+
Because this is ruby you can use known refactorings for **DOG** construction: extract methods, push into classes etc.
|
|
22
|
+
|
|
23
|
+
No external DSL rubbish here! ;)
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'dogviz'
|
|
27
|
+
|
|
28
|
+
def create_classes_description(root)
|
|
29
|
+
classes = root.container('classes')
|
|
30
|
+
system = classes.thing('System')
|
|
31
|
+
thing = classes.thing('Thing')
|
|
32
|
+
container = classes.thing('Container')
|
|
33
|
+
container.points_to thing, name: 'contains'
|
|
34
|
+
container.points_to container, name: 'contains'
|
|
35
|
+
system.points_to thing, name: 'contains'
|
|
36
|
+
system.points_to container, name: 'contains'
|
|
37
|
+
|
|
38
|
+
classes
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def create_nested_container_example(root)
|
|
42
|
+
example = root.container 'example DOG'
|
|
43
|
+
thing = example.thing 'a thing outside a container'
|
|
44
|
+
container = example.container 'a container'
|
|
45
|
+
container_thing = container.thing 'a thing in a container'
|
|
46
|
+
nested_container = container.container 'a nested container'
|
|
47
|
+
nested_c_thing = nested_container.thing 'a thing in a nested container'
|
|
48
|
+
|
|
49
|
+
container_thing.points_to nested_c_thing
|
|
50
|
+
nested_c_thing.points_to thing, name: 'things point to other things'
|
|
51
|
+
|
|
52
|
+
nested_container
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
def create_dog(classes: true)
|
|
56
|
+
domain_object_graph = Dogviz::System.new 'dogviz'
|
|
57
|
+
|
|
58
|
+
create_classes_description(domain_object_graph) if classes
|
|
59
|
+
usage = domain_object_graph.group('usage')
|
|
60
|
+
|
|
61
|
+
create_nested_container_example(usage)
|
|
62
|
+
|
|
63
|
+
domain_object_graph
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
create_dog().output svg: 'examples/dogviz-generated.svg'
|
|
67
|
+
create_dog().output jpg: 'examples/dogviz-generated.jpg'
|
|
68
|
+
|
|
69
|
+
dog_rolled_up = create_dog(classes: false)
|
|
70
|
+
dog_rolled_up.find('a nested container').rollup!
|
|
71
|
+
dog_rolled_up.output jpg: 'examples/dogviz-rolled-up-generated.jpg'
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Rolling up
|
|
75
|
+
|
|
76
|
+
You can **rollup!** *containers* before rendering so that a single **DOG** can be used to render simplified views.
|
|
77
|
+
|
|
78
|
+
The following output from above example shows how diagram can be simplified by *rolling up* the nested container.
|
|
79
|
+
Note that pointers to/from contained things are handled gracefully ([i think](https://github.com/damned/dogviz/blob/master/tests/test_dogviz_graphviz_rendering.rb#L97) :/).
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
3
83
|
|
|
4
|
-
bundle install
|
|
5
84
|
|
|
6
|
-
bundle exec ruby examples/website.rb
|
data/examples/dogfood.rb
CHANGED
|
@@ -1,15 +1,46 @@
|
|
|
1
1
|
require 'dogviz'
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
def create_classes_description(root)
|
|
4
|
+
classes = root.container('classes')
|
|
5
|
+
system = classes.thing('System')
|
|
6
|
+
thing = classes.thing('Thing')
|
|
7
|
+
container = classes.thing('Container')
|
|
8
|
+
container.points_to thing, name: 'contains'
|
|
9
|
+
container.points_to container, name: 'contains'
|
|
10
|
+
system.points_to thing, name: 'contains'
|
|
11
|
+
system.points_to container, name: 'contains'
|
|
4
12
|
|
|
5
|
-
classes
|
|
6
|
-
|
|
7
|
-
thing = classes.thing('Thing')
|
|
8
|
-
container = classes.thing('Container')
|
|
9
|
-
container.points_to thing, name: 'contains'
|
|
10
|
-
container.points_to container, name: 'contains'
|
|
11
|
-
system.points_to thing, name: 'contains'
|
|
12
|
-
system.points_to container, name: 'contains'
|
|
13
|
+
classes
|
|
14
|
+
end
|
|
13
15
|
|
|
16
|
+
def create_nested_container_example(root)
|
|
17
|
+
example = root.container 'example DOG'
|
|
18
|
+
thing = example.thing 'a thing outside a container'
|
|
19
|
+
container = example.container 'a container'
|
|
20
|
+
container_thing = container.thing 'a thing in a container'
|
|
21
|
+
nested_container = container.container 'a nested container'
|
|
22
|
+
nested_c_thing = nested_container.thing 'a thing in a nested container'
|
|
14
23
|
|
|
15
|
-
|
|
24
|
+
container_thing.points_to nested_c_thing
|
|
25
|
+
nested_c_thing.points_to thing, name: 'things point to other things'
|
|
26
|
+
|
|
27
|
+
nested_container
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def create_dog(classes: true)
|
|
31
|
+
domain_object_graph = Dogviz::System.new 'dogviz'
|
|
32
|
+
|
|
33
|
+
create_classes_description(domain_object_graph) if classes
|
|
34
|
+
usage = domain_object_graph.group('usage')
|
|
35
|
+
|
|
36
|
+
create_nested_container_example(usage)
|
|
37
|
+
|
|
38
|
+
domain_object_graph
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
create_dog().output svg: 'examples/dogviz-generated.svg'
|
|
42
|
+
create_dog().output jpg: 'examples/dogviz-generated.jpg'
|
|
43
|
+
|
|
44
|
+
dog_rolled_up = create_dog(classes: false)
|
|
45
|
+
dog_rolled_up.find('a nested container').rollup!
|
|
46
|
+
dog_rolled_up.output jpg: 'examples/dogviz-rolled-up-generated.jpg'
|
|
Binary file
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
|
|
3
|
+
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
|
4
|
+
<!-- Generated by graphviz version 2.36.0 (20140111.2315)
|
|
5
|
+
-->
|
|
6
|
+
<!-- Title: 19:22 dogviz 2016-05-21 Pages: 1 -->
|
|
7
|
+
<svg width="439pt" height="333pt"
|
|
8
|
+
viewBox="0.00 0.00 439.00 333.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
9
|
+
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 329)">
|
|
10
|
+
<title>19:22 dogviz 2016-05-21</title>
|
|
11
|
+
<polygon fill="white" stroke="none" points="-4,4 -4,-329 435,-329 435,4 -4,4"/>
|
|
12
|
+
<g id="clust1" class="cluster"><title>cluster_classes</title>
|
|
13
|
+
<polygon fill="none" stroke="black" points="8,-8 8,-286 176,-286 176,-8 8,-8"/>
|
|
14
|
+
<text text-anchor="middle" x="92" y="-270.8" font-family="Times,serif" font-size="14.00">classes</text>
|
|
15
|
+
</g>
|
|
16
|
+
<g id="clust3" class="cluster"><title>cluster_usage_example_DOG</title>
|
|
17
|
+
<polygon fill="none" stroke="black" points="184,-8 184,-317 402,-317 402,-8 184,-8"/>
|
|
18
|
+
<text text-anchor="middle" x="293" y="-301.8" font-family="Times,serif" font-size="14.00">example DOG</text>
|
|
19
|
+
</g>
|
|
20
|
+
<g id="clust4" class="cluster"><title>cluster_usage_example_DOG_a_container</title>
|
|
21
|
+
<polygon fill="none" stroke="black" points="192,-94 192,-286 394,-286 394,-94 192,-94"/>
|
|
22
|
+
<text text-anchor="middle" x="293" y="-270.8" font-family="Times,serif" font-size="14.00">a container</text>
|
|
23
|
+
</g>
|
|
24
|
+
<g id="clust5" class="cluster"><title>cluster_usage_example_DOG_a_container_a_nested_container</title>
|
|
25
|
+
<polygon fill="none" stroke="black" points="200,-102 200,-177 386,-177 386,-102 200,-102"/>
|
|
26
|
+
<text text-anchor="middle" x="293" y="-161.8" font-family="Times,serif" font-size="14.00">a nested container</text>
|
|
27
|
+
</g>
|
|
28
|
+
<!-- classes_System -->
|
|
29
|
+
<g id="node1" class="node"><title>classes_System</title>
|
|
30
|
+
<polygon fill="none" stroke="black" points="96.25,-255 39.75,-255 39.75,-219 96.25,-219 96.25,-255"/>
|
|
31
|
+
<text text-anchor="middle" x="68" y="-233.3" font-family="Times,serif" font-size="14.00">System</text>
|
|
32
|
+
</g>
|
|
33
|
+
<!-- classes_Thing -->
|
|
34
|
+
<g id="node2" class="node"><title>classes_Thing</title>
|
|
35
|
+
<polygon fill="none" stroke="black" points="93,-52 39,-52 39,-16 93,-16 93,-52"/>
|
|
36
|
+
<text text-anchor="middle" x="66" y="-30.3" font-family="Times,serif" font-size="14.00">Thing</text>
|
|
37
|
+
</g>
|
|
38
|
+
<!-- classes_System->classes_Thing -->
|
|
39
|
+
<g id="edge1" class="edge"><title>classes_System->classes_Thing</title>
|
|
40
|
+
<path fill="none" stroke="black" d="M69.875,-218.797C73.25,-186.031 80,-120.5 80,-120.5 80,-120.5 74.6534,-87.4656 70.5684,-62.2261"/>
|
|
41
|
+
<polygon fill="black" stroke="black" points="74.0219,-61.6567 68.969,-52.3444 67.1118,-62.7752 74.0219,-61.6567"/>
|
|
42
|
+
<text text-anchor="middle" x="57" y="-124.3" font-family="Times,serif" font-size="14.00">contains</text>
|
|
43
|
+
</g>
|
|
44
|
+
<!-- classes_Container -->
|
|
45
|
+
<g id="node3" class="node"><title>classes_Container</title>
|
|
46
|
+
<polygon fill="none" stroke="black" points="168,-146 98,-146 98,-110 168,-110 168,-146"/>
|
|
47
|
+
<text text-anchor="middle" x="133" y="-124.3" font-family="Times,serif" font-size="14.00">Container</text>
|
|
48
|
+
</g>
|
|
49
|
+
<!-- classes_System->classes_Container -->
|
|
50
|
+
<g id="edge2" class="edge"><title>classes_System->classes_Container</title>
|
|
51
|
+
<path fill="none" stroke="black" d="M78.4434,-218.809C88.9621,-201.493 105.317,-174.57 117.379,-154.714"/>
|
|
52
|
+
<polygon fill="black" stroke="black" points="120.382,-156.513 122.583,-146.149 114.399,-152.878 120.382,-156.513"/>
|
|
53
|
+
<text text-anchor="middle" x="122" y="-189.3" font-family="Times,serif" font-size="14.00">contains</text>
|
|
54
|
+
</g>
|
|
55
|
+
<!-- classes_Container->classes_Thing -->
|
|
56
|
+
<g id="edge3" class="edge"><title>classes_Container->classes_Thing</title>
|
|
57
|
+
<path fill="none" stroke="black" d="M120.398,-109.696C110.291,-95.8174 95.9587,-76.1373 84.5426,-60.4614"/>
|
|
58
|
+
<polygon fill="black" stroke="black" points="87.2619,-58.25 78.5457,-52.2269 81.6034,-62.3709 87.2619,-58.25"/>
|
|
59
|
+
<text text-anchor="middle" x="125" y="-74.3" font-family="Times,serif" font-size="14.00">contains</text>
|
|
60
|
+
</g>
|
|
61
|
+
<!-- usage_example_DOG_a_thing_outside_a_container -->
|
|
62
|
+
<g id="node4" class="node"><title>usage_example_DOG_a_thing_outside_a_container</title>
|
|
63
|
+
<polygon fill="none" stroke="black" points="353.25,-52 192.75,-52 192.75,-16 353.25,-16 353.25,-52"/>
|
|
64
|
+
<text text-anchor="middle" x="273" y="-30.3" font-family="Times,serif" font-size="14.00">a thing outside a container</text>
|
|
65
|
+
</g>
|
|
66
|
+
<!-- usage_example_DOG_a_container_a_thing_in_a_container -->
|
|
67
|
+
<g id="node5" class="node"><title>usage_example_DOG_a_container_a_thing_in_a_container</title>
|
|
68
|
+
<polygon fill="none" stroke="black" points="359,-255 227,-255 227,-219 359,-219 359,-255"/>
|
|
69
|
+
<text text-anchor="middle" x="293" y="-233.3" font-family="Times,serif" font-size="14.00">a thing in a container</text>
|
|
70
|
+
</g>
|
|
71
|
+
<!-- usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container -->
|
|
72
|
+
<g id="node6" class="node"><title>usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container</title>
|
|
73
|
+
<polygon fill="none" stroke="black" points="378,-146 208,-146 208,-110 378,-110 378,-146"/>
|
|
74
|
+
<text text-anchor="middle" x="293" y="-124.3" font-family="Times,serif" font-size="14.00">a thing in a nested container</text>
|
|
75
|
+
</g>
|
|
76
|
+
<!-- usage_example_DOG_a_container_a_thing_in_a_container->usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container -->
|
|
77
|
+
<g id="edge4" class="edge"><title>usage_example_DOG_a_container_a_thing_in_a_container->usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container</title>
|
|
78
|
+
<path fill="none" stroke="black" d="M293,-218.809C293,-201.961 293,-176.018 293,-156.339"/>
|
|
79
|
+
<polygon fill="black" stroke="black" points="296.5,-156.149 293,-146.149 289.5,-156.149 296.5,-156.149"/>
|
|
80
|
+
</g>
|
|
81
|
+
<!-- usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container->usage_example_DOG_a_thing_outside_a_container -->
|
|
82
|
+
<g id="edge5" class="edge"><title>usage_example_DOG_a_container_a_nested_container_a_thing_in_a_nested_container->usage_example_DOG_a_thing_outside_a_container</title>
|
|
83
|
+
<path fill="none" stroke="black" d="M289.238,-109.696C286.333,-96.3314 282.258,-77.5871 278.917,-62.2192"/>
|
|
84
|
+
<polygon fill="black" stroke="black" points="282.289,-61.2551 276.745,-52.2269 275.449,-62.7422 282.289,-61.2551"/>
|
|
85
|
+
<text text-anchor="middle" x="357" y="-74.3" font-family="Times,serif" font-size="14.00">things point to other things</text>
|
|
86
|
+
</g>
|
|
87
|
+
</g>
|
|
88
|
+
</svg>
|
|
Binary file
|
data/lib/dogviz/version.rb
CHANGED
data/lib/dogviz.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: dogviz
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.15
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- damned
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2016-
|
|
11
|
+
date: 2016-05-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -109,6 +109,9 @@ files:
|
|
|
109
109
|
- Rakefile
|
|
110
110
|
- dogviz.gemspec
|
|
111
111
|
- examples/dogfood.rb
|
|
112
|
+
- examples/dogviz-generated.jpg
|
|
113
|
+
- examples/dogviz-generated.svg
|
|
114
|
+
- examples/dogviz-rolled-up-generated.jpg
|
|
112
115
|
- examples/website.rb
|
|
113
116
|
- examples/website_domain.rb
|
|
114
117
|
- lib/dogviz.rb
|