schema_doctor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb30a32516182031828f9be6b2f30a5496d5322ba77f7a4e17aa8655e2ef8596
+  data.tar.gz: 40a59308e3e55209061d7995c393ff45071352ee168af12ea09387edf07fcff2
+SHA512:
+  metadata.gz: f7cd15084b68dd5b4c7993f5346344f01c2de301f2061ee7230267f2bf738a31b93611924a8532807ae25df8524e44f087d305116c988a6ed78d37ca0ebf2fb3
+  data.tar.gz: de186a77d0f1afec160804205a521784919a75f92452558baa8453eebfceebd34cef33fa190519872d4c2a0fdfed0a54f5ebe8bf79c025c0b44a85da45cd9fde

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.X]
+
+- Debug releases

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 @lni_T
+
+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,11 @@
+# SchemaDoctor
+
+TBD
+
+## Installation
+
+TBD
+
+## Usage
+
+TBD

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/schema_doctor/analyzer.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module SchemaDoctor
+  class Analyzer
+    attr_reader :schema_file
+
+    def initialize
+      @schema_file = SchemaFile.new
+    end
+
+    def analyze_schema
+      existing_schema = schema_file.load
+
+      puts "== Analyzing model schema..."
+      new_schema = model_schema(existing_schema || {})
+
+      puts "== Exporting Specification files..."
+      schema_file.dump(new_schema)
+    end
+
+    def model_schema(schema = {})
+      models.each do |model|
+        next if model.table_name.blank?
+
+        puts "Processing #{model.name}..."
+        schema[model.name] =
+          {
+            name: model.name,
+            table_name: model.table_name,
+            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)
+          }
+      rescue ActiveRecord::TableNotSpecified
+        nil
+      end
+
+      schema
+    end
+
+    private
+
+    def connection
+      @connection ||= ActiveRecord::Base.connection
+    end
+
+    def models
+      return @models if @models
+
+      Rails.application.eager_load! if defined?(Rails)
+      @models = ActiveRecord::Base.descendants.sort_by!(&:name)
+    end
+
+    def columns(model, columns = {})
+      model.columns.each do |column|
+        columns[column.name] =
+          {
+            name: column.name,
+            type: column.type,
+            sql_type: column.sql_type,
+            default: column.default,
+            null: column.null,
+            limit: column.limit,
+            precision: column.precision,
+            scale: column.scale,
+            column_comment: column.comment,
+            extra_comment: columns.dig(column.name, :extra_comment)
+          }
+      end
+      columns
+    end
+
+    def indexes(model)
+      connection.indexes(model.table_name).each_with_object({}) do |index, hash|
+        hash[index.name] = {
+          name: index.name,
+          columns: index.columns,
+          unique: index.unique,
+          using: index.using
+        }
+      end
+    end
+  end
+end

data/lib/schema_doctor/exporter.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+
+module SchemaDoctor
+  class Exporter
+    attr_reader :schema_file
+
+    def initialize
+      @schema_file = SchemaFile.new
+    end
+
+    def export_adoc
+      puts "== Loading model specifications..."
+      specs = schema_file.load
+
+      puts "== Exporting adoc file..."
+      # TODO: Use template
+      File.open(adoc_path, "w") do |f|
+        f.puts <<~TEXT
+          = Rails Model Specification
+          :toc: left
+          :toclevels: 1
+          :toc-title: Table of Contents
+          :linkattrs:
+
+        TEXT
+
+        specs.each_value do |model|
+          f.puts <<~TEXT
+            == #{model[:name]}
+            * Table name: #{model[:table_name]}
+            * Comment: #{model[:table_comment]}
+            #{model[:extra_comment]}
+
+            === Columns
+            [cols="1,1,1,1,1,1,1,1,2"]
+            |===
+            |name|type|sql_type|default|null|limit|precision|scale|comment
+
+          TEXT
+
+          # Output columns schema
+          model[:columns].each_value do |column|
+            column[:column_comment] = column[:column_comment].to_s + column.delete(:extra_comment).to_s
+            col_str = column.values.map do |v|
+              escaped = v.to_s.gsub("|", "{vbar}") # "|" is table delimiter in asciidoc
+              "|#{escaped}\n"
+            end.join
+
+            f.puts <<~TEXT
+              #{col_str}
+            TEXT
+          end
+          f.puts "|==="
+
+          # Output indexes schema
+          f.puts <<~TEXT
+
+            === Indexes
+          TEXT
+          if model[:indexes].present?
+            f.puts <<~TEXT
+              [cols="2,2,1,1"]
+              |===
+              |name|columns|unique|using
+
+            TEXT
+
+            model[:indexes].each_value do |index|
+              index_str = index.values.map do |v|
+                escaped = v.to_s.gsub("|", "{vbar}") # "|" is table delimiter in asciidoc
+                "|#{escaped}\n"
+              end.join
+
+              f.puts <<~TEXT
+                #{index_str}
+              TEXT
+            end
+
+            f.puts "|==="
+          else
+            f.puts <<~TEXT
+              None
+
+            TEXT
+          end
+        end
+      end
+      puts "Done! => #{adoc_path}"
+    end
+
+    def convert_adoc_to_html
+      puts "== Converting to html..."
+      Asciidoctor.convert_file adoc_path, to_file: html_path, standalone: true, safe: :server
+      puts "Done! => #{html_path}"
+    end
+
+    private
+
+    def export_dir
+      "docs/models" # TODO: Configurable
+    end
+
+    def adoc_path
+      "#{export_dir}/models.adoc" # TODO: Configurable
+    end
+
+    def html_path
+      "#{export_dir}/index.html" # TODO: Configurable
+    end
+  end
+end

data/lib/schema_doctor/railtie.rb

@@ -0,0 +1,7 @@
+module SchemaDoctor
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "tasks/schemadoc.rake")
+    end
+  end
+end

data/lib/schema_doctor/schema_file.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module SchemaDoctor
+  class SchemaFile
+    def load
+      return unless Dir.exist?(schema_dir)
+
+      # Load schema specification files and merge them into a single hash
+      Dir.glob("#{schema_dir}/*").inject({}) do |hash, file|
+        hash.merge(YAML.load_file(file))
+      end
+    end
+
+    def dump(specs)
+      # Output specification files for each model
+      FileUtils.mkdir_p(schema_dir)
+      specs.each do |name, spec|
+        File.open("#{schema_dir}/#{name}.yml", "w") do |f|
+          YAML.dump({name => spec}, f)
+        end
+      end
+    end
+
+    def delete
+      FileUtils.rm_rf(schema_dir)
+    end
+
+    private
+
+    def export_dir
+      "docs/models" # TODO: Configurable
+    end
+
+    def schema_dir
+      "#{export_dir}/specs" # TODO: Configurable
+    end
+  end
+end

data/lib/schema_doctor/tasks/schemadoc.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :schema do
+  desc "Analyze schema and Export yml files"
+  task analyze: :environment do
+    SchemaDoctor::Analyzer.new.analyze_schema
+  end
+
+  desc "Export schema documentation"
+  task export: :environment do
+    exporter = SchemaDoctor::Exporter.new
+    exporter.export_adoc
+    exporter.convert_adoc_to_html
+  end
+end

data/lib/schema_doctor/version.rb

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

data/lib/schema_doctor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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/railtie"
+
+module SchemaDoctor
+  class Error < StandardError; end
+end

data/sig/schema_doctor.rbs

@@ -0,0 +1,4 @@
+module SchemaDoctor
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: schema_doctor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lni_T
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- developer.lni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schema_doctor.rb
+- lib/schema_doctor/analyzer.rb
+- lib/schema_doctor/exporter.rb
+- lib/schema_doctor/railtie.rb
+- lib/schema_doctor/schema_file.rb
+- lib/schema_doctor/tasks/schemadoc.rake
+- lib/schema_doctor/version.rb
+- sig/schema_doctor.rbs
+homepage: https://github.com/lnit/schema_doctor
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/lnit/schema_doctor/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Automatic database documentation tool.
+test_files: []