coradoc 1.1.8 → 2.0.12

data/lib/coradoc/oscal.rb

@@ -1,99 +0,0 @@
-require "yaml"
-
-module Coradoc
-  class Oscal
-    attr_reader :_doc
-
-    def initialize(document)
-      @_doc = document
-    end
-
-    def self.to_oscal(document)
-      new(document).to_oscal
-    end
-
-    def to_oscal
-      {
-        "metadata" => _doc.document_attributes.to_hash,
-        "groups"   => sections_as_groups,
-      }
-    end
-
-    private
-
-    # Organizational controls
-    def sections_as_groups
-      _doc.sections.map do |section|
-        Hash.new.tap do |hash|
-          hash["id"] = section.id
-          hash["title"] = section.title&.content
-          hash["controls"] = build_oscal_controls(section.sections)
-        end
-      end
-    end
-
-    # Clause 5.1
-    def build_oscal_controls(sections)
-      sections.map do |section|
-        Hash.new.tap do |hash|
-          hash["id"] = section.id
-          # Use definition lists if present, otherwise fall back to glossaries
-          props_items = if section.respond_to?(:definition_lists) && section.definition_lists && !section.definition_lists.empty?
-                          section.definition_lists.first.items
-                        elsif section.glossaries && !section.glossaries.empty?
-                          section.glossaries.items
-                        else
-                          []
-                        end
-          hash["props"] = build_oscal_props(props_items)
-          hash["parts"] = build_oscal_parts(section.sections)
-        end
-      end
-    end
-
-    # Control, Purpose, Guidance
-    def build_oscal_parts(sections)
-      sections.map do |section|
-        Hash.new.tap do |hash|
-          hash["id"] = section.id
-          hash["name"] = section.title&.text
-          hash["prose"] = build_oscal_prose(section.content)
-          hash["parts"] = build_oscal_sub_parts(section.contents)
-        end.compact
-      end
-    end
-
-    def build_oscal_sub_parts(contents)
-      if contents.length > 1
-        parts = contents.select do |content|
-          content if content.is_a?(Coradoc::Element::Paragraph)
-        end
-
-        parts.map do |part|
-          Hash.new.tap do |hash|
-            hash["id"] = part.id
-            hash["prose"] = part.texts.join(" ")
-          end
-        end
-      end
-    end
-
-    def build_oscal_props(attributes)
-      return [] unless attributes.respond_to?(:map)
-
-      attributes.map do |attribute|
-        next unless attribute.respond_to?(:key) && attribute.respond_to?(:value)
-
-        Hash.new.tap do |hash|
-          hash["name"] = attribute.key.to_s.downcase
-          hash["value"] = attribute.value.to_s
-        end
-      end.compact
-    end
-
-    def build_oscal_prose(paragraph)
-      return nil unless paragraph.respond_to?(:texts)
-      paragraph.texts&.join(" ")
-    end
-  end
-end

data/lib/coradoc/output/adoc.rb

@@ -1,19 +0,0 @@
-module Coradoc
-  module Output
-    module Adoc
-      def self.processor_id
-        :adoc
-      end
-
-      def self.processor_match?(filename)
-        %w[.adoc].any? { |i| filename.downcase.end_with?(i) }
-      end
-
-      def self.processor_execute(input, _options = {})
-        input.transform_values { |i| Coradoc::Generator.gen_adoc(i) }
-      end
-
-      Coradoc::Output.define(self)
-    end
-  end
-end

data/lib/coradoc/output/coradoc_tree_debug.rb

@@ -1,21 +0,0 @@
-module Coradoc
-  module Output
-    module CoradocTreeDebug
-      def self.processor_id
-        :coradoc_tree_debug
-      end
-
-      def self.processor_match?(_filename)
-        false
-      end
-
-      def self.processor_execute(input, _options = {})
-        out = StringIO.new
-        PP.pp(input, out)
-        { nil => out.string }
-      end
-
-      Coradoc::Output.define(self)
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/admonition.rb

@@ -1,24 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Admonition
-        def admonition_type
-          str("NOTE") | str("TIP") | str("EDITOR") |
-            str("IMPORTANT") | str("WARNING") | str("CAUTION") |
-            str("TODO")
-          # requires atypical syntax for access?
-          # | str('DANGER')
-          # | str('SAFETY PRECAUTION')
-        end
-
-        def admonition_line
-          admonition_type.as(:admonition_type) >> str(": ") >>
-            (text.as(:text) >>
-            line_ending.as(:line_break)
-            ).repeat(1)
-              .as(:content)
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/attribute_list.rb

