dogviz 0.0.15 → 0.0.16
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 +73 -3
- data/examples/dogfood.rb +0 -1
- data/examples/mental_health.rb +44 -0
- data/lib/dogviz/version.rb +1 -1
- data/lib/dogviz.rb +1 -0
- metadata +3 -3
- data/examples/dogviz-generated.svg +0 -88
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c139e3de9b60c343ea816c730a3e88667a3e79d2
|
|
4
|
+
data.tar.gz: 0329e13153d5fa3079f2783a3c32370209e99d5d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cfc8beaad531936c0f9b9cb7ded8d0ae84999c4ef027ded83276adb1a91ebf8e994f60c12e90774f6722c3b55fb5ecaddf070bceabb49e74f91215da75b7f48f
|
|
7
|
+
data.tar.gz: aee0a0735f84f82c45d54a1da12e53b69d8bb4480920f9b2b7722e04eda67c07ee04e8c18e14dddc261c77586c0282b89ca16ef41b08d7918b0eb1d08c5ce648
|
data/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# dogviz
|
|
2
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
3
|
|
|
4
|
-
## Features
|
|
5
|
-
|
|
6
4
|
## Usage
|
|
7
5
|
|
|
6
|
+
```
|
|
8
7
|
gem install dogviz
|
|
9
8
|
ruby examples/dogfood.rb
|
|
9
|
+
```
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -63,7 +63,6 @@ def create_dog(classes: true)
|
|
|
63
63
|
domain_object_graph
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
-
create_dog().output svg: 'examples/dogviz-generated.svg'
|
|
67
66
|
create_dog().output jpg: 'examples/dogviz-generated.jpg'
|
|
68
67
|
|
|
69
68
|
dog_rolled_up = create_dog(classes: false)
|
|
@@ -80,5 +79,76 @@ Note that pointers to/from contained things are handled gracefully ([i think](ht
|
|
|
80
79
|
|
|
81
80
|
|
|
82
81
|
|
|
82
|
+
## Other Features
|
|
83
|
+
|
|
84
|
+
### #nominate
|
|
85
|
+
*Containers* can **#nominate** a thing so that it is referenceable via a method call on container.
|
|
86
|
+
|
|
87
|
+
It's useful if some code somewhere builds a container with multiple thing entry points you might want to point to
|
|
88
|
+
|
|
89
|
+
```ruby
|
|
90
|
+
def create_c(sys)
|
|
91
|
+
c = sys.container('c')
|
|
92
|
+
c.nominate a: c.thing('a')
|
|
93
|
+
c.nominate b: c.thing('b')
|
|
94
|
+
c
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
c = create_c(sys)
|
|
98
|
+
x = sys.thing('x')
|
|
99
|
+
x.points_to c.a
|
|
100
|
+
x.points_to c.b
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### #doclink
|
|
83
104
|
|
|
105
|
+
Add a documentation link to *thing* so that url can be visited clicking on the *thing* an svg output.
|
|
106
|
+
|
|
107
|
+
```ruby
|
|
108
|
+
thing.doclink("https://github.com/")
|
|
109
|
+
```
|
|
84
110
|
|
|
111
|
+
### splines
|
|
112
|
+
|
|
113
|
+
Splines can be turned on or off by providing flag to System.new
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
System.new 'dog', splines: false
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Extendable classes
|
|
120
|
+
|
|
121
|
+
Using standard ruby extension of **System**, **Container** and **Thing** classes, you can easily use:
|
|
122
|
+
- language specific to your domain
|
|
123
|
+
- styling specific to your types
|
|
124
|
+
|
|
125
|
+
```ruby
|
|
126
|
+
module Creators
|
|
127
|
+
def box(name, options={})
|
|
128
|
+
add Box.new(self, name, options)
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
class WebsiteSystem < System
|
|
132
|
+
include Creators
|
|
133
|
+
end
|
|
134
|
+
class Box < Container
|
|
135
|
+
def initialize(parent, name, options={})
|
|
136
|
+
super parent, name, {style: 'filled', color: '#ffaaaa'}.merge(options)
|
|
137
|
+
end
|
|
138
|
+
def process(name)
|
|
139
|
+
add Process.new self, name
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
class Process < Thing
|
|
143
|
+
def initialize(parent, name)
|
|
144
|
+
super parent, name, style: 'filled'
|
|
145
|
+
end
|
|
146
|
+
def calls(callee, options={})
|
|
147
|
+
points_to callee, options
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
sys = WebsiteSystem.new 'website'
|
|
152
|
+
box = sys.box('website box')
|
|
153
|
+
box.process('nginx').calls(box.process('app'))
|
|
154
|
+
```
|
data/examples/dogfood.rb
CHANGED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
require_relative '../lib/dogviz'
|
|
2
|
+
|
|
3
|
+
def factors(parent)
|
|
4
|
+
factors = parent.container('factors')
|
|
5
|
+
parent.nominate factors: factors
|
|
6
|
+
all = factors.thing('factors')
|
|
7
|
+
|
|
8
|
+
makeup = all.points_to factors.thing 'make-up'
|
|
9
|
+
history = all.points_to factors.thing 'history'
|
|
10
|
+
situation = all.points_to factors.thing 'situation'
|
|
11
|
+
|
|
12
|
+
patterns = makeup.points_to factors.thing 'patterns'
|
|
13
|
+
makeup.points_to factors.thing 'genetic'
|
|
14
|
+
makeup.points_to(factors.thing 'childhood').points_to patterns, name: 'forms'
|
|
15
|
+
|
|
16
|
+
history.points_to(factors.thing 'background').points_to patterns, name: 'forms, reinforces'
|
|
17
|
+
history.points_to(factors.thing 'recent').points_to patterns, name: 'reinforces'
|
|
18
|
+
|
|
19
|
+
situation.points_to factors.thing 'health'
|
|
20
|
+
situation.points_to factors.thing 'pressures'
|
|
21
|
+
support = situation.points_to factors.thing('support')
|
|
22
|
+
|
|
23
|
+
support.points_to factors.thing 'friends'
|
|
24
|
+
support.points_to factors.thing 'family'
|
|
25
|
+
support.points_to factors.thing 'colleagues'
|
|
26
|
+
|
|
27
|
+
all
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def description
|
|
31
|
+
all = Dogviz::System.new 'mental health', splines: true
|
|
32
|
+
all.thing('me')
|
|
33
|
+
.points_to(all.thing('signs'), name: 'look for')
|
|
34
|
+
.points_to(all.thing('actions'), name: 'validate')
|
|
35
|
+
.points_to(factors(all), name: 'change')
|
|
36
|
+
.points_to(all.find('me'), name: 'affect')
|
|
37
|
+
all
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
description.output svg: 'mental-health-generated.svg'
|
|
41
|
+
|
|
42
|
+
simplified = description
|
|
43
|
+
simplified.factors.rollup!
|
|
44
|
+
simplified.output svg: 'mental-health-simplified-generated.svg'
|
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.16
|
|
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-06-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -110,8 +110,8 @@ files:
|
|
|
110
110
|
- dogviz.gemspec
|
|
111
111
|
- examples/dogfood.rb
|
|
112
112
|
- examples/dogviz-generated.jpg
|
|
113
|
-
- examples/dogviz-generated.svg
|
|
114
113
|
- examples/dogviz-rolled-up-generated.jpg
|
|
114
|
+
- examples/mental_health.rb
|
|
115
115
|
- examples/website.rb
|
|
116
116
|
- examples/website_domain.rb
|
|
117
117
|
- lib/dogviz.rb
|
|
@@ -1,88 +0,0 @@
|
|
|
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>
|