uniword 1.0.0

data/lib/uniword/drawingml/transform2_d.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+module Uniword
+  module Drawingml
+    # 2D transformation
+    #
+    # Generated from OOXML schema: drawingml.yml
+    # Element: <a:xfrm>
+    class Transform2D < Lutaml::Model::Serializable
+      attribute :off, Offset
+      attribute :ext, Extents
+
+      xml do
+        element 'xfrm'
+        namespace Uniword::Ooxml::Namespaces::DrawingML
+
+        map_element 'off', to: :off, render_nil: false
+        map_element 'ext', to: :ext, render_nil: false
+      end
+    end
+  end
+end

data/lib/uniword/drawingml.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+# DrawingML namespace module
+# This file explicitly autoloads all DrawingML classes
+# Using explicit autoload instead of dynamic Dir[] for maintainability
+#
+# Namespace: http://schemas.openxmlformats.org/drawingml/2006/main
+# Prefix: a:
+
+module Uniword
+  module Drawingml
+    # Graphics Primitives (7)
+    autoload :Graphic, 'uniword/drawingml/graphic'
+    autoload :GraphicData, 'uniword/drawingml/graphic_data'
+    autoload :Blip, 'uniword/drawingml/blip'
+    autoload :BlipFill, 'uniword/drawingml/blip_fill'
+    autoload :Stretch, 'uniword/drawingml/stretch'
+    autoload :Tile, 'uniword/drawingml/tile'
+    autoload :SourceRect, 'uniword/drawingml/source_rect'
+
+    # Shapes (4)
+    autoload :Shape, 'uniword/drawingml/shape'
+    autoload :NonVisualShapeProperties, 'uniword/drawingml/non_visual_shape_properties'
+    autoload :NonVisualDrawingProperties, 'uniword/drawingml/non_visual_drawing_properties'
+    autoload :ShapeProperties, 'uniword/drawingml/shape_properties'
+
+    # Style & References (6)
+    autoload :StyleMatrix, 'uniword/drawingml/style_matrix'
+    autoload :StyleReference, 'uniword/drawingml/style_reference'
+    autoload :StyleMatrixReference, 'uniword/drawingml/style_matrix_reference'
+    autoload :ShapeStyle, 'uniword/drawingml/shape_style'
+    autoload :FontReference, 'uniword/drawingml/font_reference'
+    autoload :LineDefaults, 'uniword/drawingml/line_defaults'
+    autoload :RelativeRect, 'uniword/drawingml/relative_rect'
+
+    # Transforms (3)
+    autoload :Transform2D, 'uniword/drawingml/transform2_d'
+    autoload :Offset, 'uniword/drawingml/offset'
+    autoload :Extents, 'uniword/drawingml/extents'
+
+    # Line Properties (6)
+    autoload :LineProperties, 'uniword/drawingml/line_properties'
+    autoload :PresetDash, 'uniword/drawingml/preset_dash'
+    autoload :CustomDash, 'uniword/drawingml/custom_dash'
+    autoload :DashStop, 'uniword/drawingml/dash_stop'
+    autoload :LineJoinRound, 'uniword/drawingml/line_join_round'
+    autoload :LineJoinMiter, 'uniword/drawingml/line_join_miter'
+
+    # Text Body & Structure (4)
+    autoload :TextBody, 'uniword/drawingml/text_body'
+    autoload :BodyProperties, 'uniword/drawingml/body_properties'
+    autoload :TextParagraph, 'uniword/drawingml/text_paragraph'
+    autoload :TextRun, 'uniword/drawingml/text_run'
+
+    # Text Properties (10)
+    autoload :ListStyle, 'uniword/drawingml/list_style'
+    autoload :DefaultParagraphProperties, 'uniword/drawingml/default_paragraph_properties'
+    autoload :Level1ParagraphProperties, 'uniword/drawingml/level1_paragraph_properties'
+    autoload :Level2ParagraphProperties, 'uniword/drawingml/level2_paragraph_properties'
+    autoload :Level3ParagraphProperties, 'uniword/drawingml/level3_paragraph_properties'
+    autoload :TextParagraphProperties, 'uniword/drawingml/text_paragraph_properties'
+    autoload :TextCharacterProperties, 'uniword/drawingml/text_character_properties'
+    autoload :TextFont, 'uniword/drawingml/text_font'
+    autoload :EastAsianFont, 'uniword/drawingml/east_asian_font'
+    autoload :ComplexScriptFont, 'uniword/drawingml/complex_script_font'
+
+    # Basic Fills (2)
+    autoload :SolidFill, 'uniword/drawingml/solid_fill'
+    autoload :NoFill, 'uniword/drawingml/no_fill'
+
+    # Colors (2)
+    autoload :SrgbColor, 'uniword/drawingml/srgb_color'
+    autoload :SchemeColor, 'uniword/drawingml/scheme_color'
+
+    # Gradient Fills (10)
+    autoload :GradientFill, 'uniword/drawingml/gradient_fill'
+    autoload :GradientStopList, 'uniword/drawingml/gradient_stop_list'
+    autoload :GradientStop, 'uniword/drawingml/gradient_stop'
+    autoload :LinearGradient, 'uniword/drawingml/linear_gradient'
+    autoload :PathGradient, 'uniword/drawingml/path_gradient'
+    autoload :FillToRect, 'uniword/drawingml/fill_to_rect'
+    autoload :TileRect, 'uniword/drawingml/tile_rect'
+    autoload :PatternFill, 'uniword/drawingml/pattern_fill'
+    autoload :ForegroundColor, 'uniword/drawingml/foreground_color'
+    autoload :BackgroundColor, 'uniword/drawingml/background_color'
+
+    # Effects (15)
+    autoload :EffectList, 'uniword/drawingml/effect_list'
+    autoload :EffectContainer, 'uniword/drawingml/effect_container'
+    autoload :Glow, 'uniword/drawingml/glow'
+    autoload :InnerShadow, 'uniword/drawingml/inner_shadow'
+    autoload :OuterShadow, 'uniword/drawingml/outer_shadow'
+    autoload :PresetShadow, 'uniword/drawingml/preset_shadow'
+    autoload :Reflection, 'uniword/drawingml/reflection'
+    autoload :SoftEdge, 'uniword/drawingml/soft_edge'
+    autoload :Blur, 'uniword/drawingml/blur'
+    autoload :FillOverlay, 'uniword/drawingml/fill_overlay'
+    autoload :Duotone, 'uniword/drawingml/duotone'
+    autoload :AlphaBiLevel, 'uniword/drawingml/alpha_bi_level'
+    autoload :AlphaModulationFixed, 'uniword/drawingml/alpha_modulation_fixed'
+    autoload :BiLevel, 'uniword/drawingml/bi_level'
+    autoload :Grayscale, 'uniword/drawingml/grayscale'
+
+    # Color Transforms (21)
+    autoload :Alpha, 'uniword/drawingml/alpha'
+    autoload :AlphaOffset, 'uniword/drawingml/alpha_offset'
+    autoload :AlphaModulation, 'uniword/drawingml/alpha_modulation'
+    autoload :Hue, 'uniword/drawingml/hue'
+    autoload :HueOffset, 'uniword/drawingml/hue_offset'
+    autoload :HueModulation, 'uniword/drawingml/hue_modulation'
+    autoload :Saturation, 'uniword/drawingml/saturation'
+    autoload :SaturationOffset, 'uniword/drawingml/saturation_offset'
+    autoload :SaturationModulation, 'uniword/drawingml/saturation_modulation'
+    autoload :Luminance, 'uniword/drawingml/luminance'
+    autoload :LuminanceOffset, 'uniword/drawingml/luminance_offset'
+    autoload :LuminanceModulation, 'uniword/drawingml/luminance_modulation'
+    autoload :Red, 'uniword/drawingml/red'
+    autoload :RedOffset, 'uniword/drawingml/red_offset'
+    autoload :RedModulation, 'uniword/drawingml/red_modulation'
+    autoload :Green, 'uniword/drawingml/green'
+    autoload :Blue, 'uniword/drawingml/blue'
+    autoload :Gamma, 'uniword/drawingml/gamma'
+    autoload :InverseGamma, 'uniword/drawingml/inverse_gamma'
+    autoload :Tint, 'uniword/drawingml/tint'
+    autoload :Shade, 'uniword/drawingml/shade'
+
+    # Shapes & Geometry (9)
+    autoload :PresetGeometry, 'uniword/drawingml/preset_geometry'
+    autoload :CustomGeometry, 'uniword/drawingml/custom_geometry'
+    autoload :AdjustValueList, 'uniword/drawingml/adjust_value_list'
+    autoload :GeometryGuide, 'uniword/drawingml/geometry_guide'
+    autoload :PathList, 'uniword/drawingml/path_list'
+    autoload :MoveTo, 'uniword/drawingml/move_to'
+    autoload :LineTo, 'uniword/drawingml/line_to'
+    autoload :ArcTo, 'uniword/drawingml/arc_to'
+    autoload :ClosePath, 'uniword/drawingml/close_path'
+
+    # 3D Properties (6)
+    autoload :Rotation, 'uniword/drawingml/rotation'
+    autoload :Camera, 'uniword/drawingml/camera'
+    autoload :LightRig, 'uniword/drawingml/light_rig'
+    autoload :Scene3D, 'uniword/drawingml/scene_3d'
+    autoload :Shape3D, 'uniword/drawingml/shape_3d'
+    autoload :BevelTop, 'uniword/drawingml/bevel_top'
+
+    # GVML classes (16)
+    autoload :Gvml, 'uniword/drawingml/gvml'
+    autoload :GvmlUseShapeRectangle, 'uniword/drawingml/gvml_use_shape_rectangle'
+    autoload :GvmlTextShape, 'uniword/drawingml/gvml_text_shape'
+    autoload :GvmlShapeNonVisual, 'uniword/drawingml/gvml_shape_non_visual'
+    autoload :GvmlShape, 'uniword/drawingml/gvml_shape'
+    autoload :GvmlConnectorNonVisual, 'uniword/drawingml/gvml_connector_non_visual'
+    autoload :GvmlConnector, 'uniword/drawingml/gvml_connector'
+    autoload :GvmlPictureNonVisual, 'uniword/drawingml/gvml_picture_non_visual'
+    autoload :GvmlPicture, 'uniword/drawingml/gvml_picture'
+    autoload :GvmlGraphicFrameNonVisual, 'uniword/drawingml/gvml_graphic_frame_non_visual'
+    autoload :GvmlGraphicalObjectFrame, 'uniword/drawingml/gvml_graphical_object_frame'
+    autoload :GvmlGroupShapeNonVisual, 'uniword/drawingml/gvml_group_shape_non_visual'
+    autoload :GvmlGroupShape, 'uniword/drawingml/gvml_group_shape'
+
+    # Supporting types (9)
+    autoload :NonVisualConnectorProperties, 'uniword/drawingml/non_visual_connector_properties'
+    autoload :NonVisualGraphicFrameProperties,
+             'uniword/drawingml/non_visual_graphic_frame_properties'
+    autoload :NonVisualGroupDrawingShapeProperties,
+             'uniword/drawingml/non_visual_group_drawing_shape_properties'
+    autoload :NonVisualPictureProperties, 'uniword/drawingml/non_visual_picture_properties'
+    autoload :GroupShapeProperties, 'uniword/drawingml/group_shape_properties'
+    autoload :OfficeArtExtension, 'uniword/drawingml/office_art_extension'
+    autoload :OfficeArtExtensionList, 'uniword/drawingml/office_art_extension_list'
+    autoload :PictureLocking, 'uniword/drawingml/picture_locking'
+    autoload :GroupLocking, 'uniword/drawingml/group_locking'
+    autoload :Theme, 'uniword/drawingml/theme'
+    autoload :ThemeElements, 'uniword/drawingml/theme'
+    autoload :ColorScheme, 'uniword/drawingml/color_scheme'
+    autoload :FontScheme, 'uniword/drawingml/font_scheme'
+    autoload :FormatScheme, 'uniword/drawingml/format_scheme'
+    autoload :FillStyleList, 'uniword/drawingml/format_scheme'
+    autoload :LineStyleList, 'uniword/drawingml/format_scheme'
+    autoload :EffectStyleList, 'uniword/drawingml/format_scheme'
+    autoload :EffectStyle, 'uniword/drawingml/format_scheme'
+    autoload :BackgroundFillStyleList, 'uniword/drawingml/format_scheme'
+    autoload :ObjectDefaults, 'uniword/drawingml/object_defaults'
+    autoload :ShapeDefaults, 'uniword/drawingml/shape_defaults'
+    autoload :TextDefaults, 'uniword/drawingml/text_defaults'
+    autoload :ExtensionList, 'uniword/drawingml/extension_list'
+    autoload :Extension, 'uniword/drawingml/extension'
+    autoload :ExtraColorSchemeList, 'uniword/drawingml/extra_color_scheme_list'
+  end
+end

