omml 0.1.0 → 0.2.0

data/lib/omml/models.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Omml
+  module Models
+  end
+end
+
+require_relative "models/simple_types"
+require_relative "models/ct_acc"
+require_relative "models/ct_acc_pr"
+require_relative "models/ct_anchor"
+require_relative "models/ct_attr"
+require_relative "models/ct_picture_base"
+require_relative "models/ct_bar"
+require_relative "models/ct_bar_pr"
+require_relative "models/ct_markup"
+require_relative "models/ct_markup_range"
+require_relative "models/ct_bookmark_range"
+require_relative "models/ct_bookmark"
+require_relative "models/ct_border"
+require_relative "models/ct_border_box"
+require_relative "models/ct_border_box_pr"
+require_relative "models/ct_box"
+require_relative "models/ct_box_pr"
+require_relative "models/ct_br"
+require_relative "models/ct_break_bin"
+require_relative "models/ct_break_bin_sub"
+require_relative "models/ct_calendar_type"
+require_relative "models/ct_track_change"
+require_relative "models/ct_char"
+require_relative "models/ct_color"
+require_relative "models/ct_control"
+require_relative "models/ct_ctrl_pr"
+require_relative "models/ct_custom_xml_pr"
+require_relative "models/ct_custom_xml_run"
+require_relative "models/ct_d"
+require_relative "models/ct_d_pr"
+require_relative "models/ct_data_binding"
+require_relative "models/ct_decimal_number"
+require_relative "models/ct_drawing"
+require_relative "models/ct_east_asian_layout"
+require_relative "models/ct_effect_extent"
+require_relative "models/ct_em"
+require_relative "models/ct_empty"
+require_relative "models/ct_eq_arr"
+require_relative "models/ct_eq_arr_pr"
+require_relative "models/ct_f"
+require_relative "models/ct_f_pr"
+require_relative "models/ct_f_type"
+require_relative "models/ct_ff_check_box"
+require_relative "models/ct_ff_data"
+require_relative "models/ct_ff_help_text"
+require_relative "models/ct_ff_name"
+require_relative "models/ct_ff_status_text"
+require_relative "models/ct_ff_text_input"
+require_relative "models/ct_ff_text_type"
+require_relative "models/ct_ffdd_list"
+require_relative "models/ct_fit_text"
+require_relative "models/ct_fld_char"
+require_relative "models/ct_rel"
+require_relative "models/ct_fonts"
+require_relative "models/ct_ftn_edn_ref"
+require_relative "models/ct_func"
+require_relative "models/ct_func_pr"
+require_relative "models/ct_graphical_object"
+require_relative "models/ct_graphical_object_data"
+require_relative "models/ct_graphical_object_frame_locking"
+require_relative "models/ct_group_chr"
+require_relative "models/ct_group_chr_pr"
+require_relative "models/ct_highlight"
+require_relative "models/ct_hps_measure"
+require_relative "models/ct_hyperlink"
+require_relative "models/ct_inline"
+require_relative "models/ct_integer2"
+require_relative "models/ct_integer255"
+require_relative "models/ct_lang"
+require_relative "models/ct_language"
+require_relative "models/ct_lim_loc"
+require_relative "models/ct_lim_low"
+require_relative "models/ct_lim_low_pr"
+require_relative "models/ct_lim_upp"
+require_relative "models/ct_lim_upp_pr"
+require_relative "models/ct_lock"
+require_relative "models/ct_m"
+require_relative "models/ct_m_pr"
+require_relative "models/ct_macro_name"
+require_relative "models/ct_manual_break"
+require_relative "models/ct_math_pr"
+require_relative "models/ct_mc"
+require_relative "models/ct_mc_pr"
+require_relative "models/ct_mcs"
+require_relative "models/ct_move_bookmark"
+require_relative "models/ct_mr"
+require_relative "models/ct_nary"
+require_relative "models/ct_nary_pr"
+require_relative "models/ct_non_visual_drawing_props"
+require_relative "models/ct_non_visual_graphic_frame_properties"
+require_relative "models/ct_o_math"
+require_relative "models/ct_o_math_arg"
+require_relative "models/ct_o_math_arg_pr"
+require_relative "models/ct_o_math_jc"
+require_relative "models/ct_o_math_para"
+require_relative "models/ct_o_math_para_pr"
+require_relative "models/ct_object"
+require_relative "models/ct_office_art_extension"
+require_relative "models/ct_office_art_extension_list"
+require_relative "models/ct_on_off"
+require_relative "models/ct_wordprocessing_on_off"
+require_relative "models/ct_p_tab"
+require_relative "models/ct_perm"
+require_relative "models/ct_perm_start"
+require_relative "models/ct_phant"
+require_relative "models/ct_phant_pr"
+require_relative "models/ct_picture"
+require_relative "models/ct_placeholder"
+require_relative "models/ct_point2_d"
+require_relative "models/ct_pos_h"
+require_relative "models/ct_pos_v"
+require_relative "models/ct_positive_size2_d"
+require_relative "models/ct_proof_err"
+require_relative "models/ct_r"
+require_relative "models/ct_r_pr"
+require_relative "models/ct_r_pr_change"
+require_relative "models/ct_r_pr_original"
+require_relative "models/ct_rad"
+require_relative "models/ct_rad_pr"
+require_relative "models/ct_rpr"
+require_relative "models/ct_ruby"
+require_relative "models/ct_ruby_align"
+require_relative "models/ct_ruby_content"
+require_relative "models/ct_ruby_pr"
+require_relative "models/ct_run_track_change"
+require_relative "models/ct_s_pre"
+require_relative "models/ct_s_pre_pr"
+require_relative "models/ct_s_sub"
+require_relative "models/ct_s_sub_pr"
+require_relative "models/ct_s_sub_sup"
+require_relative "models/ct_s_sub_sup_pr"
+require_relative "models/ct_s_sup"
+require_relative "models/ct_s_sup_pr"
+require_relative "models/ct_script"
+require_relative "models/ct_sdt_combo_box"
+require_relative "models/ct_sdt_content_run"
+require_relative "models/ct_sdt_date"
+require_relative "models/ct_sdt_date_mapping_type"
+require_relative "models/ct_sdt_doc_part"
+require_relative "models/ct_sdt_drop_down_list"
+require_relative "models/ct_sdt_end_pr"
+require_relative "models/ct_sdt_list_item"
+require_relative "models/ct_sdt_pr"
+require_relative "models/ct_sdt_run"
+require_relative "models/ct_sdt_text"
+require_relative "models/ct_shd"
+require_relative "models/ct_shp"
+require_relative "models/ct_signed_hps_measure"
+require_relative "models/ct_signed_twips_measure"
+require_relative "models/ct_simple_field"
+require_relative "models/ct_smart_tag_pr"
+require_relative "models/ct_smart_tag_run"
+require_relative "models/ct_spacing_rule"
+require_relative "models/ct_string"
+require_relative "models/ct_style"
+require_relative "models/ct_sym"
+require_relative "models/ct_text"
+require_relative "models/ct_text_effect"
+require_relative "models/ct_text_scale"
+require_relative "models/ct_top_bot"
+require_relative "models/ct_track_change_numbering"
+require_relative "models/ct_twips_measure"
+require_relative "models/ct_un_signed_integer"
+require_relative "models/ct_underline"
+require_relative "models/ct_vertical_align_run"
+require_relative "models/ct_wrap_none"
+require_relative "models/ct_wrap_path"
+require_relative "models/ct_wrap_square"
+require_relative "models/ct_wrap_through"
+require_relative "models/ct_wrap_tight"
+require_relative "models/ct_wrap_top_bottom"
+require_relative "models/ct_x_align"
+require_relative "models/ct_y_align"
+require_relative "models/groups"
+require_relative "models/o_math"
+require_relative "models/o_math_para"

data/lib/omml/namespace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Omml
+  class Namespace < Lutaml::Xml::W3c::XmlNamespace
+    uri "http://schemas.openxmlformats.org/officeDocument/2006/math"
+    prefix_default "m"
+    attribute_form_default :qualified
+  end
+end

data/lib/omml/parser.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Omml
+  module Parser
+    extend self
+
+    def parse(input, context: Omml::Configuration.context_id)
+      context_id = prepare_context(context)
+      document = parse_document(input)
+      root_class = Omml::Configuration.resolve_root_class(document,
+                                                          context: context_id)
+      root_class.of_xml(document, register: context_id)
+    end
+
+    def root_name(input)
+      Omml::Configuration.root_name_from_document(parse_document(input))
+    end
+
+    private
+
+    def prepare_context(context)
+      context_id = context.to_sym
+
+      if context_id == Omml::Configuration.context_id
+        Omml::Configuration.populate_context! unless Omml::Configuration.context(context_id)
+      else
+        Omml::Configuration.require_context!(context_id)
+      end
+
+      context_id
+    end
+
+    def parse_document(input)
+      Omml::Configuration.xml_adapter.parse(input)
+    rescue Lutaml::Model::InvalidFormatError => e
+      raise Omml::Errors::InvalidXmlError, e.message
+    end
+  end
+end

data/lib/omml/type_substitutions.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Omml
+  module TypeSubstitutions
+    # This module is the small translation table between OOXML schema names and
+    # the Ruby types OMML actually uses at runtime.
+    #
+    # Generated model classes register themselves with Omml::Configuration, but
+    # OOXML also has simple-type names that are schema ids rather than concrete
+    # generated model classes. Lutaml resolves attributes through the active
+    # type context by those schema ids. Without these aliases, parsing can fail
+    # on a known schema name such as `st_string` or
+    # `st_unsigned_decimal_number` even though the correct Ruby type exists.
+    #
+    # Keeping those aliases in this small module preserves the class-owned
+    # registration flow for real models, avoids no-op wrapper classes for every
+    # redundant simple type, and keeps the schema-id compatibility layer visible
+    # in one place. The targets are lambdas so loading this file does not force
+    # the model manifest to load before context population asks for the aliases.
+    GROUPED_ALIASES = [
+      {
+        aliases: %i[long],
+        target: -> { Lutaml::Model::Type::Decimal },
+      },
+      {
+        aliases: %i[st_date_time],
+        target: -> { Lutaml::Model::Type::DateTime },
+      },
+      {
+        aliases: %i[
+          st_decimal_number
+          st_position_offset
+          st_signed_hps_measure
+          st_signed_twips_measure
+        ],
+        target: -> { Lutaml::Model::Type::Integer },
+      },
+      {
+        aliases: %i[
+          st_char
+          st_ff_help_text_val
+          st_ff_name
+          st_ff_status_text_val
+          st_macro_name
+          st_relationship_id
+          st_string
+        ],
+        target: -> { Lutaml::Model::Type::String },
+      },
+      {
+        aliases: %i[
+          st_drawing_element_id
+          st_twips_measure
+          st_un_signed_integer
+          st_wrap_distance
+        ],
+        target: -> { Omml::Models::UnsignedInt },
+      },
+      {
+        aliases: %i[
+          st_eighth_point_measure
+          st_hps_measure
+          st_point_measure
+          st_unsigned_decimal_number
+        ],
+        target: -> { Omml::Models::UnsignedLong },
+      },
+      {
+        aliases: %i[
+          st_short_hex_number
+          st_uchar_hex_number
+        ],
+        target: -> { Omml::Models::HexBinary },
+      },
+    ].freeze
+
+    module_function
+
+    def each_alias
+      GROUPED_ALIASES.each do |entry|
+        target = entry.fetch(:target).call
+
+        entry.fetch(:aliases).each do |type_name|
+          yield type_name, target
+        end
+      end
+    end
+  end
+end

data/lib/omml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Oomml
-  VERSION = '0.1.0'
+module Omml
+  VERSION = "0.2.0"
 end

data/lib/omml/wordprocessing_namespace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Omml
+  class WordprocessingNamespace < Lutaml::Xml::W3c::XmlNamespace
+    uri "http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+    prefix_default "w"
+    attribute_form_default :qualified
+  end
+end

data/lib/omml.rb

@@ -1,9 +1,45 @@
 # frozen_string_literal: true
 
-require_relative 'omml/version'
+require "lutaml/model"
 
-module Oomml
+module Omml
   class Error < StandardError; end
 
-  # Your code goes here...
+  autoload :VERSION, "omml/version"
+  autoload :Configuration, "omml/configuration"
+  autoload :Errors, "omml/errors"
+  autoload :Models, "omml/models"
+  autoload :Namespace, "omml/namespace"
+  autoload :Parser, "omml/parser"
+  autoload :TypeSubstitutions, "omml/type_substitutions"
+  autoload :WordprocessingNamespace, "omml/wordprocessing_namespace"
+
+  module_function
+
+  def default_adapter
+    RUBY_ENGINE == "opal" ? :oga : :ox
+  end
+
+  def configure_adapter!(adapter = default_adapter)
+    Configuration.adapter = adapter
+  end
+
+  def parse(input, context: nil)
+    Parser.parse(
+      string_input(input),
+      context: context || Configuration.context_id,
+    )
+  end
+
+  def root_name(input)
+    Parser.root_name(string_input(input))
+  end
+
+  def string_input(input)
+    return input if input.is_a?(String)
+
+    raise ArgumentError, "Input must be a String"
+  end
+
+  private_class_method :string_input
 end

data/omml.gemspec

@@ -1,34 +1,38 @@
 # frozen_string_literal: true
 
-require_relative 'lib/omml/version'
+require_relative "lib/omml/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'omml'
-  spec.version = Oomml::VERSION
-  spec.authors = ['Ribose Inc.']
-  spec.email = ['open.source@ribose.com']
+  spec.name = "omml"
+  spec.version = Omml::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
 
-  spec.summary = 'OMML (Office Math Markup Language) parser by Plurimath.'
+  spec.summary = "OMML (Office Math Markup Language) parser by Plurimath."
   spec.description = <<~DESCRIPTION
     OMML (Office Math Markup Language) parser and builder used in Plurimath.
   DESCRIPTION
 
-  spec.homepage = 'https://github.com/plurimath/omml'
-  spec.license = 'BSD-2-Clause'
+  spec.homepage = "https://github.com/plurimath/omml"
+  spec.license = "BSD-2-Clause"
 
-  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # `git ls-files -z` loads files that have been added to git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir = 'exe'
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'lutaml-model'
+  spec.add_dependency "lutaml-model", ">= 0.8.0", "< 1.0"
+  spec.add_dependency "moxml", ">= 0.1.18", "< 0.2"
+  spec.add_dependency "oga", "~> 3.4"
+  spec.add_dependency "ox", "~> 2.14"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/sig/omml.rbs

@@ -1,4 +1,4 @@
-module Oomml
+module Omml
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end