simple-hd-graph 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b324c969e0eee61a4e445debbb87b34d55a12995f1c72a4dc52d2f86807d68
-  data.tar.gz: 3caefc54af9dadbcd83fc9dc5cd903f04a1acd9034043bf90424e83f888314ce
+  metadata.gz: 1ea0d42c32d8bd212ceaa306f4374b267c4f4158fdf9e9110e0c8f323ca6b729
+  data.tar.gz: cfad1721bc08d8a441093db14df1cff803520618d74c7a4087ab563d6878bfca
 SHA512:
-  metadata.gz: 987f4cd19880122491628b747a516f38f4e1a3124cdd54ecbd200070b294a0227e7172ca6aa3c07cc21c455430ebe4c3b3ff7dad94e5566f7e784704ee501c5b
-  data.tar.gz: c28ac4b38fdb99fa83e05b14992e935007ce0d7dfa760a87703fba4ad83e44b7ea1c289db222fcfcd2aac0f3b9a1c7de0961188b79d3d095f5f26e2a76989d6b
+  metadata.gz: 05ded502c1824bcccf27573c9a19135e176067b4db942999b4d53fc58b422043a9c339307bbb99f1af7ea91f91fac6ec1deb702b6d9221e04e47f2a4eae21bff
+  data.tar.gz: d48005f46fca5e2f5cf836c676fce9d2b43d4a4be2bc4af1e1bed8e06518daac7e1dd89e7146f861fca2d804ae286ef7486765e87e46aab41638d05867dc1f3f

data/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_size = 2
+indent_style = space

data/README.md

@@ -22,6 +22,101 @@ 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 ( streams )
+
+```yaml
+id: example1
+resources:
+  web:
+    hosting: Heroku
+    runtime: Ruby 2.5
+    has:
+      - admin
+      - storage
+  admin:
+    hosting: Google Spreadsheet
+    runtime: Google Apps Script
+  storage:
+    hosting: AWS S3
+    region: ap-north-east1
+---
+id: example 2
+resources:
+  web:
+    hosting: Google AppEngines
+    runtime: Ruby 2.6
+depends:
+  - example1
+```
+
+output
+
+```plantuml
+rectangle "example1" as example1 {
+  object "web" as example1Web {
+    hosting: Heroku
+    runtime: Ruby 2.5
+  }
+  object "admin" as example1Admin {
+    hosting: Google Spreadsheet
+    runtime: Google Apps Script
+  }
+  object "storage" as example1Storage {
+    hosting: AWS S3
+    region: ap-north-east1
+  }
+
+  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.
@@ -30,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/exe/simple-hd-graph

@@ -1,9 +1,9 @@
 #! /usr/bin/env ruby
 
-$LOAD_PATH.unshift File.join(__dir__, '../lib')
-require 'bundler/setup'
+$LOAD_PATH.unshift File.absolute_path(File.join(__dir__, '../lib'))
+
 require 'simple-hd-graph'
 
 Version = SimpleHdGraph::VERSION
-cmd = SimpleHdGraph::Command.new(ARGV)
-cmd.run
+cmd = SimpleHdGraph::Command.new
+cmd.run(ARGV)

data/lib/simple-hd-graph.rb

@@ -4,5 +4,5 @@ module SimpleHdGraph
 end
 
 Dir.glob(__dir__ + '/simple-hd-graph/**/*.rb').each { |f|
-  require_relative f.sub(/\.rb\z/, '')
+  require f.sub(/\.rb\z/, '')
 }

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

@@ -1,31 +1,83 @@
 require 'optparse'
 
 module SimpleHdGraph
+  class Error < StandardError; end
+  class FileNotExist < Error; end
+  class DirectoryNotExist < Error; end
+
   class Command
-    def initialize(argv)
-      @argv = argv.dup
+    #
+    # @param parser [Parser]
+    # @param reader [Reader]
+    # @param renderer [Symbol]
+    #
+    def initialize(parser: Parser.new, reader: Reader.new, renderer: :plantuml)
+      @parser = parser
+      @reader = reader
+      @renderer = SimpleHdGraph::Renderer.method(renderer.to_s)
     end
+    attr_reader :parser, :reader, :renderer
 
-    def run
-      opts.parse(@argv)
-      if @file
-        nodes = Parser.new.parse(Reader.new.read_file(@file))
-        renderer = Renderer::PlantUML::Context.new
+    #
+    # @param argv [Array]
+    #
+    def run(argv)
+      parse(argv)
+      if @file || @dir
+        start
+      end
+    end
+
+    #
+    # @param argv [Array]
+    #
+    def parse(argv)
+      opts.parse(argv)
+    end
 
-        puts nodes.map { |node|
-          renderer.render(node)
-        }.join
+    #
+    # @return [String]
+    #
+    def stream
+      if (@dir)
+        reader.read_dir(@dir)
+      else
+        reader.read_file(@file)
       end
     end
 
+    def start
+      nodes = parser.parse(stream)
+
+      @renderer.call(nodes)
+    end
+
     #
     # @return [OptionParser]
     #
-    # :reek:NestedIterators
+    # :reek:NestedIterators, :reek:DuplicateMethodCall
     def opts
       OptionParser.new do |opt|
+        opt.on('-d DIR', '--dir', 'dirname') { |value|
+          if File.exist?(value) && File.directory?(value)
+            @dir = value
+          else
+            raise DirectoryNotExist, value
+          end
+        }
         opt.on('-f FILE', '--file', 'filename') { |value|
-          @file = value
+          if File.exist?(value) && File.file?(value)
+            @file = value
+          else
+            raise FileNotExist, value
+          end
+        }
+        opt.on('-r RENDERER', '--renderer', 'renderer') { |value|
+          begin
+            @renderer = SimpleHdGraph::Renderer.method(value)
+          rescue NameError
+            STDERR.puts "[Warining] renderer `#{value}` not found. falling back to :plantuml"
+          end
         }
       end
     end

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