data/lib/uniword/element.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+module Uniword
+  # Base class for all OOXML element classes.
+  #
+  # In v2.0 architecture, all elements inherit from Lutaml::Model::Serializable
+  # for XML serialization. This base class provides common functionality and
+  # serves as a common ancestor for all Uniword elements.
+  #
+  # @example Creating a custom element
+  #   class MyElement < Uniword::Element
+  #     attribute :name, :string
+  #
+  #     xml do
+  #       element 'myElement'
+  #       namespace 'http://example.com/ns'
+  #       map_attribute 'name', to: :name
+  #     end
+  #   end
+  class Element < Lutaml::Model::Serializable
+    # Common ID attribute for all elements
+    attribute :id, :string
+
+    # Allow elements to track if they're abstract (for visitor pattern)
+    class << self
+      def abstract?
+        @abstract || false
+      end
+
+      def abstract!
+        @abstract = true
+      end
+    end
+
+    # Accept method for visitor pattern
+    # Subclasses should override this method
+    def accept(visitor)
+      visitor.visit_element(self)
+    end
+
+    # Default validation - returns true
+    # Subclasses can override for custom validation
+    def valid?
+      true
+    end
+  end
+
+  # Mark Element as abstract base class
+  Element.abstract!
+end

data/lib/uniword/element_registry.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Uniword
+  # Registry for all element classes
+  # Responsibility: Maintain a registry of element classes and provide factory methods
+  #
+  # This class follows the Registry pattern to enable:
+  # - Automatic registration of element classes via Element.inherited
+  # - Runtime element discovery
+  # - Factory method for creating elements by tag/type
+  class ElementRegistry
+    class << self
+      # Register an element class
+      #
+      # @param element_class [Class] The element class to register
+      # @return [void]
+      def register(element_class)
+        return if element_class.respond_to?(:abstract?) && element_class.abstract?
+
+        key = element_class_key(element_class)
+        return if key.nil? # Skip anonymous classes
+
+        registry[key] = element_class
+      end
+
+      # Create an element instance by tag name
+      #
+      # @param tag [String, Symbol] The element tag/type name
+      # @param attributes [Hash] Attributes to initialize the element with
+      # @return [Element, nil] The created element instance or nil if not found
+      def create(tag, attributes = {})
+        element_class = find(tag)
+        return nil unless element_class
+
+        element_class.new(attributes)
+      end
+
+      # Find an element class by tag name
+      #
+      # @param tag [String, Symbol] The element tag/type name
+      # @return [Class, nil] The element class or nil if not found
+      def find(tag)
+        registry[normalize_key(tag)]
+      end
+
+      # Get all registered element classes
+      #
+      # @return [Array<Class>] Array of registered element classes
+      def all
+        registry.values
+      end
+
+      # Get all registered tag names
+      #
+      # @return [Array<String>] Array of registered tag names
+      def tags
+        registry.keys
+      end
+
+      # Check if a tag is registered
+      #
+      # @param tag [String, Symbol] The element tag/type name
+      # @return [Boolean] true if registered, false otherwise
+      def registered?(tag)
+        registry.key?(normalize_key(tag))
+      end
+
+      # Clear the registry (primarily for testing)
+      #
+      # @return [void]
+      def clear
+        registry.clear
+      end
+
+      # Get the number of registered elements
+      #
+      # @return [Integer] Number of registered elements
+      def count
+        registry.size
+      end
+
+      private
+
+      # Get the registry hash
+      #
+      # @return [Hash<String, Class>] The registry hash
+      def registry
+        @registry ||= {}
+      end
+
+      # Generate a registry key from an element class
+      #
+      # @param element_class [Class] The element class
+      # @return [String, nil] The registry key or nil for anonymous classes
+      def element_class_key(element_class)
+        class_name = element_class.name
+        return nil if class_name.nil? # Anonymous class
+
+        normalize_key(class_name.split('::').last)
+      end
+
+      # Normalize a tag name to a registry key
+      #
+      # @param tag [String, Symbol] The tag name
+      # @return [String] The normalized key
+      def normalize_key(tag)
+        tag.to_s.downcase
+      end
+    end
+  end
+end

data/lib/uniword/endnote.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Uniword
+  # Represents an endnote in a document.
+  #
+  # Responsibility: Store endnote content and metadata. Endnotes appear
+  # at the end of the document or section, unlike footnotes which appear
+  # at the bottom of each page.
+  #
+  # An endnote consists of:
+  # - An ID that uniquely identifies it
+  # - Content (array of paragraphs)
+  #
+  # @example Create an endnote
+  #   endnote = Uniword::Endnote.new(
+  #     id: 1,
+  #     content: [paragraph1, paragraph2]
+  #   )
+  #
+  # @example Access endnote properties
+  #   endnote.id       # => 1
+  #   endnote.content  # => [paragraph1, paragraph2]
+  class Endnote
+    # @return [Integer, String] The unique identifier for this endnote
+    attr_accessor :id
+
+    # @return [Array<Paragraph>] The content paragraphs of the endnote
+    attr_accessor :content
+
+    # Initialize a new Endnote.
+    #
+    # @param id [Integer, String] The unique identifier
+    # @param content [Array<Paragraph>] The endnote content paragraphs
+    #
+    # @example Create an endnote
+    #   endnote = Endnote.new(id: 1, content: [paragraph])
+    def initialize(id:, content: [])
+      @id = id
+      @content = content
+    end
+
+    # Check if endnote has content.
+    #
+    # @return [Boolean] true if endnote has content
+    def content?
+      !@content.nil? && !@content.empty?
+    end
+
+    # Get text content of endnote.
+    #
+    # @return [String] The combined text of all paragraphs
+    def text
+      @content.map { |p| p.respond_to?(:text) ? p.text : p.to_s }.join("\n")
+    end
+
+    # Convert to hash representation.
+    #
+    # @return [Hash] Hash representation of the endnote
+    def to_h
+      {
+        id: @id,
+        content: @content
+      }
+    end
+  end
+end

