paru 0.2.4.2 → 0.2.4.3

data/lib/paru/filter/math.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,51 +17,78 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./inline"
+    module PandocFilter
+        require_relative "./inline"
 
-    # Math MathType String
-    class Math < Inline
-      attr_accessor :math_type, :string
+        # A Math Inline node with the type of math node and the mathematical
+        # contents
+        #
+        # @!attribute math_type
+        #   @return [Hash]
+        #   @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:MathType
+        #
+        # @!attribute string
+        #   @return [String]
+        class Math < Inline
+            attr_accessor :math_type, :string
 
-      def initialize contents
-        @math_type, @string = contents
-      end
+            # Create a new Math node with contents
+            #
+            # @param contents [Array] an array with the type and contents
+            def initialize(contents)
+                @math_type, @string = contents
+            end
 
-      def inline?
-        "InlineMath" == @math_type[t]
-      end
+            # Is this an inline node? 
+            #
+            # @return [Boolean] true if math type is "InlineMath", false
+            #   otherwise
+            def inline?()
+                "InlineMath" == @math_type[t]
+            end
 
-      def inline!
-        @math_type = {
-          "t" => "InlineMath"
-        }
-      end
+            # Convert this Math node's content to Inline
+            def inline!()
+                @math_type = {
+                    "t" => "InlineMath"
+                }
+            end
 
-      def display?
-        "DisplayMath" == @math_type[t]
-      end
+            # Should this math be displayed as a block?
+            #
+            # @return [Boolean] true if type is "DisplayMath"
+            def display?()
+                "DisplayMath" == @math_type[t]
+            end
 
-      def display!
-        @math_type = {
-          "t" => "DisplayMath"
-        }
-      end
+            # Make this Math node's content display as a block
+            def display!()
+                @math_type = {
+                    "t" => "DisplayMath"
+                }
+            end
 
-      def ast_contents
-        [
-          @math_type,
-          @string
-        ]
-      end
+            # Create an AST representation of this Math node
+            def ast_contents()
+                [
+                    @math_type,
+                    @string
+                ]
+            end
 
-      def has_string?
-        true
-      end
+            # Has this Math node string contents?
+            #
+            # @return [Boolean] true
+            def has_string?()
+                true
+            end
 
-      def has_inline?
-        false
-      end
+            # Has this Math node inline contents?
+            #
+            # @return [Boolean] false
+            def has_inline?()
+                false
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/meta.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,25 +17,35 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./meta_map"
+    module PandocFilter
+        require_relative "./meta_map"
 
-    # Meta is a MetaMap
-    class Meta < MetaMap
-      include Enumerable
+        # A Meta node represents the metadata of a document. It is a MetaMap
+        # node.
+        #
+        # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:Meta
+        class Meta < MetaMap
+            include Enumerable
 
-      def initialize contents
-        super contents
-      end
+            # Create a new Meta node based on the contents
+            #
+            # @param value [String]
+            def initialize(value)
+                super value
+            end
 
-      def ast_type
-        "meta"
-      end
+            # The type of a Meta is "meta"
+            # 
+            # @return [String] "meta"
+            def ast_type()
+                "meta"
+            end
 
-      def to_ast
-        ast_contents
-      end
+            # Convert this Meta node to an AST representation
+            def to_ast()
+                ast_contents
+            end
 
+        end
     end
-  end
 end

data/lib/paru/filter/meta_blocks.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,16 +17,19 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./node"
+        require_relative "./node"
 
-    # MetaBlocks [Blocks]
-    class MetaBlocks < Node
+        # A MetaBlocks Node contains a list of Blocks
+        class MetaBlocks < Node
 
-      def initialize value
-        super value
-      end
+            # Create a MetaBlocks node based on the contents
+            #
+            # @param value [String] the contents of the MetaBlocks
+            def initialize(value)
+                super value
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/meta_bool.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,12 +17,12 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./meta_value"
+        require_relative "./meta_value"
 
-    # MetaBool Bool
-    class MetaBool < MetaValue
+        # A MetaBool Note representa a Boolean value
+        class MetaBool < MetaValue
+        end
     end
-  end
 end

data/lib/paru/filter/meta_inlines.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,16 +17,19 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./node"
+        require_relative "./node"
 
