mato 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 267a8ba9de0057c636442e480e5a1f714053fd74
-  data.tar.gz: 1f712541459bdfd13d3e3fb06d028e74e97daabb
+  metadata.gz: ee2da8ff1a51b08c0831e7c493a6b3061b967996
+  data.tar.gz: 718d69d428ba169fb9038620e7d8237fdceb6486
 SHA512:
-  metadata.gz: c5c98659f58a6d9b14ba67e64391c65b437f8a3da079f4bf6b3e7c6e42995a324f12d4806431906828b6ab42328c5a07f3cd8ce3a156542206fa4482554f3b8e
-  data.tar.gz: b5103f9005d068465350f405391b730a2490dc54fb81fdfbb118dcd8973265945deb8d5f0d6656171e1d04f26666f6a467cf3ff68639f06574592b652d98178d
+  metadata.gz: 6f2e0cdf40756e8d89cca2acc9c8a8bf294bcc35badac57dfeb07f9f986b6488fd5ea6bcc0e059f230c0f539ec1b20450a2ebd147741e13ddcd544aaf2fe33af
+  data.tar.gz: 335c587327afdb1c7642c0141b65db49f93ffc644c61b5ef45592c9804808846dc6befc0e50b9e059e7eedd7ae59a785c3097d701a1db04b06f32fe9bb59b5e6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# The revision history of Mato
+
+## v1.0.0 - 2017/08/08
+
+* Initial stable version

data/README.md

@@ -6,7 +6,7 @@
 This gem is built on [commonmarker](https://github.com/gjtorikian/commonmarker), a [CommonMark](https://github.com/jgm/CommonMark) implementation,
 which can parse markdown documents.
 
-## Synopsis
+## Usage
 
 ```ruby
 require 'mato'
@@ -58,10 +58,70 @@ end
 # Because Mato::Document is serializable, you can cache the base doc and then apply extra filters on demaond.
 new_doc = doc.apply_html_filters(
   -> (fragment) { modify_fragment!(fragment) },
-  SomeHtmlFilter.new, # anything that has #call(node) method
+  SomeHtmlFilter.new(some_context), # anything that has #call(node) method
 )
 ```
 
+## Filters
+
+There are three kinds of filters to mutate input texts in Mato:
+
+* Text Filters
+* Markdown Filters
+* HTML Filters
+
+### Text Filters
+
+A text filter is a callable instance that takes a `String`
+and returns a mutated arg.
+
+For example:
+
+```ruby
+mato = Mato.define do |config|
+  config.append_text_filter(->(text) {
+    text.upcase
+  })
+end
+
+mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
+```
+
+### Markdown Filters
+
+A markdown filter is a callable instance that takes a ``CommonMarker::Node`
+and mutate it in the method. The return value is ignored.
+
+For example:
+
+```ruby
+mato = Mato.define do |config|
+  config.append_markdown_filter(->(doc) {
+    paragraph = doc.first_child
+    text_node = paragraph.first_child
+    text_node.string_content = text_node.string_content.upcase
+  })
+end
+
+mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
+```
+
+### HTML Filters
+
+An HTML filter is a callable object that takes a ``Nokogiri::HTML::DocumentFragment`
+and mutate it in the method. The return value is ignored.
+
+```ruby
+mato = Mato.define do |config|
+  config.append_html_filter(->(doc) {
+    text_node = doc.xpath('.//text()').first
+    text_node.content = text_node.content.upcase
+  })
+end
+
+mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mato/processor.rb

@@ -20,12 +20,14 @@ module Mato
       text = input.dup
 
       config.text_filters.each do |filter|
-        filter.call(text)
+        # A text filter returns a mutated text
+        text = filter.call(text)
       end
 
       markdown_node = parse_markdown(text)
 
       config.markdown_filters.each do |filter|
+        # A markdown filter mutates the argument
         filter.call(markdown_node)
       end
 
@@ -33,6 +35,7 @@ module Mato
       doc = parse_html(html)
 
       config.html_filters.each do |filter|
+        # An HTML filter mutates the argument
         filter.call(doc)
       end
 

data/lib/mato/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md