schema_doctor 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +21 -3
- data/lib/schema_doctor/analyzer.rb +3 -0
- data/lib/schema_doctor/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 74042fa873e37695d586611d9dc2b5c54c6b293f2c0bf545769ff165cf3972e3
|
|
4
|
+
data.tar.gz: b65964fe3c1c06ed555fdbad5c5ad78a876513605c84e4776dfcaff2f060042a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b40f4e2c85e7530fc7ec798c203f19a2b96a5ae01439c2118fcaa290dd0ce02e13ce695f02a3fda308a376be3ee2350a269b9f77eb7fa6bbb3db997a8d8972d9
|
|
7
|
+
data.tar.gz: 13ba870f8f7f3e675b1f209fe5f07f243ebdd377f3de72774e94d65600feb23c4e3fe196e3bd047d3e753cdfc81a6da442b76b7fbbf37e1d3bdc37c839ff5713
|
data/README.md
CHANGED
|
@@ -1,11 +1,29 @@
|
|
|
1
1
|
# SchemaDoctor
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Automatic database documentation tool, for Ruby on Rails project.
|
|
4
|
+
|
|
5
|
+
## Demo
|
|
6
|
+
|
|
7
|
+
- **[Sample Output](https://lnit.github.io/schema_doctor/)**
|
|
8
|
+
- Generated from [Mastodon](https://github.com/mastodon/mastodon)'s [schema](https://github.com/mastodon/mastodon/blob/9be77fc0dbb01c1a8a54cd3da97e16c7941df367/db/schema.rb).
|
|
4
9
|
|
|
5
10
|
## Installation
|
|
6
11
|
|
|
7
|
-
|
|
12
|
+
Add the gem to your project
|
|
13
|
+
|
|
14
|
+
```rb
|
|
15
|
+
gem "rails"
|
|
16
|
+
|
|
17
|
+
group :development do
|
|
18
|
+
gem "schema_doctor"
|
|
19
|
+
end
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Then `bundle install` and you are ready to go.
|
|
8
23
|
|
|
9
24
|
## Usage
|
|
10
25
|
|
|
11
|
-
|
|
26
|
+
```sh
|
|
27
|
+
rails schema:analyze # Analyze Database Schema.
|
|
28
|
+
rails schema:export # Export HTML.
|
|
29
|
+
```
|
|
@@ -36,6 +36,9 @@ module SchemaDoctor
|
|
|
36
36
|
}
|
|
37
37
|
rescue ActiveRecord::TableNotSpecified
|
|
38
38
|
nil
|
|
39
|
+
rescue => e
|
|
40
|
+
puts "Failed to process #{model.name}: #{e.inspect}"
|
|
41
|
+
puts "\e[31mWe're sorry, Failed to process \e[33m#{model.name}\e[31m:\n #{e.inspect}\e[0m"
|
|
39
42
|
end
|
|
40
43
|
|
|
41
44
|
schema
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: schema_doctor
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- lni_T
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-07-
|
|
11
|
+
date: 2024-07-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activerecord
|