caracal 0.1.0

data/lib/caracal/renderers/xml_renderer.rb

@@ -0,0 +1,83 @@
+require 'nokogiri'
+
+
+module Caracal
+  module Renderers
+    class XmlRenderer
+      
+      #-------------------------------------------------------------
+      # Configuration
+      #-------------------------------------------------------------
+      
+      attr_reader :document
+      
+      
+      #-------------------------------------------------------------
+      # Class Methods
+      #-------------------------------------------------------------
+      
+      # This method produces xml output for the given document 
+      # according to the rules of this renderer object.
+      #
+      def self.render(doc)
+        renderer = new(doc)
+        renderer.to_xml
+      end
+      
+      
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+    
+      # This method instantiates a new verison of this renderer.
+      #
+      def initialize(doc)
+        unless doc.is_a?(Caracal::Document)
+          raise NoDocumentError, 'renderers must receive a reference to a valid Caracal document object.'
+        end
+        
+        @document = doc
+      end
+      
+      # This method converts data in the specified document to XML.
+      # A concrete implementation must be provided by the subclass.
+      #
+      def to_xml
+        raise NotImplementedError, 'renderers must implement the method :to_xml.'
+      end
+   
+   
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+      
+      # This method returns a Nokogiri::XML object that contains the 
+      # specific declaration we want.
+      #
+      def declaration_xml
+        ::Nokogiri::XML('<?xml version = "1.0" encoding = "UTF-8" standalone ="yes"?>')
+      end
+      
+      # This method returns a commonly used set of attributes for paragraph nodes.
+      #
+      def paragraph_options
+        { 'w:rsidP' => '00000000', 'w:rsidRDefault' => '00000000' }.merge(run_options)
+      end
+      
+      # This method returns a commonly used set of attributes for text run nodes.
+      #
+      def run_options
+        { 'w:rsidR' => '00000000', 'w:rsidRPr' => '00000000', 'w:rsidDel' => '00000000' }
+      end
+      
+      # These save options force Nokogiri to remove indentation and
+      # line feeds from the output.
+      #
+      def save_options
+        { save_with: Nokogiri::XML::Node::SaveOptions::AS_XML }
+      end
+      
+    end
+  end
+end

data/lib/caracal/version.rb

@@ -0,0 +1,3 @@
+module Caracal
+  VERSION = '0.1.0'
+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/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/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/line_breaks_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Caracal::Core::LineBreaks do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .br
+    describe '.br' do
+      let!(:size) { subject.contents.size }
+      
+      before { subject.br }
+      
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::LineBreakModel) }
+    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