html-pipeline-gitlab 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2152131cb71f56ec9919f5fd035e3f3419f2e09
+  data.tar.gz: 882d2777949b385ded5924d1d78a9c5d1b99ede7
+SHA512:
+  metadata.gz: a2f2b7a5e95970e8a4b1c342a9bd9c39c706a00a49a5852b7200103fda226ce7fea99098a5361d197b96a1a1dde461130a09aeabae07a99e437970d2d60a9d3e
+  data.tar.gz: 299f4f94a6a33cb0d424a80662c6cbf17d3c01e6cea370209727ae06c2f65e20975122cbdba29a5134f5034745c27765111b736e83139297ff1f10ab2558a933

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+before_install:
+  - sudo apt-get install -y libicu-dev
+install:
+  - travis_retry bundle config build.nokogiri --use-system-libraries
+  - travis_retry bundle install
+script: rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html-pipeline-gitlab.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Schilling
+
+MIT License
+
+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,31 @@
+# Html::Pipeline::Gitlab
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-gitlab'
+```
+
+And then execute:
+
+    $ bundle
+
+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 )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/html-pipeline-gitlab.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/gitlab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'html-pipeline-gitlab'
+  spec.version       = Html::Pipeline::Gitlab::VERSION
+  spec.authors       = ['Robert Schilling']
+  spec.email         = ['schilling.ro@gmail.com']
+  spec.summary       = %q{Extension filters for html-pipeline used by GitLab}
+  spec.description   = %q{Extension filters for html-pipeline used by GitLab}
+  spec.homepage      = 'https://github.com/Razer6/html-pipeline-gitlab'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'html-pipeline', '~> 1.9.0'
+  spec.add_runtime_dependency 'gitlab_emoji', '~> 0.0.1.1'
+end

data/lib/html/pipeline/gitlab.rb

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

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

@@ -0,0 +1,90 @@
+require 'cgi'
+require 'gitlab_emoji'
+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)
+        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?(':')
+
+        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
+
+      # 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))
+        end
+      end
+
+      private
+
+      def emoji_url(name)
+        File.join(asset_root, asset_path(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
+
+      def emoji_pattern
+        self.class.emoji_pattern
+      end
+
+      def self.emoji_names
+        Emoji.names
+      end
+
+      def emoji_filename(name)
+        "#{::CGI.escape(name)}.png"
+      end
+    end
+  end
+end

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

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

data/test/html/pipeline/gitlab_gemoji_filter_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'html/pipeline/gitlab/gitlab_emoji_filter'
+
+class HTML::Pipeline::GitLabEmojiFilterTest < Minitest::Test
+  GitLabEmojiFilter = HTML::Pipeline::GitLabEmojiFilter
+  
+  def test_emojify
+    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
+  end
+
+  def test_unsupported_emoji
+    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'})
+    doc = filter.call
+    assert_match "https://foo.com/emoji/%2B1.png", doc.search('img').attr('src').value
+  end
+  
+  def test_required_context_validation
+    exception = assert_raises(ArgumentError) { 
+      GitLabEmojiFilter.call("", {}) 
+    }
+    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

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'html/pipeline'
+require 'minitest/autorun'
+
+require 'active_support/core_ext/string'
+
+module TestHelpers
+  # Asserts that two html fragments are equivalent. Attribute order
+  # will be ignored.
+  def assert_equal_html(expected, actual)
+    assert_equal Nokogiri::HTML::DocumentFragment.parse(expected).to_hash,
+                 Nokogiri::HTML::DocumentFragment.parse(actual).to_hash
+  end
+end
+
+Minitest::Test.send(:include, TestHelpers)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-gitlab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Schilling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: gitlab_emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1.1
+description: Extension filters for html-pipeline used by GitLab
+email:
+- schilling.ro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- html-pipeline-gitlab.gemspec
+- lib/html/pipeline/gitlab.rb
+- lib/html/pipeline/gitlab/gitlab_emoji_filter.rb
+- lib/html/pipeline/gitlab/version.rb
+- test/html/pipeline/gitlab_gemoji_filter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Razer6/html-pipeline-gitlab
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Extension filters for html-pipeline used by GitLab
+test_files:
+- test/html/pipeline/gitlab_gemoji_filter_test.rb
+- test/test_helper.rb