@@ -1,8 +1,10 @@
+require 'simple-hd-graph/node'
+
 module SimpleHdGraph
   class ContextNode < Node
     required :id
 
-    attr_reader :resources, :relations
+    attr_reader :resources, :relations, :depends # Array
 
     #
     # @return [String]
@@ -20,6 +22,9 @@ module SimpleHdGraph
       id
     end
 
+    #
+    # @param resource [ResourceNode]
+    #
     def <<(resource)
       @resources ||= []
       @resource_dict ||= {}
@@ -28,8 +33,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/node.rb

@@ -13,6 +13,8 @@ module SimpleHdGraph
       end
     end
 
+    CAMELIZE_SEPARATOR = ' ,.、。'
+
     def initialize
       @inflector = Dry::Inflector.new
     end
@@ -24,7 +26,7 @@ module SimpleHdGraph
     def load(struct)
       klass = self.class
 
-      required_fields = if klass.instance_variables.grep(':@required_fields').size > 0
+      required_fields = if klass.instance_variables.grep(/@required_fields/).size > 0
                           klass.instance_variable_get('@required_fields')
                         else
                           nil
@@ -50,7 +52,7 @@ module SimpleHdGraph
     # @return [String]
     #
     def camelize(str)
-      @inflector.camelize(@inflector.underscore(str.gsub(/ /, '_')))
+      @inflector.camelize(@inflector.underscore(str.gsub(/[#{CAMELIZE_SEPARATOR}]/, '_')))
     end
   end
 end

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]
     #
@@ -14,30 +18,53 @@ module SimpleHdGraph
       contexts = []
 
       YAML.load_stream(document) do |node|
+        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.map { |context| context.freeze }.freeze
+    end
+
+    #
+    # @param depends [Array]
+    # @param context [ContextNode]
+    #
+    def pack_depends_into_context(depends, context)
+      context.set_depends depends
+    end
 
-      contexts
+    #
+    # @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
 
     #
@@ -50,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 => contexts.select { |c| c.alias == dependee }.first.id }
+          }
+          context.set_depends regularized
+        else
+          context.set_depends []
+        end
+      }
     end
   end
 end

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

@@ -0,0 +1,16 @@
+Dir.glob(File.join(__dir__, '**/*.rb')).each { |f| require f }
+
+module SimpleHdGraph
+  module Renderer
+    #
+    # @param nodes [Array]
+    #
+    def plantuml(nodes)
+      context = self::PlantUML::Context.new
+      puts nodes.map { |node|
+        context.render(node)
+      }.join
+    end
+    module_function :plantuml
+  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/resource.rb

@@ -1,3 +1,5 @@
+require 'simple-hd-graph/node'
+
 module SimpleHdGraph
   class ResourceNode < Node
     #

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

@@ -1,3 +1,3 @@
 module SimpleHdGraph
-  VERSION = "0.1.0"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-hd-graph
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - wtnabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -117,6 +117,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -125,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
@@ -132,6 +134,7 @@ files:
 - lib/simple-hd-graph/node.rb
 - lib/simple-hd-graph/parser.rb
 - lib/simple-hd-graph/reader.rb
+- lib/simple-hd-graph/renderer/plantuml.rb
 - lib/simple-hd-graph/renderer/plantuml/context.rb
 - lib/simple-hd-graph/renderer/plantuml/resource.rb
 - lib/simple-hd-graph/resource.rb