caracal 1.0.9 → 1.0.10

data/lib/caracal/document.rb

@@ -1,15 +1,18 @@
 require 'open-uri'
 require 'zip'
 
+require 'caracal/core/custom_properties'
 require 'caracal/core/file_name'
 require 'caracal/core/fonts'
+require 'caracal/core/iframes'
+require 'caracal/core/ignorables'
 require 'caracal/core/images'
 require 'caracal/core/list_styles'
 require 'caracal/core/lists'
+require 'caracal/core/namespaces'
 require 'caracal/core/page_breaks'
 require 'caracal/core/page_numbers'
 require 'caracal/core/page_settings'
-require 'caracal/core/custom_properties'
 require 'caracal/core/relationships'
 require 'caracal/core/rules'
 require 'caracal/core/styles'
@@ -38,16 +41,19 @@ module Caracal
     #-------------------------------------------------------------
 
     # mixins (order is important)
-    include Caracal::Core::FileName
     include Caracal::Core::CustomProperties
-
+    include Caracal::Core::FileName
+    include Caracal::Core::Ignorables
+    include Caracal::Core::Namespaces
     include Caracal::Core::Relationships
+
     include Caracal::Core::Fonts
     include Caracal::Core::PageSettings
     include Caracal::Core::PageNumbers
     include Caracal::Core::Styles
     include Caracal::Core::ListStyles
 
+    include Caracal::Core::IFrames
     include Caracal::Core::Images
     include Caracal::Core::Lists
     include Caracal::Core::PageBreaks
@@ -98,7 +104,7 @@ module Caracal
       page_margins top: 1440, bottom: 1440, left: 1440, right: 1440
       page_numbers
 
-      [:relationship, :font, :style, :list_style].each do |method|
+      [:font, :list_style, :namespace, :relationship, :style].each do |method|
         collection = self.class.send("default_#{ method }s")
         collection.each do |item|
           send(method, item)

data/lib/caracal/renderers/document_renderer.rb

@@ -97,6 +97,40 @@ module Caracal
 
       #============= MODEL RENDERERS ===========================
 
+      def render_iframe(xml, model)
+        ::Zip::File.open(model.file) do |zip|
+          a_href     = 'http://schemas.openxmlformats.org/drawingml/2006/main'
+          pic_href   = 'http://schemas.openxmlformats.org/drawingml/2006/picture'
+          r_href     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'
+
+          entry      = zip.glob('word/document.xml').first
+          content    = entry.get_input_stream.read
+          doc_xml    = Nokogiri::XML(content)
+
+          fragment = doc_xml.xpath('//w:body').first.children
+          fragment.pop
+
+          model.relationships.each do |r_hash|
+            id    = r_hash.delete(:id)              # we can't update the fragment until
+            model = document.relationship(r_hash)   # the parent document assigns the embedded
+            index = model.relationship_id           # relationship an id.
+
+            r_node  = fragment.at_xpath("//a:blip[@r:embed='#{ id }']", { a: a_href, r: r_href })
+            if r_attr  = r_node.attributes['embed']
+              r_attr.value = "rId#{ index }"
+            end
+
+            p_parent = r_node.parent.parent
+            p_node   = p_parent.children[0].children[0]
+            if p_attr  = p_node.attributes['id']
+              p_attr.value = index.to_s
+            end
+          end
+
+          xml << fragment.to_s
+        end
+      end
+
       def render_image(xml, model)
         unless ds = document.default_style
           raise Caracal::Errors::NoDefaultStyleError 'Document must declare a default paragraph style.'
@@ -327,23 +361,32 @@ module Caracal
       #============= OPTIONS ===================================
 
       def root_options
-        {
-          'xmlns:mc'   => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
-          'xmlns:o'    => 'urn:schemas-microsoft-com:office:office',
-          'xmlns:r'    => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
-          'xmlns:m'    => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
-          'xmlns:v'    => 'urn:schemas-microsoft-com:vml',
-          'xmlns:wp'   => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
-          'xmlns:w10'  => 'urn:schemas-microsoft-com:office:word',
-          'xmlns:w'    => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
-          'xmlns:wne'  => 'http://schemas.microsoft.com/office/word/2006/wordml',
-          'xmlns:sl'   => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
-          'xmlns:a'    => 'http://schemas.openxmlformats.org/drawingml/2006/main',
-          'xmlns:pic'  => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
-          'xmlns:c'    => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
-          'xmlns:lc'   => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
-          'xmlns:dgm'  => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
-        }
+        opts = {}
+        document.namespaces.each do |model|
+          opts[model.namespace_prefix] = model.namespace_href
+        end
+        unless document.ignorables.empty?
+          v = document.ignorables.join(' ')
+          opts['mc:Ignorable'] = v
+        end
+        opts
+        # {
+        #   'xmlns:mc'   => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+        #   'xmlns:o'    => 'urn:schemas-microsoft-com:office:office',
+        #   'xmlns:r'    => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+        #   'xmlns:m'    => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+        #   'xmlns:v'    => 'urn:schemas-microsoft-com:vml',
+        #   'xmlns:wp'   => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+        #   'xmlns:w10'  => 'urn:schemas-microsoft-com:office:word',
+        #   'xmlns:w'    => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+        #   'xmlns:wne'  => 'http://schemas.microsoft.com/office/word/2006/wordml',
+        #   'xmlns:sl'   => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+        #   'xmlns:a'    => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+        #   'xmlns:pic'  => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+        #   'xmlns:c'    => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+        #   'xmlns:lc'   => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+        #   'xmlns:dgm'  => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        # }
       end
 
       def page_margin_options
