stepmod-utils 0.4.14 → 0.5.0

data/lib/stepmod/utils/parsers/models/sub.rb

@@ -0,0 +1,52 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "i"
+require_relative "module_ref"
+require_relative "sup"
+require_relative "tt"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Sub < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+
+          xml do
+            root "sub"
+
+            map_content to: :content
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/sup.rb

@@ -0,0 +1,52 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "i"
+require_relative "module_ref"
+require_relative "sub"
+require_relative "tt"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Sup < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+
+          xml do
+            root "sup"
+
+            map_content to: :content
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/table.rb

@@ -0,0 +1,29 @@
+require "shale"
+
+require_relative "tr"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Table < Shale::Mapper
+          attribute :caption, Shale::Type::String
+          attribute :id, Shale::Type::String
+          attribute :number, Shale::Type::String
+          attribute :width, Shale::Type::String
+          attribute :tr, Tr, collection: true
+
+          xml do
+            root "table"
+
+            map_attribute "caption", to: :caption
+            map_attribute "id", to: :id
+            map_attribute "number", to: :number
+            map_attribute "width", to: :width
+            map_element "tr", to: :tr
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/td.rb

@@ -0,0 +1,98 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bigeqn"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "dl"
+require_relative "eqn"
+require_relative "example"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "figure"
+require_relative "i"
+require_relative "module_ref"
+require_relative "note"
+require_relative "ol"
+require_relative "p"
+require_relative "screen"
+require_relative "sub"
+require_relative "sup"
+require_relative "table"
+require_relative "tt"
+require_relative "ul"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Td < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :rowspan, Shale::Type::String
+          attribute :colspan, Shale::Type::String
+          attribute :align, Shale::Type::String
+          attribute :valign, Shale::Type::String
+          attribute :width, Shale::Type::String
+          attribute :height, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+          attribute :p, P, collection: true
+          attribute :ul, Ul, collection: true
+          attribute :ol, Ol, collection: true
+          attribute :dl, Dl, collection: true
+          attribute :screen, Screen, collection: true
+          attribute :note, Note, collection: true
+          attribute :example, Example, collection: true
+          attribute :eqn, Eqn, collection: true
+          attribute :bigeqn, Bigeqn, collection: true
+          attribute :figure, Figure, collection: true
+          attribute :table, Table, collection: true
+
+          xml do
+            root "td"
+
+            map_content to: :content
+            map_attribute "rowspan", to: :rowspan
+            map_attribute "colspan", to: :colspan
+            map_attribute "align", to: :align
+            map_attribute "valign", to: :valign
+            map_attribute "width", to: :width
+            map_attribute "height", to: :height
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+            map_element "p", to: :p
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "dl", to: :dl
+            map_element "screen", to: :screen
+            map_element "note", to: :note
+            map_element "example", to: :example
+            map_element "eqn", to: :eqn
+            map_element "bigeqn", to: :bigeqn
+            map_element "figure", to: :figure
+            map_element "table", to: :table
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/th.rb

@@ -0,0 +1,98 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bigeqn"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "dl"
+require_relative "eqn"
+require_relative "example"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "figure"
+require_relative "i"
+require_relative "module_ref"
+require_relative "note"
+require_relative "ol"
+require_relative "p"
+require_relative "screen"
+require_relative "sub"
+require_relative "sup"
+require_relative "table"
+require_relative "tt"
+require_relative "ul"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Th < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :rowspan, Shale::Type::String
+          attribute :colspan, Shale::Type::String
+          attribute :align, Shale::Type::String
+          attribute :valign, Shale::Type::String
+          attribute :width, Shale::Type::String
+          attribute :height, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+          attribute :p, P, collection: true
+          attribute :ul, Ul, collection: true
+          attribute :ol, Ol, collection: true
+          attribute :dl, Dl, collection: true
+          attribute :screen, Screen, collection: true
+          attribute :note, Note, collection: true
+          attribute :example, Example, collection: true
+          attribute :eqn, Eqn, collection: true
+          attribute :bigeqn, Bigeqn, collection: true
+          attribute :figure, Figure, collection: true
+          attribute :table, Table, collection: true
+
+          xml do
+            root "th"
+
+            map_content to: :content
+            map_attribute "rowspan", to: :rowspan
+            map_attribute "colspan", to: :colspan
+            map_attribute "align", to: :align
+            map_attribute "valign", to: :valign
+            map_attribute "width", to: :width
+            map_attribute "height", to: :height
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+            map_element "p", to: :p
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "dl", to: :dl
+            map_element "screen", to: :screen
+            map_element "note", to: :note
+            map_element "example", to: :example
+            map_element "eqn", to: :eqn
+            map_element "bigeqn", to: :bigeqn
+            map_element "figure", to: :figure
+            map_element "table", to: :table
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/title.rb

