docxer 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a012fa9eb5553b91d77c00ea040618f646eb9968
+  data.tar.gz: c905f121249032839c8a0f420d5f6a558aa7ffa4
+SHA512:
+  metadata.gz: f049b16bc00315cae6605fdafe14aacf9be7de1d8fdeb676184793016ba8b745109bd0c462eeabd8183c10afb8ea2f600f07046f7486cc8f87909f3c347ed31e
+  data.tar.gz: 85332d781045ba12b3e961100c4ccee41f01a8d7d3d838c355dca7bc6cfc1f83ec43148535d833dacc1c5edcbe585c99f9697afd0b3685514f691eaa63e70138

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Timur Gabdrakipov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,119 @@
+Docxer gem provides ability to create docx documents using Ruby.
+
+## Features
+
+1. Paragraphs
+2. Text formatting
+3. Header and Footer (limited)
+4. Tables (limited)
+5. Images
+6. Table of Content
+7. Page Numbering
+
+At the moment, the gem supports a limited number of functions, but the development of the gem is still in progress, and perhaps functionality will be expanded in the future. First of all, try to add documentation for the code and tests.
+
+## Usage
+
+```ruby
+word = Docxer::Document.new
+document = word.document
+
+# Creates Header
+header = Docxer::Word::Headers::Header.new do |h|
+  # Inserts image into header
+  header_logo = document.add_media File.open('logo.png')
+  h.image header_logo, align: 'right', width: 100, height: 100
+end
+
+# Adds header
+document.add_header(header)
+
+# Creates Footer
+footer = Docxer::Word::Footers::Footer.new do |f|
+  # Adds footer text
+  f.text "Footer Text", size: 8, align: 'center'
+  # Adds page numbers
+  f.page_numbers
+end
+# Adds footer
+document.add_footer(footer)
+
+# Creates paragraph
+document.p(size: 16, align: "center") do |p|
+  p.text "Title"
+  # Adds 3 break lines
+  p.br times: 3
+end
+
+document.p do |p|
+  # Adds text with specific styles
+  p.text "Subtitle", size: 14, color: '568AB2', bold: true
+end
+
+# Adds break page
+document.br(page: true)
+
+
+# Adds TOC
+document.text "Table of Content", size: 18, color: 'D36C8A', bold: true
+document.table_of_content(size: 14, bold: true) do |table|
+  # Adds TOC element
+  table.add_row("Table", 1)
+end
+
+# Adds break page
+document.br(page: true)
+
+# Adds table
+document.table( columns_width: [ 316, 160, 135 ] ) do |table|
+  # Adds row with specific styles
+  table.tr(fill: "FBD4B4", bold: true, align: 'center' ) do |tr|
+    # Adds cells
+    tr.tc(borders: { top: 1, right: nil, bottom: 1, left: 1 }) do |tc|
+      tc.text "Header 1"
+    end
+    tr.tc(borders: { top: 1, right: nil, bottom: 1, left: nil }) do |tc|
+      tc.text "Header 2"
+    end
+    tr.tc(borders: { top: 1, right: 1, bottom: 1, left: nil }) do |tc|
+      tc.text "Header 3"
+    end
+  end
+
+  # Adds another row
+  table.tr(align: 'center') do |tr|
+    # Adds rowspan
+    tr.tc(rowspan: true, borders: { top: 1, right: 1, bottom: 1, left: 1 }, valign: 'center') do |tc|
+      tc.text "Rowspan", align: 'left'
+    end
+    tr.tc(borders: { top: 1, right: 1, bottom: 1, left: 1 }) do |tc|
+      tc.text "Cell Value 2"
+    end
+    tr.tc(borders: { top: 1, right: 1, bottom: 1, left: 1 }) do |tc|
+      tc.text "Cell Value 3"
+    end
+  end
+
+  table.tr(fill: "D9D9D9", bold: true, align: 'center' ) do |tr|
+    tr.tc(borders: { top: 1, right: 1, bottom: 1, left: 1 }, merged: true) # Use with rowspan to mark cell as merged
+    # Adds colspan
+    tr.tc(colspan: 2, valign: 'bottom', borders: { top: 1, right: 1, bottom: 1, left: 1 }) do |tc|
+      tc.text "Colspan"
+    end
+  end
+end
+
+# Adds image
+document.p do |p|
+  p.text "Image Example", size: 16, bold: true, italic: true, underline: true, br: true
+
+  # Adds image to container
+  media = document.add_media File.open('image.png')
+  # Insert media into paragraph
+  p.image media, style: { width: '200pt', height: '200pt' }
+end
+
+# Creates Word Document
+io = word.render
+File.open('doc_1.docx', 'wb'){|f| f.write(io.string) }
+```

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/docxer.rb

@@ -0,0 +1,29 @@
+require 'nokogiri'
+require 'zip/zip'
+
+require 'docxer/relationships'
+require 'docxer/content_types'
+require 'docxer/properties'
+require 'docxer/word'
+require 'docxer/document'
+
+module Docxer
+
+  def self.to_xml(document)
+    document.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML).gsub("\n", "\r\n").strip
+  end
+
+  def self.test
+    word = Docxer::Document.new
+
+    word.document.break
+    word.document.break
+    word.document.break
+
+    file = word.render
+    File.open('test.docx', 'wb') do |f|
+      f.write(file.string)
+    end
+  end
+
+end

data/lib/docxer/content_types.rb

@@ -0,0 +1,68 @@
+require 'docxer/content_types/default'
+require 'docxer/content_types/override'
+
+module Docxer
+  class ContentTypes
+
+    attr_accessor :content_types
+
+    def initialize
+      @content_types = []
+      add(:default, "rels", "application/vnd.openxmlformats-package.relationships+xml")
+      add(:default, "xml", "application/xml")
+      add(:default, "png", "image/png")
+      add(:override, "/word/document.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml")
+      add(:override, "/word/styles.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml")
+      add(:override, "/word/stylesWithEffects.xml", "application/vnd.ms-word.stylesWithEffects+xml")
+      add(:override, "/word/settings.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml")
+      add(:override, "/word/webSettings.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.webSettings+xml")
+      add(:override, "/word/fontTable.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml")
+      add(:override, "/word/theme/theme1.xml", "application/vnd.openxmlformats-officedocument.theme+xml")
+      add(:override, "/docProps/core.xml", "application/vnd.openxmlformats-package.core-properties+xml")
+      add(:override, "/docProps/app.xml", "application/vnd.openxmlformats-officedocument.extended-properties+xml")
+      add(:override, "/word/numbering.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml")
+      add(:override, "/word/footnotes.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml")
+      add(:override, "/word/endnotes.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml")
+      add(:override, "/word/footer1.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml")
+      add(:override, "/word/header1.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml")
+    end
+
+    def add(type, attr, content)
+      content_type = create_content_type(type, attr, content)
+      @content_types << content_type if content_type
+      content_type
+    end
+
+    def render(zip)
+      zip.put_next_entry('[Content_Types].xml')
+      zip.write(Docxer.to_xml(document))
+    end
+
+    private
+    def document
+      Nokogiri::XML::Builder.with(Nokogiri::XML('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>')) do |xml|
+        xml.Types(xmlns: 'http://schemas.openxmlformats.org/package/2006/content-types') do
+          @content_types.each do |content_type|
+            content_type.build(xml)
+          end
+        end
+      end
+    end
+
+    # TODO: Need to rewrite create_content_type method
+    def create_content_type(type, attr, content)
+      send(:"create_#{type.to_s}", attr, content)
+    rescue
+      nil
+    end
+
+    def create_default(attr, content)
+      Default.new(attr, content)
+    end
+
+    def create_override(attr, content)
+      Override.new(attr, content)
+    end
+
+  end
+end

data/lib/docxer/content_types/default.rb

@@ -0,0 +1,18 @@
+module Docxer
+  class ContentTypes
+    class Default
+
+      attr_accessor :extension, :content_type
+
+      def initialize(extension, content_type)
+        @extension = extension
+        @content_type = content_type
+      end
+
+      def build(xml)
+        xml.Default('Extension' => @extension, 'ContentType' => @content_type)
+      end
+
+    end
+  end
+end

data/lib/docxer/content_types/override.rb

@@ -0,0 +1,18 @@
+module Docxer
+  class ContentTypes
+    class Override
+      
+      attr_accessor :part_name, :content_type
+
+      def initialize(part_name, content_type)
+        @part_name = part_name
+        @content_type = content_type
+      end
+
+      def build(xml)
+        xml.Override('PartName' => @part_name, 'ContentType' => @content_type)
+      end
+
+    end
+  end
+end

data/lib/docxer/document.rb

@@ -0,0 +1,36 @@
+module Docxer
+  class Document
+
+    attr_accessor :document, :properties, :relationships, :content_types
+
+    def initialize
+      
+    end
+
+    def relationships
+      @relationships ||= Relationships.new
+    end
+
+    def properties
+      @properties ||= Properties.new({})
+    end
+
+    def content_types
+      @content_types ||= ContentTypes.new
+    end
+
+    def document
+      @document ||= Word::Document.new({})
+    end
+
+    def render
+      Zip::ZipOutputStream.write_buffer do |zip|
+        document.render(zip)
+        properties.render(zip)
+        relationships.render(zip)
+        content_types.render(zip)
+      end
+    end
+
+  end
+end

data/lib/docxer/properties.rb

@@ -0,0 +1,29 @@
+require 'docxer/properties/app'
+require 'docxer/properties/core'
+
+module Docxer
+  class Properties
+    attr_accessor :options, :app, :core
+
+    def initialize(options)
+      @options = options
+    end
+
+    def app
+      @app ||= App.new(@options)
+    end
+
+    def core
+      @core ||= Core.new(@options)
+    end
+
+    def render(zip)
+      zip.put_next_entry('docProps/app.xml')
+      zip.write(Docxer.to_xml(app.document))
+
+      zip.put_next_entry('docProps/core.xml')
+      zip.write(Docxer.to_xml(core.document))
+    end
+
+  end
+end

data/lib/docxer/properties/app.rb

@@ -0,0 +1,37 @@
+module Docxer
+  class Properties
+    class App
+
+      attr_accessor :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def document
+        Nokogiri::XML::Builder.with(Nokogiri::XML('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>')) do |xml|
+          xml.Properties('xmlns' => "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties", 'xmlns:vt' => "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes") do
+            xml.Template "Normal.dotm"
+            xml.TotalTime 0
+            xml.Pages 1
+            xml.Words 0
+            xml.Characters 0
+            xml.Application "Docxer Ruby Gem"
+            xml.DocSecurity 0
+            xml.Lines 0
+            xml.Paragraphs 0
+            xml.ScaleCrop false
+            xml.Company options[:creator]
+            xml.LinksUpToDate false
+            xml.CharactersWithSpaces 0
+            xml.SharedDoc false
+            xml.HyperlinksChanged false
+            xml.AppVersion "14.0000"
+          end
+        end
+      end
+
+
+    end
+  end
+end

data/lib/docxer/properties/core.rb

@@ -0,0 +1,32 @@
+module Docxer
+  class Properties
+    class Core
+      
+      attr_accessor :options
+
+      def initialize(options)
+        @options = options
+      end
+      
+      def document
+        Nokogiri::XML::Builder.with(Nokogiri::XML('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>')) do |xml|
+          xml.coreProperties('xmlns:cp' => 'http://schemas.openxmlformats.org/package/2006/metadata/core-properties', 'xmlns:dc' => 'http://purl.org/dc/elements/1.1/', 'xmlns:dcterms' => 'http://purl.org/dc/terms/', 'xmlns:dcmitype' => 'http://purl.org/dc/dcmitype/', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance') do
+            xml.parent.namespace = xml.parent.namespace_definitions.find{|ns| ns.prefix=="cp" }
+            # xml['dc'].title options[:title]
+            xml['dc'].creator do
+              options[:creator]
+            end
+            xml['cp'].lastModifiedBy do
+              options[:creator]
+            end
+            xml['cp'].revision 1
+            xml['dcterms'].created(Time.now.strftime('%Y-%m-%dT%H:%M:%SZ'), 'xsi:type' => 'dcterms:W3CDTF')
+            xml['dcterms'].modified(Time.now.strftime('%Y-%m-%dT%H:%M:%SZ'), 'xsi:type' => 'dcterms:W3CDTF')
+          end
+        end
+      end
+      
+
+    end
+  end
+end

data/lib/docxer/relationships.rb

@@ -0,0 +1,49 @@
+require 'docxer/relationships/relationship'
+
+module Docxer
+  class Relationships
+    @@prefix = 'rId'
+
+    attr_accessor :relationships
+
+    def initialize
+      @relationships = []
+      @counter = 0
+      add("http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument", "word/document.xml")
+      add("http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties", "docProps/core.xml")
+      add("http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties", "docProps/app.xml")
+    end
+
+    def add(type, target)
+      relationship = create_relationship(sequence, type, target)
+      @relationships << relationship if relationship
+      relationship
+    end
+
+    def render(zip)
+      zip.put_next_entry('_rels/.rels')
+      zip.write(Docxer.to_xml(document))
+    end
+
+    private
+    def document
+      Nokogiri::XML::Builder.with(Nokogiri::XML('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>')) do |xml|
+        xml.Relationships(xmlns: 'http://schemas.openxmlformats.org/package/2006/relationships') do
+          @relationships.each do |relationship|
+            relationship.build(xml)
+          end
+        end
+      end
+    end
+
+    def create_relationship(id, type, target)
+      Relationship.new(id, type, target)
+    end
+
+    def sequence
+      @counter += 1
+      @@prefix + @counter.to_s
+    end
+
+  end
+end