paru 0.2.5c → 0.2.5f

data/lib/paru/filter/superscript.rb

@@ -16,10 +16,10 @@
 # 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 "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Superscript inline node
         class Superscript < Inline
         end

data/lib/paru/filter/table.rb

@@ -16,11 +16,11 @@
 # 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 "./block.rb"
+require_relative "./inline.rb"
+    
 module Paru
     module PandocFilter
-        require_relative "./block"
-        require_relative "./inline"
-    
         # The allignment of a table column
         ALIGNMENTS = ["AlignLeft", "AlignRight", "AlignCenter", "AlignDefault"]
 

data/lib/paru/filter/table_row.rb

@@ -16,10 +16,10 @@
 # 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 "./block.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # A TableRow node represents a row in a table's head or body
         class TableRow < Block
             # Create a new TableRow based on the row_data

data/lib/paru/filter/target.rb

@@ -18,7 +18,6 @@
 #++
 module Paru
     module PandocFilter
-    
         # A Target represents the target of a link or image
         #
         # @!attribute url

data/lib/paru/filter/version.rb

@@ -16,10 +16,10 @@
 # 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 "./node.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./node"
-
         # Version is a general Node containing the pandoc-api-version. It has
         # the format major.minor.revision.sub
         class Version < Node

data/lib/paru/filter_error.rb

@@ -0,0 +1,25 @@
+#--
+# 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/pandoc.rb

@@ -16,11 +16,10 @@
 # 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 "shellwords"
-    require "yaml"
+require "shellwords"
+require "yaml"
 
+module Paru
     # Pandoc is a wrapper around the pandoc document converter. See
     # <http://pandoc.org/README.html> for details about pandoc.  The Pandoc
     # class is basically a straightforward translation from the pandoc command

data/lib/paru/pandoc2yaml.rb

@@ -0,0 +1,71 @@
+#--
+# 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 "json"
+require_relative "./pandoc.rb"
+
+module Paru
+    # 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

data/lib/paru/selector.rb

@@ -16,16 +16,14 @@
 # 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_relative './filter'
-    require_relative './error'
+require_relative './error'
 
+module Paru
     # SelectorParseError is thrown when there is an error parsing a selector
     # used in a filter.
     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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.2.5c
+  version: 0.2.5f
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies: []
 description: Use Pandoc (http://www.pandoc.org) with ruby
 email: Huub@heerdebeer.org
@@ -43,12 +43,12 @@ files:
 - lib/paru/filter/horizontal_rule.rb
 - lib/paru/filter/image.rb
 - lib/paru/filter/inline.rb
+- lib/paru/filter/inner_markdown.rb
 - lib/paru/filter/line_block.rb
 - lib/paru/filter/line_break.rb
 - lib/paru/filter/link.rb
 - lib/paru/filter/list.rb
 - lib/paru/filter/list_attributes.rb
-- lib/paru/filter/markdown.rb
 - lib/paru/filter/math.rb
 - lib/paru/filter/meta.rb
 - lib/paru/filter/meta_blocks.rb
@@ -58,6 +58,7 @@ files:
 - lib/paru/filter/meta_map.rb
 - lib/paru/filter/meta_string.rb
 - lib/paru/filter/meta_value.rb
+- lib/paru/filter/metadata.rb
 - lib/paru/filter/node.rb
 - lib/paru/filter/note.rb
 - lib/paru/filter/null.rb
@@ -80,7 +81,9 @@ 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/

data/lib/paru/filter/markdown.rb

@@ -1,150 +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
-    module PandocFilter
-        # A mixin to add inner_markdown and outer_markdown properties to Nodes
-        module Markdown
-            require_relative "../pandoc"
-            require_relative "./document"
-
-            # A Paru::Pandoc converter from JSON to markdown
-            AST2MARKDOWN = Paru::Pandoc.new do
-                from "json"
-                to "markdown"
-            end
-
-            # A Paru::Pandoc converter from markdown to JSON
-            MARKDOWN2JSON = Paru::Pandoc.new do
-                from "markdown"
-                to "json"
-            end
-
-            # Get the markdown representation of this Node, including the Node
-            # itself.
-            #
-            # @return [String] the outer markdown representation of this Node
-            def outer_markdown()
-                temp_doc = PandocFilter::Document.fragment [self]
-                AST2MARKDOWN << temp_doc.to_JSON
-            end
-
-            # Set the markdown representation of this Node: replace this Node
-            # by the Node represented by the markdown string. If an inline
-            # node is being replaced and the replacement has more than one
-            # paragraph, only the contents of the first paragraph is used
-            #
-            # @param markdown [String] the markdown string to replace this
-            #   Node
-            #
-            # @example Replacing all horizontal lines by a Plain node saying "hi"
-            #   Paru::Filter.run do
-            #       with "HorizontalLine" do |line|
-            #           line.outer_markdown = "hi"
-            #       end
-            #   end
-            #       
-            def outer_markdown=(markdown)
-                json = MARKDOWN2JSON << markdown
-                temp_doc = PandocFilter::Document.from_JSON json
-
-                if not has_parent? or is_root?
-                    @children = temp_doc.children
-                else
-                    # replace current node by new nodes
-                    # There is a difference between inline and block nodes
-                    current_index = parent.find_index self
-
-                    # By default, pandoc creates a Block level node when
-                    # converting a string. However, if the original is a
-                    # inline level node, so should its replacement node(s) be.
-                    # Only using first block node (paragraph?)
-                    if is_inline?
-                        temp_doc = temp_doc.children.first
-                        
-                        if not temp_doc.children.all? {|node| node.is_inline?}
-                            raise Error.new "Cannot replace the inline level node represented by '#{outer_markdown}' with markdown that converts to block level nodes: '#{markdown}'."
-                        end
-                        
-                    end
-                        
-                    index = current_index
-                    temp_doc.each do |child|
-                        index += 1
-                        parent.insert index, child
-                    end
-                    # Remove the original node
-                    parent.remove_at current_index
-                end
-
-            end
-
-            # Get the markdown representation of this Node's children
-            #
-            # @return [String] the inner markdown representation of this Node
-            #
-            # @example Replace all occurrences of "hello" by "world" in all paragraphs
-            #   Paru::Filter.run do
-            #       with "Para" do |p|
-            #           p.inner_markdown = p.inner_markdown.gsub "hello", "world"
-            #       end
-            #   end         
-            #
-            def inner_markdown()
-                temp_doc = PandocFilter::Document.fragment @children
-                AST2MARKDOWN << temp_doc.to_JSON
-            end
-
-            # Replace this Node's children with the Nodes represented by the
-            # markdown string
-            #
-            # @param markdown [String] the markdown string to replace this
-            #   Node's children
-            #
-            # @example Replace all occurrences of "hello" by "world" in all paragraphs
-            #   Paru::Filter.run do
-            #       with "Para" do |p|
-            #           p.inner_markdown = p.inner_markdown.gsub "hello", "world"
-            #       end
-            #   end         
-            #
-            def inner_markdown=(markdown)
-                if has_string?
-                    @string = markdown
-                else
-                    if markdown.empty?
-                        @children = []
-                    else 
-                        json = MARKDOWN2JSON << markdown
-                        temp_doc = PandocFilter::Document.from_JSON json
-                        temp_doc.children.each {|c| c.parent = @parent}
-
-                        if has_inline?
-                            @children = temp_doc.children.first.children
-                        elsif has_block?
-                            @children = temp_doc.children
-                        else
-                            # Unknown; what to do here?
-                        end
-                    end
-                end
-            end
-
-        end
-    end
-end