drawerd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae10c530c0301c3a0d363cb7bb877f0d0e98bbd9c4f2defee45392cce5287040
+  data.tar.gz: '08b07ecc0ccf861a8582a76cabd619541c3ed0a3b91f99ff6b90d3a361fc4ec7'
+SHA512:
+  metadata.gz: 0cfde721641347a5f1a07769a3e67911ecc9ebea944298d6d969eff42a3c5e302354100ca926ef8e434d0a603603d6edc0eb97c0b8baf20427342cdcfcb82450
+  data.tar.gz: ee91480ba75b1cd680ae86f72c861c58f349067e35caa2604deba05ce9b322f3edd2bfd780edef957ee3591a789a471224805080e6134aa05ed7a45672e0b39f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in drawerd.gemspec
+gemspec
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    drawerd (0.1.0)
+      rails-erd (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    choice (0.2.0)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rails-erd (1.6.0)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+      choice (~> 0.2.0)
+      ruby-graphviz (~> 1.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-graphviz (1.2.5)
+      rexml
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  drawerd!
+  minitest (~> 5.0)
+  rake (~> 12.3.3)
+  rubocop
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hooopo Wang
+
+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,39 @@
+# Drawerd
+
+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/drawerd`. 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 'drawerd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drawerd
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/drawerd.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'drawerd'
+
+# 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/drawerd.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drawerd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'drawerd'
+  spec.version       = Drawerd::VERSION
+  spec.authors       = ['Hooopo Wang']
+  spec.email         = ['hoooopo@gmail.com']
+
+  spec.summary       = 'generate erd for rails, using rails-erd and drawerd.com service.'
+  spec.description   = 'Generate erd for rails, usiing rails-erd and drawerd.com service.'
+  spec.homepage      = 'https://help.drawerd.com'
+  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(__dir__)) 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 'rails-erd', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+end

data/lib/drawerd/railtie.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Drawerd::Railtie < Rails::Railtie
+  rake_tasks do
+    Drawerd.load_tasks
+  end
+end

data/lib/drawerd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Drawerd
+  VERSION = '0.1.0'
+end

data/lib/drawerd.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'drawerd/version'
+require 'drawerd/railtie' if defined?(Rails)
+
+module Drawerd
+  class Error < StandardError; end
+  # Your code goes here...
+  class << self
+    def loaded_tasks=(val); @loaded_tasks = val; end
+    def loaded_tasks; return @loaded_tasks; end
+
+    def load_tasks
+      return if(self.loaded_tasks)
+      self.loaded_tasks = true
+
+      Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+    end
+  end
+end

data/lib/generators/drawerd/USAGE

@@ -0,0 +1,4 @@
+Add a .rake file that automatically generate the graphical models when you do 
+a db:migrate in development mode:
+
+    rails generate drawerd:install

data/lib/generators/drawerd/install_generator.rb

@@ -0,0 +1,14 @@
+module Drawerd
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy drawerd rakefiles for automatic graphic generation"
+      source_root File.expand_path('../templates', __FILE__)
+
+      # copy rake tasks
+      def copy_tasks
+        template "auto_drawerd.rake", "lib/tasks/auto_drawerd.rake"
+      end
+
+    end
+  end
+end

data/lib/generators/drawerd/templates/auto_drawerd.rake

@@ -0,0 +1,6 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+  Drawerd.load_tasks
+end

data/lib/tasks/drawerd.rake

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+load 'rails_erd/tasks.rake'
+require 'rails_erd/diagram'
+require 'csv'
+
+class TableSchema
+  def initialize(table_name)
+    if table_name.split('.').size > 1
+      @schema, @name = table_name.split('.')
+    else
+      @schema = 'public'
+      @name   = table_name
+    end
+  end
+
+  attr_reader :name
+
+  attr_reader :schema
+end
+
+class DrawerdDiagram < RailsERD::Diagram
+  setup do
+    @table_csv = CSV.open(Rails.root.join('tables.csv'), 'wb')
+    @relation_csv = CSV.open(Rails.root.join('relations.csv'), 'wb')
+    @table_csv << %w[table_schema table_name column_name column_type ordinal_position is_nullable primary_key column_comment table_comment]
+    @relation_csv << %w[schema table column no relation_table_schema relation_table relation_column constraint_name relation_type]
+  end
+
+  each_entity do |entity|
+    model         = entity.model
+    table_name    = model.table_name
+    table_comment = ActiveRecord::Base.connection.table_comment(table_name)
+    table_name    = TableSchema.new(table_name).name
+    table_schema  = TableSchema.new(table_name).schema
+
+    entity.attributes.each_with_index do |attribute, ordinal_position|
+      column = attribute.column
+      column_name = column.name
+      column_type = column.type
+      is_nullable = column.null ? 't' : 'f'
+      primary_key = model.primary_key == column.name ? 't' : 'f'
+      column_comment = column.comment
+      @table_csv << [table_schema, table_name, column_name, column_type, ordinal_position, is_nullable, primary_key, column_comment, table_comment]
+    end
+  end
+  # Invoked once for each relationship
+  each_relationship do |relationship|
+    source = relationship.source
+    des = relationship.destination
+    source_model = source.model
+    des_model = des.model
+    source_table_name = source_model.table_name
+    des_table_name = des_model.table_name
+
+    schema = TableSchema.new(source_table_name).schema
+    table  = TableSchema.new(source_table_name).name
+
+    relation_table_schema = TableSchema.new(des_table_name).schema
+    relation_table = TableSchema.new(des_table_name).name
+
+    # TODO: fix mutual association
+    unless relationship.indirect?
+      if ass = relationship.associations.find { |x| x.macro == :has_many || x.macro == :has_one }
+        column          = ass.association_primary_key
+        relation_column = ass.foreign_key
+      end
+
+      if relationship.many_to? && !relationship.many_to_many?
+        if ass = relationship.associations.find { |x| x.macro == :belongs_to }
+          column          = ass.association_primary_key
+          relation_column = ass.foreign_key
+        end
+        schema, table, column, relation_table_schema, relation_table, relation_colunm = relation_table_schema, relation_table, relation_colunm, schema, table, column
+      end
+    end
+
+    relation_type = if relationship.one_to_one? then 'one'
+                    elsif relationship.indirect? && relationship.one_to_many? then 'm2m'
+                    elsif relationship.one_to_many?  then 'many'
+                    elsif relationship.many_to_many? then 'm2m'
+    end
+
+    @relation_csv << [schema, table, column, 1, relation_table_schema, relation_table, relation_column, nil, relation_type]
+  end
+
+  # Should save or return the generated diagram
+  save do
+    @table_csv.close
+    @relation_csv.close
+  end
+end
+
+namespace :drawerd do
+  desc "generate CSV file for drawerd services"
+  task generate: ['erd:check_dependencies', 'erd:options', 'erd:load_models'] do
+    say "Generating CSV for #{ActiveRecord::Base.descendants.length} models..."
+
+    DrawerdDiagram.create
+
+    say "Done! Saved tables.csv to #{Rails.root.join('tables.csv')}."
+    say "Done! Saved relations.csv to #{Rails.root.join('relations.csv')}."
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: drawerd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hooopo Wang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: Generate erd for rails, usiing rails-erd and drawerd.com service.
+email:
+- hoooopo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- drawerd.gemspec
+- lib/drawerd.rb
+- lib/drawerd/railtie.rb
+- lib/drawerd/version.rb
+- lib/generators/drawerd/USAGE
+- lib/generators/drawerd/install_generator.rb
+- lib/generators/drawerd/templates/auto_drawerd.rake
+- lib/tasks/drawerd.rake
+homepage: https://help.drawerd.com
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: generate erd for rails, using rails-erd and drawerd.com service.
+test_files: []