magnet-markdown 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f53ec18f51f0eae26fede22479045722d09bd02
+  data.tar.gz: f976dd234f55fb546881aa699b9188a3c3ab177a
+SHA512:
+  metadata.gz: 05894ffada70821a3a7eb65454680f4657318697d0a2d14066ae757168c35a6c886d73c8269a82aee7afaa7326502f2ecca0995ad4f62f43f2d3586a6fc5f7b5
+  data.tar.gz: 43acabf65ea5373872516a8552068cd16574a3fc9d0b9fc528e7db4baf4a79ee4557fc60b42e75b82ec20b23bce42903161b477dc6f5916da0f5771e1e1da079

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Include:
+    - 'Rakefile'
+    - 'config.ru'
+    - '*.gemspec'
+    - 'Gemfile'
+
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+FileName:
+  Exclude:
+    - 'lib/magnet-markdown.rb'
+  Enabled: true
+
+LineLength:
+  Max: 124

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in magnet-markdown.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rubocop'
+  gem 'test-unit-notify'
+  gem 'guard-test'
+  gem 'pry-byebug'
+  gem 'terminal-notifier'
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :test do
+  watch(/^lib\/(.*)\.rb/)                              { |m| "test/lib/#{m[1]}_test.rb" }
+  watch(/^test\/(.*)_test.rb/)
+  watch(/^test\/test_helper.rb/)                       { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sho Kusano
+
+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,58 @@
+# Magnet::Markdown
+
+[![Gem Version](https://badge.fury.io/rb/magnet-markdown.svg)](http://badge.fury.io/rb/magnet-markdown) [![Build Status](https://travis-ci.org/magnet-inc/magnet-markdown.svg)](https://travis-ci.org/magnet-inc/magnet-markdown) [![Dependency Status](https://gemnasium.com/magnet-inc/magnet-markdown.svg)](https://gemnasium.com/magnet-inc/magnet-markdown)
+
+Magent specified markdown processor. Inspired by [qiita-markdown](https://github.com/increments/qiita-markdown).
+
+Default processors:
+
+- `Magnet::Markdown::Filter::Markdown`: convert markdown to html
+- `Magnet::Markdown::Filter::Sanitize`: whitelist sanitize user markup
+- `HTML::Pipeline::Filter::ImageMaxWidthFilter`: link to full size image for large images
+- `Magnet::Markdown::Filter::Emoji`: covert :emoji: to img elements
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magnet-markdown'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install magnet-markdown
+```
+
+## Usage
+
+`Magnet::Markdown::Processor` provides markdown rendering:
+
+```ruby
+processor = Magnet::Markdown::Processor.new
+processor.call(markdow)
+# => {
+#   output: '<h1>Example</h1> ...'
+# }
+```
+
+### Options
+
+- `emoji_root`: base url to link to emoji sprite
+- `emoji_path`: url path to link to emoji sprite. `:filename` can be used as a placeholder for the sprite file name. If no `emoji_path` is set "emoji/:filename" is used.
+- `allow_script`: Default false. If set true, Do not remove `script` elements.
+
+## Contributing
+
+1. Fork it ( https://github.com/magnet-inc/magnet-markdown/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = true
+end
+
+task default: %i(rubocop test)

data/lib/magnet-markdown.rb

@@ -0,0 +1 @@
+require 'magnet/markdown'

data/lib/magnet/markdown.rb

@@ -0,0 +1,2 @@
+require 'magnet/markdown/version'
+require 'magnet/markdown/processor'

data/lib/magnet/markdown/filter.rb

@@ -0,0 +1,8 @@
+require 'magnet/markdown'
+
+module Magnet::Markdown::Filter
+end
+
+require 'magnet/markdown/filter/markdown'
+require 'magnet/markdown/filter/sanitize'
+require 'magnet/markdown/filter/emoji'

data/lib/magnet/markdown/filter/emoji.rb

@@ -0,0 +1,55 @@
+require 'gemoji'
+require 'magnet/markdown/filter'
+
+class Magnet::Markdown::Filter::Emoji < HTML::Pipeline::Filter
+  def self.emojis
+    Emoji.all.map(&:aliases).flatten.sort
+  end
+
+  def self.regexp_pattern
+    @regexp_pattern ||= /:(?<name>#{ (emojis.map { |n| Regexp.escape(n) }).join('|') }):/xo
+  end
+
+  def self.img_tag
+    '<img class="emoji" alt=":%{name}:" title=":%{name}:" style="width: 1em; height: 1em;" align="absmiddle" src="%{src}">'
+  end
+
+  def call
+    doc.search('text()').each do |node|
+      content = node.to_html
+      next unless content.include?(':')
+      next if has_ancestor?(node, %w(pre code tt))
+      html = emojify(content)
+      next if html == content
+      node.replace(html)
+    end
+    doc
+  end
+
+  def validate
+    needs :emoji_root
+  end
+
+  def emojify(html)
+    html.gsub(self.class.regexp_pattern) do |_match|
+      name = Regexp.last_match['name']
+      self.class.img_tag % { name: name, src: src_url(name) }
+    end
+  end
+
+  def src_url(emoji_name)
+    File.join(context[:emoji_root], src_path(emoji_name))
+  end
+
+  def src_path(emoji_name)
+    if context[:emoji_path]
+      context[:emoji_path].sub(':filename', emoji_filename(emoji_name))
+    else
+      File.join('emoji', emoji_filename(emoji_name))
+    end
+  end
+
+  def emoji_filename(emoji_name)
+    Emoji.find_by_alias(emoji_name).image_filename
+  end
+end

data/lib/magnet/markdown/filter/markdown.rb

@@ -0,0 +1,15 @@
+require 'github/markdown'
+require 'magnet/markdown/filter'
+
+class Magnet::Markdown::Filter::Markdown < HTML::Pipeline::TextFilter
+  def initialize(text, context = nil, result = nil)
+    super
+    @text = @text.gsub("\r", '')
+  end
+
+  def call
+    html = GitHub::Markdown.to_html(@text, :gfm)
+    html.rstrip!
+    html
+  end
+end

data/lib/magnet/markdown/filter/sanitize.rb

@@ -0,0 +1,87 @@
+require 'sanitize'
+require 'magnet/markdown/filter'
+
+class Magnet::Markdown::Filter::Sanitize < HTML::Pipeline::Filter
+  RULE = {
+    attributes: {
+      'a' => [
+        'href'
+      ],
+      'iframe' => %w(allowfullscreen frameborder height marginheight marginwidth scrolling src style width),
+      'img' => [
+        'src'
+      ],
+      'div' => %w(itemscope itemtype),
+      'script' => %w(async src),
+      all: [
+        'abbr',
+        'align',
+        'alt',
+        'border',
+        'cellpadding',
+        'cellspacing',
+        'cite',
+        'class',
+        'color',
+        'cols',
+        'colspan',
+        'datetime',
+        'height',
+        'hreflang',
+        'id',
+        'itemprop',
+        'lang',
+        'name',
+        'tabindex',
+        'target',
+        'title',
+        'width',
+        :data
+      ]
+    },
+    elements: %w(
+      a b blockquote br code dd del div dl dt em font h1 h2 h3 h4 h5 h6 h7 h8 hr i img ins kbd li ol p pre q rp rt ruby s
+      samp strike strong sub sup table tbody td tfoot th thead tr tt ul var
+    ),
+    protocols: {
+      'a' => {
+        'href' => [
+          :relative,
+          'http',
+          'https'
+        ]
+      },
+      'img' => {
+        'src' => [
+          :relative,
+          'http',
+          'https'
+        ]
+      }
+    },
+    remove_contents: [
+      'script'
+    ]
+  }
+
+  ALLOW_SCRIPT_RULE = RULE.dup.tap do |rule|
+    rule[:elements] = RULE[:elements] + %w(iframe script)
+    rule[:remove_contents] = []
+  end
+
+  def call
+    ::Sanitize.node!(doc, rule)
+    doc
+  end
+
+  def rule
+    case
+    when context[:sanitize_rule]
+      context[:sanitize_rule]
+    when context[:allow_script] == true
+      ALLOW_SCRIPT_RULE
+    else
+      RULE
+    end
+  end
+end

data/lib/magnet/markdown/processor.rb

@@ -0,0 +1,29 @@
+require 'html/pipeline'
+require 'magnet/markdown'
+require 'magnet/markdown/filter'
+
+class Magnet::Markdown::Processor
+  DEFAULT_CONTEXT = {
+    emoji_root: '/images'
+  }.freeze
+
+  DEFAULT_FILTERS = [
+    Magnet::Markdown::Filter::Markdown,
+    Magnet::Markdown::Filter::Sanitize,
+    HTML::Pipeline::ImageMaxWidthFilter,
+    Magnet::Markdown::Filter::Emoji
+  ].freeze
+
+  def initialize(context = nil)
+    context ||= {}
+    @context = DEFAULT_CONTEXT.merge(context)
+  end
+
+  def call(input, context = nil)
+    HTML::Pipeline.new(filters, @context).call(input, context || {})
+  end
+
+  def filters
+    @filters ||= DEFAULT_FILTERS.clone
+  end
+end

data/lib/magnet/markdown/version.rb

@@ -0,0 +1,5 @@
+module Magnet
+  module Markdown
+    VERSION = '0.0.1'
+  end
+end

data/magnet-markdown.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magnet/markdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'magnet-markdown'
+  spec.version       = Magnet::Markdown::VERSION
+  spec.authors       = ['Sho Kusano']
+  spec.email         = ['sho-kusano@mgnt-inc.jp']
+  spec.summary       = 'Magnet specified markdown processor'
+  spec.homepage      = 'https://github.com/magnet-inc/magnet-markdown'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'test-unit', '~> 3.0'
+
+  spec.add_dependency 'github-markdown', '~> 0.6'
+  spec.add_dependency 'sanitize', '~> 3.0'
+  spec.add_dependency 'gemoji', '~> 2.0'
+  spec.add_dependency 'html-pipeline', '~> 1.11'
+end

data/test/lib/magnet/markdown/processor_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class Magnet::Markdown::ProcessorTest < Test::Unit::TestCase
+  setup do
+    @processor = Magnet::Markdown::Processor.new(@context)
+  end
+
+  test :markdown do
+    @input = '# h1'
+    assert { output == '<h1>h1</h1>' }
+  end
+
+  test :auto_link do
+    @input = 'Google > http://google.com'
+    assert { output.include?('Google &gt; <a href="http://google.com">http://google.com</a>') }
+  end
+
+  test :sanitize do
+    @input = <<-EOS
+<img src="http://localhost/img.png">
+
+<script src="http://localhost/script.js"></script>
+    EOS
+
+    assert do
+      output.include?('<img')
+    end
+
+    assert do
+      !output.include?('<script')
+    end
+
+    @call_context = { allow_script: true }
+
+    assert do
+      output.include?('<script')
+    end
+  end
+
+  test :img_maxwidth do
+    @input = '![](http://localhost/img.png)'
+    assert { output.include?('max-width') && output.include?('<img') }
+  end
+
+  test :emoji do
+    @input = ':thumbsup:'
+    assert { output.include?('<img') }
+    assert { output.include?('/images/emoji') }
+    @call_context = { emoji_root: 'http://static.emoji/' }
+    assert { !output.include?('/images/emoji') && output.include?('http://static.emoji/emoji') }
+    @call_context = { emoji_root: 'http://static.emoji/', emoji_path: 'images/emoji/:filename' }
+    assert { output.include?('http://static.emoji/images/emoji/unicode/') }
+  end
+
+  private
+
+  def result
+    @processor.call(@input, @call_context)
+  end
+
+  def output
+    result[:output].to_s
+  end
+end

data/test/lib/magnet/markdown_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class Magnet::MarkdownTest < Test::Unit::TestCase
+  test :version do
+    assert { Magnet::Markdown::VERSION == '0.0.1' }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'magnet-markdown'
+require 'test/unit'

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: magnet-markdown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sho Kusano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: test-unit
+  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: github-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: 
+email:
+- sho-kusano@mgnt-inc.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magnet-markdown.rb
+- lib/magnet/markdown.rb
+- lib/magnet/markdown/filter.rb
+- lib/magnet/markdown/filter/emoji.rb
+- lib/magnet/markdown/filter/markdown.rb
+- lib/magnet/markdown/filter/sanitize.rb
+- lib/magnet/markdown/processor.rb
+- lib/magnet/markdown/version.rb
+- magnet-markdown.gemspec
+- test/lib/magnet/markdown/processor_test.rb
+- test/lib/magnet/markdown_test.rb
+- test/test_helper.rb
+homepage: https://github.com/magnet-inc/magnet-markdown
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Magnet specified markdown processor
+test_files:
+- test/lib/magnet/markdown/processor_test.rb
+- test/lib/magnet/markdown_test.rb
+- test/test_helper.rb