@@ -0,0 +1,53 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "i"
+require_relative "module_ref"
+require_relative "sub"
+require_relative "sup"
+require_relative "tt"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Title < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+
+          xml do
+            root "title"
+
+            map_content to: :content
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/tr.rb

@@ -0,0 +1,26 @@
+require "shale"
+
+require_relative "td"
+require_relative "th"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Tr < Shale::Mapper
+          attribute :align, Shale::Type::String
+          attribute :th, Th, collection: true
+          attribute :td, Td, collection: true
+
+          xml do
+            root "tr"
+
+            map_attribute "align", to: :align
+            map_element "th", to: :th
+            map_element "td", to: :td
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/tt.rb

@@ -0,0 +1,68 @@
+require "shale"
+
+require_relative "a"
+require_relative "b"
+require_relative "bold"
+require_relative "bom_ref"
+require_relative "express_extref"
+require_relative "express_ref"
+require_relative "i"
+require_relative "module_ref"
+require_relative "sub"
+require_relative "sup"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+
+        # These are needed to resolve circular dependencies
+        # https://github.com/kgiszczak/shale/blob/master/spec/shale/schema/xml_generator_spec.rb#L108
+        class Italic < Shale::Mapper; end
+        class A < Shale::Mapper; end
+        class B < Shale::Mapper; end
+        class Bold < Shale::Mapper; end
+        class Sub < Shale::Mapper; end
+        class Sup < Shale::Mapper; end
+        class Li < Shale::Mapper; end
+        class Ol < Shale::Mapper; end
+        class Dl < Shale::Mapper; end
+        class Example < Shale::Mapper; end
+        class Note < Shale::Mapper; end
+        class Table < Shale::Mapper; end
+
+        class Tt < Shale::Mapper
+          attribute :content, Shale::Type::String
+          attribute :express_ref, ExpressRef, collection: true
+          attribute :express_extref, ExpressExtref, collection: true
+          attribute :module_ref, ModuleRef, collection: true
+          attribute :bom_ref, BomRef, collection: true
+          attribute :i, Italic, collection: true
+          attribute :b, B, collection: true
+          attribute :sub, Sub, collection: true
+          attribute :sup, Sup, collection: true
+          attribute :tt, Tt, collection: true
+          attribute :bold, Bold, collection: true
+          attribute :a, A, collection: true
+
+          xml do
+            root "tt"
+
+            map_content to: :content
+            map_element "express_ref", to: :express_ref
+            map_element "express_extref", to: :express_extref
+            map_element "module_ref", to: :module_ref
+            map_element "bom_ref", to: :bom_ref
+            map_element "i", to: :i
+            map_element "b", to: :b
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "bold", to: :bold
+            map_element "a", to: :a
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/models/ul.rb

@@ -0,0 +1,21 @@
+require "shale"
+
+require_relative "li"
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Models
+        class Ul < Shale::Mapper
+          attribute :li, Li, collection: true
+
+          xml do
+            root "ul"
+
+            map_element "li", to: :li
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers/types/string_without_indent.rb

@@ -0,0 +1,17 @@
+# frozen_striing_literal: true
+
+module Stepmod
+  module Utils
+    module Parsers
+      module Types
+        class StringWithoutIndent < Shale::Type::Value
+          def self.cast(value)
+            return unless value
+
+            value.split("\n").map(&:strip).join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/parsers.rb

@@ -0,0 +1,4 @@
+require "shale/adapter/nokogiri"
+require_relative "parsers/mapping_table_parser"
+
+Shale.xml_adapter = Shale::Adapter::Nokogiri

data/lib/stepmod/utils/smrl_description_converter.rb

@@ -43,7 +43,8 @@ module Stepmod
         root || (return "")
 
         ReverseAdoc.config.with(options) do
-          result = ReverseAdoc::Converters.lookup(root.name).convert(root, options)
+          result = ReverseAdoc::Converters.lookup(root.name).convert(root,
+                                                                     options)
           Stepmod::Utils::Cleaner.new.tidy(result)
         end
       end

data/lib/stepmod/utils/smrl_resource_converter.rb

@@ -60,7 +60,8 @@ module Stepmod
         root || (return "")
 
         ReverseAdoc.config.with(options) do
-          result = ReverseAdoc::Converters.lookup(root.name).convert(root, options)
+          result = ReverseAdoc::Converters.lookup(root.name).convert(root,
+                                                                     options)
 
           Stepmod::Utils::Cleaner.new.tidy(result)
         end

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -30,7 +30,8 @@ module Stepmod
       end
 
       def resource_docs_schemas(stepmod_dir)
-        filepath = File.join(stepmod_dir, "data", "resource_docs", "*", "resource.xml")
+        filepath = File.join(stepmod_dir, "data", "resource_docs", "*",
+                             "resource.xml")
 
         schemas = {}
         Dir.glob(filepath).each do |resource_docs_file|
@@ -86,7 +87,8 @@ module Stepmod
             end
 
             schema_base_dir = resource_docs_cache[base_linked]
-            add_images_references(converted_description, schema_base_dir, processed_images_cache)
+            add_images_references(converted_description, schema_base_dir,
+                                  processed_images_cache)
 
             # Add converted description from exact linked path
             if resource_docs_dir && added_resource_descriptions[description["linkend"]].nil?
@@ -97,7 +99,8 @@ module Stepmod
           end
         end
 
-        bib_file_name = extract_bib_file_name(match, resource_docs_cache[@schema_name || ""])
+        bib_file_name = extract_bib_file_name(match,
+                                              resource_docs_cache[@schema_name || ""])
         bib_file = if match
                      File.join(File.dirname(express_file), bib_file_name)
                    else
@@ -135,13 +138,15 @@ module Stepmod
           .gsub(";;", ";")
       end
 
-      def add_images_references(description, schema_base_dir, processed_images_cache)
+      def add_images_references(description, schema_base_dir,
+processed_images_cache)
         referenced_images = description.scan(/image::(.*?)\[\]/).flatten
 
         referenced_images.each do |referenced_image|
           next unless schema_base_dir
 
-          image_file_path = File.join("resource_docs", schema_base_dir, referenced_image)
+          image_file_path = File.join("resource_docs", schema_base_dir,
+                                      referenced_image)
           new_image_file_path = referenced_image
 
           if processed_images_cache[new_image_file_path]
@@ -344,8 +349,10 @@ module Stepmod
         }
       end
 
-      def convert_from_resource_file(resource_docs_dir, stepmod_dir, linked, descriptions_file)
-        resource_docs_file = resource_docs_file_path(stepmod_dir, resource_docs_dir)
+      def convert_from_resource_file(resource_docs_dir, stepmod_dir, linked,
+descriptions_file)
+        resource_docs_file = resource_docs_file_path(stepmod_dir,
+                                                     resource_docs_dir)
 
         resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
         schema = resource_docs.xpath("schema[@name='#{linked}']")

data/lib/stepmod/utils/term.rb

@@ -9,7 +9,7 @@ module Stepmod
       def to_mn_adoc
         mn_adoc = ["=== #{definition.map(&:content).join}"]
         mn_adoc << "\nalt:[#{acronym}]" if acronym
-        mn_adoc << "\n\n#{designations.map(&:designation).join(", ")}" if designations&.any?
+        mn_adoc << "\n\n#{designations.map(&:designation).join(', ')}" if designations&.any?
 
         mn_adoc.join
       end