coradoc 1.0.0 → 1.1.1

data/lib/coradoc/converter.rb

@@ -0,0 +1,145 @@
+require "fileutils"
+
+module Coradoc
+  class Converter
+    attr_accessor :input, :output, :config
+
+    def initialize(input = nil, output = nil, **config)
+      @input = input || $stdin
+      @output = output || $stdout
+
+      @config = {
+        input_options: {},
+        output_options: {},
+      }.merge(config)
+
+      yield if block_given?
+    end
+
+    def self.call(*args, **kwargs, &block)
+      new(*args, **kwargs, &block).convert
+    end
+
+    def input_processor
+      if config[:input_processor]
+        Input[config[:input_processor]]
+      else
+        Input.select_processor(input)
+      end
+    end
+
+    def output_processor
+      if config[:output_processor]
+        Output[config[:output_processor]]
+      else
+        Output.select_processor(output)
+      end
+    end
+
+    def convert(data = nil)
+      input_id = input_processor.processor_id
+      output_id = output_processor.processor_id
+
+      unless data
+        input = self.input
+        input = File.open(input, "rb") if input.is_a? String
+        data = input.read
+        input_path = input.path if input.respond_to? :path
+      end
+
+      # Some input processors may prefer filenames
+      if input_processor.respond_to? :processor_wants_filenames
+        unless input.respond_to? :path
+          raise NoInputPathError,
+                "no input path given, but #{input_processor} wants that " +
+                  "form. Ensure you don't read from standard input."
+        end
+
+        data = input.path
+      end
+
+      # We may need to configure destination path.
+      output = self.output
+      if output.is_a? String
+        FileUtils.mkdir_p(File.dirname(output))
+        output = File.open(output, "wb")
+      end
+      output_path = output.path if output.respond_to?(:path)
+
+      input_options = config[:input_options]
+      input_options = input_options.merge(destination: output_path) if output_path
+      input_options = input_options.merge(sourcedir: File.dirname(input_path)) if input_path
+
+      data = input_processor.processor_execute(data, input_options)
+
+      # Two options are possible at this point:
+      # Either we have a document we want to write to some output, or
+      # we have a Hash, that contains a list of files and their
+      # documents (where a nil key denotes the main file). Let's normalize
+      # those cases.
+      data = { nil => data } unless data.is_a? Hash
+
+      # Let's check an edge case of non-nil keys and no output path
+      if !output_path && data.keys.any? { |i| !i.nil? }
+        raise NoOutputPathError,
+              "no output path given, while wanting to write multiple files"
+      end
+
+      data = output_processor.processor_execute(data, config[:output_options])
+
+      if input_processor.respond_to?(:processor_postprocess)
+        data = input_processor.processor_postprocess(
+          data, input_options.merge(output_processor: output_id)
+        )
+      end
+
+      # Now we have all, let's write.
+      data.each do |filename, content|
+        if filename.nil?
+          file = output
+        else
+          dirname = File.dirname(output_path)
+          file = "#{dirname}/#{filename}"
+          FileUtils.mkdir_p(File.dirname(file))
+          file = File.open(file, "wb")
+        end
+
+        file.write(content)
+        file.close
+      end
+    end
+
+    class ConverterArgumentError < ArgumentError; end
+
+    class NoInputPathError < ConverterArgumentError; end
+    class NoOutputPathError < ConverterArgumentError; end
+    class NoProcessorError < ConverterArgumentError; end
+
+    module CommonInputOutputMethods
+      def define(const)
+        @processors[const.processor_id] = const
+      end
+
+      def [](id)
+        @processors[id.to_sym]
+      end
+
+      def keys
+        @processors.keys
+      end
+
+      def select_processor(filename)
+        filename = filename.path if filename.respond_to? :path
+        unless filename.is_a? String
+          raise Converter::NoProcessorError,
+                "Can't find a path for #{filename}. You must manually select the processor."
+        end
+
+        @processors.values.find do |i|
+          i.processor_match?(filename)
+        end or raise Converter::NoProcessorError,
+                     "You must manually select the processor for #{filename}"
+      end
+    end
+  end
+end