@@ -359,7 +402,7 @@ module Caracal
         {
           'w:w'       => document.page_width,
           'w:h'       => document.page_height,
-          'w:orient'  => document.page_orientation 
+          'w:orient'  => document.page_orientation
         }
       end
 

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 end

data/spec/lib/caracal/core/iframes_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Caracal::Core::IFrames do
+  subject { Caracal::Document.new }
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    # .img
+    describe '.iframes' do
+      let!(:size) { subject.contents.size }
+
+      before do
+        path = File.join(Caracal.root, 'spec', 'support', '_fixtures', 'snippet.docx')
+        data = File.open(path).read
+        subject.iframe data: data
+      end
+
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::IFrameModel) }
+    end
+
+  end
+
+end

data/spec/lib/caracal/core/ignorables_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Caracal::Core::Ignorables do
+  subject  { Caracal::Document.new }
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #============== ATTRIBUTES =====================
+
+    # .ignorable
+    describe '.ignorable' do
+      it 'delegates to registration method' do
+        expect(subject).to receive(:register_ignorable)
+        subject.ignorable('dummy')
+      end
+    end
+
+
+    #============== GETTERS ========================
+
+    # .ignorables
+    describe '.ignorables' do
+      it { expect(subject.ignorables).to be_a(Array) }
+    end
+
+
+    #============== REGISTRATION ========================
+
+    # .register_ignorable
+    describe '.register_ignorable' do
+      let(:default_length) { 0 }
+
+      describe 'when not already registered' do
+        before do
+          subject.register_ignorable('dummy')
+        end
+
+        it { expect(subject.ignorables.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do
+          subject.register_ignorable('dummy')
+          subject.register_ignorable('dummy')
+        end
+
+        it { expect(subject.ignorables.size).to eq default_length + 1 }
+      end
+    end
+
+    # .unregister_ignorable
+    describe '.unregister_ignorable' do
+      let(:default_length) { 0 }
+
+      describe 'when registered' do
+        before do
+          subject.register_ignorable('dummy')
+          subject.unregister_ignorable('dummy')
+        end
+
+        it { expect(subject.ignorables.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do
+          subject.register_ignorable('dummy')
+          subject.unregister_ignorable('bogus')
+        end
+
+        it { expect(subject.ignorables.size).to eq default_length + 1 }
+      end
+    end
+
+  end
+
+end

data/spec/lib/caracal/core/models/iframe_model_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::IFrameModel do
+  subject do
+    described_class.new do
+      url    'https://www.example.com/snippet.docx'
+    end
+  end
+
+
+
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.iframe_url).to    eq 'https://www.example.com/snippet.docx' }
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #=============== SETTERS ==========================
+
+    # .url
+    describe '.url' do
+      before { subject.url('https://www.example.com/sample.docx') }
+
+      it { expect(subject.iframe_url).to eq 'https://www.example.com/sample.docx' }
+    end
+
+    # .data
+    describe '.data' do
+      before { subject.data('DOCX data follows here') }
+
+      it { expect(subject.iframe_data).to eq 'DOCX data follows here' }
+    end
+
+
+    #=============== VALIDATION ===========================
+
+    describe '.valid?' do
+      describe 'when either value present' do
+        it { expect(subject.valid?).to eq true }
+      end
+      describe 'when neither value present' do
+        before do
+          subject.url(nil)
+          subject.data(nil)
+        end
+        it { expect(subject.valid?).to eq false }
+      end
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Private Methods
+  #-------------------------------------------------------------
+
+  describe 'private method tests' do
+
+    # .option_keys
+    describe '.option_keys' do
+      let(:actual)   { subject.send(:option_keys).sort }
+      let(:expected) { [:url, :data].sort }
+
+      it { expect(actual).to eq expected }
+    end
+
+  end
+
+end

data/spec/lib/caracal/core/models/image_model_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Caracal::Core::Models::ImageModel do
-  subject do 
+  subject do
     described_class.new do
       url    'https://www.google.com/images/srpr/logo11w.png'
       ppi     96
@@ -14,15 +14,15 @@ describe Caracal::Core::Models::ImageModel do
       right   15
     end
   end
-  
-  
-  
+
+
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
 
   describe 'configuration tests' do
-    
+
     # constants
     describe 'constants' do
       it { expect(described_class::DEFAULT_IMAGE_PPI).to eq 72 }
@@ -34,7 +34,7 @@ describe Caracal::Core::Models::ImageModel do
       it { expect(described_class::DEFAULT_IMAGE_LEFT).to eq 8 }
       it { expect(described_class::DEFAULT_IMAGE_RIGHT).to eq 8 }
     end
-    
+
     # accessors
     describe 'accessors' do
       it { expect(subject.image_url).to    eq 'https://www.google.com/images/srpr/logo11w.png' }
@@ -48,122 +48,120 @@ describe Caracal::Core::Models::ImageModel do
       it { expect(subject.image_left).to   eq 14 }
       it { expect(subject.image_right).to  eq 15 }
     end
-    
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Public Methods
   #-------------------------------------------------------------
-  
+
   describe 'public method tests' do
-  
+
     #=============== GETTERS ==========================
-    
+
     # emu conversions (dimensions)
     [:width, :height].each do |m|
       describe ".formatted_#{ m }" do
         let(:actual) { subject.send("formatted_#{ m }") }
-        
+
         before do
           allow(subject).to receive("image_#{ m }").and_return(540)
           allow(subject).to receive("image_ppi").and_return(96)
         end
-        
+
         it { expect(actual).to eq 5143500 }
       end
     end
-    
+
     # emu conversions (margins)
     [:top, :bottom, :left, :right].each do |m|
       describe ".formatted_#{ m }" do
         let(:actual) { subject.send("formatted_#{ m }") }
-        
+
         before { allow(subject).to receive("image_#{ m }").and_return(9) }
-        
+
         it { expect(actual).to eq 114300 }
       end
     end
-    
-    # .relationship_target
-    
-    
-    
+
+
+
     #=============== SETTERS ==========================
-    
+
     # .url
-    describe '.color' do
+    describe '.url' do
       before { subject.url('https://www.google.com/images/dummy.png') }
-      
+
       it { expect(subject.image_url).to eq 'https://www.google.com/images/dummy.png' }
     end
-    
+
     # .data
     describe '.data' do
       before { subject.data('PNG Data follows here') }
-      
+
       it { expect(subject.image_data).to eq 'PNG Data follows here' }
     end
-    
+
     # .ppi
     describe '.ppi' do
       before { subject.ppi(108) }
-      
+
       it { expect(subject.image_ppi).to eq 108 }
     end
-    
+
     # .width
     describe '.width' do
       before { subject.width(300) }
-      
+
       it { expect(subject.image_width).to eq 300 }
     end
-    
+
     # .height
     describe '.height' do
       before { subject.height(400) }
-      
+
       it { expect(subject.image_height).to eq 400 }
     end
-    
+
     # .align
     describe '.align' do
       before { subject.align(:center) }
-      
+
       it { expect(subject.image_align).to eq :center }
     end
-    
+
     # .top
     describe '.top' do
       before { subject.top(12) }
-      
+
       it { expect(subject.image_top).to eq 12 }
     end
-    
+
     # .bottom
     describe '.bottom' do
       before { subject.bottom(12) }
-      
+
       it { expect(subject.image_bottom).to eq 12 }
     end
-    
+
     # .left
     describe '.left' do
       before { subject.left(12) }
-      
+
       it { expect(subject.image_left).to eq 12 }
     end
-    
+
     # .right
     describe '.right' do
       before { subject.right(12) }
-      
+
       it { expect(subject.image_right).to eq 12 }
     end
-    
-    
+
+
     #=============== VALIDATION ===========================
-    
+
     describe '.valid?' do
       describe 'when all values okay' do
         it { expect(subject.valid?).to eq true }
@@ -173,55 +171,55 @@ describe Caracal::Core::Models::ImageModel do
           before do
             allow(subject).to receive("image_#{ d }").and_return(0)
           end
-        
+
           it { expect(subject.valid?).to eq false }
         end
       end
     end
-  
+
   end
-  
-  
+
+
   #-------------------------------------------------------------
   # Private Methods
   #-------------------------------------------------------------
-  
+
   describe 'private method tests' do
-    
+
     # .option_keys
     describe '.option_keys' do
       let(:actual)   { subject.send(:option_keys).sort }
       let(:expected) { [:url, :width, :height, :align, :top, :bottom, :left, :right].sort }
-      
+
       it { expect(actual).to eq expected }
     end
-    
+
     # .pixels_to_emus
     describe '.pixels_to_emus' do
       let(:actual) { subject.send(:pixels_to_emus, value, 72) }
-      
+
       describe 'when argument is nil' do
         let(:value) { nil }
-        
+
         it { expect(actual).to eq 0 }
       end
       describe 'when argument is NaN' do
         let(:value) { 'a' }
-        
+
         it { expect(actual).to eq 0 }
       end
       describe 'when argument is rational' do
         let(:value) { 396.1 }
-        
+
         it { expect(actual).to eq 5029200 }
       end
       describe 'when argument is integer' do
         let(:value) { 396 }
-        
+
         it { expect(actual).to eq 5029200 }
       end
     end
-    
+
   end
-  
-end
+
+end