-    # MetaInlines [Inline]
-    class MetaInlines < Node
+        # A MetaInlines node contains a list of Inline nodes
+        class MetaInlines < Node
 
-      def initialize value
-        super value
-      end
+            # Create a new MetaInlines Node based on the contents
+            #
+            # @param value [String] the contents of this MetaInlines node
+            def initialize(value)
+                super value
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/meta_list.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,12 +17,12 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./node"
+        require_relative "./node"
 
-    # MetaList [MetaValue]
-    class MetaList < Node
+        # A MetaList node contains a list of MetaValue nodes
+        class MetaList < Node
+        end
     end
-  end
 end

data/lib/paru/filter/meta_map.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,47 +17,63 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./node"
+        require_relative "./node"
 
-    # MetaMap (M.Map String MetaValue)
-    class MetaMap < Node
+        # A MetaMap Node is a map of String keys with MetaValue values
+        class MetaMap < Node
 
-      def initialize contents
-        @children = Hash.new
+            # Create a new MetaMap based on the contents
+            #
+            # @param contents [Array] a list of key-value pairs
+            def initialize(contents)
+                @children = Hash.new
 
-        if contents.is_a? Hash
-          contents.each_pair do |key, value|
-            if not value.empty? and PandocFilter.const_defined? value["t"]
-              @children[key] = PandocFilter.const_get(value["t"]).new value["c"]
+                if contents.is_a? Hash
+                    contents.each_pair do |key, value|
+                        if not value.empty? and PandocFilter.const_defined? value["t"]
+                            @children[key] = PandocFilter.const_get(value["t"]).new value["c"]
+                        end
+                    end
+                end
             end
-          end
-        end
-      end
 
-      def [](key)
-        if @children.key_exists?
-          @children[key]
-        end
-      end
+            # Get the value belonging to key
+            #
+            # @param key [String] the key
+            #
+            # @return [MetaValue] the value belonging to the key
+            def [](key)
+                if @children.key_exists?
+                    @children[key]
+                end
+            end
 
-      def has_key? key 
-        @children.has_key? key
-      end
+            # Does this MetaMap node have key?
+            #
+            # @param key [String] the key to find
+            #
+            # @return [Boolean] true if this MetaMap node contains this key
+            def has_key?(key)
+                @children.has_key? key
+            end
 
-      def delete key
-        @children.delete key
-      end
+            # Delete the key-value pair from this MetaMap
+            #
+            # @param key [String] the key to delete
+            def delete(key)
+                @children.delete key
+            end
 
-      def ast_contents
-        ast = Hash.new
-        @children.each_pair do |key, value|
-          ast[key] = value.to_ast
+            # The AST contents
+            def ast_contents()
+                ast = Hash.new
+                @children.each_pair do |key, value|
+                    ast[key] = value.to_ast
+                end
+                ast
+            end
         end
-        ast
-      end
-
     end
-  end
 end

data/lib/paru/filter/meta_string.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,12 +17,12 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./meta_value"
+        require_relative "./meta_value"
 
-    # MetaString String
-    class MetaString < MetaValue
+        # A MetaString Node represents a String value
+        class MetaString < MetaValue
+        end
     end
-  end
 end

data/lib/paru/filter/meta_value.rb

@@ -1,5 +1,5 @@
 #-- 
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,24 +17,32 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./node"
+        require_relative "./node"
 
-    # MetaValue = MetaMap | MetaList | MetaBool | MetaString | MetaInlines |
-    #   MetaBlocks
-    class MetaValue < Node
+        # A MetaValue Node is either a MetaMap, MetaList, MetaBool, MetaString, MetaInlines, or a MetaBlocks.
+        #
+        # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:MetaValue
+        #
+        # @!attribute value
+        #   @return [String]
+        class MetaValue < Node
 
-      attr_accessor :value
+            attr_accessor :value
 
-      def initialize value
-        @value = value
-      end
+            # Create a new MetaValue Node based on the value
+            # 
+            # @param value [String]
+            def initialize(value)
+                @value = value
+            end
 
-      def ast_contents
-        @value
-      end
+            # The AST contents
+            def ast_contents()
+                @value
+            end
 
+        end
     end
-  end
 end