html-pipeline 0.0.6 → 0.0.7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.0.7
+
+  * optionally require github-linguist chrislloyd #33
+
 ## 0.0.6
 
   * don't mutate markdown strings: jakedouglas #32

data/README.md

@@ -50,7 +50,7 @@ pipeline = HTML::Pipeline.new [
   HTML::Pipeline::MarkdownFilter,
   HTML::Pipeline::SyntaxHighlightFilter
 ]
-result = pipeline.call <<CODE
+result = pipeline.call <<-CODE
 This is *great*:
 
 ``` ruby
@@ -94,10 +94,22 @@ filter.call
 * `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 with [linguist](https://github.com/github/linguist)
+* `SyntaxHighlightFilter` - [code syntax highlighter](#syntax-highlighting)
 * `TextileFilter` - convert textile to html
 * `TableOfContentsFilter` - anchor headings with name attributes
 
+## Syntax highlighting
+
+`SyntaxHighlightFilter` uses [github-linguist](https://github.com/github/linguist)
+to detect and highlight languages. It isn't included as a dependency by default
+because it's a large dependency and
+[a hassle to build on heroku](https://github.com/jch/html-pipeline/issues/33).
+To use the filter, add the following to your Gemfile:
+
+```ruby
+gem 'github-linguist'
+```
+
 ## Examples
 
 We define different pipelines for different parts of our app. Here are a few
@@ -121,7 +133,7 @@ SimplePipeline = Pipeline.new [
   SyntaxHighlightFilter,
   EmojiFilter,
   AutolinkFilter
-], context, {}
+], context
 
 # Pipeline used for user provided content on the web
 MarkdownPipeline = Pipeline.new [
@@ -133,24 +145,24 @@ MarkdownPipeline = Pipeline.new [
   MentionFilter,
   EmojiFilter,
   SyntaxHighlightFilter
-], context.merge(:gfm => true), {}  # enable github formatted markdown
+], context.merge(:gfm => true) # enable github formatted markdown
 
 
 # Define a pipeline based on another pipeline's filters
 NonGFMMarkdownPipeline = Pipeline.new(MarkdownPipeline.filters,
-  context.merge(:gfm => false), {})
+  context.merge(:gfm => false))
 
 # Pipelines aren't limited to the web. You can use them for email
 # processing also.
 HtmlEmailPipeline = Pipeline.new [
   ImageMaxWidthFilter
-], {}, {}
+], {}
 
 # Just emoji.
 EmojiPipeline = Pipeline.new [
   HTMLInputFilter,
   EmojiFilter
-], context, {}
+], context
 ```
 
 ## Extending

data/html-pipeline.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency "nokogiri",        "~> 1.4"
   gem.add_dependency "github-markdown", "~> 0.5"
   gem.add_dependency "sanitize",        "~> 2.0"
-  gem.add_dependency "github-linguist", "~> 2.1"
   gem.add_dependency "rinku",           "~> 1.7"
   gem.add_dependency "escape_utils",    "~> 0.2"
   gem.add_dependency "activesupport",   ">= 2"
+
+  gem.add_development_dependency "github-linguist", "~> 2.1"
 end

data/lib/html/pipeline/syntax_highlight_filter.rb

@@ -1,4 +1,9 @@
-require 'linguist'
+begin
+  require 'linguist'
+rescue LoadError
+  $stderr.puts "You need to install linguist before using the SyntaxHighlightFilter. See README.md for details"
+  exit 1
+end
 
 module HTML
   class Pipeline

data/lib/html/pipeline/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Pipeline
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -76,22 +76,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: github-linguist
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rinku
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +124,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: GitHub HTML processing filters and utilities
 email:
 - ryan@github.com
@@ -220,4 +220,3 @@ test_files:
 - test/html/pipeline/sanitization_filter_test.rb
 - test/html/pipeline/toc_filter_test.rb
 - test/test_helper.rb
-has_rdoc: