asciidoctor-gb 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05fd934d04e964153dbc4a60fc64478b96b286c42ba80c0b154ab821db11e5de
-  data.tar.gz: f05e4828dfe59146657900740535bcd98807536be0fd69c158672d40450af2f9
+  metadata.gz: a3e9ad8796eb1e2a3ffe4403f9d6b4b936b06bd831796ab37d8286b7e2f94607
+  data.tar.gz: 5dd921064ac73351c6650ad15b4ff5e49c716935e2e14d8243f10c05dbdc7169
 SHA512:
-  metadata.gz: d2550d7415566a3068d99b8bc2116d6ce36b67917e5656d5b6492e9ffccc55d1b72c7b1f8bf616c26c31685afb65ab2d9c3d72a0f3397ac0e22f9a6f0ef8fa27
-  data.tar.gz: c3de41e9727717bf657c38b200b447b2b395310aacf79012341a1a72b14c5d4764ab4b1fd5dd7c5b58a17a36c2c78bac4e6826e1fb2c108b596939ad117a838e
+  metadata.gz: 8c2afec17c99a8dad6e68837d20504b17ff62348853bf23c3c08d3954c7bd288049df0911ce98fd0efb36953c0f1fcf66305edb8c25e12d557b3c69741239bdb
+  data.tar.gz: c2bc4e33529e45741d06a98ce7cd34550cf82a79b86d848c5f33b9a6d34712ca681f535b2819be310ba5f5b7346f86d6195b906f2c40d1e2a3b3ec6dae6b79ce

data/.gitignore

@@ -0,0 +1,9 @@
+coverage/
+.byebug_history
+.rspec_status
+.tmp.xml
+gb-issuer-default.gif
+gb.css
+htmlstyle.css
+test.html
+test.xml

data/Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     asciidoctor-gb (0.3.0)
       asciidoctor-iso (>= 0.9.0)
+      gbbib
       isodoc (>= 0.8.0)
       twitter_cldr
 
@@ -13,17 +14,66 @@ GEM
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     asciidoctor (1.5.7.1)
-    asciidoctor-iso (0.9.0)
+    asciidoctor-csand (0.3.0)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.9.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.8.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
+    asciidoctor-csd (0.4.0)
+      asciidoctor-iso (>= 0.9.0)
+      isodoc (>= 0.8.0)
+    asciidoctor-iso (0.9.1)
       asciidoctor (~> 1.5.7)
       iso-bib-item (~> 0.1.6)
       isobib (~> 0.1.6)
       isodoc (>= 0.8)
       ruby-jing
