html-pipeline 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e3b868abc13fac903776f091b0e0e5111c3f2fb
-  data.tar.gz: 52048ee1cf9300f16e37c1a4b11c009a8dabf441
+  metadata.gz: c80ec3a729612072c5bf7e4042b86062f189a490
+  data.tar.gz: 1af2da4c0dfb19235124be8ca3caafc940b4ab5a
 SHA512:
-  metadata.gz: b51c354c77f8e6f25f7e25a512e1b4d93274b447597929d9562dedc3537b4b94c02f5b5adbfa48e75a592b200fd5bb542c412100f61df569b8faf6054dd9ce39
-  data.tar.gz: 308a373470a7f7f935df533e99a045d1b47c02805d70a2f14983a7844cb8a71760c33420287d3b012e2aeb891563f7b4e41606c94d5edb8a81b73c20daa7882a
+  metadata.gz: 5ebe5a48f81aa9f84c65ff11404f3239a65d385faac96518cc9b0a11989012e93c988bcf2a7a0577bca82b4dc7a88b17c5bdcfdecb9c67bd07c23239419deafd
+  data.tar.gz: e901ad26193941fafc158e6041a40d6049b4edc850167740b809581fcc62270d3a82014b8a40be1e30b323fa6ea0b3e573307c009fe7f14d2bf3374dcb930e10

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.8.0
+
+  * Add custom path support for EmojiFilter #122 bradly
+  * Reorganize README and add table of contents #118 simeonwillbanks
+
 ## 1.7.0
 
   * SanitizationFilter whitelists <s> and <strike> elements #120 charliesome

data/README.md

@@ -5,6 +5,19 @@ framework for defining DOM based content filters and applying them to user
 provided content. Read an introduction about this project in
 [this blog post](https://github.com/blog/1311-html-pipeline-chainable-content-filters).
 
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Examples](#examples)
+- [Filters](#filters)
+- [Dependencies](#dependencies)
+- [Documentation](#documentation)
+- [Extending](#extending)
+  - [3rd Party Extensions](#3rd-party-extensions)
+- [Instrumenting](#instrumenting)
+- [Contributing](#contributing)
+  - [Contributors](#contributors)
+  - [Releasing A New Version](#releasing-a-new-version)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -83,56 +96,7 @@ filter = HTML::Pipeline::MarkdownFilter.new("Hi **world**!", :gfm => false)
 filter.call
 ```
 
-## Filters
-
-* `MentionFilter` - replace `@user` mentions with links
-* `AbsoluteSourceFilter` - replace relative image urls with fully qualified versions
-* `AutolinkFilter` - auto_linking urls in HTML
-* `CamoFilter` - replace http image urls with [camo-fied](https://github.com/atmos/camo) https versions
-* `EmailReplyFilter` - util filter for working with emails
-* `EmojiFilter` - everyone loves [emoji](http://www.emoji-cheat-sheet.com/)!
-* `HttpsFilter` - HTML Filter for replacing http github urls with https versions.
-* `ImageMaxWidthFilter` - link to full size image for large images
-* `MarkdownFilter` - convert markdown to html
-* `PlainTextInputFilter` - html escape text and wrap the result in a div
-* `SanitizationFilter` - whitelist sanitize user markup
-* `SyntaxHighlightFilter` - [code syntax highlighter](#syntax-highlighting)
-* `TextileFilter` - convert textile to html
-* `TableOfContentsFilter` - anchor headings with name attributes and generate Table of Contents html unordered list linking headings
-
-## Dependencies
-
-Filter gem dependencies are not bundled; you must bundle the filter's gem
-dependencies. The below list details filters with dependencies. For example,
-`SyntaxHighlightFilter` uses [github-linguist](https://github.com/github/linguist)
-to detect and highlight languages. For example, to use the `SyntaxHighlightFilter`,
-add the following to your Gemfile:
-
-```ruby
-gem 'github-linguist'
-```
-
-* `AutolinkFilter` - `rinku`
-* `EmailReplyFilter` - `escape_utils`, `email_reply_parser`
-* `EmojiFilter` - `gemoji`
-* `MarkdownFilter` - `github-markdown`
-* `PlainTextInputFilter` - `escape_utils`
-* `SanitizationFilter` - `sanitize`
-* `SyntaxHighlightFilter` - `github-linguist`
-* `TextileFilter` - `RedCloth`
-
-_Note:_ See [Gemfile](/Gemfile) `:test` block for version requirements.
-
-## 3rd Party Extensions
-
-If you have an idea for a filter, propose it as
-[an issue](https://github.com/jch/html-pipeline/issues) first. This allows us discuss
-whether the filter is a common enough use case to belong in this gem, or should be
-built as an external gem.
-
-* [html-pipeline-asciidoc_filter](https://github.com/asciidoctor/html-pipeline-asciidoc_filter) - asciidoc support
-
-## Examples
+### Examples
 
 We define different pipelines for different parts of our app. Here are a few
 paraphrased snippets to get you started:
@@ -187,6 +151,50 @@ EmojiPipeline = Pipeline.new [
 ], context
 ```
 
+## Filters
+
+* `MentionFilter` - replace `@user` mentions with links
+* `AbsoluteSourceFilter` - replace relative image urls with fully qualified versions
+* `AutolinkFilter` - auto_linking urls in HTML
+* `CamoFilter` - replace http image urls with [camo-fied](https://github.com/atmos/camo) https versions
+* `EmailReplyFilter` - util filter for working with emails
+* `EmojiFilter` - everyone loves [emoji](http://www.emoji-cheat-sheet.com/)!
+* `HttpsFilter` - HTML Filter for replacing http github urls with https versions.
+* `ImageMaxWidthFilter` - link to full size image for large images
+* `MarkdownFilter` - convert markdown to html
+* `PlainTextInputFilter` - html escape text and wrap the result in a div
+* `SanitizationFilter` - whitelist sanitize user markup
+* `SyntaxHighlightFilter` - [code syntax highlighter](#syntax-highlighting)
+* `TextileFilter` - convert textile to html
+* `TableOfContentsFilter` - anchor headings with name attributes and generate Table of Contents html unordered list linking headings
+
+## Dependencies
+
+Filter gem dependencies are not bundled; you must bundle the filter's gem
+dependencies. The below list details filters with dependencies. For example,
+`SyntaxHighlightFilter` uses [github-linguist](https://github.com/github/linguist)
+to detect and highlight languages. For example, to use the `SyntaxHighlightFilter`,
+add the following to your Gemfile:
+
+```ruby
+gem 'github-linguist'
+```
+
+* `AutolinkFilter` - `rinku`
+* `EmailReplyFilter` - `escape_utils`, `email_reply_parser`
+* `EmojiFilter` - `gemoji`
+* `MarkdownFilter` - `github-markdown`
+* `PlainTextInputFilter` - `escape_utils`
+* `SanitizationFilter` - `sanitize`
+* `SyntaxHighlightFilter` - `github-linguist`
+* `TextileFilter` - `RedCloth`
+
+_Note:_ See [Gemfile](/Gemfile) `:test` block for version requirements.
+
+## Documentation
+
+Full reference documentation can be [found here](http://rubydoc.info/gems/html-pipeline/frames).
+
 ## Extending
 To write a custom filter, you need a class with a `call` method that inherits
 from `HTML::Pipeline::Filter`.
@@ -218,6 +226,15 @@ Now this filter can be used in a pipeline:
 Pipeline.new [ RootRelativeFilter ], { :base_url => 'http://somehost.com' }
 ```
 
+### 3rd Party Extensions
+
+If you have an idea for a filter, propose it as
+[an issue](https://github.com/jch/html-pipeline/issues) first. This allows us discuss
+whether the filter is a common enough use case to belong in this gem, or should be
+built as an external gem.
+
+* [html-pipeline-asciidoc_filter](https://github.com/asciidoctor/html-pipeline-asciidoc_filter) - asciidoc support
+
 ## Instrumenting
 
 Filters and Pipelines can be set up to be instrumented when called. The pipeline
@@ -268,37 +285,28 @@ service.subscribe "call_pipeline.html_pipeline" do |event, start, ending, transa
 end
 ```
 
-## Documentation
-
-Full reference documentation can be [found here](http://rubydoc.info/gems/html-pipeline/frames).
-
-## Development
-
-To see what has changed in recent versions, see the [CHANGELOG](https://github.com/jch/html-pipeline/blob/master/CHANGELOG.md).
-
-```sh
-bundle
-rake test
-```
-
-## Releasing a new version
-
-This section is for gem maintainers to cut a new version of the gem.
-
-* update lib/html/pipeline/version.rb to next version number X.X.X following [semver](http://semver.org).
-* update CHANGELOG.md. Get latest changes with `git log --oneline vLAST_RELEASE..HEAD | grep Merge`
-* on the master branch, run `script/release`
-
 ## Contributing
 
+Please review the [Contributing Guide](https://github.com/jch/html-pipeline/blob/master/CONTRIBUTING.md).
+
 1. [Fork it](https://help.github.com/articles/fork-a-repo)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new [Pull Request](https://help.github.com/articles/using-pull-requests)
 
-## Contributors
+To see what has changed in recent versions, see the [CHANGELOG](https://github.com/jch/html-pipeline/blob/master/CHANGELOG.md).
+
+### Contributors
 
 Thanks to all of [these contributors](https://github.com/jch/html-pipeline/graphs/contributors).
 
 Project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
+
+### Releasing A New Version
+
+This section is for gem maintainers to cut a new version of the gem.
+
+* update lib/html/pipeline/version.rb to next version number X.X.X following [semver](http://semver.org).
+* update CHANGELOG.md. Get latest changes with `git log --oneline vLAST_RELEASE..HEAD | grep Merge`
+* on the master branch, run `script/release`

data/lib/html/pipeline/emoji_filter.rb

@@ -12,6 +12,7 @@ module HTML
     #
     # 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 EmojiFilter < Filter
       # Build a regexp that matches all valid :emoji: names.
       EmojiPattern = /:(#{Emoji.names.map { |name| Regexp.escape(name) }.join('|')}):/
@@ -56,10 +57,22 @@ module HTML
         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", "#{::CGI.escape(name)}.png")
+        else
+          File.join("emoji", "#{::CGI.escape(name)}.png")
+        end
+      end
+
       private
 
       def emoji_url(name)
-        File.join(asset_root, "emoji", "#{::CGI.escape(name)}.png")
+        File.join(asset_root, asset_path(name))
       end
     end
   end

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "1.7.0"
+    VERSION = "1.8.0"
   end
 end

data/test/html/pipeline/emoji_filter_test.rb

@@ -21,4 +21,10 @@ class HTML::Pipeline::EmojiFilterTest < Test::Unit::TestCase
     }
     assert_match /:asset_root/, exception.message
   end
+
+  def test_custom_asset_path
+    filter = EmojiFilter.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 description: GitHub HTML processing filters and utilities
@@ -47,8 +47,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -108,17 +108,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Helpers for processing content through a chain of filters