caracal 0.1.0

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

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::TextModel do
+  subject do 
+    described_class.new do
+      content     'Lorem ipsum dolor....'
+      style       'Fancy'
+      color       '666666'
+      size        20
+      bold        false
+      italic      false
+      underline   true
+    end
+  end
+  
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+    
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.text_content).to eq 'Lorem ipsum dolor....' }
+      it { expect(subject.text_style).to eq 'Fancy' }
+      it { expect(subject.text_color).to eq '666666' }
+      it { expect(subject.text_size).to eq 20 }
+      it { expect(subject.text_bold).to eq false }
+      it { expect(subject.text_italic).to eq false }
+      it { expect(subject.text_underline).to eq true }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+  
+  describe 'public method tests' do
+    
+    #=============== GETTERS ==========================
+    
+    # .run_attributes
+    describe '.run_attributes' do
+      let(:expected) { { style: 'Fancy', color: '666666', size: 20, bold: false, italic: false, underline: true } }
+      
+      it { expect(subject.run_attributes).to eq expected }
+    end
+    
+    
+    #=============== SETTERS ==========================
+    
+    # booleans
+    describe '.bold' do
+      before { subject.bold(true) }
+      
+      it { expect(subject.text_bold).to eq true }
+    end
+    describe '.italic' do
+      before { subject.italic(true) }
+      
+      it { expect(subject.text_italic).to eq true }
+    end
+    describe '.underline' do
+      before { subject.underline(true) }
+      
+      it { expect(subject.text_underline).to eq true }
+    end
+    
+    # integers
+    describe '.size' do
+      before { subject.size(24) }
+      
+      it { expect(subject.text_size).to eq 24 }
+    end
+    
+    # strings
+    describe '.color' do
+      before { subject.color('999999') }
+      
+      it { expect(subject.text_color).to eq '999999' }
+    end
+    describe '.content' do
+      before { subject.content('Something Else') }
+      
+      it { expect(subject.text_content).to eq 'Something Else' }
+    end
+    describe '.style' do
+      before { subject.style('Dummy') }
+      
+      it { expect(subject.text_style).to eq 'Dummy' }
+    end
+    
+    
+    #=============== VALIDATION ===========================
+    
+    describe '.valid?' do
+      describe 'when required attributes provided' do
+        it { expect(subject.valid?).to eq true }
+      end
+      [:content].each do |prop|
+        describe "when #{ prop } nil" do
+          before do
+            allow(subject).to receive("text_#{ prop }").and_return(nil)
+          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) { [:content, :style, :color, :size, :bold, :italic, :underline].sort }
+      
+      it { expect(actual).to eq expected }
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Caracal::Core::PageBreaks do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .page
+    describe '.page' do
+      let!(:size) { subject.contents.size }
+      
+      before { subject.page }
+      
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::PageBreakModel) }
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Caracal::Core::PageSettings do
+  subject { Caracal::Document.new }
+  
+    
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+    
+    # constants
+    describe 'page number constants' do
+      it { expect(subject.class::DEFAULT_PAGE_NUMBER_ALIGN).to  eq :center }
+    end
+      
+    # readers
+    describe 'page number readers' do
+      it { expect(subject.page_number_show).to eq false }
+      it { expect(subject.page_number_align).to eq :center }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public methods tests' do
+    
+    # .page_numbers
+    describe '.page_numbers' do
+      describe 'when nothing given' do
+        before { subject.page_numbers }
+        
+        it { expect(subject.page_number_show).to eq false }
+        it { expect(subject.page_number_align).to eq :center }
+      end
+      describe 'when explicitly turned off' do
+        before { subject.page_numbers false }
+        
+        it { expect(subject.page_number_show).to eq false }
+        it { expect(subject.page_number_align).to eq :center }
+      end
+      describe 'when options given' do
+        before { subject.page_numbers true, align: :left }
+        
+        it { expect(subject.page_number_show).to eq true }
+        it { expect(subject.page_number_align).to eq :left }
+      end
+      describe 'when block given' do
+        before do
+          subject.page_numbers true do
+            align :left
+          end
+        end
+        
+        it { expect(subject.page_number_show).to eq true }
+        it { expect(subject.page_number_align).to eq :left }
+      end
+      describe 'when fancy block given' do
+        subject do
+          Caracal::Document.new do |docx|
+            a = :left
+            docx.page_numbers true do
+              align a
+            end
+          end
+        end
+        
+        it { expect(subject.page_number_show).to eq true }
+        it { expect(subject.page_number_align).to eq :left }
+      end
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe Caracal::Core::PageSettings do
+  subject { Caracal::Document.new }
+  
+    
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+    
+    # readers
+    describe 'page size readers' do
+      it { expect(subject.page_width).to eq 12240 }
+      it { expect(subject.page_height).to eq 15840 }
+    end
+    describe 'page margin readers' do
+      it { expect(subject.page_margin_top).to    eq 1440 }
+      it { expect(subject.page_margin_bottom).to eq 1440 }
+      it { expect(subject.page_margin_left).to   eq 1440 }
+      it { expect(subject.page_margin_right).to  eq 1440 }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public methods tests' do
+    
+    # .page_size
+    describe '.page_size' do
+      describe 'when options given' do
+        before { subject.page_size width: 10000, height: 12000 }
+        
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+      end
+      describe 'when block given' do
+        before do
+          subject.page_size do
+            width  10000
+            height 12000
+          end
+        end
+        
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+      end
+      describe 'when fancy block given' do
+        subject do
+          Caracal::Document.new do |docx|
+            w = 10000
+            h = 12000
+            docx.page_size do
+              width  w
+              height h
+            end
+          end
+        end
+        
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+      end
+      describe 'when both given' do
+        before do
+          subject.page_size width: 10000 do
+            height 12000
+          end
+        end
+        
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+      end
+    end
+    
+    # .page_margins
+    describe '.page_margins' do
+      describe 'when options given' do
+        before { subject.page_margins top: 1441, bottom: 1442, left: 1443, right: 1444 }
+        
+        it { expect(subject.page_margin_top).to    eq 1441 }
+        it { expect(subject.page_margin_bottom).to eq 1442 }
+        it { expect(subject.page_margin_left).to   eq 1443 }
+        it { expect(subject.page_margin_right).to  eq 1444 }
+      end
+      describe 'when block given' do
+        before do
+          subject.page_margins do
+            top    1441
+            bottom 1442
+            left   1443
+            right  1444
+          end
+        end
+        
+        it { expect(subject.page_margin_top).to    eq 1441 }
+        it { expect(subject.page_margin_bottom).to eq 1442 }
+        it { expect(subject.page_margin_left).to   eq 1443 }
+        it { expect(subject.page_margin_right).to  eq 1444 }
+      end
+      describe 'when fancy block given' do
+        subject do
+          Caracal::Document.new do |docx|
+            t = 1441
+            b = 1442
+            l = 1443
+            r = 1444
+            docx.page_margins do
+              top    t
+              bottom b
+              left   l
+              right  r
+            end
+          end
+        end
+        
+        it { expect(subject.page_margin_top).to    eq 1441 }
+        it { expect(subject.page_margin_bottom).to eq 1442 }
+        it { expect(subject.page_margin_left).to   eq 1443 }
+        it { expect(subject.page_margin_right).to  eq 1444 }
+      end
+      describe 'when both given' do
+        before do
+          subject.page_margins top: 1441, left: 1443 do
+            bottom 1442
+            right  1444
+          end
+        end
+        
+        it { expect(subject.page_margin_top).to    eq 1441 }
+        it { expect(subject.page_margin_bottom).to eq 1442 }
+        it { expect(subject.page_margin_left).to   eq 1443 }
+        it { expect(subject.page_margin_right).to  eq 1444 }
+      end
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Caracal::Core::Relationships do
+  let(:r1) { Caracal::Core::Models::RelationshipModel.new({ target: 'footer.xml', type: :footer }) }
+  let(:r2) { Caracal::Core::Models::RelationshipModel.new({ target: 'setting.xml', type: :setting }) }
+  
+  subject  { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Class Methods
+  #-------------------------------------------------------------
+
+  describe 'public class tests' do
+  
+    # .default_relationships
+    describe '.default_relationships' do
+      let(:expected) { [:font, :footer, :numbering, :setting, :style] }
+      let(:actual)   { subject.class.default_relationships.map { |r| r[:type] } }
+      
+      it { expect(actual).to eq expected }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    #============== ATTRIBUTES =====================
+    
+    # .relationship
+    describe '.relationship' do
+      it 'delegates to registration method' do
+        expect(subject).to receive(:register_relationship)
+        subject.relationship({ target: 'new.gif', type: :image })
+      end
+    end
+    
+    
+    #============== GETTERS ========================
+    
+    # .relationships
+    describe '.relationships' do
+      it { expect(subject.relationships).to be_a(Array) }
+    end
+    
+    # .find_relationship
+    describe '.find_relationship' do
+      let(:actual)  { subject.find_relationship(key) }
+      
+      before do
+        allow(subject).to receive(:relationships).and_return([r1])
+      end
+      
+      describe 'when key is registered' do
+        let(:key) { r1.relationship_key }
+        
+        it { expect(actual).to eq r1 }
+      end
+      describe 'when key is not registered' do
+        let(:key) { r2.relationship_key }
+        
+        it { expect(actual).to eq nil }
+      end
+    end
+    
+    
+    #============== REGISTRATION ========================
+    
+    # .register_relationship
+    describe '.register_relationship' do
+      let(:default_length) { subject.class.default_relationships.size }
+      
+      describe 'when not already registered' do
+        before do 
+          subject.register_relationship(r1)
+        end
+        
+        it { expect(subject.relationships.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do 
+          subject.register_relationship(r1) 
+          subject.register_relationship(r1)
+        end
+        
+        it { expect(subject.relationships.size).to eq default_length + 1 }
+      end
+    end
+    
+    # .unregister_relationship
+    describe '.unregister_relationship' do
+      let(:default_length) { subject.class.default_relationships.size }
+      
+      describe 'when registered' do
+        before do 
+          subject.register_relationship(r1)
+          subject.unregister_relationship(r1.relationship_target)
+        end
+        
+        it { expect(subject.relationships.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do 
+          subject.register_relationship(r1)
+          subject.unregister_relationship(r2.relationship_target)
+        end
+        
+        it { expect(subject.relationships.size).to eq default_length + 1 }
+      end
+    end
+    
+  end
+  
+end