docx_report 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2462f82a4a13faeffaad45e13b5356f0e5c0e693
-  data.tar.gz: 04753ff74b48efabe96f91d1d2db3712b009c97a
+  metadata.gz: df8bc8c2d36d553f99684f1d96f2496c2c3200f1
+  data.tar.gz: 8ff0b77d064a32fae807ed71527057c4d93da371
 SHA512:
-  metadata.gz: 17a9db4ed66576898e3fe3f5e6cc33dd4a1316df76b087e6af70eb10810153758acb9bae39855e1bd22782640759aef3efdf5914e1acf4b67501bdeb3c4535f2
-  data.tar.gz: fa77fad1bc35d081f7552c1ff06583386333bd6c7c6cd357f77aee36f5d31c6701c6c44a4ba16045b416841546c6effc5100aec2d8413c15a825cc8e15f52382
+  metadata.gz: dae046f2041647d0fed8de9ff86ba7af46845f80315e3d5999bb2ae3c99f2fa47b6127b6decc3b8134a4b281cf28d4765e1c376b43943902ca8fdf4ffeea764a
+  data.tar.gz: b2f0a465bd9e348401bd7d450df1266b4ee47935b9daac808f3f508ec7f4569e0d7160d05f348ea0f5f2393a6317d88537e6587cc1319fc7bd223026275230d3

data/lib/docx_report.rb

@@ -3,6 +3,9 @@ require 'docx_report/document'
 require 'docx_report/parser'
 require 'docx_report/table'
 require 'docx_report/record'
+require 'docx_report/field'
+require 'docx_report/content_file'
+require 'docx_report/hyperlink'
 
 module DocxReport
   def self.create_docx_report(template_path)

data/lib/docx_report/content_file.rb

@@ -0,0 +1,34 @@
+module DocxReport
+  class ContentFile
+    attr_reader :name, :xml, :rels_name, :rels_xml, :new_rels
+
+    def initialize(name, zip)
+      @name = name
+      @xml = Nokogiri::XML(zip.read(name))
+      @rels_name = "#{name.sub '/', '/_rels/'}.rels"
+      @new_rels = false
+      @rels_xml = Nokogiri::XML(if zip.entries.any? { |r| r.name == @rels_name }
+                                  zip.read(@rels_name)
+                                else
+                                  new_rels_xml
+                                end)
+    end
+
+    def new_uniqe_id
+      (@rels_xml.xpath('//*[@Id]').map do |e|
+        e[:Id][3..-1].to_i if e.name == 'Relationship'
+      end.compact.max || 0) + 1
+    end
+
+    def new_rels_xml
+      @new_rels = true
+      '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Relationships'\
+      'xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'\
+      '</Relationships>'
+    end
+
+    def rels_has_items?
+      @rels_xml.xpath('//*[@Id]').any?
+    end
+  end
+end

data/lib/docx_report/data_item.rb

@@ -0,0 +1,11 @@
+module DocxReport
+  module DataItem
+    attr_reader :fields, :images
+
+    def add_field(name, value, type = :text)
+      field = Field.new name, value, type
+      raise 'duplicate field name' if @fields.any? { |f| f.name == field.name }
+      @fields << field
+    end
+  end
+end

data/lib/docx_report/document.rb

@@ -3,52 +3,87 @@ require 'nokogiri'
 
 module DocxReport
   class Document
-    attr_reader :template_path, :files
+    attr_accessor :template_path, :files
 
     def initialize(template_path)
       @template_path = template_path
       zip = Zip::File.open(template_path)
-      @files = load_files zip
+      load_files zip
       zip.close
     end
 
-    def save(output_path)
-      zip = Zip::File.open @template_path
+    def save_to_memory
+      Zip::OutputStream.write_buffer do |output|
+        add_files output
+      end.string
+    end
+
+    def save_to_file(output_path)
       Zip::OutputStream.open(output_path) do |output|
-        zip.each do |entry|
-          output.put_next_entry entry.name
-          if @files.keys.include? entry.name
-            output.write @files[entry.name].to_xml
-          else
-            output.write zip.read(entry.name)
+        add_files output
+      end
+    end
+
+    def new_uniqe_id(type)
+      (@files.map do |file|
+        file.xml.xpath('//*[@id]').map { |e| e[:id].to_i if e.name == type }
+      end.flatten.compact.max || 0) + 1
+    end
+
+    private
+
+    def add_files(output)
+      Zip::File.open @template_path do |template|
+        template.each do |entry|
+          write_files entry.name, template, output
+        end
+        @files.each do |file|
+          if file.new_rels && file.rels_has_items?
+            output.put_next_entry file.rels_name
+            output.write file.rels_xml.to_xml
           end
         end
       end
-      zip.close()
     end
 
-    private
+    def write_files(name, template, output)
+      if @files.any? { |f| f.name == name }
+        add_data name, @files.detect { |f| f.name == name }.xml.to_xml, output
+      elsif @files.any? { |f| f.rels_name == name }
+        file = @files.detect { |f| f.rels_name == name }
+        add_data name, file.rels_xml.to_xml, output if file.rels_has_items?
+      else
+        add_data name, template.read(name), output
+      end
+    end
+
+    def add_data(name, data, output)
+      output.put_next_entry name
+      output.write data
+    end
 
     def content_types_xpath
       "//*[@ContentType = '#{CONTENT_TYPES.join("' or @ContentType='")}']"
     end
 
     def load_files(zip)
-      @files = {}
-      content_type_element = Nokogiri::XML zip.read(CONTENT_TYPE_NAME)
-      content_type_element.xpath(content_types_xpath).each do |e|
+      @files = []
+      content_type_node = Nokogiri::XML zip.read(CONTENT_TYPE_NAME)
+      content_type_node.xpath(content_types_xpath).each do |e|
         filename = e['PartName'][1..-1]
-        @files[filename] = Nokogiri::XML zip.read(filename)
+        @files << ContentFile.new(filename, zip)
       end
-      @files
     end
 
     CONTENT_TYPE_NAME = '[Content_Types].xml'.freeze
 
     CONTENT_TYPES = [
-      'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml',
-      'application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml',
-      'application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml'
+      'application/vnd.openxmlformats-officedocument.wordprocessingml'\
+      '.document.main+xml',
+      'application/vnd.openxmlformats-officedocument.wordprocessingml'\
+      '.header+xml',
+      'application/vnd.openxmlformats-officedocument.wordprocessingml'\
+      '.footer+xml'
     ].freeze
   end
 end

data/lib/docx_report/field.rb

@@ -0,0 +1,23 @@
+module DocxReport
+  class Field
+    attr_reader :name, :value, :type
+
+    def initialize(name, value = nil, type = :text, &block)
+      @name = "@#{name}@"
+      @type = type
+      set_value(value || block)
+    end
+
+    def set_value(value = nil, &block)
+      @value = value || block
+    end
+
+    def load_value(item)
+      Field.new(name[1..-2], if @value.is_a? Proc
+                               @value.call(item)
+                             else
+                               item.is_a?(Hash) ? item[@value] : item.send(@value)
+                             end, type)
+    end
+  end
+end

data/lib/docx_report/hyperlink.rb

@@ -0,0 +1,30 @@
+module DocxReport
+  class Hyperlink
+    attr_accessor :target, :file, :id
+
+    def initialize(target, file, id = nil)
+      @target = target
+      @file = file
+      if id.nil?
+        generate_id
+      else
+        @id = id
+        file.rels_xml.xpath("//*[@Id='#{id}']").first[:Target] = target
+      end
+    end
+
+    private
+
+    def generate_id
+      @id = "rId#{file.new_uniqe_id}"
+      file.rels_xml.children.first << hyperlink_rels
+    end
+
+    def hyperlink_rels
+      Nokogiri::XML(
+        format('<Relationship Id="%s" Type="http://schemas.openxmlformats'\
+        '.org/officeDocument/2006/relationships/hyperlink" Target="%s" '\
+        'TargetMode="External"/>', @id, @target)).children.first
+    end
+  end
+end

data/lib/docx_report/parser.rb

@@ -7,56 +7,78 @@ module DocxReport
     end
 
     def replace_all_fields(fields)
-      @document.files.values.each do |xml_element|
-        replace_element_fields(fields, xml_element)
+      @document.files.each do |file|
+        replace_node_fields(fields, file.xml)
+        replace_node_hyperlinks(fields, file.xml, file)
       end
     end
 
     def fill_all_tables(tables)
-      @document.files.values.each do |xml_element|
-        fill_element_tables(tables, xml_element)
+      @document.files.each do |file|
+        fill_tables(tables, file.xml, file)
       end
     end
 
     private
 
-    def search_for_text(name, parent_element)
-      parent_element.xpath(".//*[contains(text(), '#{name}')]")
+    def find_text_nodes(name, parent_node)
+      parent_node.xpath(".//*[contains(text(), '#{name}')]")
     end
 
-    def replace_element_fields(fields, parent_element)
-      fields.each do |key, value|
-        search_for_text(key, parent_element).map do |element|
-          element.content = element.content.gsub key, value
+    def find_hyperlink_nodes(name, parent_node, file)
+      links = file.rels_xml.xpath "//*[@Target='#{name}']"
+      parent_node.xpath(".//w:hyperlink[@r:id='#{find_by_Id(links)}']")
+    end
+
+    def find_by_Id(links)
+      links.map { |link| link[:Id] }.join("' or @r:id='")
+    end
+
+    def replace_node_fields(fields, parent_node)
+      fields.select { |f| f.type == :text }.each do |field|
+        find_text_nodes(field.name, parent_node).map do |node|
+          node.content = node.content.gsub field.name, field.value
+        end
+      end
+    end
+
+    def replace_node_hyperlinks(fields, parent_node, file, create = false)
+      fields.select { |f| f.type == :hyperlink }.each do |field|
+        find_hyperlink_nodes(field.name, parent_node, file).each do |node|
+          hyperlink = Hyperlink.new(field.value, file,
+                                    (node['r:id'] unless create))
+          node['r:id'] = hyperlink.id
         end
       end
     end
 
-    def find_table(name, parent_element)
-      parent_element.xpath(".//w:tbl[//w:tblCaption[@w:val='#{name}']][1]").first
+    def find_table(name, parent_node)
+      parent_node.xpath(".//w:tbl[//w:tblCaption[@w:val='#{name}']][1]")
+                    .first
     end
 
-    def find_row(table_element, row_number)
-      table_element.xpath(".//w:tr[#{row_number}]").first
+    def find_row(table, table_node)
+      row_number = table.has_header ? 2 : 1
+      table_node.xpath(".//w:tr[#{row_number}]").first
     end
 
-    def fill_element_tables(tables, parent_element)
+    def fill_tables(tables, parent_node, file)
       tables.each do |table|
-        tbl = find_table table.name, parent_element
-        if tbl
-          row_number = table.has_header ? 2 : 1
-          tbl_row = find_row tbl, row_number
-
-          if tbl_row
-            table.records.each do |record|
-              new_row = tbl_row.dup
-              tbl_row.add_previous_sibling new_row
-              replace_element_fields record.fields, new_row
-            end
-            tbl_row.remove
-          end
-        end
+        tbl = find_table table.name, parent_node
+        next if tbl.nil?
+        tbl_row = find_row table, tbl
+        fill_table_rows(table, tbl_row, file) unless tbl_row.nil?
+      end
+    end
+
+    def fill_table_rows(table, row_node, file)
+      table.records.each do |record|
+        new_row = row_node.dup
+        row_node.add_previous_sibling new_row
+        replace_node_fields record.fields, new_row
+        replace_node_hyperlinks record.fields, new_row, file, true
       end
+      row_node.remove
     end
   end
 end

data/lib/docx_report/record.rb

@@ -1,13 +1,11 @@
+require 'docx_report/data_item'
+
 module DocxReport
   class Record
-    attr_accessor :fields
+    include DataItem
 
     def initialize
-      @fields = {}
-    end
-
-    def add_field(name, value)
-      fields["{@#{name}}"] = value
+      @fields = []
     end
   end
 end

data/lib/docx_report/report.rb

@@ -1,20 +1,18 @@
-require 'tempfile'
+require 'docx_report/data_item'
 
 module DocxReport
   class Report
+    include DataItem
     attr_reader :fields, :tables
 
     def initialize(template_path)
       @template_path = template_path
-      @fields = {}
+      @fields = []
       @tables = []
     end
 
-    def add_field(name, value)
-      @fields["{@#{name}}"] = value
-    end
-
     def add_table(name, collection = nil, has_header = false)
+      raise 'duplicate table name' if @tables.any? { |t| t.name == name }
       table = Table.new name, has_header
       @tables << table
       yield table
@@ -22,18 +20,21 @@ module DocxReport
     end
 
     def generate_docx(filename = nil, template_path = nil)
-      doc = Document.new template_path || @template_path
-      parser = Parser.new doc
-      parser.fill_all_tables @tables
-      parser.replace_all_fields @fields
-      temp = Tempfile.new('') if filename.nil?
-      docx_path = filename || temp.path
-      begin
-        doc.save docx_path
-        File.read docx_path if filename.nil?
-      ensure
-        temp.close! if temp
+      document = Document.new template_path || @template_path
+      apply_changes document
+      if filename.nil?
+        document.save_to_memory
+      else
+        document.save_to_file filename
       end
     end
+
+    private
+
+    def apply_changes(document)
+      parser = Parser.new document
+      parser.replace_all_fields @fields
+      parser.fill_all_tables @tables
+    end
   end
 end

data/lib/docx_report/table.rb

@@ -1,6 +1,6 @@
 module DocxReport
   class Table
-    attr_accessor :name, :has_header, :records
+    attr_reader :name, :has_header, :records
 
     def initialize(name, has_header = false)
       @name = name
@@ -15,28 +15,21 @@ module DocxReport
       new_record
     end
 
-    def add_field(name, mapped_field = nil, &block)
-      @fields << { name: name, mapped_field: mapped_field, block: block }
+    def add_field(name, value = nil, type = :text, &block)
+      field = Field.new(name, value || block, type)
+      raise 'duplicate field name' if @fields.any? do |f|
+        f.name == field.name
+      end
+      @fields << field
     end
 
     def load_records(collection)
       collection.each do |item|
         record = new_record
         @fields.each do |field|
-          if field[:block].nil?
-            record.add_field field[:name],
-                             mapped_value(item, field[:mapped_field])
-          else
-            record.add_field field[:name], field[:block].call(item)
-          end
+          record.fields << field.load_value(item)
         end
       end
     end
-
-    private
-
-    def mapped_value(item, field_name)
-      item.is_a?(Hash) ? item[field_name] : item.send(field_name)
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx_report
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Ahmed Abudaqqa
@@ -40,14 +40,19 @@ dependencies:
         version: '1.2'
 description: |-
   docx_report is a light weight gem that generates docx files
-                     by replacing strings on previously created .docx file
+                     by replacing strings and inserting images on previously
+                     created .docx template file
 email: ahmed@abudaqqa.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/docx_report.rb
+- lib/docx_report/content_file.rb
+- lib/docx_report/data_item.rb
 - lib/docx_report/document.rb
+- lib/docx_report/field.rb
+- lib/docx_report/hyperlink.rb
 - lib/docx_report/parser.rb
 - lib/docx_report/record.rb
 - lib/docx_report/report.rb
@@ -75,5 +80,6 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: docx_report generate docx files based on previously created .docx file
+summary: docx_report generate docx files based on previously created .docx template
+  file
 test_files: []