docx_report 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab70cd0d8827c7a3041f074932345bf11caa7686
+  data.tar.gz: bf99859695067c5eff160c2f57972a6f7ca2a3c0
+SHA512:
+  metadata.gz: 577280cb7c9f90409b49a2d77744a8265a5e040dc060c59b2d1c20bd3e835548af1b3555f41a3ba31ec03782041f0436394f280bcdd2f5c00856a83880dc8ebe
+  data.tar.gz: de34a65eca9cccc643ba842e33316ce6fe37bee1da8d768f22062645e95ff2f249dbbdae9e586e3e9cdafeef601869ac31436af567cc938765e482fb98094c1d

data/lib/docx_report.rb

@@ -0,0 +1,11 @@
+require 'docx_report/report'
+require 'docx_report/document'
+require 'docx_report/parser'
+require 'docx_report/table'
+require 'docx_report/record'
+
+module DocxReport
+  def self.create_docx_report(template_path)
+    Report.new template_path
+  end
+end

data/lib/docx_report/document.rb

@@ -0,0 +1,54 @@
+require 'zip'
+require 'nokogiri'
+
+module DocxReport
+  class Document
+    attr_reader :template_path, :files
+
+    def initialize(template_path)
+      @template_path = template_path
+      zip = Zip::File.open(template_path)
+      @files = load_files zip
+      zip.close
+    end
+
+    def save(output_path)
+      zip = Zip::File.open @template_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)
+          end
+        end
+      end
+      zip.close()
+    end
+
+    private
+
+    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|
+        filename = e['PartName'][1..-1]
+        @files[filename] = Nokogiri::XML zip.read(filename)
+      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'
+    ].freeze
+  end
+end

data/lib/docx_report/parser.rb

@@ -0,0 +1,62 @@
+require 'nokogiri'
+
+module DocxReport
+  class Parser
+    def initialize(document)
+      @document = document
+    end
+
+    def replace_all_fields(fields)
+      @document.files.values.each do |xml_element|
+        replace_element_fields(fields, xml_element)
+      end
+    end
+
+    def fill_all_tables(tables)
+      @document.files.values.each do |xml_element|
+        fill_element_tables(tables, xml_element)
+      end
+    end
+
+    private
+
+    def search_for_text(name, parent_element)
+      parent_element.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
+        end
+      end
+    end
+
+    def find_table(name, parent_element)
+      parent_element.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
+    end
+
+    def fill_element_tables(tables, parent_element)
+      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
+      end
+    end
+  end
+end

data/lib/docx_report/record.rb

@@ -0,0 +1,13 @@
+module DocxReport
+  class Record
+    attr_accessor :fields
+
+    def initialize
+      @fields = {}
+    end
+
+    def add_field(name, value)
+      fields["{@#{name}}"] = value
+    end
+  end
+end

data/lib/docx_report/report.rb

@@ -0,0 +1,39 @@
+require 'tempfile'
+
+module DocxReport
+  class Report
+    attr_reader :fields, :tables
+
+    def initialize(template_path)
+      @template_path = template_path
+      @fields = {}
+      @tables = []
+    end
+
+    def add_field(name, value)
+      @fields["{@#{name}}"] = value
+    end
+
+    def add_table(name, collection = nil, has_header = false)
+      table = Table.new name, has_header
+      @tables << table
+      yield table
+      table.load_records collection if collection
+    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
+      end
+    end
+  end
+end

data/lib/docx_report/table.rb

@@ -0,0 +1,38 @@
+module DocxReport
+  class Table
+    attr_accessor :name, :has_header, :records
+
+    def initialize(name, has_header = false)
+      @name = name
+      @has_header = has_header
+      @records = []
+      @fields = []
+    end
+
+    def new_record
+      new_record = Record.new
+      records << new_record
+      new_record
+    end
+
+    def add_field(name, mapped_field)
+      @fields << { name: name, mapped_field: mapped_field }
+    end
+
+    def load_records(collection)
+      collection.each do |item|
+        record = new_record
+        @fields.each do |field|
+          record.add_field field[:name],
+                           mapped_value(item, field[:mapped_field])
+        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

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: docx_report
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Ahmed Abudaqqa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: |-
+  docx_report is a light weight gem that generates docx files
+                     by replacing strings on previously created .docx file
+email: ahmed@abudaqqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/docx_report.rb
+- lib/docx_report/document.rb
+- lib/docx_report/parser.rb
+- lib/docx_report/record.rb
+- lib/docx_report/report.rb
+- lib/docx_report/table.rb
+homepage: https://github.com/abudaqqa/docx_report
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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
+test_files: []