jekyll-mentions 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de119f82d968911efc9dd29bd45b94786f8f5aee
-  data.tar.gz: 57e52a1c7b2df33f8d2b93a74331fb36f499bea8
+  metadata.gz: 3c627b00d759842a74836656d975af42eda10beb
+  data.tar.gz: 89ec283cdfa10d508e9c5853a9324b2bc7da5a02
 SHA512:
-  metadata.gz: a7350185007b5a8b1ab764747a9b4b3f240dbe5fc6da8893c91f84117e33fe10190765b36cf5c736e099e951a571a39070b867fef36303ff78b9ad53ddc43207
-  data.tar.gz: 29a45a3f2d6921050011213f03086e5136bdad8dee7e12719b71faad006eab02256372055d710b688fb80877e849b61e4d809ce02ba7eb8df2be1e0073c1376b
+  metadata.gz: 4b83bf2888de733d34a7611e15fcd712d4d69bec82e131a6b4a5f8f8f4987a4851745df8a3fae91f97c04dee5dd4f2917941b9c53dc04b7cbe63bd8b0977735a
+  data.tar.gz: 1a83a5c422315eff654a828e3d223bb7fc98b951519a09294b0f5a2fb215c9c8e196baeca6e449f7beb0dff539ba3861bb444e3cf5f06db786efd8d021c998ec

data/lib/jekyll-mentions.rb

@@ -2,40 +2,73 @@ require 'jekyll'
 require 'html/pipeline'
 
 module Jekyll
-  class Mentions < Jekyll::Generator
-    safe true
+  class Mentions
+    GITHUB_DOT_COM = "https://github.com".freeze
 
-    DEFAULT_URL = "https://github.com"
+    InvalidJekyllMentionConfig = Class.new(Jekyll::Errors::FatalException)
 
-    def initialize(config = Hash.new)
-      @filter = HTML::Pipeline::MentionFilter.new(nil, {:base_url => base_url(config['jekyll-mentions']) })
-    end
+    class << self
+      def mentionify(doc)
+        src = mention_base(doc.site.config)
+        doc.output = filter_with_mention(src).call(doc.output)[:output].to_s
+      end
 
-    def generate(site)
-      site.pages.each { |page| mentionify page if html_page?(page) }
-      site.docs_to_write.each { |doc| mentionify doc }
-    end
+      # Public: Create or fetch the filter for the given {{src}} base URL.
+      #
+      # src - the base URL (e.g. https://github.com)
+      #
+      # Returns an HTML::Pipeline instance for the given base URL.
+      def filter_with_mention(src)
+        filters[src] ||= HTML::Pipeline.new([
+          HTML::Pipeline::MentionFilter
+        ], { :base_url => src })
+      end
 
-    def mentionify(page)
-      return unless page.content.include?('@')
-      page.content = @filter.mention_link_filter(page.content)
-    end
+      # Public: Filters hash where the key is the mention base URL.
+      # Effectively a cache.
+      def filters
+        @filters ||= {}
+      end
 
-    def html_page?(page)
-      page.html? || page.url.end_with?('/')
-    end
+      # Public: Calculate the base URL to use for mentioning.
+      # The custom base URL can be defined in the config as
+      # jekyll-mentions.base_url or jekyll-mentions, and must
+      # be a valid URL (i.e. it must include a protocol and valid domain)
+      # It should _not_ have a trailing slash.
+      #
+      # config - the hash-like configuration of the document's site
+      #
+      # Returns a URL to use as the base URL for mentions.
+      # Defaults to the https://github.com.
+      def mention_base(config = {})
+        mention_config = config['jekyll-mentions']
+        case mention_config
+        when nil, NilClass
+          GITHUB_DOT_COM
+        when String
+          mention_config.to_s
+        when Hash
+          mention_config.fetch('base_url', GITHUB_DOT_COM)
+        else
+          raise InvalidJekyllMentionConfig,
+            "Your jekyll-mentions config has to either be a" \
+            " string or a hash. It's a #{mention_config.class} right now."
+        end
+      end
 
-    def base_url(configs)
-      case configs
-      when nil, NilClass
-        DEFAULT_URL
-      when String
-        configs.to_s
-      when Hash
-        configs.fetch('base_url', DEFAULT_URL)
-      else
-        raise ArgumentError.new("Your jekyll-mentions config has to either be a string or a hash! It's a #{configs.class} right now.")
+      # Public: Defines the conditions for a document to be emojiable.
+      #
+      # doc - the Jekyll::Document or Jekyll::Page
+      #
+      # Returns true if the doc is written & is HTML.
+      def mentionable?(doc)
+        (doc.class == Jekyll::Page || doc.write?) &&
+          doc.output_ext == ".html" || (doc.permalink && doc.permalink.end_with?("/"))
       end
     end
   end
 end
+
+Jekyll::Hooks.register [:pages, :documents], :post_render do |doc|
+  Jekyll::Mentions.mentionify(doc) if Jekyll::Mentions.mentionable?(doc)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-mentions
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - GitHub, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -67,33 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  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: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: 
 email: support@github.com
 executables: []
@@ -121,9 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: "@mention support for your Jekyll site"
 test_files: []
-has_rdoc: