open_xml_package 0.1.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dccd074a45e7ab40ae475a08cc76fa971b1fdf28
-  data.tar.gz: 9c2b1b2f54b9ebe31ea4dc5fb897811ef868048c
+  metadata.gz: b7c6df8561b12ab2eba68c491b536858c24d1ac7
+  data.tar.gz: 072033ceed3d330101adade0edd83311db91fbc0
 SHA512:
-  metadata.gz: ed7b80d5fdc04c631963c985b7cd514b1a7dcaec082ad508e5a8f4eaf01185952dc25359bd3466a027eea5c4018bec380d3243e4ba111664cc196bd793a1b58c
-  data.tar.gz: 1e2c65ddc9e0c1f92f9b54dc02240ba50b6558f3289b0343bda5a79cc7337c8fbb2fe8b2194086cce6cb0a52a93d407f37d7caae00d9916fde35bba8fcf2a6ba
+  metadata.gz: 78ee971bfc8d827ca20a977004fe0bf89c09d4f15eab9f23fa4aebb559052a4215964cf638fff28fca8b3042d5b80d3e4a771504e728f6e2d4f4c5e8db7143ef
+  data.tar.gz: 7ddae79c7891090e17282dd30470e2f3d315176c8b81f7b7376f234ca1d6eb57445e23fe1aae7a9362b7d3f7dbf043960fd0ad36b4f33340f02a2434bc80bfa3

data/README.md

@@ -1,8 +1,8 @@
-# OpenXmlPackage
+# 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.
 
-
+The base class for [Rocx::Package](https://github.com/genebot/rocx/blob/master/lib/rocx/package.rb), [Xlsx::Package](https://github.com/concordia-publishing-house/xlsx/blob/master/lib/xlsx/package.rb), and [Pptx::Package](https://github.com/concordia-publishing-house/pptx/blob/master/lib/pptx/package.rb).
 
 
 ## Installation
@@ -21,7 +21,6 @@ Or install it yourself as:
 
 
 
-
 ## Usage
 
 #### Writing
@@ -29,9 +28,9 @@ Or install it yourself as:
 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 = OpenXml::Package.new
+package.add_part "content/document.xml", OpenXml::Parts::UnparsedPart.new("<document></document>")
+package.add_part "media/image.png", OpenXml::Parts::UnparsedPart.new(File.open(image_path, "rb", &:read))
 package.write_to "~/Desktop/output.zip"
 ```
 
@@ -42,15 +41,73 @@ 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"]
+  package.parts.keys # => ["content/document.xml", "media/image.png"]
+end
+```
+
+
+#### Subclassing
+
+`OpenXml::Package` is intended to be the base class for libraries that implement Open XML formats for Microsoft Office products.
+
+For example, a very simple Microsoft Word document can be defined as follows:
+
+```ruby
+require "open_xml/package"
+
+module Rocx
+  class Package < OpenXml::Package
+    attr_reader :document,
+                :doc_rels,
+                :settings,
+                :styles
+
+    content_types do
+      default "png", TYPE_PNG
+      override "/word/styles.xml", TYPE_STYLES
+      override "/word/settings.xml", TYPE_SETTINGS
+    end
+
+    def initialize
+      super
+
+      rels.add_relationship REL_DOCUMENT, "/word/document.xml"
+      @doc_rels = OpenXml::Parts::Rels.new([
+        { type: REL_STYLES, target: "/word/styles.xml"},
+        { type: REL_SETTINGS, target: "/word/settings.xml"}
+      ])
+      @settings = Rocx::Parts::Settings.new
+      @styles = Rocx::Parts::Styles.new
+      @document = Rocx::Parts::Document.new
+
+      add_part "word/_rels/document.xml.rels", doc_rels
+      add_part "word/document.xml", document
+      add_part "word/settings.xml", settings
+      add_part "word/styles.xml", styles
+    end
+
+  end
 end
 ```
 
+This gem also defines two "Parts" that are commonly used in Open XML packages.
+
+##### OpenXml::Parts::ContentTypes
+
+Is used to identify the ContentType of all of the files in the package. There are two ways of identifying content types:
+
+ 1. **Default**: declares the default content type for a file with a given extension
+ 2. **Override**: declares the content type for a specific file with the given path inside the package
+
+##### OpenXml::Parts::Rels
+
+Is used to identify links within the package
+
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/open_xml_package/fork )
+1. Fork it ( https://github.com/concordia-publishing-house/open_xml_package/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/open_xml_package/version.rb

@@ -1,3 +1,3 @@
 module OpenXmlPackage
-  VERSION = "0.1.0.beta1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_xml_package
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -200,9 +200,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2