metanorma-mpfa 0.4.0

data/lib/isodoc/mpfa/html_convert.rb

@@ -0,0 +1,63 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module MPFA
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class HtmlConvert < IsoDoc::HtmlConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      include BaseConvert
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Titillium Web",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Titillium Web",sans-serif'),
+          monospacefont: '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_rsd_titlepage.html"),
+          htmlintropage: html_doc_path("html_rsd_intro.html"),
+          scripts: html_doc_path("scripts.html"),
+        }
+      end
+
+      def googlefonts
+        <<~HEAD.freeze
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Titillium+Web:400,400i,700,700i" rel="stylesheet">
+        HEAD
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+        end
+      end
+
+      def make_body3(body, docxml)
+        body.div **{ class: "main-section" } do |div3|
+          preface docxml, div3
+          middle docxml, div3
+          footnotes div3
+          comments div3
+        end
+      end
+    end
+  end
+end
+

data/lib/isodoc/mpfa/i18n-en.yaml

@@ -0,0 +1,2 @@
+clause: Paragraph
+annex: Appendix

data/lib/isodoc/mpfa/i18n-zh-Hans.yaml

@@ -0,0 +1,2 @@
+clause: 段
+annex: 附录

data/lib/isodoc/mpfa/metadata.rb

@@ -0,0 +1,74 @@
+require "isodoc"
+require "twitter_cldr"
+require 'date'
+
+module IsoDoc
+  module MPFA
+
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
+        super
+                here = File.dirname(__FILE__)
+        set(:logo, File.expand_path(File.join(here, "html", "mpfa-logo-no-text@4x.png")))
+      end
+
+      def title(isoxml, _out)
+        main = isoxml&.at(ns("//bibdata/title[@language='en']"))&.text
+        set(:doctitle, main)
+      end
+
+      def subtitle(_isoxml, _out)
+        nil
+      end
+
+      def author(isoxml, _out)
+        publisher = isoxml.at(ns("//bibdata/contributor/organization/name"))
+        set(:publisher, publisher.text) if publisher
+      end
+
+      def docid(isoxml, _out)
+        docnumber = isoxml.at(ns("//bibdata/docidentifier"))
+        set(:docnumber, docnumber&.text)
+      end
+
+      def doctype(isoxml, _out)
+        b = isoxml&.at(ns("//bibdata/ext/doctype"))&.text || return
+        return unless b
+        t = b.split(/[- ]/).
+          map{ |w| w.capitalize unless w == "MPF" }.join(" ")
+        set(:doctype, t)
+      end
+
+      def stage_abbr(status)
+        case status
+        when "working-draft" then "wd"
+        when "committee-draft" then "cd"
+        when "draft-standard" then "d"
+        else
+          ""
+        end
+      end
+
+      def version(isoxml, _out)
+        super
+        edition = isoxml.at(ns("//version/edition"))
+        if edition
+          set(
+            :edition,
+            edition.text.to_i.localize.
+              to_rbnf_s("SpelloutRules", "spellout-ordinal").
+              split(/(\W)/).map(&:capitalize).join
+          )
+        end
+      end
+
+      def monthyr(isodate)
+        date = DateTime.parse(isodate)
+        date.strftime('%-d %B %Y')    #=> "Sun 04 Feb 2001"
+      rescue
+        # invalid dates get thrown
+        isodate
+      end
+    end
+  end
+end

data/lib/isodoc/mpfa/presentation_xml_convert.rb

@@ -0,0 +1,10 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module MPFA
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+    end
+  end
+end
+

data/lib/isodoc/mpfa/word_convert.rb

@@ -0,0 +1,62 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module MPFA
+    # A {Converter} implementation that generates Word output, and a document
+    # schema encapsulation of the document for validation
+    class WordConvert < IsoDoc::WordConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      include BaseConvert
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Arial",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Arial",sans-serif'),
+          monospacefont: '"Courier New",monospace'
+        }
+      end
+
+      def default_file_locations(options)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_rsd_titlepage.html"),
+          htmlintropage: html_doc_path("html_rsd_intro.html"),
+          scripts: html_doc_path("scripts.html"),
+          wordstylesheet: html_doc_path("wordstyle.scss"),
+          standardstylesheet: html_doc_path("rsd.scss"),
+          header: html_doc_path("header.html"),
+          wordcoverpage: html_doc_path("word_rsd_titlepage.html"),
+          wordintropage: html_doc_path("word_rsd_intro.html"),
+          ulstyle: "l3",
+          olstyle: "l2",
+        }
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+        end
+      end
+
+      def make_body2(body, docxml)
+        body.div **{ class: "WordSection2" } do |div2|
+          info docxml, div2
+          abstract docxml, div2
+          foreword docxml, div2
+          introduction docxml, div2
+          terms_defs docxml, div2, 0
+          div2.p { |p| p << "&nbsp;" } # placeholder
+        end
+        section_break(body)
+      end
+    end
+  end
+end

data/lib/isodoc/mpfa/xref.rb

