content-pipeline 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bcbf0d25b53581c0b7f6ed8c23281a97d76bc83
-  data.tar.gz: 9d9308892002f4c9e89f65b07ab5f8a03d80bc35
+  metadata.gz: 3b4bedc6ec80720723af0e97a392f3a37f689395
+  data.tar.gz: 62896591dd8f82f947454c3663e1e08091cb4547
 SHA512:
-  metadata.gz: eb3cdd69b7f4894864c7345577b27cbdc7f0c3f8b66b211d8634630ab5bf77742e7cce3789ba7fc26c49d0b13841212be1268bbdc1033809285e170221562029
-  data.tar.gz: 79d6ac899d53826cb6510606e5bc0d31705052118aee07cc36f5e0694d4e69d38c5eb86053d3d2fb7bda3716308f35e0fbef75fcbb75ff33e2f7fce50771037e
+  metadata.gz: 438d637a65de37a5ebb51be0fb6a664217753d421fb04336c53dd31809c342b974ab69868d8f4de8161124192cf2eb2afe1143f6740b19774fbf9fde4ea433ee
+  data.tar.gz: 83aa17a0b86c98161622010f5a52718f1215e7d75c3f0001f6c8a73893c91d98e78604a2ab2ccf8402c01761a68a24561e8efb27f4d92903c66f8983330734f2

data/Gemfile

@@ -2,10 +2,6 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  unless ENV["CI"]
-    gem "pry"
-  end
-
   gem "kramdown"
   gem "rake"
 

data/License

@@ -1,11 +1,11 @@
 Copyright 2013 Jordon Bedwell
 
-Licensed under the Apache License, Version 2.0 (the "License"); you may not
-use this file except in compliance with the License. You may obtain a copy of
-the License at: http://www.apache.org/licenses/LICENSE-2.0
+Licensed under the Apache License, Version 2.0 (the "License"); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-License for the specific language governing permissions and limitations under
-the License.
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing
+permissions and limitations under the License.

data/Rakefile

@@ -1,3 +1,3 @@
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 task :default => :spec
 RSpec::Core::RakeTask.new :spec

data/Readme.md

@@ -20,8 +20,17 @@ gem 'content-pipeline', '~> <VERSION>'
 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 })
+pipeline = Content::Pipeline.new([ MyFilter ], {
+  :my_filter => {
+    :o1 => true
+  }
+})
+
+pipeline.filter('# Markdown', {
+  :my_filter => {
+    :o1 => false
+  }
+})
 ```
 
 ```ruby

data/lib/content/pipeline.rb

@@ -1,47 +1,29 @@
 require_relative "pipeline/core_extensions/object_ext"
 require_relative "pipeline/core_extensions/hash_ext"
-$:.unshift(File.expand_path("../../", __FILE__))
 
 module Content
-
-  # --------------------------------------------------------------------------
-  # Content pipeline is a class that runs content through a pipeline of user
-  # set and/or defined filters returning the final result.  It can be mixed
-  # and matched anyway and filters can even be skipped and removed.
-  # --------------------------------------------------------------------------
-
   class Pipeline
     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.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
 
-    def initialize(filters = Filters::DEFAULT_FILTERS, opts = nil)
-      @opts, @filters = (opts || {}).freeze, [ filters ].flatten.freeze
+    def initialize(filters = Filters::DEFAULT_FILTERS, opts = {})
+      @opts, @filters = opts.freeze, [ filters ].flatten.freeze
     end
 
-    # ------------------------------------------------------------------------
-    # Runs through each of the extensions chosen by the user and then calls
-    # them, returning the final result as the final HTML string.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
 
-    def filter(content, opts = nil)
-      opts = @opts.deep_merge(opts || {})
-      @filters.each do |filter|
-        content = filter.new(content, opts[to_opt(filter)]).run
+    def filter(out, opts = {})
+      opts = @opts.deep_merge(opts)
+      @filters.each do |f|
+        out = f.new(out, opts[to_opt(f)]).run
       end
 
-      content
+    out
     end
 
-    # ------------------------------------------------------------------------
-    # Convert a class and it's name into an opt by splitting up it's name
-    # and downcasing the last part returning it as a symbol for opts.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
 
     private
     def to_opt(cls)

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

@@ -1,18 +1,20 @@
 module CoreExtensions
 
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
   # Hash Extensions.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   module HashExt
 
