database_documenter 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f3c7ce476383f98904cc065f592a2bfc522507b0bb5e9777b98429f206fde1
-  data.tar.gz: 52c6cebb47928cb00fc4a1e7f94aa6b807709970e78b3cb38529a7eff34e896c
+  metadata.gz: f61327bfc7acbd2f256ae2ad2c93640eb981e01a88a5fb215ed0da8eee35049b
+  data.tar.gz: 510687dda8d4aefa92660a767687ed19e91dc31379218f1dc91ed63348cbdc8e
 SHA512:
-  metadata.gz: 70679fc84a3e1e0b9e143c0f642d78ed6541cb899e07d7329db83399e5e93788eab57e6dda6b32a8e5236132ff31caeed17545a9c2554ff5f9b200ab85adacf8
-  data.tar.gz: 3fd5a31dd095a61c12c40c3c701bb683f47be404e18d6018308d3dbc956b3bff65caafd68193479ecd73bf5371d32487de2d2f4ef46f6df09ae739f1830b45de
+  metadata.gz: '0269e91c7cac255801c79ddcee20863da8d0b3c1c44ec197b97031dc97dccec92ee09bd9d2dd35e021e8b2fbe5a4d7abf50755e19ad2a37561ab3dd552a8afa7'
+  data.tar.gz: e66e7ccef12797577dd78bcd4b53cb17988fd15baddd3627cf17da9bc53d8d44f1f864e3d461c2553c10c82190ca47eb7c231b06a07fe860ed35b36a6cc2cf0b

data/.overcommit.yml

@@ -0,0 +1,37 @@
+gemfile: Gemfile
+
+PreCommit:
+  BundleCheck:
+    enabled: true
+
+  FixMe:
+    enabled: true
+    keywords: ["FIXME"]
+    exclude:
+      - .overcommit.yml
+
+  LocalPathsInGemfile:
+    enabled: true
+
+  RailsSchemaUpToDate:
+    enabled: false
+
+  RuboCop:
+    enabled: true
+    on_warn: fail
+
+  TrailingWhitespace:
+    enabled: true
+    exclude:
+      - "**/db/structure.sql"
+
+  YamlSyntax:
+    enabled: true
+
+  HardTabs:
+    enabled: true
+
+PrePush:
+  RSpec:
+    enabled: true
+    command: ['xvfb-run', '-a', 'bundle', 'exec', 'rspec']

data/.rubocop.yml

@@ -0,0 +1,84 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - "bin/*"
+    - Gemfile
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - "spec/**/*"
+
+Metrics/LineLength:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: optional
+
+Naming/VariableNumber:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Exclude:
+    - "db/migrate/**"
+
+Rails/RefuteMethods:
+  Enabled: false
+
+Rails/Validation:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/RescueStandardError:
+  Enabled: false
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false

data/Gemfile.lock

@@ -1,20 +1,38 @@
 PATH
   remote: .
   specs:
