schema_doctor 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb30a32516182031828f9be6b2f30a5496d5322ba77f7a4e17aa8655e2ef8596
-  data.tar.gz: 40a59308e3e55209061d7995c393ff45071352ee168af12ea09387edf07fcff2
+  metadata.gz: 36282d15058adc20e4b9c2013bb9ddaa1d95f1e9457a10278be99a7b40c900e4
+  data.tar.gz: baf1eae580dedd1d8cbe4c5ca5bfef36e08849589aec89856731a9680cfc268a
 SHA512:
-  metadata.gz: f7cd15084b68dd5b4c7993f5346344f01c2de301f2061ee7230267f2bf738a31b93611924a8532807ae25df8524e44f087d305116c988a6ed78d37ca0ebf2fb3
-  data.tar.gz: de186a77d0f1afec160804205a521784919a75f92452558baa8453eebfceebd34cef33fa190519872d4c2a0fdfed0a54f5ebe8bf79c025c0b44a85da45cd9fde
+  metadata.gz: 917c1f0b805be6028f319f00698fdc153aedc38ffbf3b7ff6b780fc1d9eb4fd3fb7c0a106d4185cd32c54547279b509c869645a24ac3ca8849d2d5af6e4061a8
+  data.tar.gz: b309be6513ad10e6bf0563c9da4c87d1c9b17507f87d1a670527cc6c73f0f1b41ce0dab22a5b5b395fa3a196df991f96415078c33aaad3677e1163c87a6bb5ec

data/README.md

@@ -1,11 +1,29 @@
 # SchemaDoctor
 
-TBD
+Automatic database documentation tool, for Ruby on Rails project.
+
+## Demo
+
+- **[Sample Output](https://lnit.github.io/schema_doctor/)**
+  - Generated from [Mastodon](https://github.com/mastodon/mastodon)'s [schema](https://github.com/mastodon/mastodon/blob/9be77fc0dbb01c1a8a54cd3da97e16c7941df367/db/schema.rb).
 
 ## Installation
 
-TBD
+Add the gem to your project
+
+```rb
+gem "rails"
+
+group :development do
+  gem "schema_doctor"
+end
+```
+
+Then `bundle install` and you are ready to go.
 
 ## Usage
 
-TBD
+```sh
+rails schema:analyze # Analyze Database Schema.
+rails schema:export  # Export HTML.
+```

data/lib/schema_doctor/analyzer.rb

@@ -32,10 +32,15 @@ module SchemaDoctor
             table_comment: connection.table_comment(model.table_name),
             extra_comment: schema.dig(model.name, :extra_comment),
             columns: columns(model, schema.dig(model.name, :columns) || {}),
-            indexes: indexes(model)
+            indexes: indexes(model),
+            associations: associations(model)
           }
       rescue ActiveRecord::TableNotSpecified
         nil
+      rescue => e
+        # Skip analyzing if an error occurs
+        puts "Failed to process #{model.name}: #{e.inspect}"
+        puts "\e[31mWe're sorry, Failed to process \e[33m#{model.name}\e[31m:\n #{e.inspect}\e[0m"
       end
 
       schema
@@ -83,5 +88,38 @@ module SchemaDoctor
         }
       end
     end
+
+    def associations(model)
+      result = {
+        belongs: {},
+        has: {}
+      }
+
+      model.reflect_on_all_associations.each do |association|
+        case association.macro.to_s
+        when /\Abelongs_to/
+          result[:belongs][association.name] = {
+            macro: association.macro.to_s,
+            name: association.name,
+            class_name: association.class_name,
+            foreign_key: association.foreign_key,
+            options: association.options,
+            polymorphic: association.polymorphic?
+          }
+        when /\Ahas/
+          result[:has][association.name] = {
+            macro: association.macro.to_s,
+            name: association.name,
+            class_name: association.class_name,
+            options: association.options
+          }
+        else
+          puts "Unknown association type: #{association.macro}: :#{association.name}"
+          next
+        end
+      end
+
+      result
+    end
   end
 end

data/lib/schema_doctor/exporter.rb

@@ -23,6 +23,8 @@ module SchemaDoctor
           :toclevels: 1
           :toc-title: Table of Contents
           :linkattrs:
+          :sectlinks:
+          :sectanchors:
 
         TEXT
 
@@ -85,6 +87,71 @@ module SchemaDoctor
 
             TEXT
           end
+
+          # Output associations schema
+          f.puts <<~TEXT
+
+            === Associations
+          TEXT
+          belongs = model[:associations][:belongs]
+          if belongs.present?
+            f.puts <<~TEXT
+              [cols="1,1,1,1"]
+              |===
+              |macro|name|foreign_key|options
+
+            TEXT
+
+            belongs.each_value do |association|
+              class_name = association.delete(:class_name).to_s
+              polymorphic = association.delete(:polymorphic)
+              # TODO: polymorphicのリンク先を特定できるようにする。今のところリンクを生成しないように。
+              association[:name] = "link:#_#{class_name.downcase.gsub("::", "")}[#{association[:name]}]" unless polymorphic
+
+              str = association.values.map do |v|
+                escaped = v.to_s.gsub("|", "{vbar}")
+                "|#{escaped}\n"
+              end.join
+
+              f.puts <<~TEXT
+                #{str}
+              TEXT
+            end
+
+            f.puts "|==="
+          end
+
+          has = model[:associations][:has]
+          if has.present?
+            f.puts <<~TEXT
+              [cols="1,1,1"]
+              |===
+              |macro|name|options
+
+            TEXT
+
+            has.each_value do |association|
+              class_name = association.delete(:class_name).to_s
+              association[:name] = "link:#_#{class_name.gsub("::", "").downcase}[#{association[:name]}]"
+              str = association.values.map do |v|
+                escaped = v.to_s.gsub("|", "{vbar}")
+                "|#{escaped}\n"
+              end.join
+
+              f.puts <<~TEXT
+                #{str}
+              TEXT
+            end
+
+            f.puts "|==="
+          end
+
+          if belongs.empty? & has.empty?
+            f.puts <<~TEXT
+              None
+
+            TEXT
+          end
         end
       end
       puts "Done! => #{adoc_path}"

data/lib/schema_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchemaDoctor
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_doctor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - lni_T
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord