paru 0.2.4.6 → 0.2.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76f86581e1e26603a9f55ae60486552c537f0714
-  data.tar.gz: e61570f118ec77fa9ebf544f6c22d41c6e2e1437
+  metadata.gz: 1332fd988cbb97b8dd7cd1c45c20a90706cfb537
+  data.tar.gz: 168c0c5db7710ac7ae6e7abe4f5219c6a77ea248
 SHA512:
-  metadata.gz: ae430e95dadc46085b1fb56c3a1c8a44c06bf1da5bbfec0893b654e6c0e0e612df34cf0b0fd03b4c0cba32e794bf1558e148c014578fc1264f792e0762d2bbe5
-  data.tar.gz: 54a434f05bb8d027cdb91330075bdd776b8c5d0de3b692a548cbb282fae609113aa86ad5d57aa4f3917b7c3681abd16d5b84a79efc042ad9df3c3615bcd39add
+  metadata.gz: 6fd6c4f49fa011d4001151202e5c974f3ed7f972c6b1ed922ef6ca60adfc1821a8b2a773c04fdb6a3462d62ee6cb2d8b6fe8039835ec7f0a531e884a1127e87b
+  data.tar.gz: 61e852b82fc8844a5b1cb58f1a2ee599aef73fcc06d265bd3f4e924e3a75e5f0a560e6e0e0fff9fe8ceb224ff78c54dc1e38a96067d80986b22a4e7ea914d52a

data/lib/paru.rb

@@ -18,10 +18,11 @@
 #++
 module Paru
     require "paru/pandoc"
-    require "paru/error"
     require "paru/filter"
+    require "paru/filter_error"
+    require "paru/error"
     require "paru/pandoc2yaml"
 
     # Paru's current version
-    VERSION = [0, 2, 4, 5]
+    VERSION = [0, 2, 4, 7]
 end

data/lib/paru/filter.rb

@@ -19,7 +19,7 @@
 module Paru
 
     require_relative "./selector"
-    require_relative "filter/document"
+    require_relative "./filter/document"
 
     # Paru filter is a wrapper around pandoc's JSON api, which is based on
     # {pandoc-types}[https://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html].
@@ -298,4 +298,8 @@ module Paru
         end
 
     end
+    
+    # FilterError is thrown when there is an error during fitlering
+    class FilterError < Error
+    end
 end

data/lib/paru/filter/document.rb

@@ -20,10 +20,11 @@ module Paru
     module PandocFilter
 
         require "json"
-        require_relative "./node"
-        require_relative "./plain"
-        require_relative "./meta"
-        require_relative "./version"
+        require_relative "./node.rb"
+        require_relative "./plain.rb"
+        require_relative "./meta.rb"
+        require_relative "./version.rb"
+        require_relative "../filter_error.rb"
 
         # Pandoc type version key
         VERSION = "pandoc-api-version"
@@ -49,9 +50,37 @@ module Paru
             #
             # @param json [String] a JSON string representation of the AST of a document
             # @return [Document] the newly created document
+            #
+            # @raise [ParuFilterError] when parsing JSON AST from pandoc fails
+            #   or the parsed results do not make sense.
             def self.from_JSON(json)
-                doc = JSON.parse json
-                version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
+                begin
+                    doc = JSON.parse json
+                    version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
+                rescue Exception => e
+                    raise FilterError.new <<~WARNING
+Unable to read document.
+
+Most likely cause: Paru expects a pandoc installation that has been
+compiled with pandoc-types >= #{CURRENT_PANDOC_VERSION.join('.')}. You can
+check which pandoc-types have been compiled with your pandoc installation by
+running `pandoc -v`. 
+
+Original error message: #{e.message}
+WARNING
+                end
+
+                if -1 == (version <=> CURRENT_PANDOC_VERSION)
+                    if metadata.has_key?('_debug')
+                        warn <<~WARNING
+pandoc-types API version used in document (version = #{version.join('.')}) is
+smaller than the version of pandoc-types used by paru
+(#{CURRENT_PANDOC_VERSION.join('.')}. If you experience unexpected results,
+please try updating pandoc or downgrading paru.
+                        WARNING
+                    end
+                end
+
                 PandocFilter::Document.new version, metadata, contents
             end
 

data/lib/paru/filter/meta_value.rb

@@ -26,7 +26,7 @@ module Paru
         # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:MetaValue
         #
         # @!attribute value
-        #   @return [String]
+        #   @return [String|Boolean]
         class MetaValue < Node
 
             attr_accessor :value

data/lib/paru/filter_error.rb

@@ -0,0 +1,24 @@
+#--
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+#
+# This file is part of Paru
+#
+# Paru is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Paru is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Paru.  If not, see <http://www.gnu.org/licenses/>.
+#++
+require_relative "./error.rb"
+module Paru
+    # A FilterError raised when there is an error while running a filter.
+    class FilterError < Error
+    end
+end

data/lib/paru/pandoc2yaml.rb

@@ -1,29 +1,48 @@
-#!/usr/bin/env ruby
-##
-# pandoc2yaml.rb extracts the metadata from a pandoc markdown file and prints
-# that metadata out again as a pandoc markdown file with nothing in it but that
-# metadata
+#--
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
-# Usage:
+# This file is part of Paru
 #
-#  pandoc2yaml.rb input_file
+# Paru is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-##
+# Paru is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Paru.  If not, see <http://www.gnu.org/licenses/>.
+#++
 module Paru
-    module Pandoc2Yaml
-        require "json"
-        require_relative "./pandoc.rb"
+    require "json"
+    require_relative "./pandoc.rb"
 
+    # Utility class to extract YAML metadata form a markdown file in pandoc's
+    # own markdown format.
+    class Pandoc2Yaml
         # Paru converters:
         # Note. When converting metadata back to the pandoc markdown format, you have
         # to use the option "standalone", otherwise the metadata is skipped
+
+        # Converter from pandoc's markdown to pandoc's AST JSON
         PANDOC_2_JSON = Paru::Pandoc.new {from "markdown"; to "json"}
+
+        # Converter from pandoc's AST JSON back to pandoc. Note the
+        # 'standalone' property, which is needed to output the metadata as
+        # well.
         JSON_2_PANDOC = Paru::Pandoc.new {from "json"; to "markdown"; standalone}
 
         # When converting a pandoc document to JSON, or vice versa, the JSON object
         # has the following three properties:
+        
+        # Pandoc-type API version key
         VERSION = "pandoc-api-version"
+        # Meta block key
         META = "meta"
+        # Content's blocks key
         BLOCKS = "blocks"
 
         # Extract the YAML metadata from input document

data/lib/paru/selector.rb

@@ -25,7 +25,6 @@ module Paru
     class SelectorParseError < Error
     end
 
-
     # A Selector models a relationship between Pandoc AST nodes, such as
     # parent-child or sibling. Selectors in paru are like CSS selectors, but
     # more limited because the Pandoc AST is quite simple.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.2.4.6
+  version: 0.2.4.7
 platform: ruby
 authors:
 - Huub de Beer
@@ -80,6 +80,7 @@ files:
 - lib/paru/filter/table_row.rb
 - lib/paru/filter/target.rb
 - lib/paru/filter/version.rb
+- lib/paru/filter_error.rb
 - lib/paru/pandoc.rb
 - lib/paru/pandoc2yaml.rb
 - lib/paru/pandoc_options.yaml