erd-keeper 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77c5453535635c62114cbbf22f081f7b637fc785
+  data.tar.gz: fda51f0d7de8eeb8e70caebe7286ab2bdfaa4747
+SHA512:
+  metadata.gz: e6e042352709e4429b79fc8b7e28fa198dd7cfa7635e71bf0bfee4af9fb5ec35f56b6c631a7e8856974ad5773214c00134f82e57e9adfb8f8f736ed04fde159a
+  data.tar.gz: 6ba9d3698db712c9cedf9a66ae6240169f2425e94cccbea01815f694774e9f480174049b856976b104ada98a340fbeb03118735a028755e6f79e857450988d26

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yasuhiro Matsumura
+
+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,50 @@
+# ErdKeeper
+
+ErdKeeper is a gem that outputs ER diagram by setting yaml.
+
+The output of ER diagram is realized by wrapping call of [rails-erd](https://github.com/voormedia/rails-erd).
+
+This gem generate a diagram based on your application's Active Record models.
+
+
+## Getting started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erd-keeper'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create configuration file (Write your application's Active Record models):
+
+```yml
+diagrams:
+  tweet:
+    - User
+    - Micropost
+  all:
+    - User
+    - Micropost
+    - Relationship
+```
+
+And then execute:
+
+    $ bundle exec erd-keeper --input="config/erd-keeper.yml" --output="./"
+
+
+### Options
+
+- --input : Write the path of the configuration file.
+- --output : Write the path of the output ER diagram.
+
+
+## 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/erd-keeper

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "command"
+
+Command.start

data/erd-keeper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'erd-keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "erd-keeper"
+  spec.version       = ErdKeeper::VERSION
+  spec.authors       = ["Yasuhiro Matsumura"]
+  spec.email         = ["ym.contributor@gmail.com"]
+
+  spec.summary       = %q{ErdKeeper is a gem that outputs ER diagram by setting yaml.}
+  spec.description   = %q{ErdKeeper is a gem that outputs ER diagram by setting yaml. The output of ER diagram is realized by wrapping call of rails-erd.}
+  spec.homepage      = "https://github.com/muramurasan/erd-keeper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rails-erd", "~> 1.1"
+  spec.add_dependency "thor"
+end

data/lib/command.rb

@@ -0,0 +1,19 @@
+require "thor"
+require "erd-keeper"
+
+class Command < Thor
+  default_command :generate
+
+  desc "generate", "generate ER diagrams."
+  method_option :input,
+                type: :string,
+                default: "erd-keeper.yml",
+                desc: "Specify the path of the configuration file"
+  method_option :output,
+                type: :string,
+                default: ".",
+                desc: "Specify the path of the output file"
+  def generate
+    ErdKeeper::GenerateErd.new.exec(options[:input], options[:output])
+  end
+end

data/lib/erd-keeper.rb

@@ -0,0 +1,56 @@
+require "yaml"
+require "erd-keeper/version"
+
+module ErdKeeper
+  class GenerateErd
+    def exec(input, output)
+      if Dir.exist?(output)
+        while(output[-1] == "/")
+          output.chop!
+        end
+      else
+        puts "--- output: Folder not found!"
+        puts "--- Stop the output of ERD."
+        return
+      end
+
+      if File.exist?(input)
+        generate_erd_by_setting(input, output)
+      else
+        puts "--- input: File not found!"
+        puts "--- Instead, it outputs for all models."
+        generate_project_erd(output)
+      end
+    end
+
+    private
+
+    def generate_erd_by_setting(input, output)
+      load_diagrams(input).each do |diagram_name , diagram|
+        puts "--- Generate ERD : #{diagram_name}"
+        if diagram.nil?
+          puts "--- #{diagram_name}: The models are not described!"
+          next
+        end
+        models = diagram.map { |m| m }
+        generate_domain_erd(diagram_name, models, output)
+      end
+    end
+
+    def load_diagrams(yaml)
+      load_yaml = YAML.load_file(yaml)
+      load_yaml["diagrams"]
+    end
+
+    def generate_domain_erd(diagram_name = "erd", models = nil, folder = ".")
+      system "bundle exec erd --only='#{models.join(",")}' "\
+             "--inheritance=true "\
+             "--title='#{diagram_name}' "\
+             "--filename=#{folder}/#{diagram_name} --filetype=png"
+    end
+
+    def generate_project_erd(folder)
+      system "bundle exec erd --title='All domain model' --filename=#{folder}/project --filetype=png"
+    end
+  end
+end

data/lib/erd-keeper/version.rb

@@ -0,0 +1,3 @@
+module ErdKeeper
+  VERSION = "0.1.5"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: erd-keeper
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Yasuhiro Matsumura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+description: ErdKeeper is a gem that outputs ER diagram by setting yaml. The output
+  of ER diagram is realized by wrapping call of rails-erd.
+email:
+- ym.contributor@gmail.com
+executables:
+- erd-keeper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/erd-keeper
+- erd-keeper.gemspec
+- lib/command.rb
+- lib/erd-keeper.rb
+- lib/erd-keeper/version.rb
+homepage: https://github.com/muramurasan/erd-keeper
+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: ErdKeeper is a gem that outputs ER diagram by setting yaml.
+test_files: []