html-pipeline-gitlab 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2152131cb71f56ec9919f5fd035e3f3419f2e09
-  data.tar.gz: 882d2777949b385ded5924d1d78a9c5d1b99ede7
+  metadata.gz: 761eebe497d43f7d750b204380a1a96aa97ea18a
+  data.tar.gz: 3359741032f9c25e5ad31dda0aada680ea5d9081
 SHA512:
-  metadata.gz: a2f2b7a5e95970e8a4b1c342a9bd9c39c706a00a49a5852b7200103fda226ce7fea99098a5361d197b96a1a1dde461130a09aeabae07a99e437970d2d60a9d3e
-  data.tar.gz: 299f4f94a6a33cb0d424a80662c6cbf17d3c01e6cea370209727ae06c2f65e20975122cbdba29a5134f5034745c27765111b736e83139297ff1f10ab2558a933
+  metadata.gz: bae915c13ad3623c4e788f4c8b021cee84569392095f884ad85ea6ecb1aa651f1dde1ec39c7b4e2cf0c69357a5470e5ea28162304aaca0db8457a484f2899b64
+  data.tar.gz: aead33707d35f534dee9495af9a4d581e5de332b611f3da8a5794c78c84d27090ba3ca5458aa75ee4d7ddf3365848ce81bea01ac9e846a7230dfbb93c8ea6cad

data/.travis.yml

@@ -9,3 +9,5 @@ install:
   - travis_retry bundle config build.nokogiri --use-system-libraries
   - travis_retry bundle install
 script: rake test
+notifications:
+  email: false

data/README.md

@@ -1,6 +1,11 @@
 # Html::Pipeline::Gitlab
 
-TODO: Write a gem description
+This gem implements various filters for [html-pipeline](https://github.com/jch/html-pipeline)
+ used by [GitLab](https://about.gitlab.com).
+
+## Code Status
+
+[![Build Status](https://semaphoreapp.com/api/v1/projects/b9b808be-6c72-4e76-ae62-79b3a25a022a/243365/badge.png)](https://semaphoreapp.com/razer6/html-pipeline-gitlab)
 
 ## Installation
 
@@ -18,13 +23,9 @@ Or install it yourself as:
 
     $ gem install html-pipeline-gitlab
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/html-pipeline-gitlab/fork )
+1. Fork it ( https://github.com/razer6/html-pipeline-gitlab/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/html/pipeline/gitlab/gitlab_emoji_filter.rb

@@ -5,85 +5,77 @@ require 'html/pipeline/filter'
 
 module HTML
   class Pipeline
-    # HTML filter that replaces :emoji: with images.
-    #
-    # Context:
-    #   :asset_root (required) - base url to link to emoji sprite
-    #   :asset_path (optional) - url path to link to emoji sprite. :file_name can be used as a placeholder for the sprite file name. If no asset_path is set "emoji/:file_name" is used.
-    class GitLabEmojiFilter < Filter
-      def call
-        doc.search('text()').each do |node|
-          content = node.to_html
-          next if !content.include?(':')
-          next if has_ancestor?(node, %w(pre code))
-          html = emoji_image_filter(content)
-          next if html == content
-          node.replace(html)
+    class GitLab
+      # HTML filter that replaces :emoji: with images.
+      #
+      # Context:
+      #   :asset_root (required) - base url to link to emoji sprite
+      #   :asset_path (optional) - url path to link to emoji sprite. 
+      #      :file_name can be used as a placeholder for the sprite file name. 
+      #      If no asset_path is set "emoji/:file_name" is used.
+      class GitLabEmojiFilter < Filter
+        def call
+          doc.search('text()').each do |node|
+            content = node.to_html
+            next if !content.include?(':')
+            next if has_ancestor?(node, %w(pre code))
+            html = emoji_image_filter(content)
+            next if html == content
+            node.replace(html)
+          end
+          doc
+        end
+        
+        # Implementation of validate hook.
+        # Errors should raise exceptions or use an existing validator.
+        def validate
+          needs :asset_root
         end
-        doc
-      end
-      
-      # Implementation of validate hook.
-      # Errors should raise exceptions or use an existing validator.
-      def validate
-        needs :asset_root
-      end
 
-      # Replace :emoji: with corresponding images.
-      #
-      # text - String text to replace :emoji: in.
-      #
-      # Returns a String with :emoji: replaced with images.
-      def emoji_image_filter(text)
-        return text unless text.include?(':')
+        # Replace :emoji: with corresponding images.
+        #
+        # text - String text to replace :emoji: in.
+        #
+        # Returns a String with :emoji: replaced with images.
+        def emoji_image_filter(text)
+          return text unless text.include?(':')
 
-        text.gsub(emoji_pattern) do |match|
-          name = $1
-          "<img class='emoji' title=':#{name}:' alt=':#{name}:' src='#{emoji_url(name)}' height='20' width='20' align='absmiddle' />"
+          text.gsub(emoji_pattern) do |match|
+            name = $1
+            "<img class='emoji' title=':#{name}:' alt=':#{name}:' src='#{emoji_url(name)}' height='20' width='20' align='absmiddle' />"
+          end
         end
-      end
 
-      # The base url to link emoji sprites
-      #
-      # Raises ArgumentError if context option has not been provided.
-      # Returns the context's asset_root.
-      def asset_root
-        context[:asset_root]
-      end
-
-      # The url path to link emoji sprites
-      #
-      # :file_name can be used in the asset_path as a placeholder for the sprite file name. If no asset_path is set in the context "emoji/:file_name" is used.
-      # Returns the context's asset_path or the default path if no context asset_path is given.
-      def asset_path(name)
-        if context[:asset_path]
-          context[:asset_path].gsub(":file_name", emoji_filename(name))
-        else
-          File.join("emoji", emoji_filename(name))
+        # The base url to link emoji sprites
+        #
+        # Raises ArgumentError if context option has not been provided.
+        # Returns the context's asset_root.
+        def asset_root
+          context[:asset_root]
         end
-      end
 
-      private
+        private
 
-      def emoji_url(name)
-        File.join(asset_root, asset_path(name))
-      end
+        def emoji_url(name)
+          File.join(asset_root, 'emoji', emoji_filename(name))
+        end
 
-      # Build a regexp that matches all valid :emoji: names.
-      def self.emoji_pattern
-        @emoji_pattern ||= /:(#{emoji_names.map { |name| Regexp.escape(name) }.join('|')}):/
-      end
+        # Build a regexp that matches all valid :emoji: names.
+        def self.emoji_pattern
+          @emoji_pattern ||= /:(#{emoji_names.map { |name| Regexp.escape(name) }.join('|')}):/
+        end
 
-      def emoji_pattern
-        self.class.emoji_pattern
-      end
+        def emoji_pattern
+          self.class.emoji_pattern
+        end
 
-      def self.emoji_names
-        Emoji.names
-      end
+        def self.emoji_names
+          Emoji.names
+        end
 
-      def emoji_filename(name)
-        "#{::CGI.escape(name)}.png"
+        def emoji_filename(name)
+          "#{::CGI.escape(name)}.png"
+        end
       end
     end
   end

data/lib/html/pipeline/gitlab/version.rb

@@ -1,7 +1,7 @@
 module Html
   module Pipeline
     module Gitlab
-      VERSION = "0.0.1"
+      VERSION = '0.0.2'
     end
   end
 end

data/lib/html/pipeline/gitlab.rb

@@ -1,9 +1,2 @@
-require "html/pipeline/gitlab/version"
-
-module Html
-  module Pipeline
-    module Gitlab
-      # Your code goes here...
-    end
-  end
-end
+require 'html/pipeline/gitlab/version'
+require 'html/pipeline/gitlab/gitlab_emoji_filter'

data/test/html/pipeline/gitlab_gemoji_filter_test.rb

@@ -1,26 +1,26 @@
 require 'test_helper'
-require 'html/pipeline/gitlab/gitlab_emoji_filter'
+require 'html/pipeline/gitlab'
 
 class HTML::Pipeline::GitLabEmojiFilterTest < Minitest::Test
-  GitLabEmojiFilter = HTML::Pipeline::GitLabEmojiFilter
+  GitLabEmojiFilter = HTML::Pipeline::GitLab::GitLabEmojiFilter
   
   def test_emojify
-    filter = GitLabEmojiFilter.new("<p>:heart:</p>", {:asset_root => 'https://foo.com'})
+    filter = GitLabEmojiFilter.new('<p>:heart:</p>', {asset_root: 'https://foo.com'})
     doc = filter.call
-    assert_match "https://foo.com/emoji/heart.png", doc.search('img').attr('src').value
+    assert_match 'https://foo.com/emoji/heart.png', doc.search('img').attr('src').value
   end
 
   def test_unsupported_emoji
-    block = "<p>:sheep:</p>"
-    filter = GitLabEmojiFilter.new(block, {:asset_root => 'https://foo.com'})
+    block = '<p>:sheep:</p>'
+    filter = GitLabEmojiFilter.new(block, {asset_root: 'https://foo.com'})
     doc = filter.call
     assert_match block, doc.to_html
   end
   
   def test_uri_encoding
-    filter = GitLabEmojiFilter.new("<p>:+1:</p>", {:asset_root => 'https://foo.com'})
+    filter = GitLabEmojiFilter.new('<p>:+1:</p>', {asset_root: 'https://foo.com'})
     doc = filter.call
-    assert_match "https://foo.com/emoji/%2B1.png", doc.search('img').attr('src').value
+    assert_match 'https://foo.com/emoji/%2B1.png', doc.search('img').attr('src').value
   end
   
   def test_required_context_validation
@@ -29,10 +29,4 @@ class HTML::Pipeline::GitLabEmojiFilterTest < Minitest::Test
     }
     assert_match /:asset_root/, exception.message
   end
-
-  def test_custom_asset_path
-    filter = GitLabEmojiFilter.new("<p>:+1:</p>", {:asset_path => ':file_name', :asset_root => 'https://foo.com'})
-    doc = filter.call
-    assert_match "https://foo.com/%2B1.png", doc.search('img').attr('src').value
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline-gitlab
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Schilling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler