goldendocx 0.2.2 → 0.3.0

data/lib/goldendocx/content_types/override.rb

@@ -6,13 +6,9 @@ module Goldendocx
       include Goldendocx::Element
 
       tag :Override
-      attribute :part_name, alias_name: :PartName, readonly: true
-      attribute :content_type, alias_name: :ContentType, readonly: true
 
-      def initialize(part_name, content_type)
-        @part_name = part_name
-        @content_type = content_type
-      end
+      attribute :part_name, alias_name: :PartName
+      attribute :content_type, alias_name: :ContentType
 
       def ==(other)
         part_name == other.part_name && content_type == other.content_type

data/lib/goldendocx/document.rb

@@ -3,49 +3,30 @@
 # Just to mark a element as a root document node
 module Goldendocx
   module Document
-    def self.included(base)
-      base.include(Goldendocx::Element)
-      base.extend(ClassMethods)
+    extend ActiveSupport::Concern
+    include Goldendocx::Element
+
+    included do
+      class_attribute :concerned_namespaces, default: []
+      class_attribute :ignorable_namespaces, default: []
     end
 
-    module ClassMethods
+    class_methods do
       def concern_namespaces(*namespaces)
         namespaces.each do |namespace|
           concerned_namespaces << namespace unless concerned_namespaces.include?(namespace)
         end
       end
 
-      def concerned_namespaces
-        @concerned_namespaces ||= []
-      end
-
       def ignore_namespaces(*namespaces)
         namespaces.each do |namespace|
           ignorable_namespaces << namespace.to_sym unless ignorable_namespaces.include?(namespace)
         end
       end
-
-      def ignorable_namespaces
-        @ignorable_namespaces ||= []
-      end
-    end
-
-    def concerned_namespaces
-      self.class.concerning_ancestors.flat_map(&:concerned_namespaces)
-    end
-
-    def ignorable_namespaces
-      self.class.concerning_ancestors.flat_map(&:ignorable_namespaces)
     end
 
-    def to_document_xml
-      Goldendocx.xml_serializer.build_document_xml(root_tag, concerned_namespaces, ignorable_namespaces) do |xml|
-        attributes.each { |name, value| xml[name] = value }
-
-        yield(xml) if block_given?
-
-        children.each { |child| xml << child }
-      end
+    def to_document_xml(&)
+      Goldendocx.xml_serializer.build_document_xml(tag_name, concerned_namespaces, ignorable_namespaces) { |xml| build_element(xml, &) }
     end
   end
 end

data/lib/goldendocx/documents/body.rb

@@ -7,40 +7,49 @@ module Goldendocx
 
       XML_PATH = 'word/document.xml'
 
-      attr_reader :components, :properties, :charts
+      attr_reader :components, :charts
 
       namespace :w
       tag :body
 
+      # TODO: Try to distinguish these paragraphs
       embeds_many :texts, class_name: 'Goldendocx::Components::Text'
       embeds_many :images, class_name: 'Goldendocx::Components::Image'
+
       embeds_many :tables, class_name: 'Goldendocx::Components::Table'
 
+      embeds_one :section_property, class_name: 'Goldendocx::Documents::Properties::SectionProperty', auto_build: true
+
+      class << self
+        def read_from(xml_node)
+          document = super(xml_node)
+
+          component_tags = %w[w:p w:tbl]
+          xml_node.children.map do |node|
+            document.components << node if component_tags.include?(node.tag_name)
+          end
+
+          document
+        end
+      end
+
       def initialize
         @components = []
         @charts = []
       end
 
-      def read_from(docx_file)
-        Goldendocx.xml_serializer.parse(docx_file.read(XML_PATH), %w[w:document w:body *]).map do |node|
-          element = Goldendocx::Documents::Element.new(node)
-          @components << element if element.component?
-          @properties = element if element.properties?
-        end
-      end
-
       # FIXME: Override for children not in correctly order
       def to_element(**_context)
-        Goldendocx.xml_serializer.build_element(root_tag) do |xml|
+        Goldendocx.xml_serializer.build_element(tag_name) do |xml|
           components.each { |component| xml << component }
-          xml << properties if properties
+          xml << section_property if section_property
 
           yield(xml) if block_given?
         end
       end
 
       def create_text(text, options = {})
