caracal 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fcf1c14ed4f280850b2fd85c9e05b668d145d5a
-  data.tar.gz: 17b7bb50ebecfe644ae93db4dd49516df2d12ff3
+  metadata.gz: fd6f4b1d2999578352b19dc9b0a37550421fee95
+  data.tar.gz: f5ece05dd0fb90bea538a8c0cdf8fa9073fd6e18
 SHA512:
-  metadata.gz: 3741512f2d8b8fbd429609d33cdd9874afbde332a900a531daf2c7a1821314e3de573d948603e1e3e30421b174fd2203a4cecac130aab69b590eb33446a5d42c
-  data.tar.gz: e21fabe22f0a570c2f18dbf3236d6e1591ada99c149337d1b8ba79176397ea4c6e59cc413a999c9103db58dccd2671d900bfdb62f4edb7882eae3ea652bc7ed0
+  metadata.gz: 9aacd3a282bce1a381f62af7e8b8643f96035ded1d2516cb51459df8071833f010f8080f1628fa48b71cfc0c9f3a29f6c69fe08e30eed2826148ac3a46a996a4
+  data.tar.gz: 6222df0d328b719a19e2cdf2a5139025654ad928b4423c7ad2c2fd07fcb583af928df4528c029db2f7013bb8f0cc403dd2a00100ca6150db9c8612c802e26bc8

data/README.md

@@ -304,7 +304,7 @@ end
 
 Fonts are added to the font table file by calling the `font` method and passing the name of the font.  
 
-*At present, Caracal only supports declaring the primary font name.
+*At present, Caracal only supports declaring the primary font name.*
 
 ```ruby
 docx.font do
@@ -514,6 +514,7 @@ Images can be added by using the `img` method.  The method accepts several optio
 
 ```ruby
 docx.img image_url('example.png') do
+  data    raw_data  # sets the file data directly instead of opening the url
   width   396       # sets the image width. units specified in pixels.
   height  216       # sets the image height. units specified in pixels.
   align   :right    # controls the justification of the image. default is :left.
@@ -524,6 +525,11 @@ docx.img image_url('example.png') do
 end
 ```
 
+*Note: If you provide the image data, you should still supply a URL. I know this 
+is a bit hacky, but it allows the library to key the image more effectively and 
+Caracal needs a file extension to apply to the renamed media file. This seemed 
+the simplest solution to both problems.*
+
 
 ### Tables
 

data/lib/caracal/core/models/image_model.rb

@@ -24,6 +24,7 @@ module Caracal
         
         # accessors
         attr_reader :image_url
+        attr_reader :image_data
         attr_reader :image_width
         attr_reader :image_height
         attr_reader :image_align
@@ -60,6 +61,10 @@ module Caracal
           end
         end
         
+        def relationship_target
+          image_url || image_data
+        end
+        
         
         #=============== SETTERS ==============================
         
@@ -71,7 +76,7 @@ module Caracal
         end
         
         # strings
-        [:url].each do |m|
+        [:data, :url].each do |m|
           define_method "#{ m }" do |value|
             instance_variable_set("@image_#{ m }", value.to_s)
           end

data/lib/caracal/core/models/relationship_model.rb

@@ -27,10 +27,11 @@ module Caracal
         
         # accessors
         attr_reader :relationship_id
+        attr_reader :relationship_key
         attr_reader :relationship_type
         attr_reader :relationship_target
-        attr_reader :relationship_key
-        
+        attr_reader :relationship_data
+    
         
         
         #-------------------------------------------------------------
@@ -63,13 +64,17 @@ module Caracal
           @relationship_id = value.to_i
         end
         
+        def type(value)
+          @relationship_type = value.to_s.downcase.to_sym
+        end
+        
         def target(value)
           @relationship_target = value.to_s
           @relationship_key    = value.to_s.downcase
         end
         
-        def type(value)
-          @relationship_type = value.to_s.downcase.to_sym
+        def data(value)
+          @relationship_data = value.to_s
         end
         
         
@@ -98,7 +103,7 @@ module Caracal
         private
         
         def option_keys
-          [:id, :type, :target]
+          [:id, :type, :target, :data]
         end
         
       end

data/lib/caracal/document.rb

@@ -196,7 +196,9 @@ module Caracal
     def render_media(zip)
       images = relationships.select { |r| r.relationship_type == :image }
       images.each do |rel|
-        content = open(rel.relationship_target).read
+        unless content = rel.relationship_data
+          content = open(rel.relationship_target).read
+        end
         
         zip.put_next_entry("word/#{ rel.formatted_target }")
         zip.write(content)

data/lib/caracal/renderers/document_renderer.rb

@@ -96,7 +96,7 @@ module Caracal
           raise Caracal::Errors::NoDefaultStyleError 'Document must declare a default paragraph style.'
         end
         
-        rel      = document.relationship({ target: model.image_url, type: :image })
+        rel      = document.relationship({ type: :image, target: model.image_url, data: model.image_data })
         rel_id   = rel.relationship_id
         rel_name = rel.formatted_target
         

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

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

@@ -36,6 +36,7 @@ describe Caracal::Core::Models::ImageModel do
     # accessors
     describe 'accessors' do
       it { expect(subject.image_url).to    eq 'https://www.google.com/images/srpr/logo11w.png' }
+      it { expect(subject.image_data).to   eq nil }
       it { expect(subject.image_width).to  eq 250 }
       it { expect(subject.image_height).to eq 200 }
       it { expect(subject.image_align).to  eq :right }
@@ -77,6 +78,13 @@ describe Caracal::Core::Models::ImageModel do
       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
+    
     # .width
     describe '.width' do
       before { subject.width(300) }

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

@@ -27,10 +27,11 @@ describe Caracal::Core::Models::RelationshipModel do
     
     # accessors
     describe 'accessors' do
-      it { expect(subject.relationship_id).to eq 3 }
-      it { expect(subject.relationship_type).to eq :footer }
+      it { expect(subject.relationship_id).to     eq 3 }
+      it { expect(subject.relationship_key).to    eq 'footer.xml' }
+      it { expect(subject.relationship_type).to   eq :footer }
       it { expect(subject.relationship_target).to eq 'footer.xml' }
-      it { expect(subject.relationship_key).to eq 'footer.xml' }
+      it { expect(subject.relationship_data).to   eq nil }
     end
     
   end
@@ -51,6 +52,15 @@ describe Caracal::Core::Models::RelationshipModel do
       it { expect(subject.relationship_id).to eq 3 }
     end
     
+    # .type
+    describe '.type' do
+      before do
+        subject.type('link')
+      end
+      
+      it { expect(subject.relationship_type).to eq :link }
+    end
+    
     # .target
     describe '.target' do
       before do
@@ -61,13 +71,13 @@ describe Caracal::Core::Models::RelationshipModel do
       it { expect(subject.relationship_key).to eq 'dummy.xml' }
     end
     
-    # .type
-    describe '.type' do
+    # .data
+    describe '.data' do
       before do
-        subject.type('link')
+        subject.data('Dummy data')
       end
       
-      it { expect(subject.relationship_type).to eq :link }
+      it { expect(subject.relationship_data).to eq 'Dummy data' }
     end
     
     
@@ -173,7 +183,7 @@ describe Caracal::Core::Models::RelationshipModel do
     # .option_keys
     describe '.option_keys' do
       let(:actual)   { subject.send(:option_keys).sort }
-      let(:expected) { [:id, :type, :target].sort }
+      let(:expected) { [:id, :type, :target, :data].sort }
       
       it { expect(actual).to eq expected }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Trade Infomatics