mato 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e9c1e34a9de8097eac4c6dc8ac7483396840d3
-  data.tar.gz: c973f404428162926476f304f4065adf67a6c39e
+  metadata.gz: 195f9886598ddf1a08ec46a3b9bb30dfa21a943c
+  data.tar.gz: ee6f5a7eeb28141a9b0a3fd63c9c4867e8bbb8bd
 SHA512:
-  metadata.gz: 8b4ba43e301ce5acb9f64c30337492d7de2f826bcf84d129bac651f80dbc8a7d8af79e589397e85ccd904607f84d4841bd313a972e68f7b93b443c022025fc92
-  data.tar.gz: 1506a0cf205c34f83ce14965827c17fb3f7d660d4ea117df645846b5f9a51559756969b9dc494089ff2f94be5cd7072ed07ed4456ff890d8f0d555f041124a7b
+  metadata.gz: d094d454579750f042c6fc586233f9f94172efc490969b8e2d55b9c7ec9f3d5ad2efb59e881fba36e802cef7aee51e35ccc89fc80cde024b047e7a563447fc67
+  data.tar.gz: 57481242dfab44c1c3718ba1a36d917ecf4af9da1722d8c29479e41ce58153dd27e869820c5075b1852e16dd078943c642cba77cead030308da8df6106e9b73a

data/.rubocop.yml

@@ -15,6 +15,9 @@ Lint/AmbiguousBlockAssociation:
 Lint/ScriptPermission:
   Enabled: false
 
+Lint/RescueWithoutErrorClass:
+  Enabled: false
+
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
@@ -22,7 +25,7 @@ Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 32
+  Max: 35
 
 Metrics/PerceivedComplexity:
   Max: 10
@@ -57,7 +60,7 @@ Style/CommentAnnotation:
 Style/Documentation:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
 Style/GuardClause:
@@ -114,13 +117,13 @@ Style/AsciiComments:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
-Style/VariableNumber:
+Naming/VariableNumber:
   Enabled: false
 
-Style/PredicateName:
+Naming/PredicateName:
   Enabled: false
 
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 Style/YodaCondition:
@@ -135,5 +138,8 @@ Style/MultipleComparison:
 Style/StructInheritance:
   Enabled: false
 
+Style/NonNilCheck:
+  Enabled: false
+
 Performance/RedundantBlockCall:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # The revision history of Mato
 
-## v1.3.3 - 2017/09/22
+## v1.3.0 - 2017/09/26
+
+https://github.com/bitjourney/mato/compare/v1.2.3...1.3.0
+
+* Added `timeout:`, `on_timeout:` and `on_error:` options to `append_*_filter` [#10](https://github.com/bitjourney/mato/pull/10)
+
+
+## v1.2.3 - 2017/09/22
 
 https://github.com/bitjourney/mato/compare/v1.2.2...1.2.3
 

data/README.md

@@ -1,4 +1,4 @@
-# Mato [![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) [![Gem Version](https://badge.fury.io/rb/mato.svg)](https://badge.fury.io/rb/mato)
 
 **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).
 
@@ -122,6 +122,28 @@ end
 mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
 ```
 
+### Timeout
+
+There is `timeout` option to kill filters in a specified time in seconds:
+
+```ruby
+mato = Mato.define do |config|
+  config.append_html_filter(FooFilter, timeout: timeout_in_sec, on_timeout: callback)
+end
+```
+
+If you set `on_error` callback, you can omit `on_timeout` callback.
+
+### Errors in Filters
+
+There is `on_error` callback to rescue errors in filters:
+
+```ruby
+mato = Mato.define do |config|
+  config.append_html_filter(FooFilter, on_error: callback)
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mato.rb

@@ -5,6 +5,8 @@ require_relative "./mato/version"
 require_relative "./mato/config"
 require_relative "./mato/processor"
 require_relative "./mato/converter"
+require_relative "./mato/rescue"
+require_relative "./mato/timeout"
 
 # filter classes
 require_relative "./mato/html_filters/token_link"

data/lib/mato/config.rb

@@ -75,34 +75,33 @@ module Mato
       block.call(self)
     end
 
-    def append_text_filter(text_filter)
+    def append_text_filter(text_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "text_filter must respond to call()" unless text_filter.respond_to?(:call)
-      text_filters.push(text_filter)
+      text_filters.push(wrap(text_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 
-    def prepend_text_filter(text_filter)
-      raise "text_filter must respond to call()" unless text_filter.respond_to?(:call)
-      text_filters.unshift(text_filter)
-    end
-
-    def append_markdown_filter(markdown_filter)
-      raise "markdown_filter must respond to call()" unless markdown_filter.respond_to?(:call)
-      markdown_filters.push(markdown_filter)
-    end
-
-    def prepend_markdown_filter(markdown_filter)
+    def append_markdown_filter(markdown_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "markdown_filter must respond to call()" unless markdown_filter.respond_to?(:call)
-      markdown_filters.unshift(markdown_filter)
+      markdown_filters.push(wrap(markdown_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 
-    def append_html_filter(html_filter)
+    def append_html_filter(html_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "html_filter must respond to call()" unless html_filter.respond_to?(:call)
-      html_filters.push(html_filter)
+      html_filters.push(wrap(html_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 
-    def prepend_html_filter(html_filter)
-      raise "html_filter must respond to call()" unless html_filter.respond_to?(:call)
-      html_filters.unshift(html_filter)
+    private
+
+    def wrap(filter, timeout:, on_timeout:, on_error:)
+      if timeout
+        filter = Mato::Timeout.new(filter, timeout: timeout, on_timeout: on_timeout || on_error)
+      end
+
+      if on_error
+        filter = Mato::Rescue.new(filter, on_error: on_error)
+      end
+
+      filter
     end
   end
 end

data/lib/mato/rescue.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mato
+  class Rescue
+    attr_reader :filter
+    attr_reader :on_error
+
+    def initialize(filter, on_error:)
+      @filter = filter
+      @on_error = on_error
+    end
+
+    def call(content)
+      filter.call(content)
+    rescue => e
+      on_error.call(e)
+      content
+    end
+  end
+end

data/lib/mato/timeout.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module Mato
+  class Timeout
+    attr_reader :filter
+    attr_reader :duration_sec
+    attr_reader :on_timeout
+
+    def initialize(filter, timeout:, on_timeout:)
+      @filter = filter
+      @duration_sec = timeout
+      @on_timeout = on_timeout
+
+      unless on_timeout
+        raise ArgumentError, "Missing on_timeout callback"
+      end
+    end
+
+    def call(content)
+      ::Timeout.timeout(duration_sec) do
+        filter.call(content)
+      end
+    rescue ::Timeout::Error => e
+      on_timeout.call(e)
+      content
+    end
+  end
+end

data/lib/mato/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -87,6 +87,8 @@ files:
 - lib/mato/processor.rb
 - lib/mato/renderers/html_renderer.rb
 - lib/mato/renderers/html_toc_renderer.rb
+- lib/mato/rescue.rb
+- lib/mato/timeout.rb
 - lib/mato/version.rb
 - mato.gemspec
 homepage: https://github.com/bitjourney/mato