rails_schema_excel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 198d77326308bbe83fe771b6aea1197cd03449c4cefc0eb2e16bf0bff37b1deb
+  data.tar.gz: 0eac34f563ce3083eb1ea004de83851f13f4f8dac9eb487c1665b6a9fd63b023
+SHA512:
+  metadata.gz: 82fbd81d9ad7ca3666bca685bbf93e76968886a36725db6e26d363dd6452a6926119e91861f8ab993c3585617dc5ecf4ecea5a71a3240bca9933ed7b7da02a8d
+  data.tar.gz: 4af3392cddac63eefded135acaeefe8c3661e6daf5e681eeef8c9e5696ac17fc08fc4c5502edb7b4c82e952cfdf803767c9d4bf34a060d89bb5703f956b34f93

data/README.md

@@ -0,0 +1,65 @@
+# RailsSchemaExcel
+
+Export Rails database schema to Excel format with A5:SQL Mk-2 style layout.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_schema_excel'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_schema_excel
+
+## Usage
+
+### Command Line
+
+```bash
+# From Rails root directory (uses db/schema.rb by default)
+rails_schema_excel
+
+# Specify schema file and output
+rails_schema_excel -s db/schema.rb -o output.xlsx
+
+# Show help
+rails_schema_excel -h
+```
+
+### In Ruby Code
+
+```ruby
+require 'rails_schema_excel'
+
+RailsSchemaExcel.export('db/schema.rb', 'schema.xlsx')
+```
+
+## Features
+
+Each table is exported as a separate Excel sheet with A5:SQL Mk-2 format including:
+
+- **テーブル情報** (Table Information)
+- **カラム情報** (Column Information) - name, type, not null, default, comments
+- **インデックス情報** (Index Information)
+- **制約情報** (Constraint Information) - primary keys
+- **外部キー情報** (Foreign Key Information)
+- **外部キー情報(PK側)** (Foreign Key Information - PK side)
+- **トリガー情報** (Trigger Information)
+- **RDBMS固有の情報** (RDBMS Specific Information)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/rails_schema_excel

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails_schema_excel'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: rails_schema_excel [options]"
+  
+  opts.on("-s", "--schema FILE", "Path to schema.rb file (default: db/schema.rb)") do |file|
+    options[:schema] = file
+  end
+  
+  opts.on("-o", "--output FILE", "Output Excel file (default: schema.xlsx)") do |file|
+    options[:output] = file
+  end
+  
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+schema_file = options[:schema] || 'db/schema.rb'
+output_file = options[:output] || 'schema.xlsx'
+
+unless File.exist?(schema_file)
+  puts "Error: #{schema_file} not found"
+  exit 1
+end
+
+puts "Exporting #{schema_file} to #{output_file}..."
+RailsSchemaExcel.export(schema_file, output_file)
+puts "Done! Exported to #{output_file}"

data/lib/rails_schema_excel/exporter.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'caxlsx'
+
+module RailsSchemaExcel
+  class Exporter
+    GREEN = 'FF92D050'
+    
+    def self.export(tables, output_file)
+      Axlsx::Package.new do |p|
+        tables.each do |table_name, table_data|
+          next if table_data[:columns].empty?
+          
+          sheet_name = table_name[0..30]
+          p.workbook.add_worksheet(name: sheet_name) do |sheet|
+            create_a5_format(sheet, table_name, table_data)
+          end
+        end
+        
+        p.serialize(output_file)
+      end
+    end
+    
+    def self.create_a5_format(sheet, table_name, table_data)
+      green_fill = sheet.styles.add_style(bg_color: GREEN, fg_color: '00', b: true, border: Axlsx::STYLE_THIN_BORDER)
+      header_style = sheet.styles.add_style(bg_color: GREEN, fg_color: '00', b: true, border: Axlsx::STYLE_THIN_BORDER, alignment: { horizontal: :center })
+      border_style = sheet.styles.add_style(border: Axlsx::STYLE_THIN_BORDER)
+      bold_style = sheet.styles.add_style(b: true)
+      
+      # テーブル情報
+      sheet.add_row ['テーブル情報'], style: bold_style
+      sheet.merge_cells("A1:F1")
+      
+      [
+        ['システム名', ''],
+        ['サブシステム名', ''],
+        ['スキーマ名', table_name],
+        ['論理テーブル名', ''],
+        ['物理テーブル名', table_name],
+        ['備考', '']
+      ].each do |label, value|
+        sheet.add_row [label, value], style: [green_fill, border_style]
+        sheet.merge_cells("B#{sheet.rows.length}:C#{sheet.rows.length}")
+      end
+      
+      sheet.add_row []
+      
+      # カラム情報
+      sheet.add_row ['カラム情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:F#{sheet.rows.length}")
+      
+      sheet.add_row ['No', '物理名', 'データ型', 'Not Null', 'デフォルト', '備考'], style: header_style
+      
+      table_data[:columns].each_with_index do |col, idx|
+        sheet.add_row [
+          idx + 1,
+          col[:name],
+          col[:type],
+          col[:not_null] ? 'Yes' : '',
+          col[:default],
+          ''
+        ], style: border_style
+      end
+      
+      sheet.add_row []
+      
+      # インデックス情報
+      sheet.add_row ['インデックス情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:F#{sheet.rows.length}")
+      
+      sheet.add_row ['No', 'インデックス名', 'カラムリスト', 'キー', 'ユニーク', '備考'], style: header_style
+      
+      table_data[:indexes].each_with_index do |idx_data, idx|
+        sheet.add_row [
+          idx + 1,
+          "idx_#{idx_data[:columns]}",
+          idx_data[:columns],
+          '',
+          idx_data[:unique] ? 'Yes' : '',
+          ''
+        ], style: border_style
+      end
+      
+      sheet.add_row []
+      
+      # 制約情報
+      sheet.add_row ['制約情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:D#{sheet.rows.length}")
+      
+      sheet.add_row ['No', '制約名', '種類', '制約定義'], style: header_style
+      
+      if table_data[:columns].any? { |col| col[:name] == 'id' }
+        sheet.add_row [1, 'PRIMARY', 'PRIMARY KEY', 'id'], style: border_style
+      end
+      
+      sheet.add_row []
+      
+      # 外部キー情報
+      sheet.add_row ['外部キー情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:E#{sheet.rows.length}")
+      
+      sheet.add_row ['No', '外部キー名', 'カラムリスト', '参照先テーブル名', '参照先カラムリスト'], style: header_style
+      
+      table_data[:foreign_keys].each_with_index do |fk, idx|
+        sheet.add_row [
+          idx + 1,
+          "fk_#{fk[:ref_table]}",
+          "#{fk[:ref_table]}_id",
+          fk[:ref_table],
+          'id'
+        ], style: border_style
+      end
+      
+      sheet.add_row []
+      
+      # 外部キー情報(PK側)
+      sheet.add_row ['外部キー情報(PK側)'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:E#{sheet.rows.length}")
+      
+      sheet.add_row ['No', '外部キー名', 'カラムリスト', '参照元テーブル名', '参照元カラムリスト'], style: header_style
+      sheet.add_row []
+      
+      # トリガー情報
+      sheet.add_row ['トリガー情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:E#{sheet.rows.length}")
+      
+      sheet.add_row ['No', 'トリガー名', 'イベント', 'タイミング', '条件'], style: header_style
+      sheet.add_row []
+      
+      # RDBMS固有の情報
+      sheet.add_row ['RDBMS固有の情報'], style: bold_style
+      sheet.merge_cells("A#{sheet.rows.length}:C#{sheet.rows.length}")
+      
+      sheet.add_row ['No', 'プロパティ名', 'プロパティ値'], style: header_style
+      
+      [
+        ['TABLE_CATALOG', 'def'],
+        ['TABLE_SCHEMA', ''],
+        ['TABLE_NAME', table_name],
+        ['TABLE_TYPE', 'BASE TABLE'],
+        ['ENGINE', 'InnoDB'],
+        ['VERSION', '10'],
+        ['ROW_FORMAT', 'Compact'],
+        ['TABLE_ROWS', ''],
+        ['AVG_ROW_LENGTH', ''],
+        ['DATA_LENGTH', ''],
+        ['MAX_DATA_LENGTH', '']
+      ].each_with_index do |(prop_name, prop_value), idx|
+        sheet.add_row [idx + 1, prop_name, prop_value], style: border_style
+      end
+      
+      # Column widths
+      sheet.column_widths 5, 25, 20, 20, 20, 30
+    end
+  end
+end

data/lib/rails_schema_excel/parser.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RailsSchemaExcel
+  class Parser
+    def self.parse(schema_file)
+      content = File.read(schema_file)
+      tables = {}
+      current_table = nil
+      
+      content.each_line do |line|
+        line.strip!
+        
+        if line =~ /create_table\s+"([^"]+)"/
+          current_table = $1
+          tables[current_table] = { columns: [], indexes: [], foreign_keys: [] }
+          next
+        end
+        
+        if current_table && line.start_with?('t.')
+          if line =~ /t\.(\w+)\s+"([^"]+)"(?:,\s*(.+))?/
+            col_type, col_name, options = $1, $2, $3
+            options ||= ''
+            
+            not_null = options.include?('null: false')
+            default = options[/default:\s*([^,]+)/, 1]&.strip || ''
+            
+            tables[current_table][:columns] << {
+              name: col_name,
+              type: col_type,
+              not_null: not_null,
+              default: default
+            }
+          end
+          
+          if line.include?('t.index')
+            columns = line[/\["([^"]+)"\]/, 1]
+            unique = line.include?('unique: true')
+            
+            tables[current_table][:indexes] << {
+              columns: columns,
+              unique: unique
+            } if columns
+          end
+        end
+        
+        if current_table && line.include?('foreign_key')
+          ref_table = line[/to_table:\s*:(\w+)/, 1]
+          tables[current_table][:foreign_keys] << { ref_table: ref_table } if ref_table
+        end
+        
+        current_table = nil if line == 'end' && current_table
+      end
+      
+      tables
+    end
+  end
+end

data/lib/rails_schema_excel/version.rb

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

data/lib/rails_schema_excel.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "rails_schema_excel/version"
+require_relative "rails_schema_excel/parser"
+require_relative "rails_schema_excel/exporter"
+
+module RailsSchemaExcel
+  class Error < StandardError; end
+  
+  def self.export(schema_file, output_file)
+    tables = Parser.parse(schema_file)
+    Exporter.export(tables, output_file)
+  end
+end

data/sig/rails_schema_excel.rbs

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rails_schema_excel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dang Quang Minh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: caxlsx_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Convert Rails database schema to Excel format with each table as a separate
+  sheet in A5:SQL Mk-2 style
+email:
+- d-minh@ruby-dev.vn
+executables:
+- rails_schema_excel
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- exe/rails_schema_excel
+- lib/rails_schema_excel.rb
+- lib/rails_schema_excel/exporter.rb
+- lib/rails_schema_excel/parser.rb
+- lib/rails_schema_excel/version.rb
+- sig/rails_schema_excel.rbs
+homepage: https://github.com/ojisanchamchi/rails_schema_excel
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ojisanchamchi/rails_schema_excel
+  source_code_uri: https://github.com/ojisanchamchi/rails_schema_excel
+  changelog_uri: https://github.com/ojisanchamchi/rails_schema_excel/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Export Rails schema to Excel with A5:SQL Mk-2 format
+test_files: []