sablon 0.1.1 → 0.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -117,26 +117,28 @@ files:
 - lib/sablon/configuration/html_tag.rb
 - lib/sablon/content.rb
 - lib/sablon/context.rb
+- lib/sablon/document_object_model/content_types.rb
+- lib/sablon/document_object_model/file_handler.rb
+- lib/sablon/document_object_model/model.rb
+- lib/sablon/document_object_model/numbering.rb
+- lib/sablon/document_object_model/relationships.rb
 - lib/sablon/environment.rb
 - lib/sablon/html/ast.rb
 - lib/sablon/html/ast_builder.rb
 - lib/sablon/html/converter.rb
 - lib/sablon/html/node_properties.rb
 - lib/sablon/html/visitor.rb
-- lib/sablon/numbering.rb
 - lib/sablon/operations.rb
 - lib/sablon/parser/mail_merge.rb
 - lib/sablon/processor/document.rb
-- lib/sablon/processor/numbering.rb
 - lib/sablon/processor/section_properties.rb
-- lib/sablon/relationship.rb
 - lib/sablon/template.rb
 - lib/sablon/test.rb
-- lib/sablon/test/assertions.rb
 - lib/sablon/version.rb
 - misc/TEMPLATE.md
 - misc/cv_sample.png
 - misc/cv_template.png
+- misc/image-example.png
 - misc/recipe_sample.png
 - misc/recipe_template.png
 - misc/step_1.png
@@ -162,8 +164,16 @@ files:
 - test/fixtures/cv_template.docx
 - test/fixtures/html/html_test_content.html
 - test/fixtures/html_sample.docx
+- test/fixtures/images/c3po.jpg
+- test/fixtures/images/clone.jpg
+- test/fixtures/images/darth_vader.jpg
+- test/fixtures/images/r2d2.jpg
+- test/fixtures/images_sample.docx
+- test/fixtures/images_template.docx
 - test/fixtures/insertion_template.docx
 - test/fixtures/insertion_template_no_styles.docx
+- test/fixtures/loops_sample.docx
+- test/fixtures/loops_template.docx
 - test/fixtures/markdown_sample.docx
 - test/fixtures/recipe_context.json
 - test/fixtures/recipe_sample.docx
@@ -178,7 +188,10 @@ files:
 - test/fixtures/xml/conditional_without_ending.xml
 - test/fixtures/xml/corrupt_table.xml
 - test/fixtures/xml/edited_complex_field.xml
+- test/fixtures/xml/image.xml
+- test/fixtures/xml/loop_with_unique_ids.xml
 - test/fixtures/xml/loop_without_ending.xml
+- test/fixtures/xml/mock_document/word/document.xml
 - test/fixtures/xml/paragraph_loop.xml
 - test/fixtures/xml/paragraph_loop_within_table_cell.xml
 - test/fixtures/xml/simple_field.xml
@@ -195,9 +208,9 @@ files:
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
 - test/processor/document_test.rb
+- test/processor/section_properties_test.rb
 - test/sablon_test.rb
 - test/sandbox/.gitkeep
-- test/section_properties_test.rb
 - test/support/document_xml_helper.rb
 - test/support/html_snippets.rb
 - test/support/xml_snippets.rb
@@ -222,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: docx template processor
@@ -239,8 +252,16 @@ test_files:
 - test/fixtures/cv_template.docx
 - test/fixtures/html/html_test_content.html
 - test/fixtures/html_sample.docx
+- test/fixtures/images/c3po.jpg
+- test/fixtures/images/clone.jpg
+- test/fixtures/images/darth_vader.jpg
+- test/fixtures/images/r2d2.jpg
+- test/fixtures/images_sample.docx
+- test/fixtures/images_template.docx
 - test/fixtures/insertion_template.docx
 - test/fixtures/insertion_template_no_styles.docx
+- test/fixtures/loops_sample.docx
+- test/fixtures/loops_template.docx
 - test/fixtures/markdown_sample.docx
 - test/fixtures/recipe_context.json
 - test/fixtures/recipe_sample.docx
@@ -255,7 +276,10 @@ test_files:
 - test/fixtures/xml/conditional_without_ending.xml
 - test/fixtures/xml/corrupt_table.xml
 - test/fixtures/xml/edited_complex_field.xml
+- test/fixtures/xml/image.xml
+- test/fixtures/xml/loop_with_unique_ids.xml
 - test/fixtures/xml/loop_without_ending.xml
+- test/fixtures/xml/mock_document/word/document.xml
 - test/fixtures/xml/paragraph_loop.xml
 - test/fixtures/xml/paragraph_loop_within_table_cell.xml
 - test/fixtures/xml/simple_field.xml
@@ -272,9 +296,9 @@ test_files:
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
 - test/processor/document_test.rb
+- test/processor/section_properties_test.rb
 - test/sablon_test.rb
 - test/sandbox/.gitkeep
-- test/section_properties_test.rb
 - test/support/document_xml_helper.rb
 - test/support/html_snippets.rb
 - test/support/xml_snippets.rb

data/lib/sablon/numbering.rb

@@ -1,23 +0,0 @@
-module Sablon
-  class Numbering
-    attr_reader :definitions
-
-    Definition = Struct.new(:numid, :style) do
-      def inspect
-        "#<Numbering #{numid}:#{style}"
-      end
-    end
-
-    def initialize
-      @numid = 1000
-      @definitions = []
-    end
-
-    def register(style)
-      @numid += 1
-      definition = Definition.new(@numid, style)
-      @definitions << definition
-      definition
-    end
-  end
-end

data/lib/sablon/processor/numbering.rb

