jekyll-commit-mentions 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3a0dc4eb6f161ded768904fcc66efa9de0c1fbe
-  data.tar.gz: 16cc8173db3ab806c79ed080ce293d17718189bb
+  metadata.gz: 87ffeea732e0618fa4f7e37aa4ce263516300bf0
+  data.tar.gz: aa3e8bc25e70d06ceebbacb78a823a7c89dc1b46
 SHA512:
-  metadata.gz: d3b924783e47e064af1409ca22932e7987ea2c018e24b3757b48d4d21e6acf731d3094836cc1c9d98c585f8ced0b7c0abebb741cc8a2df02a711f0a50837f6b3
-  data.tar.gz: 7db3165bae90bdb3b82b7c6194836db498fb3f0a9eebe7cf85138a822abcc81bd31515de9ea28d21b0d82e5cb7c234fafb9cafa6cb7e9cf6edeeb516c32266f0
+  metadata.gz: 302339310c9fd3c999af178b3d049ba874ea77b13ba273a38a468eee9654f5e497a8b2fc435768868dcc3927bfbe30394bb9461d84af7c8138807fc0f16fb778
+  data.tar.gz: 62473ed2b2f6fe1f4f8fc7bd49ea8f699c5ebfd242c3e1890a58a68bebd97c708bf2f0e827f27f18240a604f51d0404fc56f683557fdf360c57f6a221ed9367a

data/lib/commit_mention_filter.rb

@@ -2,16 +2,16 @@ require 'set'
 
 module HTML
   class Pipeline
-    # HTML filter that replaces #mention mentions with links to Github issue. Mentions within <pre>,
+    # HTML filter that replaces mention mentions with links to Github commit. Mentions within <pre>,
     # <code>, <style> and <a> elements are ignored.
     #
     # Context options:
-    #   :base_url - Used to construct links to issue page for each mention.
+    #   :base_url - Used to construct links to commit page for each mention.
     #   :commitid_pattern - Used to provide a custom regular expression to
-    #                       identify issue ids
+    #                       identify commit ids
     #
     class CommitMentionFilter < Filter
-      # Public: Find issue #mention in text.  See
+      # Public: Find commit mention in text.  See
       # CommitMentionFilter#mention_link_filter.
       #
       #   CommitMentionFilter.mentioned_commits_in(text) do |match, commitid|
@@ -49,17 +49,17 @@ module HTML
 
       # Default pattern used to extract commitid from text. The value can be
       # overriden by providing the commitid_pattern variable in the context.
-      CommitidPattern = /[0-9a-f]{7,40}/
+      CommitidPattern = /[0-9a-f]{40}/
 
       # Don't look for mentions in text nodes that are children of these elements
-      IGNORE_PARENTS = %w(pre code a style).to_set
+      IGNORE_PARENTS = %w(pre code a style script).to_set
 
       def call
         result[:mentioned_commitids] ||= []
 
         doc.search('text()').each do |node|
           content = node.to_html
-          next if !content.match(CommitidPattern)
+          next if !content.match(commitid_pattern)
           next if has_ancestor?(node, IGNORE_PARENTS)
           html = mention_link_filter(content, base_url, commitid_pattern)
           next if html == content
@@ -72,33 +72,32 @@ module HTML
         context[:commitid_pattern] || CommitidPattern
       end
 
-      # Replace issue #mentions in text with links to the mentioned
-      # issue's page.
+      # Replace commit mentions in text with links to the mentioned
+      # commit's page.
       #
-      # text      - String text to replace #mention commitids in.
-      # base_url  - The base URL used to construct issue page URLs.
+      # text      - String text to replace mention commitids in.
+      # base_url  - The base URL used to construct commit page URLs.
       # commitid_pattern  - Regular expression used to identify commitid in
       #                     text
       #
       # Returns a string with #commitid replaced with links. All links have a
-      # 'issue-mention' class name attached for styling.
+      # 'commit-mention' class name attached for styling.
       def mention_link_filter(text, base_url='/', commitid_pattern)
         self.class.mentioned_commits_in(text, commitid_pattern) do |match, commitid|
-          link = link_to_mentioned_issue(commitid)
+          link = link_to_mentioned_commit(commitid)
           link ? match.sub("#{commitid}", link) : match
         end
       end
 
-      def link_to_mentioned_issue(commitid)
+      def link_to_mentioned_commit(commitid)
         result[:mentioned_commitids] |= [commitid]
 
         url = base_url.dup
         url << "/" unless url =~ /[\/~]\z/
+        url << commitid
         shortid = commitid[-7..-1] || commitid
 
-        "<a href='#{url << commitid}' class='commit-mention'>" +
-        "#{shortid}" +
-        "</a>"
+        "<a href='#{url}' class='commit-mention'>#{shortid}</a>"
       end
     end
   end

data/lib/jekyll-commit-mentions.rb

@@ -3,11 +3,12 @@ require 'html/pipeline'
 require 'commit_mention_filter'
 
 module Jekyll
-  class IssueMentions < Jekyll::Generator
+  class CommitMentions < Jekyll::Generator
     safe true
+    attr_reader :base_url
 
     def initialize(config = Hash.new)
-      @filter = HTML::Pipeline::CommitMentionFilter.new(nil, {:base_url => base_url(config['jekyll-issue-mentions']) })
+      validate_config!(config)
     end
 
     def generate(site)
@@ -17,30 +18,34 @@ module Jekyll
     end
 
     def mentionify(page)
-      return if !page.content.match(@filter.commitid_pattern)
-      page.content = @filter.mention_link_filter(page.content, @filter.base_url, @filter.commitid_pattern)
+      @filter = HTML::Pipeline::CommitMentionFilter.new(page.content, {:base_url => base_url})
+      page.content = @filter.call.to_s.
+        gsub("&gt;", ">").
+        gsub("&lt;", "<").
+        gsub("%7B", "{").
+        gsub("%20", " ").
+        gsub("%7D", "}")
     end
 
     def html_page?(page)
       page.html? || page.url.end_with?('/')
     end
 
-    def base_url(configs)
+  private
+    def validate_config!(configs)
+      configs = configs['jekyll-commit-mentions']
+      base_url = nil
       case configs
-      when nil, NilClass
-        raise ArgumentError.new("Your jekyll-issue-mentions config has to configured.")
       when String
-        configs.to_s
+        base_url = configs
       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
+      error_prefix = "jekyll-commit-mentions"
+      raise ArgumentError.new("#{error_prefix}.base_url is missing/empty") if (base_url.nil? || base_url.empty?)
+
+      @base_url = base_url
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-commit-mentions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - harish shetty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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