db_diagram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d57803fb20594bda33f3c18821172c211c407298f77195370437f96bc51f517
+  data.tar.gz: a155532c9d7a8afbb019f3a29187cf0a35b44ea2dc60d47590749f4f1b0b917d
+SHA512:
+  metadata.gz: a12348fb80939bbd79c82426c999fb7c71609fd8b095ecd972776212612edd928acd8fb0b5acdb457337e2017bc899d62a9b7abf7818bbe00b861e5f8915c187
+  data.tar.gz: aa20629614f8bec8195e3d1bd79cfe738b6a2ba6268e0138edec1afd70c34ec9430ffc629edfefd61b8a2fe673760e3589bb6c83d98e86483cdee1d2b1cb4af0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea/

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.3.8" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/workspace.xml

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="7f350ad4-1bb3-4a04-86f5-62b2a5e4d821" name="Default Changelist" comment="">
+      <change afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.rspec" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.travis.yml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/CODE_OF_CONDUCT.md" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/Gemfile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/LICENSE.txt" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/Rakefile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/bin/console" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/bin/setup" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/db_diagram.gemspec" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/db_diagram.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/db_diagram/version.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/spec/db_diagram_spec.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/spec/spec_helper.rb" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="ProjectId" id="1vFIxP5HDlxrTweBONN1ektn8eE" />
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">
+    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
+    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
+    <property name="WebServerToolWindowFactoryState" value="false" />
+    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
+    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
+    <property name="settings.editor.selected.configurable" value="preferences.externalDependencies" />
+    <property name="vue.rearranger.settings.migration" value="true" />
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
+  <component name="SvnConfiguration">
+    <configuration>$USER_HOME$/.subversion</configuration>
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="7f350ad4-1bb3-4a04-86f5-62b2a5e4d821" name="Default Changelist" comment="" />
+      <created>1626151656269</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1626151656269</updated>
+      <workItem from="1626151657542" duration="73000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shuh_jx@163.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in db_diagram.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    db_diagram (0.1.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+      ruby-graphviz (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (10.5.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby-graphviz (1.2.5)
+      rexml
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  db_diagram!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 suhu
+
+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,43 @@
+# DBDiagram
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/db_diagram`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db_diagram'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db_diagram
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/db_diagram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DBDiagram project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/db_diagram/blob/master/CODE_OF_CONDUCT.md).

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 "db_diagram"
+
+# 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/db_diagram.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "db_diagram/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_diagram"
+  spec.version       = DBDiagram::VERSION
+  spec.authors       = ["suhu"]
+  spec.email         = ["shuh_jx@163.com"]
+
+  spec.summary       = 'DBDiagram'
+  spec.description   = 'DBDiagram'
+  spec.homepage      = "https://github.com/shuhjx/db_diagram"
+  spec.license       = "MIT"
+
+  # 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.required_ruby_version = '>= 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "activerecord", ">= 4.2"
+  spec.add_runtime_dependency "activesupport", ">= 4.2"
+  spec.add_runtime_dependency "ruby-graphviz", "~> 1.2"
+end

data/lib/db_diagram.rb

@@ -0,0 +1,48 @@
+require "db_diagram/version"
+require "active_support/ordered_options"
+
+#   DBDiagram.options.orientation = :vertical
+#   DBDiagram.options.title = "My model diagram"
+module DBDiagram
+  class Error < StandardError; end
+
+  class << self
+    # Access to default options. Any instance of DBDiagram::Domain and
+    # DBDiagram::Diagram will use these options unless overridden.
+    attr_accessor :options
+
+    def default_options
+      ActiveSupport::OrderedOptions[
+        :attributes, :true, #显示全部字段，调用Attribute#true?
+        :filename, nil, #nil时文件名为数据库名
+        :filetype, :png,
+        :markup, true,
+        :notation, :simple, #显示式样
+        :orientation, :horizontal, #排列方向，横向
+        :sort, false, #字段不排序
+        :warn, true,
+        :title, true,
+        :exclude, nil, #不显示的表名，例：[:admins, users]
+        :only, nil, #只显示的表名，例：[:admins, users]
+        :only_recursion_depth, nil,
+        :prepend_primary, true, #把主键放在最前面
+        :cluster, false,
+      ]
+    end
+  end
+
+  module Inspectable # @private :nodoc:
+    def inspection_attributes(*attributes)
+      attribute_inspection = attributes.collect { |attribute|
+        " @#{attribute}=\#{[Symbol, String].include?(#{attribute}.class) ? #{attribute}.inspect : #{attribute}}"
+      }.join
+      class_eval <<-RUBY
+        def inspect
+          "#<\#{self.class}:0x%.14x#{attribute_inspection}>" % (object_id << 1)
+        end
+      RUBY
+    end
+  end
+
+  self.options = default_options #.merge(Config.load)
+end

data/lib/db_diagram/diagram.rb

@@ -0,0 +1,184 @@
+require "db_diagram/domain"
+
+module DBDiagram
+  # This class is an abstract class that will process a domain model and
+  # allows easy creation of diagrams. To implement a new diagram type, derive
+  # from this class and override +process_entity+, +process_relationship+,
+  # and (optionally) +save+.
+  #
+  # As an example, a diagram class that generates code that can be used with
+  # yUML (https://yuml.me) can be as simple as:
+  #
+  #   require "db_diagram/diagram"
+  #
+  #   class YumlDiagram < DBDiagram::Diagram
+  #     setup { @edges = [] }
+  #
+  #     each_relationship do |relationship|
+  #
+  #       arrow = case
+  #       when relationship.one_to_one?   then "1-1>"
+  #       when relationship.one_to_many?  then "1-*>"
+  #       when relationship.many_to_many? then "*-*>"
+  #       end
+  #
+  #       @edges << "[#{relationship.source}] #{arrow} [#{relationship.destination}]"
+  #     end
+  #
+  #     save { @edges * "\n" }
+  #   end
+  #
+  # Then, to generate the diagram (example based on the domain model of Gemcutter):
+  #
+  #   YumlDiagram.create
+  #   #=> "[Rubygem] 1-*> [Ownership]
+  #   #    [Rubygem] 1-*> [Subscription]
+  #   #    [Rubygem] 1-*> [Version]
+  #   #    [Rubygem] 1-1> [Linkset]
+  #   #    [Rubygem] 1-*> [Dependency]
+  #   #    [Version] 1-*> [Dependency]
+  #   #    [User] 1-*> [Ownership]
+  #   #    [User] 1-*> [Subscription]
+  #   #    [User] 1-*> [WebHook]"
+  #
+  # For another example implementation, see Diagram::Graphviz, which is the
+  # default (and currently only) diagram type that is used by Rails ERD.
+  #
+  # === Options
+  #
+  # The following options are available and will by automatically used by any
+  # diagram generator inheriting from this class.
+  #
+  # attributes:: Selects which attributes to display. Can be any combination of
+  #              +:content+, +:primary_keys+, +:foreign_keys+, +:timestamps+, or
+  #              +:inheritance+.
+  # warn:: When set to +false+, no warnings are printed to the
+  #        command line while processing the domain model. Defaults
+  #        to +true+.
+  class Diagram
+    class << self
+      # Generates a new domain model based on all <tt>ActiveRecord::Base</tt>
+      # subclasses, and creates a new diagram. Use the given options for both
+      # the domain generation and the diagram generation.
+      def create(options = {})
+        new(Domain.generate(options), options).create
+      end
+
+      protected
+
+      def setup(&block)
+        callbacks[:setup] = block
+      end
+
+      def each_entity(&block)
+        callbacks[:each_entity] = block
+      end
+
+      def each_relationship(&block)
+        callbacks[:each_relationship] = block
+      end
+
+      def save(&block)
+        callbacks[:save] = block
+      end
+
+      private
+
+      def callbacks
+        @callbacks ||= Hash.new { proc {} }
+      end
+    end
+
+    # The options that are used to create this diagram.
+    attr_reader :options
+
+    # The domain that this diagram represents.
+    attr_reader :domain
+
+    # Create a new diagram based on the given domain.
+    def initialize(domain, options = {})
+      @domain, @options = domain, DBDiagram.options.merge(options)
+    end
+
+    # Generates and saves the diagram, returning the result of +save+.
+    def create
+      generate
+      save
+    end
+
+    # Generates the diagram, but does not save the output. It is called
+    # internally by Diagram#create.
+    def generate
+      instance_eval(&callbacks[:setup])
+      if options.only_recursion_depth.present?
+        depth = options.only_recursion_depth.to_s.to_i
+        options[:only].dup.each do |class_name|
+          options[:only]+= recurse_into_relationships(@domain.entity_by_name(class_name), depth)
+        end
+        options[:only].uniq!
+      end
+
+      filtered_entities.each do |entity|
+        instance_exec entity, filtered_attributes(entity), &callbacks[:each_entity]
+      end
+
+      filtered_relationships.each do |relationship|
+        instance_exec relationship, &callbacks[:each_relationship]
+      end
+    end
+
+    def recurse_into_relationships(entity, max_level, current_level = 0)
+      return [] unless entity
+      return [] if max_level == current_level
+
+      relationships = entity.relationships.reject{|r| r.recursive?}
+
+      relationships.map do |relationship|
+        other_entity = if relationship.source == entity
+                          relationship.destination
+                        else
+                          relationship.source
+                        end
+        if other_entity and !other_entity.generalized?
+          [other_entity.name] + recurse_into_relationships(other_entity, max_level, current_level + 1)
+        else
+          []
+        end
+      end.flatten.uniq
+    end
+
+    def save
+      instance_eval(&callbacks[:save])
+    end
+
+    private
+
+    def callbacks
+      @callbacks ||= self.class.send(:callbacks)
+    end
+
+    def filtered_entities
+      @domain.entities.reject { |entity|
+        options.exclude.present? && [options.exclude].flatten.map(&:to_sym).include?(entity.name.to_sym) or
+        options[:only].present? && entity.model && ![options[:only]].flatten.map(&:to_sym).include?(entity.name.to_sym)
+      }.compact.tap do |entities|
+        raise "No entities found; create your models first!" if entities.empty?
+      end
+    end
+
+    def filtered_relationships
+      @domain.relationships
+    end
+
+    def filtered_attributes(entity)
+      entity.attributes.reject { |attribute|
+        # Select attributes that satisfy the conditions in the :attributes option.
+        [*options.attributes].none? { |type| attribute.send(:"#{type.to_s.chomp('s')}?") }
+      }
+    end
+
+    def warn(message)
+      puts "Warning: #{message}" if options.warn
+    end
+  end
+end