asciidoctor-confluence_publisher 0.1.0

data/lib/asciidoctor/confluence_publisher/invoker.rb

@@ -0,0 +1,154 @@
+require 'digest'
+
+module Asciidoctor
+  module ConfluencePublisher
+    class Invoker
+      # default template directory for asciidoctor_confluence marcos
+      DEFAULT_TEMPLATE_DIR = File.expand_path("../../../../template", __FILE__)
+
+      attr_reader :options
+      def initialize(options)
+        @options = options.dup
+        @options[:to_file] = nil
+        @options[:catalog_assets] = true
+
+        @options[:backend] = 'xhtml5'
+        @options[:template_dirs] = Array(options[:template_dirs]) << DEFAULT_TEMPLATE_DIR
+        @options[:to_file] = false
+        @options[:header_footer] = false
+        # confluence related configuration
+        attributes = options[:attributes] || {}
+        attributes['confluence_host'] ||= ENV['CONFLUENCE_HOST']
+        attributes['space'] ||= ENV['SPACE']
+        attributes['username'] ||= ENV['CONFLUENCE_USERNAME']
+        attributes['password'] ||= ENV['CONFLUENCE_PASSWORD']
+        @ancestor_id = (attributes['ancestor_id'] ||= ENV['ANCESTOR_ID'])
+        check_confluence_config(attributes)
+
+        proxy = attributes[:proxy] || ENV['CONFLUENCE_PROXY']
+        skip_verify_ssl = attributes['skip_verify_ssl'].to_s == 'true'
+        @confluence_client = ConfluenceApi.new(attributes['confluence_host'],
+                                               attributes['space'],
+                                               attributes['username'],
+                                               attributes['password'],
+                                               skip_verify_ssl: skip_verify_ssl,
+                                               proxy: proxy)
+      end
+
+      def invoke!
+        input_files = options[:asciidoc_source_dir] ? Array(options[:asciidoc_source_dir]) : options[:input_files]
+
+        input_files.map(&method(:build_file_tree)).each do |node|
+          traverse_file_tree(@ancestor_id, node, &method(:convert_and_publish))
+        end
+      end
+
+      private
+      def convert_and_publish(ancestor_id, input_file)
+        if File.file?(input_file)
+          document = Asciidoctor.load_file input_file, options
+          confluence_page = find_or_create_page(document.title, ancestor_id)
+          process_page_content(confluence_page.id, document.title, document.content)
+          process_page_attachments(confluence_page.id, [document.references[:links], document.references[:images]].flatten, File.dirname(input_file))
+        else
+          title = File.basename(input_file)
+          confluence_page = find_or_create_page(title, ancestor_id)
+        end
+        confluence_page.id
+      end
+
+      def process_page_attachments(page_id, assets, source_dir)
+        resource_property = 'resource_hash'
+        page_resource_prop = @confluence_client.get_page_property(page_id, resource_property)
+        page_attachment_hash = page_resource_prop && page_resource_prop.value || {}
+        attachment_hash = @confluence_client.get_attachments(page_id).map { |attachment| [attachment.title, attachment.id] }.to_h
+
+        has_asset_updated = false
+        assets.each do |link|
+          next if Asciidoctor::Helpers.uriish?(link)
+          source_file_dir = source_dir
+          if link.is_a? ::Struct
+            source_file_dir += "/#{link.imagesdir}"
+          end
+          file_path = File.join(source_file_dir, link.to_s)
+          next if !File.exist?(file_path)
+          file_md5 = Digest::MD5.hexdigest File.read(file_path)
+          filename = File.basename(file_path)
+
+          attachment_update_success = if attachment_hash.has_key?(filename)
+                                        if file_md5 != page_attachment_hash[filename]
+                                          @confluence_client.update_attachment(page_id, attachment_hash[filename], file_path)
+                                          has_asset_updated = true
+                                        end
+                                      else
+                                        @confluence_client.create_attachment(page_id, file_path)
+                                        has_asset_updated = true
+                                      end
+          page_attachment_hash[filename] = file_md5 if attachment_update_success
+        end
+
+        @confluence_client.set_page_property(page_id, resource_property, page_attachment_hash) if has_asset_updated
+      end
+
+      def process_page_content(page_id, title, document_content)
+        content_property = 'content_hash'
+        page_hash_prop = @confluence_client.get_page_property(page_id, content_property)
+        page_content_hash = page_hash_prop && page_hash_prop.value
+
+        if (new_content_hash = Digest::MD5.hexdigest(document_content)) != page_content_hash
+          @confluence_client.update_page(page_id, title, document_content)
+          @confluence_client.set_page_property(page_id, content_property, new_content_hash)
+        end
+      end
+
+      def check_confluence_config(attributes)
+        empty_attrs = %w(confluence_host space username password ancestor_id).select do |prop|
+          attr = attributes[prop]
+          attr.nil? || attr.to_s.strip.length < 1
+        end
+        raise empty_attrs.join(', ') if empty_attrs.size > 0
+      end
+
+      def build_file_tree(root)
+        node = nil
+        if File.directory?(root) || File.file?(root) && File.extname(root) =~ /.(adoc|asc|asciidoc)$/
+          node = Asciidoctor::ConfluencePublisher::Asciidoc.new(root)
+        end
+        return node if File.file?(root)
+
+        Dir.children(root).each do |dir|
+          next if dir.start_with?('.')
+          child = build_file_tree(File.join(root, dir))
+          node.add_child(child)
+        end
+
+        node
+      end
+
+      def traverse_file_tree(ancestor_id, root, &block)
+        new_ancestor_id =  ancestor_id
+        if options[:asciidoc_source_dir] != root.path
+          new_ancestor_id = block.call(ancestor_id, root.path)
+        end
+        children = root.children
+        return if children.size.zero?
+        children.each do |child|
+          next if !child.has_any_leaves?
+          traverse_file_tree(new_ancestor_id, child, &block)
+        end
+      end
+
+      def find_or_create_page(title, ancestor_id)
+        confluence_pages = @confluence_client.get_pages_by_title(title).select { |page| page.contain_ancestor?(ancestor_id) }
+        if confluence_pages.size > 1
+          raise 'Too many duplicate page title'
+        elsif confluence_pages.size == 1
+          confluence_page = confluence_pages[0]
+        else
+          confluence_page = @confluence_client.create_page(title, '', ancestor_id)
+        end
+        confluence_page
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/ancestor.rb