data/lib/uniword/errors.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Uniword
+  # Base error class for all Uniword errors
+  class Error < StandardError; end
+
+  # Raised when a file is not found
+  class FileNotFoundError < Error
+    # @param path [String] The file path that was not found
+    def initialize(path)
+      super("File not found: #{path}")
+      @path = path
+    end
+
+    # @return [String] The file path
+    attr_reader :path
+  end
+
+  # Raised when a file format is invalid or unsupported
+  class InvalidFormatError < Error
+    # @param path [String] The file path
+    # @param format [Symbol, String] The invalid format
+    def initialize(path, format)
+      super("Invalid or unsupported format '#{format}' for file: #{path}")
+      @path = path
+      @format = format
+    end
+
+    # @return [String] The file path
+    attr_reader :path
+
+    # @return [Symbol, String] The format
+    attr_reader :format
+  end
+
+  # Raised when a file is corrupted or malformed
+  class CorruptedFileError < Error
+    # @param path [String] The file path
+    # @param reason [String] The reason for corruption
+    def initialize(path, reason)
+      super("Corrupted file #{path}: #{reason}")
+      @path = path
+      @reason = reason
+    end
+
+    # @return [String] The file path
+    attr_reader :path
+
+    # @return [String] The reason
+    attr_reader :reason
+  end
+
+  # Raised when element validation fails
+  class ValidationError < Error
+    # @param element [Element] The element that failed validation
+    # @param errors [Array<String>] Array of validation error messages
+    def initialize(element, errors)
+      element_name = element.class.name.split('::').last
+      super("Validation failed for #{element_name}: #{errors.join(', ')}")
+      @element = element
+      @errors = errors
+    end
+
+    # @return [Element] The element that failed
+    attr_reader :element
+
+    # @return [Array<String>] The validation errors
+    attr_reader :errors
+  end
+
+  # Raised when trying to write to a read-only document
+  class ReadOnlyError < Error
+    # @param operation [String] The operation that was attempted
+    def initialize(operation)
+      super("Cannot perform '#{operation}' on read-only document")
+      @operation = operation
+    end
+
+    # @return [String] The operation
+    attr_reader :operation
+  end
+
+  # Raised when a required dependency is missing
+  class DependencyError < Error
+    # @param gem_name [String] The name of the missing gem
+    # @param feature [String] The feature that requires it
+    def initialize(gem_name, feature)
+      super("Missing dependency '#{gem_name}' required for #{feature}. Install with: gem install #{gem_name}")
+      @gem_name = gem_name
+      @feature = feature
+    end
+
+    # @return [String] The gem name
+    attr_reader :gem_name
+
+    # @return [String] The feature
+    attr_reader :feature
+  end
+
+  # Raised when an unsupported operation is attempted
+  class UnsupportedOperationError < Error
+    # @param operation [String] The unsupported operation
+    # @param context [String] Additional context
+    def initialize(operation, context = nil)
+      message = "Unsupported operation: #{operation}"
+      message += " (#{context})" if context
+      super(message)
+      @operation = operation
+      @context = context
+    end
+
+    # @return [String] The operation
+    attr_reader :operation
+
+    # @return [String, nil] The context
+    attr_reader :context
+  end
+
+  # Raised when a conversion between formats fails
+  class ConversionError < Error
+    # @param from_format [Symbol] The source format
+    # @param to_format [Symbol] The target format
+    # @param reason [String] The reason for failure
+    def initialize(from_format, to_format, reason)
+      super("Cannot convert from #{from_format} to #{to_format}: #{reason}")
+      @from_format = from_format
+      @to_format = to_format
+      @reason = reason
+    end
+
+    # @return [Symbol] The source format
+    attr_reader :from_format
+
+    # @return [Symbol] The target format
+    attr_reader :to_format
+
+    # @return [String] The reason
+    attr_reader :reason
+  end
+end