-    # ------------------------------------------------------------------------
-    # Merge a hash, merging hashes in hashes with hashes in hashes if hashes.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
+    # Merge a hash, merging hashes in hashes with hashes in hashes.
+    # -----------------------------------------------------------------
 
-    def deep_merge(new_hash)
-      merge(new_hash) do |k, o, n|
-        Hash === o && Hash === n ? o.deep_merge(n) : n
+    unless method_defined?(:deep_merge)
+      def deep_merge(new_hash)
+        merge(new_hash) do |k, o, n|
+          o.is_a?(Hash) && n.is_a?(Hash) ? o.deep_merge(n) : n
+        end
       end
     end
   end

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

@@ -2,18 +2,18 @@ require "nokogiri"
 
 module CoreExtensions
 
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
   # Object Extensions.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   module ObjectExt
     def jruby?
       RbConfig::CONFIG["ruby_install_name"] == "jruby"
     end
 
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
     # Convert an element to a Nokogiri document fragment.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
 
     def to_nokogiri_fragment
       Nokogiri::HTML.fragment(self.to_s)
@@ -21,6 +21,6 @@ module CoreExtensions
   end
 end
 
-# ----------------------------------------------------------------------------
+# ---------------------------------------------------------------------
 
 Object.send(:include, CoreExtensions::ObjectExt)

data/lib/content/pipeline/filters.rb

@@ -1,25 +1,12 @@
 class Content::Pipeline
-
-  # --------------------------------------------------------------------------
-  # Pipeline is an "abstract" class meant to be inherited from in a defined
-  # filter.  It provides a set of base methods, namely initialize which
-  # spawns the str not to mention add_filter which allows the filter author
-  # to define a set of methods that need to be run on this filter.
-  # --------------------------------------------------------------------------
-
   class Filter
-
-    # ------------------------------------------------------------------------
-    # Initialize.
-    # ------------------------------------------------------------------------
-
     def initialize(str, opts = nil)
       @opts, @str = (opts || {}), str
     end
 
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
     # Run the set of filters the user wants ran on the filter.
-    # ------------------------------------------------------------------------
+    # -----------------------------------------------------------------
 
     def run
       self.class.filters.each do |f|
@@ -29,14 +16,11 @@ class Content::Pipeline
       @str.to_s
     end
 
+    # -----------------------------------------------------------------
+
     class << self
       attr_reader :filters
 
-      # ----------------------------------------------------------------------
-      # Allows the author of a filter to set a method to be run on this,
-      # filter, without us having to enforce a specific type of name.
-      # ----------------------------------------------------------------------
-
       def add_filter(*filters)
         @filters ||= []
         @filters.push(*filters.flatten)
@@ -44,17 +28,11 @@ class Content::Pipeline
     end
   end
 
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   module Filters
     require_relative "filters/code_highlight"
     require_relative "filters/markdown"
-
-    # ------------------------------------------------------------------------
-    # A set of default filters that we use if the user does not supply their
-    # own filters for us to use.
-    # ------------------------------------------------------------------------
-
     DEFAULT_FILTERS = [ Markdown, CodeHighlight ].freeze
   end
 end

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

@@ -1,10 +1,5 @@
 require "pygments" unless jruby?
 
-# ----------------------------------------------------------------------------
-# A filter that discovers pre tags and then syntax highlights them, also
-# allowing for fallback to just wrapping them so they stay consistent.
-# ----------------------------------------------------------------------------
-
 class Content::Pipeline::Filters::CodeHighlight < Content::Pipeline::Filter
   add_filter :highlight
 
@@ -32,22 +27,18 @@ class Content::Pipeline::Filters::CodeHighlight < Content::Pipeline::Filter
     HTML
   }
 
-  # --------------------------------------------------------------------------
-  # Searches for elements we want to transform and transforms them.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def highlight
     @str = @str.to_nokogiri_fragment
-    @str.search('pre').each do |node|
+    @str.search("pre").each do |node|
       lang = node[:lang] || @opts[:default] || "ruby"
       node.replace Templates[:wrap] % wrap(pygments(node.inner_text, lang), lang)
     end
   end
 
-  # --------------------------------------------------------------------------
-  # Goes through each line and wraps it as well as creates line numbers.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def wrap(str, lang)
@@ -59,14 +50,11 @@ class Content::Pipeline::Filters::CodeHighlight < Content::Pipeline::Filter
     [numbs, lang, lines]
   end
 
-  # --------------------------------------------------------------------------
-  # Wraps around Pygments catching a timeout error so that it can cont.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def pygments(str, lang)
     return str if jruby? || !Pygments::Lexer[lang]
