caracal_the_curve 1.4.1

data/lib/caracal/utilities.rb

@@ -0,0 +1,23 @@
+# We're using this strategy borrowed from ActiveSupport to
+# make command syntax a little more flexible. In a perfect 
+# world we'd just use the double splat feature of Ruby, but 
+# support for that is pretty limited at this point, so we're 
+# going the extra mile to be cool.
+#
+module Caracal
+  class Utilities
+    
+    #-------------------------------------------------------------
+    # Public Class Methods
+    #-------------------------------------------------------------
+    
+    def self.extract_options!(args)
+      if args.last.is_a?(Hash)
+        args.pop
+      else
+        {}
+      end
+    end
+    
+  end
+end

data/lib/caracal/version.rb

@@ -0,0 +1,3 @@
+module Caracal
+  VERSION = '1.4.1'
+end

data/lib/caracal.rb

@@ -0,0 +1,40 @@
+#------------------------------------------------
+# Requirements
+#------------------------------------------------
+
+# external dependencies
+require 'tilt'
+
+# odds & ends
+require 'caracal/errors'
+require 'caracal/utilities'
+require 'caracal/version'
+
+# document
+require 'caracal/document'
+
+
+#------------------------------------------------
+# Extra Setup
+#------------------------------------------------
+
+# Convenience method for finding root directory.
+#
+module Caracal
+  def self.root
+    File.dirname __dir__
+  end
+end
+
+
+# Add functions to table cell model. we do this here to
+# avoid a circular require between Caracal::Core::Tables
+# and Caracal::Core::Models::TableCellModel.
+#
+Caracal::Core::Models::TableCellModel.class_eval do
+  include Caracal::Core::Images
+  include Caracal::Core::Lists
+  include Caracal::Core::Rules
+  include Caracal::Core::Tables
+  include Caracal::Core::Text
+end

data/lib/tilt/caracal.rb