+    asciidoctor-m3d (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.9.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.8.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
+    asciidoctor-rfc (0.9.0)
+      asciidoctor (~> 1.5.7)
+      htmlentities (~> 4.3.4)
+      nokogiri
+      ruby-jing
+      thread_safe
+    asciidoctor-rsd (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.8.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.7.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
     asciimath (1.0.4)
     ast (2.4.0)
     byebug (9.1.0)
     camertron-eprun (1.1.1)
     cldr-plurals-runtime-rb (1.0.1)
+    cnccs (0.1.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -32,6 +82,9 @@ GEM
       nokogiri (>= 1.4.3)
     ffi (1.9.25)
     formatador (0.2.5)
+    gbbib (0.1.2)
+      cnccs
+      iso-bib-item
     guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -58,11 +111,11 @@ GEM
     htmlentities (4.3.4)
     httpclient (2.8.3)
     image_size (2.0.0)
-    iso-bib-item (0.1.6)
+    iso-bib-item (0.1.8)
       duplicate
       isoics (~> 0.1.6)
       nokogiri
-    isobib (0.1.6)
+    isobib (0.1.7)
       algoliasearch
       iso-bib-item (~> 0.1.2)
     isodoc (0.8)
@@ -87,6 +140,15 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
+    metanorma (0.2.3)
+      asciidoctor-csand (>= 0.3.0)
+      asciidoctor-csd (>= 0.4.0)
+      asciidoctor-gb (>= 0.3.0)
+      asciidoctor-iso (>= 0.9.1)
+      asciidoctor-m3d (>= 0.3.1)
+      asciidoctor-rfc (>= 0.9.0)
+      asciidoctor-rsd (>= 0.3.0)
+      isodoc (>= 0.8.0)
     method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -171,6 +233,7 @@ DEPENDENCIES
   equivalent-xml (~> 0.6)
   guard (~> 2.14)
   guard-rspec (~> 4.7)
+  metanorma
   rake (~> 12.0)
   rspec (~> 3.6)
   rubocop (~> 0.50)

data/README.adoc

@@ -4,7 +4,9 @@ image:https://img.shields.io/gem/v/asciidoctor-gb.svg["Gem Version", link="https
 image:https://img.shields.io/travis/riboseinc/asciidoctor-gb/master.svg["Build Status", link="https://travis-ci.org/riboseinc/asciidoctor-gb"]
 image:https://codeclimate.com/github/riboseinc/asciidoctor-gb/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/asciidoctor-gb"]
 
-Ruby gem for generating
+== Functionality
+
+This gem generates
 https://en.wikipedia.org/wiki/Guobiao_standards[Guibiao standards]
 (Chinese national standards), using AsciiDoc.
 
@@ -24,10 +26,65 @@ The gem can also be used to generate Chinese local or sector standards, which
 have the same format; the gem formats the title page to have the correct
 metadata displayed.
 
-The gem generates Word and HTML output. The Word output of the gem is strictly
+The following outputs are generated.
+* (Optional) An HTML preview generated directly from the Asciidoctor document,
+using native Asciidoc formatting.
+** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
+The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
+which is syntactically stricter than the common MathJax processor;
+if you do not get expected results, try bracketting terms your in AsciiMathML
+expressions.
+* an XML representation of the document, intended as a document model for GB
+International Standards.
+* The XML representation is processed in turn to generate the following outputs
+as end deliverable GB standard drafts.
+** HTML
+** Word
+
+The Word output of the gem is strictly
 aligned to the GB/T 1.1 specification, including the fonts and font sizes
 prescribed, and the measurements for element positioning on the page.
 
+== Usage
+
+The preferred way to invoke this gem is via the `metanorma` script:
+
+[source,console]
+----
+$ metanorma --type gb a.adoc                   # output HTML and DOC
+$ metanorma --type gb --extensions html a.adoc # output just HTML
+$ metanorma --type gb --extensions doc a.adoc  # output just DOC
+$ metanorma --type gb --extensions xml a.adoc  # output GB XML
+----
+
+The gem translates the document into GB XML format, and then
+validates its output against the GB XML document model; errors are
+reported to console against the XML, and are intended for users to
+check that they have provided all necessary components of the
+document.
+
+The gem then converts the XML into HTML and DOC.
+
+The gem can also be invoked directly within asciidoctor, though this is deprecated:
+
+[source,console]
+----
+$ asciidoctor -b gb -r 'asciidoctor-gb' a.adoc  
+----
+
+=== Installation
+
+If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
+repository has instructions on setting up your machine to run Metanorma
+scripts such as this one. You need only run the following in a Terminal console:
+
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install asciidoctor-gb
+----
+
+
 == Differences from `asciidoctor-iso`
 
 === Document Attributes

data/asciidoctor-gb.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "asciidoctor-iso", ">= 0.9.0"
+  spec.add_dependency "gbbib"
   spec.add_dependency "isodoc", ">= 0.8.0"
   spec.add_dependency "twitter_cldr"
 
@@ -40,4 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 0.50"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "metanorma"
 end

data/lib/asciidoctor/gb/converter.rb

@@ -7,6 +7,7 @@ require_relative "./section_input.rb"
 require_relative "./front.rb"
 require_relative "./validate.rb"
 require "pp"
+require "byebug"
 
 module Asciidoctor
   module Gb
@@ -186,19 +187,29 @@ module Asciidoctor
       end
 
       def cleanup(xmldoc)
+        lang = xmldoc.at("//language")&.text
+        @agencyclass = IsoDoc::Gb::Agencies.new(lang, {}, "")
         super
         contributor_cleanup(xmldoc)
         xmldoc
       end
 
+      def docidentifier_cleanup(xmldoc)
+        #byebug
+        id = xmldoc.at("//bibdata/docidentifier/project-number") or return
+        scope = xmldoc.at("//gbscope")&.text
+        prefix = xmldoc.at("//gbprefix")&.text
+        mandate = xmldoc.at("//gbmandate")&.text || "mandatory"
+        idtext = @agencyclass.docidentifier(scope, prefix, mandate, nil, id.text) || return
+        id.content = idtext.gsub(/\ /, " ")
+      end
+
       def contributor_cleanup(xmldoc)
         issuer = xmldoc.at("//bibdata/contributor[role/@type = 'issuer']/organization/name")
         scope = xmldoc.at("//gbscope")&.text
         prefix = xmldoc.at("//gbprefix")&.text
         mandate = xmldoc.at("//gbmandate")&.text || "mandatory"
-        lang = xmldoc.at("//language")&.text
         agency = issuer.content
-        @agencyclass = IsoDoc::Gb::Agencies.new(lang, {}, "")
         agency = @agencyclass.standard_agency1(scope, prefix, mandate) if agency == "GB"
         agency = "GB" if agency.nil? || agency.empty?
         owner = xmldoc.at("//copyright/owner/organization/name")

data/lib/asciidoctor/gb/front.rb

@@ -1,3 +1,4 @@
+
 module Asciidoctor
   module Gb
     class Converter < ISO::Converter

data/lib/asciidoctor/gb/section_input.rb

@@ -1,3 +1,5 @@
+require "gbbib"
+
 module Asciidoctor
   module Gb
 
@@ -55,6 +57,30 @@ module Asciidoctor
         end.join("\n")
       end
 
+      # @param xml [Nokogiri::XML::Builder]
+      # @param code [String]
+      #def fetch_ref(xml, code, _year, **opts)
+        #warn "fetching #{code}..."
+        #result = Gbbib::GbBibliography.search code
+        #hit = result.first
+        #if hit&.title&.match(%r{^[^\s]+\s[\d-]+}).to_s == code
+          ## hit.fetch.to_xml xml, opts
+          #xml.parent.add_child hit.fetch.to_xml(xml, opts)
+          #xml
+        #end
+      #end
+
+      #def fetch_ref1(code, year, opts)
+        #id = iso_id(code, year, opts[:all_parts])
+        #return nil if @bibdb.nil? # signals we will not be using isobib
+        #@bibdb[id] = Isobib::IsoBibliography.get(code, year, opts) unless @bibdb[id]
+        #@local_bibdb[id] = @bibdb[id] if !@local_bibdb.nil? &&
+          #!@local_bibdb[id]
+        #return @local_bibdb[id] unless @local_bibdb.nil?
+        #@bibdb[id]
+      #end
+
+
 =begin
       # spec of permissible section sequence
       SEQ = [

data/lib/asciidoctor/gb/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Gb
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/isodoc/gb/agencies.rb

@@ -315,6 +315,27 @@ module IsoDoc
         end
       end
 
+      SCOPEPFX = {
+        :local => "DB",
+        "social-group".to_sym => "T",
+        :enterprise => "Q",
+      }.freeze
+
+      def docidentifier(scope, prefix, mandate, docyear, docnum)
+        dn = case scope
+             when "local"
+               "#{SCOPEPFX[scope.to_sym]}#{mandate_suffix(prefix, mandate)}/"\
+                 "#{docnum}".gsub(%r{/([TZ])/}, "/\\1 ")
+             when "social-group", "enterprise"
+               "#{mandate_suffix(SCOPEPFX[scope.to_sym], mandate)}/"\
+                 "#{prefix} #{docnum}"
+             else
+               "#{mandate_suffix(prefix, mandate)} #{docnum}"
+             end
+        dn += "—#{docyear}" if docyear
+        dn
+      end
+
       def gbtype_validate(root)
         scope = root.at("//gbscope")&.text
         prefix = root.at("//gbprefix")&.text

data/lib/isodoc/gb/metadata.rb

@@ -128,28 +128,6 @@ module IsoDoc
         end
       end
 
-      SCOPEPFX = {
-        :local => "DB",
-        "social-group".to_sym => "T",
-        :enterprise => "Q",
-      }.freeze
-
-      def docidentifier(scope, prefix, mandate, docyear)
-        docnum = get[:docnumber]
-        dn = case scope 
-             when "local"
-               "#{SCOPEPFX[scope.to_sym]}#{@agencies.mandate_suffix(prefix, mandate)}/"\
-                 "#{docnum}".gsub(%r{/([TZ])/}, "/\\1 ")
-             when "social-group", "enterprise"
-               "#{@agencies.mandate_suffix(SCOPEPFX[scope.to_sym], mandate)}/"\
-                 "#{prefix} #{docnum}"
-             else
-               "#{@agencies.mandate_suffix(prefix, mandate)} #{docnum}"
-             end
-        dn += "—#{docyear}" if docyear
-        set(:docidentifier, dn)
-      end
-
       def gb_identifier(isoxml)
         scope = isoxml.at(ns("//gbscope"))&.text || "national"
         mandate = isoxml.at(ns("//gbmandate"))&.text || "mandatory"
@@ -158,7 +136,7 @@ module IsoDoc
         issuer = isoxml&.at(ns("//bibdata/contributor[role/@type = 'issuer']/"\
                                "organization/name"))&.text || "GB"
         @agencies = Agencies.new(@lang, @labels, issuer)
-        docidentifier(scope, prefix, mandate, docyear)
+        set(:docidentifier, @agencies.docidentifier(scope, prefix, mandate, docyear, get[:docnumber]))
         set(:issuer, issuer)
         set(:standard_class, @agencies.standard_class(scope, prefix, mandate))
         set(:standard_agency, @agencies.standard_agency(scope, prefix, mandate))

data/lib/metanorma/gb/processor.rb

@@ -17,6 +17,10 @@ module Metanorma
         }
       end
 
+      def version
+        "Asciidoctor::Gb #{Asciidoctor::Gb::VERSION}"
+      end
+
       def input_to_isodoc(file)
         Metanorma::Input::Asciidoc.new.process(file, @asciidoctor_backend)
       end
@@ -32,4 +36,4 @@ module Metanorma
 
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-gb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor-iso
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: gbbib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: metanorma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   asciidoctor-gb lets you write GB standards (Chinese national standards)
   in AsciiDoc syntax.
@@ -203,6 +231,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".hound.yml"
 - ".oss-guides.rubocop.yml"
 - ".rubocop.ribose.yml"
@@ -327,7 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: asciidoctor-gb lets you write GB standards in AsciiDoc.