simple-hd-graph 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77adb613fe39a632f031c03043e04a4d063544bc52981be78b4a7940ed72aa9a
-  data.tar.gz: 187db445f834508dd9980ed23b53c847a9be21bcf277f7dc05fcec1a5c80db13
+  metadata.gz: 8c9b0d3ded87feb7413df4ddeba6059e109be00644737ded9a4e814f8e9a1e67
+  data.tar.gz: 9c677cc4cd05e216464afe2b3c04ba8b321a595dedb5932292bfd5ec4dbd7c90
 SHA512:
-  metadata.gz: 6014c3b504f50736f97fa2c47089a95b17021f08ce60b9510ccbab0f3c224804be9b52cc381255ad6ef5de2470d1bb66f5206fe3db620a6161e24a0cfcdfe525
-  data.tar.gz: 14c5773be07183a884c25c4fe17d3d2f5a3eb4d607790a68f826db3699a3fa068c6b42f95de62a8cc487cc736b9839928cb2f5b534a5924254be7ab96d7b7ab4
+  metadata.gz: 99df519c7c3e8927c09ed17e6b6a8dd9d0533cd7885ff59592d2da9f614ea2c2bff15d4473095f108b19bd1b045b07de3013d2a3a94b1025af878280bce6d159
+  data.tar.gz: 81d0c1f6c5359f88cca05d4f3beaeb6c55ce73a19cbd966c3a8086fc8553e690b77a8ad96af359a186940958b2733f187067f8df58351cb631db2738bc3f314b

data/README.md

@@ -22,9 +22,42 @@ Or install it yourself as:
 
     $ simple-hd-graph -f FILE
 
+or
+
+    $ simple-hd-graph -d DIR
+
+## Format
+
+SimpleHdGraph was designed primarily to describe systems, its constituent resources, and their dependencies.
+
+The two components are as follows:
+
+ * Context
+ * Resource
+
+A single YAML document corresponds to a single context as below:
+
+<pre>
+<b>id</b>: name1
+<b>resources</b>:
+  resource1:
+    note: memo
+    <b>has</b>: resource2
+  resource2:
+    note: very important
+<b>depends</b>:
+ - name2
+</pre>
+
+features:
+
+ * Context can contain mutiple Resources
+ * Resource can use the `has` keyword to indicate that it owns other Resources
+ * Context can use the `depends` keyword to indicate its dependency on other Contexts
+
 ## Example
 
-input
+input ( streams )
 
 ```yaml
 id: example1
@@ -41,6 +74,14 @@ resources:
   storage:
     hosting: AWS S3
     region: ap-north-east1
+---
+id: example 2
+resources:
+  web:
+    hosting: Google AppEngines
+    runtime: Ruby 2.6
+depends:
+  - example1
 ```
 
 output
@@ -63,8 +104,19 @@ rectangle "example1" as example1 {
   example1Web -d-|> example1Admin
   example1Web -d-|> example1Storage
 }
