relaton-iec 1.7.8 → 1.8.0

data/lib/relaton_iec/basic_block/formula.rb

@@ -0,0 +1,34 @@
+module BasicBlock
+  class Formula
+    #
+    # @param [String] id
+    # @param [BasicBlock::Stem] content
+    # @param [Array<BasicBlock::Note>] note
+    # @param [Hash] args
+    # @option args [Boolean, nil] :unnumbered
+    # @option args [String, nil] :subsequence
+    # @option args [Boolean, nil] :inequality
+    # @option args [BasicBlock::Dl, nil] :dl
+    #
+    def initialize(id:, content:, note:, **args)
+      @id = id
+      @content = content
+      @note = note
+      @unnumbered = args[:unnumbered]
+    end
+
+    #
+    # @param [Builder] builder
+    #
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      f = builder.formula id: @id do |b|
+        @content.to_xml b
+        @dl&.each { |d| d.to_xml b }
+        @note.each { |n| n.to_xml b }
+      end
+      f[:unnumbered] = @unnumbered if @unnumbered
+      f[:subsequence] = @subsequence if @subsequence
+      f[:inequality] = @inequality if @ineainequality
+    end
+  end
+end

data/lib/relaton_iec/basic_block/image.rb

@@ -0,0 +1,41 @@
+module BasicBlock
+  class Image
+    #
+    # @param [String] id
+    # @param [String] src
+    # @param [String] mimetype
+    # @param [Hash] args
+    # @option args [String] :filename
+    #
+    def initialize(id:, src:, mimetype:, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+      @id = id
+      @src = src
+      @mimetype = mimetype
+      @filename = args[:filename]
+      if args[:width] && !args[:width].is_a?(Integer) && args[:width] != "auto"
+        warn "[basic-block] WARNING: invalid image width attribute \"#{args[:width]}"
+        warn "[basic-block] image width should be integer or \"auto\""
+      end
+      if args[:height] && !args[:height].is_a?(Integer) && args[:height] != "auto"
+        warn "[basic-block] WARNING: invalid image height attribute \"#{args[:height]}"
+        warn "[basic-block] image height should be integer or \"auto\""
+      end
+      @width = args[:width]
+      @height = args[:height]
+      @alt = args[:alt]
+      @title = args[:title]
+      @longdesc = args[:longdesc]
+    end
+
+    # @param [Nokogiri::XML::Builder]
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      img = builder.image id: @id, src: @src, mimetype: @mimetype
+      img[:filename] = @filename if @filename
+      img[:width] = @width if @width
+      img[:height] = @height if @height
+      img[:alt] = @alt if @alt
+      img[:title] = @title if @title
+      img[:longdesc] = @longdesc if @longdesc
+    end
+  end
+end

data/lib/relaton_iec/basic_block/index.rb

@@ -0,0 +1,27 @@
+module BasicBlock
+  class Index
+    #
+    # @param [Array<BasicBlock::TextElement] primary
+    # @param [Hash] args
+    # @option args [String, nil] :to
+    # @option args [Array<BasicBlock::TextElement>, nil] :secondary
+    # @option args [Array<BasicBlock::TextElement>, nil] :tertiary
+    #
+    def initialize(primary:, **args)
+      @to = args[:to]
+      @primary = primary
+      @secondary = args[:secondary]
+      @tertiary = args[:tertiary]
+    end
+
+    # @param [Nokogiri::XML::Builder] builder
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      idx = builder.index do |b|
+        @primary.each { |p| p.to_xml b }
+        @secondary&.each { |s| s.to_xml b }
+        @tertiary&.each { |t| t.to_xml b }
+      end
+      idx[:to] = @to if @to
+    end
+  end
+end

data/lib/relaton_iec/basic_block/index_xref.rb

@@ -0,0 +1,31 @@
+module BasicBlock
+  class IndexXref
+    #
+    # @param [Boolean] also
+    # @param [Array<BasicBlock::TextElement>] primary
+    # @param [Array<BasicBlock::TextElement>] target
+    # @param [Hash] args
+    # @option args [Array<BasicBlock::TextElement>, nil] secondary
+    # @option args [Array<BasicBlock::TextElement>, nil] tertiary
+    #
+    def initialize(also:, primary:, target:, **args)
+      @also = also
+      @primary = primary
+      @target = target
+      @secondary = args[:secondary]
+      @tertiary = args[:tertiary]
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      builder.send "index-xref", also: @also do |b|
+        @primary.each { |p| p.to_xml b }
+        @secondary&.each { |s| s.to_xml b }
+        @tertiary&.each { |t| t.to_xml b }
+        @target.each { |t| t.to_xml b }
+      end
+    end
+  end
+end

data/lib/relaton_iec/basic_block/note.rb

@@ -0,0 +1,21 @@
+module BasicBlock
+  class Note
+    #
+    # @param [String] id
+    # @param [Array<BasicBlock::Paragraph>] content
+    #
+    def initialize(id:, content:)
+      @id = id
+      @contain = content
+    end
+
+    #
+    # @param [Nokogiei::XMO::Builder] builder
+    #
+    def to_xml(builder)
+      builder.note id: @id do |b|
+        @content.each { |c| c.to_xm b }
+      end
+    end
+  end
+end

data/lib/relaton_iec/basic_block/paragraph.rb

@@ -0,0 +1,27 @@
+module BasicBlock
+  class Paragraph
+    #
+    # @param [String] id
+    # @param [Array<BasicBlock::TextElement>] content
+    # @param [Array<BasicBlock::Note>] note
+    # @param [BasicBlock::Alignment, nil] align
+    #
+    def initialize(id:, content:, note:, align: nil)
+      @id = id
+      @content = content
+      @note = note
+      @align = align
+    end
+  end
+
+  #
+  # @param [Nokogiri::XML::Builder] builder
+  #
+  def to_xml(builder)
+    p = builder.p id: @id do |b|
+      @content.each { |c| c.to_xml b }
+      @note.each { |n| n.to_xml b }
+    end
+    p[:align] = @align if @align
+  end
+end

data/lib/relaton_iec/basic_block/paragraph_with_footnote.rb

@@ -0,0 +1,29 @@
+module BasicBlock
+  class ParagraphWithFootnote
+    #
+    # @param [String] id
+    # @param [Hash] args
+    # @param [BasicBlock::Alignment, nil] align
+    # @param [Array<BasicBlock::TextElement, BasicBlock::Eref, BasicBlock::Stem,
+    #   BasicBlock::Image, BasicBlock::Index, BasicBlock::IndexXref>] content
+    # @param [Array<RelatonIec::Note>] note
+    #
+    def initialize(id:, align: nil, content: [], note: [])
+      @id = id
+      @aligments = align
+      @content = content
+      @note = note
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder)
+      elm = builder.p(@id) do |b|
+        @content.each { |te| te.to_xml b }
+        @note.each { |n| n.to_xml b }
+      end
+      elm[:align] = @align if @align
+    end
+  end
+end

