dbdoc 0.1.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a675eef6484bf4c2c6bb78521c9f322ff057804feec72e34061eb899153352
-  data.tar.gz: 5e80744c319d0e2ea77b321704e317467e871e9d93a53ad77871c655106b8f3b
+  metadata.gz: c25899d4d18291f22be12f731230d64669f353e422f63d069791bd030ba3d9a8
+  data.tar.gz: be30d30193572b1b4dcf5141c010e9593e373d90c099f5e41ab40f5a06cf7e40
 SHA512:
-  metadata.gz: b49a2edb0d2e31280b4bd8ed29ef109da6ff38fd6669df30a260f049ad5ad841bea5425d3c68fd9862f8e74116f4cbcb90e767f69e44aeed2c0910429ba13ac1
-  data.tar.gz: 18b09c76bc60de2ffb1a574a9695d03b1be0ba5c40b3bedbeb2d59eaefbd4b431b4a370ea52cb46defb34a388b9a177e2dd6c4496e7a78bdf1c3d7ed0d607a82
+  metadata.gz: ecc79a5cabb4a5cea63e5ae92c9b2c5b331c539590da6464aef4a789c96167a50a9aa876a840186b8e4ac3d29c5db4db6024b0bc5c2183c02bf44037c89cf09b
+  data.tar.gz: d7b19650e610c9a2b0c4b7c26250571f3811f459016740b85925d6e82d56d8c72b7119a2b0c6c14237638b295d832156e7a4ab7784da9748670e290a96a33618

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: makaroni4
+ko_fi: makaroni4

data/.rubocop.yml

@@ -1,2 +1,27 @@
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 50
+
+Style/Documentation:
+  Exclude:
+    - lib/confluence/api.rb
+    - lib/dbdoc/cli.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/dbdoc/cli.rb
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Security/YAMLLoad:
+  Enabled: false

data/Gemfile

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
-gem "httparty"
-
 group :development do
   gem "byebug"
   gem "coveralls", require: false
-  gem "rubocop"
   gem "rake", "~> 12.0"
   gem "rspec", "~> 3.0"
+  gem "rubocop"
 end

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    dbdoc (0.1.0)
+    dbdoc (0.3.5)
+      httparty (~> 0.18)
+      kramdown (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +22,8 @@ GEM
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     json (2.3.1)
+    kramdown (2.3.0)
+      rexml
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
@@ -76,7 +80,6 @@ DEPENDENCIES
   byebug
   coveralls
   dbdoc!
-  httparty
   rake (~> 12.0)
   rspec (~> 3.0)
   rubocop

data/README.md

@@ -40,7 +40,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ```
-gem uninstall dbdoc && gem build dbdoc.gemspec && bundle && rake build && rake install && dbdoc help
+Y | gem uninstall dbdoc && gem build dbdoc.gemspec && bundle && rake build && rake install && dbdoc help
+```
+
+```
+Y | gem uninstall dbdoc && gem build dbdoc.gemspec && bundle && rake build && rake release
 ```
 
 ## Contributing

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"

data/bin/dbdoc

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #!/usr/bin/env ruby
 
 require "dbdoc"

data/dbdoc.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/dbdoc/version"
 
 Gem::Specification.new do |spec|
@@ -22,4 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.executables   = ["dbdoc"]
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.18"
+  spec.add_runtime_dependency "kramdown", "~> 2.3"
 end

data/doc_files/columns.md.erb

@@ -1,4 +1,4 @@
-||Name||Type||Description||
+||Name||Type||Foreign Key||Description||
 <%- columns.each do |column| -%>
-|<%= column[:name] %>|<%= column[:type] %>|<%= column[:description].strip %>|
+|<%= column[:name] %>|<%= column[:type] %>|<%= column[:foreign_key] || " " %>|<%= column[:description].strip %>|
 <%- end -%>

data/doc_files/columns.yml.erb

@@ -3,6 +3,7 @@
   - :name: <%= name %>
     :type: <%= type %>
     :position: <%= position %>
+    :foreign_key: TODO
     :description: |
       TODO
   <%- end -%>

data/doc_files/table_description.md

@@ -1 +1,5 @@
-Write table description here
+This is a table description in a normal Markdown.
+
+This is **bold**.
+
+This is *italic*.

data/doc_files/table_example.md

@@ -1,10 +1,8 @@
-h3. Count all users
+### How to count all users
 
 Use this query to count all user records:
 
-(!) This is a warning note.
-
-{code:language=sql}
+~~~sql
 SELECT COUNT(*)
 FROM users
-{code}
+~~~

data/lib/confluence/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "httparty"
 require "json"
 require "yaml"
@@ -18,22 +20,25 @@ module Confluence
     end
 
     def delete_page(page_id:)
-      HTTParty.delete(
+      response = HTTParty.delete(
         "https://dbdoc.atlassian.net/wiki/rest/api/content/#{page_id}", {
           headers: {
             "Authorization" => "Basic #{basic_auth}",
-            "Content-Type"  => "application/json"
+            "Content-Type" => "application/json"
           }
         }
       )
+
+      response.code == 200
     end
 
     def existing_pages
+      # TODO: paginate over all pages in the space
       response = HTTParty.get(
         "https://dbdoc.atlassian.net/wiki/rest/api/content/?&spaceKey=#{@space}", {
           headers: {
             "Authorization" => "Basic #{basic_auth}",
-            "Content-Type"  => "application/json"
+            "Content-Type" => "application/json"
           }
         }
       )
@@ -64,7 +69,7 @@ module Confluence
         "https://dbdoc.atlassian.net/wiki/rest/api/content/#{page_id}", {
           headers: {
             "Authorization" => "Basic #{basic_auth}",
-            "Content-Type"  => "application/json"
+            "Content-Type" => "application/json"
           },
           body: payload.to_json
         }
@@ -112,7 +117,7 @@ module Confluence
         "https://dbdoc.atlassian.net/wiki/rest/api/content/", {
           headers: {
             "Authorization" => "Basic #{basic_auth}",
-            "Content-Type"  => "application/json"
+            "Content-Type" => "application/json"
           },
           body: payload.to_json
         }

data/lib/confluence/markdown_converter.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "kramdown"
+
+module Confluence
+  # By default, all documentation should be written in a normal
+  # Markdown format. Later, when we're generating/uploading final documentation,
+  # we'll use Confluence::MarkdownConverter to convert normal Markdown
+  # into Confluence specific Markdown
+  # https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html
+  class MarkdownConverter
+    CONVERTERS = %w[
+      convert_h1
+      convert_h2
+      convert_h3
+      convert_h4
+      convert_h5
+      convert_bold
+      convert_italic
+      convert_code
+      convert_unordered_list
+    ].freeze
+
+    def convert(original_markdown)
+      return if original_markdown.nil?
+
+      output = original_markdown
+
+      CONVERTERS.each do |converter_method|
+        output = send(converter_method, output)
+      end
+
+      output
+    end
+
+    private
+
+    def convert_h1(markdown)
+      markdown.gsub(/^(#)([^#].+)$/, 'h1.\2')
+    end
+
+    def convert_h2(markdown)
+      markdown.gsub(/^(##)([^\#].+)$/, 'h2.\2')
+    end
+
+    def convert_h3(markdown)
+      markdown.gsub(/^(###)([^\#].+)$/, 'h3.\2')
+    end
+
+    def convert_h4(markdown)
+      markdown.gsub(/^(####)([^\#].+)$/, 'h4.\2')
+    end
+
+    def convert_h5(markdown)
+      markdown.gsub(/^(#####)([^\#].+)$/, 'h5.\2')
+    end
+
+    def convert_bold(markdown)
+      markdown.gsub(/(\*\*)(\w+)(\*\*)/, '*\2*')
+    end
+
+    def convert_italic(markdown)
+      markdown.gsub(/(\*)(\w+)(\*)/, '_\2_')
+    end
+
+    def convert_code(markdown)
+      output_lines = []
+
+      markdown.each_line do |line|
+        if line =~ /^\~{3}\w+$/
+          language = line.gsub("~~~", "").strip
+
+          output_lines.push("{code:language=#{language}}\n")
+        elsif line =~ /^\~{3}$/
+          output_lines.push("{code}")
+        else
+          output_lines.push(line)
+        end
+      end
+
+      output_lines.join
+    end
+
+    def convert_unordered_list(markdown)
+      markdown.gsub(/^\*\s(.+)$/, '- \1')
+    end
+
+    # TODO: add nested list convertion
+    # TODO: add numbered list convertion
+
+    # TODO: add emoji
+    # https://support.atlassian.com/confluence-cloud/docs/use-symbols-emojis-and-special-characters/
+  end
+end

data/lib/{dbdoc → confluence}/uploader.rb

@@ -1,10 +1,22 @@
+# frozen_string_literal: true
+
 require "dbdoc/constants"
+require_relative "../confluence/markdown_converter"
 require_relative "../confluence/api"
 
-module Dbdoc
+module Confluence
+  # Confluence::Uploader class knows how to uploaded
+  # documentation to the Confluence Space provided in the config.yml.
+  #
+  # Uploader creates a root page with the database name from config.yml
+  # and creates nested pages for schemas and tables.
+  #
+  # A Confluence ID of each page created by dbdoc
+  # is logged to pages.yml file stored in the user's folder
+  # with the documentation.
   class Uploader
-    def initialize(config: {})
-      @config = config
+    def initialize(local_path: Dir.pwd)
+      @config = Dbdoc::Config.new(local_path: local_path).load
       @confluence_api = Confluence::Api.new
       @doc_folder = File.join(Dir.pwd, "doc")
     end
@@ -14,24 +26,45 @@ module Dbdoc
       delete_pages_for_dropped_schemas_or_tables
     end
 
+    def space_pages
+      @confluence_api.existing_pages["results"]
+    end
+
+    def print_space_pages
+      space_pages.each do |page|
+        page_title = page["title"]
+        page_id = page["id"]
+
+        puts "#{page_title}: #{page_id}"
+      end
+    end
+
     def clear_confluence_space
-      # TODO paginate and fetch all Confluence pages
-      # TODO ask user to Yn if they want to proceed with deletion
-      # TODO iterate over each page_id, unlog it from page_ids.yml and @confluence_api.delete_page(page_id:)
+      YAML.load(File.read(page_ids_file))
+
+      space_pages.each do |page|
+        page_key = page["title"]
+        page_id = page["id"]
+
+        puts "--> Deleting #{page_key} #{page_id}"
+
+        unlog_page_id(key: page_key) if @confluence_api.delete_page(page_id: page_id)
+      end
     end
 
     private
 
+    # rubocop:disable Metrics/AbcSize
     def delete_pages_for_dropped_schemas_or_tables
       uploaded_pages = YAML.load(File.read(page_ids_file))
 
-      uploaded_pages.each do |key, params|
+      uploaded_pages.each do |key, _params|
         next if key == "root"
 
         if key.start_with?("schema:")
           schema_name = key.gsub("schema:", "")
 
-          unless Dir.exists?(File.join(@doc_folder, schema_name))
+          unless Dir.exist?(File.join(@doc_folder, schema_name))
             page_id = uploaded_pages[key][:page_id]
             puts "--> delete page #{key}: #{page_id}"
             @confluence_api.delete_page(page_id: page_id)
@@ -40,7 +73,7 @@ module Dbdoc
         elsif key.start_with?("table:")
           schema_name, table_name = key.gsub("table:", "").split(".")
 
-          unless Dir.exists?(File.join(@doc_folder, schema_name, table_name))
+          unless Dir.exist?(File.join(@doc_folder, schema_name, table_name))
             page_id = uploaded_pages[key][:page_id]
             puts "--> delete page #{key}: #{page_id}"
             @confluence_api.delete_page(page_id: page_id)
@@ -49,6 +82,7 @@ module Dbdoc
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def create_or_updates_pages
       root_page_id = create_root_db_page[:page_id]
@@ -71,7 +105,7 @@ module Dbdoc
     def page_ids_file
       file = File.join(Dir.pwd, "page_ids.yml")
 
-      unless File.exists?(file)
+      unless File.exist?(file)
         File.open(file, "w") do |f|
           f.puts("--- {}")
         end
@@ -97,7 +131,7 @@ module Dbdoc
         version: 0
       }
 
-      if page_ids[key][:version] == 0
+      if page_ids.dig(key, :version).zero?
         puts "--> create page #{key}: #{page_id}"
       else
         puts "--> update page #{key}: #{page_id}"
@@ -123,9 +157,11 @@ module Dbdoc
     def create_root_db_page
       page_id = latest_page_id(key: "root")
 
-      return {
-        page_id: page_id
-      } if page_id
+      if page_id
+        return {
+          page_id: page_id
+        }
+      end
 
       db_name = @config["db"]["name"]
       @confluence_api.create_page(
@@ -162,37 +198,50 @@ module Dbdoc
       end
     end
 
+    def markdown(input)
+      Confluence::MarkdownConverter.new.convert(input)
+    end
+
+    # rubocop:disable Metrics/AbcSize
     def upload_table(schema_name:, table_name:, schema_page_id:)
       table_folder = File.join(@doc_folder, schema_name, table_name)
 
-      table_description = File.read(File.join(table_folder, "description.md"))
+      table_description = markdown(File.read(File.join(table_folder, "description.md")))
 
       examples_folder = File.join(table_folder, "examples")
-      table_examples = Dir[File.join(examples_folder, "*.md")].map { |f| File.read(f) }
+      table_examples = Dir[File.join(examples_folder, "*.md")].map do |f|
+        markdown(File.read(f))
+      end
 
-      columns_markdown_template_file = File.join(DBDOC_HOME, "doc_files", "columns.md.erb")
+      columns_markdown_template_file = File.join(Dbdoc::DBDOC_HOME, "doc_files", "columns.md.erb")
 
       columns_table_template = ERB.new(
         File.read(columns_markdown_template_file),
         nil,
         "-"
       )
+
+      columns_doc = YAML.load(File.read(File.join(table_folder, "columns.yml")))
+      columns_doc.each do |col|
+        col[:description] = markdown(col[:description])
+      end
+
       columns_table = columns_table_template.result_with_hash({
-        columns: YAML.load(File.read(File.join(table_folder, "columns.yml")))
+        columns: columns_doc
       })
 
-      page_body = <<-MARKDOWN
-h2. Description
+      page_body = <<~MARKDOWN
+        h2. Description
 
-#{table_description}
+        #{table_description}
 
-h2. Columns
+        h2. Columns
 
-#{columns_table}
+        #{columns_table}
 
-h2. Examples
+        h2. Examples
 
-#{table_examples.join("\n") }
+        #{table_examples.join("\n")}
       MARKDOWN
 
       page_title = schema_name == "public" ? table_name : "#{schema_name}.#{table_name}"
@@ -201,7 +250,7 @@ h2. Examples
       page_id = latest_page_id(key: page_key)
 
       if page_id
-        response = @confluence_api.update_page(
+        @confluence_api.update_page(
           page_id: page_id,
           page_title: page_title,
           body: page_body,
@@ -221,5 +270,6 @@ h2. Examples
         log_page_id(key: "table:#{schema_name}.#{table_name}", page_id: table_page_id)
       end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/dbdoc.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require "dbdoc/constants"
 require "dbdoc/version"
 require "dbdoc/config"
 require "dbdoc/manager"
-require "dbdoc/uploader"
+require "dbdoc/folder_initializer"
+require "confluence/uploader"
 
 module Dbdoc
   class Error < StandardError; end

data/lib/dbdoc/cli.rb

@@ -1,130 +1,116 @@
+# frozen_string_literal: true
+
 require "optparse"
 
 $LOAD_PATH << File.expand_path(__dir__)
 
 module Dbdoc
   class CLI
+    COMMANDS = {
+      install: %(
+        Generates all necessary config files and documentation folders.
+
+        Run this command in an empty directory.
+      ),
+      query: %(
+        Prints a query that you need to run in the database \
+        you're going to document.
+
+        Export the result of this query to the "schema.csv" file \
+        and copy it over to the "schema" folder for processing.
+      ),
+      plan: %(
+        Shows you what columns/tables/schemas are new and \
+        going to be added/deleted from the documentation.
+      ),
+      apply: %(
+        Generates boilerplate documentation for newly added \
+        columns/tables/schemas.
+
+        Drops documentation for columns/tables/schemas that \
+        were deleted from the database.
+      ),
+      "confluence:upload": %(
+        Uploads current documentation to Confluence: pages for \
+        new tables/schemas will be added, pages for dropped tables/schemas \
+        will be deleted from your Confluence space.
+      ),
+      "confluece:pages": %(
+        Lists all pages in your dbdoc Confluence space \
+        (created manually or via dbdoc).
+      ),
+      "confluence:clear": %(
+        IMPORTANT This command will delete ALL pages from \
+        the Confluence space (pages created via dbdoc AND pages that were added manually).
+      ),
+      todo: %(
+        Shows you the documentation that needs to be written.
+      )
+    }.freeze
+
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def run(args = [])
-      if args.first == "init"
-        require "fileutils"
-
-        schema_folder = File.join(Dir.pwd, "schema")
-        unless Dir.exists?(schema_folder)
-          Dir.mkdir(schema_folder)
-        end
-
-        doc_folder = File.join(Dir.pwd, "doc")
-        unless Dir.exists?(doc_folder)
-          Dir.mkdir(doc_folder)
-        end
-
-        target_file = File.join(Dir.pwd, "config.yml")
-        config_file = File.join(File.expand_path(__dir__), "../..", "config", "default.yml")
-
-        FileUtils.cp(config_file, target_file) unless File.exists?(target_file)
-
-        target_file = File.join(Dir.pwd, ".gitignore")
-        config_file = File.join(File.expand_path(__dir__), "../..", "config", "gitignore.template")
-
-        FileUtils.cp(config_file, target_file) unless File.exists?(target_file)
-
-        target_file = File.join(Dir.pwd, "confluence.yml")
-        config_file = File.join(File.expand_path(__dir__), "../..", "config", "confluence.yml")
-
-        FileUtils.cp(config_file, target_file) unless File.exists?(target_file)
-
-        0
+      if args.first == "install"
+        Dbdoc::FolderInitializer.new.init
       elsif args.first == "query"
-        options = extract_options(args)
-
-        config = Dbdoc::Config.load
-        config.merge!(options)
-
-        db_type = config["db"]["type"]
-        query_file = File.join(File.expand_path(__dir__), "../..", "config", "schema_queries", "#{db_type}.sql")
-        query = File.read(query_file)
-
-        puts query
-
-        0
+        puts manager.query
       elsif args.first == "plan"
-        options = extract_options(args)
+        plan = manager.plan
 
-        config = Dbdoc::Config.load
-        config.merge!(options)
-
-        manager = Dbdoc::Manager.new(config: config)
-        manager.plan
+        puts "--> New columns:"
+        plan[:new_columns].each do |column|
+          puts column
+        end
 
-        0
+        puts "--> Columns to drop:"
+        plan[:columns_to_drop].each do |column|
+          puts column
+        end
       elsif args.first == "apply"
-        options = extract_options(args)
-
-        config = Dbdoc::Config.load
-        config.merge!(options)
-
-        manager = Dbdoc::Manager.new(config: config)
         manager.apply
-
-        0
-      elsif args.first == "upload"
-        options = extract_options(args)
-
-        config = Dbdoc::Config.load
-        config.merge!(options)
-
-        uploader = Dbdoc::Uploader.new(config: config)
+      elsif args.first == "confluence:upload"
         uploader.upload
-
-        0
-      elsif args.first == "clear_confluence_space"
-        options = extract_options(args)
-
-        config = Dbdoc::Config.load
-        config.merge!(options)
-
-        uploader = Dbdoc::Uploader.new(config: config)
+      elsif args.first == "confluence:pages"
+        uploader.print_space_pages
+      elsif args.first == "confluence:clear"
         uploader.clear_confluence_space
-
-        0
+      elsif args.first == "todo"
+        manager.todo
       elsif args.first == "help"
-        puts "--> SOME HELP"
-
-        0
+        print_help
+      elsif args.first == "version"
+        puts Dbdoc::VERSION
       end
 
       0
     end
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     private
 
-    # This method is needed to unindent
-    # ["here document"](https://en.wikibooks.org/wiki/Ruby_Programming/Here_documents)
-    # help description.
-    #
     def unindent(str)
       str.gsub(/^#{str.scan(/^[ \t]+(?=\S)/).min}/, "")
     end
 
-    def extract_options(args)
-      options = {}
-
-      OptionParser.new do |opts|
-        opts.banner = unindent(<<-TEXT)
-          dbdoc help
-
-          1. dbdoc query
+    def manager
+      @manager ||= Dbdoc::Manager.new
+    end
 
-          This will print you a query you need to run to export your database schema.
-        TEXT
+    def uploader
+      @uploader ||= Confluence::Uploader.new
+    end
 
-        opts.on("-v", "--version", "Prints current version of dbdoc") do
-          puts Dbdoc::VERSION
-          exit 0
-        end
-      end.parse!(args)
+    def print_help
+      puts unindent <<-TEXT
+        Usage: dbdoc [command]
+      TEXT
+      puts
 
-      options
+      COMMANDS.each do |command, description|
+        puts "dbdoc #{command}"
+        puts
+        puts unindent(description)
+      end
     end
   end
 end

data/lib/dbdoc/config.rb

@@ -1,27 +1,24 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "dbdoc/constants"
 
 module Dbdoc
+  # Dbdoc::Config class knows how to load the default config from the
+  # dbdoc gem folder. Later, if needed, this class could be used to merge
+  # user-defined config with the default one.
   class Config
-    FILE_NAME = "config.yml".freeze
-    DEFAULT_FILE = File.join(DBDOC_HOME, "config", "default.yml")
-
-    class << self
-      # Be default gem will try to load config file in user's project folder.
-      # Then user's config (or empty object) will be merge with the default config
-      # from gem's folder.
-      #
-      def load
-        user_config = File.exist?(user_file) ? YAML.safe_load(File.read(user_file)) : {}
-        default_config = YAML.safe_load(File.read(DEFAULT_FILE))
-
-        default_config.merge(user_config)
-      end
+    def initialize(local_path: Dir.pwd)
+      @local_path = local_path
+    end
 
-      private
+    def load
+      local_config_file = File.join(@local_path, "config.yml")
 
-      def user_file
-        File.join(Dir.pwd, FILE_NAME)
+      if File.exist?(local_config_file)
+        YAML.load(File.read(local_config_file))
+      else
+        {}
       end
     end
   end

data/lib/dbdoc/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dbdoc
   DBDOC_HOME = File.realpath(File.join(__dir__, "..", ".."))
 end

data/lib/dbdoc/folder_initializer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
+require "dbdoc/constants"
+
+module Dbdoc
+  # Dbdoc::FolderInitializer class knows how to turn an emtpy
+  # folder into a dbdoc folder.
+  #
+  class FolderInitializer
+    def initialize(local_path: Dir.pwd)
+      @config = Dbdoc::Config.new(local_path: local_path).load
+    end
+
+    def init
+      create_schema_folder
+      create_doc_folder
+      create_config_file
+      create_gitignore_file
+      create_confluence_config_file
+    end
+
+    private
+
+    # schema folder is the one user copies the schema.csv to
+    # before updating/generating documentation
+    def create_schema_folder
+      schema_folder = File.join(Dir.pwd, "schema")
+      Dir.mkdir(schema_folder) unless Dir.exist?(schema_folder)
+    end
+
+    # doc folder stores all the database documentation files
+    def create_doc_folder
+      doc_folder = File.join(Dir.pwd, "doc")
+      Dir.mkdir(doc_folder) unless Dir.exist?(doc_folder)
+    end
+
+    def create_file(default_file_name, target_file_name)
+      target_file = File.join(Dir.pwd, target_file_name)
+
+      return if File.exist?(target_file)
+
+      config_file = File.join(File.expand_path(__dir__), "../..", "config", default_file_name)
+
+      FileUtils.cp(config_file, target_file)
+    end
+
+    def create_config_file
+      create_file("default.yml", "config.yml")
+    end
+
+    def create_gitignore_file
+      create_file("gitignore.template", ".gitignore")
+    end
+
+    def create_confluence_config_file
+      create_file("confluence.yml", "confluence.yml")
+    end
+  end
+end

data/lib/dbdoc/manager.rb

@@ -1,30 +1,58 @@
+# frozen_string_literal: true
+
 require "yaml"
+require "erb"
+require "fileutils"
 require "dbdoc/constants"
 
 module Dbdoc
+  # Dbdoc::Manager class manages database schema documentation.
+  #
+  # It knows how to generate and update documentation based on the database
+  # schema generated by the schema query for user's database.
   class Manager
-    def initialize(config: {})
-      @config = Dbdoc::Config.load.merge(config)
+    def initialize(local_path: Dir.pwd)
+      @local_path = local_path
+      @config = Dbdoc::Config.new(local_path: local_path).load
     end
 
-    def plan(verbose: true)
-      puts "--> PLAN"
-      puts
-      puts
-
-      input_schema = read_input_schema.map { |r| r.first(4) }.map { |r| r.join(":") }
+    def plan
+      input_schema = read_input_schema.map { |r| r.first(4).join(":") }
       current_schema = read_documented_schema
 
-      puts "--> New columns:"
-      pp input_schema - current_schema
-      puts
-      puts
+      {
+        new_columns: input_schema - current_schema,
+        columns_to_drop: current_schema - input_schema
+      }
+    end
+
+    def todo
+      doc_folder_files = File.join(@local_path, "doc", "**/*")
+
+      Dir[doc_folder_files].each do |file|
+        next if file == "."
+        next if file == ".."
+        next if File.directory?(file)
 
-      puts "--> Columns to drop:"
-      pp current_schema - input_schema
+        File.read(file).split("\n").each_with_index do |line, i|
+          next unless line.include?("TODO")
+
+          relative_path = file.gsub(@local_path, "")
+
+          puts "#{relative_path}:#{i + 1}"
+        end
+      end
+    end
+
+    def query
+      db_type = @config["db"]["type"]
+      query_file = File.join(File.expand_path(__dir__), "../..", "config", "schema_queries", "#{db_type}.sql")
+
+      File.read(query_file)
     end
 
-    def apply(path: Dir.pwd, verbose: true)
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    def apply
       puts "--> APPLY"
       puts
       puts
@@ -35,14 +63,16 @@ module Dbdoc
       added_columns = input_schema - current_schema
       dropped_columns = current_schema - input_schema
 
-      doc_folder = File.join(Dir.pwd, "doc")
+      doc_folder = File.join(@local_path, "doc")
+
+      Dir.mkdir(doc_folder) unless Dir.exist?(doc_folder)
 
       ## DROP COLUMNS
       dropped_columns.each do |column|
-        schema_name, table_name, column_name, column_type = column.split(":")
+        schema_name, table_name, column_name = column.split(":")
 
         columns_file = File.join(doc_folder, schema_name, table_name, "columns.yml")
-        next unless File.exists?(columns_file)
+        next unless File.exist?(columns_file)
 
         columns = YAML.load(File.read(columns_file))
         columns.reject! { |c| c[:name] == column_name }
@@ -69,7 +99,7 @@ module Dbdoc
           next unless File.directory?(table_folder)
 
           columns_file = File.join(table_folder, "columns.yml")
-          next unless File.exists?(columns_file)
+          next unless File.exist?(columns_file)
 
           columns = YAML.load(File.read(columns_file))
 
@@ -93,16 +123,18 @@ module Dbdoc
 
       create_new_columns(added_columns)
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
 
     private
 
     def input_schema
-      File.read(File.join(Dir.pwd, "schema", "schema.csv"))
+      File.read(File.join(@local_path, "schema", "schema.csv"))
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     def read_input_schema
       rows = input_schema.split("\n")
-      with_header = rows[0].include?("schema_name")
+      with_header = rows[0].include?("table_schema")
 
       rows.shift if with_header
 
@@ -110,38 +142,37 @@ module Dbdoc
         r.split(",").map(&:strip).map { |c| c.gsub('"', "") }.first(5)
       end
 
-      config = YAML.load(File.read("config.yml"))
-
-      if @config["ignorelist"]
-        @config["ignorelist"].map { |r| r.split(/[\.\#]/) }.each do |b|
-          schema_pattern, table_pattern, column_pattern = b
+      @config["ignorelist"]&.map { |r| r.split(/[\.\#]/) }&.each do |b|
+        schema_pattern, table_pattern, column_pattern = b
 
-          rows.reject! do |row|
-            schema_name, table_name, column_name, _, _ = row
+        rows.reject! do |row|
+          schema_name, table_name, column_name, = row
 
-            if column_pattern
-              next unless column_name =~ Regexp.new(column_pattern.gsub("*", ".*"))
-            end
-
-            if table_pattern
-              next unless table_name =~ Regexp.new(table_pattern.gsub("*", ".*"))
-            end
+          if column_pattern
+            next unless column_name =~ Regexp.new(column_pattern.gsub("*", ".*"))
+          end
 
-            if schema_pattern
-              next unless schema_name =~ Regexp.new(schema_pattern.gsub("*", ".*"))
-            end
+          if table_pattern
+            next unless table_name =~ Regexp.new(table_pattern.gsub("*", ".*"))
+          end
 
-            true
+          if schema_pattern
+            next unless schema_name =~ Regexp.new(schema_pattern.gsub("*", ".*"))
           end
+
+          true
         end
       end
 
       rows
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
 
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     def read_documented_schema
-      doc_folder = File.join(Dir.pwd, "doc")
+      doc_folder = File.join(@local_path, "doc")
 
+      return [] unless Dir.exist?(doc_folder)
       return [] if Dir.empty?(doc_folder)
 
       keys = []
@@ -160,9 +191,9 @@ module Dbdoc
           next unless File.directory?(table_folder)
 
           columns_file = File.join(table_folder, "columns.yml")
-          next unless File.exists?(columns_file)
+          next unless File.exist?(columns_file)
 
-          columns = YAML.load(File.read(columns_file))
+          columns = YAML.load(File.read(columns_file), [Symbol])
           columns.each do |column|
             keys.push([
               schema_name,
@@ -176,9 +207,11 @@ module Dbdoc
 
       keys
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
 
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
     def create_new_columns(added_columns)
-      doc_folder = File.join(Dir.pwd, "doc")
+      doc_folder = File.join(@local_path, "doc")
 
       added_columns.map! { |r| r.split(":") }
       new_columns = read_input_schema.select do |row|
@@ -224,17 +257,18 @@ module Dbdoc
           # 4. create table columns.yml
           columns_yaml = File.join(table_folder, "columns.yml")
 
-          unless File.exists?(columns_yaml)
-            columns_erb_tamplate_file = File.join(DBDOC_HOME, "doc_files", "columns.yml.erb")
-            columns_yaml_template = ERB.new(File.read(columns_erb_tamplate_file), nil, "-")
-            File.open(columns_yaml, "w") do |f|
-              f.puts columns_yaml_template.result_with_hash({
-                columns: columns
-              })
-            end
+          next if File.exist?(columns_yaml)
+
+          columns_erb_tamplate_file = File.join(DBDOC_HOME, "doc_files", "columns.yml.erb")
+          columns_yaml_template = ERB.new(File.read(columns_erb_tamplate_file), nil, "-")
+          File.open(columns_yaml, "w") do |f|
+            f.puts columns_yaml_template.result_with_hash({
+              columns: columns
+            })
           end
         end
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
   end
 end

data/lib/dbdoc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dbdoc
-  VERSION = "0.1.0".freeze
+  VERSION = "0.3.5"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dbdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Anatoli Makarevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
-dependencies: []
+date: 2020-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Dbdoc is a tool to keep your database documentation up-to-date and version
   controlled.
 email:
@@ -19,6 +47,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -43,12 +72,14 @@ files:
 - doc_files/table_description.md
 - doc_files/table_example.md
 - lib/confluence/api.rb
+- lib/confluence/markdown_converter.rb
+- lib/confluence/uploader.rb
 - lib/dbdoc.rb
 - lib/dbdoc/cli.rb
 - lib/dbdoc/config.rb
 - lib/dbdoc/constants.rb
+- lib/dbdoc/folder_initializer.rb
 - lib/dbdoc/manager.rb
-- lib/dbdoc/uploader.rb
 - lib/dbdoc/version.rb
 homepage: https://github.com/sqlhabit/dbdoc
 licenses: