Udpated the README and bumped gem version

digitalmoksha · digitalmoksha · commit 2dbe4fce4127 · 2019-07-15T20:29:14.000-05:00
diff --git a/README.md b/README.md
@@ -3,27 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/motion-html-pipeline.svg)](http://badge.fury.io/rb/motion-html-pipeline)
 [![Build Status](https://travis-ci.org/digitalmoksha/motion-html-pipeline.svg?branch=master)](https://travis-ci.org/digitalmoksha/motion-html-pipeline)
 
-This gem is a port of the [`html-pipeline` gem](https://github.com/jch/html-pipeline) to RubyMotion, for use on iOS and macOS. Currently synced with `html-pipeline` release [`v.2.11.0`](https://github.com/jch/html-pipeline/releases/tag/v2.11.0)
-
-Several of the standard filters, such as `AutolinkFilter` and `EmojiFilter`, are initially disabled, as they rely on other Ruby gems that don't have RubyMotion equivalents.  Please feel free to submit a pull request that enables any of them.
-
-We use [HTMLKit](https://github.com/iabudiab/HTMLKit) to take the place of Nokogiri.
-
-Below is a copy of the original README file, until I'm able to flesh this one out more.
-
-But you can build a pipeline like this:
-
-```ruby
-pipeline = MotionHTMLPipeline::Pipeline.new [
-  MotionHTMLPipeline::Pipeline::HttpsFilter,
-  MotionHTMLPipeline::Pipeline::ImageMaxWidthFilter
-]
-result = pipeline.call("<a href='http://example.com/one.png'>link</a> <img src='one.png'>", {http_url: 'http://example.com'})
-result[:output].to_s
-```
-
----
-# HTML::Pipeline
+_This gem is a port of the [`html-pipeline` gem](https://github.com/jch/html-pipeline) to RubyMotion, for use on iOS and macOS. Currently synced with `html-pipeline` release [`v.2.11.0`](https://github.com/jch/html-pipeline/releases/tag/v2.11.0)_
 
 GitHub HTML processing filters and utilities. This module includes a small
 framework for defining DOM based content filters and applying them to user
@@ -34,95 +14,93 @@ provided content. Read an introduction about this project in
 - [Usage](#usage)
   - [Examples](#examples)
 - [Filters](#filters)
-- [Dependencies](#dependencies)
+  - [Disabled Filters](#disabled-filters)
 - [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:
 
 ```ruby
-gem 'html-pipeline'
+gem 'motion-html-pipeline'
 ```
 
-And then execute:
+and to your `Rakefile`
 
-```sh
-$ bundle
+```ruby
+require 'motion-html-pipeline'
 ```
 
-Or install it yourself as:
+And then execute:
 
 ```sh
-$ gem install html-pipeline
+$ bundle
 ```
 
 ## Usage
 
-This library provides a handful of chainable HTML filters to transform user
-content into markup. A filter takes an HTML string or
-`Nokogiri::HTML::DocumentFragment`, optionally manipulates it, and then
+This library provides a handful of chain-able HTML filters to transform user
+content into markup. A filter takes an HTML string or a
+`MotionHTMLPipeline::DocumentFragment`, optionally manipulates it, and then
 outputs the result.
 
-For example, to transform Markdown source into Markdown HTML:
+For example, to transform an image URL into an image tag:
 
 ```ruby
-require 'html/pipeline'
-
-filter = HTML::Pipeline::MarkdownFilter.new("Hi **world**!")
+filter = MotionHTMLPipeline::Pipeline::ImageFilter.new("http://example.com/test.jpg")
 filter.call
 ```
 
+would output
+
+```html
+<img src="http://example.com/test.jpg" alt=""/>
+```
+
 Filters can be combined into a pipeline which causes each filter to hand its
 output to the next filter's input. So if you wanted to have content be
-filtered through Markdown and be syntax highlighted, you can create the
-following pipeline:
+filtered through the `ImageFilter` and then wrap it in an `<a>` tag with 
+a max-width inline style:
 
 ```ruby
-pipeline = HTML::Pipeline.new [
-  HTML::Pipeline::MarkdownFilter,
-  HTML::Pipeline::SyntaxHighlightFilter
-]
-result = pipeline.call <<-CODE
-This is *great*:
-
-    some_code(:first)
-
-CODE
+pipeline = MotionHTMLPipeline::Pipeline.new([
+  MotionHTMLPipeline::Pipeline::ImageFilter,
+  MotionHTMLPipeline::Pipeline::ImageMaxWidthFilter
+])
+result = pipeline.call("http://example.com/test.jpg")
 result[:output].to_s
 ```
 
 Prints:
 
 ```html
-<p>This is <em>great</em>:</p>
-
-<pre><code>some_code(:first)
-</code></pre>
+<a href="http://example.com/test.jpg" target="_blank"><img src="http://example.com/test.jpg" alt="" style="max-width:100%;"></a>
 ```
 
-To generate CSS for HTML formatted code, use the [Rouge CSS Theme](https://github.com/jneen/rouge#css-theme-options) `#css` method. `rouge` is a dependency of the `SyntaxHighlightFilter`.
-
 Some filters take an optional **context** and/or **result** hash. These are
 used to pass around arguments and metadata between filters in a pipeline. For
-example, if you don't want to use GitHub formatted Markdown, you can pass an
-option in the context hash:
+example, with the `AbsoluteSourceFilter` you can pass in `:image_base_url` in
+the context hash:
+
 
 ```ruby
-filter = HTML::Pipeline::MarkdownFilter.new("Hi **world**!", :gfm => false)
+filter = MotionHTMLPipeline::Pipeline::AbsoluteSourceFilter.new('<img src="/test.jpg">', image_base_url: 'http://example.com')
 filter.call
 ```
 
 ### Examples
 
 We define different pipelines for different parts of our app. Here are a few
-paraphrased snippets to get you started:
+paraphrased snippets to get you started.
+
+_Note: these are examples from the original
+gem since they illustrate how the pipelines can be used.  Many of the filters are
+not currently usable yet, as mentioned in the Filters section below._
 
 ```ruby
 # The context hash is how you pass options between different filters.
@@ -177,68 +155,51 @@ EmojiPipeline = Pipeline.new [
 
 ## Filters
 
-* `MentionFilter` - replace `@user` mentions with links
 * `AbsoluteSourceFilter` - replace relative image urls with fully qualified versions
+* `HttpsFilter` - HTML Filter for replacing http github urls with https versions.
+* `ImageMaxWidthFilter` - link to full size image for large images
+
+### Disabled Filters
+
+Several of the standard filters, such as `AutolinkFilter` and `EmojiFilter`, are initially disabled, as they rely on other Ruby gems that don't have RubyMotion equivalents.  Please feel free to submit a pull request that enables any of them.
+
+* `MentionFilter` - replace `@user` mentions with links
 * `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
-* `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 [rouge](https://github.com/jneen/rouge)
-to detect and highlight languages. For example, to use the `SyntaxHighlightFilter`,
-add the following to your Gemfile:
-
-```ruby
-gem 'rouge'
-```
-
-* `AutolinkFilter` - `rinku`
-* `EmailReplyFilter` - `escape_utils`, `email_reply_parser`
-* `EmojiFilter` - `gemoji`
-* `MarkdownFilter` - `commonmarker`
-* `PlainTextInputFilter` - `escape_utils`
-* `SanitizationFilter` - `sanitize`
-* `SyntaxHighlightFilter` - `rouge`
-* `TableOfContentsFilter` - `escape_utils`
-* `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).
+Full reference documentation for the original `html-pipeline` gem 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`.
+from `MotionHTMLPipeline::Pipeline::Filter`.
 
 For example this filter adds a base url to images that are root relative:
 
 ```ruby
-require 'uri'
-
-class RootRelativeFilter < HTML::Pipeline::Filter
+class RootRelativeFilter < MotionHTMLPipeline::Pipeline::Filter
 
   def call
-    doc.search("img").each do |img|
+    doc.css("img").each do |img|
       next if img['src'].nil?
+
       src = img['src'].strip
+
       if src.start_with? '/'
-        img["src"] = URI.join(context[:base_url], src).to_s
+        base_url   = NSURL.URLWithString(context[:base_url])
+        img["src"] = NSURL.URLWithString(src, relativeToURL: base_url).absoluteString
       end
     end
+
     doc
   end
 
@@ -248,15 +209,12 @@ end
 Now this filter can be used in a pipeline:
 
 ```ruby
-Pipeline.new [ RootRelativeFilter ], { :base_url => 'http://somehost.com' }
+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.
+Many people have built their own filters for [html-pipeline](https://github.com/jch/html-pipeline/issues).  Although these have not been converted to run with RubyMotion, most of them should be easy convert.
 
 Here are some extensions people have built:
 
@@ -282,22 +240,25 @@ Here are some extensions people have built:
 
 ## Instrumenting
 
+_Although instrumenting was ported, it has not been used real-world, and may not work 
+properly at this time._
+
 Filters and Pipelines can be set up to be instrumented when called. The pipeline
 must be setup with an
 [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html)
 compatible service object and a name. New pipeline objects will default to the
-`HTML::Pipeline.default_instrumentation_service` object.
+`MotionHTMLPipeline::Pipeline.default_instrumentation_service` object.
 
 ``` ruby
 # the AS::Notifications-compatible service object
 service = ActiveSupport::Notifications
 
 # instrument a specific pipeline
-pipeline = HTML::Pipeline.new [MarkdownFilter], context
+pipeline = MotionHTMLPipeline::Pipeline.new [MarkdownFilter], context
 pipeline.setup_instrumentation "MarkdownPipeline", service
 
 # or set default instrumentation service for all new pipelines
-HTML::Pipeline.default_instrumentation_service = service
+MotionHTMLPipeline::Pipeline.default_instrumentation_service = service
 pipeline = HTML::Pipeline.new [MarkdownFilter], context
 pipeline.setup_instrumentation "MarkdownPipeline"
 ```
@@ -332,6 +293,8 @@ end
 
 ## FAQ
 
+_I have left this FAQ item here for when we get the `PlainTextInputFilter` working._
+
 ### 1. Why doesn't my pipeline work when there's no root element in the document?
 
 To make a pipeline work on a plain text document, put the `PlainTextInputFilter`
@@ -353,38 +316,8 @@ html_fragment = "This is outside of an html element, but <strong>this isn't. :+1
 EmojiPipeline.call("<div>#{html_fragment}</div>") # <- Wrap your own html fragments to avoid escaping
 ```
 
-### 2. How do I customize a whitelist for `SanitizationFilter`s?
-
-`SanitizationFilter::WHITELIST` is the default whitelist used if no `:whitelist`
-argument is given in the context. The default is a good starting template for
-you to add additional elements. You can either modify the constant's value, or
-re-define your own constant and pass that in via the context.
-
 ## 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)
-
-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.
-
-* create a new branch named `release-x.y.z` where `x.y.z` follows [semver](http://semver.org)
-* update lib/html/pipeline/version.rb to next version number X.X.X
-* update CHANGELOG.md. Prepare a draft with `script/changelog`
-* push branch and create a new pull request
-* after tests are green, merge to master
-* on the master branch, run `script/release`
+Thanks to all of [these contributors](https://github.com/jch/html-pipeline/graphs/contributors), who have made the original gem possible.
diff --git a/lib/motion-html-pipeline/pipeline/version.rb b/lib/motion-html-pipeline/pipeline/version.rb
@@ -1,5 +1,5 @@
 module MotionHTMLPipeline
   class Pipeline
-    VERSION = '0.1'.freeze
+    VERSION = '0.2'.freeze
   end
 end
