open_xml_package 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4810bfc241d1304a49265a41d83d1001dfc82b98
-  data.tar.gz: f79a5e20f1fff7efde22611227989c10a1c3c172
+  metadata.gz: 2b72f5c67d5a18d27b73e969c287d3901d5180ae
+  data.tar.gz: 3136fa54c21681c6f1d7025480befbf286313ddf
 SHA512:
-  metadata.gz: ad48be06ceb26837ae2666f56ec8b58ba5bd8cdbe9d58ca9708c5f9a24db0ee9ce589edb02746581a66f84d01b5ac56e43ac68a3e40a95a714627b98a0a67d12
-  data.tar.gz: 965b5eb3ba83acb311bae0589ebd0d56483a17bb379cc7f812a2420a871a239fa1ccad65f82c3bff6ff7e0bc44561620d35d66416f8aaa2a71adbeb582d8e12e
+  metadata.gz: 5fe55147d26a022c6be62eae2cfb5b292198999cd4f0cfa8438c8bcb0019d6af798b7889597b544d92149c44081335425a9076a2716d73a0461180b8f4c0ec27
+  data.tar.gz: 227b72c1f194c1bdba20b656522b7d6c4c2dd6f742d7b1e2b47e019286f9a5956b3b932b2d80185ba3faff2e39f44ca5ca04d597440cb9bb2e00f52e6974a461

data/README.md

@@ -1,6 +1,9 @@
 # OpenXmlPackage
 
