caracal 0.1.0

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

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

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Caracal::Core::Text do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # all commands
+    [:p, :h1, :h2, :h3, :h4, :h5, :h6].each do |cmd|
+      describe ".#{ cmd }" do
+        let!(:size) { subject.contents.size }
+      
+        before { subject.send(cmd, 'Smaple text.') }
+      
+        it { expect(subject.contents.size).to eq size + 1 }
+        it { expect(subject.contents.last).to be_a(Caracal::Core::Models::ParagraphModel) }
+      end
+    end
+    
+  end
+  
+  
+  #-------------------------------------------------------------
+  # Private Methods
+  #-------------------------------------------------------------
+
+  describe 'private method tests' do
+    
+    # .style_id_for_header
+    describe '.style_id_for_header' do
+      (1..6).each do |i|
+        describe "when h#{ i }" do
+          let(:actual) { subject.send(:style_id_for_header, "h#{ i }") }
+          
+          it { expect(actual).to eq "Heading#{ i }" }
+        end
+      end
+      describe 'when unknown return normal' do
+        let(:actual) { subject.send(:style_id_for_header, 'Dummy') }
+        
+        it { expect(actual).to eq 'Normal' }
+      end
+    end
+    
+  end
+  
+end

data/spec/lib/caracal/errors_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Caracal::Errors do
+  
+  # existence checks
+  it { expect(Caracal::Errors::InvalidModelError).not_to be_nil }
+  it { expect(Caracal::Errors::NoDefaultStyleError).not_to be_nil }
+  it { expect(Caracal::Errors::NoDocumentError).not_to be_nil }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'caracal'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: caracal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trade Infomatics
+- John Dugan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: " Caracal is a pure Ruby MSWord generation library that produces professional
+  quality Word documents using a simple, HTML-style DSL. "
+email:
+- jpdugan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- caracal.gemspec
+- lib/caracal.rb
+- lib/caracal/core/file_name.rb
+- lib/caracal/core/fonts.rb
+- lib/caracal/core/images.rb
+- lib/caracal/core/line_breaks.rb
+- lib/caracal/core/list_styles.rb
+- lib/caracal/core/lists.rb
+- lib/caracal/core/models/base_model.rb
+- lib/caracal/core/models/border_model.rb
+- lib/caracal/core/models/font_model.rb
+- lib/caracal/core/models/image_model.rb
+- lib/caracal/core/models/line_break_model.rb
+- lib/caracal/core/models/link_model.rb
+- lib/caracal/core/models/list_item_model.rb
+- lib/caracal/core/models/list_model.rb
+- lib/caracal/core/models/list_style_model.rb
+- lib/caracal/core/models/margin_model.rb
+- lib/caracal/core/models/page_break_model.rb
+- lib/caracal/core/models/page_number_model.rb
+- lib/caracal/core/models/page_size_model.rb
+- lib/caracal/core/models/paragraph_model.rb
+- lib/caracal/core/models/relationship_model.rb
+- lib/caracal/core/models/rule_model.rb
+- lib/caracal/core/models/style_model.rb
+- lib/caracal/core/models/table_cell_model.rb
+- lib/caracal/core/models/table_model.rb
+- lib/caracal/core/models/text_model.rb
+- lib/caracal/core/page_breaks.rb
+- lib/caracal/core/page_numbers.rb
+- lib/caracal/core/page_settings.rb
+- lib/caracal/core/relationships.rb
+- lib/caracal/core/rules.rb
+- lib/caracal/core/styles.rb
+- lib/caracal/core/tables.rb
+- lib/caracal/core/text.rb
+- lib/caracal/document.rb
+- lib/caracal/errors.rb
+- lib/caracal/renderers/app_renderer.rb
+- lib/caracal/renderers/content_types_renderer.rb
+- lib/caracal/renderers/core_renderer.rb
+- lib/caracal/renderers/document_renderer.rb
+- lib/caracal/renderers/fonts_renderer.rb
+- lib/caracal/renderers/footer_renderer.rb
+- lib/caracal/renderers/numbering_renderer.rb
+- lib/caracal/renderers/package_relationships_renderer.rb
+- lib/caracal/renderers/relationships_renderer.rb
+- lib/caracal/renderers/settings_renderer.rb
+- lib/caracal/renderers/styles_renderer.rb
+- lib/caracal/renderers/xml_renderer.rb
+- lib/caracal/version.rb
+- lib/tilt/caracal.rb
+- spec/lib/caracal/core/file_name_spec.rb
+- spec/lib/caracal/core/fonts_spec.rb
+- spec/lib/caracal/core/images_spec.rb
+- spec/lib/caracal/core/line_breaks_spec.rb
+- spec/lib/caracal/core/list_styles_spec.rb
+- spec/lib/caracal/core/lists_spec.rb
+- spec/lib/caracal/core/models/base_model_spec.rb
+- spec/lib/caracal/core/models/border_model_spec.rb
+- spec/lib/caracal/core/models/font_model_spec.rb
+- spec/lib/caracal/core/models/image_model_spec.rb
+- spec/lib/caracal/core/models/line_break_model_spec.rb
+- spec/lib/caracal/core/models/link_model_spec.rb
+- spec/lib/caracal/core/models/list_item_model_spec.rb
+- spec/lib/caracal/core/models/list_model_spec.rb
+- spec/lib/caracal/core/models/list_style_model_spec.rb
+- spec/lib/caracal/core/models/margin_model_spec.rb
+- spec/lib/caracal/core/models/page_break_model_spec.rb
+- spec/lib/caracal/core/models/page_number_model_spec.rb
+- spec/lib/caracal/core/models/page_size_model_spec.rb
+- spec/lib/caracal/core/models/paragraph_model_spec.rb
+- spec/lib/caracal/core/models/relationship_model_spec.rb
+- spec/lib/caracal/core/models/rule_model_spec.rb
+- spec/lib/caracal/core/models/style_model_spec.rb
+- spec/lib/caracal/core/models/table_cell_model_spec.rb
+- spec/lib/caracal/core/models/table_model_spec.rb
+- spec/lib/caracal/core/models/text_model_spec.rb
+- spec/lib/caracal/core/page_breaks_spec.rb
+- spec/lib/caracal/core/page_numbers_spec.rb
+- spec/lib/caracal/core/page_settings_spec.rb
+- spec/lib/caracal/core/relationships_spec.rb
+- spec/lib/caracal/core/rules_spec.rb
+- spec/lib/caracal/core/styles_spec.rb
+- spec/lib/caracal/core/tables_spec.rb
+- spec/lib/caracal/core/text_spec.rb
+- spec/lib/caracal/errors_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/trade-informatics/caracal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fast, professional MSWord writer for Ruby.
+test_files:
+- spec/lib/caracal/core/file_name_spec.rb
+- spec/lib/caracal/core/fonts_spec.rb
+- spec/lib/caracal/core/images_spec.rb
+- spec/lib/caracal/core/line_breaks_spec.rb
+- spec/lib/caracal/core/list_styles_spec.rb
+- spec/lib/caracal/core/lists_spec.rb
+- spec/lib/caracal/core/models/base_model_spec.rb
+- spec/lib/caracal/core/models/border_model_spec.rb
+- spec/lib/caracal/core/models/font_model_spec.rb
+- spec/lib/caracal/core/models/image_model_spec.rb
+- spec/lib/caracal/core/models/line_break_model_spec.rb
+- spec/lib/caracal/core/models/link_model_spec.rb
+- spec/lib/caracal/core/models/list_item_model_spec.rb
+- spec/lib/caracal/core/models/list_model_spec.rb
+- spec/lib/caracal/core/models/list_style_model_spec.rb
+- spec/lib/caracal/core/models/margin_model_spec.rb
+- spec/lib/caracal/core/models/page_break_model_spec.rb
+- spec/lib/caracal/core/models/page_number_model_spec.rb
+- spec/lib/caracal/core/models/page_size_model_spec.rb
+- spec/lib/caracal/core/models/paragraph_model_spec.rb
+- spec/lib/caracal/core/models/relationship_model_spec.rb
+- spec/lib/caracal/core/models/rule_model_spec.rb
+- spec/lib/caracal/core/models/style_model_spec.rb
+- spec/lib/caracal/core/models/table_cell_model_spec.rb
+- spec/lib/caracal/core/models/table_model_spec.rb
+- spec/lib/caracal/core/models/text_model_spec.rb
+- spec/lib/caracal/core/page_breaks_spec.rb
+- spec/lib/caracal/core/page_numbers_spec.rb
+- spec/lib/caracal/core/page_settings_spec.rb
+- spec/lib/caracal/core/relationships_spec.rb
+- spec/lib/caracal/core/rules_spec.rb
+- spec/lib/caracal/core/styles_spec.rb
+- spec/lib/caracal/core/tables_spec.rb
+- spec/lib/caracal/core/text_spec.rb
+- spec/lib/caracal/errors_spec.rb
+- spec/spec_helper.rb