data/lib/coradoc/document.rb

@@ -1,6 +1,11 @@
 require_relative "element/base"
 require_relative "element/title"
 require_relative "element/block"
+require_relative "element/bibliography"
+require_relative "element/bibliography_entry"
+require_relative "element/comment_block"
+require_relative "element/comment_line"
+require_relative "element/include"
 require_relative "element/section"
 require_relative "element/attribute"
 require_relative "element/attribute_list"
@@ -12,12 +17,14 @@ require_relative "element/header"
 require_relative "element/document_attributes"
 require_relative "element/paragraph"
 require_relative "element/table"
+require_relative "element/tag"
 require_relative "element/list"
 require_relative "element/inline"
 require_relative "element/image"
 require_relative "element/audio"
 require_relative "element/video"
 require_relative "element/break"
+require_relative "element/term"
 
 module Coradoc
   class Document
@@ -60,5 +67,11 @@ module Coradoc
       @sections = options.fetch(:sections, [])
       self
     end
+
+    def to_adoc
+      Coradoc::Generator.gen_adoc(@header) +
+        Coradoc::Generator.gen_adoc(@document_attributes) +
+        Coradoc::Generator.gen_adoc(@sections)
+    end
   end
 end

data/lib/coradoc/element/admonition.rb

@@ -8,6 +8,11 @@ module Coradoc
         @type = type.downcase.to_sym
         @line_break = options.fetch(:line_break, "")
       end
+
+      def to_adoc
+        content = Coradoc::Generator.gen_adoc(@content)
+        "#{type.to_s.upcase}: #{content}#{@line_break}"
+      end
     end
   end
 end

data/lib/coradoc/element/attribute_list.rb

@@ -71,7 +71,7 @@ module Coradoc
         adoc << @named.map do |k, v|
           if v.is_a?(String)
             v = v.gsub("\"", "\\\"")
-            if v.include?(" ") || v.include?(",") || v.include?('"')
+            if v.include?(",") || v.include?('"')
               v = "\"#{v}\""
             end
           elsif v.is_a?(Array)

data/lib/coradoc/element/author.rb

@@ -13,10 +13,10 @@ module Coradoc
       end
 
       def to_adoc
-        adoc = "#{@first_name} "
-        adoc << "#{@middle_name} " if @middle_name
-        adoc << @last_name.to_s
-        adoc << " <#{@email}>" if @email
+        adoc = "#{@first_name}"
+        adoc << " #{@middle_name}" if @middle_name
+        adoc << " #{@last_name.to_s}"
+        adoc << " <#{@email}>\n" if @email
         adoc
       end
     end

data/lib/coradoc/element/bibliography.rb

@@ -0,0 +1,24 @@
+module Coradoc
+  module Element
+    class Bibliography < Base
+      attr_accessor :id, :title, :entries
+
+      def initialize(options = {})
+        @id = options.fetch(:id, nil)
+        @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
+        @title = options.fetch(:title, nil)
+        @entries = options.fetch(:entries,nil)
+      end
+
+      def to_adoc
+        adoc = "#{gen_anchor}\n"
+        adoc << "[bibliography]"
+        adoc << "== #{@title}\n\n"
+        @entries.each do |entry|
+          adoc << "#{entry.to_adoc}\n"
+        end
+        adoc
+      end
+    end
+  end
+end

data/lib/coradoc/element/bibliography_entry.rb

@@ -0,0 +1,24 @@
+module Coradoc
+  module Element
+    class BibliographyEntry < Base
+      attr_accessor :anchor_name, :document_id, :ref_text, :line_break
+
+      def initialize(options = {})
+        @anchor_name = options.fetch(:anchor_name, nil)
+        @document_id = options.fetch(:document_id, nil)
+        @ref_text = options.fetch(:ref_text, nil)
+        @line_break = options.fetch(:line_break, "")
+      end
+
+      def to_adoc
+        text = Coradoc::Generator.gen_adoc(@ref_text) if @ref_text
+        adoc = "* [[[#{@anchor_name}"
+        adoc << ",#{@document_id}" if @document_id
+        adoc << "]]]"
+        adoc << "#{text}" if @ref_text
+        adoc << @line_break
+        adoc
+      end
+    end
+  end
+end

