jekyll-mentioji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f7969c91c7033c67e9327d2cb3dac8687bc30bd
+  data.tar.gz: a61f334384fc26db61b2adf0a9996768f55a02c9
+SHA512:
+  metadata.gz: 6ecf13698e63ef1cd5ce1565108e0d678b5f3610086456202fcb9091594706ae79467e0cd750200ade2d7a6344f029be16ddf0ecbb517a773b9fb6409fad39f6
+  data.tar.gz: 8b04cc659afae2e1f9666c9b5ca9be95444351da0e5b38ca3260b757be43310219f0717f630524222daf65518c1072600b75bef623d841533dcb769d25f2f4be

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2018 Ashwin Maroli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Jekyll Mentioji
+
+If your site uses both [`jekyll-mentions`](https://github.com/jekyll/jekyll-mentions) and [`jemoji`](https://github.com/jekyll/jemoji), then
+using `jekyll-mentioji` *instead*, is going to improve your build times.
+
+Internally, this plugin combines the code & logic behind the above two plugins and adapts the associated code in
+[`html-pipeline`](https://github.com/jch/html-pipeline), which the above two plugins wrap around, to emerge as *the faster implementation*
+in comparison to using the two plugins together in a site.
+
+## Usage
+
+Replace the two plugins in your `Gemfile` and/or `_config.yml` with this plugin:
+
+```diff
+# Gemfile
+
+group :jekyll_plugins do
+-   gem "jekyll-mentions"
+-   gem "jemoji"
++   gem "jekyll-mentioji"
+end
+```
+```sh
+bundle install
+```
+```diff
+# _config.yml
+
+plugins:
+-   - jekyll-mentions
+-   - jemoji
++   - jekyll-mentioji
+```
+
+## Other Notes:
+
+  - This plugin aims to be a zero-config replacement for the two plugins and therefore should be compatible with existing configuration
+  for the two plugins. `jekyll-mentioji` will read both existing `jekyll-mentions:` and `emoji:` settings in your config file.
+  - A few diversions from the two official plugins:
+      - `@mention` can currently include the underscore (`_`) along with alphanumeric characters and hyphen (`-`)
+      - `@mention` will not be rendered within `<script></script>`
+      - configuration for emoji assets-path mirror that of `jekyll-mentions`: the value can be both a string or a dictionary
+
+### Build times comparison
+
+rvm   | jmentions+jemoji | *jmentioji*
+:---: | :----: | :------:
+2.2.9 | 15.482 | *13.671*
+2.3.6 | 13.798 | *11.988*
+2.4.3 | 14.225 | *12.848*
+2.5.0 | 14.560 | *12.771*
+
+(built using `jekyll:master@c7f006`)
+
+*Disclaimer: The no.s above are averages of 3 restarted jobs on two separate Travis CI build-commits and therefore cannot be considered as
+solid evidence. However, tests run locally do show an improvement of approx. 2s with `jekyll-mentioji` over the combo.*

data/lib/jekyll-mentioji.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require "gemoji"
+require "nokogiri"
+
+module Jekyll
+  class Mentioji
+    MENTIONPATTERNS = %r~(?:^|\B)@((?>[\w][\w-]*))(?!/)(?=\.+[ \t\W]|\.+$|[^\w.]|$)~i
+
+    OPENING_BODY_TAG_REGEX = %r!<body(.*?)>\s*!
+
+    IGNORE_MENTION_PARENTS = %w(pre code a script style).freeze
+    IGNORE_EMOJI_PARENTS = %w(pre code tt).freeze
+
+    class << self
+      def transform(doc)
+        content = doc.output
+        return unless content.include?("@") || content.include?(":")
+        setup_transformer(doc.site.config)
+        doc.output = if content.include?("<body")
+                       process_html_body(content)
+                     else
+                       process(content)
+                     end
+      end
+
+      def transformable?(doc)
+        (doc.is_a?(Jekyll::Page) || doc.write?) &&
+          doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
+      end
+
+      private
+
+      def process_html_body(content)
+        head, opener, tail  = content.partition(OPENING_BODY_TAG_REGEX)
+        body_content, *rest = tail.partition("</body>")
+
+        String.new(head) << opener << process(body_content) << rest.join
+      end
+
+      def process(body_content)
+        return body_content unless body_content =~ prelim_check_regex
+        parsed_body = Nokogiri::HTML::DocumentFragment.parse(body_content)
+        parsed_body.search(".//text()").each do |node|
+          content = node.text
+          next if !content.include?("@") && !content.include?(":")
+          node.replace(
+            mention_renderer(
+              node, emoji_renderer(node, content)
+            )
+          )
+        end
+        parsed_body.to_html
+      end
+
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def setup_transformer(config)
+        @transconfig ||= {
+          "mention_base" => compute_base(
+            config, "jekyll-mentions", "base_url", default_mention_base
+          ),
+          "emoji_source" => compute_base(
+            config, "emoji", "src", default_asset_root
+          ),
+        }
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      def compute_base(config, key, subkey, default_value)
+        subject = config[key]
+        case subject
+        when nil, NilClass
+          default_value
+        when String
+          subject
+        when Hash
+          subject.fetch(subkey, default_value)
+        else
+          raise TypeError, "Your #{key} config has to either be a string or a hash. It's a " \
+            "kind of #{subject.class} right now."
+        end
+      end
+
+      def default_mention_base
+        if !ENV["SSL"].to_s.empty? && !ENV["GITHUB_HOSTNAME"].to_s.empty?
+          scheme = ENV["SSL"] == "true" ? "https://" : "http://"
+          "#{scheme}#{ENV["GITHUB_HOSTNAME"].chomp("/")}"
+        else
+          "https://github.com"
+        end
+      end
+
+      def default_asset_root
+        if ENV["ASSET_HOST_URL"].to_s.empty?
+          File.join("https://assets-cdn.github.com", "/images/icons")
+        else
+          File.join(ENV["ASSET_HOST_URL"], "/images/icons")
+        end
+      end
+
+      def mention_markup(username)
+        mention_stash[username] ||= begin
+          "<a href='#{@transconfig["mention_base"]}/#{username}' " \
+          "class='user-mention'>@#{username}</a>"
+        end
+      end
+
+      def mention_renderer(node, text)
+        return text unless text.include?("@")
+        return text if has_ancestor?(node, IGNORE_MENTION_PARENTS)
+        text.gsub(MENTIONPATTERNS) { mention_markup(Regexp.last_match(1)) }
+      end
+
+      def emoji_renderer(node, text)
+        return text unless text.include?(":")
+        return text if has_ancestor?(node, IGNORE_EMOJI_PARENTS)
+        text.gsub(emoji_pattern) { emoji_markup(Regexp.last_match(1)) }
+      end
+
+      def emoji_url(name)
+        File.join(
+          @transconfig["emoji_source"], "emoji",
+          ::Emoji.find_by_alias(name).image_filename
+        )
+      end
+
+      def emoji_markup(name)
+        emoji_stash[name] ||= begin
+          attrs = []
+          img_attrs(name).each do |key, value|
+            attrs << "#{key}='#{value}'"
+          end
+          "<img #{attrs.join(" ")}>"
+        end
+      end
+
+      def img_attrs(name)
+        {
+          "class"  => "emoji",
+          "title"  => ":#{name}:",
+          "alt"    => ":#{name}:",
+          "src"    => emoji_url(name).to_s,
+          "height" => "20",
+          "width"  => "20",
+        }
+      end
+
+      def mention_stash
+        @mention_stash ||= {}
+      end
+
+      def emoji_stash
+        @emoji_stash ||= {}
+      end
+
+      def emoji_names
+        ::Emoji.all.flat_map(&:aliases).sort!.map! { |name| Regexp.escape(name) }
+      end
+
+      def emoji_pattern
+        @emoji_pattern ||= %r!:(#{emoji_names.join('|')}):!
+      end
+
+      def prelim_check_regex
+        @prelim_check_regex ||= %r!#{MENTIONPATTERNS}|#{emoji_pattern}!
+      end
+
+      # rubocop:disable Naming/PredicateName
+      def has_ancestor?(node, tags)
+        while (node = node.respond_to?(:parent) && node.parent)
+          break true if tags.include?(node.name.downcase)
+        end
+      end
+      # rubocop:enable Naming/PredicateName
+    end
+  end
+end
+
+Jekyll::Hooks.register([:pages, :documents], :post_render) do |doc|
+  Jekyll::Mentioji.transform(doc) if Jekyll::Mentioji.transformable?(doc)
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-mentioji
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-mentions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Improve build times for sites using both 'jekyll-mentions and 'jemoji'
+  plugins
+email:
+- ashmaroli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-mentioji.rb
+homepage: https://github.com/ashmaroli/jekyll-mentioji
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Faster version of the 'Jekyll::Mentions + Jekyll::Emoji' combo
+test_files: []