@@ -0,0 +1,21 @@
+require 'tilt/template'
+require 'caracal'
+
+
+module Tilt
+  class CaracalTemplate < Template
+    self.default_mime_type = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+    
+    def prepare
+      @code =<<-RUBY
+        Caracal::Document.render do |docx|
+          #{ data }
+        end
+      RUBY
+    end
+    
+    def precompiled_template(locals)
+      @code
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Caracal::Core::Bookmarks do
+  subject { Caracal::Document.new }
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    # .bookmark_start
+    describe '.bookmark_start' do
+      let!(:size) { subject.contents.size }
+
+      before { subject.send('bookmark_start', id: '123', name: 'abc') }
+
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::BookmarkModel) }
+    end
+
+    # .bookmark_end
+    describe '.bookmark_end' do
+      let!(:size) { subject.contents.size }
+
+      before { subject.send('bookmark_end', id: '123') }
+
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::BookmarkModel) }
+    end
+
+  end
+
+end

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

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Caracal::Core::FileName do
+  let(:file_name) { 'test.docx' }
+  
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+    
+    # constants
+    describe 'file name constants' do
+      it { expect(subject.class::DEFAULT_FILE_NAME).to eq 'caracal.docx' }
+    end
+      
+    # accessors
+    describe 'file name readers' do
+      it { expect(subject.name).to eq 'caracal.docx' }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .file_name
+    describe '.file_name' do
+      let(:new_name)  { 'example.docx' }
+      let(:actual)    { subject.name }
+      
+      before { subject.file_name(new_name) }
+      
+      describe 'when argument provided' do
+        it { expect(actual).to eq new_name }
+      end
+      describe 'when argument nil' do
+        let!(:previous) { subject.name }
+        let(:new_name)  { nil }
+        
+        it { expect(actual).to eq previous }
+      end
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Caracal::Core::Fonts do
+  let(:f1) { Caracal::Core::Models::FontModel.new({ name: 'Helvetica' }) }
+  let(:f2) { Caracal::Core::Models::FontModel.new({ name: 'Garamond' }) }
+  
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Class Methods
+  #-------------------------------------------------------------
+
+  describe 'public class tests' do
+  
+    # .default_fonts
+    describe '.default_fonts' do
+      let(:expected) { ['Arial', 'Trebuchet MS'] }
+      let(:actual)   { subject.class.default_fonts.map { |r| r[:name] } }
+      
+      it { expect(actual).to eq expected }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    #============== ATTRIBUTES =====================
+    
+    # .font
+    describe '.font' do
+      it 'delegates font to registration method' do
+        expect(subject).to receive(:register_font)
+        subject.font({ name: 'Helvetica' })
+      end
+    end
+    
+    
+    #============== GETTERS ========================
+    
+    # .fonts
+    describe '.fonts' do
+      it { expect(subject.fonts).to be_a(Array) }
+    end
+    
+    # .find_font
+    describe '.find_font' do
+      let(:actual)  { subject.find_font(key) }
+      
+      before do
+        allow(subject).to receive(:fonts).and_return([f1])
+      end
+      
+      describe 'when key is registered' do
+        let(:key) { f1.font_name }
+        
+        it { expect(actual).to eq f1 }
+      end
+      describe 'when key is not registered' do
+        let(:key) { f2.font_name }
+        
+        it { expect(actual).to eq nil }
+      end
+    end
+    
+    
+    #============== REGISTRATION ========================
+    
+    # .register_font
+    describe '.register_font' do
+      let(:default_length) { subject.class.default_fonts.size }
+      
+      describe 'when not already registered' do
+        before do 
+          subject.register_font(f1)
+        end
+        
+        it { expect(subject.fonts.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do 
+          subject.register_font(f1) 
+          subject.register_font(f1)
+        end
+        
+        it { expect(subject.fonts.size).to eq default_length + 1 }
+      end
+    end
+    
+    # .unregister_font
+    describe '.unregister_font' do
+      let(:default_length) { subject.class.default_fonts.size }
+      
+      describe 'when registered' do
+        before do 
+          subject.register_font(f1)
+          subject.unregister_font(f1.font_name)
+        end
+        
+        it { expect(subject.fonts.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do 
+          subject.register_font(f1)
+          subject.unregister_font(f2.font_name)
+        end
+        
+        it { expect(subject.fonts.size).to eq default_length + 1 }
+      end
+    end
+    
+  end
+  
+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/images_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Caracal::Core::Images do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .img
+    describe '.img' do
+      let!(:size) { subject.contents.size }
+      
+      before { subject.img 'https://www.google.com/images/srpr/logo11w.png', width: 538, height: 190 }
+      
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::ImageModel) }
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Caracal::Core::ListStyles do
+  let(:s1) { Caracal::Core::Models::ListStyleModel.new({ type: :ordered, level: 10, format: 'decimal',     value: '%1.' }) }
+  let(:s2) { Caracal::Core::Models::ListStyleModel.new({ type: :ordered, level: 11, format: 'lowerLetter', value: '%2.' }) }
+  
+  subject  { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Class Methods
+  #-------------------------------------------------------------
+
+  describe 'public class tests' do
+  
+    # .default_list_styles
+    describe '.default_list_styles' do
+      let(:expected) { 18 }
+      let(:actual)   { subject.class.default_list_styles.size }
+
+      it {expect(actual).to eq expected }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    #============== ATTRIBUTES =====================
+    
+    # .list_style
+    describe '.list_style' do
+      it 'delegates to registration method' do
+        expect(subject).to receive(:register_list_style)
+        subject.list_style({ type: :ordered, level: 2, format: 'decimal', value: '2f.' })
+      end
+    end
+    
+    
+    #============== GETTERS ========================
+    
+    # .list_styles
+    describe '.list_styles' do
+      it { expect(subject.list_styles).to be_a(Array) }
+    end
+    
+    # .find_list_style
+    describe '.find_list_style' do
+      let(:actual)  { subject.find_list_style(type, level) }
+      
+      before do
+        allow(subject).to receive(:list_styles).and_return([s1])
+      end
+      
+      describe 'when key is registered' do
+        let(:type)  { s1.style_type  }
+        let(:level) { s1.style_level }
+        
+        it { expect(actual).to eq s1 }
+      end
+      describe 'when key is not registered' do
+        let(:type)  { s2.style_type  }
+        let(:level) { s2.style_level }
+        
+        it { expect(actual).to eq nil }
+      end
+    end
+    
+    
+    #============== REGISTRATION ========================
+    
+    # .register_list_style
+    describe '.register_list_style' do
+      let(:default_length) { subject.class.default_list_styles.size }
+      
+      describe 'when not already registered' do
+        before do 
+          subject.register_list_style(s1)
+        end
+        
+        it { expect(subject.list_styles.size).to eq default_length + 1 }
+      end
+      describe 'when already registered' do
+        before do 
+          subject.register_list_style(s1) 
+          subject.register_list_style(s1)
+        end
+        
+        it { expect(subject.list_styles.size).to eq default_length + 1 }
+      end
+    end
+    
+    # .unregister_list_style
+    describe '.unregister_list_style' do
+      let(:default_length) { subject.class.default_list_styles.size }
+      
+      describe 'when registered' do
+        before do 
+          subject.register_list_style(s1)
+          subject.unregister_list_style(s1.style_type, s1.style_level)
+        end
+        
+        it { expect(subject.list_styles.size).to eq default_length }
+      end
+      describe 'when not registered' do
+        before do 
+          subject.register_list_style(s1)
+          subject.unregister_list_style(s2.style_type, s2.style_level)
+        end
+        
+        it { expect(subject.list_styles.size).to eq default_length + 1 }
+      end
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Caracal::Core::Lists do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .ol
+    describe '.ol' do
+      let!(:size) { subject.contents.size }
+      
+      before do 
+        subject.ol do
+          li 'Item 1'
+        end
+      end
+        
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::ListModel) }
+    end
+    
+    # .ul
+    describe '.ul' do
+      let!(:size) { subject.contents.size }
+      
+      before do 
+        subject.ul do
+          li 'Item 1'
+        end
+      end
+        
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::ListModel) }
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::BaseModel do
+  subject { described_class.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+  
+  describe 'public method tests' do
+    
+    #=============== VALIDATION ===========================
+    
+    describe '.valid?' do
+      it { expect(subject.valid?).to eq true }
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Private Methods
+  #-------------------------------------------------------------
+  
+  describe 'private method tests' do
+    
+    # .option_keys
+    describe '.option_keys' do
+      let(:actual)   { subject.send(:option_keys).sort }
+      let(:expected) { [] }
+      
+      it { expect(actual).to eq expected }
+    end
+    
+  end
+  
+end