database_documenter 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79f3c7ce476383f98904cc065f592a2bfc522507b0bb5e9777b98429f206fde1
+  data.tar.gz: 52c6cebb47928cb00fc4a1e7f94aa6b807709970e78b3cb38529a7eff34e896c
+SHA512:
+  metadata.gz: 70679fc84a3e1e0b9e143c0f642d78ed6541cb899e07d7329db83399e5e93788eab57e6dda6b32a8e5236132ff31caeed17545a9c2554ff5f9b200ab85adacf8
+  data.tar.gz: 3fd5a31dd095a61c12c40c3c701bb683f47be404e18d6018308d3dbc956b3bff65caafd68193479ecd73bf5371d32487de2d2f4ef46f6df09ae739f1830b45de

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+database_documenter-*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in database_documenter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    database_documenter (0.1.5)
+      caracal (= 1.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    caracal (1.4.1)
+      nokogiri (~> 1.6)
+      rubyzip (~> 1.1)
+      tilt (>= 1.4)
+    diff-lcs (1.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubyzip (1.2.3)
+    tilt (2.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  database_documenter!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,61 @@
+# DatabaseDocumenter
+
+Welcome to Database Documenter gem! We created this gem to generate database documentation for rails applications.
+
+## Features
+
+1. Generate database documentation as a Word document.
+2. Generate Description for columns based on it is type and name, Also handle Enums and STI and AASM.
+3. Easy to change the generated description by adding a comment on your database.
+4. Hide sample values of desired columns using configuration.
+5. You can Ignore models inside certain namespaces.
+6. Works on MySQL and PostgreSQL database.
+
+## Installation
+
+```ruby
+gem 'database_documenter'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Configuration
+
+To generate the gem configuration file run this rake task in the application directory
+
+    $ bundle exec rake generate_dd_initializer
+
+or create the configuration file manually in this path `config/initializers/database_documenter.rb` :
+
+```ruby
+DatabaseDocumenter.configure do |config|
+  config.skipped_modules = %w(NAMESPACE)
+  config.hidden_values_columns = %w(col1 col2)
+  config.footer = "Generated by Company" # Footer beside the pagination
+end
+```
+
+## Usage
+
+in the application folder run this rake task and then you will found word document named `database.docx` in your application folder:
+
+    $ bundle exec rake generate_db_document
+
+## Override generated description
+You can override it by adding comment to your schema using one of the following options:
+
+### Rails 4
+use [migration comments](https://github.com/pinnymz/migration_comments) gem or [pg_comment](https://github.com/albertosaurus/pg_comment)
+
+### Rails 5.2
+use `change_column_comment` and `change_table_comment` methods in rails 5
+
+## TODO
+
+- Add more Configurations.
+- Add OverCommit
+- Generate the ERD with the file.
+- Clean code.
+- Add test cases.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "database_documenter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/database_documenter.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "database_documenter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_documenter"
+  spec.version       = DatabaseDocumenter::VERSION
+  spec.authors       = ["Ahmed Yehia"]
+  spec.email         = ["ruby@espace.com.eg"]
+  spec.homepage    = "https://github.com/espace/db_documenter"
+
+  spec.summary       = %q{Generate Database Documentation as a word document}
+  spec.description   = %q{Generate Database Documentation as a word document}
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'caracal', '=1.4.1'
+end

data/lib/database_documenter.rb

@@ -0,0 +1,29 @@
+require 'database_documenter/configuration'
+require "database_documenter/version"
+require 'database_documenter/database_comment'
+require 'database_documenter/database_comment/base_database_comment'
+require 'database_documenter/database_comment/mysql_database_comment'
+require 'database_documenter/database_comment/postgres_database_comment'
+require 'database_documenter/tables_sql'
+require 'database_documenter/column_description'
+require 'caracal'
+require "database_documenter/railtie" if defined?(Rails)
+
+module DatabaseDocumenter
+  class Error < StandardError; end
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/database_documenter/column_description.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+module DatabaseDocumenter::ColumnDescription
+
+  def self.generate(column_name, column_type, klass)
+    klass_name = klass.name.demodulize.titleize
+
+    # handle enums
+    if klass.defined_enums.keys.include?(column_name)
+      return generate_enum_column_description(column_name, column_type, klass_name, klass)
+    end
+
+    # handle assm
+    if klass.respond_to?(:aasm) && klass.aasm.attribute_name.to_s == column_name
+      return generate_assm_column_description(column_name, column_type, klass_name, klass)
+    elsif klass.subclasses.select { |x| x.respond_to?(:aasm) }[0] != nil
+      subklass = klass.subclasses.select { |x| x.respond_to?(:aasm) }[0]
+      if subklass.aasm.attribute_name.to_s == column_name
+        return generate_assm_column_description(column_name, column_type, klass_name, subklass)
+      end
+    end
+
+    # Default
+    if self.respond_to?("generate_#{column_type}_column_description")
+      send("generate_#{column_type}_column_description", column_name, column_type, klass_name)
+    else
+      self.generate_with_default_rules(column_name, column_type, klass_name, klass)
+    end
+  end
+
+  def self.generate_datetime_column_description(column_name, column_type, klass_name)
+    case column_name
+    when 'remember_created_at'
+      "Date when remember me created"
+    when 'reset_password_sent_at'
+      "Date when reset password sent"
+    when 'current_sign_in_at'
+      "Date when the user current signed in"
+    when "last_sign_in_at"
+      "Date when the user last signed in"
+    when 'remember_created_at'
+      "Date when remember token created"
+    when /.*_at/
+      "Date when the row was #{column_name.titlecase.downcase[0..-4]}"
+    else
+      "Date when the row was #{column_name.titlecase.downcase}"
+    end
+  end
+
+  def self.generate_boolean_column_description(column_name, column_type, klass_name)
+    case column_name
+    when /.*active/, /has_.*/, "canceled"
+      "Is #{klass_name.titlecase.downcase} #{column_name.titlecase.downcase}"
+    when /is_.*/
+      column_name.titlecase.downcase
+    else
+      "Is #{klass_name.titlecase.downcase} has #{column_name.titlecase.downcase}"
+    end
+  end
+
+  def self.generate_with_default_rules(column_name, column_type, klass_name, klass)
+    case column_name
+    when 'type'
+      values_hash = Hash[klass.subclasses.collect { |k| [k.name.underscore.humanize, k.name] } ]
+      represent_multi_value_column(column_name, klass_name, values_hash)
+    when /.*_code/
+      refered_table_name = column_name.scan(/(.*)_code/)[0][0]
+      "Code of #{refered_table_name.titleize}".capitalize
+    when /.*_id/
+      refered_table_name = column_name.scan(/(.*)_id/)[0][0]
+      "Id of #{refered_table_name.titleize}".capitalize
+    when /.*_type/
+      refered_table_name = column_name.scan(/(.*)_type/)[0][0]
+      "Type of #{refered_table_name.titleize}".capitalize
+    when /.*_count/
+      refered_table_name = column_name.scan(/(.*)_count/)[0][0]
+      "Count of #{refered_table_name.titleize}".capitalize
+    else
+      "#{column_name.titlecase.downcase} of #{klass_name.titleize}".capitalize
+    end
+  end
+
+  def self.generate_enum_column_description(column_name, column_type, klass_name, klass)
+    values_hash = klass.defined_enums[column_name]
+    represent_multi_value_column(column_name, klass_name, values_hash)
+  end
+
+  def self.generate_assm_column_description(column_name, column_type, klass_name, klass)
+    values_hash = Hash[klass.aasm.states.collect { |k| [k.name.to_s.humanize, k.name.to_s] } ]
+    represent_multi_value_column(column_name, klass_name, values_hash)
+  end
+
+  def self.represent_multi_value_column(column_name, klass_name, values_hash)
+    broken_cell_para = Caracal::Core::Models::TableCellModel.new do |c|
+      c.p "#{column_name.titlecase.downcase} of #{klass_name.titleize}, possible values:"
+      values_hash.each do |k,v|
+        if k == values_hash.keys.last
+          c.p "[#{v}] => #{k}."
+        else
+          c.p "[#{v}] => #{k},"
+        end
+      end
+    end
+     broken_cell_para
+  end
+end

data/lib/database_documenter/configuration.rb

@@ -0,0 +1,12 @@
+module DatabaseDocumenter
+  class Configuration
+    attr_accessor :skipped_modules, :hidden_values_columns, :database_configuration, :footer
+
+    def initialize
+      @skipped_modules = []
+      @hidden_values_columns = ['encrypted_password', 'current_sign_in_ip', 'remote_address', 'last_sign_in_ip']
+      @database_configuration = Rails.application.config.database_configuration[Rails.env]
+      @footer = ''
+    end
+  end
+end

data/lib/database_documenter/database_comment.rb

@@ -0,0 +1,15 @@
+module DatabaseDocumenter
+  module DatabaseComment
+    def self.get_comment_class(adapter = get_current_adapter)
+      if  adapter == "postgresql"
+        DatabaseDocumenter::DatabaseComment::PostgresDatabaseComment
+      else
+        DatabaseDocumenter::DatabaseComment::MysqlDatabaseComment
+      end
+    end
+
+    def self.get_current_adapter
+      DatabaseDocumenter.configuration.database_configuration['adapter']
+    end
+  end
+end

data/lib/database_documenter/database_comment/base_database_comment.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# A base class for reading column database comments
+  class DatabaseDocumenter::DatabaseComment::BaseDatabaseComment
+
+    def self.read_columns_comment(table_name)
+      raise NotImplementedError
+    end
+
+    def self.read_table_comment(table_name)
+      raise NotImplementedError
+    end
+
+    def self.database_name
+    	Rails.application.config.database_configuration[Rails.env]['database'].freeze
+    end
+  end

data/lib/database_documenter/database_comment/mysql_database_comment.rb

@@ -0,0 +1,28 @@
+module DatabaseDocumenter
+  class DatabaseComment::MysqlDatabaseComment < DatabaseComment::BaseDatabaseComment
+
+    def self.read_columns_comment(table_name)
+
+      select_comment = <<-SQL
+        SELECT `column_name`, `column_comment`
+        FROM `information_schema`.`COLUMNS`
+        WHERE `table_name` = '#{table_name}'
+        AND `table_schema` = '#{database_name}'
+        AND `column_comment` != '';
+      SQL
+
+      ActiveRecord::Base.connection.execute(select_comment).to_h
+    end
+
+    def self.read_table_comment(table_name)
+      select_comment = <<-SQL
+        SELECT `TABLE_COMMENT`
+        FROM `information_schema`.`TABLES`
+        WHERE `TABLE_NAME` = '#{table_name}'
+        AND `table_schema` = '#{database_name}';
+      SQL
+
+      ActiveRecord::Base.connection.execute(select_comment).to_a.try('[]', 0).try('[]', 0)
+    end
+  end
+end

data/lib/database_documenter/database_comment/postgres_database_comment.rb

@@ -0,0 +1,39 @@
+module DatabaseDocumenter
+  class DatabaseComment::PostgresDatabaseComment < DatabaseComment::BaseDatabaseComment
+
+    def self.read_columns_comment(table_name)
+
+      select_comment = <<-SQL
+        SELECT
+    	    cols.column_name,
+    	    (
+  	        SELECT
+  	            pg_catalog.col_description(c.oid, cols.ordinal_position::int)
+  	        FROM
+  	            pg_catalog.pg_class c
+  	        WHERE
+  	            c.oid = (SELECT ('"' || cols.table_name || '"')::regclass::oid)
+  	            AND c.relname = cols.table_name
+  		    ) AS column_comment
+  			FROM
+  			    information_schema.columns cols
+  			WHERE
+  			    cols.table_catalog    = '#{database_name}'
+  			    AND cols.table_name   = '#{table_name}'
+  			    AND cols.table_schema = 'public';
+      SQL
+
+      columns_comment_hash ={}
+      ActiveRecord::Base.connection.execute(select_comment).map { |c| columns_comment_hash[c['column_name']] = c['column_comment']}
+      columns_comment_hash
+    end
+
+    def self.read_table_comment(table_name)
+      select_comment = <<-SQL
+        select obj_description('public.#{table_name}'::regclass);
+      SQL
+
+      ActiveRecord::Base.connection.execute(select_comment)[0]['obj_description']
+    end
+  end
+end

data/lib/database_documenter/railtie.rb

@@ -0,0 +1,6 @@
+class DatabaseDocumenter::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/generate_db_document.rake'
+    load 'tasks/generate_dd_initializer.rake'
+  end
+end

data/lib/database_documenter/tables_sql.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module DatabaseDocumenter::TablesSql
+
+  def self.generate
+
+    configuration = DatabaseDocumenter.configuration.database_configuration
+
+    tables_sql = generate_sql_file(configuration)
+
+    self.send("process_#{configuration['adapter']}_sql", tables_sql)
+  end
+
+  def self.generate_sql_file(configuration)
+    ActiveRecord::Tasks::DatabaseTasks.structure_dump(configuration, 'database.sql')
+    tables_sql = IO.read('database.sql')
+    File.delete('database.sql')
+    tables_sql
+  end
+
+  def self.process_postgresql_sql(tables_sql)
+    tables_sql_hash = {}
+    tables_sql = tables_sql.split('--').select { |line| line.match(/CREATE TABLE/)}
+
+    tables_sql.each do |sql_statement|
+      key = sql_statement.scan(/public.(.*) \(/)[0][0]
+      broken_cell_para = Caracal::Core::Models::TableCellModel.new do |c|
+        sql_statement.strip.squeeze(' ').split("\n").each do |p|
+          c.p p
+        end
+      end
+      tables_sql_hash[key] = broken_cell_para
+
+    end
+
+    tables_sql_hash
+  end
+
+  def self.process_mysql2_sql(tables_sql)
+    tables_sql_hash = {}
+    tables_sql = tables_sql.split(';').select { |line| line.match(/CREATE/)}
+
+    tables_sql.each do |sql_statement|
+      key = sql_statement.scan(/`(.*)`/)[0][0]
+      broken_cell_para = Caracal::Core::Models::TableCellModel.new do |c|
+        sql_statement[1..-1].squeeze(' ').split("\n").each do |p|
+          c.p p
+        end
+      end
+      tables_sql_hash[key] = broken_cell_para
+
+    end
+
+    tables_sql_hash
+  end
+end

data/lib/database_documenter/version.rb

@@ -0,0 +1,3 @@
+module DatabaseDocumenter
+  VERSION = "0.1.6"
+end

data/lib/tasks/generate_db_document.rake

@@ -0,0 +1,96 @@
+require "bundler/setup"
+require "database_documenter"
+
+task generate_db_document: :environment do
+  Rails.application.eager_load!
+
+  tables_sql = DatabaseDocumenter::TablesSql.generate
+
+  Caracal::Document.save 'database.docx' do |docx|
+    database_comment_class = DatabaseDocumenter::DatabaseComment.get_comment_class
+
+    docx.page_numbers true do
+      align 'center'
+      label "#{DatabaseDocumenter.configuration.footer}"
+    end
+
+    docx.h1 "Database Design"
+    docx.p "The database design specifies how the data of the software is going to be stored."
+
+    printed_tables = []
+    generated_col_description = 0
+    col_description_from_comments = 0
+    ActiveRecord::Base.descendants.each do |klass|
+      next if (klass.class_name != klass.base_class.class_name) || klass.abstract_class? || klass == ActiveAdmin::Comment # Ignore STI classes
+
+      next if printed_tables.include? klass.table_name # Skip duplicate tables in case of has_and_belongs_to_many
+
+      next if DatabaseDocumenter.configuration.skipped_modules.include? klass.parent.name
+
+      printed_tables << klass.table_name
+
+      table_comment = database_comment_class.read_table_comment(klass.table_name)
+
+      docx.p ''
+      docx.h2 "#{klass.table_name} schema"
+      docx.hr
+
+      table_name = ["Table Name", klass.table_name]
+      description = ["Description", (table_comment.nil? || table_comment.empty?) ? "A collection of data related to #{klass.table_name.titleize}" : table_comment ]
+      primary_key = ["Primary Key", klass.primary_key]
+      sql_code = ["SQL Code", tables_sql[klass.table_name]]
+
+      docx.table [table_name, description, primary_key, sql_code], border_size: 4 do
+        cell_style rows[0][0], background: 'b4b4b4', bold: true, width: 2000
+        cell_style rows[1][0], background: 'e0e0e0', bold: true, width: 2000
+        cell_style rows[2][0], background: 'e0e0e0', bold: true, width: 2000
+        cell_style rows[3][0], background: 'e0e0e0', bold: true, width: 2000
+      end
+
+      columns_header = ["Attribute", "Description", "Type", "Example of values"]
+      columns = []
+      sample_record = klass.first
+      columns_comments = database_comment_class.read_columns_comment(klass.table_name)
+      klass.columns.each do |col|
+        column_data = [col.name]
+        if columns_comments[col.name].present?
+          col_description_from_comments +=1
+          broken_cell_para = Caracal::Core::Models::TableCellModel.new do |c|
+            columns_comments[col.name].split("<br/>").each do |s|
+              c.p s
+            end
+          end
+          column_data << broken_cell_para
+        else
+          generated_col_description +=1
+          column_data << DatabaseDocumenter::ColumnDescription.generate(col.name, col.type, klass)
+        end
+
+        column_data << col.type
+
+        hidden_values_columns = DatabaseDocumenter.configuration.hidden_values_columns
+
+        if hidden_values_columns.include?(col.name)
+          column_data << 'Data is hidden/removed'
+        elsif sample_record.nil?
+          column_data << ''
+        else
+          if Rails.version.split(".")[0].to_i == 4
+            column_data << sample_record[col.name]
+          else
+            column_data << sample_record.send("#{col.name}_before_type_cast")
+          end
+        end
+
+        columns << column_data
+      end
+      docx.page
+      docx.table [columns_header] + columns, border_size: 4 do
+        cell_style rows[0], background: 'e0e0e0', bold: true
+      end
+      docx.page
+    end
+    puts "Number of columns with generated description #{generated_col_description}"
+    puts "Number of columns with description from comments #{col_description_from_comments}"
+  end
+end

data/lib/tasks/generate_dd_initializer.rake

@@ -0,0 +1,9 @@
+task :generate_dd_initializer do
+  template_path = File.join( File.dirname(__FILE__), 'templates/database_documenter.rb').freeze
+  initializer_path = 'config/initializers/database_documenter.rb'.freeze
+  # Check if the initializer already exists
+  abort("Initializer already exists") if File.file?(initializer_path)
+
+  # Copy the template to the initializers dir
+  FileUtils.cp(template_path, initializer_path)
+end

data/lib/tasks/templates/database_documenter.rb

@@ -0,0 +1,5 @@
+DatabaseDocumenter.configure do |config|
+  config.skipped_modules = %w(NAMESPACE)
+  config.hidden_values_columns = %w(col1 col2)
+  config.footer = "Generated by Company" # Footer beside the pagination
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: database_documenter
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Ahmed Yehia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: caracal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: Generate Database Documentation as a word document
+email:
+- ruby@espace.com.eg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_documenter.gemspec
+- lib/database_documenter.rb
+- lib/database_documenter/column_description.rb
+- lib/database_documenter/configuration.rb
+- lib/database_documenter/database_comment.rb
+- lib/database_documenter/database_comment/base_database_comment.rb
+- lib/database_documenter/database_comment/mysql_database_comment.rb
+- lib/database_documenter/database_comment/postgres_database_comment.rb
+- lib/database_documenter/railtie.rb
+- lib/database_documenter/tables_sql.rb
+- lib/database_documenter/version.rb
+- lib/tasks/generate_db_document.rake
+- lib/tasks/generate_dd_initializer.rake
+- lib/tasks/templates/database_documenter.rb
+homepage: https://github.com/espace/db_documenter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Generate Database Documentation as a word document
+test_files: []