@@ -0,0 +1,102 @@
+module IsoDoc
+  module MPFA
+    class Xref < IsoDoc::Xref
+      FRONT_CLAUSE = "//*[parent::preface]".freeze
+
+      def initial_anchor_names(d)
+        d.xpath(ns(self.class::FRONT_CLAUSE)).each do |c|
+          preface_names(c)
+          sequential_asset_names(c)
+        end
+        middle_section_asset_names(d)
+        clause_names(d, 0)
+        termnote_anchor_names(d)
+        termexample_anchor_names(d)
+      end
+
+      def annex_name_lbl(clause, num)
+        l10n("<b>#{@labels['annex']} #{num}</b>")
+      end
+
+      def clause_names(docxml, sect_num)
+        q = "//clause[parent::sections]"
+        @topnum = nil
+        lvl = 0
+        docxml.xpath(ns(q)).each do |c|
+          container_names(c, 0)
+          sect_num, lvl = sect_names(c, nil, sect_num, 0, lvl)
+        end
+      end
+
+      def container_names(clause, lvl)
+        if clause["container"]
+          @anchors[clause["id"]] =
+            { label: nil, xref: clause.at(ns("./title"))&.text, level: lvl+1 }
+        end
+        clause.xpath(ns("./clause | ./term  | ./terms | "\
+                        "./definitions")).each do |c|
+          container_names(c, clause["container"] ? lvl+1 : lvl)
+        end
+      end
+
+      def sect_names(clause, num, i, lvl, prev_lvl)
+        return i if clause.nil?
+        curr = i
+        if !clause["container"]
+          retlvl = lvl
+          i+=1
+          curr = i
+          name = num.nil? ? i.to_s : "#{num}.#{i}"
+          @anchors[clause["id"]] = { label: name, level: lvl + 1,
+                                     xref: l10n("#{@labels['clause']} #{name}") }
+        end
+        prev = lvl
+        j = 0
+        clause.xpath(ns("./clause | ./term  | ./terms | "\
+                        "./definitions")).each do |c|
+          if clause["container"]
+            i, lvl = sect_names(c, num, i, lvl, lvl)
+          else
+            j, prev = sect_names(c, name, j, lvl+1, prev)
+          end
+        end
+        i = j if j >0
+        i = curr if lvl < prev
+        [i, prev]
+      end
+
+      def annex_naming(c, num, lvl, i)
+        if c["guidance"] then annex_names1(c, "#{num}E", lvl + 1)
+        else
+          i+= 1 unless c["container"]
+          annex_names1(c, "#{num}.#{i}", lvl + 1)
+        end
+        i
+      end
+
+      def annex_names(clause, num)
+        @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
+                                   xref: "#{@labels['annex']} #{num}", level: 1 }
+        if a = single_annex_special_section(clause)
+          annex_names1(a, "#{num}", 1)
+        else
+          i = 0
+          clause.xpath(ns("./clause | ./references")).each do |c|
+            container_names(c, 0)
+            i = annex_naming(c, num, 1, i)
+          end
+        end
+        hierarchical_asset_names(clause, num)
+      end
+
+      def annex_names1(clause, num, level)
+        clause["container"] or @anchors[clause["id"]] =
+          { label: num, xref: "#{@labels['annex']} #{num}", level: level }
+        i = 0
+        clause.xpath(ns("./clause | ./references")).each do |c|
+          i = annex_naming(c, num, level, i)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma-mpfa.rb

@@ -0,0 +1,11 @@
+require "asciidoctor" unless defined? Asciidoctor::Converter
+require_relative "asciidoctor/mpfa/converter"
+require_relative "isodoc/mpfa/html_convert"
+require_relative "isodoc/mpfa/word_convert"
+require_relative "isodoc/mpfa/presentation_xml_convert"
+require_relative "metanorma/mpfa/version"
+
+if defined? Metanorma
+  require_relative "metanorma/mpfa"
+  Metanorma::Registry.instance.register(Metanorma::MPFA::Processor)
+end

data/lib/metanorma/mpfa.rb

@@ -0,0 +1,7 @@
+require_relative "./mpfa/processor"
+
+module Metanorma
+  module MPFA
+
+  end
+end

data/lib/metanorma/mpfa/processor.rb

@@ -0,0 +1,49 @@
+require "metanorma/processor"
+
+module Metanorma
+  module MPFA
+    def self.fonts_used
+      {
+        html: ["Titillium Web", "Space Mono"],
+        doc: ["Arial", "Courier New"],
+      }
+    end
+
+    class Processor < Metanorma::Processor
+
+      def initialize
+        @short = [:mpfd, :mpfa]
+        @input_format = :asciidoc
+        @asciidoctor_backend = :mpfa
+      end
+
+      def output_formats
+        super.merge(
+          html: "html",
+          doc: "doc"
+        )
+      end
+
+      def version
+        "Metanorma::MPFA #{Metanorma::MPFA::VERSION}"
+      end
+
+      def input_to_isodoc(file, filename)
+        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
+      end
+
+      def output(isodoc_node, inname, outname, format, options={})
+        case format
+        when :html
+          IsoDoc::MPFA::HtmlConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        when :doc
+          IsoDoc::MPFA::WordConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        when :presentation
+          IsoDoc::MPFA::PresentationXMLConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/mpfa/version.rb

@@ -0,0 +1,5 @@
+module Metanorma
+  module MPFA
+    VERSION = "0.4.0"
+  end
+end

data/metanorma-mpfd.gemspec

@@ -0,0 +1,46 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "metanorma/mpfa/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-mpfa"
+  spec.version       = Metanorma::MPFA::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "metanorma-mpfa lets you write MPFA documents in AsciiDoc."
+  spec.description   = <<~DESCRIPTION
+    metanorma-mpfa lets you write MPFA documents in AsciiDoc syntax.
+
+    This gem is in active development.
+
+    Formerly known as metanorma-mpfd
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/metanorma-mpfa"
+  spec.license       = "BSD-2-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.add_dependency "htmlentities", "~> 4.3.4"
+  #spec.add_dependency "nokogiri"
+  spec.add_dependency "metanorma-standoc", "~> 1.4.0"
+  spec.add_dependency "isodoc", "~> 1.1.0"
+  spec.add_dependency "twitter_cldr"
+
+  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rubocop", "= 0.54.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "timecop", "~> 0.9"
+end