data/lib/relaton_iec/basic_block/reference_format.rb

@@ -0,0 +1,38 @@
+module RelatonIec
+  def self.respond_to_missing?(method, _include_private)
+    method == "ReferenceFormat"
+  end
+
+  def self.method_missing(_method, *args)
+    ReferenceFormat.new *args
+  end
+
+  class ReferenceFormat
+    FORMATS = %w[external inline footnote callout].freeze
+
+    #
+    # @param [String] format
+    #
+    def initialize(format)
+      unless FORMATS.include? format
+        warn "[relaton-iec] WARNING: invalid reference format \"#{format}\""
+        warn "[relaton-iec] alloved reference formats are: #{FORMATS.join ', '}"
+      end
+      @format = format
+    end
+
+    #
+    # @return [String]
+    #
+    def to_s
+      @format
+    end
+
+    #
+    # @return [Sting] <description>
+    #
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/relaton_iec/basic_block/stem.rb

@@ -0,0 +1,30 @@
+module BasicBlock
+  class Stem
+    TYPES = %w[MathML AsciiMath].freeze
+
+    # @return [String]
+    attr_reader :type
+
+    #
+    # @param [String] type
+    # @param [Array<#to_xml>] content any element
+    #
+    def initialize(type:, content: [])
+      unless TYPES.include? type
+        warn "[relaton-iec] WARNING: invalud type \"#{type}\""
+        warn "[relaton-iec] allowed types are: #{TYPES.join ', '}"
+      end
+      @type = type
+      @content = content
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder)
+      builder.stem(type) do |b|
+        content.each { |c| c.to_xml b }
+      end
+    end
+  end
+end

data/lib/relaton_iec/basic_block/table.rb

