openxml-package 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9125838f28df960214ac225121b29ecabee182e4
-  data.tar.gz: 23eefb7c402ecf3b0c500c1241a9e5105c24a7e3
+  metadata.gz: 7d6a0da91c83a3de0209c39c9d29016da44e3ffc
+  data.tar.gz: 08f26c9b65ec985d6b784341cd288b15f58cea8d
 SHA512:
-  metadata.gz: b22bbdd8a0064445003508a9f5c96528cf5950725f863a5c8eba95389885f3767f6c5d44ec325bb4a7e451cdfe788d84afaf2445454472d437606b182d69c93b
-  data.tar.gz: 81aa9f271fb5f65ca9e31c5b6a03b99d8f701003d1fd534749c5c87863cc84eb12b72f717e49065d4007502cada293c6ff9b31db6f6b2637ece7c64b2196fd63
+  metadata.gz: da26c7fc3fa5e983c0a6f78ebb5149e3ca562991ba182e44d516a226451ac95522ee41a09ca8c4c1ccc6c328eac29d595c14bc06055d6fb3bb5030c6fcbe1032
+  data.tar.gz: 6965c0f5343a7328c78a7a6fba636dad620f9ed316e223e82a2ef6d153f79dcae22f63cd23b7c5d30ff2ba962981d32bd149a35c1532b97f896533d5843574d5

data/lib/openxml/builder/element.rb

@@ -0,0 +1,43 @@
+module OpenXml
+  class Builder
+    class Element < SimpleDelegator
+      attr_reader :namespace
+      attr_accessor :parent
+
+      def initialize(*args)
+        super Ox::Element.new(*args)
+      end
+
+      def []=(attribute, value)
+        namespace_def = attribute.downcase.to_s.match /^xmlns(?:\:(?<prefix>.*))?$/
+        add_namespace(namespace_def[:prefix], value.to_s) if namespace_def
+        super
+      end
+
+      def namespace=(ns)
+        @namespace = ns
+        tag = name.match(/^(?:\w*?\:)?(?<tag>\w*)$/i)[:tag]
+        self.value = "#{namespace.prefix}:#{tag}" if namespace.is_a? OpenXml::Builder::Namespace
+        self.value = "#{namespace}:#{tag}" if namespace.is_a? String
+      end
+
+      def namespaces
+        @namespaces ||= []
+      end
+      alias :namespace_definitions :namespaces
+
+      def ancestors
+        parents = [self]
+        parents << parent.ancestors unless parent.nil? || !parent.respond_to?(:ancestors)
+        parents.flatten
+      end
+
+    private
+
+      def add_namespace(prefix, uri)
+        namespaces << OpenXml::Builder::Namespace.new(prefix, uri)
+      end
+
+    end
+  end
+end

data/lib/openxml/builder/namespace.rb

@@ -0,0 +1,13 @@
+module OpenXml
+  class Builder
+    class Namespace
+      attr_accessor :prefix, :uri
+
+      def initialize(prefix, uri)
+        @prefix = prefix.to_s
+        @uri = uri
+      end
+
+    end
+  end
+end

data/lib/openxml/builder.rb

@@ -4,41 +4,88 @@
 #
 # This class mimics the XML Builder DSL.
 require "ox"
+require "openxml/builder/element"
+require "openxml/builder/namespace"
 
 module OpenXml
   class Builder
+    attr_reader :parent
 
-    def initialize
-      @document = Ox::Document.new(version: "1.0")
-      @current = @document
+    def initialize(options={})
+      @options = {
+        with_xml: true,
+        encoding: "utf-8"
+      }.merge(options)
+      @options[:with_xml] = !!@options[:with_xml] || @options[:standalone] == :yes
+
+      @document = Ox::Document.new({version: "1.0"}.merge(@options))
+      @parent = @document
       yield self if block_given?
     end
 
     def to_s
-      Ox.dump @document
+      Ox.dump @document, @options
     end
     alias :to_xml :to_s
 
+    # Adapted from Nokogiri's builder.rb
+    def [](ns)
+      if @parent != @document
+        @ns = @parent.namespace_definitions.find { |x| x.prefix == ns.to_s }
+      end
+      return self if @ns
+
+      @parent.ancestors.each do |a|
+        next if a == @document
+        @ns = a.namespace_definitions.find { |x| x.prefix == ns.to_s }
+        return self if @ns
+      end
+
+      @ns = { :pending => ns.to_s }
+      return self
+    end
+
     def method_missing(tag_name, *args)
-      new_element = Ox::Element.new(tag_name)
-      attributes = args.extract_options!
+      new_element = OpenXml::Builder::Element.new(tag_name)
+      new_element.parent = @parent
+      attributes = extract_options!(args)
       attributes.each do |key, value|
         new_element[key] = value
       end
 
+      # Adapted from Nokogiri's builder.rb
+      if @ns.is_a? OpenXml::Builder::Namespace
+        new_element.namespace = @ns
+      elsif @ns.is_a? Hash
+        new_element.namespace = new_element.namespace_definitions.find { |x| x.prefix == @ns[:pending] }
+        raise ArgumentError, "Namespace #{@ns[:pending]} has not been defined" if new_element.namespace.nil?
+      end
+
+      @ns = nil
+
       if block_given?
         begin
-          was_current = @current
-          @current = new_element
+          was_current = @parent
+          @parent = new_element
           yield self
         ensure
-          @current = was_current
+          @parent = was_current
         end
       elsif value = args.first
         new_element << value.to_s
       end
 
-      @current << new_element
+      @parent << new_element.__getobj__
+    end
+
+  private
+
+    def extract_options!(args)
+      if args.last.is_a?(Hash) && args.last.instance_of?(Hash)
+        args.pop
+      else
+        {}
+      end
     end
 
   end

data/lib/openxml/part.rb

@@ -1,16 +1,14 @@
-require "nokogiri"
 require "openxml/builder"
 
 module OpenXml
   class Part
-    include ::Nokogiri
 
-    def build_xml
-      OpenXml::Builder.new { |xml| yield xml }.to_xml
+    def build_xml(options={})
+      OpenXml::Builder.new(options) { |xml| yield xml }.to_xml
     end
 
     def build_standalone_xml(&block)
-      "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>" + build_xml(&block)
+      build_xml({ standalone: :yes }, &block)
     end
 
     def read

data/lib/openxml-package/version.rb

@@ -1,3 +1,3 @@
 module OpenXmlPackage
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/part_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+require "fileutils"
+require "set"
+
+class OpenXmlPartTest < 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
+      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
+      end
+    end
+
+  end
+
+
+
+private
+
+
+  def basic_xml
+    <<-STR
+<?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
+<?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
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openxml-package
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bob Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -213,6 +213,8 @@ files:
 - lib/openxml-package.rb
 - lib/openxml-package/version.rb
 - lib/openxml/builder.rb
+- lib/openxml/builder/element.rb
+- lib/openxml/builder/namespace.rb
 - lib/openxml/content_types_presets.rb
 - lib/openxml/errors.rb
 - lib/openxml/package.rb
@@ -226,6 +228,7 @@ files:
 - openxml-package.gemspec
 - test/content_types_test.rb
 - test/package_test.rb
+- test/part_test.rb
 - test/support/sample.docx
 - test/test_helper.rb
 homepage: https://github.com/openxml/openxml-package
@@ -255,5 +258,6 @@ summary: A Ruby implementation of OpenXmlPackage
 test_files:
 - test/content_types_test.rb
 - test/package_test.rb
+- test/part_test.rb
 - test/support/sample.docx
 - test/test_helper.rb