html_pipeline_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 001523be3aba2cbb410842e4fa47a04fb16ea34c
+  data.tar.gz: 1e02571da32c0e5e54498d6862c42b1962252af0
+SHA512:
+  metadata.gz: 540936f9d7a33b41ac0b6c609cbe7ea9ed8ef6e30f4d3cde92170a3fdf0bf5ea619c96bc2b717a41f534dfd59213c7abef176e3f0375ac8ee093295e4e68311a
+  data.tar.gz: 2c4ba2973a8a38da9d5a74362b7d69091d11f3864f7c0abd77f9d6353c512f6af37b5b545a8df7471a8565ff79d5277a64ed063a27bacc58c3cc85c652821da5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html_pipeline_rails.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/}) { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aidan Feldman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# HTML::Pipeline for Rails [![Build Status](https://travis-ci.org/afeld/html_pipeline_rails.png?branch=master)](https://travis-ci.org/afeld/html_pipeline_rails)
+
+Adds support for rendering views via [HTML::Pipeline](https://github.com/jch/html-pipeline) in Rails.  [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) in your Rails app!
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'html_pipeline_rails'
+```
+
+and then run:
+
+    $ bundle
+
+All views ending in `.md` will then be rendered as HTML.  Otherwise, they act the same as normal `.html.erb` files.  Cool, eh?
+
+## Customization
+
+By default, `.md` views will run through ERB, and then the `MarkdownFilter` pipeline.  You can customize the render pipeline like so:
+
+```ruby
+# config/initializers/html_pipeline.rb
+HtmlPipelineRails.config do |c|
+  c.pipeline = HTML::Pipeline.new([
+    HTML::Pipeline::MarkdownFilter,
+    HTML::Pipeline::MentionFilter
+  ])
+end
+```
+
+In this case, `@mention`s will now be converted to links.  See [the HTML::Pipeline documentation](https://github.com/jch/html-pipeline#usage) to learn about the different options.
+
+## Contributing
+
+Run tests with:
+
+```bash
+bundle
+# then
+bundle exec rspec
+# or
+bundle exec guard
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/html_pipeline_rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html_pipeline_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html_pipeline_rails"
+  spec.version       = HtmlPipelineRails::VERSION
+  spec.authors       = ["Aidan Feldman"]
+  spec.email         = ["aidan.feldman@gmail.com"]
+  spec.summary       = %q{Render Markdown via HTML::Pipeline in Rails.}
+  spec.homepage      = "https://github.com/afeld/html_pipeline_rails/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "github-markdown"
+  spec.add_dependency "html-pipeline"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionpack", ">= 3.0"
+  spec.add_development_dependency "rspec", "~> 2.14"
+
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/html_pipeline_rails.rb

@@ -0,0 +1,18 @@
+require 'html_pipeline_rails/configuration'
+require 'html_pipeline_rails/handler'
+require 'html_pipeline_rails/version'
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+module HtmlPipelineRails
+  mattr_accessor :configuration
+  self.configuration = Configuration.new
+
+  def self.config
+    yield self.configuration
+  end
+end
+
+ActionView::Template.register_template_handler(:md, HtmlPipelineRails::Handler.new)
+ActionView::Template.register_template_handler(:mdown, HtmlPipelineRails::Handler.new)
+ActionView::Template.register_template_handler(:markdown, HtmlPipelineRails::Handler.new)

data/lib/html_pipeline_rails/configuration.rb

@@ -0,0 +1,15 @@
+module HtmlPipelineRails
+  class Configuration
+    attr_accessor :pipeline
+
+    def initialize
+      self.reset!
+    end
+
+    def reset!
+      self.pipeline = HTML::Pipeline.new([
+        HTML::Pipeline::MarkdownFilter
+      ])
+    end
+  end
+end

data/lib/html_pipeline_rails/handler.rb

@@ -0,0 +1,24 @@
+require 'html/pipeline'
+
+module HtmlPipelineRails
+  class Handler
+    def default_format
+      :html
+    end
+
+    def call(template)
+      compiled_source = self.class.erb.call(template)
+
+      <<-END
+        pipeline = HtmlPipelineRails.configuration.pipeline
+        result = pipeline.call(begin;#{compiled_source};end)
+        result[:output].to_s
+      END
+    end
+
+    # via http://stackoverflow.com/a/10131299/358804
+    def self.erb
+      @erb ||= ActionView::Template.registered_template_handler(:erb)
+    end
+  end
+end

data/lib/html_pipeline_rails/version.rb

@@ -0,0 +1,3 @@
+module HtmlPipelineRails
+  VERSION = "0.1.0"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe HtmlPipelineRails::Configuration do
+  describe '#reset' do
+    let(:config) { HtmlPipelineRails::Configuration.new }
+
+    it "sets the pipeline to the default" do
+      config.pipeline = HTML::Pipeline.new([
+        HTML::Pipeline::MarkdownFilter,
+        HTML::Pipeline::MentionFilter
+      ])
+      config.reset!
+      expect(config.pipeline.filters).to eq([HTML::Pipeline::MarkdownFilter])
+    end
+  end
+end

data/spec/fixtures/templates/_fake_md.html

@@ -0,0 +1 @@
+# Fake Heading

data/spec/fixtures/templates/_simple_md.html.md

@@ -0,0 +1 @@
+# A Heading

data/spec/html_pipeline_rails_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe HtmlPipelineRails do
+  describe '.config' do
+    it "runs the config block" do
+      block_run = false
+      HtmlPipelineRails.config do |c|
+        block_run = true
+      end
+      expect(block_run).to be_true
+    end
+
+    it "defaults to include the MarkdownFilter" do
+      HtmlPipelineRails.config do |c|
+        pipeline = c.pipeline
+        expect(pipeline).to be_an(HTML::Pipeline)
+        expect(pipeline.filters).to eq([HTML::Pipeline::MarkdownFilter])
+      end
+    end
+  end
+end

data/spec/markdown_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe "markdown views" do
+  before do
+    setup_view_instance
+  end
+
+  it "inline rendering" do
+    template = '# A Heading'
+    result = @view.render(inline: template, type: :md)
+    expect(result).to eq('<h1>A Heading</h1>')
+  end
+
+  it "doesn't affect normal HTML rendering" do
+    template = '# A Heading'
+    result = @view.render(inline: template)
+    expect(result).to eq(template)
+  end
+
+  it "renders external templates" do
+    result = @view.render('simple_md')
+    expect(result).to eq("<h1>A Heading</h1>")
+  end
+
+  it "doesn't affect normal external HTML templates" do
+    result = @view.render('fake_md')
+    expect(result).to eq("# Fake Heading\n")
+  end
+
+  it "interprets ERB" do
+    template = '<%= 1 + 1 %>'
+    result = @view.render(inline: template, type: :md)
+    # not sure why it gets wrapped...
+    expect(result).to eq('<p>2</p>')
+  end
+
+  it "uses the configured pipeline" do
+    HtmlPipelineRails.config do |c|
+      c.pipeline = HTML::Pipeline.new([
+        HTML::Pipeline::MarkdownFilter,
+        HTML::Pipeline::MentionFilter
+      ])
+    end
+
+    template = '@afeld'
+    result = @view.render(inline: template, type: :md)
+    expect(result).to eq('<p><a href="/afeld" class="user-mention">@afeld</a></p>')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+
+require 'action_view'
+require_relative '../lib/html_pipeline_rails'
+
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before do
+    HtmlPipelineRails.config do |c|
+      c.reset!
+    end
+  end
+end
+
+
+def setup_view_instance
+  @view = ActionView::Base.new
+  @view.view_paths << File.join(File.dirname(__FILE__), 'fixtures', 'templates')
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: html_pipeline_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- aidan.feldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- html_pipeline_rails.gemspec
+- lib/html_pipeline_rails.rb
+- lib/html_pipeline_rails/configuration.rb
+- lib/html_pipeline_rails/handler.rb
+- lib/html_pipeline_rails/version.rb
+- spec/configuration_spec.rb
+- spec/fixtures/templates/_fake_md.html
+- spec/fixtures/templates/_simple_md.html.md
+- spec/html_pipeline_rails_spec.rb
+- spec/markdown_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/afeld/html_pipeline_rails/
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Render Markdown via HTML::Pipeline in Rails.
+test_files:
+- spec/configuration_spec.rb
+- spec/fixtures/templates/_fake_md.html
+- spec/fixtures/templates/_simple_md.html.md
+- spec/html_pipeline_rails_spec.rb
+- spec/markdown_spec.rb
+- spec/spec_helper.rb