mato 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc964ed48f7d5e7d1d069e32b2ea3701118a6765
-  data.tar.gz: 310ca6e0226f7ebaf1da5653d17a926580c8c476
+  metadata.gz: 267a8ba9de0057c636442e480e5a1f714053fd74
+  data.tar.gz: 1f712541459bdfd13d3e3fb06d028e74e97daabb
 SHA512:
-  metadata.gz: b19a063ae37c6885ae08a1e1d961a3519f36dc19fd42370a09f95a143f5a1b3f84d5d17adb17f48e8247db268d8750f0c1759a54193e6f7c93e73696a08b45ba
-  data.tar.gz: 1b6d1995d00dba709bd52d8138530ce8fe66699b5006060dc10277333569a23582fec03ab0f86a47380e3eee5328fbc6739b841152d5a5a27219d3f842ffca80
+  metadata.gz: c5c98659f58a6d9b14ba67e64391c65b437f8a3da079f4bf6b3e7c6e42995a324f12d4806431906828b6ab42328c5a07f3cd8ce3a156542206fa4482554f3b8e
+  data.tar.gz: b5103f9005d068465350f405391b730a2490dc54fb81fdfbb118dcd8973265945deb8d5f0d6656171e1d04f26666f6a467cf3ff68639f06574592b652d98178d

data/Gemfile

@@ -5,8 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in mato.gemspec
 gemspec
 
-gem "sanitize"
 gem "rouge"
+gem "sanitize"
 
 gem "m"
 gem "minitest"

data/README.md

@@ -1,10 +1,10 @@
-# Mato - Markdown Toolkit based on CommonMark [![Build Status](https://travis-ci.org/bitjourney/mato.svg?branch=master)](https://travis-ci.org/bitjourney/mato)
+# Mato [![Build Status](https://travis-ci.org/bitjourney/mato.svg?branch=master)](https://travis-ci.org/bitjourney/mato)
 
-**Mato**, standing for **Ma**rkdown **To**oolkit,  is an extensible markdown-based content processing toolkit, inspired by [HTML::Pipeline](https://github.com/jch/html-pipeline).
+**Mato**, standing for **Ma**rkdown **To**oolkit,  is an extensible, pipeline-based markdown processing toolkit, inspired by [HTML::Pipeline](https://github.com/jch/html-pipeline).
 
 
 This gem is built on [commonmarker](https://github.com/gjtorikian/commonmarker), a [CommonMark](https://github.com/jgm/CommonMark) implementation,
-which can parse markdown documents into AST.
+which can parse markdown documents.
 
 ## Synopsis
 
@@ -78,9 +78,16 @@ Or install it yourself as:
 
     $ gem install mato
 
-## Usage
+## Motivation
 
-TODO: Write usage instructions here
+The original idea comes from [qiita-markdown](https://github.com/increments/qiita-markdown),
+a markdown processing tool like mato, based on html-pipeline.
+
+html-pipeline is a great tool that invents the idea of "pipeline", to filter HTML node (or `Nokogiri::XML::Node`) in each filter. This is safe, fast, and easy to enhance.
+
+However, html-pipeline is not suitable for cache, esp. context-aware caching.
+
+(TBD)
 
 ## Optional Dependencies
 
@@ -97,7 +104,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bitjourney/mato.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/mato/config.rb

@@ -10,14 +10,14 @@ module Mato
     DEFAULT_MARKDOWN_PARSE_OPTIONS = %i[
       DEFAULT
       VALIDATE_UTF8
-    ]
+    ].freeze
 
     # https://github.com/gjtorikian/commonmarker#render-options
     DEFAULT_MARKDOWN_RENDER_OPTIONS = [
       :DEFAULT,
       :HARDBREAKS, # convert "\n" as <br/>
       # :SOURCEPOS, // TODO: enable it after assertions are supported
-    ]
+    ].freeze
 
     # https://github.com/github/cmark/tree/master/extensions
     DEFAULT_MARKDOWN_EXTENSIONS = %i[
@@ -25,7 +25,7 @@ module Mato
       strikethrough
       autolink
       tagfilter
-    ]
+    ].freeze
 
     # @return [Array<Proc>]
     attr_accessor :text_filters

data/lib/mato/document.rb

@@ -54,7 +54,7 @@ module Mato
 
     def marshal_dump
       {
-        fragment: fragment.to_s,
+        fragment: fragment.to_html(save_with: 0),
       }
     end
 

data/lib/mato/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mato
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/mato.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["goro-fuj@bitjoureny.com"]
 
   spec.summary       = 'MArkdown TOolkit'
-  spec.description   = 'An extensible markdown processing toolkit based on CommonMark'
+  spec.description   = 'A pipeline-based markdown toolkit with CommonMark(er)'
   spec.homepage      = "https://github.com/bitjourney/mato"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-description: An extensible markdown processing toolkit based on CommonMark
+description: A pipeline-based markdown toolkit with CommonMark(er)
 email:
 - goro-fuj@bitjoureny.com
 executables: []