@@ -1,47 +0,0 @@
-module Sablon
-  module Processor
-    class Numbering
-      LIST_DEFINITION = <<-XML.gsub(/^\s+/, '').tr("\n", '')
-        <w:num w:numId="%s">
-          <w:abstractNumId w:val="%s" />
-        </w:num>
-      XML
-
-      def self.process(doc, env)
-        processor = new(doc)
-        processor.manipulate env
-        doc
-      end
-
-      def initialize(doc)
-        @doc = doc
-      end
-
-      def manipulate(env)
-        env.numbering.definitions.each do |definition|
-          abstract_num_ref = find_definition(definition.style)
-          abstract_num_copy = abstract_num_ref.dup
-          abstract_num_copy['w:abstractNumId'] = definition.numid
-          abstract_num_copy.xpath('./w:nsid').each(&:remove)
-          container.prepend_child abstract_num_copy
-          container.add_child(LIST_DEFINITION % [definition.numid, abstract_num_copy['w:abstractNumId']])
-        end
-        @doc
-      end
-
-      private
-      def container
-        @container ||= @doc.xpath('//w:numbering').first
-      end
-
-      def find_definition(style)
-        abstract_num = @doc.xpath("//w:abstractNum[descendant-or-self::*[w:pStyle[@w:val='#{style}']]]").first
-        if abstract_num
-          abstract_num
-        else
-          raise ArgumentError, "Could not find w:abstractNum definition for style: #{style.inspect}"
-        end
-      end
-    end
-  end
-end

data/lib/sablon/relationship.rb

@@ -1,47 +0,0 @@
-module Sablon
-  # Handles storing referenced relationships in the document.xml file and
-  # writing them to the document.xml.rels file
-  class Relationship
-    attr_accessor :relationships
-
-    def initialize
-      @relationships = []
-    end
-
-    def add_found_relationships(content, output_stream)
-      output_stream.put_next_entry('word/_rels/document.xml.rels')
-      #
-      unless @relationships.empty?
-        rels_doc = Nokogiri::XML(content)
-        rels_doc_root = rels_doc.root
-        # convert new rels to nodes
-        node_set = convert_relationships_to_node_set(rels_doc)
-        @relationships = []
-        # add new nodes to XML content
-        rels_doc_root.last_element_child.after(node_set)
-        content = rels_doc.to_xml(indent: 0, save_with: 0)
-      end
-      #
-      output_stream.write(content)
-    end
-
-    private
-
-    # Builds a set of Relationship XML nodes from the stored relationships
-    def convert_relationships_to_node_set(doc)
-      node_set = Nokogiri::XML::NodeSet.new(doc)
-      @relationships.each do |relationship|
-        rel_tag = "<Relationship#{relationship_attributes(relationship)}/>"
-        node_set << Nokogiri::XML.fragment(rel_tag).children.first
-      end
-      #
-      node_set
-    end
-
-    # Builds the attribute string for the relationship XML node
-    def relationship_attributes(relationship)
-      return '' if relationship.nil? || relationship.empty?
-      ' ' + relationship.map { |k, v| %(#{k}="#{v}") }.join(' ')
-    end
-  end
-end

data/lib/sablon/test/assertions.rb

@@ -1,22 +0,0 @@
-module Sablon
-  module Test
-    module Assertions
-      def assert_docx_equal(expected_path, actual_path)
-        if get_document_xml(expected_path) != get_document_xml(actual_path)
-          msg = <<-error
-The generated document does not match the sample. Please investigate.
-
-If the generated document is correct, the sample needs to be updated:
-\t cp #{actual_path} #{expected_path}
-      error
-          fail msg
-        end
-      end
-
-      def get_document_xml(path)
-        document_xml_entry = Zip::File.open(path).get_entry("word/document.xml")
-        document_xml_entry.get_input_stream.read
-      end
-    end
-  end
-end

data/test/section_properties_test.rb

@@ -1,41 +0,0 @@
-require "test_helper"
-require "support/document_xml_helper"
-
-class SectionPropertiesTest < Sablon::TestCase
-  include DocumentXMLHelper
-
-  def test_assign_start_page_number_with_pgNumType_tag
-    xml = wrap <<-documentxml
-<w:body>
-  <w:sectPr w:rsidR="00FC1AFD" w:rsidSect="006745DF">
-    <w:pgSz w:w="11900" w:h="16840"/>
-    <w:pgMar w:top="1440" w:right="1800" w:bottom="1440" w:left="1800" w:header="708" w:footer="708" w:gutter="0"/>
-    <w:pgNumType w:start="1"/>
-    <w:cols w:space="708"/>
-    <w:docGrid w:linePitch="360"/>
-  </w:sectPr>
-</w:body>
-    documentxml
-    properties = Sablon::Processor::SectionProperties.from_document(xml)
-    assert_equal "1", properties.start_page_number
-    properties.start_page_number = "23"
-    assert_equal "23", properties.start_page_number
-  end
-
-  def test_assign_start_page_number_without_pgNumType_tag
-    xml = wrap <<-documentxml
-<w:body>
-  <w:sectPr w:rsidR="00FC1AFD" w:rsidSect="006745DF">
-    <w:pgSz w:w="11900" w:h="16840"/>
-    <w:pgMar w:top="1440" w:right="1800" w:bottom="1440" w:left="1800" w:header="708" w:footer="708" w:gutter="0"/>
-    <w:cols w:space="708"/>
-    <w:docGrid w:linePitch="360"/>
-  </w:sectPr>
-</w:body>
-    documentxml
-    properties = Sablon::Processor::SectionProperties.from_document(xml)
-    assert_nil properties.start_page_number
-    properties.start_page_number = "16"
-    assert_equal "16", properties.start_page_number
-  end
-end