data/lib/coradoc/element/block/core.rb

@@ -10,13 +10,13 @@ module Coradoc
 
         def initialize(title, options = {})
           @title = title
-          @lines = options.fetch(:lines, [])
+          @id = options.fetch(:id, nil)
+          @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
           @type_str = options.fetch(:type, nil)
-          @delimiter = options.fetch(:delimiter, "")
           @attributes = options.fetch(:attributes, AttributeList.new)
+          @delimiter = options.fetch(:delimiter, "")
           @lang = options.fetch(:lang, nil)
-          @id = options.fetch(:id, nil)
-          @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
+          @lines = options.fetch(:lines, [])
         end
 
         def type
@@ -37,6 +37,7 @@ module Coradoc
         def gen_attributes
           attrs = @attributes.to_adoc(false)
           return "#{attrs}\n" if !attrs.empty?
+
           ""
         end
 
@@ -65,6 +66,7 @@ module Coradoc
             "----" => :source,
             "====" => :example,
             "...." => :literal,
+            "++++" => :pass,
           }
         end
       end

data/lib/coradoc/element/block/example.rb

@@ -8,6 +8,7 @@ module Coradoc
           @title = title
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @lines = options.fetch(:lines, [])
           @delimiter_char = "="
           @delimiter_len = options.fetch(:delimiter_len, 4)

data/lib/coradoc/element/block/pass.rb

@@ -0,0 +1,21 @@
+module Coradoc
+  module Element
+    module Block
+      class Pass < Core
+        def initialize(options = {})
+          @id = options.fetch(:id, nil)
+          @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
+          @title = options.fetch(:title, "")
+          @attributes = options.fetch(:attributes, AttributeList.new)
+          @delimiter_char = "+"
+          @delimiter_len = options.fetch(:delimiter_len, 4)
+          @lines = options.fetch(:lines, [])
+        end
+
+        def to_adoc
+          "\n\n#{gen_anchor}#{gen_title}#{gen_attributes}#{gen_delimiter}\n" << gen_lines << "\n#{gen_delimiter}\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/element/block/quote.rb

@@ -11,7 +11,7 @@ module Coradoc
         end
 
         def to_adoc
-          "\n\n#{gen_attributes}#{gen_delimiter}\n" << gen_lines << "\n#{gen_delimiter}\n\n"
+          "\n\n#{gen_title}#{gen_attributes}#{gen_delimiter}\n" << gen_lines << "\n#{gen_delimiter}\n\n"
         end
       end
     end

data/lib/coradoc/element/block/reviewer_comment.rb

@@ -0,0 +1,19 @@
+module Coradoc
+  module Element
+    module Block
+      class ReviewerComment < Core
+        def initialize(options = {})
+          @title = options.fetch(:title, "")
+          @attributes = options.fetch(:attributes, AttributeList.new)
+          @delimiter_char = "*"
+          @delimiter_len = options.fetch(:delimiter_len, 4)
+          @lines = options.fetch(:lines, [])
+        end
+
+        def to_adoc
+          "\n\n#{gen_title}#{gen_attributes}#{gen_delimiter}\n" << gen_lines << "\n#{gen_delimiter}\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/element/block/side.rb

@@ -3,13 +3,15 @@ module Coradoc
     module Block
       class Side < Core
         def initialize(options = {})
-          @lines = options.fetch(:lines, [])
+          @title = options.fetch(:title, "")
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @delimiter_char = "*"
           @delimiter_len = options.fetch(:delimiter_len, 4)
+          @lines = options.fetch(:lines, [])
         end
 
         def to_adoc
-          "\n\n#{gen_delimiter}" << gen_lines << "\n#{gen_delimiter}\n\n"
+          "\n\n#{gen_title}#{gen_attributes}#{gen_delimiter}\n" << gen_lines << "\n#{gen_delimiter}\n\n"
         end
       end
     end

data/lib/coradoc/element/block/sourcecode.rb

