content-pipeline 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e843633684063415b4e1b255c2cb31951eef56
-  data.tar.gz: 77a10f7cb27a40367be4713dbaad5f7c7a676aa3
+  metadata.gz: 82e18bcc2d6c061a7b0ea5a7d1e2a2557718bbf1
+  data.tar.gz: f6aaedc35707c3d056556a0a890f25867392a353
 SHA512:
-  metadata.gz: cfd257ad678d8a45a1e4f939c7b586f050958614a8e8d5161bd65840eb6ce99fa0c901771a8d16efbbe5f12b93c59444c1837377b62c54bcfd32a53cb66603aa
-  data.tar.gz: ab38717b3c52a5174c07ea42ab6c40bb391643b21cc8d278427ebe8b3b4b0cd6c416d2d5ac3e7d48c63bd93b0167b168db2256a1a4e6db347ce6e28079b93812
+  metadata.gz: 7303628384ea53a2854832749a465a08721861dbe9f48a36361f4577e6635d6c03538b988aed7ecfc8cea62311be285ed217add4ad38c81403ea47ee767e9aad
+  data.tar.gz: 06f12ee5b5df5aa9b69b8ff4129f5b0ec99ce1e628db1184402b5e0195671965f6497c2913b66d626273d5a074ea4378be606e5b6339e1d6556d6dd39327406f

data/Gemfile

@@ -1,12 +1,18 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem 'kramdown', '~> 1.1.0'
-  gem 'pry', '~> 0.9.12'
+  unless ENV["CI"]
+    gem "pry"
+  end
+
+  gem "envygeeks-coveralls"
+  gem "kramdown"
+  gem "rake"
+  gem "luna-rspec-formatters"
 
-  unless RbConfig::CONFIG['ruby_install_name'] == 'jruby'
-    gem 'pygments.rb', '~> 0.5.1'
-    gem 'github-markdown', '~> 0.5.3'
+  unless RbConfig::CONFIG["ruby_install_name"] == "jruby"
+    gem "pygments.rb"
+    gem "github-markdown"
   end
 end

data/Readme.md

@@ -4,3 +4,53 @@
 
 
 Content pipeline is like `html-pipeline` except it's less restrictive.
+
+## Installing
+
+```
+gem install content-pipeline
+```
+
+```
+gem 'content-pipeline', '~> <VERSION>'
+```
+
+## Usage
+
+Content Pipeline is extremely simple to use out of the box:
+
+```ruby
+pipeline = Content::Pipeline.new([ MyFilter ], :my_filter => { :o1 => true })
+pipeline.filter('# Markdown', :my_filter => { :o1 => false })
+```
+
+```ruby
+Content::Pipeline.new.filter('# Markdown')
+```
+
+* Supports multiple Markdowns.
+* Supports global options with overrides.
+* By default uses both `CodeHighlight` and `Markdown`.
+
+*It should be noted that if you send a list of filters you wish to use, it will not use the default filters at all.  So where you see `[ MyFilter ]` that will be the only filter that is ran, since it automatically assumes this is the pipeline you wish to use.*
+
+### Filter Options
+
+Filter options are set globally and can be overriden each time the filter is ran, this allows for you to setup a single pipeline and then adjust it on the fly on a per-content basis, for example if you wish to run `Markdown` `:safe` on user comments but not on posts, then you would simply setup the global pipeline and then each time you parse a user comment send the content with the hash `{ :markdown => { :safe => true }}`.
+
+*All options are keyed based on their class name, so `MyFilter` would have the option key `:my_filter`*
+
+### Content::Pipeline::Filters::Markdown
+
+The Markdown filter allows you to choose between `github-markdown` and `kramdown`, and by default will use `kramdown` on jRuby and `github-markdown` on any other Ruby that supports it.  **These dependencies are loose, which means you must install the one you wish to use.**
+
+Options:
+* `:type` => [`:gfm`, `:markdown`, `:kramdown`] - The Markdown filter you wish to use.
+* `:safe` => [`true`, `false`] - Does basic filtering, removes images and strips autolinked anchors.
+
+*You should not need to adjust any of your "\`\`\`" because the `Markdown` filter will automatically convert those to `~~~` if you choose Kramdown.  This is not done because one way is
+better than the other, it's done so that people can remain agnostic.*
+
+### Content::Pipeline::Filters::CodeHighlight
+
+The code highlight filter allows you to highlight code, with or without Pygments.  If Pygments is supported it will require it and syntax highlight, otherwise it will simply wrap your code in the normal code style and not syntax highlight it.  You will still have the line numbers, just not the fancy syntax highlight.

data/lib/content/pipeline/core_extensions/object_ext.rb

@@ -1,4 +1,4 @@
-require 'nokogiri'
+require "nokogiri"
 
 module CoreExtensions
 
@@ -9,7 +9,7 @@ module CoreExtensions
   module ObjectExt
 
     def jruby?
-      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+      RbConfig::CONFIG["ruby_install_name"] == "jruby"
     end
 
     # ------------------------------------------------------------------------
@@ -20,21 +20,6 @@ module CoreExtensions
       return self if Nokogiri::HTML::DocumentFragment === self
       Nokogiri::HTML.fragment(respond_to?(:to_html) ? to_html : to_s)
     end
