runger_rails_model_explorer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13594a1f1badfb4c8a76809112550bd6fc1d6c9af400836f43dc0478a14723d6
+  data.tar.gz: 8c5f4913877b98d698a8543275eb085b65fee34b68f7e5ca8128e0b2d664ceab
+SHA512:
+  metadata.gz: 57f2707038031e6834cfb0b3f0f17196a5c8681c5530ade1b0e5a06aac0ccac01f72742fbabced9813f529a93dcdb87959506cb5de54cc2882f9a65168d71791
+  data.tar.gz: eb863c9993b29b9250f24760b0956a1f2cd7ddce234b47c20a376325f7e6f967c302ae5ae863b5453a89f0df8f7808d0434b7c4b745819081c8bc4fbfa8d2e77

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) David Runger
+
+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,47 @@
+# RungerRailsModelExplorer
+
+Explore your Rails models.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'runger_rails_model_explorer'
+```
+
+and then run `bundle install`.
+
+## Usage
+
+Add a Rails controller to your application that looks something like this:
+
+```rb
+# app/controllers/model_graph_controller.rb
+class ModelGraphController < ApplicationController
+  def index
+    bootstrap(model_metadata: RungerRailsModelExplorer.model_metadata)
+  end
+end
+```
+
+Add a view that looks something like this:
+
+```haml
+-# app/views/model_graph/index.html.haml
+- content_for(:page_assets) do
+  = ts_tag('model_graph')
+```
+
+Add a route that looks something like this:
+
+```rb
+# config/routes.rb
+get 'models', to: 'model_graph#index'
+```
+
+**NOTE:** If this is a private app, then you will probably want to secure that route somehow, e.g. within a Devise `authenticate :admin_user do ... end` block.
+
+Then, follow setup instructions for [the `@davidrunger/vue-model-explorer` NPM package][npm-package-setup-instructions].
+
+[npm-package-setup-instructions]: https://github.com/davidrunger/vue_rails_model_explorer/blob/main/vue-model-explorer/README.md

data/lib/runger_rails_model_explorer/version.rb

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

data/lib/runger_rails_model_explorer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'runger_rails_model_explorer/version'
+
+module RungerRailsModelExplorer
+  class << self
+    def model_metadata
+      Rails.application.eager_load!
+
+      models =
+        ActiveRecord::Base.descendants.select do |model_class|
+          !model_class.abstract_class? && model_class.table_exists?
+        end
+
+      models.map do |model|
+        {
+          model_name: model.name,
+          table_name: model.table_name,
+          columns: model.columns.map do |column|
+            {
+              name: column.name,
+              type: column.type,
+              null: column.null,
+              default: column.default,
+            }
+          end,
+          associations: model.reflect_on_all_associations.map do |association|
+            {
+              name: association.name,
+              macro: association.macro,
+              class_name: association.class_name,
+              options: association.options,
+            }
+          end,
+        }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: runger_rails_model_explorer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Runger
+bindir: bin
+cert_chain: []
+date: 2025-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+email:
+- davidjrunger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/runger_rails_model_explorer.rb
+- lib/runger_rails_model_explorer/version.rb
+homepage: https://github.com/davidrunger/vue_rails_model_explorer/blob/main/runger_rails_model_explorer/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davidrunger/vue_rails_model_explorer/blob/main/runger_rails_model_explorer/README.md
+  source_code_uri: https://github.com/davidrunger/vue_rails_model_explorer/blob/main/runger_rails_model_explorer/README.md
+  changelog_uri: https://github.com/davidrunger/vue_rails_model_explorer/blob/main/runger_rails_model_explorer/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Explore your Rails models
+test_files: []