Implement creating, removing, and editing existing styles. Utilize this system throughout the app.

Author: rickychilcott

README.md

@@ -181,12 +181,29 @@ 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')
+
+# see lib/docx/elements/style.rb for more attributes you can set!
+new_style = d.styles_config.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.styles_config.remove_style("Red")
+```
+
+
 ## Development
 
 ### todo
 
 * 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)

lib/docx/containers.rb

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

lib/docx/containers/paragraph.rb

@@ -77,32 +77,42 @@ def aligned_center?
         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 style
           return nil unless @document
 
-          if style_property.nil?
+          @document.style_name_of(style_id) ||
             @document.default_paragraph_style
-          else
-            @document.style_name(style_property.attributes['val'].value)
-          end
         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&.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

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

lib/docx/containers/text_run.rb

@@ -111,8 +111,11 @@ def hyperlink_id
         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

lib/docx/document.rb

@@ -1,10 +1,12 @@
 require 'docx/containers'
 require 'docx/elements'
+require 'docx/errors'
+require 'docx/helpers'
 require 'nokogiri'
 require 'zip'
 
 module Docx
-  # The Document class wraps around a docx file and provides methods to
+  # The Document class wraps around a docx file and pro.es methods to
   # interface with it.
   #
   #   # get a Docx::Document for a docx file in the local directory
@@ -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 = {})
@@ -82,10 +86,11 @@ def tables
     # 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
@@ -130,13 +135,11 @@ def save(path)
           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
@@ -169,15 +172,15 @@ def replace_entry(entry_path, file_contents)
     end
 
     def default_paragraph_style
-      s = @styles.at_xpath("w:styles/w:style[@w:type='paragraph' and @w:default='1']")
-      s = s.at_xpath('w:name')
-      s.attributes['val'].value
+      @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 style_name(style_id)
-      s = @styles.at_xpath("w:styles/w:style[@w:styleId='#{style_id}']")
-      s = s.at_xpath('w:name')
-      s.attributes['val'].value
+    def styles_configuration
+      @styles_configuration ||= Elements::Containers::StylesConfiguration.new(@styles.dup)
     end
 
     private
@@ -206,6 +209,7 @@ def load_rels
     #++
     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

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'

lib/docx/elements/style.rb

@@ -0,0 +1,125 @@
+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
+
+      def self.attributes
+        @@attributes
+      end
+
+      def self.attribute(name, *selectors, converter: Converters::DefaultValueConverter, validator: Validators::DefaultValidator)
+        define_method(name) do
+          selectors
+            .lazy
+            .filter_map { |node_xpath| node.at_xpath(node_xpath)&.value }
+            .map { |value| converter.decode(value) }
+            .first
+        end
+
+        define_method("#{name}=") do |value|
+          validator.validate(value) || raise(Errors::StyleInvalidPropertyValue, "Invalid value for #{name}: #{value}")
+
+          selectors.map do |attribute_xpath|
+            encoded_value = converter.encode(value).to_s
+            if (existing_attribute = node.at_xpath(attribute_xpath))
+              existing_attribute.value = encoded_value
+              next value
+            end
+
+            node_xpath, attribute = attribute_xpath.split("/@")
+
+            created_node =
+              node_xpath
+                .split("/")
+                .reduce(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
+
+      def self.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
+
+      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"
+      attribute :name, "./w:name/@w:val", "./w:next/@w:val"
+      attribute :type, ".//@w:type"
+      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 to_xml
+        node.to_xml
+      end
+
+      def remove
+        node.remove
+        @configuration.styles.delete(self)
+      end
+    end
+  end
+end