-    database_documenter (0.1.5)
+    database_documenter (0.1.7)
       caracal (= 1.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     caracal (1.4.1)
       nokogiri (~> 1.6)
       rubyzip (~> 1.1)
       tilt (>= 1.4)
+    childprocess (1.0.1)
+      rake (< 13.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
+    iniparse (1.4.4)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
     mini_portile2 (2.4.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
+    overcommit (0.49.0)
+      childprocess (>= 0.6.3, < 2.0)
+      iniparse (~> 1.4)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -29,8 +47,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.1)
     rubyzip (1.2.3)
     tilt (2.0.9)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -38,8 +66,11 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   database_documenter!
+  overcommit (= 0.49.0)
+  pry (~> 0.12.2)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (= 0.58.2)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -52,10 +52,14 @@ use [migration comments](https://github.com/pinnymz/migration_comments) gem or [
 ### Rails 5.2
 use `change_column_comment` and `change_table_comment` methods in rails 5
 
+## Contribution
+
+- Fork & create a branch
+- bundle install
+- Make sure to run `overcommit --install` before working to run RuboCop before push.
+- Create Pull Request.
+
 ## TODO
 
-- Add more Configurations.
-- Add OverCommit
 - Generate the ERD with the file.
-- Clean code.
 - Add test cases.

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/database_documenter.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "database_documenter/version"
 
@@ -8,14 +7,14 @@ Gem::Specification.new do |spec|
   spec.version       = DatabaseDocumenter::VERSION
   spec.authors       = ["Ahmed Yehia"]
   spec.email         = ["ruby@espace.com.eg"]
-  spec.homepage    = "https://github.com/espace/db_documenter"
+  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}
+  spec.summary       = 'Generate Database Documentation as a word document'
+  spec.description   = '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
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -23,7 +22,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "overcommit", "=0.49.0"
+  spec.add_development_dependency 'pry', '~> 0.12.2'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "=0.58.2"
+
   spec.add_dependency 'caracal', '=1.4.1'
 end

data/lib/database_documenter.rb

@@ -6,13 +6,15 @@ 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 'database_documenter/table_data'
+require 'database_documenter/exporters/export_to_word'
 require 'caracal'
 require "database_documenter/railtie" if defined?(Rails)
 
 module DatabaseDocumenter
   class Error < StandardError; end
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
   end
 
   def self.configuration

data/lib/database_documenter/column_description.rb

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
-module DatabaseDocumenter::ColumnDescription
 
+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 enums
+    return generate_enum_column_description(column_name, column_type, klass_name, klass) if klass.defined_enums.key?(column_name)
 
-    # 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
+    # Handle assm
+    return generate_assm_column_description(column_name, column_type, klass_name, klass) if klass.respond_to?(:aasm) && klass.aasm.attribute_name.to_s == column_name
+
+    unless 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
+      return generate_assm_column_description(column_name, column_type, klass_name, subklass) if subklass.aasm.attribute_name.to_s == column_name
     end
 
     # Default
-    if self.respond_to?("generate_#{column_type}_column_description")
+    generate_default_column_descrription(column_name, column_type, klass_name, klass)
+  end
+
+  def self.generate_default_column_descrription(column_name, column_type, klass_name, klass)
+    if 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)
+      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)
+  def self.handle_enums(column_name, column_type, klass_name, klass)
+    generate_enum_column_description(column_name, column_type, klass_name, klass)
+  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'
@@ -46,7 +48,7 @@ module DatabaseDocumenter::ColumnDescription
     end
   end
 
-  def self.generate_boolean_column_description(column_name, column_type, klass_name)
+  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}"
@@ -57,10 +59,10 @@ module DatabaseDocumenter::ColumnDescription
     end
   end
 
-  def self.generate_with_default_rules(column_name, column_type, klass_name, klass)
+  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] } ]
+      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]
@@ -79,27 +81,25 @@ module DatabaseDocumenter::ColumnDescription
     end
   end
 
-  def self.generate_enum_column_description(column_name, column_type, klass_name, klass)
+  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] } ]
+  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
+    description = ["#{column_name.titlecase.downcase} of #{klass_name.titleize}, possible values:"]
+    values_hash.each do |k, v|
+      description <<  if k == values_hash.keys.last
+                        "[#{v}] => #{k}."
+                      else
+                        "[#{v}] => #{k},"
+                      end
     end
-     broken_cell_para
+    description
   end
 end

data/lib/database_documenter/configuration.rb

@@ -4,7 +4,7 @@ module DatabaseDocumenter
 
     def initialize
       @skipped_modules = []
-      @hidden_values_columns = ['encrypted_password', 'current_sign_in_ip', 'remote_address', 'last_sign_in_ip']
+      @hidden_values_columns = %w[encrypted_password current_sign_in_ip remote_address last_sign_in_ip]
       @database_configuration = Rails.application.config.database_configuration[Rails.env]
       @footer = ''
     end

