docx 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96b871b0d07fecde4e6c93c67463da727565f3acca519b08b9c554d987570e58
-  data.tar.gz: 2f3b9362b91c33d02e6c1b4acf0b23fb723f71d26f9b2e800b930c91c3687eee
+  metadata.gz: 38d8b4c53502b022e87a0b00ac8b15c99c06d79c2a51e664364ddd52dcca52a7
+  data.tar.gz: e7a747b4ef58b53e279fdd0cfc516b06ab5c14820e622938bea4ec73858f637c
 SHA512:
-  metadata.gz: 5e198cb74eb7a06b62bb63a3a0ff065b0c95cf26aafb53320bb5b14339dc386d975a1f57178316d1d5d7753081e07989b4498bcdfa3f0092f2fc14b1e4086b84
-  data.tar.gz: d0626b7332fd3a3d95b6358a3fb6ea09b0faf58545db9bd948c9f97baa5457eacb43267cc40914df2fa54872b42cca5c1963f66111a8b0b4be33a3e6f99c4b38
+  metadata.gz: f4db62333498540c5ff8ea488828d17c05629c0477fd917bd9106a061d987f368e02a16d4fe566b93c456a5b1920fe1aa5dfe3c39aa3d68682a99e83087c4f25
+  data.tar.gz: 12864372c581d4fb4cd7f4330b49b4aa115061dfef5b8bc9ff603adaea6a0766b6e1475ae402eef473ce7636352e8b68657be59bc18cd048d85e2314d523f416

data/README.md

@@ -11,7 +11,7 @@ A ruby library/gem for interacting with `.docx` files. currently capabilities in
 
 ### Prerequisites
 
-- Ruby 2.5 or later
+- Ruby 2.6 or later
 
 ### Install
 
