rails_erd_viewer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57e5bc9a196ae2b3a355691d443a910b14303c0f72974d723c12ad9612213dd6
+  data.tar.gz: 814b1568381750e9b4cf5a4f379a7a861c8feab0126decf9ed20953ef846cb37
+SHA512:
+  metadata.gz: '06391e090974a2768d70fd3363cc722876f6546ac4947687b2001b4d17c00491a143d1526eda6e73b34620800555703058cecd10db9e975a2d044c772acf00a5'
+  data.tar.gz: adb1aeecee36b7cec8d6f593977990b2defad29a60f6246db0d7709b69a5b29279c8fcaf55fb0983bf279647400431c5adb04760c5becfb5b768ce997b3ac21f

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+## 0.1.1 (18-Nov-24)
+* Initial release

data/Gemfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+gemspec
+
+group :development, :test do
+  case rails_version = ENV.fetch('RAILS_VERSION', nil)
+  when nil
+    gem 'rails'
+  when 'edge'
+    gem 'rails', github: 'rails/rails'
+  else
+    gem 'rails', "~> #{rails_version}.0"
+  end
+
+  gem 'codecov'
+  gem 'rails-controller-testing'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rails'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'rubocop-rspec_rails'
+  gem 'simplecov'
+  gem 'sprockets-rails'
+  gem 'sqlite3'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Lokalise team, Ilya Bodrov
+
+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,42 @@
+# Rails ERD Viewer
+
+Rails ERD Viewer automatically generates Entity-Relationship Diagrams from your ActiveRecord and displays them
+using [erd-editor](https://github.com/dineug/erd-editor).
+
+---
+
+### Install
+
+Add this to the development group in your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'rails_erd_viewer', '~> 0.1.0'
+end
+```
+
+---
+
+### Usage
+
+Run `rails erd:generate`.
+
+Then visit `/erd-viewer`
+
+
+---
+
+### Automatic ERD Generation
+
+The ERD generation will happen automatically in the following situations:
+
+- **After running migrations**: Every time you execute `rails db:migrate`, `rails db:reset`, or `rails db:redo`, the ERD diagram will be automatically generated, reflecting changes in the database.
+- **After a rollback**: Whenever you run `rails db:rollback`, the ERD diagram will be regenerated to reflect the current state of the database.
+
+This ensures that the ERD diagram is always up-to-date, reflecting changes in the database structure without the need for additional commands.
+
+---
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wptussolini/rails_erd_viewer.

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rake'
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/lib/rails_erd_viewer/engine.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsErdViewer
+  # RailsErdViewer::Engine
+  class Engine < Rails::Engine
+    isolate_namespace RailsErdViewer
+
+    initializer 'rails_erd_viewer.assets.precompile' do |app|
+      app.config.assets.precompile += %w[
+        rails_erd_viewer/application.js
+      ]
+    end
+  end
+end

data/lib/rails_erd_viewer/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails_erd_viewer'
+require 'rails'
+
+module RailsErdViewer
+  # RailsErdViewer::Railtie
+  class Railtie < Rails::Railtie
+    railtie_name :rails_erd_viewer
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/rails_erd_viewer/schema_generator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RailsErdViewer
+  #  ERDGenerator
+  class SchemaGenerator
+    def self.generate
+      file_path = Rails.root.join('tmp/application_schema.sql')
+      File.open(file_path, 'w') do |file|
+        ActiveRecord::Base.connection.tables.each do |table_name|
+          columns = ActiveRecord::Base.connection.columns(table_name)
+
+          add_table_to_file(file, table_name, columns)
+
+          add_foreign_keys_to_file(file, table_name)
+        end
+      end
+    end
+
+    def self.add_table_to_file(file, table_name, columns)
+      file.write "CREATE TABLE #{table_name} (\n"
+      add_columns_to_file(file, columns)
+      file.write "    PRIMARY KEY (id)\n" if columns.any? { |c| c.name == 'id' }
+      file.write ");\n\n"
+    end
+
+    def self.add_foreign_keys_to_file(file, table_name)
+      foreign_keys = ActiveRecord::Base.connection.foreign_keys(table_name)
+      foreign_keys.each do |fk|
+        file.write(
+          "ALTER TABLE #{fk.from_table} ADD FOREIGN KEY (#{fk.column}) " \
+          "REFERENCES #{fk.to_table} (#{fk.primary_key});\n"
+        )
+      end
+    end
+
+    def self.add_columns_to_file(file, columns)
+      columns_count = columns.size
+      columns.each_with_index do |column, index|
+        column_end = index == columns_count - 1 ? '' : ','
+        add_column_to_file(file, column, column_end)
+      end
+    end
+
+    def self.add_column_to_file(file, column, column_end)
+      type = get_column_type(column)
+
+      null_constraint = column.null ? '' : ' NOT NULL'
+      default_constraint = column.default.nil? ? '' : " DEFAULT #{column.default.inspect}"
+
+      file.write "    #{column.name} #{type}#{null_constraint}#{default_constraint}#{column_end}\n"
+    end
+
+    def self.get_column_type(column)
+      column_type_map[column.type] || 'unknown'
+    end
+
+    def self.column_type_map
+      {
+        string: 'varchar(255)', text: 'text', integer: 'integer(11)', float: 'float', decimal: 'decimal(10,2)',
+        datetime: 'datetime', boolean: 'boolean', date: 'date', time: 'time'
+      }
+    end
+  end
+end

data/lib/rails_erd_viewer/version.rb

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

data/lib/rails_erd_viewer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'rails_erd_viewer/version'
+require 'rails_erd_viewer/engine'
+require_relative 'rails_erd_viewer/schema_generator'
+module RailsErdViewer
+  require 'rails_erd_viewer/railtie' if defined?(Rails)
+  class MissingErdSchemaError < StandardError; end
+end

data/lib/tasks/db.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :db do
+  namespace :migrate do
+    %i[change up down reset redo].each do |t|
+      task t => :environment do # rubocop:disable
+        RailsErdViewer::SchemaGenerator.generate
+      end
+    end
+  end
+end

data/lib/tasks/generate_erd.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :erd do
+  desc 'Generate ERD Schema of the Database'
+  task generate: :environment do
+    RailsErdViewer::SchemaGenerator.generate
+    puts 'ERD Schema generated successfully. You can view it at: http://localhost:3000/erd-viewer'
+  end
+end

data/rails_erd_viewer.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/rails_erd_viewer/version', __dir__)
+Gem::Specification.new do |spec|
+  spec.name = 'rails_erd_viewer'
+  spec.version = RailsErdViewer::VERSION
+  spec.authors = ['Phelipe Tussolini']
+  spec.email = ['wp.tussolini@gmail.com']
+  spec.summary = 'A gem to visualize Entity-Relationship Diagram from your rails application.'
+  spec.description = 'RailsERD Viewer helps developers visualize ERDs, making database relationships clearer.'
+  spec.homepage = 'https://github.com/wptussolini/rails-erd'
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.license = 'MIT'
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.files = Dir['README.md', 'LICENSE',
+                   'CHANGELOG.md', 'lib/**/*.rb',
+                   'lib/**/*.rake',
+                   'rails_erd_viewer.gemspec', '.github/*.md',
+                   'Gemfile', 'Rakefile']
+  spec.extra_rdoc_files = ['README.md']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: rails_erd_viewer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Phelipe Tussolini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-25 00:00:00.000000000 Z
+dependencies: []
+description: RailsERD Viewer helps developers visualize ERDs, making database relationships
+  clearer.
+email:
+- wp.tussolini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_erd_viewer.rb
+- lib/rails_erd_viewer/engine.rb
+- lib/rails_erd_viewer/railtie.rb
+- lib/rails_erd_viewer/schema_generator.rb
+- lib/rails_erd_viewer/version.rb
+- lib/tasks/db.rake
+- lib/tasks/generate_erd.rake
+- rails_erd_viewer.gemspec
+homepage: https://github.com/wptussolini/rails-erd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A gem to visualize Entity-Relationship Diagram from your rails application.
+test_files: []