-
-    # ------------------------------------------------------------------------
-    # Require a file with a fallback and if all else fails send an error.
-    # ------------------------------------------------------------------------
-
-    def require_or_fail(a, b, msg)
-      require a
-    rescue LoadError
-      begin
-        require b
-      rescue LoadError => error
-        # Try to keep the call chain proper.
-        raise LoadError, msg, error.backtrace[3...-1]
-      end
-    end
   end
 end
 

data/lib/content/pipeline/filters/code_highlight.rb

@@ -1,4 +1,4 @@
-require 'pygments' unless jruby?
+require "pygments" unless jruby?
 
 # ----------------------------------------------------------------------------
 # A filter that discovers pre tags and then syntax highlights them, also
@@ -41,7 +41,7 @@ class Content::Pipeline::Filters::CodeHighlight < Content::Pipeline::Filter
     @str = @str.to_nokogiri_fragment
     @str.search('pre').each do |node|
       node.replace Templates[:wrap] %
-        wrap(pygments(node.inner_text, node[:lang]), node[:lang] || 'text')
+        wrap(pygments(node.inner_text, node[:lang]), node[:lang] || "text")
     end
   end
 
@@ -51,7 +51,7 @@ class Content::Pipeline::Filters::CodeHighlight < Content::Pipeline::Filter
 
   private
   def wrap(str, lang)
-    lines, numbs = '', ''; str.each_line.with_index(1) do |line, numb|
+    lines, numbs = "", ""; str.each_line.with_index(1) do |line, numb|
       lines+= Templates[:line] % line
       numbs+= Templates[:numb] % numb
     end

data/lib/content/pipeline/filters/markdown.rb

@@ -16,12 +16,12 @@ class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
 
     @str = case
     when type =~ /\Amarkdown|gfm\Z/
-      require 'github/markdown'
-      GitHub::Markdown.to_html(@str, @opts.fetch(:type, :gfm))
+      require "github/markdown"
+      GitHub::Markdown.to_html(@str, @opts.fetch(:type, :gfm)).strip
     else
-      require 'kramdown'
+      require "kramdown"
       fix_kramdown_wraps(Kramdown::Document.
-        new(convert_backtick(@str), :enable_coderay => false).to_html)
+        new(convert_backtick(@str), :enable_coderay => false).to_html).strip
     end
   end
 
@@ -52,7 +52,7 @@ class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
 
   private
   def strip_links
-    @str.search('a').each do |node|
+    @str.search("a").each do |node|
       node.replace(node[:href])
     end
   end
@@ -63,7 +63,7 @@ class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
 
   private
   def strip_image
-    @str.search('img').each do |node|
+    @str.search("img").each do |node|
       # Tries to cover single line images wrapped in a paragraph.
       node.parent.children.count == 1 ? node.parent.remove : node.remove
     end
@@ -75,7 +75,7 @@ class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
 
   private
   def convert_backtick(str)
-    str.gsub(/^`{3}(\s?[a-zA-Z0-9]+)?$/, '~~~\\1')
+    str.gsub(/^`{3}(\s?[a-zA-Z0-9]+)?$/, "~~~\\1")
   end
 
   # --------------------------------------------------------------------------

data/lib/content/pipeline/filters.rb

@@ -47,8 +47,8 @@ class Content::Pipeline
   # --------------------------------------------------------------------------
 
   module Filters
-    require_relative 'filters/code_highlight'
-    require_relative 'filters/markdown'
+    require_relative "filters/code_highlight"
+    require_relative "filters/markdown"
 
     # ------------------------------------------------------------------------
     # A set of default filters that we use if the user does not supply their

data/lib/content/pipeline/version.rb

@@ -1,5 +1,5 @@
 module Content
   class Pipeline
-    VERSION = '0.0.1'
+    VERSION = "0.1.0"
   end
 end

data/lib/content/pipeline.rb

@@ -1,6 +1,6 @@
-require_relative 'pipeline/core_extensions/object_ext'
-require_relative 'pipeline/core_extensions/hash_ext'
-$:.unshift(File.expand_path('../../', __FILE__))
+require_relative "pipeline/core_extensions/object_ext"
+require_relative "pipeline/core_extensions/hash_ext"
+$:.unshift(File.expand_path("../../", __FILE__))
 
 module Content
 
@@ -11,15 +11,13 @@ module Content
   # --------------------------------------------------------------------------
 
   class Pipeline
-    require_relative 'pipeline/filters'
+    require_relative "pipeline/filters"
     attr_reader :filters, :opts
 
     # ------------------------------------------------------------------------
     # Allows the user to initialize with a custom set of filters or to auto
     # load our filters and use them, the base filters we provider are
     # redcarpet and pygments.
-    #
-    # @opt filters [Array] a list of filters to use.
     # ------------------------------------------------------------------------
 
     def initialize(filters = Filters::DEFAULT_FILTERS, opts = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: content-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jordon Bedwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,61 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.7
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.7
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.1.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.14.0.rc1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.14.0.rc1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: luna-rspec-formatters
+  name: rspec-expect_error
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 description: A less restrictive version of html-pipeline for content.
 email: envygeeks@gmail.com
 executables: []