paru 0.2.4.2 → 0.2.4.3

data/lib/paru/filter/attr.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,40 +17,76 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    class Attr
-      include Enumerable
-
-      attr_accessor :id, :classes
-      def initialize(attributes)
-        @id, @classes, @data = attributes
-      end
-
-      def each
-        @data.each
-      end
-
-      def [](key) 
-        if @data.key_exists? key
-          @data[key]
-        end 
-      end
-
-      def has_key? name
-        @data.key_exists? name
-      end
-
-      def has_class? name
-        @classes.include? name
-      end
-
-      def to_ast
-        [
-          @id,
-          @classes,
-          @data
-        ]
-      end
+    module PandocFilter
+
+        # Attr represents an attribute object for a node. It contains of an id, a
+        # list of class names and a list of key-value pairs. 
+        #
+        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Attr
+        #
+        # @!attribute id
+        #   @return [String]
+        #
+        # @!attribute classes
+        #   @return [Array<String>]
+        class Attr
+            include Enumerable
+
+            attr_accessor :id, :classes
+
+            # Create a new attributes object
+            #
+            # @param attributes [Array] the attributes as [id, [class names],
+            #   [key-value pairs]]
+            def initialize(attributes)
+                @id, @classes, @data = attributes
+            end
+
+            # For each key-value pair of this attributes object
+            def each
+                @data.each
+            end
+
+            # Get the value for key in this attributes object
+            #
+            # @param key [String] the key to get the value for. Nil if it does
+            # not exists
+            def [](key) 
+                if @data.key_exists? key
+                    @data[key]
+                end 
+            end
+
+            # Does this attributes object have this key?
+            #
+            # @param name [String] key to find
+            #
+            # @return [Boolean] true if this key exist, false otherwise
+            def has_key?(name)
+                @data.key_exists? name
+            end
+
+            # Does this attributes object have a class?
+            #
+            # @param name [String] the class name to search for.
+            #
+            # @return [Boolean] true if this class name exist, false
+            #   otherwise.
+            def has_class?(name)
+                @classes.include? name
+            end
+
+            # Convert this attributes object to an AST representation
+            #
+            # @return [Array] Array containing id, class name list, and
+            #   key-value pair list
+            def to_ast
+                [
+                    @id,
+                    @classes,
+                    @data
+                ]
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/block.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,13 +17,19 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./node"
+    module PandocFilter
+        require_relative "./node"
+        
+        # A Block level node.
+        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Block
+        class Block < Node
 
-    class Block < Node
-      def is_block?
-        true
-      end
+            # Is this node a block?
+            #
+            # @return [Boolean] true
+            def is_block?
+                true
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/block_quote.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,14 +17,17 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./block"
+    module PandocFilter
+        require_relative "./block"
 
-    # BlockQuote [Block]
-    class BlockQuote < Block
-      def has_block?
-        true
-      end
+        # A BlockQuote node. Contains a list of Blocks
+        class BlockQuote < Block
+            # Has this node a block?
+            #
+            # @return [Boolean] true
+            def has_block?
+                true
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/bullet_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,11 +17,11 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./list"
+    module PandocFilter
+        require_relative "./list"
 
-    # BulletList [[Block]]
-    class BulletList < List
+        # BulletList, contains a list of list of Block nodes.
+        class BulletList < List
+        end
     end
-  end
 end

data/lib/paru/filter/citation.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,31 +17,57 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #--
 module Paru
-  module PandocFilter
-    require_relative "./inline"
+    module PandocFilter
+        require_relative "./inline"
+    
+        # A Citation consists of an id, a prefix, a suffix, a mode, a note
+        # number, and integer hash. All of which are optional.
+        #
+        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Citation
+        #
+        # @!attribute id
+        #   @return [String]
+        #
+        # @!attribute prefix
+        #   @return [Array<Inline>]
+        #
+        # @!attribute suffix
+        #   @return [Array<Inline>]
+        #
+        # @!attribute mode
+        #   @return [String]
+        #
+        # @!attribute note_num
+        #   @return [Integer]
+        #
+        # @!attribute hash  
+        #   @return [Integer]
+        class Citation
+            attr_accessor :id, :prefix, :suffix, :mode, :note_num, :hash
 
-    class Citation
-      attr_accessor :id, :prefix, :suffix, :mode, :note_num, :hash
+            # Create a new Citation node base on an AST specification
+            #
+            # @param spec [Hash] the specification of this citation
+            def initialize(spec)
+                @id = spec["citationId"] if spec.has_key? "citationId"
+                @prefix = Inline.new spec["citationPrefix"] if spec.has_key? "citationPrefix"
+                @suffix = Inline.new spec["citationSuffix"] if spec.has_key? "citationSuffix"
+                @mode = spec["citationMode"] if spec.has_key? "citationMode"
+                @note_num = spec["citationNoteNum"] if spec.has_key? "citationNoteNum"
+                @hash = spec["citationHash"] if spec.has_key? "citationHash"
+            end
 
