schema_doctor 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74042fa873e37695d586611d9dc2b5c54c6b293f2c0bf545769ff165cf3972e3
-  data.tar.gz: b65964fe3c1c06ed555fdbad5c5ad78a876513605c84e4776dfcaff2f060042a
+  metadata.gz: da7654f58e8c8dff14e477cdf437a0c3532a2d650a299158eddda22d5ca2b794
+  data.tar.gz: 3a336c98c4420b1aa9f8b5d55ee99389aeeff4d893366eca32ad3e91e2ca18d5
 SHA512:
-  metadata.gz: b40f4e2c85e7530fc7ec798c203f19a2b96a5ae01439c2118fcaa290dd0ce02e13ce695f02a3fda308a376be3ee2350a269b9f77eb7fa6bbb3db997a8d8972d9
-  data.tar.gz: 13ba870f8f7f3e675b1f209fe5f07f243ebdd377f3de72774e94d65600feb23c4e3fe196e3bd047d3e753cdfc81a6da442b76b7fbbf37e1d3bdc37c839ff5713
+  metadata.gz: c7420bc7730dc74855950fefe32ca6352691ae2ee52f320556286f5ed8f5a6073fdcd75dec5d188d35a7f99759a493970a88d07fea01e2009552f5b067e6e084
+  data.tar.gz: 3d3fbe268ffc5cd71faca72598e70c3f35a1418cecdc835f5273c27c556448e1004ad555a1d8094eba0dedbdf9e0563c4de186a873d82e0d03088a60b084eccf

data/lib/schema_doctor/analyzer.rb

@@ -32,11 +32,13 @@ 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
@@ -86,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: Utils.sefety_dump_hash(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: Utils.sefety_dump_hash(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/utils.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SchemaDoctor
+  class Utils
+    class << self
+      def sefety_dump_hash(obj)
+        case obj
+        when Hash
+          obj.transform_values { |v| sefety_dump_hash(v) }
+        when Array
+          obj.map { |v| sefety_dump_hash(v) }
+        when TrueClass, FalseClass, NilClass, Integer, Float, String
+          obj
+        else
+          obj.to_s
+        end
+      end
+    end
+  end
+end

data/lib/schema_doctor/version.rb

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

data/lib/schema_doctor.rb

@@ -4,6 +4,7 @@ require_relative "schema_doctor/version"
 require_relative "schema_doctor/schema_file"
 require_relative "schema_doctor/analyzer"
 require_relative "schema_doctor/exporter"
+require_relative "schema_doctor/utils"
 require_relative "schema_doctor/railtie"
 
 module SchemaDoctor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_doctor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - lni_T
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -71,6 +71,7 @@ files:
 - lib/schema_doctor/railtie.rb
 - lib/schema_doctor/schema_file.rb
 - lib/schema_doctor/tasks/schemadoc.rake
+- lib/schema_doctor/utils.rb
 - lib/schema_doctor/version.rb
 - sig/schema_doctor.rbs
 homepage: https://github.com/lnit/schema_doctor