metanorma-itu 0.0.1

data/lib/isodoc/itu/html_convert.rb

@@ -0,0 +1,72 @@
+require "isodoc"
+require_relative "metadata"
+require "fileutils"
+
+module IsoDoc
+  module ITU
+
+    # 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
+
+      def convert1(docxml, filename, dir)
+        FileUtils.cp html_doc_path('Logo_ITU.jpg'), "#{@localdir}/Logo_ITU.jpg"
+        @files_to_delete << "#{@localdir}/Logo_ITU.jpg"
+        super
+      end
+
+            def html_toc(docxml)
+        docxml
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Open Sans",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Open Sans",sans-serif'),
+          monospacefont: '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_itu_titlepage.html"),
+          htmlintropage: html_doc_path("html_itu_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,800|Space+Mono:400,700" 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|
+          abstract docxml, div3
+          preface docxml, div3
+          middle docxml, div3
+          footnotes div3
+          comments div3
+        end
+      end
+
+      include BaseConvert
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+termsdef: Definitions
+termnote: NOTE %

data/lib/isodoc/itu/metadata.rb

@@ -0,0 +1,100 @@
+require "isodoc"
+
+module IsoDoc
+  module ITU
+
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
+        super
+      end
+
+      def title(isoxml, _out)
+        main = isoxml&.at(ns("//bibdata/title[@language='en']"))&.text
+        set(:doctitle, main)
+        series = isoxml&.at(ns("//bibdata/series[@type='main']/title"))&.text
+        set(:series, series)
+        series1 = isoxml&.at(ns("//bibdata/series[@type='secondary']/title"))&.text
+        set(:series1, series1)
+        series2 = isoxml&.at(ns("//bibdata/series[@type='tertiary']/title"))&.text
+        set(:series2, series2)
+      end
+
+      def subtitle(_isoxml, _out)
+        nil
+      end
+
+      def author(isoxml, _out)
+        bureau = isoxml.at(ns("//bibdata/ext/editorialgroup/bureau"))
+        set(:bureau, bureau.text) if bureau
+        tc = isoxml.at(ns("//bibdata/ext/editorialgroup/committee"))
+        set(:tc, tc.text) if tc
+      end
+
+      def docid(isoxml, _out)
+        dn = isoxml.at(ns("//bibdata/docnumber"))
+        set(:docnumber, dn&.text)
+        dn = isoxml.at(ns("//bibdata/docidentifier"))
+        set(:docidentifier, dn&.text)
+      end
+
+      def status_abbr(status)
+        case status
+        when "working-draft" then "wd"
+        when "committee-draft" then "cd"
+        when "draft-standard" then "d"
+        else
+          ""
+        end
+      end
+
+      def unpublished(status)
+        %w(in-force-prepublished).include? status.downcase
+      end
+
+      def version(isoxml, _out)
+        super
+        revdate = get[:revdate]
+        set(:revdate_monthyear, monthyr(revdate))
+      end
+
+      MONTHS = {
+        "01": "January",
+        "02": "February",
+        "03": "March",
+        "04": "April",
+        "05": "May",
+        "06": "June",
+        "07": "July",
+        "08": "August",
+        "09": "September",
+        "10": "October",
+        "11": "November",
+        "12": "December",
+      }.freeze
+
+      def bibdate(isoxml, _out)
+        pubdate = isoxml.xpath(ns("//bibdata/date[@type = 'published']"))
+        pubdate and set(:pubdate_monthyear, monthyr(pubdate.text))
+      end
+
+      def monthyr(isodate)
+        m = /(?<yr>\d\d\d\d)-(?<mo>\d\d)/.match isodate
+        return isodate unless m && m[:yr] && m[:mo]
+        return "#{m[:mo]}/#{m[:yr]}"
+      end
+
+      def keywords(isoxml, _out)
+        keywords = []
+        isoxml.xpath(ns("//bibdata/ext/keyword")).each do |kw|
+          keywords << kw.text
+        end
+        set(:keywords, keywords)
+      end
+
+      def ip_notice_received(isoxml, _out)
+        received = isoxml.at(ns("//bibdata/ext/ip-notice-received"))&.text || "false"
+        set(:ip_notice_received, received)
+      end
+    end
+  end
+end

data/lib/isodoc/itu/pdf_convert.rb

@@ -0,0 +1,70 @@
+require "isodoc"
+require_relative "metadata"
+require "fileutils"
+
+module IsoDoc
+  module ITU
+    # A {Converter} implementation that generates PDF HTML output, and a
+    # document schema encapsulation of the document for validation
+    class PdfConvert < IsoDoc::PdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def convert1(docxml, filename, dir)
+        FileUtils.cp html_doc_path('Logo_ITU.jpg'), File.join(@localdir, "Logo_ITU.jpg")
+        @files_to_delete << File.join(@localdir, "Logo_ITU.jpg")
+        super
+      end
+
+      def html_toc(docxml)
+        docxml
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Open Sans",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Open Sans",sans-serif'),
+          monospacefont: '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_itu_titlepage.html"),
+          htmlintropage: html_doc_path("html_itu_intro.html"),
+          scripts_pdf: html_doc_path("scripts.pdf.html"),
+        }
+      end
+
+      def googlefonts()
+        <<~HEAD.freeze
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,800|Space+Mono:400,700" 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|
+          abstract docxml, div3
+          preface docxml, div3
+          middle docxml, div3
+          footnotes div3
+          comments div3
+        end
+      end
+
+      include BaseConvert
+    end
+  end
+end

data/lib/isodoc/itu/word_convert.rb

