bunto-mentions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6efd40b178df1e50d0ee6928344766cb96a6b403
+  data.tar.gz: a276e58657c9f2cd7404c502844c5c022bf6ed67
+SHA512:
+  metadata.gz: 629046fce4c66a9bd613ac2176c7622bb968a5aa9897728d7ab690aa73e53b384112e401e1f41b25fbe6f4e6c1b015e9630a71b3763fe33b65be414ea063e3b2
+  data.tar.gz: 6dc93b62ee64886cac0b729903b28993e953bca24d3992d4512843e4a3ae44610443706503c69fb77743ebcea574826b2dc4f5237a33a09793a89c852c0fdffa

data/lib/bunto-mentions.rb

@@ -0,0 +1,74 @@
+require 'bunto'
+require 'html/pipeline'
+
+module Bunto
+  class Mentions
+    GITHUB_DOT_COM = "https://github.com".freeze
+
+    InvalidBuntoMentionConfig = Class.new(Bunto::Errors::FatalException)
+
+    class << self
+      def mentionify(doc)
+        src = mention_base(doc.site.config)
+        doc.output = filter_with_mention(src).call(doc.output)[:output].to_s
+      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
+
+      # Public: Filters hash where the key is the mention base URL.
+      # Effectively a cache.
+      def filters
+        @filters ||= {}
+      end
+
+      # Public: Calculate the base URL to use for mentioning.
+      # The custom base URL can be defined in the config as
+      # bunto-mentions.base_url or bunto-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['bunto-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 InvalidBuntoMentionConfig,
+            "Your bunto-mentions config has to either be a" \
+            " string or a hash. It's a #{mention_config.class} right now."
+        end
+      end
+
+      # Public: Defines the conditions for a document to be emojiable.
+      #
+      # doc - the Bunto::Document or Bunto::Page
+      #
+      # Returns true if the doc is written & is HTML.
+      def mentionable?(doc)
+        (doc.is_a?(Bunto::Page) || doc.write?) &&
+          doc.output_ext == ".html" || (doc.permalink && doc.permalink.end_with?("/"))
+      end
+    end
+  end
+end
+
+Bunto::Hooks.register [:pages, :documents], :post_render do |doc|
+  Bunto::Mentions.mentionify(doc) if Bunto::Mentions.mentionable?(doc)
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bunto-mentions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- GitHub, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: rspec
+  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'
+description: 
+email: support@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bunto-mentions.rb
+homepage: https://github.com/bunto/bunto-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.2.2
+signing_key: 
+specification_version: 4
+summary: "@mention support for your Bunto site"
+test_files: []