md2conf 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99aae9ed537d6bbd435e310f1d104bb83c4cb013
-  data.tar.gz: c6c2dbfb7ab2bc0bc84627a7440785251c6106a8
+  metadata.gz: a0f39ff071ace36b7bf5019c84e20247c1eb563e
+  data.tar.gz: 39c3ce8db54264dff21f95c0c7c997ae0fd5751d
 SHA512:
-  metadata.gz: 249cc7658acf867f02cf85e878cc187562aa276c185132f2fa0eaa19b3f6b694a1494fd66e6d28b64047157bc7b539a2b782da499bbaf01956ccc47e8d9c5e5e
-  data.tar.gz: c2c54d26b897c73a699681c90f285dd12c3aedc5808ad06ad18bea910d584bf3ad7d69d8242dc9fff30f8f7ecaeb7ac5cfb59209095938d3a59f8f61748e47de
+  metadata.gz: c48b4f6bd990331be451810c312a027a4648000f54121480ca21806924c8f22535b1a0b3ca3b014bb29d9f987e256dc26ae7a9fa596d8ee420ecbee8f36b98f8
+  data.tar.gz: fdcdaa8f0abe0d9069a080bb1731a5fb67200387af1e2f72c571942923f696bd392768fbe4cf0ebd682e5fdbf368cbdf2703a91a0c92e42cf30fd8f50f083237

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.2.0] - 2017-08-29
+### Added
+- Macro support. Any macro can be specified in the form of `{MACRO:ARGUMENT}` inside your Markdown files.
+  Check out the updated README for more info.
+
+
 ## [0.1.2] - 2017-08-21
 ### Changed
 - Updated documentation.

data/README.md

@@ -24,6 +24,8 @@ $ gem install md2conf
 
 ## Usage
 
+### Basic usage
+
 ```ruby
 require 'md2conf'
 
@@ -32,6 +34,38 @@ conf_xhtml = Md2conf.parse_markdown(File.read('./README.md'))
 
 Contents of `conf_xhtml` is now ready to be pushed to Confluence.
 
+### Custom macros
+
+It is possible to set up custom macros to be processed inside your Markdown files.
+
+Macros must be specified in the format `{MACRO_NAME:MACRO_ARG}` and reside outside of code blocks.
+
+Macro definition are read from the file `~/.md2conf.yaml` inside a `macros` key:
+
+```yaml
+macros:
+  PUP: <a href="https://tickets.puppetlabs.com/browse/PUP-%<arg>s"><img src="https://img.shields.io/badge/PUP-%<arg>s-blue.svg" /></a>
+  PUPTEXT: <a href="https://tickets.puppetlabs.com/browse/PUP-%<arg>s">PUP-%<arg>s</a>
+```
+
+Having these definitions, the following macros:
+
+```markdown
+{PUP:7123} Fixed a bug
+
+{PUPTEXT:7885} Work in progress
+```
+
+will be converted to this:
+
+```html
+<a href="https://tickets.puppetlabs.com/browse/PUP-7123"><img src="https://img.shields.io/badge/PUP-7123-blue.svg" /></a> Fixed a bug
+
+<a href="https://tickets.puppetlabs.com/browse/PUP-7885">PUP-7885</a> Work in progress
+```
+
+Note the usage of `%<arg>s` - these will be replaced by the `MACRO_ARG` part that is specified inside each macro.
+
 ## 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.
@@ -40,4 +74,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pegasd/md2conf.
+Bug reports, feature and pull requests are welcome at the official GitHub [repo](https://github.com/pegasd/md2conf).

data/lib/md2conf.rb

@@ -1,6 +1,7 @@
 require 'md2conf/version'
 require 'redcarpet'
 require 'cgi'
+require 'yaml'
 
 # Processes markdown and converts it to Confluence Storage Format.
 #
@@ -11,13 +12,18 @@ module Md2conf
   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)
+    def initialize(html, max_toc_level, config_file)
       @html          = html
       @max_toc_level = max_toc_level
+      return unless File.file?(File.expand_path(config_file))
+      @config = YAML.load_file(File.expand_path(config_file))
+      return unless @config.key? 'macros'
+      @macros = @config['macros']
     end
 
     # Launch all internal parsers.
     def parse
+      process_macros if @macros
       process_mentions
       convert_info_macros
       process_code_blocks
@@ -26,6 +32,38 @@ module Md2conf
       @html
     end
 
+    # Process custom macros. Macro definitions should be placed in `~/.md2conf.yaml`.
+    # Format is described in the README.
+    #
+    # Macros are blocks that are contained in curly braces like this: `{JIRA:52837}`.
+    def process_macros
+      html_new      = ''
+      last_position = 0
+      @html.scan(/{(.*?)}/) do |macro|
+        next if inside_code_block Regexp.last_match.pre_match
+        macro_name = macro.first.split(':')[0]
+        macro_arg  = macro.first.split(':')[1]
+
+        confluence_code = if @macros.include? macro_name
+          @macros[macro_name] % { arg: macro_arg }
+        else
+          "<code>#{macro.first}</code>"
+        end
+
+        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
+
     # Process username mentions.
     #
     # Everything that starts with an `@` and is not enclosed in a code block will be converted
@@ -51,20 +89,6 @@ module Md2conf
       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
@@ -138,6 +162,21 @@ module Md2conf
         #{@html}
       HTML
     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
   end
 
   # @example Just read a Markdown file and parse it
@@ -148,14 +187,14 @@ module Md2conf
   # @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)
+  def self.parse_markdown(markdown, cut_header: true, max_toc_level: 7, config_file: '~/.md2conf.yaml')
     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 = ConfluenceUtil.new(html, max_toc_level, config_file)
     confluence.parse
   end
 end

data/lib/md2conf/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md2conf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Eugene Piven
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,8 +89,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - README.md
 - lib/md2conf.rb
 - lib/md2conf/version.rb

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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

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