metanorma-generic 1.4.5

data/lib/isodoc/generic/html_convert.rb

@@ -0,0 +1,63 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Generic
+
+    # 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
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited( k )
+        k._file = caller_locations.first.absolute_path
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' 
+                     : configuration.html_bodyfont || '"Overpass",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : 
+                       configuration.html_headerfont || '"Overpass",sans-serif'),
+          monospacefont: configuration.html_monospacefont || '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: baselocation(configuration.htmlstylesheet) ||
+            html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: baselocation(configuration.htmlcoverpage) ||
+            html_doc_path("html_generic_titlepage.html"),
+          htmlintropage: baselocation(configuration.htmlintropage) ||
+            html_doc_path("html_generic_intro.html"),
+          scripts: baselocation(configuration.scripts) ||
+            html_doc_path("scripts.html"),
+          i18nyaml: baselocation(configuration.i18nyaml)
+        }
+      end
+
+      def configuration
+        Metanorma::Generic.configuration
+      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">
+        HEAD
+      end
+
+      include BaseConvert
+    end
+  end
+end
+

data/lib/isodoc/generic/metadata.rb

@@ -0,0 +1,48 @@
+require "isodoc"
+
+module IsoDoc
+  module Generic
+
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
+        super
+        here = File.dirname(__FILE__)
+        default_logo_path = File.expand_path(File.join(here, "html", "logo.jpg"))
+        set(:logo, baselocation(configuration.logo_path) || default_logo_path)
+      end
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited( k )
+        k._file = caller_locations.first.absolute_path
+      end
+
+      def baselocation(loc)
+        return nil if loc.nil?
+        File.expand_path(File.join(File.dirname(self.class::_file || __FILE__), "..", "..", "..", loc))
+      end
+
+      def configuration
+        Metanorma::Generic.configuration
+      end
+
+      def author(isoxml, _out)
+        super
+        tc = isoxml.at(ns("//bibdata/ext/editorialgroup/committee"))
+        set(:tc, tc.text) if tc
+      end
+
+      def stage_abbr(status)
+        return super unless configuration.stage_abbreviations
+        Hash(configuration.stage_abbreviations).dig(status)
+      end
+
+      def unpublished(status)
+        stages = configuration&.published_stages || ["published"]
+        !(Array(stages).map { |m| m.downcase }.include? status.downcase)
+      end
+    end
+  end
+end

data/lib/isodoc/generic/pdf_convert.rb

@@ -0,0 +1,64 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Generic
+    # 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
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited( k )
+        k._file = caller_locations.first.absolute_path
+      end
+
+       def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif'
+                     : configuration.html_bodyfont || '"Overpass",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+                       configuration.html_headerfont || '"Overpass",sans-serif'),
+          monospacefont: configuration.html_monospacefont || '"Space Mono",monospace'
+        }
+      end
+
+      def default_file_locations(_options)
+        {
+          htmlstylesheet: baselocation(configuration.htmlstylesheet) ||
+            html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: baselocation(configuration.htmlcoverpage) ||
+            html_doc_path("html_generic_titlepage.html"),
+          htmlintropage: baselocation(configuration.htmlintropage) ||
+            html_doc_path("html_generic_intro.html"),
+          scripts_pdf: baselocation(configuration.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|Space+Mono:400,700" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+        HEAD
+      end
+
+      def html_toc(docxml)
+        docxml
+      end
+
+      def configuration
+        Metanorma::Generic.configuration
+      end
+
+      include BaseConvert
+    end
+  end
+end
+

data/lib/isodoc/generic/word_convert.rb

@@ -0,0 +1,56 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Generic
+    # 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
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited( k )
+        k._file = caller_locations.first.absolute_path
+      end
+
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : configuration.word_bodyfont || '"Arial",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' :  configuration.word_headerfont ||  '"Arial",sans-serif'),
+          monospacefont:  configuration.word_monospacefont ||  '"Courier New",monospace'
+        }
+      end
+
+      def default_file_locations(options)
+        {
+          wordstylesheet: baselocation(configuration.wordstylesheet) ||
+            html_doc_path("wordstyle.scss"),
+          standardstylesheet: baselocation(configuration.standardstylesheet) ||
+            html_doc_path("generic.scss"),
+          header: baselocation(configuration.header) ||
+            html_doc_path("header.html"),
+          wordcoverpage: baselocation(configuration.wordcoverpage) ||
+            html_doc_path("word_generic_titlepage.html"),
+          wordintropage: baselocation(configuration.wordintropage) ||
+            html_doc_path("word_generic_intro.html"),
+          i18nyaml: baselocation(configuration.i18nyaml),
+          ulstyle: "l3",
+          olstyle: "l2",
+        }
+      end
+
+      def configuration
+        Metanorma::Generic.configuration
+      end
+
+      include BaseConvert
+    end
+  end
+end

data/lib/metanorma-generic.rb

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

data/lib/metanorma/generic.rb

@@ -0,0 +1,88 @@
+require "metanorma/generic/processor"
+require "metanorma/generic/version"
+require 'forwardable'
+require 'yaml'
+
+module Metanorma
+  module Generic
+    ORGANIZATION_NAME_SHORT = "Acme"
+    ORGANIZATION_NAME_LONG = "Acme Corp."
+    DOCUMENT_NAMESPACE = "https://metanorma.org/ns/generic"
+    YAML_CONFIG_FILE = 'metanorma.yml'
+
+    class Configuration
+      CONFIG_ATTRS = %i[
+        organization_name_short
+        organization_name_long
+        document_namespace
+        docid_template
+        i18nyaml
+        logo_path
+        header
+        htmlcoverpage
+        htmlintropage
+        htmlstylesheet
+        html_bodyfont
+        html_headerfont
+        html_monospacefont
+        published_stages
+        stage_abbreviations
+        scripts
+        scripts_pdf
+        standardstylesheet
+        validate_rng_file
+        wordcoverpage
+        wordintropage
+        wordstylesheet
+        word_bodyfont
+        word_headerfont
+        word_monospacefont
+        xml_root_tag
+      ].freeze
+
+      attr_accessor(*CONFIG_ATTRS)
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited( k )
+        k._file = caller_locations.first.absolute_path
+      end
+
+      def initialize(*args)
+        super
+        # Try to set config values from yaml file in current directory
+        @yaml = File.join(File.dirname(self.class::_file || __FILE__), "..", "..", YAML_CONFIG_FILE)
+        set_default_values_from_yaml_file(@yaml) if File.file?(@yaml)
+        self.organization_name_short ||= ORGANIZATION_NAME_SHORT
+        self.organization_name_long ||= ORGANIZATION_NAME_LONG
+        self.document_namespace ||= DOCUMENT_NAMESPACE
+      end
+
+      def set_default_values_from_yaml_file(config_file)
+        default_config_options = YAML.load(File.read(config_file))
+        CONFIG_ATTRS.each do |attr_name|
+          instance_variable_set("@#{attr_name}", default_config_options[attr_name.to_s])
+        end
+      end
+    end
+
+    class << self
+      extend Forwardable
+
+      attr_accessor :configuration
+
+      Configuration::CONFIG_ATTRS.each do |attr_name|
+        def_delegator :@configuration, attr_name
+      end
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+    end
+
+    configure {}
+  end
+end

data/lib/metanorma/generic/processor.rb

@@ -0,0 +1,71 @@
+require "metanorma/processor"
+
+module Metanorma
+  module Generic
+    class Processor < Metanorma::Processor
+      def initialize
+        @short = :generic
+        @input_format = :asciidoc
+        @asciidoctor_backend = :generic
+      end
+
+      def output_formats
+        super.merge(
+          html: "html",
+          doc: "doc",
+          pdf: "pdf"
+        )
+      end
+
+      def version
+        "Metanorma::Generic #{Metanorma::Generic::VERSION}"
+      end
+
+      def input_to_isodoc(file, filename)
+        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
+      end
+
+      def extract_options(file)
+        head = file.sub(/\n\n.*$/m, "\n")
+        /\n:htmlstylesheet: (?<htmlstylesheet>[^\n]+)\n/ =~ head
+        /\n:htmlcoverpage: (?<htmlcoverpage>[^\n]+)\n/ =~ head
+        /\n:htmlintropage: (?<htmlintropage>[^\n]+)\n/ =~ head
+        /\n:scripts: (?<scripts>[^\n]+)\n/ =~ head
+        /\n:wordstylesheet: (?<wordstylesheet>[^\n]+)\n/ =~ head
+        /\n:standardstylesheet: (?<standardstylesheet>[^\n]+)\n/ =~ head
+        /\n:header: (?<header>[^\n]+)\n/ =~ head
+        /\n:wordcoverpage: (?<wordcoverpage>[^\n]+)\n/ =~ head
+        /\n:wordintropage: (?<wordintropage>[^\n]+)\n/ =~ head
+        /\n:ulstyle: (?<ulstyle>[^\n]+)\n/ =~ head
+        /\n:olstyle: (?<olstyle>[^\n]+)\n/ =~ head
+        new_options = {
+          htmlstylesheet: defined?(htmlstylesheet) ? htmlstylesheet : nil,
+          htmlcoverpage: defined?(htmlcoverpage) ? htmlcoverpage : nil,
+          htmlintropage: defined?(htmlintropage) ? htmlintropage : nil,
+          scripts: defined?(scripts) ? scripts : nil,
+          wordstylesheet: defined?(wordstylesheet) ? wordstylesheet : nil,
+          standardstylesheet: defined?(standardstylesheet) ? standardstylesheet : nil,
+          header: defined?(header) ? header : nil,
+          wordcoverpage: defined?(wordcoverpage) ? wordcoverpage : nil,
+          wordintropage: defined?(wordintropage) ? wordintropage : nil,
+          ulstyle: defined?(ulstyle) ? ulstyle : nil,
+          olstyle: defined?(olstyle) ? olstyle : nil,
+        }.reject { |_, val| val.nil? }
+        super.merge(new_options)
+      end
+
+      def output(isodoc_node, outname, format, options={})
+        case format
+        when :html
+          IsoDoc::Generic::HtmlConvert.new(options).convert(outname, isodoc_node)
+        when :doc
+          IsoDoc::Generic::WordConvert.new(options).convert(outname, isodoc_node)
+        when :pdf
+          IsoDoc::Generic::PdfConvert.new(options).convert(outname, isodoc_node)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/generic/version.rb

@@ -0,0 +1,5 @@
+module Metanorma
+  module Generic
+    VERSION = "1.4.5"
+  end
+end

data/metanorma-generic.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "metanorma/generic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-generic"
+  spec.version       = Metanorma::Generic::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Metanorma template gem for customisation."
+  spec.description   = <<~DESCRIPTION
+    Metanorma template gem for customisation. This gem is meant to be customised for any downstream use.
+    
+    Formerly known as metanorma-acme
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/metanorma-generic"
+  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 "ruby-jing"
+  spec.add_dependency "metanorma-standoc", "~> 1.3.0"
+  spec.add_dependency "isodoc", "~> 1.0.0"
+
+  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