@@ -6,6 +6,7 @@ module Coradoc
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
           @lang = options.fetch(:lang, "")
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @lines = options.fetch(:lines, [])
           @delimiter_char = "-"
           @delimiter_len = options.fetch(:delimiter_len, 4)

data/lib/coradoc/element/block.rb

@@ -9,5 +9,7 @@ require_relative "block/core"
 require_relative "block/example"
 require_relative "block/literal"
 require_relative "block/quote"
+require_relative "block/pass"
 require_relative "block/side"
 require_relative "block/sourcecode"
+require_relative "block/reviewer_comment"

data/lib/coradoc/element/comment_block.rb

@@ -0,0 +1,22 @@
+module Coradoc
+  module Element
+    module Comment
+      class Block < Base
+        attr_accessor :text
+
+        def initialize(text, options = {})
+          @text = text
+          @line_break = options.fetch(:line_break, "\n")
+        end
+
+        def to_adoc
+          <<~ADOC.chomp
+            ////
+            #{@text}
+            ////#{@line_break}
+          ADOC
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/element/comment_line.rb

@@ -0,0 +1,18 @@
+module Coradoc
+  module Element
+    module Comment
+      class Line < Base
+        attr_accessor :text
+
+        def initialize(text, options = {})
+          @text = text
+          @line_break = options.fetch(:line_break, "\n")
+        end
+
+        def to_adoc
+          "// #{@text}#{@line_break}"
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/element/document_attributes.rb

@@ -11,10 +11,17 @@ module Coradoc
       end
 
       def to_hash
-        data.to_h do |attribute|
+        @data.to_h do |attribute|
           [attribute.key.to_s, attribute.value.to_s.gsub("'", "")]
         end
       end
+
+      def to_adoc
+        to_hash.map do |key, value|
+          v = value.to_s.empty? ? "" : " #{value}"
+          ":#{key}:#{v}\n"
+        end.join + "\n"
+      end
     end
   end
 end

data/lib/coradoc/element/header.rb

@@ -12,7 +12,7 @@ module Coradoc
       end
 
       def to_adoc
-        adoc = "= #{title}\n"
+        adoc = "= #{@title}\n"
         adoc << @author.to_adoc if @author
         adoc << @revision.to_adoc if @revision
         adoc

data/lib/coradoc/element/image/block_image.rb

@@ -7,6 +7,14 @@ module Coradoc
           @colons = "::"
         end
 
+        def to_adoc
+          missing = "// FIXME: Missing image: #{@annotate_missing}\n" if @annotate_missing
+          anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
+          title = ".#{@title}\n" unless @title.to_s.empty?
+          attrs = @attributes.to_adoc
+          [missing, anchor, title, "image", @colons, @src, attrs, @line_break].join("")
+        end
+
         def validate_named
           @attributes.validate_named(VALIDATORS_NAMED, VALIDATORS_NAMED_BLOCK)
         end

data/lib/coradoc/element/image/core.rb

@@ -9,21 +9,24 @@ module Coradoc
         def initialize(title, id, src, options = {})
           @title = title
           @id = id
-          @anchor = @id.nil? ? nil : Coradoc::Element::Inline::Anchor.new(@id)
+          @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
           @src = src
           @attributes = options.fetch(:attributes, AttributeList.new)
-          @title = options.fetch(:title, nil)
+          @annotate_missing = options.fetch(:annotate_missing, nil)
+          @title = options.fetch(:title, nil) unless @title
           if @attributes.any?
             @attributes.validate_positional(VALIDATORS_POSITIONAL)
             @attributes.validate_named(VALIDATORS_NAMED)
           end
+          @line_break = options.fetch(:line_break, "")
         end
 
         def to_adoc
+          missing = "// FIXME: Missing image: #{@annotate_missing}\n" if @annotate_missing
           anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
           title = ".#{@title}\n" unless @title.to_s.empty?
-          attrs = @attributes.to_adoc
-          [anchor, title, "image", @colons, @src, attrs].join("")
+          attrs = @attributes_macro.to_adoc
+          [missing, anchor, title, "image", @colons, @src, attrs, @line_break].join("")
         end
 
         extend AttributeList::Matchers

