simple-hd-graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44b324c969e0eee61a4e445debbb87b34d55a12995f1c72a4dc52d2f86807d68
+  data.tar.gz: 3caefc54af9dadbcd83fc9dc5cd903f04a1acd9034043bf90424e83f888314ce
+SHA512:
+  metadata.gz: 987f4cd19880122491628b747a516f38f4e1a3124cdd54ecbd200070b294a0227e7172ca6aa3c07cc21c455430ebe4c3b3ff7dad94e5566f7e784704ee501c5b
+  data.tar.gz: c28ac4b38fdb99fa83e05b14992e935007ce0d7dfa760a87703fba4ad83e44b7ea1c289db222fcfcd2aac0f3b9a1c7de0961188b79d3d095f5f26e2a76989d6b

data/.gitignore

@@ -0,0 +1,14 @@
+*~
+*.bak
+.DS_Store
+Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graph.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2021 wtnabe
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# SimpleHdGraph
+
+parse single-tier hierarchy, simplex direction graph from YAML DSL, render PlantUML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-hd-graph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-hd-graph
+
+## Usage
+
+    $ simple-hd-graph -f FILE
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wtnabe/graph.

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"]
+  t.options = ["--any", "--extra", "--opts"]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/simple-hd-graph

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

data/lib/simple-hd-graph.rb

@@ -0,0 +1,8 @@
+module SimpleHdGraph
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+Dir.glob(__dir__ + '/simple-hd-graph/**/*.rb').each { |f|
+  require_relative f.sub(/\.rb\z/, '')
+}

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

@@ -0,0 +1,33 @@
+require 'optparse'
+
+module SimpleHdGraph
+  class Command
+    def initialize(argv)
+      @argv = argv.dup
+    end
+
+    def run
+      opts.parse(@argv)
+      if @file
+        nodes = Parser.new.parse(Reader.new.read_file(@file))
+        renderer = Renderer::PlantUML::Context.new
+
+        puts nodes.map { |node|
+          renderer.render(node)
+        }.join
+      end
+    end
+
+    #
+    # @return [OptionParser]
+    #
+    # :reek:NestedIterators
+    def opts
+      OptionParser.new do |opt|
+        opt.on('-f FILE', '--file', 'filename') { |value|
+          @file = value
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module SimpleHdGraph
+  class ContextNode < Node
+    required :id
+
+    attr_reader :resources, :relations
+
+    #
+    # @return [String]
+    #
+    def alias
+      @content[:id]
+    end
+
+    #
+    # @return [String]
+    #
+    def id
+      id = camelize(self.alias)
+      id[0] = id[0].downcase
+      id
+    end
+
+    def <<(resource)
+      @resources ||= []
+      @resource_dict ||= {}
+      @resources << resource
+      @resource_dict[resource.alias] = resource.id
+    end
+
+    #
+    # :reek:NestedIterators
+    def refill_relation
+      @relations ||= []
+      @resources.each { |resource|
+        dependencies = resource.has
+        if dependencies
+          dependencies.each { |dependency|
+            @relations << { resource.id => @resource_dict[dependency] }
+          }
+        end
+      }
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'dry/inflector'
+
+module SimpleHdGraph
+  class Node
+    class RequiredFieldNotFilled < StandardError; end
+
+    class << self
+      #
+      # @param names [Array]
+      #
+      def required(*names)
+        @required_fields = names
+      end
+    end
+
+    def initialize
+      @inflector = Dry::Inflector.new
+    end
+
+    #
+    # @param struct [Hash]
+    #
+    # :reek:TooManyStatements
+    def load(struct)
+      klass = self.class
+
+      required_fields = if klass.instance_variables.grep(':@required_fields').size > 0
+                          klass.instance_variable_get('@required_fields')
+                        else
+                          nil
+                        end
+
+      if required_fields.is_a? Array
+        filled = required_fields.all? {|field|
+          if struct.has_key? field
+            true
+          else
+            raise RequiredFieldNotFilled, field
+          end
+        }
+      else
+        filled = true
+      end
+
+      @content = struct if filled
+    end
+
+    #
+    # @param str [String]
+    # @return [String]
+    #
+    def camelize(str)
+      @inflector.camelize(@inflector.underscore(str.gsub(/ /, '_')))
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'yaml'
+
+module SimpleHdGraph
+  #
+  # parse for YAML string
+  #
+  # :reek:InstanceVaariableAssumption
+  class Parser
+    #
+    # @param document [String]
+    #
+    # :reek:TooManyStatements
+    def parse(document)
+      contexts = []
+
+      YAML.load_stream(document) do |node|
+        context   = nil
+        resources = []
+
+        # :reek:NestedIterators
+        node.each_pair { |key, value|
+          if key == 'id'
+            context = ContextNode.new
+            context.load({ id: value })
+          elsif reserved_keywords.include?(key)
+          elsif key == 'resources'
+            resources = value
+          end
+        }
+
+        resources.each { |key, resource|
+          rn = ResourceNode.new
+          rn.load_with_context({ id: context.id }, { key => resource })
+          context << rn
+        }
+        contexts << context
+      end
+      refill_relation(contexts)
+
+      contexts
+    end
+
+    #
+    # @param contexts [Array]
+    #
+    def refill_relation(contexts)
+      contexts.each {|context|
+        context.refill_relation
+      }
+    end
+
+    #
+    # @return [Array]
+    #
+    def reserved_keywords
+      [:depends]
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module SimpleHdGraph
+  class Reader
+    #
+    # @param file [String]
+    # @return [String]
+    #
+    # :reek:UtilityFunction
+    def read_file(file)
+      File.read(file)
+    end
+
+    #
+    # @param dir [String]
+    # @return [String]
+    #
+    def read_dir(dir)
+      Dir.glob("#{dir}/**/*.{yml,yaml}").map {|file|
+        read_file(file)
+      }.join("---\n")
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module SimpleHdGraph
+  module Renderer
+    module PlantUML
+      class Context
+        def initialize
+          @resource_renderer = Resource.new
+        end
+
+        #
+        # @param node [ContextNode]
+        #
+        # :reek:FeatureEnvy
+        def render(node)
+          resources = node.resources.map { |resource|
+            indent_resource(resource)
+          }.join
+          relations = node.relations.map { |relation|
+            render_relation(relation)
+          }.join("\n")
+          <<EOD
+rectangle \"#{node.alias}\" as #{node.id} {
+#{resources}
+#{relations if relations.size > 0}
+}
+EOD
+        end
+
+        #
+        # @param resource [String]
+        # @return [String]
+        #
+        def indent_resource(resource)
+          @resource_renderer.render(resource).lines.map { |line|
+            "  #{line}"
+          }.join
+        end
+
+        #
+        # @param relation [Hash]
+        # @return [String]
+        #
+        # :reek:UtilityFunction
+        def render_relation(relation)
+          depender, dependee = relation.to_a.first
+          "  #{depender} -d-|> #{dependee}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module SimpleHdGraph
+  module Renderer
+    module PlantUML
+      class Resource
+        #
+        # @param node [ResourceNode]
+        #
+        # :reek:UtilityFunction
+        def render(node)
+          content = node.content.map { |key, value|
+            "  #{key}: #{value}"
+          }.join("\n")
+          <<EOD
+object \"#{node.alias}\" as #{node.id} {
+#{content}
+}
+EOD
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module SimpleHdGraph
+  class ResourceNode < Node
+    #
+    # @param context [Object]
+    # @param struct [Hash]
+    #
+    def load_with_context(context, struct)
+      @context = context
+      load(struct)
+    end
+
+    #
+    # @return [String]
+    #
+    def alias
+      @content.keys.first.to_s.freeze
+    end
+
+    #
+    # @return [String]
+    #
+    def id
+      id = camelize(context)
+      id[0] = id[0].downcase
+      [id, camelize(self.alias)].join('').freeze
+    end
+
+    #
+    # @return [String]
+    #
+    def context
+      @context[:id].freeze
+    end
+
+    #
+    # @return [Hash]
+    #
+    def content
+      @content.values.first.select { |key, value|
+        key != 'has'
+      }
+    end
+
+    #
+    # @return [Array]
+    #
+    def has
+      @content.values.first['has']
+    end
+  end
+end

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

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