-        text = build_text(text: text, **options.slice(:align, :color, :bold))
+        text = build_text(text:, **options.slice(:align, :color, :bold))
 
         components << text
 
@@ -57,7 +66,7 @@ module Goldendocx
       end
 
       def create_image(relationship_id, options)
-        image = build_image(relationship_id: relationship_id, width: options[:width], height: options[:height])
+        image = build_image(relationship_id:, width: options[:width], height: options[:height])
 
         components << image
 
@@ -65,7 +74,7 @@ module Goldendocx
       end
 
       def create_embed_image(relationship_id, options)
-        Goldendocx::Components::Image.new(relationship_id: relationship_id, width: options[:width], height: options[:height])
+        Goldendocx::Components::Image.new(relationship_id:, width: options[:width], height: options[:height])
       end
 
       def ensure_chart_type(chart_type)

data/lib/goldendocx/documents/document.rb

@@ -5,7 +5,9 @@ module Goldendocx
     class Document
       include Goldendocx::Document
 
+      TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
       XML_PATH = 'word/document.xml'
+      CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'
 
       namespace :w
       tag :document
@@ -16,10 +18,6 @@ module Goldendocx
 
       embeds_one :body, class_name: 'Goldendocx::Documents::Body', auto_build: true
 
-      def read_from(docx_file)
-        body.read_from(docx_file)
-      end
-
       def write_to(zos)
         zos.put_next_entry XML_PATH
         zos.write to_document_xml

data/lib/goldendocx/documents/latent_styles.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    class LatentStyles
+      include Goldendocx::Element
+
+      namespace :w
+      tag :latentStyles
+    end
+  end
+end

data/lib/goldendocx/documents/properties/default_style_property.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class DefaultStyleProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :docDefaults
+
+        embeds_one :run_default, class_name: 'Goldendocx::Documents::Properties::RunDefaultStyleProperty', auto_build: true
+        embeds_one :paragraph_default, class_name: 'Goldendocx::Documents::Properties::ParagraphDefaultStyleProperty', auto_build: true
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/page_margin_property.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class PageMarginProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :pgMar
+
+        attribute :top, namespace: :w, default: 1440
+        attribute :bottom, namespace: :w, default: 1440
+        attribute :left, namespace: :w, default: 1800
+        attribute :right, namespace: :w, default: 1800
+        attribute :header, namespace: :w, default: 851
+        attribute :footer, namespace: :w, default: 992
+        attribute :gutter, namespace: :w, default: 0
+
+        # Follow html margin style setting
+        def margin=(*args)
+          args = Array(*args)
+          raise StandardError("wrong number of arguments (given #{args.length}, expected 1..4)") unless (1..4).cover?(args.length)
+
+          margins =
+            case args.length
+            when 1 then [args.first] * 4
+            when 2 then [args.first, args.last, args.first, args.last]
+            when 3 then [args.first, args.second, args.last, args.second]
+            else args
+            end
+          assign_attributes(**%i[top right bottom left].zip(margins).to_h)
+        end
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/page_size_property.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class PageSizeProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :pgSz
+
+        attribute :width, alias_name: :w, namespace: :w, default: 11906
+        attribute :height, alias_name: :h, namespace: :w, default: 16838
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/paragraph_default_style_property.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class ParagraphDefaultStyleProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :pPrDefault
+
+        embeds_one :property, class_name: 'Goldendocx::Components::Properties::Property'
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/run_default_style_property.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class RunDefaultStyleProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :rPrDefault
+
+        embeds_one :property, class_name: 'Goldendocx::Components::Properties::RunProperty'
+
+        def initialize
+          build_property
+          property.build_language
+          property.build_font
+        end
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/section_property.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class SectionProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :sectPr
+
+        embeds_one :size, class_name: 'Goldendocx::Documents::Properties::PageSizeProperty', auto_build: true
+        embeds_one :margin, class_name: 'Goldendocx::Documents::Properties::PageMarginProperty', auto_build: true
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties/style_name_property.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class StyleNameProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :name
+
+        attribute :name, alias_name: :val, namespace: :w
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/properties.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+    end
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'properties', '*.rb').to_s).each do |file|
+  require file
+end

data/lib/goldendocx/documents/settings.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    class Settings
+      include Goldendocx::Document
+
+      XML_PATH = 'word/settings.xml'
+      TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings'
+      CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml'
+
+      namespace :w
+      tag :settings
+      concern_namespaces :mc, :o, :r, :m, :v, :w10, :w, :w14, :w15, :w16cid, :w16se, :sl
+      ignore_namespaces :w14, :w15, :w16se, :w16cid
+
+      def write_to(zos)
+        zos.put_next_entry XML_PATH
+        zos.write to_document_xml
+      end
+    end
+  end
+end

data/lib/goldendocx/documents/style.rb

@@ -3,18 +3,18 @@
 module Goldendocx
   module Documents
     class Style
-      attr_reader :node, :id, :type, :name
+      include Goldendocx::Element
 
-      def initialize(node)
-        @node = node
-        @id = node['w:styleId']
-        @type = node['w:type']
-        @name = node.public_send(:'w:name')['w:val']
-        @default = node['w:default']
-      end
+      namespace :w
+      tag :style
+
+      attribute :id, alias_name: :styleId, namespace: :w
+      attribute :type, namespace: :w
+
+      embeds_one :style_name, class_name: 'Goldendocx::Documents::Properties::StyleNameProperty', auto_build: true
 
-      def to_element(**_context)
-        @node
+      def name
+        style_name.name
       end
     end
   end

data/lib/goldendocx/documents/styles.rb

@@ -6,42 +6,22 @@ module Goldendocx
       include Goldendocx::Document
 
       XML_PATH = 'word/styles.xml'
+      TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles'
+      CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml'
 
       tag :styles
       namespace :w
       concern_namespaces :mc, :r, :w, :w14, :w15
       ignore_namespaces :w14, :w15
 
-      attr_reader :styles, :doc_defaults, :latent_styles
-
-      def initialize
-        @styles = []
-      end
+      embeds_one :defaults, class_name: 'Goldendocx::Documents::Properties::DefaultStyleProperty', auto_build: true
+      embeds_one :latentStyles, class_name: 'Goldendocx::Documents::LatentStyles'
+      embeds_many :styles, class_name: 'Goldendocx::Documents::Style'
 
       def size
         styles.size
       end
 
-      def read_from(docx_file)
-        @styles = Goldendocx.xml_serializer.parse(docx_file.read(XML_PATH), %w[w:styles w:style]).map do |node|
-          Goldendocx::Documents::Style.new(node)
-        end
-        @doc_defaults = Goldendocx.xml_serializer.parse(docx_file.read(XML_PATH), %w[w:styles w:docDefaults]).map do |node|
-          Goldendocx::Documents::UnparsedStyle.new(node)
-        end
-        @latent_styles = Goldendocx.xml_serializer.parse(docx_file.read(XML_PATH), %w[w:styles w:latentStyles]).map do |node|
-          Goldendocx::Documents::UnparsedStyle.new(node)
-        end
-      end
-
-      def to_document_xml
-        super do |xml|
-          @doc_defaults&.each { |element| xml << element }
-          @latent_styles&.each { |element| xml << element }
-          styles.each { |style| xml << style }
-        end
-      end
-
       def write_to(zos)
         zos.put_next_entry XML_PATH
         zos.write to_document_xml
@@ -60,14 +40,10 @@ module Goldendocx
       end
 
       def add_style(fragment)
-        # FIXME: Not a good implementation for Nokogiri compatibility
-        raise NotImplementedError unless Goldendocx.config.xml_serializer == :ox
-
-        style_id = (@styles.size + 1).to_s
-        style = Goldendocx.xml_serializer.parse(fragment)
-        style['w:styleId'] = style_id if style['w:styleId'].nil? || style['w:styleId'].empty?
-        @styles << Goldendocx::Documents::Style.new(style)
-        style_id
+        style = Goldendocx::Documents::Style.parse(fragment)
+        style.id = (styles.size + 1).to_s # Rearrange id to prevent duplicates
+        styles << style
+        style.id
       end
     end
   end

data/lib/goldendocx/documents.rb

@@ -5,6 +5,6 @@ module Goldendocx
   end
 end
 
-Dir.glob(File.join(File.dirname(__FILE__), 'documents', '*.rb').to_s).sort.each do |file|
+Dir.glob(File.join(File.dirname(__FILE__), 'documents', '*.rb').to_s).each do |file|
   require file
 end

data/lib/goldendocx/docx.rb

@@ -1,32 +1,54 @@
 # frozen_string_literal: true
 
-require 'goldendocx/units'
-require 'goldendocx/element'
-require 'goldendocx/document'
-
+require 'goldendocx/models'
 require 'goldendocx/components'
 require 'goldendocx/documents'
 require 'goldendocx/parts'
 
 module Goldendocx
   class Docx
-    attr_reader :unstructured_entries, :documents, :content_types
+    include Goldendocx::HasAssociations
+
+    attr_reader :unstructured_entries, :documents
+
+    RELATIONSHIPS_XML_PATH = '_rels/.rels'
 
     STRUCTURED_ENTRIES = [
+      RELATIONSHIPS_XML_PATH,
+
       Goldendocx::Parts::ContentTypes::XML_PATH,
+      Goldendocx::Parts::App::XML_PATH,
+      Goldendocx::Parts::Core::XML_PATH,
+
+      Goldendocx::Parts::Documents::RELATIONSHIPS_XML_PATH,
 
-      Goldendocx::Documents::Body::XML_PATH,
-      Goldendocx::Documents::Relationships::XML_PATH,
+      Goldendocx::Documents::Document::XML_PATH,
+      Goldendocx::Documents::Settings::XML_PATH,
       Goldendocx::Documents::Styles::XML_PATH
     ].freeze
 
-    def initialize(file_path)
+    relationships_at RELATIONSHIPS_XML_PATH
+    associate :app, class_name: 'Goldendocx::Parts::App'
+    associate :core, class_name: 'Goldendocx::Parts::Core'
+    associate :content_types, class_name: 'Goldendocx::Parts::ContentTypes', isolate: true
+
+    def initialize(file_path = nil)
+      file_path.present? ? read_from(file_path) : build_default
+    end
+
+    def read_from(file_path)
       docx_file = Zip::File.new(file_path)
+
+      read_relationships(docx_file)
+      read_associations(docx_file)
+
       @documents = Goldendocx::Parts::Documents.read_from(docx_file)
-      @content_types = Goldendocx::Parts::ContentTypes.read_from(docx_file)
+
       @unstructured_entries = docx_file.entries.filter_map do |entry|
         UnStructuredEntry.new(entry) unless STRUCTURED_ENTRIES.include?(entry.name)
       end
+
+      self
     end
 
     def write_to(new_path)
@@ -65,6 +87,25 @@ module Goldendocx
 
     private
 
+    def build_default
+      associations.each do |association, options|
+        association_class = options.class_name.constantize
+        instance_variable_set("@#{association}", association_class.new)
+        add_relationship association_class::TYPE, association_class::XML_PATH unless options.isolate
+      end
+
+      content_types.add_override "/#{Goldendocx::Parts::App::XML_PATH}", Goldendocx::Parts::App::CONTENT_TYPE
+      content_types.add_override "/#{Goldendocx::Parts::Core::XML_PATH}", Goldendocx::Parts::Core::CONTENT_TYPE
+      content_types.add_override "/#{Goldendocx::Documents::Styles::XML_PATH}", Goldendocx::Documents::Styles::CONTENT_TYPE
+      content_types.add_override "/#{Goldendocx::Documents::Settings::XML_PATH}", Goldendocx::Documents::Settings::CONTENT_TYPE
+
+      @documents = Goldendocx::Parts::Documents.new
+      add_relationship Goldendocx::Documents::Document::TYPE, Goldendocx::Documents::Document::XML_PATH
+      content_types.add_override "/#{Goldendocx::Documents::Document::XML_PATH}", Goldendocx::Documents::Document::CONTENT_TYPE
+
+      @unstructured_entries = []
+    end
+
     def ensure_image_content_type!(_image_data)
       extension = 'png'
       content_type = 'image/png'
@@ -79,10 +120,12 @@ module Goldendocx
 
     def to_stream
       Zip::OutputStream.write_buffer do |zos|
-        zos.put_next_entry Goldendocx::Parts::ContentTypes::XML_PATH
-        zos.write content_types.to_document_xml
+        write_relationships(zos)
+
+        associations.each_key do |association|
+          send(association).write_to(zos)
+        end
 
-        zos.put_next_entry Goldendocx::Parts::Documents::XML_PATH
         documents.write_stream(zos)
 
         @unstructured_entries.each { |unstructured_entry| unstructured_entry.write_to(zos) }