docx_report 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df8bc8c2d36d553f99684f1d96f2496c2c3200f1
-  data.tar.gz: 8ff0b77d064a32fae807ed71527057c4d93da371
+  metadata.gz: fba6128858dc1881724b7334e94d2fa527979e2e
+  data.tar.gz: 2191d4a90ec26b96769b8d3b7870024d6200c81b
 SHA512:
-  metadata.gz: dae046f2041647d0fed8de9ff86ba7af46845f80315e3d5999bb2ae3c99f2fa47b6127b6decc3b8134a4b281cf28d4765e1c376b43943902ca8fdf4ffeea764a
-  data.tar.gz: b2f0a465bd9e348401bd7d450df1266b4ee47935b9daac808f3f508ec7f4569e0d7160d05f348ea0f5f2393a6317d88537e6587cc1319fc7bd223026275230d3
+  metadata.gz: 7e4be5bff6c1c47b28913bd71028e25fd938eb82dbcb1d59daa6d3f53aaf09179d3b59c9583243930befad0851a6187cc1fcf645eadb0ea09b95f01067eff911
+  data.tar.gz: 84c3319c0f168a716213bdd11d88adef5f6654e926f85b87301babdc306e2d376cacafa9df91a4c626659a4a724ecb79f64267b07f92e7f750fbcb7d79f74321

data/lib/docx_report.rb

@@ -6,6 +6,8 @@ require 'docx_report/record'
 require 'docx_report/field'
 require 'docx_report/content_file'
 require 'docx_report/hyperlink'
+require 'docx_report/image'
+require 'docx_report/block_value'
 
 module DocxReport
   def self.create_docx_report(template_path)

data/lib/docx_report/block_value.rb

@@ -0,0 +1,11 @@
+module DocxReport
+  module BlockValue
+    def load_value(item)
+      if @value.is_a? Proc
+        @value.call(item)
+      else
+        item.is_a?(Hash) ? item[@value] : item.send(@value)
+      end
+    end
+  end
+end

data/lib/docx_report/data_item.rb

@@ -1,6 +1,6 @@
 module DocxReport
   module DataItem
-    attr_reader :fields, :images
+    attr_reader :fields, :images, :tables
 
     def add_field(name, value, type = :text)
       field = Field.new name, value, type

data/lib/docx_report/document.rb

@@ -3,33 +3,32 @@ require 'nokogiri'
 
 module DocxReport
   class Document
-    attr_accessor :template_path, :files
+    attr_accessor :template_path, :files, :image_ids, :images, :image_types
 
     def initialize(template_path)
+      @images = []
+      @image_types = []
       @template_path = template_path
       zip = Zip::File.open(template_path)
       load_files zip
+      @image_ids = images_ids zip
       zip.close
     end
 
     def save_to_memory
       Zip::OutputStream.write_buffer do |output|
+        add_images output
         add_files output
       end.string
     end
 
     def save_to_file(output_path)
       Zip::OutputStream.open(output_path) do |output|
+        add_images output
         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)
@@ -47,11 +46,12 @@ module DocxReport
     end
 
     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 }
+      if file = @files.detect { |f| f.name == name }
+        add_data name, file.xml.to_xml, output
+      elsif file = @files.detect { |f| f.rels_name == name }
         add_data name, file.rels_xml.to_xml, output if file.rels_has_items?
+      elsif name == CONTENT_TYPE_NAME
+        add_data name, @content_types.to_xml, output
       else
         add_data name, template.read(name), output
       end
@@ -62,17 +62,49 @@ module DocxReport
       output.write data
     end
 
+    def add_images(output)
+      images.each do |image|
+        image.save(output)
+        image.new_rels.each do |rels|
+          rels[:Target] = format(rels[:Target], image.type)
+        end
+        add_content_type image.type
+      end
+    end
+
     def content_types_xpath
       "//*[@ContentType = '#{CONTENT_TYPES.join("' or @ContentType='")}']"
     end
 
     def load_files(zip)
       @files = []
-      content_type_node = Nokogiri::XML zip.read(CONTENT_TYPE_NAME)
-      content_type_node.xpath(content_types_xpath).each do |e|
+      @content_types = Nokogiri::XML zip.read(CONTENT_TYPE_NAME)
+      @content_types.xpath(content_types_xpath).each do |e|
         filename = e['PartName'][1..-1]
         @files << ContentFile.new(filename, zip)
       end
+      find_image_types.each { |type| @image_types << type[:Extension] }
+    end
+
+    def images_ids(zip)
+      zip.entries.map do |e|
+        if e.name.start_with?('word/media/image')
+          (File.basename(e.name, '.*')[5..-1]).to_i
+        end
+      end.compact
+    end
+
+    def find_image_types
+      @content_types.xpath('//*[starts-with(@ContentType, "image")]')
+    end
+
+    def add_content_type(type)
+      unless @image_types.include? type
+        @content_types.children.first << Nokogiri::XML(
+          format('<Default Extension="%s" ContentType="image/%s"/>',
+                 type, type)).children.first
+        @image_types << type
+      end
     end
 
     CONTENT_TYPE_NAME = '[Content_Types].xml'.freeze

data/lib/docx_report/field.rb

@@ -1,5 +1,9 @@
+
+require 'docx_report/block_value'
+
 module DocxReport
   class Field
+    include BlockValue
     attr_reader :name, :value, :type
 
     def initialize(name, value = nil, type = :text, &block)
@@ -12,12 +16,8 @@ module DocxReport
       @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)
+    def load_field(item)
+      Field.new(name[1..-2], load_value(item), type)
     end
   end
 end

data/lib/docx_report/image.rb

@@ -0,0 +1,88 @@
+require 'mini_magick'
+
+module DocxReport
+  class Image
+    attr_accessor :path, :id, :nodes, :files, :new_rels, :type
+
+    def initialize(path, document)
+      @path = path
+      @files = {}
+      @nodes = []
+      @new_rels = []
+      global_id(document)
+    end
+
+    def global_id(document)
+      @id = document.image_ids.max + 1
+      document.image_ids << @id
+      document.images << self
+    end
+
+    def file_image_id(file)
+      new_image_id(file) if files[file.name].nil?
+      files[file.name]
+    end
+
+    def image_ref(id)
+      rels = Nokogiri::XML(
+        format('<Relationship Id="%s" Type="http://schemas.openxmlformats.org/'\
+        'officeDocument/2006/relationships/image" Target="media/image%s.%s"/>',
+               id, @id, '%s')).children.first
+      @new_rels << rels
+      rels
+    end
+
+    def save(output)
+      img = MiniMagick::Image.open(@path)
+      @type = img.type.downcase
+      fix_rels
+      output.put_next_entry "word/media/image#{@id}.#{@type}"
+      img.write output
+      set_dimentions img.width, img.height, img.resolution
+    end
+
+    private
+
+    def fix_rels
+      new_rels.each { |rels| format(rels, @id, @type) }
+    end
+
+    def new_image_id(file)
+      files[file.name] = "rId#{file.new_uniqe_id}"
+      file.rels_xml.children.first << image_ref(files[file.name])
+    end
+
+    def set_dimentions(width, height, resolution)
+      @width = width.to_f / resolution[0] * EMUS_PER_INCH
+      @height = height.to_f / vert_dpi(resolution) * EMUS_PER_INCH
+      fit_in_page
+      @nodes.each do |node|
+        node.xpath('.//*[@cx and @cy]').each do |ext|
+          ext[:cx] = @width.to_i
+          ext[:cy] = @height.to_i
+        end
+      end
+    end
+
+    def vert_dpi(resolution)
+      resolution[resolution.length == 2 ? 1 : 2]
+    end
+
+    def fit_in_page
+      if @width > MAX_WIDTH_EMUS
+        ratio = @height / @width
+        @width = MAX_WIDTH_EMUS
+        @height = MAX_WIDTH_EMUS * ratio
+      end
+      if @height > MAX_HEIGHT_EMUS
+        ratio = @width / @height
+        @height = MAX_HEIGHT_EMUS
+        @width = MAX_HEIGHT_EMUS * ratio
+      end
+    end
+
+    EMUS_PER_INCH = 914400
+    MAX_WIDTH_EMUS = 5742360
+    MAX_HEIGHT_EMUS = 8229600
+  end
+end

data/lib/docx_report/parser.rb

@@ -10,6 +10,7 @@ module DocxReport
       @document.files.each do |file|
         replace_node_fields(fields, file.xml)
         replace_node_hyperlinks(fields, file.xml, file)
+        replace_node_images(fields, file.xml, file)
       end
     end
 
@@ -27,10 +28,15 @@ module DocxReport
 
     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)}']")
+      parent_node.xpath(".//w:hyperlink[@r:id='#{find_by_id(links)}']")
     end
 
-    def find_by_Id(links)
+    def find_image_nodes(name, parent_node)
+      parent_node.xpath(
+        ".//w:drawing[.//wp:docPr[@title='#{name}']]")
+    end
+
+    def find_by_id(links)
       links.map { |link| link[:Id] }.join("' or @r:id='")
     end
 
@@ -52,9 +58,24 @@ module DocxReport
       end
     end
 
+    def replace_node_images(fields, parent_node, file)
+      fields.select { |f| f.type == :image }.each do |field|
+        image = document_image(field.value)
+        find_image_nodes(field.name, parent_node).each do |node|
+          node.xpath('.//*[@r:embed]').first['r:embed'] = image
+                                                          .file_image_id(file)
+          image.nodes << node
+        end
+      end
+    end
+
+    def document_image(path)
+      @document.images.detect { |img| img.path == path } ||
+        Image.new(path, @document)
+    end
+
     def find_table(name, parent_node)
-      parent_node.xpath(".//w:tbl[//w:tblCaption[@w:val='#{name}']][1]")
-                    .first
+      parent_node.xpath(".//w:tbl[//w:tblCaption[@w:val='#{name}']][1]").first
     end
 
     def find_row(table, table_node)
@@ -75,8 +96,10 @@ module DocxReport
       table.records.each do |record|
         new_row = row_node.dup
         row_node.add_previous_sibling new_row
+        fill_tables record.tables, new_row, file
         replace_node_fields record.fields, new_row
         replace_node_hyperlinks record.fields, new_row, file, true
+        replace_node_images record.fields, new_row, file
       end
       row_node.remove
     end

data/lib/docx_report/record.rb

@@ -6,6 +6,7 @@ module DocxReport
 
     def initialize
       @fields = []
+      @tables = []
     end
   end
 end

data/lib/docx_report/report.rb

@@ -3,7 +3,7 @@ require 'docx_report/data_item'
 module DocxReport
   class Report
     include DataItem
-    attr_reader :fields, :tables
+    attr_reader :fields
 
     def initialize(template_path)
       @template_path = template_path
@@ -33,8 +33,8 @@ module DocxReport
 
     def apply_changes(document)
       parser = Parser.new document
-      parser.replace_all_fields @fields
       parser.fill_all_tables @tables
+      parser.replace_all_fields @fields
     end
   end
 end

data/lib/docx_report/table.rb

@@ -1,17 +1,23 @@
+require 'docx_report/block_value'
+
 module DocxReport
   class Table
+    include BlockValue
     attr_reader :name, :has_header, :records
 
-    def initialize(name, has_header = false)
+    def initialize(name, has_header = false, collection = nil, fields = [],
+                   tables = [])
       @name = name
       @has_header = has_header
+      @value = collection
       @records = []
-      @fields = []
+      @fields = fields
+      @tables = tables
     end
 
     def new_record
       new_record = Record.new
-      records << new_record
+      @records << new_record
       new_record
     end
 
@@ -23,12 +29,24 @@ module DocxReport
       @fields << field
     end
 
+    def add_table(name, collection = nil, has_header = false, &block)
+      raise 'duplicate table name' if @tables.any? { |t| t.name == name }
+      table = Table.new name, has_header, collection || block
+      @tables << table
+      table
+    end
+
+    def load_table(item)
+      table = Table.new(name, has_header, nil, @fields, @tables)
+      table.load_records(load_value(item))
+      table
+    end
+
     def load_records(collection)
       collection.each do |item|
         record = new_record
-        @fields.each do |field|
-          record.fields << field.load_value(item)
-        end
+        @tables.each { |table| record.tables << table.load_table(item) }
+        @fields.each { |field| record.fields << field.load_field(item) }
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx_report
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Ahmed Abudaqqa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,21 +38,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
 description: |-
-  docx_report is a light weight gem that generates docx files
-                     by replacing strings and inserting images on previously
-                     created .docx template file
+  docx_report is a gem that generates docx files 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/block_value.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/image.rb
 - lib/docx_report/parser.rb
 - lib/docx_report/record.rb
 - lib/docx_report/report.rb