paru 0.2.4.8 → 0.2.5b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f287d46ed1a1baf39416d71f0fd52a225062be99
-  data.tar.gz: 1ada26f825334fc92975559863c8c2da1dafa87d
+  metadata.gz: 87a2a350eeeb33246aa3d841ca14062935c29806
+  data.tar.gz: 92e889e2dd7b06f6966327406cb8fed6d3b2f3dc
 SHA512:
-  metadata.gz: 783f0782f3d3c41a697ef4612c50a1bebf246e414639e66e04534cec150b6e5b6a5d7aa53c8bc89daea76bea4fc278f66825e736f767838267a3e7e94f79228e
-  data.tar.gz: 6a88cc2fe3e25510b03613e21a53b332deae52ed1e30f4ec5c19c597c1336b28101d111bf1646cbb823119c2010810b808df1306d4eb464b25c514c4dc71da8d
+  metadata.gz: 616a84c6f967318840a95e4c4f993a63e48cc461e95bab75981dc92b35a8b32db473a1878dc46371893a2b875eddbc964d2974a616ebc0f37c1f5c8b092f5015
+  data.tar.gz: 4ce02c9ad9a3983c2751bda198efcbdab1701ad9e5a5f181d03e5cf440ebc7a98f2390723c635fffb327b65e44a7856c4564e8e67e8ed26c60d2273760178c8d

data/bin/do-pandoc.rb

@@ -2,7 +2,9 @@
 require "yaml"
 require 'optparse'
 require "paru/pandoc"
-require "paru/pandoc2yaml"
+require_relative "./pandoc2yaml.rb"
+
+include Pandoc2Yaml
 
 parser = OptionParser.new do |opts|
   opts.banner = "do-pandoc.rb runs pandoc on an input file using the pandoc configuration specified in that input file."
@@ -42,9 +44,7 @@ if !File.readable? document
   warn "Cannot read file: #{input_document}"
   exit
 end
-
-yaml = Paru::Pandoc2Yaml.extract_metadata(document)
-metadata = YAML.load yaml
+metadata = YAML.load Pandoc2Yaml.extract_metadata(document)
 
 if metadata.has_key? "pandoc" then
   begin
@@ -65,5 +65,5 @@ if metadata.has_key? "pandoc" then
     warn "Something went wrong while using pandoc:\n\n#{e.message}"
   end
 else
-    warn "Unsure what to do: no pandoc options in #{input_document}"
+    warn "Unsure what to do: no pandoc options in #{input}"
 end

data/bin/pandoc2yaml.rb

@@ -9,51 +9,86 @@
 #  pandoc2yaml.rb input_file
 #
 ##
-require "json"
-require 'optparse'
-require 'paru/pandoc2yaml'
+module Pandoc2Yaml
+  require "json"
+  require "paru/pandoc"
 
-parser = OptionParser.new do |opts|
+  # Paru converters:
+  # Note. When converting metadata back to the pandoc markdown format, you have
+  # to use the option "standalone", otherwise the metadata is skipped
+  PANDOC_2_JSON = Paru::Pandoc.new {from "markdown"; to "json"}
+  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:
+  VERSION = "pandoc-api-version"
+  META = "meta"
+  BLOCKS = "blocks"
+
+  def extract_metadata input_document
+    json = JSON.parse(PANDOC_2_JSON << File.read(input_document))
+    yaml = ""
+
+    version, metadata = json.values_at(VERSION, META)
+
+    if not metadata.empty? then
+      metadata_document = {
+        VERSION => version, 
+        META => metadata, 
+        BLOCKS => []
+      }
+
+      yaml = JSON_2_PANDOC << JSON.generate(metadata_document)
+    end
+
+    yaml
+  end
+end
+
+if __FILE__ == $0
+  include Pandoc2Yaml
+  require 'optparse'
+
+  parser = OptionParser.new do |opts|
     opts.banner = "pandoc2yaml.rb mines a pandoc markdown file for its YAML metadata"
     opts.banner << "\n\nUsage: pandoc2yaml.rb some-pandoc-markdownfile.md"
     opts.separator ""
     opts.separator "Common options"
 
     opts.on_tail("-h", "--help", "Show this message") do
-        puts opts
-        exit
+      puts opts
+      exit
     end
 
     opts.on("-v", "--version", "Show version") do 
-        puts "pandoc2yaml.rb is part of paru version 0.2.3"
-        exit
+      puts "pandoc2yaml.rb is part of paru version 0.2.3"
+      exit
     end
-end
+  end
 
-parser.parse! ARGV
+  parser.parse! ARGV
 
-input_document = ARGV.pop
+  input_document = ARGV.pop
 
-if ARGV.size != 0 then
+  if ARGV.size != 0 then
     warn "Expecting exactly one argument: the pandoc file to strip for metadata"
     puts ""
     puts parser
     exit
-end
+  end
 
-document = File.expand_path input_document
-if not File.exist? document
+  document = File.expand_path input_document
+  if not File.exist? document
     warn "Cannot find file: #{input_document}"
     exit
-end
+  end
 
-if !File.readable? document
+  if !File.readable? document
     warn "Cannot read file: #{input_document}"
     exit
-end
-
-yaml = Paru::Pandoc2Yaml.extract_metadata(document)
+  end
 
-yaml = "---\n..." if yaml.empty?
-
-puts yaml
+  output_metadata = Pandoc2Yaml.extract_metadata document
+  
+  puts output_metadata
+end

data/lib/paru/filter/document.rb

@@ -20,11 +20,10 @@ module Paru
     module PandocFilter
 
         require "json"
-        require_relative "./node.rb"
-        require_relative "./plain.rb"
-        require_relative "./meta.rb"
-        require_relative "./version.rb"
-        require_relative "../filter_error.rb"
+        require_relative "./node"
+        require_relative "./plain"
+        require_relative "./meta"
+        require_relative "./version"
 
         # Pandoc type version key
         VERSION = "pandoc-api-version"
@@ -50,37 +49,9 @@ 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)
-                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
-lower 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
-
+                doc = JSON.parse json
+                version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
                 PandocFilter::Document.new version, metadata, contents
             end
 

data/lib/paru/filter/meta_map.rb

@@ -42,7 +42,7 @@ module Paru
             end
 
             # Get the value belonging to key. Prefer to use the {has?}, {get},
-            # {replace} and {delete} methods to manipulate metadata.
+            # and {delete} methods to manipulate metadata.
             #
             # @param key [String] the key
             #
@@ -56,7 +56,9 @@ module Paru
             # to set the metadata.
             #
             # @param key [String] the key to set
-            # @param value [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value to set
+            # @param value
+            #   [MetaBlocks|MetaBool|MetaInline|MetaList|MetaMap|MetaString|MetaValue]
+            #   the value to set
             def []=(key, value)
                 @children[key] = value
             end
@@ -71,7 +73,6 @@ module Paru
             # Mixin the YAML code into this metadata object
             #
             # @param yaml_string [YAML] A string with YAML data
-            # @return [MetaMap] this MetaMap object
             #
             # @example Set some properties in the metadata
             #   #!/usr/bin/env ruby
@@ -81,7 +82,7 @@ module Paru
             #   Paru::Filter.run do
             #     metadata.yaml <<~YAML
             #       ---
-            #       date: #{Date.today.to_s}
+            #       date: Date.today.to_s
             #       title: This **is** the title
             #       pandoc_options:
             #         from: markdown
@@ -98,7 +99,6 @@ module Paru
                 meta_from_yaml(yaml_string).each do |key, value|
                     self[key] = value
                 end
-                self
             end
 
             # Replace the property in this MetaMap matching the selector with
@@ -108,7 +108,8 @@ module Paru
             # @param selector [String] a dot-separated sequence of property
             # names denoting a sequence of descendants.
             #
-            # @param value [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue|String]
+            # @param value
+            # [MetaBlocks|MetaBool|MetaInline|MetaList|MetaMap|MetaString|MetaValue|String]
             #   if value is a String, it is treated as a yaml string
             def replace(selector, value)
                 parent = select(selector, true)
@@ -123,7 +124,7 @@ module Paru
             # @param selector [String] a dot-separated sequence of property
             #   names denoting a sequence of descendants.
             #
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value matching the selected property, nil if it cannot be found
+            # @return [MetaBlocks|MetaBool|MetaInline|MetaList|MetaMap|MetaString|MetaValue] the value matching the selected property, nil if it cannot be found
             def get(selector)
                 select(selector)
             end 
@@ -144,17 +145,14 @@ module Paru
             # @param selector [String] a dot-separated sequence of property
             #   names denoting a sequence of descendants
             #
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
+            # @return [MetaBlocks|MetaBool|MetaInline|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
             #
             def delete(selector)
-                if has?(selector)
-                    parent = select(selector, true)
-                    parent.children.delete(last_key(selector))
-                else
-                    nil
-                end
+                parent = select(selector, true)
+                parent.children.delete(last_key(selector))
             end
 
+
             # The AST contents
             def ast_contents()
                 ast = Hash.new
@@ -175,7 +173,7 @@ module Paru
             # @param get_parent [Boolean = false] Get the parent MetaMap
             #   of the selected property instead of its value
             # 
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
+            # @return [MetaBlocks|MetaBool|MetaInline|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
             def select(selector, get_parent = false)
                 keys = selector.split(".")
                 level = self

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|Boolean]
+        #   @return [String]
         class MetaValue < Node
 
             attr_accessor :value

data/lib/paru/filter/raw_block.rb

@@ -38,7 +38,7 @@ module Paru
             end
 
             # Create an AST representation of this RawBlock node
-            def ast_contents()
+            def to_ast()
                 [
                     @format,
                     @string

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].
@@ -198,23 +198,11 @@ module Paru
     #
     class Filter
 
-        # Create a new Filter instance. For convenience, {run} creates a new
-        # {Filter} and runs it immediately. Use this constructor if you want
-        # to run a filter on different input and output streams that STDIN and
-        # STDOUT respectively.
-        #
-        # @param input [IO = $stdin] the input stream to read, defaults to
-        #   STDIN
-        # @param output [IO = $stdout] the output stream to write, defaults to 
-        #   STDOUT
-        def initialize(input = $stdin, output = $stdout)
-            @input = input
-            @output = output
-        end
-
-        # Run the filter specified by block. This is a convenience method that
-        # creates a new {Filter} using input stream STDIN and output stream
-        # STDOUT and immediately runs {filter} with the block supplied. 
+        # Run the filter specified by block. In the block you specify
+        # selectors and actions to be performed on selected nodes. In the
+        # example below, the selector is "Image", which selects all image
+        # nodes. The action is to prepend the contents of the image's caption
+        # by the string "Figure. ".
         #
         # @param block [Proc] the filter specification
         #
@@ -225,39 +213,23 @@ module Paru
         #       end
         #   end
         def self.run(&block)
-            Filter.new($stdin, $stdout).filter(&block)
+            Filter.new().filter(&block)
         end
 
+
         # The Document node from JSON formatted pandoc document structure
         # on STDIN that is being filtered
         #
         # @return [Document] create a new Document node from a pandoc AST from
         #   JSON from STDIN
         def document()
-            PandocFilter::Document.from_JSON @input.read
+            PandocFilter::Document.from_JSON $stdin.read
         end
 
-        # Create a filter using +block+. In the block you specify
-        # selectors and actions to be performed on selected nodes. In the
-        # example below, the selector is "Image", which selects all image
-        # nodes. The action is to prepend the contents of the image's caption
-        # by the string "Figure. ".
-        #
-        # @param block [Proc] the filter specification
+        # Create a filter using +block+.
         #
+        # @param block [Proc] a block specifying selectors and actions
         # @return [JSON] a JSON string with the filtered pandoc AST
-        #
-        # @example Add 'Figure' to each image's caption
-        #   input = IOString.new(File.read("my_report.md")
-        #   output = IOString.new
-        #
-        #   Paru::Filter.new(input, output).filter do
-        #       with "Image" do |image|
-        #           image.inner_markdown = "Figure. #{image.inner_markdown}"
-        #       end
-        #   end
-        #
-        #   # do something with output.string
         def filter(&block)
             @selectors = Hash.new
             @filtered_nodes = []
@@ -268,9 +240,10 @@ module Paru
                 instance_eval(&block)
             end
 
-            @output.write @doc.to_JSON
+            puts @doc.to_JSON
         end
 
+
         # +current_node+ points to the node that is *now* being processed while
         # running this filter.
         #
@@ -298,8 +271,4 @@ module Paru
         end
 
     end
-    
-    # FilterError is thrown when there is an error during fitlering
-    class FilterError < Error
-    end
 end

data/lib/paru/selector.rb

@@ -25,6 +25,7 @@ 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.

data/lib/paru.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.2.4.8
+  version: 0.2.5b
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies: []
 description: Use Pandoc (http://www.pandoc.org) with ruby
 email: Huub@heerdebeer.org
@@ -80,9 +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
 - lib/paru/selector.rb
 homepage: https://heerdebeer.org/Software/markdown/paru/
@@ -100,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2

data/lib/paru/filter_error.rb

@@ -1,24 +0,0 @@
-#--
-# 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,71 +0,0 @@
-#--
-# 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/>.
-#++
-module Paru
-    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
-        #
-        # @param input_document [String] path to input document
-        # @return [String] YAML metadata from input document on STDOUT
-        def self.extract_metadata input_document
-            json = JSON.parse(PANDOC_2_JSON << File.read(input_document))
-            yaml = ""
-
-            version, metadata = json.values_at(VERSION, META)
-
-            if not metadata.empty? then
-                metadata_document = {
-                    VERSION => version, 
-                    META => metadata, 
-                    BLOCKS => []
-                }
-
-                yaml = JSON_2_PANDOC << JSON.generate(metadata_document)
-            end
-
-            yaml
-        end
-    end
-end