sync_readme 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aae0ad2a0988f1ab3b183584b9c3be86c5bc013
-  data.tar.gz: 44f347b0583e8d4ca3d1747c7937771f88e5ae8c
+  metadata.gz: ad7a199bae921cefac3fe964d453a85957266985
+  data.tar.gz: 17b3a141759854b013dfb907dd7fb4c901e7ad1f
 SHA512:
-  metadata.gz: 5e9b679d27ee036868e06633687a98091d39ef8d2156ccb4751ae5286211cdd8889709edc0e7a864e839a68c27854e2670e185a82c1bfde5272d674b50f1021c
-  data.tar.gz: 5d17aadfbc0335682eeec7917700ba87d4f67dd18f73a530beda3312b5f036b0834650cb708d722111302d271e61916fe0b37118eca21c710ca11e99f3b6d8a1
+  metadata.gz: 4af9909b137ae065b12a90db87b1ffcdd6c06a92af6c8172703d205726b3ebdf912439ad2bf799644811d452fbe7a63b6924ba4ba4649ca054c1f52098bc7d99
+  data.tar.gz: f43a1629c77d82f7423d5625947b1a6d33fa3c5c1dbf028d8fccc28d43afced41ac80c7eae76fe57a245fb13dac676f2bf214fdc927d68e047a8ca75948f2b34

data/README.md

@@ -32,6 +32,7 @@ readme:
   notice: this file is sync'd!      # optional, adds the notice (as html) to the top of the confluance docs
   strip_title: false                # optional, defaults false, strips the first h1 (#) tag from the file
   syntax_highlighting: true         # optional, defaults true, uses coderay syntax highlighting on code blocks
+  toc: true                         # optional, defaults false, can also be a hash of toc macro params
 ```
 
 You can also set the following in your environment (ex: continuous integration) to store credentials:

data/lib/sync_readme/config.rb

@@ -36,6 +36,10 @@ module SyncReadme
       @raw_config['notice']
     end
 
+    def toc
+      @raw_config['toc']
+    end
+
     def password
       ENV['CONFLUENCE_PASSWORD'] || @raw_config['password']
     end

data/lib/sync_readme/reader.rb

@@ -5,10 +5,46 @@ module SyncReadme
     def initialize(config)
       @file_contents = File.read(config.filename)
       @notice = config.notice
+      @toc = config.toc
       @strip_title = config.strip_title?
       @highlighter = config.syntax_highlighting? ? 'coderay' : nil
     end
 
+    # See here for ToC parameters
+    # https://confluence.atlassian.com/display/CONF55/Table+of+Contents+Macro
+    def toc
+      return '' unless @toc
+      @toc = {} unless @toc.is_a?(Hash)
+      params = {
+        'printable' => true,
+        'style' => 'circle',
+        'maxLevel' => 2,
+        'indent' => '5px',
+        'minLevel' => 2,
+        'exclude' => '[1/2]',
+        'outline' => true,
+        'type' => 'list',
+        'include' => '.*',
+        'class' => 'sync_readme_toc'
+        }.merge(@toc)
+
+      return <<-TOC
+      <ac:structured-macro ac:name="toc">
+        <ac:parameter ac:name="printable">#{params['printable']}</ac:parameter>
+        <ac:parameter ac:name="style">#{params['style']}</ac:parameter>
+        <ac:parameter ac:name="maxLevel">#{params['maxLevel']}</ac:parameter>
+        <ac:parameter ac:name="indent">#{params['indent']}</ac:parameter>
+        <ac:parameter ac:name="minLevel">#{params['minLevel']}</ac:parameter>
+        <ac:parameter ac:name="class">#{params['class']}</ac:parameter>
+        <ac:parameter ac:name="exclude">#{params['exclude']}</ac:parameter>
+        <ac:parameter ac:name="type">#{params['type']}</ac:parameter>
+        <ac:parameter ac:name="outline">#{params['outline']}</ac:parameter>
+        <ac:parameter ac:name="include">#{params['include']}</ac:parameter>
+      </ac:structured-macro>
+      TOC
+    end
+
+
     def html
       markdown = @file_contents
       markdown.sub!(/# .*\n/, '') if @strip_title
@@ -20,9 +56,11 @@ module SyncReadme
           line_numbers: 'table'
         }
       }
-      value = Kramdown::Document.new(markdown, options).to_html
-      value = "#{@notice}#{value}" if @notice
-      value
+      value = []
+      value << "<p>#{@notice}</p>" if @notice
+      value << toc if @toc
+      value << Kramdown::Document.new(markdown, options).to_html
+      value.join("\n")
     end
   end
 end

data/lib/sync_readme/version.rb

@@ -1,3 +1,3 @@
 module SyncReadme
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_readme
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Ives
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday