coradoc-docx 0.1.0

data/lib/coradoc/docx.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'coradoc'
+require 'coradoc/core_model'
+require 'uniword'
+
+# Coradoc::Docx provides DOCX (OOXML) format support for Coradoc.
+#
+# Transforms Uniword::Wordprocessingml model trees into
+# Coradoc::CoreModel, enabling DOCX → AsciiDoc and DOCX → Markdown
+# conversion via the hub-and-spoke architecture.
+#
+# @example Convert DOCX to AsciiDoc
+#   Coradoc.convert("input.docx", from: :docx, to: :asciidoc)
+#
+# @example Parse DOCX to CoreModel
+#   core = Coradoc::Docx.parse_to_core("input.docx")
+#
+module Coradoc
+  module Docx
+    autoload :VERSION, 'coradoc/docx/version'
+    autoload :Transform, 'coradoc/docx/transform'
+
+    class << self
+      # Parse a DOCX input to CoreModel
+      #
+      # @param input [String, IO, Uniword::Wordprocessingml::DocumentRoot]
+      #   Path to .docx file, IO stream, or pre-parsed Uniword document
+      # @param _options [Hash] additional options (reserved)
+      # @return [Coradoc::CoreModel::StructuralElement] CoreModel document
+      def parse_to_core(input, _options = {})
+        document = coerce_to_document(input)
+        Transform::ToCoreModel.transform(document)
+      end
+
+      # Parse a DOCX input to Uniword model (no CoreModel conversion)
+      #
+      # @param input [String, IO] path to .docx file or IO stream
+      # @return [Uniword::Wordprocessingml::DocumentRoot] Uniword document model
+      def parse(input, _options = {})
+        coerce_to_document(input)
+      end
+
+      # Whether this format supports serialization
+      def serialize?
+        true
+      end
+
+      # Serialize CoreModel to DOCX
+      #
+      # @param core_model [Coradoc::CoreModel::Base] CoreModel document
+      # @param options [Hash] serialization options
+      # @option options [String] :output_path Path to write .docx file
+      # @return [String, Uniword::Wordprocessingml::DocumentRoot]
+      #   Returns the output path if :output_path given, otherwise the DocumentRoot
+      def serialize(core_model, **options)
+        document = Transform::FromCoreModel.transform(core_model)
+
+        if options[:output_path]
+          document.save(options[:output_path])
+          options[:output_path]
+        elsif options[:to_io]
+          io = options[:to_io]
+          document.save(io.path)
+          io
+        else
+          document
+        end
+      end
+
+      private
+
+      def coerce_to_document(input)
+        case input
+        when Uniword::Wordprocessingml::DocumentRoot
+          input
+        when String
+          raise ArgumentError, "File not found: #{input}" unless File.exist?(input)
+
+          Uniword::DocumentFactory.from_file(input)
+
+        when IO, StringIO
+          Uniword::DocumentFactory.from_io(input)
+        else
+          raise ArgumentError,
+                "Expected file path, IO, or DocumentRoot, got #{input.class}"
+        end
+      end
+    end
+  end
+end
+
+# Auto-register :docx format with Coradoc when both gems are loaded
+unless Coradoc.registered_formats.include?(:docx)
+  Coradoc.register_format(:docx, Coradoc::Docx,
+                          aliases: %w[docx],
+                          extensions: %w[.docx],
+                          binary: true)
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: coradoc-docx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coradoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: uniword
+  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: rake
+  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: rspec
+  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: rubocop
+  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: Provides OOXML (DOCX) to CoreModel transformation for the Coradoc document
+  transformation hub. Uses Uniword to read DOCX files and transforms the OOXML model
+  tree to Coradoc::CoreModel.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- lib/coradoc/docx.rb
+- lib/coradoc/docx/transform.rb
+- lib/coradoc/docx/transform/context.rb
+- lib/coradoc/docx/transform/from_core_model.rb
+- lib/coradoc/docx/transform/numbering_resolver.rb
+- lib/coradoc/docx/transform/ordered_content.rb
+- lib/coradoc/docx/transform/rule.rb
+- lib/coradoc/docx/transform/rule_registry.rb
+- lib/coradoc/docx/transform/rules/bookmark_rule.rb
+- lib/coradoc/docx/transform/rules/break_rule.rb
+- lib/coradoc/docx/transform/rules/footnote_rule.rb
+- lib/coradoc/docx/transform/rules/heading_rule.rb
+- lib/coradoc/docx/transform/rules/hyperlink_rule.rb
+- lib/coradoc/docx/transform/rules/image_rule.rb
+- lib/coradoc/docx/transform/rules/list_item_rule.rb
+- lib/coradoc/docx/transform/rules/math_rule.rb
+- lib/coradoc/docx/transform/rules/paragraph_rule.rb
+- lib/coradoc/docx/transform/rules/proof_error_rule.rb
+- lib/coradoc/docx/transform/rules/run_rule.rb
+- lib/coradoc/docx/transform/rules/simple_field_rule.rb
+- lib/coradoc/docx/transform/rules/structured_document_tag_rule.rb
+- lib/coradoc/docx/transform/rules/table_rule.rb
+- lib/coradoc/docx/transform/rules/text_rule.rb
+- lib/coradoc/docx/transform/style_resolver.rb
+- lib/coradoc/docx/transform/to_core_model.rb
+- lib/coradoc/docx/version.rb
+homepage: https://github.com/lutaml/coradoc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lutaml/coradoc
+  source_code_uri: https://github.com/lutaml/coradoc
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: DOCX (OOXML) format support for Coradoc
+test_files: []