@@ -1,89 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module AttributeList
-        def named_attribute_name
-          attribute_name
-        end
-
-        def named_value_noquote
-          match('[^\],]').repeat(1)
-        end
-
-        def named_value_single_quote
-          str("'") >>
-            match("[^']").repeat(1) >>
-            str("'")
-        end
-
-        def named_value_double_quote
-          str('"') >>
-            match('[^"]').repeat(1) >>
-            str('"')
-        end
-
-        def named_value
-          (named_value_single_quote |
-            named_value_double_quote |
-            named_value_noquote
-          ).as(:named_value)
-        end
-
-        def named_key
-          match("[a-zA-Z0-9_-]").repeat(1).as(:named_key)
-        end
-
-        def named_attribute
-          (named_key >>
-            str(" ").maybe >> str("=") >> str(" ").maybe >>
-              named_value >>
-              str(" ").maybe
-          ).as(:named)
-        end
-
-        def positional_attribute
-          (match['a-zA-Z0-9_\-%.'].repeat(1) >>
-            str("=").absent?
-          ).as(:positional)
-        end
-
-        def named_many
-          (named_attribute.repeat(1, 1) >>
-              (str(",") >> space.maybe >> named_attribute).repeat(0))
-        end
-
-        def positional_one_named_many
-          (positional_attribute.repeat(1, 1) >>
-            (str(",") >> space.maybe >> named_attribute).repeat(1))
-        end
-
-        def positional_many_named_many
-          (positional_attribute.repeat(1, 1) >>
-            (str(",") >> space.maybe >> positional_attribute).repeat(1) >>
-            (str(",") >> space.maybe >> named_attribute).repeat(1))
-        end
-
-        def positional_many
-          (positional_attribute.repeat(1, 1) >>
-            (str(",") >> space.maybe >> positional_attribute).repeat(0))
-        end
-
-        def positional_zero_or_one
-          positional_attribute.repeat(0, 1)
-        end
-
-        def attribute_list(name = :attribute_list)
-          str("[").present? >>
-            str("[") >> str("[").absent? >>
-            (named_many |
-              positional_one_named_many |
-              positional_many_named_many |
-              positional_many |
-              positional_zero_or_one
-            ).as(:attribute_array).as(name) >>
-            str("]")
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/base.rb

@@ -1,87 +0,0 @@
-require "parslet"
-require "parslet/convenience"
-
-require_relative "admonition"
-require_relative "attribute_list"
-require_relative "bibliography"
-require_relative "block"
-require_relative "citation"
-require_relative "content"
-require_relative "document_attributes"
-require_relative "header"
-require_relative "inline"
-require_relative "list"
-require_relative "paragraph"
-require_relative "section"
-require_relative "table"
-require_relative "term"
-require_relative "text"
-
-module Coradoc
-  module Parser
-    module Asciidoc
-      class Base < Parslet::Parser
-        include Coradoc::Parser::Asciidoc::Admonition
-        include Coradoc::Parser::Asciidoc::AttributeList
-        include Coradoc::Parser::Asciidoc::Bibliography
-        include Coradoc::Parser::Asciidoc::Block
-        include Coradoc::Parser::Asciidoc::Citation
-        include Coradoc::Parser::Asciidoc::Content
-        include Coradoc::Parser::Asciidoc::DocumentAttributes
-        include Coradoc::Parser::Asciidoc::Header
-        include Coradoc::Parser::Asciidoc::Inline
-        include Coradoc::Parser::Asciidoc::List
-        include Coradoc::Parser::Asciidoc::Paragraph
-        include Coradoc::Parser::Asciidoc::Section
-        include Coradoc::Parser::Asciidoc::Table
-        include Coradoc::Parser::Asciidoc::Term
-        include Coradoc::Parser::Asciidoc::Text
-
-        def rule_dispatch(rule_name, *args, **kwargs)
-          @dispatch_data ||= {}
-          dispatch_key = [rule_name, args, kwargs.to_a.sort]
-          dispatch_hash = dispatch_key.hash.abs
-          unless @dispatch_data.has_key?(dispatch_hash)
-            alias_name = "#{rule_name}_#{dispatch_hash}".to_sym
-            Coradoc::Parser::Asciidoc::Base.class_exec do
-              rule(alias_name) do
-                send(rule_name, *args, **kwargs)
-              end
-            end
-            @dispatch_data[dispatch_hash] = alias_name
-          end
-          dispatch_method = @dispatch_data[dispatch_hash]
-          send(dispatch_method)
-        end
-
-        add_dispatch = true
-        with_params = true
-
-        parser_methods = (Coradoc::Parser::Asciidoc.constants - [:Base]).map do |const|
-          Coradoc::Parser::Asciidoc.const_get(const).instance_methods
-        end.flatten.uniq
-
-        parser_methods.each do |rule_name|
-          params = Coradoc::Parser::Asciidoc::Base.instance_method(rule_name).parameters
-          if add_dispatch && params == []
-            alias_name = "alias_nondispatch_#{rule_name}".to_sym
-            Coradoc::Parser::Asciidoc::Base.class_exec do
-              alias_method alias_name, rule_name
-              rule(rule_name) do
-                send(alias_name)
-              end
-            end
-          elsif add_dispatch && with_params
-            alias_name = "alias_dispatch_#{rule_name}".to_sym
-            Coradoc::Parser::Asciidoc::Base.class_exec do
-              alias_method alias_name, rule_name
-              define_method(rule_name) do |*args, **kwargs|
-                rule_dispatch(alias_name, *args, **kwargs)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/bibliography.rb

@@ -1,29 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Bibliography
-        def bibliography
-          (element_id.maybe >>
-          str("[bibliography]\n") >>
-          str("== ") >> match("[^\n]").repeat(1).as(:title) >> str("\n") >>
-          bib_entry.repeat(1).as(:entries)
-          ).as(:bibliography)
-        end
-
-        def bib_entry
-          (match("^*") >> str(" [[[") >>
-            match('[^,\[\]\n]').repeat(1).as(:anchor_name) >>
-          (str(",") >>
-            match('[^\]\n]').repeat(1).as(:document_id)
-          ).maybe >>
-          str("]]]") >>
-            (text_line.repeat(0, 1) >>
-              text_line.repeat(0)
-            ).as(:ref_text).maybe >>
-            line_ending.repeat(1).as(:line_break).maybe
-          ).as(:bibliography_entry)
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/block.rb

@@ -1,94 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Block
-        def block(n_deep = 3)
-          (example_block(n_deep) |
-          sidebar_block(n_deep) |
-          source_block(n_deep) |
-          quote_block(n_deep) |
-          pass_block(n_deep)).as(:block)
-        end
-
-        def example_block(n_deep)
-          block_style(n_deep, "=")
-        end
-
-        def pass_block(n_deep)
-          block_style(n_deep, "+", 4, :pass)
-        end
-
-        def quote_block(n_deep)
-          block_style(n_deep, "_")
-        end
-
-        def sidebar_block(n_deep)
-          block_style(n_deep, "*")
-        end
-
-        def source_block(n_deep)
-          block_style(n_deep, "-", 2)
-        end
-
-        def block_title
-          str(".") >> space.absent? >> text.as(:title) >> newline
-        end
-
-        def block_type(type)
-          (line_start? >> str("[") >> str("[").absent? >>
-            str(type).as(:type) >>
-            str("]")) >> newline # |
-        end
-
-        def block_content(n_deep = 3)
-          c = block_image |
-            list |
-            text_line |
-            empty_line.as(:line_break)
-          c = c | block(n_deep - 1) if n_deep.positive?
-          c.repeat(1)
-        end
-
-        def block_delimiter
-          line_start? >>
-            ((str("*") |
-              str("=") |
-              str("_") |
-              str("+") |
-              str("-")).repeat(4) |
-              str("-").repeat(2, 2)) >>
-            newline
-        end
-
-        def element_attributes
-          block_title.maybe >>
-            element_id.maybe >>
-            (attribute_list >> newline).maybe >>
-            block_title.maybe >>
-            newline.maybe >>
-            (attribute_list >> newline).maybe >>
-            element_id.maybe
-        end
-
-        def block_style(n_deep = 3, delimiter = "*", repeater = 4, type = nil)
-          current_delimiter = str(delimiter).repeat(repeater).capture(:delimit)
-          closing_delimiter = dynamic do |_s, c|
-            str(c.captures[:delimit].to_s.strip)
-          end
-
-          element_attributes >>
-            (line_start? >> attribute_list >> newline).maybe >>
-            line_start? >>
-            current_delimiter.as(:delimiter) >> newline >>
-            if type == :pass
-              (text_line | empty_line.as(:line_break)).repeat(1).as(:lines)
-            else
-              (closing_delimiter >> newline).absent? >> block_content(n_deep - 1).as(:lines)
-            end >>
-            line_start? >>
-            closing_delimiter >> newline
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/citation.rb

@@ -1,30 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Citation
-        def xref_anchor
-          match("[^,>]").repeat(1).as(:href_arg).repeat(1, 1)
-        end
-
-        def xref_str
-          match("[^,>]").repeat(1).as(:text)
-        end
-
-        def xref_arg
-          (str("section") | str("paragraph") | str("clause") | str("annex") | str("table")).as(:key) >>
-            match("[ =]").as(:delimiter) >>
-            match("[^,>=]").repeat(1).as(:value)
-        end
-
-        def cross_reference
-          (str("<<") >> xref_anchor >>
-          ((str(",") >> xref_arg).repeat(1) |
-            (str(",") >> xref_str).repeat(1)
-          ).maybe >>
-            str(">>")
-          ).as(:cross_reference)
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/content.rb

@@ -1,64 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Content
-        def literal_space
-          (match[" "] | match[' \t']).repeat(1)
-        end
-
-        # Override
-        def literal_space?
-          literal_space.maybe
-        end
-
-        def list_prefix
-          (line_start? >>
-            (match("^[*]") >> str("*").repeat(1, 5) |
-            match('^[\.]') >> str(".").repeat(1, 5)) >>
-            str(" "))
-        end
-
-        # Text
-        # :zero :one :many
-        def text_line(many_breaks = false)
-          tl = (asciidoc_char_with_id.absent? | element_id_inline) >>
-            literal_space? >> text_any.as(:text)
-          if many_breaks
-            tl >> (line_ending.repeat(1).as(:line_break) | eof?)
-          else
-            tl >> (line_ending.as(:line_break) | eof?)
-          end
-        end
-
-        def asciidoc_char
-          line_start? >> match['*_:+=\-']
-        end
-
-        def asciidoc_char_with_id
-          asciidoc_char | str("[#") | str("[[")
-        end
-
-        def element_id
-          line_start? >>
-            (str("[[") >> keyword.as(:id) >> str("]]") |
-               str("[#") >> keyword.as(:id) >> str("]")
-            ) >> newline
-        end
-
-        def element_id_inline
-          str("[[") >> keyword.as(:id) >> str("]]") |
-            str("[#") >> keyword.as(:id) >> str("]")
-        end
-
-        def glossary
-          keyword.as(:key) >> str("::") >> (str(" ") | newline) >>
-            text.as(:value) >> line_ending.as(:line_break)
-        end
-
-        def glossaries
-          glossary.repeat(1)
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/document_attributes.rb

@@ -1,25 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module DocumentAttributes
-        def attribute_name
-          match("[a-zA-Z0-9_-]").repeat(1)
-        end
-
-        def attribute_value
-          text | str("") >> str("\n").absent?
-        end
-
-        def document_attributes
-          document_attribute.repeat(1)
-            .as(:document_attributes)
-        end
-
-        def document_attribute
-          str(":") >> attribute_name.as(:key) >> str(":") >>
-            space? >> (attribute_value | str("")).as(:value) >> line_ending
-        end
-      end
-    end
-  end
-end

data/lib/coradoc/parser/asciidoc/header.rb

@@ -1,29 +0,0 @@
-module Coradoc
-  module Parser
-    module Asciidoc
-      module Header
-        def header
-          header_title >>
-            author.maybe.as(:author) >>
-            revision.maybe.as(:revision) >> newline.maybe
-        end
-
-        def header_title
-          match("^=") >> str("=").absent? >> space? >> text.as(:title) >> newline
-        end
-
-        def author
-          words.as(:first_name) >> str(",") >>
-            space? >> words.as(:last_name) >>
-            space? >> str("<") >> email.as(:email) >> str(">") >> newline
-        end
-
-        def revision
-          (word >> (str(".") >> word).maybe).as(:number) >>
-            str(",") >> space? >> date.as(:date) >> str(":") >>
-            space? >> words.as(:remark) >> newline
-        end
-      end
-    end
-  end
-end