-TODO: Write a gem description
+A Ruby implementation of [DocumentFormat.OpenXml.Packaging.OpenXmlPackage](http://msdn.microsoft.com/en-us/library/documentformat.openxml.packaging.openxmlpackage_members(v=office.14).aspx) from Microsoft's Open XML SDK.
+
+
+
 
 ## Installation
 
@@ -16,9 +19,34 @@ Or install it yourself as:
 
     $ gem install open_xml_package
 
+
+
+
 ## Usage
 
-TODO: Write usage instructions here
+#### Writing
+
+You can assemble an Open XML Package in-memory and then write it to disk:
+
+```ruby
+package = OpenXmlPackage.new
+package.add_part "content/document.xml", "<document></document>"
+package.add_part "media/image.png", File.open(image_path, "rb", &:read)
+package.write_to "~/Desktop/output.zip"
+```
+
+
+#### Reading
+
+You can read the contents of an Open XML Package:
+
+```ruby
+OpenXmlPackage.open("~/Desktop/output.zip") do |package|
+  package.parts.map(&:path) # => ["content/document.xml", "media/image.png"]
+end
+```
+
+
 
 ## Contributing
 
@@ -27,3 +55,10 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+#### Reference
+
+ - [DocumentFormat.OpenXml.Packaging.OpenXmlPackage](http://msdn.microsoft.com/en-us/library/documentformat.openxml.packaging.openxmlpackage_members(v=office.14).aspx)
+ - [DocumentFormat.OpenXml.Packaging.OpenXmlPartContainer](http://msdn.microsoft.com/en-us/library/documentformat.openxml.packaging.openxmlpartcontainer_members(v=office.14).aspx)
+ - [DocumentFormat.OpenXml.Packaging.OpenXmlPart](http://msdn.microsoft.com/en-us/library/documentformat.openxml.packaging.openxmlpart_members(v=office.14).aspx)
+ - [System.IO.Packaging.Package](http://msdn.microsoft.com/en-us/library/system.io.packaging.package.aspx)

data/lib/open_xml_package/part.rb

@@ -0,0 +1,14 @@
+class OpenXmlPackage
+  class Part < Struct.new(:path, :content)
+    
+    def content
+      self[:content] = self[:content].get_input_stream.read if promise?
+      super
+    end
+    
+    def promise?
+      self[:content].respond_to?(:get_input_stream)
+    end
+    
+  end
+end

data/lib/open_xml_package/version.rb

@@ -1,3 +1,3 @@
 class OpenXmlPackage
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/open_xml_package.rb

@@ -1,3 +1,4 @@
+require "open_xml_package/part"
 require "open_xml_package/version"
 require "zip"
 
@@ -5,21 +6,65 @@ require "zip"
 class OpenXmlPackage
   attr_reader :parts
 
-  def initialize
-    @parts = {}
+  def self.open(path)
+    if block_given?
+      Zip::File.open(path) do |zipfile|
+        yield new(zipfile)
+      end
+    else
+      new Zip::File.open(path)
+    end
+  end
+
+  def initialize(zipfile=nil)
+    @zipfile = zipfile
+    @parts = []
+    read_zipfile! if zipfile
+  end
+
+
+
+  def add_part(path_or_part, content=nil)
+    path = path_or_part
+    path = path_or_part.path if path_or_part.respond_to?(:path)
+    content = path_or_part.read if path_or_part.respond_to?(:read)
+    
+    @parts << Part.new(path, content)
   end
 
-  def add_part(path, part)
-    parts[path] = part
+  def get_part(path)
+    @parts.detect { |part| part.path == path }
+  end
+
+
+
+  def close
+    zipfile.close if zipfile
   end
 
   def write_to(path)
-    Zip::OutputStream.open(path) do |io|
-      parts.each do |path, part|
-        io.put_next_entry path
-        io.write part.read
+    File.open(path, "w") do |file|
+      file.write to_stream.string
+    end
+  end
+  
+  def to_stream
+    Zip::OutputStream.write_buffer do |io|
+      parts.each do |part|
+        io.put_next_entry part.path
+        io.write part.content
       end
     end
   end
 
+private
+
+  attr_reader :zipfile
+
+  def read_zipfile!
+    zipfile.entries.each do |entry|
+      @parts << Part.new(entry.name, entry)
+    end
+  end
+
 end

data/test/open_xml_package_test.rb

@@ -1,11 +1,29 @@
 require "test_helper"
 require "fileutils"
-require "digest"
+require "set"
 
 
 class OpenXmlPackageTest < ActiveSupport::TestCase
   attr_reader :package, :temp_file
   
+  
+  
+  context "#add_part" do
+    should "accept a path and content" do
+      package = OpenXmlPackage.new
+      package.add_part "PATH", "CONTENT"
+      assert_equal 1, package.parts.count
+    end
+    
+    should "accept a part that responds to :path and :read" do
+      package = OpenXmlPackage.new
+      package.add_part OpenXmlPackage::Part.new("PATH", "CONTENT")
+      assert_equal 1, package.parts.count
+    end
+  end
+  
+  
+  
   context "Writing" do
     setup do
       @temp_file = expand_path "../tmp/test.zip"
@@ -15,10 +33,10 @@ class OpenXmlPackageTest < ActiveSupport::TestCase
     context "Given a simple part" do
       setup do
         @package = OpenXmlPackage.new
-        package.add_part "content/document.xml", some_content
+        package.add_part "content/document.xml", document_content
       end
       
-      should "write the expected file" do
+      should "write a valid zip file with the expected parts" do
         package.write_to temp_file
         assert File.exists?(temp_file), "Expected the file #{temp_file.inspect} to have been created"
         assert_equal %w{content/document.xml}, Zip::File.open(temp_file).entries.map(&:name)
@@ -28,16 +46,58 @@ class OpenXmlPackageTest < ActiveSupport::TestCase
   
   
   
+  context "Reading" do
+    context "Given a sample Word document" do
+      setup do
+        @temp_file = expand_path "./support/sample.docx"
+        @package = OpenXmlPackage.open(temp_file)
+        @expected_contents = Set[
+          "[Content_Types].xml",
+          "_rels/.rels",
+          "docProps/app.xml",
+          "docProps/core.xml",
+          "docProps/thumbnail.jpeg",
+          "word/_rels/document.xml.rels",
+          "word/document.xml",
+          "word/fontTable.xml",
+          "word/media/image1.png",
+          "word/settings.xml",
+          "word/styles.xml",
+          "word/stylesWithEffects.xml",
+          "word/theme/theme1.xml",
+          "word/webSettings.xml" ]
+      end
+      
+      teardown do
+        package.close
+      end
+      
+      should "discover the expected parts" do
+        assert_equal @expected_contents, package.parts.map(&:path).to_set
+      end
+      
+      should "read their content on-demand" do
+        assert_equal web_settings_content, package.get_part("word/webSettings.xml").content
+      end
+    end
+  end
+  
+  
+  
 private
   
-  def some_content
-    StringIO.new(<<-STR)
+  def document_content
+    <<-STR
     <document>
       <body>Works!</body>
     </document>
     STR
   end
   
+  def web_settings_content
+    "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\r\n<w:webSettings xmlns:mc=\"http://schemas.openxmlformats.org/markup-compatibility/2006\" xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\" xmlns:w=\"http://schemas.openxmlformats.org/wordprocessingml/2006/main\" xmlns:w14=\"http://schemas.microsoft.com/office/word/2010/wordml\" mc:Ignorable=\"w14\"><w:allowPNG/><w:doNotSaveAsSingleFile/></w:webSettings>"
+  end
+  
   def expand_path(path)
     File.expand_path(File.join(File.dirname(__FILE__), path))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_xml_package
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bob Lail
@@ -155,9 +155,11 @@ files:
 - README.md
 - Rakefile
 - lib/open_xml_package.rb
+- lib/open_xml_package/part.rb
 - lib/open_xml_package/version.rb
 - open_xml_package.gemspec
 - test/open_xml_package_test.rb
+- test/support/sample.docx
 - test/test_helper.rb
 homepage: ''
 licenses:
@@ -185,4 +187,5 @@ specification_version: 4
 summary: A Ruby implementation of OpenXmlPackage
 test_files:
 - test/open_xml_package_test.rb
+- test/support/sample.docx
 - test/test_helper.rb