yml2erd 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 819409f55a463c90f71fe700c5376d85f4006510
+  data.tar.gz: a1c757ac6a9a2f009b8ea2f5a0e6e8d0d55906a6
+SHA512:
+  metadata.gz: 68520b7dcc1eac6ea39c506aa5498d512e38403db5cce9a2952982e06925f7cb416d116a47ee130c826877cd14835afe96dc1052871721665f4f3339e4f24180
+  data.tar.gz: 211d20578c42f29c4fdf9f3a6693c88bb0f1aeb43f0f67d65edf5e8297cb7a7f165590fc4d4e0dceb27dc3c0c142ea1be8cb1d19582c5b457bf64c5a64fee667

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+output.*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+sudo: required
+before_install:
+  - sudo apt-get install graphviz
+  - gem install bundler -v 1.13.1
+install: bundle install

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 asmsuechan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Yml2erd
+[![Build Status](https://travis-ci.org/asmsuechan/yml2erd.svg?branch=master)](https://travis-ci.org/asmsuechan/yml2erd)
+
+yml2erd allows us to generate erd easily.
+
+![output_image](https://raw.githubusercontent.com/asmsuechan/asmsuechan.github.io/master/images/image.png)
+
+When I consider database structure, I wanted erd generator. However there are no tools to fit. So I created.
+
+## Installation
+Before install this gem, you need to install graphviz.
+
+```
+$ brew install graphviz
+```
+
+You can get more from [here](http://www.graphviz.org/Download..php)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yml2erd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yml2erd
+
+## Usage
+Run this,
+```
+$ yml2erd convert structure.yml
+```
+and we get output.png.
+
+```
+$ yml2erd help convert
+Usage:
+  yml2erd convert <path>
+
+Options:
+  o, [--output=FILE_PATH]          # default: output.png
+  p, [--projectname=PROJECT_NAME]
+  s, [--outputstyle=OUTPUT_STYLE]  # svg or png, default: png
+
+Convert erd from yml
+```
+
+## Rule
+You must write yml just like below
+
+```
+<table_name>:
+  columns:
+    - <column_name>: <column_type>
+  relations:
+    belongs_to:
+      - <table_name>
+    has_many:
+      - <table_name>
+  index:
+    - <column_name>
+```
+
+belongs_to or has_many is not necessary.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asmsuechan/yml2erd.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yml2erd"
+
+# 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

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/bin/yml2erd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'yml2erd'
+Yml2erd::CLI.start

data/lib/yml2erd/cli.rb

@@ -0,0 +1,22 @@
+require "yml2erd/parser"
+require "yml2erd/diagram"
+require "thor"
+
+module Yml2erd
+  class CLI < Thor
+    desc "convert <path>", "Convert erd from yml"
+    option :output, aliases: :o, banner: 'FILE_PATH', desc: 'default: output.png'
+    option :projectname, aliases: :p, banner: 'PROJECT_NAME', desc: 'default: null'
+    option :outputstyle, aliases: :s, banner: 'OUTPUT_STYLE', desc: 'svg or png, default: png'
+    def convert(path)
+      schema_structure = Yml2erd::Parser.parse(path)
+      opts = {
+        output_path: options[:output_path],
+        project_name: options[:projectname],
+        output_style: options[:outputstyle]
+      }
+      Yml2erd::Diagram.create(schema_structure, opts)
+      puts 'Successfully converted!'
+    end
+  end
+end

data/lib/yml2erd/diagram.rb

@@ -0,0 +1,54 @@
+require "graphviz"
+
+module Yml2erd
+  class Diagram
+    class << self
+      DEFAULT_OPTIONS = { output_path: './output.png' }.freeze
+
+      def table_relations(schema_structure)
+        schema_structure.relations
+      end
+
+      def create(schema_structure, opts = {})
+        opts = opts.merge(DEFAULT_OPTIONS)
+        GraphViz::options(use: 'dot')
+        g = GraphViz::new('structs', label: opts[:project_name])
+
+        table_names = schema_structure.table_names
+
+        table_names.each do |table_name|
+          columns = ''
+          schema_structure.columns(table_name).each do |column|
+            column.each { |key, value| columns += "#{key}: <FONT color='gray'>#{value}</FONT><BR/>" }
+          end
+
+          index = schema_structure.index(table_name)
+          label = build_label(table_name, columns, index)
+          g.add_nodes(table_name, shape: "record", label: label, style: "rounded")
+        end
+
+        table_names.each do |table_name|
+          unless schema_structure.relation(table_name)['belongs_to'].nil?
+            schema_structure.relation(table_name)['belongs_to'].each do |belongs_to|
+              g.add_edges(belongs_to, table_name)
+            end
+          end
+        end
+
+        if opts[:output_style] == 'svg'
+          g.output(:svg=> opts[:output_path] + '.svg')
+        else
+          g.output(:png => opts[:output_path])
+        end
+      end
+
+      def build_label(table_name, columns, index)
+        if index
+          "<{<FONT POINT-SIZE='15'>#{table_name}</FONT> | #{columns} | indexed: #{index.to_s}}>"
+        else
+          "<{<FONT POINT-SIZE='15'>#{table_name}</FONT> | #{columns}}>"
+        end
+      end
+    end
+  end
+end

data/lib/yml2erd/parser.rb

@@ -0,0 +1,17 @@
+require 'yml2erd/schema_structure'
+require 'yml2erd/schema_structure/validator'
+require 'yaml'
+
+module Yml2erd
+  class Parser
+    class << self
+      # returns an object of Yml2erd::SchemaStructure
+      def parse(path)
+        yml = YAML.load_file(path)
+        ss = Yml2erd::SchemaStructure.new(yml)
+        Yml2erd::SchemaStructure::Validator.new(ss).validate
+        ss
+      end
+    end
+  end
+end

data/lib/yml2erd/schema_structure/validator.rb

@@ -0,0 +1,62 @@
+module Yml2erd
+  class SchemaStructure
+    class Validator
+      RELATIONS_KEY = %w(belongs_to has_many)
+
+      class InvalidKeyNameError < StandardError;end
+      class InvalidYmlStructureError < StandardError;end
+
+      attr_reader :ss
+
+      def initialize(schema_structure)
+        @ss = schema_structure
+      end
+
+      def validate
+        # relations
+        columns
+        keyname
+      end
+
+      private
+
+      # check to match or not a table name among relations
+      def relations
+        raise InvalidYmlStructureError
+      end
+
+      # columns must be an array
+      def columns
+        ss.table_names.each do |table_name|
+          raise InvalidYmlStructureError, 'columns must be an array' unless ss.columns(table_name).class == Array
+        end
+      end
+
+      # yml structure is just like below
+      # ```
+      # <table_name>:
+      #   columns:
+      #     - <column_name>: <column_type>
+      #   relations:
+      #     belongs_to:
+      #       - <table_name>
+      #     has_many:
+      #       - <table_name>
+      #   index:
+      #     - <column_name>
+      # ```
+      # belongs_to or has_many is not necessary
+      def keyname
+        ss.table_names.each do |table_name|
+          if correct_relation_key?(table_name) && ss.columns(table_name).nil? && ss.relation(table_name).nil?
+            raise InvalidKeyNameError, 'you must use correct keyname'
+          end
+        end
+      end
+
+      def correct_relation_key?(table_name)
+        ss.relation(table_name).keys.map { |key| RELATIONS_KEY.include?(key) }.all?
+      end
+    end
+  end
+end

data/lib/yml2erd/schema_structure.rb

@@ -0,0 +1,46 @@
+module Yml2erd
+  class SchemaStructure
+
+    attr_accessor :structure_yml, :table_names
+
+    def initialize(yml)
+      @structure_yml = yml
+      @table_names = table_names
+    end
+
+    # returns an array which has table_names like bellow
+    # => ["users", "user_auths", "posts", "companies"]
+    def table_names
+      structure_yml.to_a.map { |s| s.first }
+    end
+
+    # returns a hash like below
+    # { users: { belongs_to: ['user_auths', 'companies'], has_many: ['posts'] } }
+    def relation(table_name)
+      relations = structure_yml[table_name]['relations']
+      # { table_name.to_sym => relations }
+    end
+
+    def relations
+      table_names.map { |table_name| relation(table_name) }
+    end
+
+    # returns a hash like below
+    # => {"columns"=>[{"name"=>"string"}, {"email"=>"string"}], "relations"=>{"belongs_to"=>["user_auths", "companies"], "has_many"=>["posts"]}}
+    def table(table_name)
+      structure_yml[table_name]
+    end
+
+    # returns an array like below
+    # => [{"name"=>"string"}, {"email"=>"string"}]
+    def columns(table_name)
+      structure_yml[table_name]['columns']
+    end
+
+    # returns an array like below
+    # => ["email"]
+    def index(table_name)
+      structure_yml[table_name]['index']
+    end
+  end
+end

data/lib/yml2erd/version.rb

@@ -0,0 +1,3 @@
+module Yml2erd
+  VERSION = "0.9.0"
+end

data/lib/yml2erd.rb

@@ -0,0 +1,8 @@
+# require "yml2erd/version"
+# require "yml2erd/analyzer"
+# require "yml2erd/converter"
+require "yml2erd/cli"
+
+module Yml2erd
+  # Your code goes here...
+end

data/sample.yml

@@ -0,0 +1,30 @@
+users:
+  columns:
+    - name: string
+    - email: string
+  relations:
+    belongs_to:
+      - user_auths
+      - companies
+    has_many:
+      - posts
+  index:
+    - email
+user_auths:
+  columns:
+    - password: string
+  relations:
+    has_many:
+      - users
+posts:
+  columns:
+    - content: text
+  relations:
+    belongs_to:
+      - users
+companies:
+  columns:
+    - name: string
+    - address: string
+  relations:
+    has_many: users

data/sample_abnormal.yml

@@ -0,0 +1,19 @@
+invalid_columns_style:
+  columns:
+    name: string
+    email: string
+  relations:
+invalid_relation_key:
+  columns:
+    - name: string
+    - email: string
+  relations:
+    invalid_key:
+      - child
+child:
+  columns:
+    - name: string
+    - email: string
+  relations:
+    belongs_to:
+      - invalid_relation_key

data/yml2erd.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yml2erd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yml2erd"
+  spec.version       = Yml2erd::VERSION
+  spec.authors       = ["asmsuechan"]
+  spec.email         = ["suenagaryoutaabc@gmail.com"]
+
+  spec.summary       = %q{This gem allows us to generate erd easily.}
+  spec.description   = %q{Convert simple yml to erd}
+  spec.homepage      = "https://github.com/asmsuechan/yml2erd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "ruby-graphviz"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: yml2erd
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- asmsuechan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  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: thor
+  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: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: pry
+  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: pry-doc
+  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: pry-byebug
+  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: Convert simple yml to erd
+email:
+- suenagaryoutaabc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/yml2erd
+- lib/yml2erd.rb
+- lib/yml2erd/cli.rb
+- lib/yml2erd/diagram.rb
+- lib/yml2erd/parser.rb
+- lib/yml2erd/schema_structure.rb
+- lib/yml2erd/schema_structure/validator.rb
+- lib/yml2erd/version.rb
+- sample.yml
+- sample_abnormal.yml
+- yml2erd.gemspec
+homepage: https://github.com/asmsuechan/yml2erd
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This gem allows us to generate erd easily.
+test_files: []