docxi 0.0.2 → 0.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c090f48de3b5f08211cfcf6772bede9af088528
-  data.tar.gz: 0dda1273cb0c9cdd092a36db7a9448538828dbe6
+SHA256:
+  metadata.gz: 92d0e49fe9e1a189dc7d1cb7dccb3c7e7a3f4877f4b4c56f5cfb2cc779a944de
+  data.tar.gz: 8a0192d020e0471216c6224de46478a7b2ac4a71a04c4a05569f6774ae3c0b76
 SHA512:
-  metadata.gz: 2ada27ba61335c8421b4d8e2dd65757afb79a960b8ffdb20d121d48d3310c042bc9264dd882f3568918c9ca689f9edec5c52beee4a68c70fa3480ac07f843a48
-  data.tar.gz: ba26ae7dfe72ad1e40ce4bfb64602965d31e67e3240a9d9501817d70230442740be4c2e80ab434a4ac549bd03cad1082f0445968a1cd6c5e2ce50f3be2c82845
+  metadata.gz: 1060898ce0f6fe2a1122a98cce52b2220460c96969ea78ebeb576e32f20fadefed3b8b6bd741c623cdc9ae0d4721189fa649ef7e0d04fbf5767852001ac0392f
+  data.tar.gz: 266f7794a16fbad300b520f5d49bf70e6fd15407143e8a3bc54f6b8fff91a32ed7358a498a76ddaca98be92df6a87310c55612da45c5ece198130ad64e9fe63f

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+docxi installs and runs again in current apps, with or without Rails. No code changes are needed, and the generated documents are the same as 0.0.6's (the tests compare them against 0.0.6's output).
+
+### Compatibility
+
+- Requires Ruby 2.5 or newer. Apps on older Rubies stay on 0.0.6.
+- Works with or without Rails, and is tested alongside Rails 5.2 through 8.1.
+- nokogiri `>= 1.8, < 2` instead of `>= 1.6.3, < 1.7`, which conflicted with every Rails version since 6.0.
+- rubyzip `>= 1.3, < 4` instead of `~> 0.9.9`.
+- No longer calls ActiveSupport's `blank?` and `present?`, which only worked when Rails had loaded them.
+
+### Fixes
+
+- Documents written with rubyzip 3 no longer contain Zip64 records, which Google Docs and older LibreOffice versions reject.
+- `add_media` with an image URL works on Ruby 3 again.
+- `add_media` no longer runs a string that starts with `|` as a shell command.
+- `tab` and `frame` no longer raise `NameError`.
+- `document.frame("text")` no longer raises `TypeError`.
+- `page_numbers` in a header no longer raises `NameError`.
+
+### Gem
+
+- New maintainer, homepage and changelog links.
+- Releases require MFA.
+
+## 0.0.6 (2016-10-18)
+
+Last release before the 0.1.0 update.

data/README.md

@@ -11,11 +11,36 @@ Docxi gem provides ability to create docx documents using Ruby.
 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.
+## NOTE
+ Use Latest version of Gem. Old Version has bugs.
+
+## Installation
+
+```ruby
+gem "docxi", "~> 0.1"
+```
+
+## Supported versions
+
+| Dependency | Supported versions |
+|---|---|
+| Ruby | 2.5 or newer |
+| Rails | Not required. Tested alongside Rails 5.2, 6.0, 6.1, 7.0, 7.1, 7.2, 8.0 and 8.1 |
+| nokogiri | 1.8 or newer |
+| rubyzip | 1.3 or newer, including 3.x |
+
+### Upgrading from 0.0.x
+
+Run `bundle update docxi`. The API is unchanged and 0.1.0 generates the same documents as 0.0.6. Apps on a Ruby older than 2.5 stay on 0.0.6 automatically.
 
 ## Usage
 
 ```ruby
-word = Docxi::Document.new
+# default attributes (top: 720,right: 1440,left: 1440,bottom: 720,footer: 200, header: 190)
+word = Docxi::Document.new 
+# or change margins
+# word = Docxi::Document.new(top: 0,right: 0,left: 0,bottom: 0)
+
 document = word.document
 
 # Creates Header
@@ -39,8 +64,8 @@ end
 document.add_footer(footer)
 
 # Creates paragraph
-document.p(size: 16, align: "center") do |p|
-  p.text "Title"
+document.p(size: 12, bold: true, align: "center", color: "000000", fill: "AAAAAA") do |p|
+  p.text "Title", size: 12, bold: true, align: "center", color: "000000"
   # Adds 3 break lines
   p.br times: 3
 end
@@ -103,17 +128,67 @@ document.table( columns_width: [ 316, 160, 135 ] ) do |table|
   end
 end
 
+# Adds table with row height and column indentation
+document.table( columns_width: [ 316, 160, 135 ], height: 268, iwidth: 108) 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
+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')
+  # Or add image URL
+  # media = document.add_media image_url 
   # Insert media into paragraph
   p.image media, style: { width: '200pt', height: '200pt' }
+
+  # Add Hyperlink
+  hyper = document.add_hyperlink("http://google.com")
+  p.hyperlink "Go to Google", "http://google.com", hyper
+
+end
+
+# Add Underline 
+document.p(bottom: true) do |p|
+  p.text "Example text"
+end
+
+# Set position of Paragraph
+document.p(fill: "d7d7d7",align: "center", right: -1000, left: -1000) do |p| 
+  p.text "Example Text 2"
+  p.br
 end
 
 # Creates Word Document
 io = word.render
 File.open('doc_1.docx', 'wb'){|f| f.write(io.string) }
-```
+```
+
+## Development
+
+```sh
+bundle install
+bundle exec rake test       # run the tests
+bundle exec rake samples    # write tmp/samples/*.docx to open in Word, LibreOffice or Google Docs
+
+# run the tests with a specific Rails version loaded
+BUNDLE_GEMFILE=gemfiles/rails_8.1.gemfile bundle install
+BUNDLE_GEMFILE=gemfiles/rails_8.1.gemfile DOCXI_WITH_RAILS=1 bundle exec rake test
+```
+
+`test/golden` holds the XML that 0.0.6 generated for the sample documents in `test/support/sample_documents.rb`, and the tests check every release against it. After an intentional change to the generated XML, update it with `bundle exec rake golden` and review the diff.

data/Rakefile

@@ -4,6 +4,34 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.warning = false
+end
+
+desc 'Rewrite test/golden from the current code (only after an intentional output change)'
+task :golden do
+  $LOAD_PATH.unshift File.expand_path('lib', __dir__)
+  require 'docxi'
+  require_relative 'test/support/package'
+  require_relative 'test/support/sample_documents'
+
+  SampleDocuments.all.each do |name, word|
+    Package.write_golden(File.join(__dir__, 'test', 'golden', name), word.render.string)
+  end
+end
+
+desc 'Write the sample documents to tmp/samples for opening in Word, LibreOffice or Google Docs'
+task :samples do
+  $LOAD_PATH.unshift File.expand_path('lib', __dir__)
+  require 'docxi'
+  require 'fileutils'
+  require_relative 'test/support/sample_documents'
+
+  FileUtils.mkdir_p('tmp/samples')
+  SampleDocuments.all.each do |name, word|
+    File.binwrite("tmp/samples/#{name}.docx", word.render.string)
+    puts "tmp/samples/#{name}.docx"
+  end
 end
 
 desc "Run tests"

data/lib/docxi/content_types.rb

@@ -11,6 +11,7 @@ module Docxi
       add(:default, "rels", "application/vnd.openxmlformats-package.relationships+xml")
       add(:default, "xml", "application/xml")
       add(:default, "png", "image/png")
+      add(:override, "/_rels/.rels","application/vnd.openxmlformats-package.relationships+xml")
       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")
@@ -24,7 +25,11 @@ module Docxi
       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/footer2.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml")
       add(:override, "/word/header1.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml")
+      add(:override, "/word/header2.xml", "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml")
+      add(:override, "/word/_rels/header2.xml.rels", "application/vnd.openxmlformats-package.relationships+xml")
+      add(:override, "/word/_rels/document.xml.rels", "application/vnd.openxmlformats-package.relationships+xml")
     end
 
     def add(type, attr, content)
@@ -34,8 +39,7 @@ module Docxi
     end
 
     def render(zip)
-      zip.put_next_entry('[Content_Types].xml')
-      zip.write(Docxi.to_xml(document))
+      Docxi.write_entry(zip, '[Content_Types].xml', Docxi.to_xml(document))
     end
 
     private

data/lib/docxi/document.rb

@@ -1,10 +1,10 @@
 module Docxi
   class Document
 
-    attr_accessor :document, :properties, :relationships, :content_types
+    attr_accessor :document, :properties, :relationships, :content_types, :options
 
-    def initialize
-      
+    def initialize(options = {top: 720,right: 1440,left: 1440,bottom: 720,footer: 200, header: 190})
+      @options = options
     end
 
     def relationships
@@ -20,11 +20,11 @@ module Docxi
     end
 
     def document
-      @document ||= Word::Document.new({})
+      @document ||= Word::Document.new(options)
     end
 
     def render
-      Zip::ZipOutputStream.write_buffer do |zip|
+      Zip::OutputStream.write_buffer do |zip|
         document.render(zip)
         properties.render(zip)
         relationships.render(zip)

data/lib/docxi/properties.rb

@@ -18,11 +18,9 @@ module Docxi
     end
 
     def render(zip)
-      zip.put_next_entry('docProps/app.xml')
-      zip.write(Docxi.to_xml(app.document))
+      Docxi.write_entry(zip, 'docProps/app.xml', Docxi.to_xml(app.document))
 
-      zip.put_next_entry('docProps/core.xml')
-      zip.write(Docxi.to_xml(core.document))
+      Docxi.write_entry(zip, 'docProps/core.xml', Docxi.to_xml(core.document))
     end
 
   end

data/lib/docxi/relationships.rb

@@ -21,8 +21,7 @@ module Docxi
     end
 
     def render(zip)
-      zip.put_next_entry('_rels/.rels')
-      zip.write(Docxi.to_xml(document))
+      Docxi.write_entry(zip, '_rels/.rels', Docxi.to_xml(document))
     end
 
     private

data/lib/docxi/util.rb

@@ -0,0 +1,19 @@
+module Docxi
+  module Util
+
+    # Same rules as ActiveSupport's Object#blank?, which older versions of this
+    # gem called without depending on ActiveSupport.
+    def self.blank?(value)
+      case value
+      when nil, false then true
+      when String then /\A[[:space:]]*\z/ === value
+      else value.respond_to?(:empty?) ? !!value.empty? : false
+      end
+    end
+
+    def self.present?(value)
+      !blank?(value)
+    end
+
+  end
+end

data/lib/docxi/version.rb

@@ -1,3 +1,3 @@
 module Docxi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0.rc1"
 end

data/lib/docxi/word/contents/frame.rb

@@ -0,0 +1,84 @@
+module Docxi
+  module Word
+    module Contents
+
+      class Frame
+
+        attr_accessor :content, :options
+        def initialize(options={})
+          @content = []
+          @options = options
+          if block_given?
+            yield self
+          else
+
+          end
+        end
+
+        def render(xml)
+          xml['w'].r do
+            xml['w'].pict do
+              xml['v'].rect("fillcolor"=>"#bfbfbf[2412]", "strokecolor"=>"000000","strokeweight"=>"0pt", "style"=> @options[:style]) do
+                xml['v'].fill("opacity" =>"52429f")
+                xml['v'].textbox("inset" => "0in,0in,0in,0in") do 
+                  xml['w'].txbxContent do
+                    xml['w'].p do
+                      xml['w'].pPr do
+                      xml['w'].pStyle('w:val'=>"Normal")
+                        xml['w'].pBdr do
+                          xml['w'].top('w:val'=>"nil")
+                          xml['w'].left('w:val'=>"nil")
+                          xml['w'].bottom('w:val'=>"nil")
+                          xml['w'].right('w:val'=>"nil")
+                        end
+                        if @options[:spacing]
+                          xml['w'].spacing('w:before'=>"240")
+                        end
+                      end
+                      @content.each do |element|
+                        element.render(xml)
+                      end
+                    end
+                  end
+                end
+              xml['w10'].wrap('type'=>"topAndBottom")
+              end
+            end
+          end
+        end
+
+        def br(options={})
+          br = Docxi::Word::Contents::Break.new(options)
+          @content << br
+          br
+        end
+
+        def tab(options={})
+          tab = Docxi::Word::Contents::Tab.new(options)
+          @content << tab
+          tab
+        end
+
+        def frame(options={}, &block)
+          element = Docxi::Word::Contents::Frame.new(options, &block)
+          @content << element
+          element
+        end
+
+        def text(text, options={})
+          options = @options.merge(options)
+          text = Docxi::Word::Contents::Text.new(text, options)
+          @content << text
+          text
+        end
+
+        def image(image, options={})
+          img = Docxi::Word::Contents::Image.new(image, options)
+          @content << img
+          img
+        end
+
+      end
+    end
+  end
+end

data/lib/docxi/word/contents/image.rb

@@ -7,7 +7,7 @@ module Docxi
         attr_accessor :media, :options
         def initialize(media, options={})
           @media = media
-          @media.file.rewind
+          # @media.file.rewind
           @options = options
         end
 
@@ -19,16 +19,80 @@ module Docxi
 
         def render(xml)
           xml['w'].r do
-            xml['w'].rPr do
-              xml['w'].noProof
-            end
-            xml['w'].pict do
-              xml['v'].shape( 'id' => @media.uniq_id, 'type' => @media.type, 'style' => styles ) do
-                xml['v'].imagedata( 'r:id' => @media.sequence, 'o:title' => @options[:title] )
+            if options[:pH] and options[:pV] and options[:wrap]
+              xml['w'].drawing do
+                xml['wp'].anchor( "behindDoc" => 1 ,"distT" => 0,"distB" => 0, "distL" => 0, "distR" => 0 ,"simplePos" => 0 ,"locked" => 0, "layoutInCell" => 1, "allowOverlap" => 1, "relativeHeight" => 3) do
+                  xml['wp'].simplePos('x'=> 0 , 'y' => 0 )
+                  xml['wp'].positionH("relativeFrom" => "column") do
+                    xml['wp'].posOffset options[:pH] 
+                  end
+                  xml['wp'].positionV("relativeFrom" => "paragraph") do
+                    xml['wp'].posOffset options[:pV] 
+                  end
+                  xml['wp'].extent( 'cx' => ( options[:width] * options[:height] * 14.92 ).to_i, 'cy' => ( options[:width] * options[:height] * 14.92 ).to_i ) if options[:width] && options[:height]
+                  xml['wp'].effectExtent( 'l' => 0, 't' => 0, 'r' => 0, 'b' => 0 )
+                  xml['wp'].wrapNone
+                  xml['wp'].docPr( 'id' => 1, 'name'=> "Image", 'descr' => "image")
+                  xml['wp'].cNvGraphicFramePr do
+                    xml.graphicFrameLocks( 'xmlns:a' => "http://schemas.openxmlformats.org/drawingml/2006/main", 'noChangeAspect' => "1" ) do
+                      xml.parent.namespace = xml.parent.namespace_definitions.find{|ns| ns.prefix == "a" }
+                    end
+                  end
+                  xml.graphic( 'xmlns:a' => "http://schemas.openxmlformats.org/drawingml/2006/main" ) do
+                    xml.parent.namespace = xml.parent.namespace_definitions.find{|ns| ns.prefix == "a" }
+                    xml['a'].graphicData( 'uri' => "http://schemas.openxmlformats.org/drawingml/2006/picture") do
+                      xml.pic( 'xmlns:pic' => "http://schemas.openxmlformats.org/drawingml/2006/picture") do
+                        xml.parent.namespace = xml.parent.namespace_definitions.find{|ns| ns.prefix == "pic" }
+                        xml['pic'].nvPicPr do
+                          xml['pic'].cNvPr( 'id' => 0, 'name' => "Image" )
+                          xml['pic'].cNvPicPr do
+                            xml['a'].picLocks( 'noChangeAspect' => "1", 'noChangeArrowheads' => "1" )
+                          end
+                        end
+                        xml['pic'].blipFill do
+                          xml['a'].blip( 'r:embed' => @media.sequence )
+                          xml['a'].stretch do
+                            xml['a'].fillRect
+                          end
+                        end
+                        xml['pic'].spPr( 'bwMode' => "auto" ) do
+                          xml['a'].xfrm do
+                            xml['a'].off( 'x' => 0, 'y' => 0 )
+                            xml['a'].ext( 'cx' => ( options[:width] * options[:height] * 14.92 ).to_i, 'cy' => ( options[:width] * options[:height] * 14.92).to_i ) if options[:width] && options[:height]
+                          end
+                          xml['a'].prstGeom( 'prst' => "rect" ) do
+                            xml['a'].avLst
+                          end
+                          xml['a'].noFill
+                          xml['a'].ln('w' => "9525") do
+                            xml['a'].noFill
+                            xml['a'].miter('lim'=>"800000")
+                            xml['a'].headEnd
+                            xml['a'].tailEnd
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            else  
+              xml['w'].pict do
+                unless options[:fill_color]
+                  xml['v'].rect( 'id' => @media.uniq_id, 'type' => @media.type, 'style' => styles, :stroked => "f" ) do
+                    xml['v'].imagedata( 'r:id' => @media.sequence, 'o:title' => @options[:title] )
+                    xml['v'].wrap('v:type' => 'none') if options[:wrap]
+                  end
+                else
+                  xml['v'].rect("fillcolor"=> options[:fill_color], 'id' => @media.uniq_id, 'type' => @media.type, 'style' => styles, :stroked => "f" ) do
+                    if Docxi::Util.present?(options[:opacity])
+                      xml['v'].fill("opacity" => options[:opacity])
+                    end
+                    xml['v'].imagedata( 'r:id' => @media.sequence, 'o:title' => @options[:title] )
+                    xml['v'].wrap('v:type' => 'none') if options[:wrap]
+                  end
+                end
               end
-            end
-            xml['w'].rPr do
-              xml['w'].noProof
             end
           end
         end

data/lib/docxi/word/contents/paragraph.rb

@@ -4,10 +4,11 @@ module Docxi
 
       class Paragraph
 
-        attr_accessor :content, :options
+        attr_accessor :content, :options, :relationships, :id
         def initialize(options={})
           @content = []
           @options = options
+          @relationships = []
 
           if block_given?
             yield self
@@ -16,16 +17,70 @@ module Docxi
           end
         end
 
+        def content_type
+          "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
+        end
+
+        def target
+          "document.xml"
+        end
+
+
+        def hyperlink(text,link,id)
+          text = Hyperlink.new(text, link, id)
+          @content << text
+        end
+
+        class Hyperlink
+          attr_accessor :text, :link, :id 
+          def initialize(text, link, id )
+            @text = text
+            @link = link
+            @id = id
+          end
+
+          def content_type
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
+          end
+
+          def render(xml)
+            xml['w'].pPr do
+              xml['w'].pStyle('w:val' => "Normal")
+              xml['w'].rPr do 
+                xml['w'].rStyle('w:val' => "InternetLink")
+              end
+            end
+            xml['w'].hyperlink('r:id' => @id) do 
+              xml['w'].r do
+                xml['w'].rPr do
+                  xml['w'].rStyle( 'w:val' => "InternetLink")
+                end
+                xml['w'].t @text
+              end
+            end
+          end
+        end
+        
         def render(xml)
           xml['w'].p do
             xml['w'].pPr do
               xml['w'].jc( 'w:val' => @options[:align]) if @options[:align]
+              xml['w'].shd( 'w:val' => 'clear','w:fill' => @options[:fill] ) if @options[:fill]
+              xml['w'].ind( 'w:left' => @options[:left], 'w:right' => @options[:right] ) if @options[:left] and @options[:right]
               if options[:ul]
                 xml['w'].numPr do
                   xml['w'].ilvl( 'w:val' => 0 )
                   xml['w'].numId( 'w:val' => 1 )
                 end
               end
+              if options[:bottom]
+                xml['w'].pBdr do
+                  xml['w'].top( 'w:val' => "nil")
+                  xml['w'].left('w:val' => "nil")
+                  xml['w'].bottom('w:val'=>"single", 'w:sz'=>"4", 'w:space'=>"1", 'w:color'=>"000000")
+                  xml['w'].right('w:val'=>"nil")
+                end
+              end
             end
             @content.each do |element|
               element.render(xml)
@@ -40,12 +95,24 @@ module Docxi
           text
         end
 
+        def frame(options={}, &block)
+          element = Docxi::Word::Contents::Frame.new(options, &block)
+          @content << element
+          element
+        end
+
         def br(options={})
           br = Docxi::Word::Contents::Break.new(options)
           @content << br
           br
         end
 
+        def tab(options={})
+          tab = Docxi::Word::Contents::Tab.new(options)
+          @content << tab
+          tab
+        end
+
         def image(image, options={})
           img = Docxi::Word::Contents::Image.new(image, options)
           @content << img

data/lib/docxi/word/contents/tab.rb

@@ -0,0 +1,33 @@
+module Docxi
+  module Word
+    module Contents
+
+      class Tab
+
+        attr_accessor :options
+        def initialize(options={})
+          @options = options
+          @options[:times] ||= 1
+        end
+
+        def render(xml)
+          if @options[:page]
+            xml['w'].p do
+              xml['w'].r do
+                xml['w'].tab
+              end
+            end
+          else
+            @options[:times].times do
+              xml['w'].r do
+                xml['w'].tab
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end