jekyll-issue-mentions 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b953ba404a6d187573847e00b59b7b1a2de31c6d
+  data.tar.gz: 9fe7280e38a240006de05b0d7f3f4cd6dd3f4fa2
+SHA512:
+  metadata.gz: 0f4b6b5bbc0feaf6409ed460c51470fbecc369c57822389ebc9e230293949f43ee95a3c620a0bfa1c21f0df7f6945d6a025fa37cff580ea125fe1f3a069e048c
+  data.tar.gz: a2f0f2e4a693dcd31e74f0cad0f1dc9f43eaafd79c0780c70c24c9e7c12e2ec7aec2597d7e69563510655a26ef67d0671c3d83a206e9a4b8f2b9304ca46c2820

data/lib/issue_mention_filter.rb

@@ -0,0 +1,104 @@
+require 'set'
+
+module HTML
+  class Pipeline
+    # HTML filter that replaces #mention mentions with links to Github issue. Mentions within <pre>,
+    # <code>, <style> and <a> elements are ignored.
+    #
+    # Context options:
+    #   :base_url - Used to construct links to issue page for each mention.
+    #   :issueid_pattern - Used to provide a custom regular expression to
+    #                       identify issue ids
+    #
+    class IssueMentionFilter < Filter
+      # Public: Find issue #mention in text.  See
+      # IssueMentionFilter#mention_link_filter.
+      #
+      #   IssueMentionFilter.mentioned_issues_in(text) do |match, issueid|
+      #     "<a href=...>#{issueid}</a>"
+      #   end
+      #
+      # text - String text to search.
+      #
+      # Yields the String match, the String issueid.  The yield's return replaces the match in
+      # the original text.
+      #
+      # Returns a String replaced with the return of the block.
+      def self.mentioned_issues_in(text, issueid_pattern=IssueidPattern)
+        text.gsub MentionPatterns[issueid_pattern] do |match|
+          issueid = $1
+          yield match, issueid
+        end
+      end
+
+
+      # Hash that contains all of the mention patterns used by the pipeline
+      MentionPatterns = Hash.new do |hash, key|
+        hash[key] = /
+          (?:^|\W)                    # beginning of string or non-word char
+          \#((?>#{key}))              # #issueid
+          (?!\/)                      # without a trailing slash
+          (?=
+            \.+[ \t\W]|               # dots followed by space or non-word character
+            \.+$|                     # dots at end of line
+            [^0-9a-zA-Z_.]|           # non-word character except dot
+            $                         # end of line
+          )
+        /ix
+      end
+
+      # Default pattern used to extract issueid from text. The value can be
+      # overriden by providing the issueid_pattern variable in the context.
+      IssueidPattern = /[0-9][0-9-]*/
+
+      # Don't look for mentions in text nodes that are children of these elements
+      IGNORE_PARENTS = %w(pre code a style).to_set
+
+      def call
+        result[:mentioned_issueids] ||= []
+
+        doc.search('text()').each do |node|
+          content = node.to_html
+          next if !content.include?('#')
+          next if has_ancestor?(node, IGNORE_PARENTS)
+          html = mention_link_filter(content, base_url, issueid_pattern)
+          next if html == content
+          node.replace(html)
+        end
+        doc
+      end
+
+      def issueid_pattern
+        context[:issueid_pattern] || IssueidPattern
+      end
+
+      # Replace issue #mentions in text with links to the mentioned
+      # issue's page.
+      #
+      # text      - String text to replace #mention issueids in.
+      # base_url  - The base URL used to construct issue page URLs.
+      # issueid_pattern  - Regular expression used to identify issueid in
+      #                     text
+      #
+      # Returns a string with #issueid replaced with links. All links have a
+      # 'issue-mention' class name attached for styling.
+      def mention_link_filter(text, base_url='/', issueid_pattern)
+        self.class.mentioned_issues_in(text, issueid_pattern) do |match, issueid|
+          link = link_to_mentioned_issue(issueid)
+          link ? match.sub("\##{issueid}", link) : match
+        end
+      end
+
+      def link_to_mentioned_issue(issueid)
+        result[:mentioned_issueids] |= [issueid]
+
+        url = base_url.dup
+        url << "/" unless url =~ /[\/~]\z/
+
+        "<a href='#{url << issueid}' class='issue-mention'>" +
+        "\##{issueid}" +
+        "</a>"
+      end
+    end
+  end
+end

data/lib/jekyll-issue-mentions.rb

@@ -0,0 +1,46 @@
+require 'jekyll'
+require 'html/pipeline'
+require 'issue_mention_filter'
+
+module Jekyll
+  class IssueMentions < Jekyll::Generator
+    safe true
+
+    def initialize(config = Hash.new)
+      @filter = HTML::Pipeline::IssueMentionFilter.new(nil, {:base_url => base_url(config['jekyll-issue-mentions']) })
+    end
+
+    def generate(site)
+      site.pages.each { |page| mentionify page if html_page?(page) }
+      site.posts.each { |post| mentionify post }
+      site.docs_to_write.each { |doc| mentionify doc }
+    end
+
+    def mentionify(page)
+      return unless page.content.include?('#')
+      page.content = @filter.mention_link_filter(page.content, @filter.base_url, @filter.issueid_pattern)
+    end
+
+    def html_page?(page)
+      page.html? || page.url.end_with?('/')
+    end
+
+    def base_url(configs)
+      case configs
+      when nil, NilClass
+        raise ArgumentError.new("Your jekyll-issue-mentions config has to configured.")
+      when String
+        configs.to_s
+      when Hash
+        base_url = configs['base_url']
+        if base_url.nil?
+          raise ArgumentError.new("Your jekyll-issue-mentions is missing base_url configuration.")
+        else
+          base_url
+        end
+      else
+        raise ArgumentError.new("Your jekyll-issue-mentions config has to either be a string or a hash! It's a #{configs.class} right now.")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-issue-mentions
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Harish Shetty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.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: rdoc
+  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: shoulda
+  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: minitest
+  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'
+description: 
+email: support@workato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/issue_mention_filter.rb
+- lib/jekyll-issue-mentions.rb
+homepage: https://github.com/workato/jekyll-issue-mentions
+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.4.6
+signing_key: 
+specification_version: 4
+summary: "#issueid support for your Jekyll site"
+test_files: []