caracal_the_curve 1.4.1

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

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Caracal::Core::Namespaces do
+  let(:m1) { Caracal::Core::Models::NamespaceModel.new({ prefix: 'com', href: 'http://www.example.com' }) }
+  let(:m2) { Caracal::Core::Models::NamespaceModel.new({ prefix: 'org', href: 'http://www.example.org' }) }
+
+  subject  { Caracal::Document.new }
+
+
+  #-------------------------------------------------------------
+  # Class Methods
+  #-------------------------------------------------------------
+
+  describe 'public class tests' do
+
+    # .default_namespaces
+    describe '.default_namespaces' do
+      it { expect(subject.class.default_namespaces).to be_a(Array) }
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #============== ATTRIBUTES =====================
+
+    # .namespace
+    describe '.namespace' do
+      it 'delegates to registration method' do
+        expect(subject).to receive(:register_namespace)
+        subject.namespace({ prefix: 'dummy', href: 'http://www.dummy.com' })
+      end
+    end
+
+
+    #============== GETTERS ========================
+
+    # .namespaces
+    describe '.namespaces' do
+      it { expect(subject.namespaces).to be_a(Array) }
+    end
+
+    # .find_namespace
+    describe '.find_namespace' do
+      let(:actual)  { subject.find_namespace(key) }
+
+      before do
+        allow(subject).to receive(:namespaces).and_return([m1])
+      end
+
+      describe 'when key is registered' do
+        let(:key) { m1.namespace_prefix }
+
+        it { expect(actual).to eq m1 }
+      end
+      describe 'when key is not registered' do
+        let(:key) { m2.namespace_prefix }
+
+        it { expect(actual).to eq nil }
+      end
+    end
+
+
+    #============== REGISTRATION ========================
+
+    # .register_namespace
+    describe '.register_namespace' do
+      let(:default_length) { subject.class.default_namespaces.size }
+
+      describe 'when not already registered' do
+        before do
+          subject.register_namespace(m1)
+        end
+
+        it { expect(subject.namespaces.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do
+          subject.register_namespace(m1)
+          subject.register_namespace(m1)
+        end
+
+        it { expect(subject.namespaces.size).to eq default_length + 1 }
+      end
+    end
+
+    # .unregister_namespace
+    describe '.unregister_namespace' do
+      let(:default_length) { subject.class.default_namespaces.size }
+
+      describe 'when registered' do
+        before do
+          subject.register_namespace(m1)
+          subject.unregister_namespace(m1.namespace_prefix)
+        end
+
+        it { expect(subject.namespaces.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do
+          subject.register_namespace(m1)
+          subject.unregister_namespace(m2.namespace_prefix)
+        end
+
+        it { expect(subject.namespaces.size).to eq default_length + 1 }
+      end
+    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,89 @@
+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_align).to eq :center }
+      it { expect(subject.page_number_label).to eq nil }
+      it { expect(subject.page_number_show).to eq false }
+    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_align).to eq :center }
+        it { expect(subject.page_number_label).to eq nil }
+        it { expect(subject.page_number_show).to eq false }
+      end
+      describe 'when explicitly turned off' do
+        before { subject.page_numbers false }
+
+        it { expect(subject.page_number_align).to eq :center }
+        it { expect(subject.page_number_label).to eq nil }
+        it { expect(subject.page_number_show).to eq false }
+      end
+      describe 'when options given' do
+        before { subject.page_numbers true, label: 'Custom Text', align: :left }
+
+        it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'Custom Text' }
+        it { expect(subject.page_number_show).to eq true }
+      end
+      describe 'when block given' do
+        before do
+          subject.page_numbers true do
+            align :left
+            label 'More Text'
+          end
+        end
+
+        it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'More Text' }
+        it { expect(subject.page_number_show).to eq true }
+      end
+      describe 'when fancy block given' do
+        subject do
+          Caracal::Document.new do |docx|
+            t = 'This is text'
+            a = :left
+            docx.page_numbers true do
+              label t
+              align a
+            end
+          end
+        end
+
+        it { expect(subject.page_number_align).to eq :left }
+        it { expect(subject.page_number_label).to eq 'This is text' }
+        it { expect(subject.page_number_show).to eq true }
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,151 @@
+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 }
+      it { expect(subject.page_orientation).to eq 'portrait' }
+    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, orientation: :landscape }
+
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
+      end
+      describe 'when block given' do
+        before do
+          subject.page_size do
+            width       10000
+            height      12000
+            orientation :landscape
+          end
+        end
+
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
+      end
+      describe 'when fancy block given' do
+        subject do
+          Caracal::Document.new do |docx|
+            w = 10000
+            h = 12000
+            o = :landscape
+            docx.page_size do
+              width       w
+              height      h
+              orientation o
+            end
+          end
+        end
+
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
+      end
+      describe 'when both given' do
+        before do
+          subject.page_size width: 10000, orientation: :landscape do
+            height 12000
+          end
+        end
+
+        it { expect(subject.page_width).to eq 10000 }
+        it { expect(subject.page_height).to eq 12000 }
+        it { expect(subject.page_orientation).to eq 'landscape' }
+      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(:m1) { Caracal::Core::Models::RelationshipModel.new({ target: 'footer.xml', type: :footer }) }
+  let(:m2) { 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([m1])
+      end
+
+      describe 'when key is registered' do
+        let(:key) { m1.relationship_key }
+
+        it { expect(actual).to eq m1 }
+      end
+      describe 'when key is not registered' do
+        let(:key) { m2.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(m1)
+        end
+
+        it { expect(subject.relationships.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do
+          subject.register_relationship(m1)
+          subject.register_relationship(m1)
+        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(m1)
+          subject.unregister_relationship(m1.relationship_target)
+        end
+
+        it { expect(subject.relationships.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do 
+          subject.register_relationship(m1)
+          subject.unregister_relationship(m2.relationship_target)
+        end
+
+        it { expect(subject.relationships.size).to eq default_length + 1 }
+      end
+    end
+
+  end
+
+end

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

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

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

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Caracal::Core::Styles do
+  let(:s1) { Caracal::Core::Models::StyleModel.new({ id: 'Dummy', name: 'dummy' }) }
+  let(:s2) { Caracal::Core::Models::StyleModel.new({ id: 'Fake',  name: 'fake' }) }
+  
+  subject  { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Class Methods
+  #-------------------------------------------------------------
+
+  describe 'public class tests' do
+  
+    # .default_styles
+    describe '.default_styles' do
+      let(:expected) { ['Normal', 'Heading1', 'Heading2', 'Heading3', 'Heading4', 'Heading5', 'Heading6', 'Title', 'Subtitle'].sort }
+      let(:actual)   { subject.class.default_styles.map { |s| s[:id] }.sort }
+
+      it {expect(actual).to eq expected }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    #============== ATTRIBUTES =====================
+    
+    # .style
+    describe '.style' do
+      it 'delegates to registration method' do
+        expect(subject).to receive(:register_style)
+        subject.style({ id: 'heading2', name: 'Heading 2' })
+      end
+    end
+    
+    
+    #============== GETTERS ========================
+    
+    # .styles
+    describe '.styles' do
+      it { expect(subject.styles).to be_a(Array) }
+    end
+    
+    # .default_style
+    describe '.default_style' do
+      before do
+        allow(s1).to receive(:style_default).and_return(true)
+        allow(subject).to receive(:styles).and_return([s1,s2])
+      end
+      
+      it { expect(subject.default_style).to eq s1 }
+    end
+    
+    # .find_style
+    describe '.find_style' do
+      let(:actual)  { subject.find_style(key) }
+      
+      before do
+        allow(subject).to receive(:styles).and_return([s1])
+      end
+      
+      describe 'when key is registered' do
+        let(:key) { s1.style_id }
+        
+        it { expect(actual).to eq s1 }
+      end
+      describe 'when key is not registered' do
+        let(:key) { s2.style_id }
+        
+        it { expect(actual).to eq nil }
+      end
+    end
+    
+    
+    #============== REGISTRATION ========================
+    
+    # .register_style
+    describe '.register_style' do
+      let(:default_length) { subject.class.default_styles.size }
+      
+      describe 'when not already registered' do
+        before do 
+          subject.register_style(s1)
+        end
+        
+        it { expect(subject.styles.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do 
+          subject.register_style(s1) 
+          subject.register_style(s1)
+        end
+        
+        it { expect(subject.styles.size).to eq default_length + 1 }
+      end
+    end
+    
+    # .unregister_style
+    describe '.unregister_style' do
+      let(:default_length) { subject.class.default_styles.size }
+      
+      describe 'when registered' do
+        before do 
+          subject.register_style(s1)
+          subject.unregister_style(s1.style_id)
+        end
+        
+        it { expect(subject.styles.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do 
+          subject.register_style(s1)
+          subject.unregister_style(s2.style_id)
+        end
+        
+        it { expect(subject.styles.size).to eq default_length + 1 }
+      end
+    end
+    
+  end
+  
+end

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

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