@@ -0,0 +1,115 @@
+require "isodoc"
+require_relative "metadata"
+require "fileutils"
+
+module IsoDoc
+  module ITU
+    # 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
+
+      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
+          keywords docxml, div2
+          preface docxml, div2
+          div2.p { |p| p << "&nbsp;" } # placeholder
+        end
+        section_break(body)
+      end
+
+      def abstract(isoxml, out)
+        f = isoxml.at(ns("//preface/abstract")) || return
+        out.div **attr_code(id: f["id"]) do |s|
+          clause_name(nil, "Summary", s, class: "AbstractTitle")
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def keywords(_docxml, out)
+        kw = @meta.get[:keywords]
+        kw.nil? || kw.empty? and return
+        out.div do |div|
+          clause_name(nil, "Keywords", div,  class: "IntroTitle")
+          div.p kw.sort.join(", ") + "."
+        end
+      end
+
+      def word_preface_cleanup(docxml)
+        docxml.xpath("//h1[@class = 'AbstractTitle'] | "\
+                     "//h1[@class = 'IntroTitle']").each do |h2|
+          h2.name = "p"
+          h2["class"] = "h1Preface"
+        end
+      end
+
+      def word_cleanup(docxml)
+        word_preface_cleanup(docxml)
+        super
+        docxml
+      end
+
+      def middle_title(out)
+        out.p(**{ class: "zzSTDTitle1" }) { |p| p << "Recommendation " + @meta.get[:docidentifier] }
+        out.p(**{ class: "zzSTDTitle2" }) { |p| p << @meta.get[:doctitle] }
+      end
+
+      def word_preface(docxml)
+        super
+        abstractbox = docxml.at("//div[@id='abstractbox']")
+        historybox = docxml.at("//div[@id='historybox']")
+        keywordsbox = docxml.at("//div[@id='keywordsbox']")
+        abstract = docxml.at("//p[@class = 'h1Preface' and text() = 'Summary']/..")
+        history = docxml.at("//p[@class = 'h1Preface' and text() = 'History']/..")
+        keywords = docxml.at("//p[@class = 'h1Preface' and text() = 'Keywords']/..")
+        abstract.parent = abstractbox if abstract && abstractbox
+        history.parent = historybox if history && historybox
+        keywords.parent = keywordsbox if keywords && keywordsbox
+      end
+
+
+      def convert1(docxml, filename, dir)
+        FileUtils.cp html_doc_path('itu-document-comb.png'), File.join(@localdir, "itu-document-comb.png")
+        FileUtils.cp html_doc_path('logo.png'), File.join(@localdir, "logo.png")
+        super
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Times New Roman",serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Times New Roman",serif'),
+          monospacefont: '"Courier New",monospace'
+        }
+      end
+
+      def default_file_locations(options)
+        {
+          wordstylesheet: html_doc_path("wordstyle.scss"),
+          standardstylesheet: html_doc_path("itu.scss"),
+          header: html_doc_path("header.html"),
+          wordcoverpage: html_doc_path("word_itu_titlepage.html"),
+          wordintropage: html_doc_path("word_itu_intro.html"),
+          ulstyle: "l3",
+          olstyle: "l2",
+        }
+      end
+
+      include BaseConvert
+    end
+  end
+end

data/lib/metanorma-itu.rb

@@ -0,0 +1,8 @@
+require "metanorma/itu"
+require "asciidoctor"
+require "asciidoctor/itu"
+require "isodoc/itu"
+
+if defined? Metanorma
+  Metanorma::Registry.instance.register(Metanorma::ITU::Processor)
+end

data/lib/metanorma/itu.rb

@@ -0,0 +1,11 @@
+require "metanorma/itu/processor"
+
+module Metanorma
+  module ITU
+
+    ORGANIZATION_NAME_SHORT = "Acme"
+    ORGANIZATION_NAME_LONG = "Acme Corp."
+    DOCUMENT_NAMESPACE = "https://open.ribose.com/standards/itu"
+
+  end
+end

data/lib/metanorma/itu/processor.rb

@@ -0,0 +1,43 @@
+require "metanorma/processor"
+
+module Metanorma
+  module ITU
+    class Processor < Metanorma::Processor
+
+      def initialize
+        @short = :itu
+        @input_format = :asciidoc
+        @asciidoctor_backend = :itu
+      end
+
+      def output_formats
+        super.merge(
+          html: "html",
+          doc: "doc",
+          pdf: "pdf"
+        )
+      end
+
+      def version
+        "Metanorma::Acme #{Metanorma::ITU::VERSION}"
+      end
+
+      def input_to_isodoc(file, filename)
+        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
+      end
+
+      def output(isodoc_node, outname, format, options={})
+        case format
+        when :html
+          IsoDoc::ITU::HtmlConvert.new(options).convert(outname, isodoc_node)
+        when :doc
+          IsoDoc::ITU::WordConvert.new(options).convert(outname, isodoc_node)
+        when :pdf
+          IsoDoc::ITU::PdfConvert.new(options).convert(outname, isodoc_node)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/itu/version.rb

@@ -0,0 +1,5 @@
+module Metanorma
+  module ITU
+    VERSION = "0.0.1"
+  end
+end

data/metanorma-itu.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "metanorma/itu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-itu"
+  spec.version       = Metanorma::ITU::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Metanorma for the ITU"
+  spec.description   = <<~DESCRIPTION
+    Metanorma for the ITU.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/metanorma-itu"
+  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.add_dependency "asciidoctor", "~> 1.5.7"
+  spec.add_dependency "htmlentities", "~> 4.3.4"
+  spec.add_dependency "ruby-jing"
+  spec.add_dependency "metanorma-standoc", "~> 1.1.0"
+  spec.add_dependency "isodoc", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0.1"
+  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"
+  spec.add_development_dependency "metanorma", "~> 0.3.0"
+  spec.add_development_dependency "metanorma-cli", "~> 1.1.2"
+end