@@ -0,0 +1,115 @@
+module BasicBlock
+  class Table
+    #
+    # @param [String] id
+    # @param [Array<BasicBlock::Tr>] tbody
+    # @param [Array<BasicBlock::Paragraph>] note
+    # @param [Hash] args
+    # @option args [Boolean, nil] :unnumbered
+    # @option args [String, nil] :subsequence
+    # @option args [String, nil] :alt
+    # @option args [String, nil] :summary
+    # @option args [String, nil] :uri
+    # @option args [BasicBlock::TextElement, nil] :tname
+    # @option args [BasicBlock::Table::Tr, nil] :thead
+    # @option args [BasicBlock::TextElement, nil] :tfoot
+    # @option args [BasicBlock::Dl, nil] :dl
+    #
+    def initialize(id:, tbody:, note:, **args) # rubocop:disable Metrics/MethodLength
+      @id = id
+      @unnumbered = args[:unnumbered]
+      @subsequence = args[:subsequence]
+      @alt = args[:alt]
+      @summary = args[:summary]
+      @uri = args[:uri]
+      @tname = args[:tname]
+      @thead = args[:thead]
+      @tbody = tbody
+      @tfoot = args[:tfoot]
+      @note = note
+      @dl = args[:dl]
+    end
+
+    # @param [Nokogiri::XML::Builder] builder
+    def to_xml(builder) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+      tab = builder.table id: @id do |b|
+        b.name { @tname.to_xml b } if @tname
+        b.thead { @thead.to_xml b } if @thead
+        @tbody.each { |tb| tb.to_xml b }
+        b.name { @tfoot.to_xml b } if @tfoot
+        @note.each { |n| b.note { n.to_xml b } }
+        @dl.to_xml b
+      end
+      tab[:unnumbered] = @unnumbered if @unnumbered
+      tab[:subsequence] = @subsequence if @subsequence
+      tab[:alt] = @alt if @alt
+      tab[:summary] = @summary if @summary
+      tab[:uri] = @uri if @uri
+    end
+
+    class Tr
+      # @param [Array<BasicBlock::Table::Td, BasicBlock::Table::Th>] content
+      def initialize(content)
+        @content = content
+      end
+
+      # @param [Nokogiri::XML::Builder] builder
+      def to_xml(builder)
+        builder.tr do |b|
+          @content.each { |c| c.to_xm b }
+        end
+      end
+    end
+
+    class TabCell
+      ALIGNS = %w[left right ceter].freeze
+      VALIGNS = %w[top middle bottom baseline].freeze
+
+      # @param [Array<BasicBlock::TextElement,
+      #   BasicBlock::ParagraphWithFootnote>] content
+      # @param [Hssh] args
+      # @option args [String, nil] :colspan
+      # @option args [String, nil] :rowspan
+      # @option args [String, nil] :align
+      # @option args [String, nil] :valign
+      def initialize(content, **args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        if args[:align] && !ALIGNS.include?(args[:align])
+          warn "[basic-block] WARNING: invalid table/tr/td align \"#{args[:align]}\""
+          warn "[basic-block] alloved aligns are: #{ALIGNS.join ', '}"
+        end
+        if args[:valign] && !VALIGNS.include?(args[:valign])
+          warn "[basic-block] WARNING: invalid table/tr/td valign \"#{args[:valign]}\""
+          warn "[basic-block] alloved valigns are: #{VALIGNS.join ', '}"
+        end
+        @content = content
+        @colspan = args[:colspan]
+        @rowspan = args[:rowspan]
+        @align = args[:align]
+        @valign = args[:valign]
+      end
+
+      # @param [Nokogiri::XML::Builder] builder
+      def to_xml(builder)
+        td = @content.each { |c| c.to_xml builder }
+        td[:colspan] = @colspan if @colspan
+        td[:rowspan] = @rowspan if @rowspan
+        td[:align] = @align if @align
+        td[:valign] = @valign if @valign
+      end
+    end
+
+    class Td < BasicBlock::Table::TabCell
+      # @param [Nokogiri::XML::Builder] builder
+      def to_xml(builder)
+        builder.th { super }
+      end
+    end
+
+    class Th < BasicBlock::Table::TabCell
+      # @param [Nokogiri::XML::Builder] builder
+      def to_xml(builder)
+        builder.td { super }
+      end
+    end
+  end
+end

data/lib/relaton_iec/basic_block/text_element.rb

@@ -0,0 +1,27 @@
+module BasicBlock
+  class TextElement
+    TAGS = %w[em strong sub sup tt underline strike smallcap br hr keyword rp
+              rt ruby pagebreak bookmark].freeze
+
+    #
+    # @param [String] tag
+    # @param [Array<String, BasicBlock::TextElement, BasicBlock::Stem>,
+    #   String] content
+    #
+    def initialize(tag:, content:)
+      unless TAGS.include? tag
+        warn "[basic-block] WARNING: invalid tag \"#{tag}\""
+        warn "[basic-block] allowed tags are: #{TAGS.join ', '}"
+      end
+      @tag = tag
+      @content = content
+    end
+
+    # @param [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.send @tag do |b|
+        @content.each { |c| c.is_a?(String) ? c : c.to_xml(b) }
+      end
+    end
+  end
+end

data/lib/relaton_iec/hit_collection.rb

@@ -25,7 +25,7 @@ module RelatonIec
     def to_all_parts # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity
       parts = @array.reject { |h| h.part.nil? }
       hit = parts.min_by &:part
-      return @array.first.fetch lang unless hit
+      return @array.first&.fetch unless hit
 
       bibitem = hit.fetch
       all_parts_item = bibitem.to_all_parts