dbdoc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a675eef6484bf4c2c6bb78521c9f322ff057804feec72e34061eb899153352
-  data.tar.gz: 5e80744c319d0e2ea77b321704e317467e871e9d93a53ad77871c655106b8f3b
+  metadata.gz: 95d1967a75eb0505c9dd74882fcc2fa18127b464d2358f4fe83bfb803a3291c9
+  data.tar.gz: 655b2bf4f41c4c05e4709ec44611af42e9f529daa9891617529c131a095c6968
 SHA512:
-  metadata.gz: b49a2edb0d2e31280b4bd8ed29ef109da6ff38fd6669df30a260f049ad5ad841bea5425d3c68fd9862f8e74116f4cbcb90e767f69e44aeed2c0910429ba13ac1
-  data.tar.gz: 18b09c76bc60de2ffb1a574a9695d03b1be0ba5c40b3bedbeb2d59eaefbd4b431b4a370ea52cb46defb34a388b9a177e2dd6c4496e7a78bdf1c3d7ed0d607a82
+  metadata.gz: 65386544fb68b47f56121ab291b86b0bbb0d462c35692e40d223faaaa56b7accc2cf401438001ddf9fb1aab01fb80f51fb28aededa4653f4ff5da41435b65e13
+  data.tar.gz: da90433a70497544484e32bacd6806ea166b64f7cd9cf90f1111da06d9c14c90c582dc9fb7890094bea272dff25fc3033261b22f16c623c8b204b3a2b787b6da

data/.github/FUNDING.yml

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

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "httparty"
+gem "kramdown"
 
 group :development do
   gem "byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dbdoc (0.1.0)
+    dbdoc (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +20,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)
@@ -77,6 +79,7 @@ DEPENDENCIES
   coveralls
   dbdoc!
   httparty
+  kramdown
   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/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

@@ -18,7 +18,7 @@ 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}",
@@ -26,9 +26,12 @@ module Confluence
           }
         }
       )
+
+      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: {

data/lib/confluence/markdown_converter.rb

@@ -0,0 +1,87 @@
+require "kramdown"
+
+module Confluence
+  class MarkdownConverter
+    CONVERTERS = %w(
+      convert_h1
+      convert_h2
+      convert_h3
+      convert_h4
+      convert_h5
+      convert_bold
+      convert_italic
+      convert_code
+      convert_unordered_list
+    )
+
+    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/cli.rb

@@ -77,7 +77,24 @@ module Dbdoc
         uploader.upload
 
         0
-      elsif args.first == "clear_confluence_space"
+      elsif args.first == "existing_pages"
+        options = extract_options(args)
+
+        config = Dbdoc::Config.load
+        config.merge!(options)
+
+        uploader = Dbdoc::Uploader.new(config: config)
+        pages = uploader.space_pages
+
+        pages.each do |page|
+          page_title = page["title"]
+          page_id = page["id"]
+
+          puts "#{page_title}: #{page_id}"
+        end
+
+        0
+      elsif args.first == "clear_space"
         options = extract_options(args)
 
         config = Dbdoc::Config.load
@@ -86,6 +103,16 @@ module Dbdoc
         uploader = Dbdoc::Uploader.new(config: config)
         uploader.clear_confluence_space
 
+        0
+      elsif args.first == "todo"
+        options = extract_options(args)
+
+        config = Dbdoc::Config.load
+        config.merge!(options)
+
+        manager = Dbdoc::Manager.new(config: config)
+        manager.todo
+
         0
       elsif args.first == "help"
         puts "--> SOME HELP"

data/lib/dbdoc/manager.rb

@@ -24,6 +24,24 @@ module Dbdoc
       pp current_schema - input_schema
     end
 
+    def todo
+      doc_folder_files = File.join(Dir.pwd, "doc", "**/*")
+
+      Dir[doc_folder_files].each do |file|
+        next if file == "."
+        next if file == ".."
+        next if File.directory?(file)
+
+        File.read(file).split("\n").each_with_index do |line, i|
+          if line.include?("TODO")
+            relative_path = file.gsub(Dir.pwd, "")
+
+            puts "#{relative_path}:#{i + 1}"
+          end
+        end
+      end
+    end
+
     def apply(path: Dir.pwd, verbose: true)
       puts "--> APPLY"
       puts

data/lib/dbdoc/uploader.rb

@@ -1,4 +1,5 @@
 require "dbdoc/constants"
+require_relative "../confluence/markdown_converter"
 require_relative "../confluence/api"
 
 module Dbdoc
@@ -14,10 +15,23 @@ module Dbdoc
       delete_pages_for_dropped_schemas_or_tables
     end
 
+    def space_pages
+      @confluence_api.existing_pages["results"]
+    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:)
+      uploaded_pages = 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}"
+
+        if @confluence_api.delete_page(page_id: page_id)
+          unlog_page_id(key: page_key)
+        end
+      end
     end
 
     private
@@ -162,13 +176,17 @@ module Dbdoc
       end
     end
 
+    def markdown(input)
+      Confluence::MarkdownConverter.new.convert(input)
+    end
+
     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 { |f| File.read(f) }.map { |example| markdown(example) }
 
       columns_markdown_template_file = File.join(DBDOC_HOME, "doc_files", "columns.md.erb")
 
@@ -177,8 +195,14 @@ module Dbdoc
         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

data/lib/dbdoc/version.rb

@@ -1,3 +1,3 @@
 module Dbdoc
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anatoli Makarevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies: []
 description: Dbdoc is a tool to keep your database documentation up-to-date and version
   controlled.
@@ -19,6 +19,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -43,6 +44,7 @@ files:
 - doc_files/table_description.md
 - doc_files/table_example.md
 - lib/confluence/api.rb
+- lib/confluence/markdown_converter.rb
 - lib/dbdoc.rb
 - lib/dbdoc/cli.rb
 - lib/dbdoc/config.rb