@@ -181,6 +181,78 @@ p_children = p_element.xpath("//child::*") # selects all children
 p_child = p_element.at_xpath("//child::*") # selects first child
 ```
 
+### Writing and Manipulating Styles
+``` ruby
+require 'docx'
+
+d = Docx::Document.open('example.docx')
+existing_style = d.styles_configuration.style_of("Heading 1")
+existing_style.font_color = "000000"
+
+# see attributes below
+new_style = d.styles_configuration.add_style("Red", name: "Red", font_color: "FF0000", font_size: 20)
+new_style.bold = true
+
+d.paragraphs.each do |p|
+  p.style = "Red"
+end
+
+d.paragraphs.each do |p|
+  p.style = "Heading 1"
+end
+
+d.styles_configuration.remove_style("Red")
+```
+
+#### Style Attributes
+
+The following is a list of attributes and what they control within the style.
+
+- **id**: The unique identifier of the style. (required)
+- **name**: The human-readable name of the style. (required)
+- **type**: Indicates the type of the style (e.g., paragraph, character).
+- **keep_next**: Boolean value controlling whether to keep a paragraph and the next one on the same page. Valid values: `true`/`false`.
+- **keep_lines**: Boolean value specifying whether to keep all lines of a paragraph together on one page. Valid values: `true`/`false`.
+- **page_break_before**: Boolean value indicating whether to insert a page break before the paragraph. Valid values: `true`/`false`.
+- **widow_control**: Boolean value controlling widow and orphan lines in a paragraph. Valid values: `true`/`false`.
+- **shading_style**: Defines the shading pattern style.
+- **shading_color**: Specifies the color of the shading pattern. Valid values: Hex color codes.
+-  **shading_fill**: Indicates the background fill color of shading.
+-  **suppress_auto_hyphens**: Boolean value controlling automatic hyphenation. Valid values: `true`/`false`.
+-  **bidirectional_text**: Boolean value indicating if the paragraph contains bidirectional text. Valid values: `true`/`false`.
+-  **spacing_before**: Defines the spacing before a paragraph.
+-  **spacing_after**: Specifies the spacing after a paragraph.
+-  **line_spacing**: Indicates the line spacing of a paragraph.
+-  **line_rule**: Defines how line spacing is calculated.
+-  **indent_left**: Sets the left indentation of a paragraph.
+-  **indent_right**: Specifies the right indentation of a paragraph.
+-  **indent_first_line**: Indicates the first line indentation of a paragraph.
+-  **align**: Controls the text alignment within a paragraph.
+-  **font**: Sets the font for different scripts (ASCII, complex script, East Asian, etc.).
+-  **font_ascii**: Specifies the font for ASCII characters.
+-  **font_cs**: Indicates the font for complex script characters.
+-  **font_hAnsi**: Sets the font for high ANSI characters.
+-  **font_eastAsia**: Specifies the font for East Asian characters.
+-  **bold**: Boolean value controlling bold formatting. Valid values: `true`/`false`.
+-  **italic**: Boolean value indicating italic formatting. Valid values: `true`/`false`.
+-  **caps**: Boolean value controlling capitalization. Valid values: `true`/`false`.
+-  **small_caps**: Boolean value specifying small capital letters. Valid values: `true`/`false`.
+-  **strike**: Boolean value indicating strikethrough formatting. Valid values: `true`/`false`.
+-  **double_strike**: Boolean value defining double strikethrough formatting. Valid values: `true`/`false`.
+-  **outline**: Boolean value specifying outline effects. Valid values: `true`/`false`.
+-  **outline_level**: Indicates the outline level in a document's hierarchy.
+-  **font_color**: Sets the text color. Valid values: Hex color codes.
+-  **font_size**: Controls the font size.
+-  **font_size_cs**: Specifies the font size for complex script characters.
+-  **underline_style**: Indicates the style of underlining.
+-  **underline_color**: Specifies the color of the underline. Valid values: Hex color codes.
+-  **spacing**: Controls character spacing.
+-  **kerning**: Sets the space between characters.
+-  **position**: Controls the position of characters (superscript/subscript).
+-  **text_fill_color**: Sets the fill color of text. Valid values: Hex color codes.
+-  **vertical_alignment**: Controls the vertical alignment of text within a line.
+-  **lang**: Specifies the language tag for the text.
+
 ## Development
 
 ### todo
@@ -188,5 +260,4 @@ p_child = p_element.at_xpath("//child::*") # selects first child
 * Calculate element formatting based on values present in element properties as well as properties inherited from parents
 * Default formatting of inserted elements to inherited values
 * Implement formattable elements.
-* Implement styles.
 * Easier multi-line text insertion at a single bookmark (inserting paragraph nodes after the one containing the bookmark)

data/lib/docx/containers/container.rb

@@ -7,12 +7,12 @@ module Docx
         # Relation methods
         # TODO: Create a properties object, include Element
         def properties
-          @node.at_xpath("./#{@properties_tag}")
+          @node.at_xpath("./w:#{@properties_tag}")
         end
 
         # Erase text within an element
         def blank!
-          @node.xpath(".//w:t").each {|t| t.content = '' }
+          @node.xpath('.//w:t').each { |t| t.content = '' }
         end
 
         def remove!

data/lib/docx/containers/paragraph.rb

@@ -15,11 +15,12 @@ module Docx
 
         # Child elements: pPr, r, fldSimple, hlink, subDoc
         # http://msdn.microsoft.com/en-us/library/office/ee364458(v=office.11).aspx
-        def initialize(node, document_properties = {})
+        def initialize(node, document_properties = {}, doc = nil)
           @node = node
           @properties_tag = 'pPr'
           @document_properties = document_properties
           @font_size = @document_properties[:font_size]
+          @document = doc
         end
 
         # Set text of paragraph
@@ -48,6 +49,7 @@ module Docx
             html << text_run.to_html
           end
           styles = { 'font-size' => "#{font_size}pt" }
+          styles['color'] = "##{font_color}" if font_color
           styles['text-align'] = alignment if alignment
           html_tag(:p, content: html, styles: styles)
         end
@@ -76,20 +78,48 @@ module Docx
         end
 
         def font_size
-          size_tag = @node.xpath('w:pPr//w:sz').first
-          size_tag ? size_tag.attributes['val'].value.to_i / 2 : @font_size
+          size_attribute = @node.at_xpath('w:pPr//w:sz//@w:val')
+
+          return @font_size unless size_attribute
+
+          size_attribute.value.to_i / 2
+        end
+
+        def font_color
+          color_tag = @node.xpath('w:r//w:rPr//w:color').first
+          color_tag ? color_tag.attributes['val'].value : nil
+        end
+
+        def style
+          return nil unless @document
+
+          @document.style_name_of(style_id) ||
+            @document.default_paragraph_style
+        end
+
+        def style_id
+          style_property.get_attribute('w:val')
+        end
+
+        def style=(identifier)
+          id = @document.styles_configuration.style_of(identifier).id
+
+          style_property.set_attribute('w:val', id)
         end
-        
+
+        alias_method :style_id=, :style=
         alias_method :text, :to_s
 
         private
 
+        def style_property
+          properties&.at_xpath('w:pStyle') || properties&.add_child('<w:pStyle/>').first
+        end
+
         # Returns the alignment if any, or nil if left
         def alignment
-          alignment_tag = @node.xpath('.//w:jc').first
-          alignment_tag ? alignment_tag.attributes['val'].value : nil
+          @node.at_xpath('.//w:jc/@w:val')&.value
         end
-
       end
     end
   end

data/lib/docx/containers/styles_configuration.rb

@@ -0,0 +1,52 @@
+require 'docx/containers/container'
+require 'docx/elements/style'
+
+module Docx
+  module Elements
+    module Containers
+      StyleNotFound = Class.new(StandardError)
+
+      class StylesConfiguration
+        def initialize(raw_styles)
+          @raw_styles = raw_styles
+          @styles_parent_node = raw_styles.root
+        end
+
+        attr_reader :styles, :styles_parent_node
+
+        def styles
+          styles_parent_node
+            .children
+            .filter_map do |style|
+              next unless style.get_attribute("w:styleId")
+
+              Elements::Style.new(self, style)
+            end
+        end
+
+        def style_of(id_or_name)
+          styles.find { |style| style.id == id_or_name || style.name == id_or_name } || raise(Errors::StyleNotFound, "Style name or id '#{id_or_name}' not found")
+        end
+
+        def size
+          styles.size
+        end
+
+        def add_style(id, attributes = {})
+          Elements::Style.create(self, {id: id, name: id}.merge(attributes))
+        end
+
+        def remove_style(id)
+          style = styles.find { |style| style.id == id }
+
+          style.node.remove
+          styles.delete(style)
+        end
+
+        def serialize(**options)
+          @raw_styles.serialize(**options)
+        end
+      end
+    end
+  end
+end

data/lib/docx/containers/text_run.rb

@@ -10,7 +10,8 @@ module Docx
         DEFAULT_FORMATTING = {
           italic:    false,
           bold:      false,
-          underline: false
+          underline: false,
+          strike: false
         }
 
         def self.tag
@@ -60,7 +61,8 @@ module Docx
           {
             italic:    !@node.xpath('.//w:i').empty?,
             bold:      !@node.xpath('.//w:b').empty?,
-            underline: !@node.xpath('.//w:u').empty?
+            underline: !@node.xpath('.//w:u').empty?,
+            strike: !@node.xpath('.//w:strike').empty?
           }
         end
 
@@ -73,6 +75,7 @@ module Docx
           html = @text
           html = html_tag(:em, content: html) if italicized?
           html = html_tag(:strong, content: html) if bolded?
+          html = html_tag(:s, content: html) if striked?
           styles = {}
           styles['text-decoration'] = 'underline' if underlined?
           # No need to be granular with font size down to the span level if it doesn't vary.
@@ -90,12 +93,20 @@ module Docx
           @formatting[:bold]
         end
 
+        def striked?
+          @formatting[:strike]
+        end
+
         def underlined?
           @formatting[:underline]
         end
 
         def hyperlink?
-          @node.name == 'hyperlink'
+          @node.name == 'hyperlink' && external_link?
+        end
+
+        def external_link?
+          !@node.attributes['id'].nil?
         end
 
         def href
@@ -107,8 +118,11 @@ module Docx
         end
 
         def font_size
-          size_tag = @node.xpath('w:rPr//w:sz').first
-          size_tag ? size_tag.attributes['val'].value.to_i / 2 : @font_size
+          size_attribute = @node.at_xpath('w:rPr//w:sz//@w:val')
+
+          return @font_size unless size_attribute
+
+          size_attribute.value.to_i / 2
         end
 
         private

data/lib/docx/containers.rb

@@ -2,3 +2,4 @@ require 'docx/containers/container'
 require 'docx/containers/text_run'
 require 'docx/containers/paragraph'
 require 'docx/containers/table'
+require 'docx/containers/styles_configuration'

data/lib/docx/document.rb

@@ -1,5 +1,7 @@
 require 'docx/containers'
 require 'docx/elements'
+require 'docx/errors'
+require 'docx/helpers'
 require 'nokogiri'
 require 'zip'
 
@@ -18,6 +20,8 @@ module Docx
   #     puts d.text
   #   end
   class Document
+    include Docx::SimpleInspect
+
     attr_reader :xml, :doc, :zip, :styles
 
     def initialize(path_or_io, options = {})
@@ -25,6 +29,7 @@ module Docx
 
       # if path-or_io is string && does not contain a null byte
       if (path_or_io.instance_of?(String) && !/\u0000/.match?(path_or_io))
+        raise Errno::EIO.new('Invalid file format') if !File.extname(path_or_io).eql?('.docx')
         @zip = Zip::File.open(path_or_io)
       else
         @zip = Zip::File.open_buffer(path_or_io)
@@ -38,7 +43,7 @@ module Docx
       load_styles
       yield(self) if block_given?
     ensure
-      @zip.close
+      @zip.close unless @zip.nil?
     end
 
     # This stores the current global document properties, for now
@@ -81,10 +86,11 @@ module Docx
     # Some documents have this set, others don't.
     # Values are returned as half-points, so to get points, that's why it's divided by 2.
     def font_size
-      return nil unless @styles
+      size_value = @styles&.at_xpath('//w:docDefaults//w:rPrDefault//w:rPr//w:sz/@w:val')&.value
+
+      return nil unless size_value
 
-      size_tag = @styles.xpath('//w:docDefaults//w:rPrDefault//w:rPr//w:sz').first
-      size_tag ? size_tag.attributes['val'].value.to_i / 2 : nil
+      size_value.to_i / 2
     end
 
     # Hyperlink targets are extracted from the document.xml.rels file
@@ -129,13 +135,11 @@ module Docx
           next unless entry.file?
 
           out.put_next_entry(entry.name)
+          value = @replace[entry.name] || zip.read(entry.name)
 
-          if @replace[entry.name]
-            out.write(@replace[entry.name])
-          else
-            out.write(zip.read(entry.name))
-          end
+          out.write(value)
         end
+
       end
       zip.close
     end
@@ -167,6 +171,18 @@ module Docx
       @replace[entry_path] = file_contents
     end
 
+    def default_paragraph_style
+      @styles.at_xpath("w:styles/w:style[@w:type='paragraph' and @w:default='1']/w:name/@w:val").value
+    end
+
+    def style_name_of(style_id)
+      styles_configuration.style_of(style_id).name
+    end
+
+    def styles_configuration
+      @styles_configuration ||= Elements::Containers::StylesConfiguration.new(@styles.dup)
+    end
+
     private
 
     def load_styles
@@ -193,11 +209,12 @@ module Docx
     #++
     def update
       replace_entry 'word/document.xml', doc.serialize(save_with: 0)
+      replace_entry 'word/styles.xml', styles_configuration.serialize(save_with: 0)
     end
 
     # generate Elements::Containers::Paragraph from paragraph XML node
     def parse_paragraph_from(p_node)
-      Elements::Containers::Paragraph.new(p_node, document_properties)
+      Elements::Containers::Paragraph.new(p_node, document_properties, self)
     end
 
     # generate Elements::Bookmark from bookmark XML node

data/lib/docx/elements/element.rb

@@ -14,13 +14,20 @@ module Docx
       end
 
       attr_accessor :node
-      delegate :at_xpath, :xpath, :to => :@node
 
       # TODO: Should create a docx object from this
       def parent(type = '*')
         @node.at_xpath("./parent::#{type}")
       end
 
+      def at_xpath(*args)
+        @node.at_xpath(*args)
+      end
+
+      def xpath(*args)
+        @node.xpath(*args)
+      end
+
       # Get parent paragraph of element
       def parent_paragraph
         Elements::Containers::Paragraph.new(parent('w:p'))
@@ -102,4 +109,4 @@ module Docx
       end
     end
   end
-end
+end

data/lib/docx/elements/style/converters.rb

@@ -0,0 +1,37 @@
+module Docx
+  module Elements
+    class Style
+      module Converters
+        class DefaultValueConverter
+          def self.encode(value)
+            value
+          end
+
+          def self.decode(value)
+            value
+          end
+        end
+
+        class FontSizeConverter
+          def self.encode(value)
+            value.to_i * 2
+          end
+
+          def self.decode(value)
+            value.to_i / 2
+          end
+        end
+
+        class BooleanConverter
+          def self.encode(value)
+            value ? "1" : "0"
+          end
+
+          def self.decode(value)
+            value == "1"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docx/elements/style/validators.rb

@@ -0,0 +1,31 @@
+module Docx
+  module Elements
+    class Style
+      module Validators
+        class DefaultValidator
+          def self.validate(value)
+            true
+          end
+        end
+
+        class ColorValidator
+          COLOR_REGEX = /^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/
+
+          def self.validate(value)
+            value =~ COLOR_REGEX
+          end
+        end
+
+        class ValueValidator
+          def initialize(*values)
+            @values = values
+          end
+
+          def validate(value)
+            @values.include?(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docx/elements/style.rb

@@ -0,0 +1,179 @@
+require 'docx/helpers'
+require 'docx/elements'
+require 'docx/elements/style/converters'
+require 'docx/elements/style/validators'
+
+module Docx
+  module Elements
+    class Style
+      include Docx::SimpleInspect
+
+      class Attribute
+        attr_reader :name, :selectors, :required, :converter, :validator
+
+        def initialize(name, selectors, required: false, converter:, validator:)
+          @name = name
+          @selectors = selectors
+          @required = required
+          @converter = converter || Converters::DefaultValueConverter
+          @validator = validator || Validators::DefaultValidator
+        end
+
+        def required?
+          required
+        end
+
+        def retrieve_from(style)
+          selectors
+            .lazy
+            .filter_map { |node_xpath| style.node.at_xpath(node_xpath)&.value }
+            .map { |value| converter.decode(value) }
+            .first
+        end
+
+        def assign_to(style, value)
+          (required && value.nil?) &&
+            raise(Errors::StyleRequiredPropertyValue, "Required value #{name}")
+
+          validator.validate(value) ||
+            raise(Errors::StyleInvalidPropertyValue, "Invalid value for #{name}: '#{value.nil? ? "nil" : value}'")
+
+          encoded_value = converter.encode(value)
+
+          selectors.map do |attribute_xpath|
+            if (existing_attribute = style.node.at_xpath(attribute_xpath))
+              if encoded_value.nil?
+                existing_attribute.remove
+              else
+                existing_attribute.value = encoded_value.to_s
+              end
+
+              next encoded_value
+            end
+
+            next encoded_value if encoded_value.nil?
+
+            node_xpath, attribute = attribute_xpath.split("/@")
+
+            created_node =
+              node_xpath
+                .split("/")
+                .reduce(style.node) do |parent_node, child_xpath|
+                  # find the child node
+                  parent_node.at_xpath(child_xpath) ||
+                    # or create the child node
+                    Nokogiri::XML::Node.new(child_xpath, parent_node)
+                      .tap { |created_child_node| parent_node << created_child_node }
+                end
+
+            created_node.set_attribute(attribute, encoded_value)
+          end
+            .first
+        end
+      end
+
+      @attributes = []
+
+      class << self
+        attr_accessor :attributes
+
+        def required_attributes
+          attributes.select(&:required?)
+        end
+
+        def attribute(name, *selectors, required: false, converter: nil, validator: nil)
+          new_attribute = Attribute.new(name, selectors, required: required, converter: converter, validator: validator)
+          attributes << new_attribute
+
+          define_method(name) do
+            new_attribute.retrieve_from(self)
+          end
+
+          define_method("#{name}=") do |value|
+            new_attribute.assign_to(self, value)
+          end
+        end
+
+        def create(configuration, attributes = {})
+          node = Nokogiri::XML::Node.new("w:style", configuration.styles_parent_node)
+          configuration.styles_parent_node.add_child(node)
+
+          Elements::Style.new(configuration, node, **attributes)
+        end
+      end
+
+      def initialize(configuration, node, **attributes)
+        @configuration = configuration
+        @node = node
+
+        attributes.each do |name, value|
+          self.send("#{name}=", value)
+        end
+      end
+
+      attr_accessor :node
+
+      attribute :id, "./@w:styleId", required: true
+      attribute :name, "./w:name/@w:val", "./w:next/@w:val", required: true
+      attribute :type, ".//@w:type", required: true, validator: Validators::ValueValidator.new("paragraph", "character", "table", "numbering")
+      attribute :keep_next, "./w:pPr/w:keepNext/@w:val", converter: Converters::BooleanConverter
+      attribute :keep_lines, "./w:pPr/w:keepLines/@w:val", converter: Converters::BooleanConverter
+      attribute :page_break_before, "./w:pPr/w:pageBreakBefore/@w:val", converter: Converters::BooleanConverter
+      attribute :widow_control, "./w:pPr/w:widowControl/@w:val", converter: Converters::BooleanConverter
+      attribute :shading_style, "./w:pPr/w:shd/@w:val", "./w:rPr/w:shd/@w:val"
+      attribute :shading_color, "./w:pPr/w:shd/@w:color", "./w:rPr/w:shd/@w:color", validator: Validators::ColorValidator
+      attribute :shading_fill, "./w:pPr/w:shd/@w:fill", "./w:rPr/w:shd/@w:fill"
+      attribute :suppress_auto_hyphens, "./w:pPr/w:suppressAutoHyphens/@w:val", converter: Converters::BooleanConverter
+      attribute :bidirectional_text, "./w:pPr/w:bidi/@w:val", converter: Converters::BooleanConverter
+      attribute :spacing_before, "./w:pPr/w:spacing/@w:before"
+      attribute :spacing_after, "./w:pPr/w:spacing/@w:after"
+      attribute :line_spacing, "./w:pPr/w:spacing/@w:line"
+      attribute :line_rule, "./w:pPr/w:spacing/@w:lineRule"
+      attribute :indent_left, "./w:pPr/w:ind/@w:left"
+      attribute :indent_right, "./w:pPr/w:ind/@w:right"
+      attribute :indent_first_line, "./w:pPr/w:ind/@w:firstLine"
+      attribute :align, "./w:pPr/w:jc/@w:val"
+      attribute :font, "./w:rPr/w:rFonts/@w:ascii", "./w:rPr/w:rFonts/@w:cs", "./w:rPr/w:rFonts/@w:hAnsi", "./w:rPr/w:rFonts/@w:eastAsia" # setting :font, will set all other fonts
+      attribute :font_ascii, "./w:rPr/w:rFonts/@w:ascii"
+      attribute :font_cs, "./w:rPr/w:rFonts/@w:cs"
+      attribute :font_hAnsi, "./w:rPr/w:rFonts/@w:hAnsi"
+      attribute :font_eastAsia, "./w:rPr/w:rFonts/@w:eastAsia"
+      attribute :bold, "./w:rPr/w:b/@w:val", "./w:rPr/w:bCs/@w:val", converter: Converters::BooleanConverter
+      attribute :italic, "./w:rPr/w:i/@w:val", "./w:rPr/w:iCs/@w:val", converter: Converters::BooleanConverter
+      attribute :caps, "./w:rPr/w:caps/@w:val", converter: Converters::BooleanConverter
+      attribute :small_caps, "./w:rPr/w:smallCaps/@w:val", converter: Converters::BooleanConverter
+      attribute :strike, "./w:rPr/w:strike/@w:val", converter: Converters::BooleanConverter
+      attribute :double_strike, "./w:rPr/w:dstrike/@w:val", converter: Converters::BooleanConverter
+      attribute :outline, "./w:rPr/w:outline/@w:val", converter: Converters::BooleanConverter
+      attribute :outline_level, "./w:pPr/w:outlineLvl/@w:val"
+      attribute :font_color, "./w:rPr/w:color/@w:val", validator: Validators::ColorValidator
+      attribute :font_size, "./w:rPr/w:sz/@w:val", "./w:rPr/w:szCs/@w:val", converter: Converters::FontSizeConverter
+      attribute :font_size_cs, "./w:rPr/w:szCs/@w:val", converter: Converters::FontSizeConverter
+      attribute :underline_style, "./w:rPr/w:u/@w:val"
+      attribute :underline_color, "./w:rPr/w:u/@w:color", validator: Validators::ColorValidator
+      attribute :spacing, "./w:rPr/w:spacing/@w:val"
+      attribute :kerning, "./w:rPr/w:kern/@w:val"
+      attribute :position, "./w:rPr/w:position/@w:val"
+      attribute :text_fill_color, "./w:rPr/w14:textFill/w14:solidFill/w14:srgbClr/@w14:val", validator: Validators::ColorValidator
+      attribute :vertical_alignment, "./w:rPr/w:vertAlign/@w:val"
+      attribute :lang, "./w:rPr/w:lang/@w:val"
+
+      def valid?
+        self.class.required_attributes.all? do |a|
+          attribute_value = a.retrieve_from(self)
+
+          a.validator&.validate(attribute_value)
+        end
+      end
+
+      def to_xml
+        node.to_xml
+      end
+
+      def remove
+        node.remove
+        @configuration.styles.delete(self)
+      end
+    end
+  end
+end

data/lib/docx/elements/text.rb

@@ -2,16 +2,22 @@ module Docx
   module Elements
     class Text
       include Element
-      delegate :content, :content=, :to => :@node
 
       def self.tag
         't'
       end
 
+      def content
+        @node.content
+      end
+
+      def content=(args)
+        @node.content = args
+      end
 
       def initialize(node)
         @node = node
       end
     end
   end
-end
+end

data/lib/docx/elements.rb

@@ -1,3 +1,4 @@
 require 'docx/elements/bookmark'
 require 'docx/elements/element'
-require 'docx/elements/text'
+require 'docx/elements/text'
+require 'docx/elements/style'

data/lib/docx/errors.rb

@@ -0,0 +1,7 @@
+module Docx
+  module Errors
+    StyleNotFound = Class.new(StandardError)
+    StyleInvalidPropertyValue = Class.new(StandardError)
+    StyleRequiredPropertyValue = Class.new(StandardError)
+  end
+end

data/lib/docx/helpers.rb

@@ -0,0 +1,22 @@
+module Docx
+  module SimpleInspect
+    # Returns a string representation of the document that is far more readable and understandable
+    # than the default inspect method. But you can still get the default inspect method by passing
+    # true as the first argument.
+    def inspect(full = false)
+      return(super) if full
+
+      variable_values =
+        instance_variables.map do |var|
+          value = v = instance_variable_get(var).inspect
+
+          [
+            var,
+            value.length > 100 ? "#{value[0..100]}..." : value
+          ].join('=')
+        end
+
+      "#<#{self.class}:0x#{(object_id << 1).to_s(16)} #{variable_values.join(' ')}>"
+    end
+  end
+end

data/lib/docx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docx #:nodoc:
-  VERSION = '0.7.0'
+  VERSION = '0.9.0'
 end

data/lib/docx.rb

@@ -4,4 +4,3 @@ module Docx #:nodoc:
   autoload :Document, 'docx/document'
 end
 
-require 'docx/core_ext/module'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Christopher Hunt
@@ -9,10 +9,9 @@ authors:
 - Higgins Dragon
 - Toms Mikoss
 - Sebastian Wittenkamp
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2025-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -104,23 +103,27 @@ files:
 - lib/docx/containers.rb
 - lib/docx/containers/container.rb
 - lib/docx/containers/paragraph.rb
+- lib/docx/containers/styles_configuration.rb
 - lib/docx/containers/table.rb
 - lib/docx/containers/table_cell.rb
 - lib/docx/containers/table_column.rb
 - lib/docx/containers/table_row.rb
 - lib/docx/containers/text_run.rb
-- lib/docx/core_ext/module.rb
 - lib/docx/document.rb
 - lib/docx/elements.rb
 - lib/docx/elements/bookmark.rb
 - lib/docx/elements/element.rb
+- lib/docx/elements/style.rb
+- lib/docx/elements/style/converters.rb
+- lib/docx/elements/style/validators.rb
 - lib/docx/elements/text.rb
+- lib/docx/errors.rb
+- lib/docx/helpers.rb
 - lib/docx/version.rb
 homepage: https://github.com/chrahunt/docx
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +131,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: a ruby library/gem for interacting with .docx files
 test_files: []

data/lib/docx/core_ext/module.rb

@@ -1,172 +0,0 @@
-unless Object.const_defined?("ActiveSupport")
-  class Module
-    # Provides a delegate class method to easily expose contained objects' public methods
-    # as your own. Pass one or more methods (specified as symbols or strings)
-    # and the name of the target object via the <tt>:to</tt> option (also a symbol
-    # or string). At least one method and the <tt>:to</tt> option are required.
-    #
-    # Delegation is particularly useful with Active Record associations:
-    #
-    #   class Greeter < ActiveRecord::Base
-    #     def hello
-    #       'hello'
-    #     end
-    #
-    #     def goodbye
-    #       'goodbye'
-    #     end
-    #   end
-    #
-    #   class Foo < ActiveRecord::Base
-    #     belongs_to :greeter
-    #     delegate :hello, to: :greeter
-    #   end
-    #
-    #   Foo.new.hello   # => "hello"
-    #   Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c>
-    #
-    # Multiple delegates to the same target are allowed:
-    #
-    #   class Foo < ActiveRecord::Base
-    #     belongs_to :greeter
-    #     delegate :hello, :goodbye, to: :greeter
-    #   end
-    #
-    #   Foo.new.goodbye # => "goodbye"
-    #
-    # Methods can be delegated to instance variables, class variables, or constants
-    # by providing them as a symbols:
-    #
-    #   class Foo
-    #     CONSTANT_ARRAY = [0,1,2,3]
-    #     @@class_array  = [4,5,6,7]
-    #
-    #     def initialize
-    #       @instance_array = [8,9,10,11]
-    #     end
-    #     delegate :sum, to: :CONSTANT_ARRAY
-    #     delegate :min, to: :@@class_array
-    #     delegate :max, to: :@instance_array
-    #   end
-    #
-    #   Foo.new.sum # => 6
-    #   Foo.new.min # => 4
-    #   Foo.new.max # => 11
-    #
-    # It's also possible to delegate a method to the class by using +:class+:
-    #
-    #   class Foo
-    #     def self.hello
-    #       "world"
-    #     end
-    #
-    #     delegate :hello, to: :class
-    #   end
-    #
-    #   Foo.new.hello # => "world"
-    #
-    # Delegates can optionally be prefixed using the <tt>:prefix</tt> option. If the value
-    # is <tt>true</tt>, the delegate methods are prefixed with the name of the object being
-    # delegated to.
-    #
-    #   Person = Struct.new(:name, :address)
-    #
-    #   class Invoice < Struct.new(:client)
-    #     delegate :name, :address, to: :client, prefix: true
-    #   end
-    #
-    #   john_doe = Person.new('John Doe', 'Vimmersvej 13')
-    #   invoice = Invoice.new(john_doe)
-    #   invoice.client_name    # => "John Doe"
-    #   invoice.client_address # => "Vimmersvej 13"
-    #
-    # It is also possible to supply a custom prefix.
-    #
-    #   class Invoice < Struct.new(:client)
-    #     delegate :name, :address, to: :client, prefix: :customer
-    #   end
-    #
-    #   invoice = Invoice.new(john_doe)
-    #   invoice.customer_name    # => 'John Doe'
-    #   invoice.customer_address # => 'Vimmersvej 13'
-    #
-    # If the delegate object is +nil+ an exception is raised, and that happens
-    # no matter whether +nil+ responds to the delegated method. You can get a
-    # +nil+ instead with the +:allow_nil+ option.
-    #
-    #   class Foo
-    #     attr_accessor :bar
-    #     def initialize(bar = nil)
-    #       @bar = bar
-    #     end
-    #     delegate :zoo, to: :bar
-    #   end
-    #
-    #   Foo.new.zoo   # raises NoMethodError exception (you called nil.zoo)
-    #
-    #   class Foo
-    #     attr_accessor :bar
-    #     def initialize(bar = nil)
-    #       @bar = bar
-    #     end
-    #     delegate :zoo, to: :bar, allow_nil: true
-    #   end
-    #
-    #   Foo.new.zoo   # returns nil
-    def delegate(*methods)
-      options = methods.pop
-      unless options.is_a?(Hash) && to = options[:to]
-        raise ArgumentError, 'Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
-      end
-
-      prefix, allow_nil = options.values_at(:prefix, :allow_nil)
-
-      if prefix == true && to =~ /^[^a-z_]/
-        raise ArgumentError, 'Can only automatically set the delegation prefix when delegating to a method.'
-      end
-
-      method_prefix = \
-        if prefix
-          "#{prefix == true ? to : prefix}_"
-        else
-          ''
-        end
-
-      file, line = caller.first.split(':', 2)
-      line = line.to_i
-
-      to = to.to_s
-      to = 'self.class' if to == 'class'
-
-      methods.each do |method|
-        # Attribute writer methods only accept one argument. Makes sure []=
-        # methods still accept two arguments.
-        definition = (method =~ /[^\]]=$/) ? 'arg' : '*args, &block'
-
-        if allow_nil
-          module_eval(<<-EOS, file, line - 2)
-            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
-              if #{to} || #{to}.respond_to?(:#{method})         #   if client || client.respond_to?(:name)
-                #{to}.#{method}(#{definition})                  #     client.name(*args, &block)
-              end                                               #   end
-            end                                                 # end
-          EOS
-        else
-          exception = %(raise "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
-
-          module_eval(<<-EOS, file, line - 1)
-            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
-              #{to}.#{method}(#{definition})                    #   client.name(*args, &block)
-            rescue NoMethodError                                # rescue NoMethodError
-              if #{to}.nil?                                     #   if client.nil?
-                #{exception}                                    #     # add helpful message to the exception
-              else                                              #   else
-                raise                                           #     raise
-              end                                               #   end
-            end                                                 # end
-          EOS
-        end
-      end
-    end
-  end
-end