+rectangle "example 2" as example2 {
+  object "web" as example2Web {
+    hosting: Google AppEngines
+    runtime: Ruby 2.6
+  }
+}
+example2 -|> example1
 ```
 
+after plantuml converted
+
+![example output converted by plantuml](example.png)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -73,4 +125,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wtnabe/graph.
+Bug reports and pull requests are welcome on GitHub at https://github.com/wtnabe/simple-hd-graph.

data/lib/simple-hd-graph/context.rb

@@ -2,7 +2,7 @@ module SimpleHdGraph
   class ContextNode < Node
     required :id
 
-    attr_reader :resources, :relations
+    attr_reader :resources, :relations, :depends # Array
 
     #
     # @return [String]
@@ -20,6 +20,9 @@ module SimpleHdGraph
       id
     end
 
+    #
+    # @param resource [ResourceNode]
+    #
     def <<(resource)
       @resources ||= []
       @resource_dict ||= {}
@@ -28,8 +31,15 @@ module SimpleHdGraph
     end
 
     #
-    # :reek:NestedIterators
+    # @param depends [Array]
+    #
+    def set_depends(depends)
+      @depends = depends
+    end
+
+    # :reek:NestedIterators, :reek:TooManyStatements
     def refill_relation
+      @resource  ||= []
       @relations ||= []
       @resources.each { |resource|
         dependencies = resource.has

data/lib/simple-hd-graph/parser.rb

@@ -6,6 +6,10 @@ module SimpleHdGraph
   #
   # :reek:InstanceVaariableAssumption
   class Parser
+    KEYWORD_ID        ||= 'id'.freeze
+    KEYWORD_RESOURCES ||= 'resources'.freeze
+    KEYWORD_DEPENDS   ||= 'depends'.freeze
+
     #
     # @param document [String]
     #
@@ -17,29 +21,50 @@ module SimpleHdGraph
         next unless node
 
         context   = nil
-        resources = []
+        resources = nil
+        depends   = nil
 
-        # :reek:NestedIterators
         node.each_pair { |key, value|
-          if key == 'id'
+          case key
+          when KEYWORD_ID
             context = ContextNode.new
             context.load({ id: value })
-          elsif reserved_keywords.include?(key)
-          elsif key == 'resources'
+          when KEYWORD_DEPENDS
+            depends = value
+          when KEYWORD_RESOURCES
             resources = value
           end
         }
 
-        resources.each { |key, resource|
-          rn = ResourceNode.new
-          rn.load_with_context({ id: context.id }, { key => resource })
-          context << rn
-        }
+        pack_depends_into_context(depends, context) if depends
+        pack_resources_into_context(resources, context) if resources
+
         contexts << context
       end
       refill_relation(contexts)
+      refill_depends(contexts)
 
-      contexts
+      contexts.map { |context| context.freeze }.freeze
+    end
+
+    #
+    # @param depends [Array]
+    # @param context [ContextNode]
+    #
+    def pack_depends_into_context(depends, context)
+      context.set_depends depends
+    end
+
+    #
+    # @param resources [Array]
+    # @param context [ContextNode]
+    #
+    def pack_resources_into_context(resources, context)
+      resources.each { |key, resource|
+        rn = ResourceNode.new
+        rn.load_with_context({ id: context.id }, { key => resource })
+        context << rn
+      }
     end
 
     #
@@ -52,10 +77,19 @@ module SimpleHdGraph
     end
 
     #
-    # @return [Array]
+    # @param context [Array]
     #
-    def reserved_keywords
-      [:depends]
+    def refill_depends(contexts)
+      contexts.map { |context|
+        if context.depends
+          regularized = context.depends.map { |dependee|
+            { context.id => dependee }
+          }
+          context.set_depends regularized
+        else
+          context.set_depends []
+        end
+      }
     end
   end
 end

data/lib/simple-hd-graph/renderer/plantuml/context.rb

@@ -9,19 +9,23 @@ module SimpleHdGraph
         #
         # @param node [ContextNode]
         #
-        # :reek:FeatureEnvy
+        # :reek:FeatureEnvy, :reek:DuplicateMethodCall
         def render(node)
           resources = node.resources.map { |resource|
             indent_resource(resource)
-          }.join
+          }.join if node.resources.size > 0
           relations = node.relations.map { |relation|
             render_relation(relation)
-          }.join("\n")
-          <<EOD
+          }.join("\n") if node.relations.size > 0
+          depends = node.depends.map { |depending|
+            render_depends(depending)
+          }.join("\n") if node.depends.size > 0
+          (<<-EOD).gsub(/^$\n/, '')
 rectangle \"#{node.alias}\" as #{node.id} {
 #{resources}
-#{relations if relations.size > 0}
+#{relations}
 }
+#{depends}
 EOD
         end
 
@@ -44,6 +48,16 @@ EOD
           depender, dependee = relation.to_a.first
           "  #{depender} -d-|> #{dependee}"
         end
+
+        #
+        # @param depending [Hash]
+        # @return [String]
+        #
+        # :reek:UtilityFunction
+        def render_depends(depending)
+          depender, dependee = depending.to_a.first
+          "#{depender} -|> #{dependee}"
+        end
       end
     end
   end

data/lib/simple-hd-graph/version.rb

@@ -1,3 +1,3 @@
 module SimpleHdGraph
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-hd-graph
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - wtnabe
@@ -126,6 +126,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example.png
 - exe/simple-hd-graph
 - lib/simple-hd-graph.rb
 - lib/simple-hd-graph/command.rb