openxml-package 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5323017681158167286a27e7c26df3781b547b7b
-  data.tar.gz: 4ab1a1397d8452202ecc02abbb3a484160b9c7f7
+  metadata.gz: ae52e67709cf5e65ec3a4dad4c3cd7f88a40b538
+  data.tar.gz: 29dfc74ba61458cc74ba029c1a4bc9941d8cbd89
 SHA512:
-  metadata.gz: 5e528096108f7b0536aad09ce7ef073c3774766cf506a797cf8807b887d126c8a216490dfbfab4b32ac736a0c7278a6001bd609d635bc570368d04b91e9b6e41
-  data.tar.gz: 6b9897eae69205b5d1e4f6723ca092569fe348775c265c3a6b38e5531e91abe52c7464cd09e0f87f79791752a289d96e0b6299901711da1e45c6d05b0ad1badf
+  metadata.gz: 08a1895d8a8e4c2c5324efa071d7635b214cebd99a1619fa3620072a3d876c9953fe191db353a8a2b78ed13f55fcc5e969366ae70975870da48d6acddb1f9f6d
+  data.tar.gz: 3255c8264fa47faf23980a903042a43dc155875a48a1dfc5eddae57c6bc7f61f2b650c4ca9b60be56939aa002b30550aa57a10deeb7c8bbdbb615c4d7af2e6b4

data/.travis.yml

@@ -0,0 +1,6 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.3.0
+script:
+  - bundle exec rake test

data/README.md

@@ -1,8 +1,12 @@
 # OpenXml::Package
 
-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.
+[![Gem Version](https://badge.fury.io/rb/openxml-package.svg)](https://rubygems.org/gems/openxml-package)
+[![Code Climate](https://codeclimate.com/github/openxml/openxml-package.svg)](https://codeclimate.com/github/openxml/openxml-package)
+[![Build Status](https://travis-ci.org/openxml/openxml-package.svg)](https://travis-ci.org/openxml/openxml-package)
 
-The base class for [Docx::Package](https://github.com/openxml/openxml-docx/blob/master/lib/openxml/docx/package.rb), [Xlsx::Package](https://github.com/openxml/openxml-xlsx/blob/master/lib/openxml/xlsx/package.rb), and [Pptx::Package](https://github.com/openxml/openxml-pptx).
+A Ruby implementation of [DocumentFormat.OpenXml.Packaging.OpenXmlPackage](https://msdn.microsoft.com/en-us/library/documentformat.openxml.packaging.openxmlpackage_members.aspx) from Microsoft's Open XML SDK.
+
+The base class for [OpenXml::Docx::Package](https://github.com/openxml/openxml-docx/blob/master/lib/openxml/docx/package.rb), [OpenXml::Xlsx::Package](https://github.com/openxml/openxml-xlsx/blob/master/lib/openxml/xlsx/package.rb), and [OpenXml::Pptx::Package](https://github.com/openxml/openxml-pptx/blob/master/lib/openxml/xlsx/package.rb).
 
 
 ## Installation
@@ -40,7 +44,7 @@ package.write_to "~/Desktop/output.zip"
 You can read the contents of an Open XML Package:
 
 ```ruby
-OpenXmlPackage.open("~/Desktop/output.zip") do |package|
+OpenXml::Package.open("~/Desktop/output.zip") do |package|
   package.parts.keys # => ["content/document.xml", "media/image.png"]
 end
 ```

data/lib/openxml-package/version.rb

@@ -1,3 +1,3 @@
 module OpenXmlPackage
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/openxml-package.gemspec

@@ -9,17 +9,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Bob Lail"]
   spec.email         = ["bob.lailfamily@gmail.com"]
 
-  spec.summary       = %q{A Ruby implementation of OpenXmlPackage}
-  spec.description   = %q{A Ruby implementation of OpenXmlPackage}
-  spec.license       = "MIT"
+  spec.summary       = %q{A Ruby implementation of OpenXmlPackage from Microsoft's Open XML SDK}
+  spec.description   = %q{A Ruby implementation of OpenXmlPackage from Microsoft's Open XML SDK}
   spec.homepage      = "https://github.com/openxml/openxml-package"
+  spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubyzip", "~> 1.1.0"
+  spec.add_dependency "rubyzip", "~> 1.2.1"
   spec.add_dependency "nokogiri"
   spec.add_dependency "ox"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openxml-package
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby implementation of OpenXmlPackage
+description: A Ruby implementation of OpenXmlPackage from Microsoft's Open XML SDK
 email:
 - bob.lailfamily@gmail.com
 executables: []
@@ -206,6 +206,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -225,14 +226,6 @@ files:
 - lib/openxml/rubyzip_fix.rb
 - lib/openxml/types.rb
 - openxml-package.gemspec
-- test/content_types_test.rb
-- test/element_test.rb
-- test/package_test.rb
-- test/part_test.rb
-- test/rels_test.rb
-- test/support/external_hyperlink.docx
-- test/support/sample.docx
-- test/test_helper.rb
 - tmp/.keep
 homepage: https://github.com/openxml/openxml-package
 licenses:
@@ -254,16 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby implementation of OpenXmlPackage
-test_files:
-- test/content_types_test.rb
-- test/element_test.rb
-- test/package_test.rb
-- test/part_test.rb
-- test/rels_test.rb
-- test/support/external_hyperlink.docx
-- test/support/sample.docx
-- test/test_helper.rb
+summary: A Ruby implementation of OpenXmlPackage from Microsoft's Open XML SDK
+test_files: []

data/test/content_types_test.rb

@@ -1,34 +0,0 @@
-require "test_helper"
-
-class ContentTypesTest < ActiveSupport::TestCase
-  attr_reader :content_types
-
-  WORDPROCESSING_DOCUMENT_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"
-
-  setup do
-    @content_types = OpenXml::Parts::ContentTypes.new(
-      {"xml" => OpenXml::Types::XML, "rels" => OpenXml::Types::RELATIONSHIPS},
-      {"word/document.xml" => WORDPROCESSING_DOCUMENT_TYPE})
-  end
-
-
-  context "Given a path without an override" do
-    should "identify the content type from its extension" do
-      assert_equal OpenXml::Types::XML, content_types.of("content/some.xml")
-    end
-  end
-
-  context "Given a path with an override" do
-    should "identify the content type from its path" do
-      assert_equal WORDPROCESSING_DOCUMENT_TYPE, content_types.of("word/document.xml")
-    end
-  end
-
-  context "Given a path with an unrecognized extension" do
-    should "be nil" do
-      assert_equal nil, content_types.of("img/screenshot.jpg")
-    end
-  end
-
-
-end

data/test/element_test.rb

@@ -1,38 +0,0 @@
-require "test_helper"
-
-class ElementTest < ActiveSupport::TestCase
-  attr_reader :element
-
-  setup do
-    @element = OpenXml::Builder::Element.new("tag")
-  end
-
-  context "The element" do
-    should "correctly assign attributes" do
-      element[:attribute] = "value"
-      element["namespaced:attribute"] = "value"
-      dump = Ox.dump(element.__getobj__)
-      assert_equal "\n<tag attribute=\"value\" namespaced:attribute=\"value\"/>\n", dump
-    end
-
-    should "parse out available namespace prefixes from namespace definition attributes" do
-      nsdef_prefix = "xmlns:namespace"
-      nsdef_uri = "http://schema.somenamespace.org/"
-      element[nsdef_prefix] = nsdef_uri
-      assert_equal [:namespace], element.namespaces
-    end
-
-    should "only parse namespace definition attributes with a prefix" do
-      element["xmlns"] = "http://schema.somenamespace.org/"
-      assert element.namespaces.empty?
-    end
-
-    should "correctly use a namespace prefix" do
-      element.namespace = "namespace"
-      dump = Ox.dump(element.__getobj__)
-      assert_equal "\n<namespace:tag/>\n", dump
-    end
-  end
-
-
-end

data/test/package_test.rb

@@ -1,163 +0,0 @@
-require "test_helper"
-require "fileutils"
-require "set"
-
-class OpenXmlPackageTest < ActiveSupport::TestCase
-  attr_reader :package, :temp_file
-
-
-
-  context "#add_part" do
-    should "accept a path and a part" do
-      package = OpenXml::Package.new
-      assert_difference "package.parts.count", +1 do
-        package.add_part "PATH", OpenXml::Part.new
-      end
-    end
-  end
-
-
-
-  context "Writing" do
-    setup do
-      @temp_file = expand_path "../tmp/test.zip"
-      FileUtils.rm temp_file, force: true
-    end
-
-    context "Given a simple part" do
-      setup do
-        @package = OpenXml::Package.new
-        package.add_part "content/document.xml", OpenXml::Parts::UnparsedPart.new(document_content)
-      end
-
-      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_Types].xml _rels/.rels content/document.xml},
-          Zip::File.open(temp_file).entries.map(&:name)
-      end
-    end
-  end
-
-
-
-  context "Reading" do
-    context "Given a sample Word document" do
-      setup do
-        @temp_file = expand_path "./support/sample.docx"
-        @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
-
-      context ".open" do
-        setup do
-          @package = OpenXml::Package.open(temp_file)
-        end
-
-        teardown do
-          package.close
-        end
-
-        should "discover the expected parts" do
-          assert_equal @expected_contents, package.parts.keys.to_set
-        end
-
-        should "read their content on-demand" do
-          assert_equal web_settings_content, package.get_part("word/webSettings.xml").content
-        end
-      end
-
-      context ".from_stream" do
-        setup do
-          @package = OpenXml::Package.from_stream(File.open(temp_file, "rb", &:read))
-        end
-
-        should "also discover the expected parts" do
-          assert_equal @expected_contents, package.parts.keys.to_set
-        end
-
-        should "read their content" do
-          assert_equal web_settings_content, package.get_part("word/webSettings.xml").content
-        end
-      end
-
-      context "ContentTypes" do
-        setup do
-          @package = OpenXml::Package.open(temp_file)
-        end
-
-        teardown do
-          package.close
-        end
-
-        should "be parsed" do
-          assert_equal %w{jpeg png rels xml}, package.content_types.defaults.keys.sort
-          assert_equal "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
-            package.content_types.overrides["/word/document.xml"]
-        end
-      end
-
-      context "Rels" do
-        setup do
-          @package = OpenXml::Package.open(temp_file)
-        end
-
-        teardown do
-          package.close
-        end
-
-        should "be parsed" do
-          assert_equal %w{docProps/core.xml docProps/app.xml word/document.xml docProps/thumbnail.jpeg},
-            package.rels.map(&:target)
-        end
-      end
-    end
-
-    context "Given a document with an external hyperlink" do
-      context ".open" do
-        should "parse the TargetMode attribute of the Relationship element" do
-          path = expand_path "support/external_hyperlink.docx"
-          OpenXml::Package.open(path) do |package|
-            part = package.parts["word/_rels/document.xml.rels"]
-            relationship = part.find { |r| r.target == "http://example.com" }
-            assert_equal relationship.target_mode, 'External'
-          end
-        end
-      end
-    end
-  end
-
-
-
-private
-
-  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
-
-end

data/test/part_test.rb

@@ -1,91 +0,0 @@
-require "test_helper"
-require "fileutils"
-require "set"
-
-class PartTest < ActiveSupport::TestCase
-  attr_reader :part, :builder
-
-
-
-  context "Building" do
-    setup do
-      @part = OpenXml::Part.new
-    end
-
-    context "Given simple xml for one part" do
-      setup do
-        @builder = @part.build_xml do |xml|
-          xml.document do |xml|
-            2.times { xml.child(attribute: "value", other_attr: "other value") }
-          end
-        end
-      end
-
-      should "build the expected xml" do
-        assert_equal basic_xml, builder.to_s(debug: true)
-      end
-    end
-
-    context "Given namespaced xml for one part" do
-      setup do
-        @builder = @part.build_xml do |xml|
-          xml.document("xmlns:ns" => "some:namespace:uri") do
-            2.times { xml["ns"].child(attribute: "value", other_attr: "other value") }
-          end
-        end
-      end
-
-      should "build the expected xml" do
-        assert_equal namespaced_xml, builder.to_s(debug: true)
-      end
-    end
-
-    context "For a standalone XML element" do
-      setup do
-        @builder = @part.build_standalone_xml do |xml|
-          xml.document do
-            xml.child(attribute: "value", other_attr: "other value")
-          end
-        end
-      end
-
-      should "build the expected xml" do
-        assert_equal standalone_xml, builder.to_s(debug: true)
-      end
-    end
-  end
-
-
-
-private
-
-  def basic_xml
-    <<-STR.strip
-<?xml version="1.0" encoding="utf-8"?>
-<document>
-  <child attribute="value" other_attr="other value"/>
-  <child attribute="value" other_attr="other value"/>
-</document>
-    STR
-  end
-
-  def namespaced_xml
-    <<-STR.strip
-<?xml version="1.0" encoding="utf-8"?>
-<document xmlns:ns="some:namespace:uri">
-  <ns:child attribute="value" other_attr="other value"/>
-  <ns:child attribute="value" other_attr="other value"/>
-</document>
-    STR
-  end
-
-  def standalone_xml
-    <<-STR.strip
-<?xml version="1.0" encoding="utf-8" standalone="yes"?>
-<document>
-  <child attribute="value" other_attr="other value"/>
-</document>
-    STR
-  end
-
-end

data/test/rels_test.rb

@@ -1,15 +0,0 @@
-require "test_helper"
-
-class RelsTest < ActiveSupport::TestCase
-  context "#to_xml" do
-    context "given a document with an external hyperlink" do
-      should "write the TargetMode attribute of the Relationship element" do
-        path = File.expand_path "../support/external_hyperlink.docx", __FILE__
-        OpenXml::Package.open(path) do |package|
-          part = package.parts["word/_rels/document.xml.rels"]
-          assert_match /<Relationship Id=".+" Target="http:\/\/example.com" TargetMode="External"/, part.to_xml.to_s
-        end
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,16 +0,0 @@
-require "rubygems"
-
-require "simplecov"
-SimpleCov.start do
-  add_filter "test/"
-end
-
-require "rails"
-require "rails/test_help"
-require "pry"
-require "rr"
-require "shoulda/context"
-require "minitest/reporters/turn_reporter"
-MiniTest::Reporters.use! Minitest::Reporters::TurnReporter.new
-
-require "openxml/package"