content-pipeline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63e843633684063415b4e1b255c2cb31951eef56
+  data.tar.gz: 77a10f7cb27a40367be4713dbaad5f7c7a676aa3
+SHA512:
+  metadata.gz: cfd257ad678d8a45a1e4f939c7b586f050958614a8e8d5161bd65840eb6ce99fa0c901771a8d16efbbe5f12b93c59444c1837377b62c54bcfd32a53cb66603aa
+  data.tar.gz: ab38717b3c52a5174c07ea42ab6c40bb391643b21cc8d278427ebe8b3b4b0cd6c416d2d5ac3e7d48c63bd93b0167b168db2256a1a4e6db347ce6e28079b93812

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'kramdown', '~> 1.1.0'
+  gem 'pry', '~> 0.9.12'
+
+  unless RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+    gem 'pygments.rb', '~> 0.5.1'
+    gem 'github-markdown', '~> 0.5.3'
+  end
+end

data/License

@@ -0,0 +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
+
+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.

data/Rakefile

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

data/Readme.md

@@ -0,0 +1,6 @@
+# Content Pipeline.
+
+[![Build Status](https://travis-ci.org/envygeeks/content-pipeline.png?branch=master)](https://travis-ci.org/envygeeks/content-pipeline) [![Coverage Status](https://coveralls.io/repos/envygeeks/content-pipeline/badge.png)](https://coveralls.io/r/envygeeks/content-pipeline) [![Code Climate](https://codeclimate.com/github/envygeeks/content-pipeline.png)](https://codeclimate.com/github/envygeeks/content-pipeline) [![Dependency Status](https://gemnasium.com/envygeeks/content-pipeline.png)](https://gemnasium.com/envygeeks/content-pipeline)
+
+
+Content pipeline is like `html-pipeline` except it's less restrictive.

data/lib/content/pipeline.rb

@@ -0,0 +1,53 @@
+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.
+    #
+    # @opt filters [Array] a list of filters to use.
+    # ------------------------------------------------------------------------
+
+    def initialize(filters = Filters::DEFAULT_FILTERS, opts = nil)
+      @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
+      end
+
+      content
+    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)
+      cls.name.split(/::/).last.downcase.to_sym
+    end
+  end
+end

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

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

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

@@ -0,0 +1,43 @@
+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
+      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
+
+# ----------------------------------------------------------------------------
+
+Object.send(:include, CoreExtensions::ObjectExt)

data/lib/content/pipeline/filters.rb

@@ -0,0 +1,60 @@
+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|
+        send(f)
+      end
+
+      @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)
+      end
+    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

@@ -0,0 +1,71 @@
+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
+
+  Matcher = /<pre>(.+)<\/pre>/m
+  Templates = {
+    :numb => %Q{<span class="line-number">%s</span>\n},
+    :line => '<span class="line">%s</span>',
+    :wrap => <<-HTML
+      <figure class="code">
+        <div class="highlight">
+          <table>
+            <tbody>
+              <tr>
+                <td class="gutter">
+                  <pre>%s</pre>
+                </td>
+                <td class="code">
+                  <pre><code class="%s">%s</code></pre>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </figure>
+    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|
+      node.replace Templates[:wrap] %
+        wrap(pygments(node.inner_text, node[:lang]), node[:lang] || 'text')
+    end
+  end
+
+  # --------------------------------------------------------------------------
+  # Goes through each line and wraps it as well as creates line numbers.
+  # --------------------------------------------------------------------------
+
+  private
+  def wrap(str, lang)
+    lines, numbs = '', ''; str.each_line.with_index(1) do |line, numb|
+      lines+= Templates[:line] % line
+      numbs+= Templates[:numb] % numb
+    end
+
+    [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]
+    Pygments::Lexer[lang].highlight(str) =~ Matcher ? $1 : str
+  end
+end

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

@@ -0,0 +1,89 @@
+# ----------------------------------------------------------------------------
+# 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 markdown
+    type = @opts.fetch(:type, ((jruby?) ? (:kramdown) : (:gfm)))
+
+    @str = case
+    when type =~ /\Amarkdown|gfm\Z/
+      require 'github/markdown'
+      GitHub::Markdown.to_html(@str, @opts.fetch(:type, :gfm))
+    else
+      require 'kramdown'
+      fix_kramdown_wraps(Kramdown::Document.
+        new(convert_backtick(@str), :enable_coderay => false).to_html)
+    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
+    @str = @str.to_nokogiri_fragment
+    if @opts[:safe]
+      private_methods(false).keep_if { |m| m =~ /\Astrip_/ }.each do |m|
+        unless m == :strip_html
+          send(m)
+        end
+      end
+    end
+  end
+
+  # --------------------------------------------------------------------------
+  # Strip anchor tags.
+  # --------------------------------------------------------------------------
+
+  private
+  def strip_links
+    @str.search('a').each do |node|
+      node.replace(node[: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
+    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)
+    str.gsub(/<pre><code class="language-([A-Za-z0-9]+)">/, '<pre lang="\\1"><code>')
+  end
+end

data/lib/content/pipeline/version.rb

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: content-pipeline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordon Bedwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  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
+- !ruby/object:Gem::Dependency
+  name: luna-rspec-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: A less restrictive version of html-pipeline for content.
+email: envygeeks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- License
+- Rakefile
+- Gemfile
+- lib/content/pipeline/filters/markdown.rb
+- lib/content/pipeline/filters/code_highlight.rb
+- lib/content/pipeline/core_extensions/object_ext.rb
+- lib/content/pipeline/core_extensions/hash_ext.rb
+- lib/content/pipeline/version.rb
+- lib/content/pipeline/filters.rb
+- lib/content/pipeline.rb
+homepage: https://github.com/envygeeks/content-pipeline
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Adds a pipeline for your content.
+test_files: []