@@ -0,0 +1,9 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Ancestor < Base
+        attr_accessor :id
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/attachment.rb

@@ -0,0 +1,15 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Attachment < Base
+        attr_accessor :id, :title
+        attr_reader :version
+
+        def version=(ver)
+          @version = Version.new(ver)
+        end
+      end
+    end
+  end
+end
+

data/lib/asciidoctor/confluence_publisher/model/base.rb

@@ -0,0 +1,21 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Base
+        def initialize(hash = {})
+          accessor_methods = public_methods(false).select { |mth| mth.to_s =~ /\w+=$/ }
+          hash.each do |key, val|
+            setter_method = "#{key}="
+            if accessor_methods.include?(setter_method.to_sym)
+              public_send(setter_method, val)
+            end
+          end
+        end
+
+        def to_s
+          inspect
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/page.rb

@@ -0,0 +1,26 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Page < Base
+        attr_accessor :id, :title
+        attr_reader :version, :ancestors, :space
+
+        def version=(ver)
+          @version = Version.new(ver)
+        end
+
+        def ancestors=(ancestors)
+          @ancestors = ancestors.map { |ans| Ancestor.new(ans) }
+        end
+
+        def space=(space)
+          @space = Space.new(space)
+        end
+
+        def contain_ancestor?(ancestor_id)
+          @ancestors.any? { |ancestor| ancestor.id == ancestor_id.to_s }
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/property.rb

@@ -0,0 +1,14 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Property < Base
+        attr_accessor :key, :value
+        attr_reader :version
+
+        def version=(ver)
+          @version = Version.new(ver)
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/space.rb

@@ -0,0 +1,9 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Space < Base
+        attr_accessor :key
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/model/version.rb

