has_html_pipeline 0.0.1

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,15 @@
+language: ruby
+
+jdk: openjdk7
+
+env:
+  - JRUBY_OPTS="-Xcext.enabled=true"
+
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'html-pipeline-no-charlock'
+
+# Specify your gem's dependencies in has_html_pipeline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ian Yang
+
+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,48 @@
+# HasHtmlPipeline
+
+TODO: Write a gem description
+
+## Installation
+
+Add following lines to your application's Gemfile:
+
+    gem 'html-pipeline'
+    # or
+    # gem 'html-pipeline-no-charlock'
+    gem 'has_html_pipeline'
+
+Gem `html-pipeline` must be added manually since it has too many unnecessary
+dependencies, so you can choose to include `html-pipeline-no-charlock`.
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline # or html-pipeline-no-charlock
+    $ gem install has_html_pipeline
+
+## Usage
+
+    HasHtmlPipeline.register_html_pipeline(:markdown, [HTML::Pipeline::MarkdownFilter])
+
+    class User
+      extend HasHtmlPipeline
+
+      attr_accessor :about
+
+      has_html_pipeline :about, :markdown
+    end
+
+    u = User.new
+    u.about = '# Markdown #'
+    u.about_html # => '<h1>Markdown</h1>'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/has_html_pipeline.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_html_pipeline/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "has_html_pipeline"
+  gem.version       = HasHtmlPipeline::VERSION
+  gem.authors       = ["Ian Yang"]
+  gem.email         = ["me@iany.me"]
+  gem.description   = %q{Ease using html-pipeline to convert an object attribute to HTML}
+  gem.summary       = %q{Add a "#{attr}_html" method to apply the pre-registered html pipelines on attr getter method.}
+  gem.homepage      = "https://github.com/doitian/has_html_pipeline"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/lib/has_html_pipeline.rb

@@ -0,0 +1,47 @@
+require 'html/pipeline'
+
+# Usage:
+#
+#     HasHtmlPipeline.register_html_pipeline(:markdown, [HTML::Pipeline::MarkdownFilter])
+#
+#     class User
+#       extend HasHtmlPipeline
+#
+#       attr_accessor :about
+#
+#       has_html_pipeline :about, :markdown
+#     end
+#
+#     u = User.new
+#     u.about = '# Markdown #'
+#     u.about_html # => '<h1>Markdown</h1>'
+#
+module HasHtmlPipeline
+  class << self
+    # for `include HasHtmlPipeline`
+    def included(klass)
+      klass.extend(self)
+    end
+
+    def registered_html_pipelines
+      @registered_html_pipelines ||= {}
+    end
+
+    def register_html_pipeline(name, filters, context = {})
+      registered_html_pipelines[name.to_sym] = HTML::Pipeline.new(filters, context)
+    end
+
+    alias_method :register, :register_html_pipeline
+
+    def configure
+      yield self
+    end
+  end
+
+  def has_html_pipeline(field, pipeline_name)
+    define_method "#{field}_html" do
+      pipeline = ::HasHtmlPipeline.registered_html_pipelines[pipeline_name.to_sym]
+      pipeline.call(send(field))[:output].to_s
+    end
+  end
+end

data/lib/has_html_pipeline/version.rb

@@ -0,0 +1,3 @@
+module HasHtmlPipeline
+  VERSION = "0.0.1"
+end

data/spec/lib/has_html_pipeline_spec.rb

@@ -0,0 +1,38 @@
+require 'has_html_pipeline'
+
+describe HasHtmlPipeline do
+  context 'when a markdown pipeline has been registered' do
+    before do
+      HasHtmlPipeline.register_html_pipeline :test, [HTML::Pipeline::MarkdownFilter]
+    end
+
+    context 'User has field about and has the markdown pipeline on about' do
+      let(:klass) {
+        Class.new do
+          extend HasHtmlPipeline
+          attr_accessor :about
+          has_html_pipeline :about, :test
+        end
+      }
+      let(:user) { klass.new }
+
+      context 'when assign about with markdown' do
+        before do
+          user.about = <<-MD
+# Title #
+
+- list item 1
+- list item 2
+          MD
+        end
+
+        subject { user.about_html }
+
+        it { should include('<h1>Title</h1>') }
+        it { should include('<li>list item 1</li>') }
+        it { should include('<li>list item 2</li>') }
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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.
+#
+# 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'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: has_html_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ease using html-pipeline to convert an object attribute to HTML
+email:
+- me@iany.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_html_pipeline.gemspec
+- lib/has_html_pipeline.rb
+- lib/has_html_pipeline/version.rb
+- spec/lib/has_html_pipeline_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/doitian/has_html_pipeline
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4008131752445651120
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4008131752445651120
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add a "#{attr}_html" method to apply the pre-registered html pipelines on
+  attr getter method.
+test_files:
+- spec/lib/has_html_pipeline_spec.rb
+- spec/spec_helper.rb