data/lib/database_documenter/database_comment.rb

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

data/lib/database_documenter/database_comment/base_database_comment.rb

@@ -1,16 +1,17 @@
 # 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
+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.read_table_comment(_table_name)
+    raise NotImplementedError
+  end
 
-    def self.database_name
-    	Rails.application.config.database_configuration[Rails.env]['database'].freeze
-    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

@@ -1,8 +1,6 @@
 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`

data/lib/database_documenter/database_comment/postgres_database_comment.rb

@@ -1,30 +1,28 @@
 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';
+          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 = {}
+      ActiveRecord::Base.connection.execute(select_comment).map { |c| columns_comment_hash[c['column_name']] = c['column_comment'] }
       columns_comment_hash
     end
 

data/lib/database_documenter/exporters/export_to_word.rb

@@ -0,0 +1,115 @@
+# 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
+
+    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
+
+          generate_table_metadata(docx, klass)
+          generate_table_columns(docx, klass)
+
+          docx.page
+        end
+      end
+      Rails.logger.info "Number of columns with generated description #{generated_cols_count}"
+      Rails.logger.info "Number of columns with description from comments #{commented_cols_count}"
+    end
+
+    def add_word_footer(docx)
+      docx.page_numbers true do
+        align 'center'
+        label DatabaseDocumenter.configuration.footer.to_s
+      end
+    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."
+    end
+
+    def skip_class?(klass)
+      (klass.class_name != klass.base_class.class_name) || klass.abstract_class? || (klass == ActiveAdmin::Comment) ||
+        (printed_tables.include? klass.table_name) || (DatabaseDocumenter.configuration.skipped_modules.include? klass.parent.name)
+    end
+
+    def generate_table_metadata(docx, klass)
+      metadata = table_data.get_meta_data(klass)
+      docx.p ''
+      docx.h2 "#{klass.table_name} schema"
+      docx.hr
+
+      word_table = [
+        ["Table Name", metadata[:name]],
+        ["Description", metadata[:description]],
+        ["Primary Key", metadata[:primary_key]],
+        ["SQL Code", metadata[:sql_code]]
+      ]
+
+      docx.table word_table, 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
+    end
+
+    def generate_table_columns(docx, klass)
+      columns_header = ["Attribute", "Description", "Type", "Example of values"]
+      columns = []
+
+      columns_data = table_data.get_columns_data(klass)
+
+      columns_data.each do |col|
+        data = [col[:name]]
+        if col[:description_generated]
+          self.generated_cols_count += 1
+        else
+          self.commented_cols_count += 1
+        end
+
+        broken_cell_para = Caracal::Core::Models::TableCellModel.new do |c|
+          col[:description].flatten.each do |s|
+            c.p s
+          end
+        end
+
+        data << broken_cell_para
+        data << col[:type]
+        data << col[:value]
+        columns << data
+      end
+      docx.page
+      docx.table [columns_header] + columns, border_size: 4 do
+        cell_style rows[0], background: 'e0e0e0', bold: true
+      end
+    end
+  end
+end

data/lib/database_documenter/table_data.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class DatabaseDocumenter::TableData
+  attr_accessor :tables_sql, :database_comment_class
+
+  def initialize
+    self.database_comment_class = DatabaseDocumenter::DatabaseComment.get_comment_class
+    load_tables_sql_data
+  end
+
+  def load_tables_sql_data
+    self.tables_sql = DatabaseDocumenter::TablesSql.generate
+  end
+
+  def get_meta_data(klass)
+    table_comment = database_comment_class.read_table_comment(klass.table_name)
+
+    data = {}
+    data[:name] = klass.table_name
+    data[:description] = table_comment.presence || "A collection of data related to #{klass.table_name.titleize}"
+    data[:primary_key] = klass.primary_key
+    data[:sql_code] = tables_sql[klass.table_name]
+    data
+  end
+
+  def get_columns_data(klass)
+    sample_record = klass.first
+    columns_comments = database_comment_class.read_columns_comment(klass.table_name)
+    columns = []
+    klass.columns.each do |col|
+      column_data = get_column_data(klass, col, sample_record, columns_comments[col.name])
+
+      columns << column_data
+    end
+    columns
+  end
+
+  def get_column_data(klass, col, sample_record, column_comment)
+    column_data = { name: col.name }
+    column_data[:description] = []
+
+    if column_comment.present?
+      column_data[:description_generated] = false
+      column_comment.split("<br/>").each do |s|
+        column_data[:description] << s
+      end
+    else
+      column_data[:description_generated] = true
+      column_data[:description] << DatabaseDocumenter::ColumnDescription.generate(col.name, col.type, klass)
+    end
+
+    column_data[:type] = col.type
+
+    hidden_values_columns = DatabaseDocumenter.configuration.hidden_values_columns
+
+    column_data[:value] = if hidden_values_columns.include?(col.name)
+                            'Data is hidden/removed'
+                          elsif sample_record.nil?
+                            ''
+                          elsif Rails.version.split(".")[0].to_i == 4
+                            sample_record[col.name]
+                          else
+                            sample_record.send("#{col.name}_before_type_cast")
+                          end
+    column_data
+  end
+end

data/lib/database_documenter/tables_sql.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
-module DatabaseDocumenter::TablesSql
 
+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)
+    send("process_#{configuration['adapter']}_sql", tables_sql)
   end
 
   def self.generate_sql_file(configuration)
@@ -19,7 +18,7 @@ module DatabaseDocumenter::TablesSql
 
   def self.process_postgresql_sql(tables_sql)
     tables_sql_hash = {}
-    tables_sql = tables_sql.split('--').select { |line| line.match(/CREATE TABLE/)}
+    tables_sql = tables_sql.split('--').select { |line| line.match(/CREATE TABLE/) }
 
     tables_sql.each do |sql_statement|
       key = sql_statement.scan(/public.(.*) \(/)[0][0]
@@ -29,7 +28,6 @@ module DatabaseDocumenter::TablesSql
         end
       end
       tables_sql_hash[key] = broken_cell_para
-
     end
 
     tables_sql_hash
@@ -37,7 +35,7 @@ module DatabaseDocumenter::TablesSql
 
   def self.process_mysql2_sql(tables_sql)
     tables_sql_hash = {}
-    tables_sql = tables_sql.split(';').select { |line| line.match(/CREATE/)}
+    tables_sql = tables_sql.split(';').select { |line| line.match(/CREATE/) }
 
     tables_sql.each do |sql_statement|
       key = sql_statement.scan(/`(.*)`/)[0][0]
@@ -47,7 +45,6 @@ module DatabaseDocumenter::TablesSql
         end
       end
       tables_sql_hash[key] = broken_cell_para
-
     end
 
     tables_sql_hash

data/lib/database_documenter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DatabaseDocumenter
-  VERSION = "0.1.6"
+  VERSION = '0.1.7'
 end

data/lib/tasks/generate_db_document.rake

@@ -2,95 +2,5 @@ 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
+  DatabaseDocumenter::Exporters::ExportToWord.new.call
 end

data/lib/tasks/generate_dd_initializer.rake

@@ -1,9 +1,9 @@
 task :generate_dd_initializer do
-  template_path = File.join( File.dirname(__FILE__), 'templates/database_documenter.rb').freeze
+  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
+end

data/lib/tasks/templates/database_documenter.rb

@@ -1,5 +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
+  # config.skipped_modules = %w(NAMESPACE)
+  # config.hidden_values_columns = %w(col1 col2)
+  # config.footer = "Generated by Company" # Footer beside the pagination
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_documenter
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ahmed Yehia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: caracal
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +116,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -90,7 +134,9 @@ 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/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