data/lib/uniword/field.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+module Uniword
+  # Represents a field (dynamic content like page numbers, dates, etc.)
+  # Fields can be simple or complex
+  class Field < Lutaml::Model::Serializable
+    attribute :type, :string
+    attribute :instruction, :string
+    attribute :value, :string
+    attribute :simple, :boolean, default: -> { true }
+
+    # Common field types
+    TYPES = {
+      page: 'PAGE',
+      numpages: 'NUMPAGES',
+      date: 'DATE',
+      time: 'TIME',
+      seq: 'SEQ',
+      ref: 'REF',
+      hyperlink: 'HYPERLINK'
+    }.freeze
+
+    # Create a page number field
+    def self.page_number(format: 'ARABIC')
+      new(
+        type: 'PAGE',
+        instruction: " PAGE \\* #{format} ",
+        simple: true
+      )
+    end
+
+    # Create a total pages field
+    def self.total_pages(format: 'ARABIC')
+      new(
+        type: 'NUMPAGES',
+        instruction: " NUMPAGES \\* #{format} ",
+        simple: true
+      )
+    end
+
+    # Create a date field
+    def self.date(format: 'M/d/yyyy')
+      new(
+        type: 'DATE',
+        instruction: " DATE \\@ \"#{format}\" ",
+        simple: true
+      )
+    end
+
+    # Create a sequence field (for captions)
+    def self.sequence(label, format: 'ARABIC')
+      new(
+        type: 'SEQ',
+        instruction: " SEQ #{label} \\* #{format} ",
+        simple: false
+      )
+    end
+
+    # Create a caption field
+    def self.caption(label: 'Figure', format: 'ARABIC')
+      sequence(label, format: format)
+    end
+
+    # Check if this is a simple field
+    def simple?
+      simple
+    end
+
+    # Check if this is a complex field
+    def complex?
+      !simple
+    end
+  end
+end