-      def initialize spec
-        @id = spec["citationId"] if spec.has_key? "citationId"
-        @prefix = Inline.new spec["citationPrefix"] if spec.has_key? "citationPrefix"
-        @suffix = Inline.new spec["citationSuffix"] if spec.has_key? "citationSuffix"
-        @mode = spec["citationMode"] if spec.has_key? "citationMode"
-        @note_num = spec["citationNoteNum"] if spec.has_key? "citationNoteNum"
-        @hash = spec["citationHash"] if spec.has_key? "citationHash"
-      end
-
-      def to_ast
-        citation = Hash.new
-        citation["citationId"] = @id if not @id.nil?
-        citation["citationPrefix"] = @prefix.ast_contents if not @prefix.nil?
-        citation["citationSuffix"] = @suffix.ast_contents if not @suffix.nil?
-        citation["citationMode"] = @mode if not @mode.nil?
-        citation["citationNoteNum"] = @note_num if not @note_num.nil?
-        citation["citationHash"] = @hash if not @hash.nil?
-        citation
-      end
+            # Convert this Citation to an AST representation
+            def to_ast()
+                citation = Hash.new
+                citation["citationId"] = @id if not @id.nil?
+                citation["citationPrefix"] = @prefix.ast_contents if not @prefix.nil?
+                citation["citationSuffix"] = @suffix.ast_contents if not @suffix.nil?
+                citation["citationMode"] = @mode if not @mode.nil?
+                citation["citationNoteNum"] = @note_num if not @note_num.nil?
+                citation["citationHash"] = @hash if not @hash.nil?
+                citation
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/cite.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,28 +17,37 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./inline"
+    module PandocFilter
+        require_relative "./inline"
 
-    # Cite [Citation] [Inline]
-    class Cite < Inline
-      attr_accessor :citations
+        # A Cite node, consisting of a list of Citation nodes, and a list of
+        # Inline nodes
+        #
+        # @!attribute citations
+        #   @return [Array<Citation>]
+        class Cite < Inline
+            attr_accessor :citations
 
-      def initialize contents
-        @citations = []
-        contents[0].each do |citation|
-          @citations.push Citation.new(citation)
-        end
-        super contents[1]
-      end
+            # Create a new Cite node
+            #
+            # @param contents [Array] an array containing a list of citations
+            #   and a list of inline nodes
+            def initialize contents
+                @citations = []
+                contents[0].each do |citation|
+                    @citations.push Citation.new(citation)
+                end
+                super contents[1]
+            end
 
-      def ast_contents
-        [
-          @citations.map {|citation| citation.to_ast},
-          super
-        ]
-      end
+            # Create an AST representation of this Cite node.
+            def ast_contents()
+                [
+                    @citations.map {|citation| citation.to_ast},
+                    super
+                ]
+            end
+        end
     end
-  end
 end
 

data/lib/paru/filter/code.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,33 +17,50 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./inline"
-    require_relative "./attr"
+    module PandocFilter
+        require_relative "./inline"
+        require_relative "./attr"
 
-    # Code Attr String
-    class Code < Inline
-      attr_accessor :attr, :string
+        # A Code node, with an attribute object and the code itself as a
+        # string.
+        #
+        # @!attribute attr 
+        #   @return [Attr]
+        #
+        # @!attribute string
+        #   @return [String]
+        class Code < Inline
+            attr_accessor :attr, :string
 
-      def initialize contents
-        @attr = Attr.new contents[0]
-        @string = contents[1]
-      end
+            # Create a new Code node
+            #
+            # @param contents [Array] an array of the attribute and the code
+            def initialize(contents)
+                @attr = Attr.new contents[0]
+                @string = contents[1]
+            end
 
-      def ast_contents
-        [
-          @attr.to_ast,
-          @string
-        ]
-      end
+            # Create an AST representation of this Code node.
+            def ast_contents()
+                [
+                    @attr.to_ast,
+                    @string
+                ]
+            end
 
-      def has_string?
-        true
-      end
+            # Has this Code node a string contents?
+            #
+            # @return [Boolean] true
+            def has_string?()
+                true
+            end
 
-      def has_inline?
-        false
-      end
+            # Has this code node inline contents?
+            #
+            # @return [Boolean] false
+            def has_inline?()
+                false
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/code_block.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,29 +17,44 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./block"
-    require_relative "./attr"
+    module PandocFilter
+        require_relative "./block"
+        require_relative "./attr"
 
-    # CodeBlock Attr String
-    class CodeBlock < Block
-      attr_accessor :attr, :string
+        # A CodeBlock is a Block level node with an attribute object and the
+        # code as a string
+        #
+        # @!attribute attr 
+        #   @return [Attr]
+        #
+        # @!attribute string
+        #   @return [String]
+        class CodeBlock < Block
+            attr_accessor :attr, :string
 
-      def initialize(contents)
-        @attr = Attr.new contents[0]
-        @string = contents[1]
-      end
+            # Create a new CodeBlock based on the contents
+            #
+            # @param contents [Array] an array with the attribute and the code
+            #   string
+            def initialize(contents)
+                @attr = Attr.new contents[0]
+                @string = contents[1]
+            end
 
-      def ast_contents
-        [
-          @attr.to_ast,
-          @string
-        ]
-      end
+            # An AST representation of this CodeBlock
+            def ast_contents()
+                [
+                    @attr.to_ast,
+                    @string
+                ]
+            end
 
-      def has_string?
-        true
-      end
+            # Has this CodeBlock string contents?
+            #
+            # @return [Boolean] true
+            def has_string?()
+                true
+            end
+        end
     end
-  end
 end