data/simple-hd-graph.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple-hd-graph/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-hd-graph"
+  spec.version       = SimpleHdGraph::VERSION
+  spec.authors       = ["wtnabe"]
+  spec.email         = ["wtnabe@gmail.com"]
+
+  spec.summary       = %q{single-tier hierary and simplex direction graph DSL}
+  spec.description   = %q{parse single-tier hierarchy and simplex direction graph from YAML, and generate PlantUML with rectangle and object}
+  spec.homepage      = "https://github.com/wtnabe/simple-hd-graph"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.metadata["source_code_uri"] + "/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "dry-inflector", "~> 0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1"
+  spec.add_development_dependency "minitest-power_assert"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: simple-hd-graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wtnabe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: parse single-tier hierarchy and simplex direction graph from YAML, and
+  generate PlantUML with rectangle and object
+email:
+- wtnabe@gmail.com
+executables:
+- simple-hd-graph
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/simple-hd-graph
+- lib/simple-hd-graph.rb
+- lib/simple-hd-graph/command.rb
+- lib/simple-hd-graph/context.rb
+- lib/simple-hd-graph/node.rb
+- lib/simple-hd-graph/parser.rb
+- lib/simple-hd-graph/reader.rb
+- lib/simple-hd-graph/renderer/plantuml/context.rb
+- lib/simple-hd-graph/renderer/plantuml/resource.rb
+- lib/simple-hd-graph/resource.rb
+- lib/simple-hd-graph/version.rb
+- simple-hd-graph.gemspec
+homepage: https://github.com/wtnabe/simple-hd-graph
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wtnabe/simple-hd-graph
+  source_code_uri: https://github.com/wtnabe/simple-hd-graph
+  changelog_uri: https://github.com/wtnabe/simple-hd-graph/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: single-tier hierary and simplex direction graph DSL
+test_files: []