-    # Protects you against a possible Pygments error.
     Pygments::Lexer[lang].highlight(str) =~ Matcher ? $1 : str
   end
 end

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

@@ -1,38 +1,30 @@
-# ----------------------------------------------------------------------------
-# A filter that supports Github-Markdown and also has a few filters to strip
-# the most basic unsafe content, if the user chooses this to be done.
-# ----------------------------------------------------------------------------
-
 class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
   add_filter :markdown, :strip_html
 
-  # --------------------------------------------------------------------------
-  # Parse Markdown content.
-  # --------------------------------------------------------------------------
+  private
+  def default_markdown
+    (jruby?) ? :kramdown : :gfm
+  end
+
+  # -------------------------------------------------------------------
 
   private
   def markdown
-    type = @opts.fetch(:type, ((jruby?) ? (:kramdown) : (:gfm)))
+    type = @opts.fetch(:type, default_markdown)
+    @str = convert_backtick(@str)
 
     @str = case
     when type =~ /\Amarkdown|gfm\Z/
       require "github/markdown"
-      GitHub::Markdown.to_html(@str, @opts.fetch(:type, :gfm)).strip
+      GitHub::Markdown.to_html(@str, type).strip
     else
       require "kramdown"
-      fix_kramdown_wraps(Kramdown::Document.
-        new(convert_backtick(@str), :enable_coderay => false).to_html).strip
+      str = Kramdown::Document.new(@str, :enable_coderay => false)
+      normalize_kramdown(str.to_html).strip
     end
   end
 
-  # --------------------------------------------------------------------------
-  # Discovers private methods that start with strip_ and runs them if the
-  # filter is in safe mode.  Which will strip certain tags from the data.
-  #
-  # Doing it this way allows us to allow people to extend this class and add
-  # what they wish to it, while us preventing them from monkey patching key
-  # methods and having to keep those up-to-date.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def strip_html
@@ -46,44 +38,35 @@ class Content::Pipeline::Filters::Markdown < Content::Pipeline::Filter
     end
   end
 
-  # --------------------------------------------------------------------------
-  # Strip anchor tags.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def strip_links
-    @str.search("a").each do |node|
-      node.replace(node[:href])
+    @str.search("a").each do |n|
+      n.replace(n[:href])
     end
   end
 
-  # --------------------------------------------------------------------------
-  # Strip image tags.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def strip_image
-    @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
+    @str.search("img").each do |n|
+      n.parent.children.count == 1 ? n.parent.remove : n.remove
     end
   end
 
-  # --------------------------------------------------------------------------
-  # Converts Github style backticks over to Portable ~~~.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
   def convert_backtick(str)
     str.gsub(/^`{3}(\s?[a-zA-Z0-9]+)?$/, "~~~\\1")
   end
 
-  # --------------------------------------------------------------------------
-  # Converts <pre><code class="language-ruby"> to <pre lang="lang">.
-  # --------------------------------------------------------------------------
+  # -------------------------------------------------------------------
 
   private
-  def fix_kramdown_wraps(str)
+  def normalize_kramdown(str)
     str.gsub(/<pre><code class="language-([A-Za-z0-9]+)">/, '<pre lang="\\1"><code>')
   end
 end

data/lib/content/pipeline/version.rb

@@ -1,5 +1,5 @@
 module Content
   class Pipeline
-    VERSION = "0.2.2"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,101 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: content-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordon Bedwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2014-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rspec-expect_error
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: envygeeks-coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: luna-rspec-formatters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 description: A less restrictive version of html-pipeline for content.
 email: envygeeks@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Readme.md
+- Gemfile
 - License
 - Rakefile
-- Gemfile
+- Readme.md
 - lib/content/pipeline.rb
-- lib/content/pipeline/filters.rb
-- lib/content/pipeline/filters/markdown.rb
-- lib/content/pipeline/filters/code_highlight.rb
 - lib/content/pipeline/core_extensions/hash_ext.rb
 - lib/content/pipeline/core_extensions/object_ext.rb
+- lib/content/pipeline/filters.rb
+- lib/content/pipeline/filters/code_highlight.rb
+- lib/content/pipeline/filters/markdown.rb
 - lib/content/pipeline/version.rb
 homepage: https://github.com/envygeeks/content-pipeline
 licenses:
@@ -107,17 +107,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.1.10
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Adds a pipeline for your content.