database_documenter 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 176767166531dfb4e16ceca14a8886ce1880af20b9483c4c66dac658beddebb0
-  data.tar.gz: 36b02826a64e616f15cc3e0080419ec34f06d4fbc2e679f5dfa9601dfb203562
+  metadata.gz: 56031ec9b99ec64b5212f3eada1f4b576d36f36ec3967fd270a3c80b2714d32a
+  data.tar.gz: b0054f9a664ef63947afa1f3ea1545721369463812334d9e497424bfbe0b9334
 SHA512:
-  metadata.gz: bf6a6e03968e2533da87d7754403066d40fe16ad88b200440d4bc06a4c6a356b03851f17d099ab455f401cfb623532e78814e4baab9426e7805abee2c23c5953
-  data.tar.gz: 18bff132a9f9556078e070ee58d8cb170e8fc7ea5b3dfce5e33f75a09300b0248f2c5679fcdce2e4e3d709130529f625b1d1a8342a386bd6fcd1640db7988b0b
+  metadata.gz: 564ccee8d6051584a010bb03897e432809d972bae8f6ad1bf8cfe850e6002a46072b7bfa35cfcdd93cf529ef77ff8c6739b131b085a3f4a630684ee3efbd14fd
+  data.tar.gz: 0704b340ecc3c62bcb39609b3216bbbba7a523eb0b25b05253037d77166c327dcc8059fb921620ede41ba496e6e4740863f4c9b0ab265261bb8a6381a98388aa

data/.gitignore

@@ -10,3 +10,6 @@
 # rspec failure tracking
 .rspec_status
 database_documenter-*.gem
+
+# RubyMine Configs
+.idea/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    database_documenter (0.1.8)
+    database_documenter (0.1.9)
       caracal (= 1.4.1)
 
 GEM

data/README.md

@@ -4,7 +4,7 @@ Welcome to Database Documenter gem! We created this gem to generate database doc
 
 ## Features
 
-1. Generate database documentation as a Word document.
+1. Generate database documentation as a `Word document` or `Markdown file`.
 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.
@@ -39,10 +39,18 @@ end
 
 ## Usage
 
-in the application folder run this rake task and then you will found word document named `database.docx` in your application folder:
+### To Generate the Word document
+
+In the application directory run this rake task and then you will find a word document named `database.docx` in your application directory:
 
     $ bundle exec rake generate_db_document
 
+### To Generate the Markdown file
+
+Run the following rake task and then you will find a markdown file named `database.md` in your application directory:
+
+    $ bundle exec rake generate_db_md_document
+
 ## Override generated description
 You can override it by adding comment to your schema using one of the following options:
 
@@ -63,3 +71,4 @@ use `change_column_comment` and `change_table_comment` methods in rails 5
 
 - Generate the ERD with the file.
 - Add test cases.
+- Update `DatabaseDocumenter::TableDat`a to return the `sql_code` as a `String`.

data/lib/database_documenter.rb

@@ -7,7 +7,9 @@ require 'database_documenter/database_comment/postgres_database_comment'
 require 'database_documenter/tables_sql'
 require 'database_documenter/column_description'
 require 'database_documenter/table_data'
+require 'database_documenter/exporters/base_exporter'
 require 'database_documenter/exporters/export_to_word'
+require 'database_documenter/exporters/export_to_md'
 require 'caracal'
 require "database_documenter/railtie" if defined?(Rails)
 

data/lib/database_documenter/exporters/base_exporter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DatabaseDocumenter::Exporters
+  class BaseExporter
+    attr_accessor :table_data, :printed_tables, :generated_cols_count, :commented_cols_count
+
+    APP_NAME = ENV['APP_NAME'].capitalize
+    HEADER_SECOND_LINE = "The database design specifies how the data of the software is going to be stored."
+
+    def initialize
+      self.table_data = DatabaseDocumenter::TableData.new
+      self.printed_tables = []
+      self.generated_cols_count = 0
+      self.commented_cols_count = 0
+    end
+
+    def load_all_models
+      Rails.application.eager_load!
+    end
+
+    # Skip STI classes
+    # Skip duplicate tables in case of has_and_belongs_to_many
+    # Skip certain modules
+    def skip_class?(klass)
+      (klass.class_name != klass.base_class.class_name) || klass.abstract_class? ||
+        (printed_tables.include? klass.table_name) || (DatabaseDocumenter.configuration.skipped_modules.include? klass.parent.name)
+    end
+  end
+end

data/lib/database_documenter/exporters/export_to_md.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module DatabaseDocumenter::Exporters
+  class ExportToMd < BaseExporter
+    def call
+      load_all_models
+      generate_md_document
+    end
+
+    def generate_md_document
+      md_file_header = StringIO.new
+      md_file_body = StringIO.new
+      md_file = File.open("database.md", "w")
+
+      generate_md_file_header(md_file_header)
+
+      ActiveRecord::Base.descendants.each do |klass|
+        next if skip_class?(klass)
+
+        generate_table_metadata(md_file_header, md_file_body, klass)
+        generate_table_columns(md_file_body, klass)
+      end
+      md_file.puts md_file_header.string
+      md_file.puts md_file_body.string
+      md_file.close
+    end
+
+    def generate_md_file_header(md_file_header)
+      md_file_header << "# #{APP_NAME} Database Design\n"
+      md_file_header << "#{HEADER_SECOND_LINE}\n"
+      md_file_header << "# Tables \n"
+    end
+
+    def generate_table_metadata(md_file_header, md_file_body, klass)
+      metadata = table_data.get_meta_data(klass)
+
+      md_file_header << "- [#{klass.table_name}](##{klass.table_name})\n"
+
+      md_file_body << "\n"
+      md_file_body << "## #{klass.table_name}\n"
+      md_file_body << "### Table details\n"
+      md_file_body << "|Key|Value|\n"
+      md_file_body << "|---|---|\n"
+      md_file_body << "|Table Name|#{metadata[:name]}|\n"
+      md_file_body << "|Description|#{metadata[:description]}|\n"
+      md_file_body << "|Primary Key|#{metadata[:primary_key]}|\n"
+
+      md_file_body << "\n"
+
+      # TODO: Update DatabaseDocumenter::TableData to return this value as a String
+      # And let every Exporter renders it according to the required format
+      sql_code = metadata[:sql_code].contents.map(&:runs).map(&:first).map(&:text_content).join("\n")
+      md_file_body << "### Table SQL Code\n"
+      md_file_body << "```SQL\n"
+      md_file_body << "#{sql_code}\n"
+      md_file_body << "```\n"
+    end
+
+    def generate_table_columns(md_file_body, klass)
+      columns_data = table_data.get_columns_data(klass)
+
+      md_file_body << "### Table attributes\n"
+      md_file_body << "|Attribute|Description|Type|Example of values|\n"
+      md_file_body << "|---|---|---|---|\n"
+
+      columns_data.each do |col|
+        description = StringIO.new
+        col[:description].each do |column_description|
+          description << "- #{column_description}\n"
+        end
+        md_file_body.puts "|#{col[:name]}|#{col[:description][0]}|#{col[:type]}|#{col[:value]}|\n"
+      end
+      md_file_body.puts "\n"
+    end
+  end
+end

data/lib/database_documenter/exporters/export_to_word.rb

@@ -1,34 +1,18 @@
 # frozen_string_literal: true
 
 module DatabaseDocumenter::Exporters
-  class ExportToWord
-    attr_accessor :table_data, :printed_tables, :generated_cols_count, :commented_cols_count
-
-    def initialize
-      self.table_data = DatabaseDocumenter::TableData.new
-      self.printed_tables = []
-      self.generated_cols_count = 0
-      self.commented_cols_count = 0
-    end
-
+  class ExportToWord < BaseExporter
     def call
       load_all_models
       generate_word_document
     end
 
-    def load_all_models
-      Rails.application.eager_load!
-    end
-
     def generate_word_document
       Caracal::Document.save 'database.docx' do |docx|
         add_word_header(docx)
         add_word_footer(docx)
 
         ActiveRecord::Base.descendants.each do |klass|
-          # Skip STI classes
-          # Skip duplicate tables in case of has_and_belongs_to_many
-          # Skip certain modules
           next if skip_class?(klass)
 
           printed_tables << klass.table_name
@@ -51,8 +35,8 @@ module DatabaseDocumenter::Exporters
     end
 
     def add_word_header(docx)
-      docx.h1 "Database Design"
-      docx.p "The database design specifies how the data of the software is going to be stored."
+      docx.h1 "#{APP_NAME} Database Design"
+      docx.p HEADER_SECOND_LINE
     end
 
     def skip_class?(klass)

data/lib/database_documenter/railtie.rb

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

data/lib/database_documenter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseDocumenter
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/lib/tasks/generate_db_md_document.rake

@@ -0,0 +1,6 @@
+require "bundler/setup"
+require "database_documenter"
+
+task generate_db_md_document: :environment do
+  DatabaseDocumenter::Exporters::ExportToMd.new.call
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_documenter
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Ahmed Yehia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,12 +134,15 @@ files:
 - 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/exporters/base_exporter.rb
+- lib/database_documenter/exporters/export_to_md.rb
 - lib/database_documenter/exporters/export_to_word.rb
 - lib/database_documenter/railtie.rb
 - lib/database_documenter/table_data.rb
 - lib/database_documenter/tables_sql.rb
 - lib/database_documenter/version.rb
 - lib/tasks/generate_db_document.rake
+- lib/tasks/generate_db_md_document.rake
 - lib/tasks/generate_dd_initializer.rake
 - lib/tasks/templates/database_documenter.rb
 homepage: https://github.com/espace/db_documenter