data/lib/coradoc/element/include.rb

@@ -0,0 +1,18 @@
+module Coradoc
+  module Element
+    class Include
+      attr_accessor :text
+
+      def initialize(path, options = {})
+        @path = path
+        @attributes = options.fetch(:attributes, AttributeList.new)
+        @line_break = options.fetch(:line_break, "\n")
+      end
+
+      def to_adoc
+        attrs = @attributes.to_adoc(true)
+        "include::#{@path}#{attrs}#{@line_break}"
+      end
+    end
+  end
+end

data/lib/coradoc/element/inline/citation.rb

@@ -0,0 +1,24 @@
+module Coradoc
+  module Element
+    module Inline
+      class Citation < Base
+        attr_accessor :cross_reference, :comment
+
+        declare_children :cross_reference, :comment
+
+        def initialize(opts = {})
+          @cross_reference = opts.fetch(:cross_reference, nil)
+          @comment = opts.fetch(:comment, nil)
+        end
+
+        def to_adoc
+          adoc = "[.source]\n"
+          adoc << @cross_reference.to_adoc if @cross_reference
+          adoc << "\n" if @cross_reference && !@comment
+          adoc << Coradoc::Generator.gen_adoc(@comment) if @comment
+          adoc
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/element/inline/cross_reference.rb

@@ -2,21 +2,42 @@ module Coradoc
   module Element
     module Inline
       class CrossReference < Base
-        attr_accessor :href, :name
+        attr_accessor :href, :args
 
-        declare_children :href, :name
+        declare_children :href, :args
 
-        def initialize(href, name = nil)
+        def initialize(href, args = nil)
           @href = href
-          @name = name
+          @args = args
+          @args = nil if @args == ""
+          @args = [@args] unless @args.is_a?(Array) || @args == nil
         end
 
         def to_adoc
-          if @name.to_s.empty?
-            "<<#{@href}>>"
-          else
-            "<<#{@href},#{@name}>>"
+          if @args
+            args = @args.map{|a|
+              Coradoc::Generator.gen_adoc(a)}.join(',')
+            if args.empty?
+              return "<<#{@href}>>"
+            else
+              return "<<#{@href},#{args}>>"
+            end
           end
+          "<<#{@href}>>"
+        end
+      end
+
+      class CrossReferenceArg < Base
+        attr_accessor :key, :delimiter, :value
+
+        def initialize(key, delimiter, value)
+          @key = key
+          @delimiter = delimiter
+          @value = value
+        end
+
+        def to_adoc
+          [@key,@delimiter,@value].join
         end
       end
     end

data/lib/coradoc/element/inline.rb

@@ -8,6 +8,7 @@ end
 require_relative "inline/anchor"
 require_relative "inline/bold"
 require_relative "inline/cross_reference"
+require_relative "inline/citation"
 require_relative "inline/hard_line_break"
 require_relative "inline/highlight"
 require_relative "inline/italic"

data/lib/coradoc/element/list/core.rb

@@ -14,7 +14,15 @@ module Coradoc
           @items = [@items] unless @items.is_a?(Array)
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-          @ol_count = options.fetch(:ol_count, 1)
+          @ol_count = options.fetch(:ol_count, nil)
+          if @ol_count.nil?
+            m = @items.select do |i|
+              i.is_a?(Coradoc::Element::ListItem) &&
+                !i.marker.nil?
+            end.first&.marker
+            @ol_count = m.size if m.is_a?(String)
+          end
+          @ol_count = 1 if @ol_count.nil?
           @attrs = options.fetch(:attrs, AttributeList.new)
         end
 
@@ -25,8 +33,13 @@ module Coradoc
           @items.each do |item|
             c = Coradoc::Generator.gen_adoc(item)
             if !c.empty?
-              content << prefix.to_s
-              content << " " if c[0]!=" "
+              # If there's a list inside a list directly, we want to
+              # skip adding an empty list item.
+              # See: https://github.com/metanorma/coradoc/issues/96
+              unless item.is_a? List::Core
+                content << prefix.to_s
+                content << " " if c[0] != " "
+              end
               content << c
             end
           end