md2conf 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99aae9ed537d6bbd435e310f1d104bb83c4cb013
+  data.tar.gz: c6c2dbfb7ab2bc0bc84627a7440785251c6106a8
+SHA512:
+  metadata.gz: 249cc7658acf867f02cf85e878cc187562aa276c185132f2fa0eaa19b3f6b694a1494fd66e6d28b64047157bc7b539a2b782da499bbaf01956ccc47e8d9c5e5e
+  data.tar.gz: c2c54d26b897c73a699681c90f285dd12c3aedc5808ad06ad18bea910d584bf3ad7d69d8242dc9fff30f8f7ecaeb7ac5cfb59209095938d3a59f8f61748e47de

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.1.2] - 2017-08-21
+### Changed
+- Updated documentation.
+
+### Fixed
+- Info macros substitution did not always work.
+
+## [0.1.0] - 2017-08-21
+### Added
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vtyshkevich@iponweb.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contribution Guide
+
+Feel free to contribute!

data/README.md

@@ -0,0 +1,43 @@
+# Md2conf
+
+Confverts Markdown to Confluence storage format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'md2conf'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install md2conf
+```
+
+## Usage
+
+```ruby
+require 'md2conf'
+
+conf_xhtml = Md2conf.parse_markdown(File.read('./README.md'))
+```
+
+Contents of `conf_xhtml` is now ready to be pushed to Confluence.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pegasd/md2conf.

data/lib/md2conf.rb

@@ -0,0 +1,161 @@
+require 'md2conf/version'
+require 'redcarpet'
+require 'cgi'
+
+# Processes markdown and converts it to Confluence Storage Format.
+#
+# The main workload is done by redcarpet gem, which generates an almost ready-to-use
+# XHTML output. But there's some more magic performed by ConfluenceUtil class afterwards.
+module Md2conf
+  # ConfluenceUtil class contains various helpers for processing XHTML generated by redcarpet gem.
+  class ConfluenceUtil
+    # @param [String] html XHTML rendered by redcarpet gem (must have fenced code blocks).
+    # @param [Integer] max_toc_level Table of Contents maximum header depth.
+    def initialize(html, max_toc_level)
+      @html          = html
+      @max_toc_level = max_toc_level
+    end
+
+    # Launch all internal parsers.
+    def parse
+      process_mentions
+      convert_info_macros
+      process_code_blocks
+      add_toc
+
+      @html
+    end
+
+    # Process username mentions.
+    #
+    # Everything that starts with an `@` and is not enclosed in a code block will be converted
+    # to a valid Confluence username.
+    def process_mentions
+      html_new      = ''
+      last_position = 0
+      @html.scan(/@(\w+)/) do |mention|
+        next if inside_code_block Regexp.last_match.pre_match
+
+        confluence_code  = "<ac:link><ri:user ri:username=\"#{mention.first}\"/></ac:link>"
+        since_last_match = @html[last_position..Regexp.last_match.begin(0) - 1]
+        html_new << "#{since_last_match}#{confluence_code}"
+        last_position = Regexp.last_match.end(1)
+      end
+
+      # Did we have at least one match?
+      return unless Regexp.last_match
+      @html = html_new << if inside_code_block Regexp.last_match.pre_match
+        @html[last_position..-1]
+      else
+        Regexp.last_match.post_match
+      end
+    end
+
+    private
+    # Check whether we're inside a code block based on pre_match variable.
+    def inside_code_block(pre_match)
+      # *
+      return false unless pre_match.include? '<code'
+
+      # <code> *
+      return true unless pre_match.include? '</code>'
+
+      # <code></code> *
+      # <code></code><code> *
+      pre_match.rindex('<code') > pre_match.rindex('</code>')
+    end
+
+    # Convert Info macros to Confluence-friendly format:
+    #
+    # @example Regular informational message
+    #   > My info message
+    #
+    # @example A Note (`Note: ` will be removed from the message)
+    #   > Note: An important note
+    #
+    # @example A Warning (`Warning: ` will be removed from the message)
+    #   > Warning: An extremely important warning
+    def convert_info_macros
+      confluence_code = <<~HTML
+        <ac:structured-macro ac:name="%<macro_name>s">
+          <ac:rich-text-body>
+            %<quote>s
+          </ac:rich-text-body>
+        </ac:structured-macro>
+      HTML
+
+      @html.scan(%r{<blockquote>(.*?)</blockquote>}m).each do |quote|
+        quote = quote.first
+        if quote.include? 'Note: '
+          quote_new  = quote.strip.sub 'Note: ', ''
+          macro_name = 'note'
+        elsif quote.include? 'Warning: '
+          quote_new  = quote.strip.sub 'Warning: ', ''
+          macro_name = 'warning'
+        else
+          quote_new  = quote.strip
+          macro_name = 'info'
+        end
+        @html.sub! "<blockquote>#{quote}</blockquote>", format(confluence_code, macro_name: macro_name, quote: quote_new)
+      end
+    end
+
+    # Convert regular code blocks to Confluence code blocks.
+    # Language type is also supported.
+    #
+    # `puppet` is currently replaced by `ruby` language type.
+    def process_code_blocks
+      @html.scan(%r{<pre><code.*?>.*?</code></pre>}m).each do |codeblock|
+        content = codeblock.match(%r{<pre><code.*?>(.*?)</code></pre>}m)[1]
+        lang    = codeblock.match(/code class="(.*)"/)
+        lang    = if lang.nil?
+          'none'
+        else
+          lang[1].sub('puppet', 'ruby')
+        end
+
+        confluence_code = <<~HTML
+          <ac:structured-macro ac:name="code">
+            <ac:parameter ac:name="theme">RDark</ac:parameter>
+            <ac:parameter ac:name="linenumbers">true</ac:parameter>
+            <ac:parameter ac:name="language">#{lang}</ac:parameter>
+            <ac:plain-text-body><![CDATA[#{CGI.unescape_html content}]]></ac:plain-text-body>
+          </ac:structured-macro>
+        HTML
+
+        @html.sub! codeblock, confluence_code
+      end
+    end
+
+    # Add Table of Contents Confluence tag at the beginning.
+    #
+    # Use @max_toc_level class variable to specify maximum header depth.
+    def add_toc
+      @html = <<~HTML
+        <ac:structured-macro ac:name="toc">
+          <ac:parameter ac:name="maxLevel">#{@max_toc_level}</ac:parameter>
+        </ac:structured-macro>
+        #{@html}
+      HTML
+    end
+  end
+
+  # @example Just read a Markdown file and parse it
+  #   Md2conf.parse_markdown File.read './README.md'
+  #
+  # @param [String] markdown Markdown contents to convert to Confluence format.
+  # @param [Boolean] cut_header Whether to cut off initial header (must start with `/^# /`).
+  # @param [Integer] max_toc_level Table of Contents maximum header depth.
+  #
+  # @return [String] Confluence Storage Format document.
+  def self.parse_markdown(markdown, cut_header: true, max_toc_level: 7)
+    if cut_header && markdown.start_with?('# ')
+      markdown = markdown.lines.drop(1).join
+    end
+
+    md         = Redcarpet::Markdown.new(Redcarpet::Render::XHTML.new, tables: true, fenced_code_blocks: true, autolink: true)
+    html       = md.render(markdown)
+    confluence = ConfluenceUtil.new(html, max_toc_level)
+    confluence.parse
+  end
+end

data/lib/md2conf/version.rb

@@ -0,0 +1,3 @@
+module Md2conf
+  VERSION = '0.1.2'.freeze
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: md2conf
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Eugene Piven
+- Vladimir Tyshkevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- epiven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- README.md
+- lib/md2conf.rb
+- lib/md2conf/version.rb
+homepage: https://github.com/pegasd/md2conf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Convert Markdown to Confluence XHTML storage format
+test_files: []