@@ -0,0 +1,9 @@
+module Asciidoctor
+  module ConfluencePublisher
+    module Model
+      class Version < Base
+        attr_accessor :number
+      end
+    end
+  end
+end

data/lib/asciidoctor/confluence_publisher/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module ConfluencePublisher
+    VERSION = "0.1.0"
+  end
+end

data/lib/asciidoctor_confluence_publisher.rb

@@ -0,0 +1 @@
+require_relative "asciidoctor/confluence_publisher"

data/template/block_admonition.html.haml

@@ -0,0 +1,6 @@
+%ac:structured-macro{"ac:name" => admonition_name}
+  - if title?
+    %ac:parameter{"ac:name" => "title"}= title
+  %ac:rich-text-body
+    %p= content
+

data/template/block_example.haml.haml

@@ -0,0 +1,4 @@
+%ac:structured-macro{ "ac:name" => "expand" }
+  - if title?
+    %ac:parameter{"ac:name" => "title"}= title
+  %ac:rich-text-body= content

data/template/block_image.html.haml

@@ -0,0 +1,10 @@
+- haml_tag_if((attr? :link), :a, {href: (attr :link)}) do
+  - href_target = attr :target
+  %ac:image{ "ac:title" => title? && title, "ac:alt" => (attr :alt), "ac:height" => (attr :height), "ac:width" => (attr :width) }
+    - if uri_link? href_target
+      %ri:url{ "ri:value" => href_target }/
+    - else
+      %ri:attachment{ "ri:filename" => File.basename(href_target) }/
+  - if title?
+    .cp-image-title
+      %em= captioned_title

data/template/block_listing.html.haml

@@ -0,0 +1,18 @@
+- if @style == 'source'
+  %ac:structured-macro{"ac:name" => "code"}
+    - if confluence_supported_lang(source_lang)
+      %ac:parameter{"ac:name" => "language"}= source_lang
+    - if title?
+      %ac:parameter{"ac:name" => "title"}= title
+    - if attr? :linenums
+      %ac:parameter{"ac:name" => "linenumbers"} true
+    - if attr? :start
+      %ac:parameter{"ac:name" => "firstline"}= attr :start
+    - wrap_code = (@document.attr? :prewrap) || (has_option?(:nowrap) && !(option? :nowrap))
+    %ac:parameter{"ac:name" => "collapse"}= wrap_code
+    %ac:plain-text-body= "<![CDATA[#{content}]]>"
+- else
+  %ac:structured-macro{"ac:name" => "noformat"}
+    - if title?
+      %ac:parameter{"ac:name" => "title"}= title
+    %ac:plain-text-body= "<![CDATA[#{content}]]>"

data/template/block_olist.html.haml

@@ -0,0 +1,8 @@
+- if title?
+  .cp-olist-title= title
+%ol
+  - items.each do |item|
+    %li
+      %p= item.text
+      - if item.blocks?
+        = item.content

data/template/block_paragraph.html.haml

@@ -0,0 +1,4 @@
+- if title?
+  .cp-paragraph-title
+    %em= title
+%p= content

data/template/block_preamble.html.haml

@@ -0,0 +1 @@
+=content

data/template/block_quote.html.haml

@@ -0,0 +1,9 @@
+%blockquote=content
+- if (attr? :attribution) or (attr? :citetitle)
+  .attribution{ style: 'text-align: right;'}
+    - if attr? :attribution
+      — #{attr :attribution}
+      - if attr? :citetitle
+        - if attr? :attribution
+          %br
+        %cite=attr :citetitle

data/template/block_stem.html.haml

@@ -0,0 +1,3 @@
+%ac:structured-macro{ "ac:name" => "mathjax-block-macro" }
+  %ac:plain-text-body
+    = "<![CDATA[#{content}]]>"

data/template/block_table.html.haml

@@ -0,0 +1,24 @@
+%table
+  - if title?
+    %caption.title= captioned_title
+  - unless (attr :rowcount).zero?
+    - [:head, :foot, :body].select {|tblsec| !@rows[tblsec].empty? }.each do |tblsec|
+      - haml_tag "t#{tblsec}" do
+        - @rows[tblsec].each do |row|
+          %tr
+            - row.each do |cell|
+              - haml_tag "#{(tblsec == :head || cell.style == :header) ? 'th' : 'td'}", colspan: cell.colspan, rowspan: cell.rowspan do
+                - if tblsec == :head
+                  = cell.text
+                - else
+                  - case cell.style
+                  - when :asciidoc
+                    %div= cell.content
+                  - when :verse
+                    .verse= cell.text
+                  - when :literal
+                    .literal
+                      %pre= cell.text
+                  - else
+                    - cell.content.each do |text|
+                      = text

data/template/block_toc.html.haml

@@ -0,0 +1,7 @@
+%ac:structured-macro{"ac:name" => "toc"}
+  %ac:parameter{"ac:name" => "maxLevel"} 4
+  %ac:parameter{"ac:name" => "minLevel"} 2
+  %ac:parameter{"ac:name" => "outline"} true
+  %ac:parameter{"ac:name" => "indent"} 0px
+  %ac:parameter{"ac:name" => "style"} none
+  %ac:parameter{"ac:name" => "separator"} pipe

data/template/block_ulist.html.haml

@@ -0,0 +1,15 @@
+- if title?
+  .cp-ulist-title =title
+%ul
+  - items.each_with_index do |item, index|
+    %li
+      - if item.attr? :checkbox
+        %ac:task-list
+          %ac:task
+            %ac:task-id= index
+            %ac:task-status= (item.attr? :checked) ? 'complete' : 'imcomplete'
+            %ac:task-body= item.text
+      - else
+        =item.text
+        - if item.blocks?
+          = item.content

data/template/block_verse.html.haml

@@ -0,0 +1,9 @@
+%pre.content=content
+- if (attr? :attribution) or (attr? :citetitle)
+  .attribution
+    - if attr? :attribution
+      — #{attr :attribution}
+    - if attr? :citetitle
+      - if attr? :attribution
+        %br
+      %cite=attr :citetitle

data/template/block_video.html.haml

@@ -0,0 +1,11 @@
+%div{:id=>@id, :class=>['videoblock', @style, role]}
+  - if title?
+    .title=captioned_title
+  .content
+    - if video_iframe?
+      %iframe{:width=>(attr :width), :height=>(attr :height), :src=>video_uri, :frameborder=>0, :allowfullscreen=>!(option? :nofullscreen)}
+    - else
+      %video{:src=>video_uri, :width=>(attr :width), :height=>(attr :height),
+          :poster=>((attr :poster) ? media_uri(attr :poster) : nil), :autoplay=>(option? :autoplay),
+          :controls=>!(option? :nocontrols), :loop=>(option? :loop)}
+        Your browser does not support the video tag.

data/template/document.html.haml

@@ -0,0 +1 @@
+= content

data/template/embedded.html.haml

@@ -0,0 +1,4 @@
+- if (attr? :toc) && (attr? 'toc-placement', 'auto')
+  - current_dir = Pathname.new(File.dirname(__FILE__)).realpath
+  %p =Haml::Engine.new(File.read("#{current_dir}/block_toc.html.haml")).render
+= content

data/template/helpers.rb

@@ -0,0 +1,171 @@
+# Add custom functions to this module that you want to use in your Haml
+# templates. Within the template you can invoke them as top-level functions
+# just like the built-in helper functions that Haml provides.
+module Haml::Helpers
+
+  CG_ALPHA = '[a-zA-Z]'
+  CC_ALNUM = 'a-zA-Z0-9'
+
+  # Detects strings that resemble URIs.
+  #
+  # Examples
+  #   http://domain
+  #   https://domain
+  #   file:///path
+  #   data:info
+  #
+  #   not c:/sample.adoc or c:\sample.adoc
+  #
+  UriRegexp = %r{^#{CG_ALPHA}[#{CC_ALNUM}.+-]+:/{0,2}}
+
+  def has_option? name
+    @attributes.has_key? %(#{name}-option)
+  end
+
+  ##
+  # Returns corrected section level.
+  #
+  # @param sec [Asciidoctor::Section] the section node (default: self).
+  # @return [Integer]
+  #
+  def section_level(sec = self)
+    @_section_level ||= (sec.level == 0 && sec.special) ? 1 : sec.level
+  end
+
+  ##
+  # Returns the captioned section's title, optionally numbered.
+  #
+  # @param sec [Asciidoctor::Section] the section node (default: self).
+  # @return [String]
+  #
+  def section_title(sec = self)
+    sectnumlevels = document.attr(:sectnumlevels, 3).to_i
+
+    if sec.numbered && !sec.caption && sec.level <= sectnumlevels
+      [sec.sectnum, sec.captioned_title].join(' ')
+    else
+      sec.captioned_title
+    end
+  end
+
+  #--------------------------------------------------------
+  # block_listing
+  #
+
+  def source_lang
+    attr :language, nil, false
+  end
+
+  def confluence_supported_lang(lang)
+    supported = ['actionscript3','applescript','bash','c#','cpp','css',
+                 'coldfusion','delphi','diff','erl','groovy',
+                 'xml','java','jfx','js','php','perl',
+                 'text','powershell','py','ruby','sql','sass',
+                 'scala','vb','yml']
+    supported.include? lang
+  end
+
+  #--------------------------------------------------------
+  # block_table
+  #
+
+  def autowidth?
+    option? :autowidth
+  end
+
+  def spread?
+    'spread' if !(option? 'autowidth') && (attr :tablepcwidth) == 100
+  end
+
+  #--------------------------------------------------------
+  # block_video
+  #
+
+  # @return [Boolean] +true+ if the video should be embedded in an iframe.
+  def video_iframe?
+    ['vimeo', 'youtube'].include?(attr :poster)
+  end
+
+  def admonition_name
+     case (attr :name)
+     when 'note'
+      'info'
+     when 'tip'
+       'tip'
+     when 'caution', 'warning'
+      'note'
+     when 'important'
+       'warning'
+     end
+  end
+
+  # Public: Efficiently checks whether the specified String resembles a URI
+  #
+  # Uses the Asciidoctor::UriSniffRx regex to check whether the String begins
+  # with a URI prefix (e.g., http://). No validation of the URI is performed.
+  #
+  # str - the String to check
+  #
+  # @return true if the String is a URI, false if it is not
+  def uri_link?(str)
+    str && (str.include? ':') && str =~ UriRegexp
+  end
+
+  def video_uri
+    case (attr :poster, '').to_sym
+    when :vimeo
+      params = {
+        :autoplay => (1 if option? 'autoplay'),
+        :loop     => (1 if option? 'loop')
+      }
+      start_anchor = "#at=#{attr :start}" if attr? :start
+      "//player.vimeo.com/video/#{attr :target}#{start_anchor}#{url_query params}"
+
+    when :youtube
+      video_id, list_id = (attr :target).split('/', 2)
+      params = {
+        :rel      => 0,
+        :start    => (attr :start),
+        :end      => (attr :end),
+        :list     => (attr :list, list_id),
+        :autoplay => (1 if option? 'autoplay'),
+        :loop     => (1 if option? 'loop'),
+        :controls => (0 if option? 'nocontrols')
+      }
+      "//www.youtube.com/embed/#{video_id}#{url_query params}"
+    else
+      anchor = [(attr :start), (attr :end)].join(',').chomp(',')
+      anchor.prepend '#t=' unless anchor.empty?
+      media_uri "#{attr :target}#{anchor}"
+    end
+  end
+
+  # Formats URL query parameters.
+  def url_query(params)
+    str = params.map { |k, v|
+      next if v.nil? || v.to_s.empty?
+      [k, v] * '='
+    }.compact.join('&amp;')
+
+    str.prepend('?') unless str.empty?
+  end
+
+  #--------------------------------------------------------
+  # inline_anchor
+  #
+  # @return [String, nil] text of the xref anchor, or +nil+ if not found.
+  def xref_text
+    str = text || document.references[:ids][attr :refid || target]
+    str.tr_s("\n", ' ') if str
+  end
+
+  # removes leading hash from anchor targets
+  def anchor_name str
+    if str.start_with? "#"
+      str[1..str.length]
+    else
+      str
+    end
+  end
+
+end