metanorma-ieee 0.0.1

data/lib/metanorma/ieee/validate_style.rb

@@ -0,0 +1,108 @@
+module Metanorma
+  module IEEE
+    class Converter < Standoc::Converter
+      ASSETS_TO_STYLE =
+        "//termsource | //formula | //termnote | "\
+        "//p[not(ancestor::boilerplate)] | //li[not(p)] | //dt | "\
+        "//dd[not(p)] | //td[not(p)][not(ancestor::boilerplate)] | "\
+        "//th[not(p)][not(ancestor::boilerplate)] | //example".freeze
+
+      def extract_text(node)
+        return "" if node.nil?
+
+        node1 = Nokogiri::XML.fragment(node.to_s)
+        node1.xpath("//link | //locality | //localityStack").each(&:remove)
+        ret = ""
+        node1.traverse { |x| ret += x.text if x.text? }
+        HTMLEntities.new.decode(ret)
+      end
+
+      def asset_style(root)
+        root.xpath(ASSETS_TO_STYLE).each { |e| style(e, extract_text(e)) }
+      end
+
+      def style_regex(regex, warning, node, text)
+        (m = regex.match(text)) && style_warning(node, warning, m[:num])
+      end
+
+      def style_warning(node, msg, text = nil)
+        return if @novalid
+
+        w = msg
+        w += ": #{text}" if text
+        @log.add("Style", node, w)
+      end
+
+      def style(node, text)
+        return if @novalid
+
+        style_number(node, text)
+        style_percent(node, text)
+        style_units(node, text)
+      end
+
+      # Style manual 14.2
+      def style_number(node, text)
+        style_regex(/\b(?<num>[0-9]+,[0-9]+)/i,
+                    "possible decimal comma", node, text)
+        style_regex(/(?:^|\s)(?<num>[\u2212-]?\.[0-9]+)/i,
+                    "decimal without initial zero", node, text)
+      end
+
+      # Style manual 14.2
+      def style_percent(node, text)
+        style_regex(/\b(?<num>[0-9.]+%)/,
+                    "no space before percent sign", node, text)
+      end
+
+      # leaving out as problematic: N J K C S T H h d B o E
+      SI_UNIT = "(m|cm|mm|km|μm|nm|g|kg|mgmol|cd|rad|sr|Hz|Hz|MHz|Pa|hPa|kJ|"\
+                "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|"\
+                "bit|kB|MB|Hart|nat|Sh|var)".freeze
+
+      # Style manual 14.2
+      def style_units(node, text)
+        style_regex(/(\b|^)(?<num>[0-9][0-9.]*#{SI_UNIT})\b/o,
+                    "no space between number and SI unit", node, text)
+        style_regex(/(\b|^)(?<num>[0-9.]+\s*\u00b1\s*[0-9.]+\s*#{SI_UNIT})\b/o,
+                    "unit is needed on both value and tolerance", node, text)
+      end
+
+      # Style manual 16.3.2
+      def table_style(docxml)
+        docxml.xpath("//td").each do |td|
+          style_regex(/^(?<num>[\u2212-]?[0-9]{5,}[.0-9]*|-?[0-9]+\.[0-9]{5,})$/,
+                      "number in table not broken up in threes", td, td.text)
+        end
+        docxml.xpath("//table").each { |t| table_style_columns(t) }
+      end
+
+      # deliberately doing naive, ignoring rowspan
+      def table_style_columns(table)
+        table_extract_columns(table).each do |col|
+          next unless col.any? do |x|
+            /^[0-9. ]+$/.match?(x) &&
+              (/\d{3} \d/.match?(x) || /\d \d{3}/.match?(x))
+          end
+
+          col.each do |x|
+            /^[0-9. ]+$/.match?(x) && /\d{4}/.match?(x) and
+              @log.add("Style", table,
+                       "#{x} is a 4-digit number in a table column with "\
+                       "numbers broken up in threes")
+          end
+        end
+      end
+
+      def table_extract_columns(table)
+        ret = table.xpath(".//tr").each_with_object([]) do |tr, m|
+          tr.xpath("./td | ./th").each_with_index do |d, i|
+            m[i] ||= []
+            m[i] << d.text
+          end
+        end
+        ret.map { |x| x.is_a?(Array) ? x : [] }
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/version.rb

@@ -0,0 +1,5 @@
+module Metanorma
+  module IEEE
+    VERSION = "0.0.1".freeze
+  end
+end

data/lib/metanorma/ieee.rb

@@ -0,0 +1,11 @@
+require "metanorma/ieee/version"
+require "metanorma/ieee/processor"
+require "metanorma/ieee/converter"
+
+module Metanorma
+  module IEEE
+    ORGANIZATION_NAME_SHORT = "IEEE"
+    ORGANIZATION_NAME_LONG = "Institute of Electrical and Electronics Engineers"
+  end
+end
+

data/lib/metanorma-ieee.rb

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

data/metanorma-itu.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "metanorma/ieee/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-ieee"
+  spec.version       = Metanorma::IEEE::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Metanorma for the IEEE"
+  spec.description   = <<~DESCRIPTION
+    Metanorma for the ITU.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/metanorma-ieee"
+  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.5.0")
+
+  spec.add_dependency "metanorma-standoc", "~> 2.1.0"
+
+  spec.add_development_dependency "debug"
+  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", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rubocop", "~> 1.5.2"
+  spec.add_development_dependency "sassc", "2.4.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,284 @@
+--- !ruby/object:Gem::Specification
+name: metanorma-ieee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metanorma-standoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: debug
+  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'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: 'Metanorma for the ITU.
+
+  '
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.adoc
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/html2doc/ieee.rb
+- lib/isodoc/ieee.rb
+- lib/isodoc/ieee/base_convert.rb
+- lib/isodoc/ieee/html/header.html
+- lib/isodoc/ieee/html/html_ieee_intro.html
+- lib/isodoc/ieee/html/html_ieee_titlepage.html
+- lib/isodoc/ieee/html/htmlstyle.css
+- lib/isodoc/ieee/html/htmlstyle.scss
+- lib/isodoc/ieee/html/ieee.css
+- lib/isodoc/ieee/html/ieee.scss
+- lib/isodoc/ieee/html/scripts.html
+- lib/isodoc/ieee/html/word_ieee_intro.html
+- lib/isodoc/ieee/html/word_ieee_titlepage.html
+- lib/isodoc/ieee/html/wordstyle.css
+- lib/isodoc/ieee/html/wordstyle.scss
+- lib/isodoc/ieee/html_convert.rb
+- lib/isodoc/ieee/i18n-en.yaml
+- lib/isodoc/ieee/i18n.rb
+- lib/isodoc/ieee/ieee.amendment.xsl
+- lib/isodoc/ieee/ieee.rb
+- lib/isodoc/ieee/ieee.standard.xsl
+- lib/isodoc/ieee/init.rb
+- lib/isodoc/ieee/metadata.rb
+- lib/isodoc/ieee/pdf_convert.rb
+- lib/isodoc/ieee/presentation_terms.rb
+- lib/isodoc/ieee/presentation_xml_convert.rb
+- lib/isodoc/ieee/word_authority.rb
+- lib/isodoc/ieee/word_cleanup.rb
+- lib/isodoc/ieee/word_convert.rb
+- lib/isodoc/ieee/xref.rb
+- lib/metanorma-ieee.rb
+- lib/metanorma/ieee.rb
+- lib/metanorma/ieee/basicdoc.rng
+- lib/metanorma/ieee/biblio.rng
+- lib/metanorma/ieee/boilerplate.xml
+- lib/metanorma/ieee/cleanup.rb
+- lib/metanorma/ieee/converter.rb
+- lib/metanorma/ieee/front.rb
+- lib/metanorma/ieee/ieee.rng
+- lib/metanorma/ieee/isodoc.rng
+- lib/metanorma/ieee/processor.rb
+- lib/metanorma/ieee/reqt.rng
+- lib/metanorma/ieee/validate.rb
+- lib/metanorma/ieee/validate_section.rb
+- lib/metanorma/ieee/validate_style.rb
+- lib/metanorma/ieee/version.rb
+- metanorma-itu.gemspec
+homepage: https://github.com/metanorma/metanorma-ieee
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key:
+specification_version: 4
+summary: Metanorma for the IEEE
+test_files: []