schema_doctor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb30a32516182031828f9be6b2f30a5496d5322ba77f7a4e17aa8655e2ef8596
-  data.tar.gz: 40a59308e3e55209061d7995c393ff45071352ee168af12ea09387edf07fcff2
+  metadata.gz: 74042fa873e37695d586611d9dc2b5c54c6b293f2c0bf545769ff165cf3972e3
+  data.tar.gz: b65964fe3c1c06ed555fdbad5c5ad78a876513605c84e4776dfcaff2f060042a
 SHA512:
-  metadata.gz: f7cd15084b68dd5b4c7993f5346344f01c2de301f2061ee7230267f2bf738a31b93611924a8532807ae25df8524e44f087d305116c988a6ed78d37ca0ebf2fb3
-  data.tar.gz: de186a77d0f1afec160804205a521784919a75f92452558baa8453eebfceebd34cef33fa190519872d4c2a0fdfed0a54f5ebe8bf79c025c0b44a85da45cd9fde
+  metadata.gz: b40f4e2c85e7530fc7ec798c203f19a2b96a5ae01439c2118fcaa290dd0ce02e13ce695f02a3fda308a376be3ee2350a269b9f77eb7fa6bbb3db997a8d8972d9
+  data.tar.gz: 13ba870f8f7f3e675b1f209fe5f07f243ebdd377f3de72774e94d65600feb23c4e3fe196e3bd047d3e753cdfc81a6da442b76b7fbbf37e1d3bdc37c839ff5713

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

@@ -36,6 +36,9 @@ module SchemaDoctor
           }
       rescue ActiveRecord::TableNotSpecified
         nil
+      rescue => e
+        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

data/lib/schema_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchemaDoctor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 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.2
 platform: ruby
 authors:
 - lni_T
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord