erd 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e01b6f95c48fb88666e202d05e7bf98108528302e77d898b2018f2d4e2605b
-  data.tar.gz: d36ff0445b128f2a95ce9516c14dcba5774a05e9d44c758fa59ccd7f5e2d1adf
+  metadata.gz: 23d4342f2a320f75b2e90d11bf2474d5f1878632369e6c5a9e3608f3c9ac9aee
+  data.tar.gz: d7b53a5993a0b95508e44be666ec68f620563e4a9ee7bfb7ef708f09beb0ffda
 SHA512:
-  metadata.gz: b872b5a9d45cef77e3c651e67577058b811a817ccd5229b92f2525b5a7a80ecfadbecf3a26e96ae4f6ad7582b9872288f6511c0a0dc136fc121b9faed894140f
-  data.tar.gz: e36dec85dbaadedd20d2b91872a66b8e555f854f6412c3a4ae6f4a18eb935f1f8d7eff8d920153c9a114febe41a28bdb09de241b5f46a8f0b7aad1b5f2093e89
+  metadata.gz: 37a889901a16afac747792e929a71a8831ff55b0119cdb5cf96911fb19447a493a717021c7a65c1e7d3274809af67dd64c6a0184f79aebfa09716198186d38f8
+  data.tar.gz: c87a23f1c22cbff2363b8f54d993be86669330854fd80bd9570df87b3f144434c9ad55aacceacdf08f95b0fe60ff0cf67d4a145ee1918c22c1cba2b7b8b31b15

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.sass-cache
 Gemfile.lock
 gemfiles/*.lock
 InstalledFiles

data/.travis.yml

@@ -14,7 +14,6 @@ cache:
 
 before_install:
   - sudo apt install -y chromium-chromedriver
-  - sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/bin/
   - gem i bundler -v '<2'
 
 rvm:
@@ -22,6 +21,7 @@ rvm:
   - 2.0.0
 
 gemfile:
+  - gemfiles/rails_60.gemfile
   - gemfiles/rails_52.gemfile
   - gemfiles/rails_51.gemfile
   - gemfiles/rails_50.gemfile
@@ -32,6 +32,8 @@ gemfile:
 
 matrix:
   exclude:
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_60.gemfile
     - rvm: 2.0.0
       gemfile: gemfiles/rails_52.gemfile
     - rvm: 2.0.0
@@ -46,6 +48,3 @@ matrix:
       gemfile: gemfiles/rails_40.gemfile
     - rvm: 2.6.0
       gemfile: gemfiles/rails_32.gemfile
-  include:
-    - rvm: 1.8.7
-      gemfile: gemfiles/rails_32.gemfile

data/README.md

@@ -0,0 +1,72 @@
+# Erd
+
+A Rails engine for drawing your app's ER diagram and operating migrations
+
+
+## Requirements
+
+* Rails 5.2, 5.1, 5.0, 4.2, 4.1, 4.0, 3.2, or 3.1
+
+* Graphviz
+
+
+## Installation
+
+Bundle 'erd' gem to your existing Rails app's Gemfile:
+```ruby
+gem 'erd', group: :development
+
+```
+
+
+## Usage
+
+Browse at your http://localhost:3000/erd
+
+
+## Features
+
+### Show Mode
+
+* Erd draws an ER diagram based on your app's database and models.
+
+* You can drag and arrange the positions of each model.
+
+    * Then you can save the positions to a local file `db/erd_positions.json`, so you can share the diagram between the team members.
+
+### Edit Mode
+
+* You can operate DB schema manipulations such as `add column`, `rename column`, `alter column`, `create model (as well as table)`, and `drop table`.
+
+* Then, Erd generates migration files on the server.
+
+* And you can run each migration on your browser super quickly.
+
+
+## TODO
+
+* Fix buggy JS
+
+* drop column (need to think of the UI)
+
+* stop depending on Graphviz
+
+* tests
+
+* cleaner code (the code is horrible. Please don't read the code, though of course your patches welcome)
+
+
+## Contributing to Erd
+
+* Send me your pull requests!
+
+
+## Team
+
+* [Akira Matsuda][https://github.com/amatsuda]
+* [Teppei Machida][http://github.com/machida] (design)
+
+
+## Copyright
+
+Copyright (c) 2012 Akira Matsuda. See MIT-LICENSE for further details.

data/app/controllers/erd/erd_controller.rb

@@ -1,70 +1,70 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'rails_erd/diagram/graphviz'
+require 'ruby-graphviz'
 require 'erd/application_controller'
 
 module Erd
   class ErdController < ::Erd::ApplicationController
+    POSITIONS_JSON_FILE = Rails.root.join('db/erd_positions.json').freeze
+    OLD_POSITIONS_JSON_FILE = Rails.root.join('db/erd_positions.json').freeze  # for compatibility
+
     def index
-      Rails.application.eager_load!
-      RailsERD.options[:filename], RailsERD.options[:filetype] = Rails.root.join('tmp/erd'), 'plain'
-      RailsERD::Diagram::Graphviz.create
-      plain = Rails.root.join('tmp/erd.plain').read
-      positions = if (json = Rails.root.join('tmp/erd_positions.json')).exist?
-        ActiveSupport::JSON.decode json.read
-      else
-        {}
-      end
-      @erd = render_plain plain, positions
+      @erd = render_plain generate_plain, saved_positions
+    end
 
+    def edit
+      @erd = render_plain generate_plain, saved_positions, true
       @migrations = Erd::Migrator.status
     end
 
     def update
-      changes = ActiveSupport::JSON.decode(params[:changes])
+      if params[:position_changes].present?
+        position_changes = ActiveSupport::JSON.decode(params[:position_changes])
+        positions = saved_positions
+        positions.merge! position_changes.transform_keys(&:tableize)
+        POSITIONS_JSON_FILE.open('w') {|f| f.write positions.to_json }
+      end
+
+      changes = params[:changes].present? ? ActiveSupport::JSON.decode(params[:changes]) : []
       executed_migrations, failed_migrations = [], []
       changes.each do |row|
         begin
           action, model, column, from, to = row['action'], row['model'], row['column'], row['from'], row['to']
-          if action == 'move'
+
+          case action
+          when 'create_model'
+            columns = column.split(' ').compact
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_model model, columns
+          when 'remove_model'
             model = model.tableize
-            json_file = Rails.root.join('tmp', 'erd_positions.json')
-            positions = json_file.exist? ? ActiveSupport::JSON.decode(json_file.read) : {}
-            positions[model] = to
-            json_file.open('w') {|f| f.write positions.to_json}
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "drop_#{model}"
+            gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    drop_table :#{model}\n  end"
+          when 'rename_model'
+            _model, from, to = from.tableize, to.tableize, model.tableize
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "rename_#{from}_to_#{to}"
+            gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    rename_table :#{from}, :#{to}\n  end"
+          when 'add_column'
+            model = model.tableize
+            name_and_type = column.scan(/(.*)\((.*?)\)/).first
+            name, type = name_and_type[0], name_and_type[1]
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "add_#{name}_to_#{model}", ["#{name}:#{type}"]
+          when 'rename_column'
+            model = model.tableize
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "rename_#{model}_#{from}_to_#{to}"
+            gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    rename_column :#{model}, :#{from}, :#{to}\n  end"
+          when 'alter_column'
+            model = model.tableize
+            generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "change_#{model}_#{column}_type_to_#{to}"
+            gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    change_column :#{model}, :#{column}, :#{to}\n  end"
+          when 'move'
+            # do nothing
           else
-            case action
-            when 'create_model'
-              columns = column.split(' ').compact
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_model model, columns
-            when 'remove_model'
-              model = model.tableize
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "drop_#{model}"
-              gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    drop_table :#{model}\n  end"
-            when 'rename_model'
-              _model, from, to = from.tableize, to.tableize, model.tableize
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "rename_#{from}_to_#{to}"
-              gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    rename_table :#{from}, :#{to}\n  end"
-            when 'add_column'
-              model = model.tableize
-              name_and_type = column.scan(/(.*)\((.*?)\)/).first
-              name, type = name_and_type[0], name_and_type[1]
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "add_#{name}_to_#{model}", ["#{name}:#{type}"]
-            when 'rename_column'
-              model = model.tableize
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "rename_#{model}_#{from}_to_#{to}"
-              gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    rename_column :#{model}, :#{from}, :#{to}\n  end"
-            when 'alter_column'
-              model = model.tableize
-              generated_migration_file = Erd::GenaratorRunner.execute_generate_migration "change_#{model}_#{column}_type_to_#{to}"
-              gsub_file generated_migration_file, /def (up|change).*  end/m, "def change\n    change_column :#{model}, :#{column}, :#{to}\n  end"
-            else
-              raise "unexpected action: #{action}"
-            end
-            Erd::Migrator.run_migrations :up => generated_migration_file
-            executed_migrations << generated_migration_file
+            raise "unexpected action: #{action}"
           end
+
+          Erd::Migrator.run_migrations :up => generated_migration_file
+          executed_migrations << generated_migration_file
         rescue ::Erd::MigrationError => e
           failed_migrations << e.message
         end
@@ -79,28 +79,70 @@ module Erd
     end
 
     private
-    def render_plain(plain, positions)
-      _scale, svg_width, svg_height = plain.scan(/\Agraph ([0-9\.]+) ([0-9\.]+) ([0-9\.]+)$/).first
-      # node name x y width height label style shape color fillcolor
-      max_model_x, max_model_y = 0, 0
-      models = plain.scan(/^node ([^ ]+) ([0-9\.]+) ([0-9\.]+) ([0-9\.]+) ([0-9\.]+) <\{?(<((?!^\}?>).)*)^\}?> [^ ]+ [^ ]+ [^ ]+ [^ ]+\n/m).map {|node_name, x, y, width, height, label|
-        label_doc = Nokogiri::HTML::DocumentFragment.parse(label)
-        model_name = node_name.dup
-        model_name[0] = model_name[-1] = '' if (model_name.first == '"') && (model_name.last == '"')
-        model_name = model_name.sub(/^m_/, '')
-        next if model_name.in? ['ActiveRecord::SchemaMigration', 'ActiveRecord::InternalMetadata']
-        columns = []
-        if (cols_table = label_doc.search('table')[1])
-          columns = cols_table.search('tr > td').map {|col| col_name, col_type = col.text.split(' '); {:name => col_name, :type => col_type}}
+
+    def saved_positions
+      if POSITIONS_JSON_FILE.exist?
+        ActiveSupport::JSON.decode(POSITIONS_JSON_FILE.read)
+      elsif OLD_POSITIONS_JSON_FILE.exist?
+        ActiveSupport::JSON.decode(OLD_POSITIONS_JSON_FILE.read)
+      else
+        {}
+      end
+    end
+
+    def generate_plain
+      if Rails.respond_to?(:autoloaders) && Rails.autoloaders.try(:zeitwerk_enabled?)
+        Zeitwerk::Loader.eager_load_all
+      else
+        Rails.application.eager_load!
+      end
+      ar_descendants = ActiveRecord::Base.descendants.reject {|m| m.name.in?(%w(ActiveRecord::SchemaMigration ActiveRecord::InternalMetadata ApplicationRecord)) }
+      ar_descendants.reject! {|m| !m.table_exists? }
+
+      g = GraphViz.new('ERD', :type => :digraph, :rankdir => 'LR', :labelloc => :t, :ranksep => '1.5', :nodesep => '1.8', :margin => '0,0', :splines => 'spline') {|g|
+        nodes = ar_descendants.each_with_object({}) do |model, hash|
+          next if model.name.start_with? 'HABTM_'
+          hash[model.name] = model.columns.reject {|c| c.name.in? %w(id created_at updated_at) }.map {|c| [c.name, c.type]}
+        end
+
+        edges = []
+        ar_descendants.each do |model|
+          model.reflect_on_all_associations.each do |reflection|
+            next unless nodes.key? model.name
+            next if reflection.macro == :belongs_to
+            next unless nodes.key?(reflection.klass.name)
+
+            edges << [model.name, reflection.klass.name]
+            # don't include the FKs in the diagram
+            nodes[reflection.klass.name].delete_if {|col, _type| col == reflection.foreign_key }
+          end
+        end
+
+        nodes.each_pair do |model_name, cols|
+          g.add_nodes model_name, 'shape' => 'record', 'label' => "#{model_name}|#{cols.map {|name, type| "#{name}(#{type})"}.join('\l')}"
         end
+        edges.each do |from, to|
+          g.add_edge g.search_node(from), g.search_node(to)
+        end
+      }
+      g.output('plain' => String)
+    end
+
+    def render_plain(plain, positions, edit_mode = false)
+      _scale, svg_width, svg_height = plain.scan(/\Agraph ([\d\.]+) ([\d\.]+) ([\d\.]+)$/).first
+      # node name x y width height label style shape color fillcolor
+      models = plain.scan(/^node ([^ ]+) ([\d\.]+) ([\d\.]+) ([\d\.]+) ([\d\.]+) ([^ ]+) [^ ]+ [^ ]+ [^ ]+ [^ ]+\n/m).map {|model_name, x, y, width, height, label|
+        columns = label.gsub("\\\n", '').split('|')[1].split('\l').map {|name_and_type| name_and_type.scan(/(.*?)\((.*?)\)/).first }.map {|n, t| {:name => n, :type => t} }
         custom_x, custom_y = positions[model_name.tableize].try(:split, ',')
-        h = {:model => model_name, :x => (custom_x || (BigDecimal(x) * 72).round), :y => (custom_y || (BigDecimal(y) * 72).round), :width => (BigDecimal(width) * 72).round, :height => height, :columns => columns}
-        max_model_x, max_model_y = [h[:x].to_i + h[:width].to_i, max_model_x, 1024].max, [h[:y].to_i + h[:height].to_i, max_model_y, 768].max
-        h
+        {:model => model_name, :x => (custom_x || (BigDecimal(x) * 72).round), :y => (custom_y || (BigDecimal(y) * 72).round), :width => (BigDecimal(width) * 72).round, :height => (BigDecimal(height) * 72).round, :columns => columns}
       }.compact
+      max_model_x = models.map {|m| m[:x].to_f + m[:width].to_f }.max
+      erd_width = [[(BigDecimal(svg_width) * 72).round, max_model_x].min + 150, 1024].max
+      max_model_y = models.map {|m| m[:y].to_f + m[:height].to_f }.max
+      erd_height = [[(BigDecimal(svg_height) * 72).round, max_model_y].min + 150, 768].max
       # edge tail head n x1 y1 .. xn yn [label xl yl] style color
-      edges = plain.scan(/^edge ([^ ]+)+ ([^ ]+)/).map {|from, to| {:from => from.sub(/^m_/, ''), :to => to.sub(/^m_/, '')}}
-      render_to_string 'erd/erd/erd', :layout => nil, :locals => {:width => [(BigDecimal(svg_width) * 72).round, max_model_x].max, :height => [(BigDecimal(svg_height) * 72).round, max_model_y].max, :models => models, :edges => edges}
+      edges = plain.scan(/^edge ([^ ]+)+ ([^ ]+)/).map {|from, to| {:from => from, :to => to}}
+      render_to_string 'erd/erd/erd', :layout => nil, :locals => {:width => erd_width, :height => erd_height, :models => models, :edges => edges, :edit_mode => edit_mode}
     end
 
     def gsub_file(path, flag, *args, &block)

data/app/views/erd/erd/_column.html.erb

@@ -2,12 +2,16 @@
   <table>
     <tr>
       <td>
-        <span class="column_name_text"><%= column[:name] %></span>
-        <form class="rename_column_form"><span><input name="model" type="hidden" value="<%= model[:model] %>" /><input name="column" type="hidden" value="<%= column[:name] %>" /><input name="to" type="text" /><input type="submit" value="Change" /></span><a href="#!" class="cancel">Cancel</a></form>
+        <span class="column_name_text<%= "#{' edit' if edit_mode}" %>"><%= column[:name] %></span>
+  <% if edit_mode %>
+          <form class="rename_column_form"><span><input name="model" type="hidden" value="<%= model[:model] %>" /><input name="column" type="hidden" value="<%= column[:name] %>" /><input name="to" type="text" /><input type="submit" value="Change" /></span><a href="#!" class="cancel">Cancel</a></form>
+  <% end %>
       </td>
       <td>
-        <span class="column_type_text <%= column[:type].delete(" ∗") %>"><%= column[:type] %></span>
-        <form class="alter_column_form"><span><input name="model" type="hidden" value="<%= model[:model] %>" /><input name="column" type="hidden" value="<%= column[:name] %>" /><input name="type" type="hidden" value="<%= column[:type] %>" /><input name="to" type="text" /><input type="submit" value="Change" /></span><a href="#!" class="cancel">Cancel</a></form>
+        <span class="column_type_text <%= column[:type] %><%= "#{' edit' if edit_mode}" %>"><%= column[:type] %></span>
+  <% if edit_mode %>
+          <form class="alter_column_form"><span><input name="model" type="hidden" value="<%= model[:model] %>" /><input name="column" type="hidden" value="<%= column[:name] %>" /><input name="type" type="hidden" value="<%= column[:type] %>" /><input name="to" type="text" /><input type="submit" value="Change" /></span><a href="#!" class="cancel">Cancel</a></form>
+  <% end %>
       </td>
     </tr>
   </table>

data/app/views/erd/erd/_model.html.erb

@@ -1,28 +1,34 @@
 <div id="erd-<%= model[:model] %>" class="model" style="top: <%= model[:y] %>px; left: <%= model[:x] %>px;" data-model_name="<%= model[:model] %>">
-  <a href="#!" class="close"><%= image_tag("/assets/erd/close.png") %></a>
-  <div class="model_name">
+  <% if edit_mode %>
+    <a href="#!" class="close"><%= image_tag '/erd/close.png' %></a>
+  <% end %>
+  <div class="model_name<%= "#{' edit' if edit_mode}" %>">
     <div class="model_name_text"><%= model[:model] %></div>
-    <form class="rename_model_form">
-      <table>
-        <tr>
-          <td>
-            <input name="model" type="hidden" value="<%= model[:model] %>"/>
-          </td>
-          <td>
-            <input name="to" type="text" /><input type="submit" value="Change"/>
-          </td>
-        </tr>
-      </table>
-      <a href="#!" class="cancel">Cancel</a>
-    </form>
+    <% if edit_mode %>
+      <form class="rename_model_form">
+        <table>
+          <tr>
+            <td>
+              <input name="model" type="hidden" value="<%= model[:model] %>"/>
+            </td>
+            <td>
+              <input name="to" type="text" /><input type="submit" value="Change"/>
+            </td>
+          </tr>
+        </table>
+        <a href="#!" class="cancel">Cancel</a>
+      </form>
+    <% end %>
   </div>
   <div class="columns">
     <ul>
-      <%= render :partial => 'erd/erd/column', :collection => model[:columns], :locals => {:model => model} -%>
+      <%= render :partial => 'erd/erd/column', :collection => model[:columns], :locals => {:model => model, :edit_mode => edit_mode} -%>
     </ul>
   </div>
   <div class="add_column_box">
-    <a href="#!" class="add_column">add column</a>
+    <% if edit_mode %>
+      <a href="#!" class="add_column">add column</a>
+    <% end %>
     <form class="add_column_form">
       <input name="model" type="hidden" value="<%= model[:model] %>" />
       <table>

data/app/views/erd/erd/edit.html.erb

@@ -0,0 +1,87 @@
+<div id="erd_box">
+  <div id="erd_container">
+    <%=raw @erd %>
+  </div>
+  <div id="open_migration"><%= image_tag '/erd/angle-left.png' %></div>
+  <div id="migration">
+    <div id="close_migration"><%= image_tag '/erd/angle-right.png' %></div>
+    <%- if flash[:executed_migrations].present? -%>
+      <div id="executed">
+        <h2>Successfully executed following <%= flash[:executed_migrations].values.flatten.count %> migrations!</h2>
+        <%- [:up, :down].each do |direction| -%>
+          <%- if flash[:executed_migrations][direction].present? -%>
+            <h3><%= direction %></h3>
+            <ul>
+            <%- flash[:executed_migrations][direction].each do |m| -%>
+              <li><%= File.basename m.to_s %></li>
+            <%- end -%>
+            </ul>
+          <%- end -%>
+        <%- end -%>
+      </div>
+    <%- end -%>
+    <%- if flash[:failed_migrations].present? -%>
+      <div id="failed">
+        <h2>failed migrations</h2>
+        <ul>
+        <%- flash[:failed_migrations].each do |m| -%>
+          <li><%= m %></li>
+        <%- end -%>
+        </ul>
+      </div>
+    <%- end -%>
+    <table id="changes">
+      <caption>schema changes</caption>
+      <thead><tr><th>action</th><th>model</th><th>column</th><th>from</th><th>to</th></tr></thead>
+      <tbody></tbody>
+    </table>
+    <%= form_tag '/erd', :method => :put, :id => 'changes_form' do %>
+      <%= hidden_field_tag 'changes' %>
+      <%= hidden_field_tag 'position_changes' %>
+      <%= submit_tag 'save changes' %>
+    <% end %>
+    <%= form_tag '/erd/migrate', :method => :put, :id => 'migrate_form' do %>
+      <ul id="open_buttons">
+        <li><button id="open_up" type="button">up</button></li>
+        <li><button id="open_down" type="button">down</button></li>
+        <li><button id="close_all" type="button">close</button></li>
+      </ul>
+      <table id="migration_status">
+        <caption>migration status</caption>
+        <thead>
+          <tr><th class="status">status</th><th class="version">version</th><th class="name">name</th></tr>
+          <tr><td colspan="3" class="migrations">
+            <button>UNFOLD ALL</button>
+            <%= @migrations.count %> migrations in total (up: <%= @migrations.count {|m| m[:status] == 'up'} %>, down: <%= @migrations.count {|m| m[:status] == 'down'} %>)
+          </td></tr>
+        </thead>
+        <tbody>
+          <%- @migrations.each do |m| -%>
+            <tr class="<%= m[:status] %>">
+              <td><label><%= check_box_tag (m[:status] == 'up' ? 'down[]' : 'up[]'), m[:filename], false, :id => "check_#{m[:filename]}" %><%= m[:status] %></label></td>
+              <td><%= m[:version] %></td>
+              <td class="migration_file_name"><%= m[:name] %></td>
+            </tr>
+          <%- end -%>
+        </tbody>
+      </table>
+      <%= submit_tag 'run migrations' %>
+    <% end %>
+  </div>
+  <a href="#" id='open_create_model_dialog'%>Create Model</a>
+  <div id="create_model_form">
+    <form>
+      Model Name: <input id="new_model_name" name="new_model_name" type="text" /><br>
+      <table id="create_model_table">
+        <tbody>
+          <tr>
+            <td><input name="new_model_column_name_1" type="text" /></td>
+            <td class="separator">:</td>
+            <td><input name="new_model_column_type_1" type="text" value="string" /></td>
+          </tr>
+        </tbody>
+      </table>
+      <div><a href="#" id="new_model_add_column" class="ui-button ui-widget ui-state-default ui-corner-all ui-button-text-only"><span class="ui-button-text">Add More Column</span></a></div>
+    </form>
+  </div>
+</div>