caracal 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b30278ea80ad76f441a2ea9f6c593882dd949a3
-  data.tar.gz: ba375c68ca17a0d4a02c1a6bd94014d981c9ad71
+  metadata.gz: bb4f8f78bfe33c9d9d5070949adf296c1d6921ed
+  data.tar.gz: 2ee67fa3530320cbcd1b0cbff6067838241e7dd7
 SHA512:
-  metadata.gz: aeeaa43517f427a98e241a16e630a8a7382679322064dea47a044043960a2ed05cc8ffcc9e1a3a53e9d6d94d9584c719e37ea643866aa9c1de5b4ccfb0a36b2b
-  data.tar.gz: 36f3e961946d533924e25a0b3f32470762f16e51d33ef3b679c242a55594e1d112e55125dae26ec0bb1e6432832a39eb3c0743873e578a1171c2e6d121320361
+  metadata.gz: 35ae59436ca344e6deb31bd9db3086affcfe492929e0783ca828e2a3fd496f77168a2628bb493baca079591a060d292a87eaba07033c5077761bba3c608874a5
+  data.tar.gz: 11214dec66d45079254a0a36476d6a2de9f27c7b2ae914069df5c82dbc420bee6e7162a890aab143f87853b5866e045f6a6f84c727d838240833670ad463f9cd

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 gemfiles/*.gemfile.lock
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+#### v0.2.0
+
+* Enhancements
+	* Implemented true line breaks within paragraphs (@Linuus).
+	* Converted paragraph command to accept/allow blank content (@Linuus).
+	* Allowed :top and :bottom attributes to be set on default paragraph style (@jpdugan).
+
+
+* Deprecations
+	* Line breaks are no longer allowed at the document level. Use blank paragraphs instead.
+
+
+
+#### v0.1.x
+
+* Enhancements
+	* Initial commits. (@jpdugan) 	 

data/README.md

@@ -22,10 +22,10 @@ Caracal::Document.save 'example.docx' do |docx|
   # page 1
   docx.h1 'Page 1 Header'
   docx.hr
-  docx.br
+  docx.p
   docx.h2 'Section 1'
   docx.p  'Lorem ipsum dolor....'
-  docx.br
+  docx.p
   docx.table @my_data, border_size: 4 do
     cell_style rows[0], background: 'cccccc', bold: true
   end
@@ -34,19 +34,19 @@ Caracal::Document.save 'example.docx' do |docx|
   docx.page
   docx.h1 'Page 2 Header'
   docx.hr
-  docx.br
+  docx.p
   docx.h2 'Section 2'
   docx.p  'Lorem ipsum dolor....'
   docx.ul do
     li 'Item 1'
     li 'Item 2'
   end
-  docx.br
+  docx.p
   docx.img image_url('graph.png'), width: 500, height: 300
 end
 ```
 
-**You can! Read on.**
+**You can!** Read on.
 
 
 ## Why is Caracal Needed?
@@ -330,7 +330,8 @@ docx.style do
   align     :left           # sets the alignment. accepts :left, :center, :right, and :both.
   line      360             # sets the line height. units in twips.
   top       100             # sets the spacing above the paragraph. units in twips.
-  bottom    0               # sets the spacing below the paragraph. units in twips.end
+  bottom    0               # sets the spacing below the paragraph. units in twips.
+end
 ```
 
 Caracal establishes a standard set of default styles for every document. Default styles can be overridden by issuing a `style` command referencing an existing id. Default style ids are:
@@ -348,7 +349,7 @@ Caracal establishes a standard set of default styles for every document. Default
 
 ### Paragraphs
 
-Paragrpah text can be added using the `p` method.  The method accepts several optional parameters for controlling the style and behavior of the paragrpah. 
+Paragraph text can be added using the `p` method.  The method accepts several optional parameters for controlling the style and behavior of the paragrpah. 
 
 In its simple form, a paragraph accepts a text string and formatting options.
 
@@ -376,6 +377,8 @@ docx.p do
   link 'link', 'https://www.example.com'
   text ' to something awesome', color: '555555', size: 32, bold: true, italic: true, underline: true
   text '.'
+  br
+  text 'This text follows a line break.'
 end
 ```
 
@@ -431,10 +434,20 @@ end
 
 ### Line Breaks
 
-Line breaks can be added via the `br` method.  The method accepts no parameters.
+Line breaks can be added via the `br` method inside paragraphs.
+
+```ruby
+docx.p do
+  text 'This sentence precedes the line break.'
+  br
+  text 'This sentence follows the line break.'
+end
+```
+
+Line breaks only work instead paragraph-like commands. If you want to create an empty line between two paragraphs, use an empty paragraph instead.
 
 ```ruby
-docx.br     # adds a blank line using the default paragrpah style.
+docx.p
 ```
 
 
@@ -449,6 +462,8 @@ docx.ol do
     text 'Second item with a '
     link 'link', 'http://www.google.com'
     text '.'
+    br
+    text 'This sentence follows a line break.'
   end
 end
 ```
@@ -462,6 +477,8 @@ docx.ul do
     text 'Second item with a '
     link 'link', 'http://www.google.com'
     text '.'
+    br
+    text 'This sentence follows a line break.'
   end
 end
 ```
@@ -588,7 +605,7 @@ c1 = Caracal::Core::Models:TableCellModel.new do
   end
   
   p 'This is a sentence above an image.'
-  br
+  p
   img image_url('example.png'), width: 200, height: 100
 end  
 ```

data/lib/caracal.rb

@@ -24,9 +24,8 @@ require 'caracal/document'
 #
 Caracal::Core::Models::TableCellModel.class_eval do
   include Caracal::Core::Images
-  include Caracal::Core::LineBreaks
   include Caracal::Core::Lists
   include Caracal::Core::Rules
   include Caracal::Core::Tables
   include Caracal::Core::Text
-end
+end

data/lib/caracal/core/models/list_item_model.rb

@@ -65,6 +65,7 @@ module Caracal
           else
             raise Caracal::Errors::InvalidModelError, 'Ordered lists require at least one list item.'
           end
+          model
         end
         
         # .ul
@@ -77,6 +78,7 @@ module Caracal
           else
             raise Caracal::Errors::InvalidModelError, 'Unordered lists require at least one list item.'
           end
+          model
         end
         
         

data/lib/caracal/core/models/list_model.rb

@@ -103,6 +103,7 @@ module Caracal
           else
             raise Caracal::Errors::InvalidModelError, 'List item must have at least one run.'
           end
+          model
         end
         
         

data/lib/caracal/core/models/paragraph_model.rb

@@ -28,10 +28,8 @@ module Caracal
         
         # initialization
         def initialize(options={}, &block)
-          if content = options.delete(:content)
-            text content, options.dup
-          end
-          
+          content = options.delete(:content) { "" }
+          text content, options.dup
           super options, &block
         end
         
@@ -104,6 +102,14 @@ module Caracal
           else
             raise Caracal::Errors::InvalidModelError, ':link method must receive strings for the display text and the external href.'
           end
+          model
+        end
+
+        # .br
+        def br
+          model = Caracal::Core::Models::LineBreakModel.new()
+          runs << model
+          model
         end
         
         # .text
@@ -117,6 +123,7 @@ module Caracal
           else
             raise Caracal::Errors::InvalidModelError, ':text method must receive a string for the display text.'
           end
+          model
         end
         
         
@@ -140,4 +147,4 @@ module Caracal
       
     end
   end
-end
+end

data/lib/caracal/core/text.rb

@@ -1,4 +1,5 @@
 require 'caracal/core/models/paragraph_model'
+require 'caracal/core/models/line_break_model'
 require 'caracal/errors'
 
 
@@ -71,4 +72,4 @@ module Caracal
     end
     
   end
-end
+end

data/lib/caracal/document.rb

@@ -4,7 +4,6 @@ require 'zip'
 require 'caracal/core/file_name'
 require 'caracal/core/fonts'
 require 'caracal/core/images'
-require 'caracal/core/line_breaks'
 require 'caracal/core/list_styles'
 require 'caracal/core/lists'
 require 'caracal/core/page_breaks'
@@ -47,7 +46,6 @@ module Caracal
     include Caracal::Core::ListStyles
     
     include Caracal::Core::Images
-    include Caracal::Core::LineBreaks
     include Caracal::Core::Lists
     include Caracal::Core::PageBreaks
     include Caracal::Core::Rules
@@ -243,4 +241,4 @@ module Caracal
     end
         
   end
-end
+end

data/lib/caracal/renderers/document_renderer.rb

@@ -149,13 +149,8 @@ module Caracal
       end
       
       def render_linebreak(xml, model)
-        xml.send 'w:p', paragraph_options do
-          xml.send 'w:pPr' do
-            xml.send 'w:contextualSpacing', { 'w:val' => '0' }
-          end
-          xml.send 'w:r', run_options do
-            xml.send 'w:rtl', { 'w:val' => '0' }
-          end
+        xml.send 'w:r' do
+          xml.send 'w:br'
         end
       end
       
@@ -312,10 +307,9 @@ module Caracal
         
         # don't know why this is needed, but it prevents a 
         # rendering error.
-        render_linebreak(xml, Caracal::Core::Models::LineBreakModel.new)
-      end      
-      
-      
+        render_paragraph(xml, Caracal::Core::Models::ParagraphModel.new)
+      end
+
       
       #============= OPTIONS ===================================
       
@@ -357,4 +351,4 @@ module Caracal
    
     end
   end
-end
+end

data/lib/caracal/renderers/styles_renderer.rb

@@ -43,7 +43,7 @@ module Caracal
                   xml.send 'w:keepNext',     { 'w:val' => '0' }
                   xml.send 'w:keepLines',    { 'w:val' => '0' }
                   xml.send 'w:widowControl', { 'w:val' => '1' }
-                  xml.send 'w:spacing',      { 'w:lineRule' => 'auto', 'w:line' => s.style_line, 'w:before' => '0', 'w:after' => '0' }
+                  xml.send 'w:spacing',      spacing_options(s, true)
                   xml.send 'w:ind',          { 'w:left' => '0', 'w:firstLine' => '0', 'w:right' => '0' }
                   xml.send 'w:jc',           { 'w:val' => s.style_align.to_s }
                 end
@@ -69,8 +69,9 @@ module Caracal
                 xml.send 'w:basedOn', { 'w:val' => s.style_base }
                 xml.send 'w:next',    { 'w:val' => s.style_next }
                 xml.send 'w:pPr' do
-                  xml.send 'w:keepNext',          { 'w:val' => '1' }
-                  xml.send 'w:keepLines',         { 'w:val' => '1' }
+                  xml.send 'w:keepNext',          { 'w:val' => '0' }
+                  xml.send 'w:keepLines',         { 'w:val' => '0' }
+                  xml.send 'w:widowControl',      { 'w:val' => '1' }
                   xml.send 'w:spacing',           spacing_options(s)                              unless spacing_options(s).nil?
                   xml.send 'w:contextualSpacing', { 'w:val' => '1' }
                   xml.send 'w:jc',                { 'w:val' => s.style_align.to_s }               unless s.style_align.nil?
@@ -122,9 +123,9 @@ module Caracal
         { 'w:cs' => name, 'w:hAnsi' => name, 'w:eastAsia' => name, 'w:ascii' => name }
       end
       
-      def spacing_options(style)
-        top     = style.style_top
-        bottom  = style.style_bottom
+      def spacing_options(style, default=false)
+        top     = (default) ? style.style_top.to_i    : style.style_top
+        bottom  = (default) ? style.style_bottom.to_i : style.style_bottom
         line    = style.style_line
         
         options = nil

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

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

@@ -13,6 +13,7 @@ describe Caracal::Core::Models::ParagraphModel do
     end
   end
   
+
   #-------------------------------------------------------------
   # Configuration
   #-------------------------------------------------------------
@@ -29,9 +30,9 @@ describe Caracal::Core::Models::ParagraphModel do
       it { expect(subject.paragraph_italic).to eq false }
       it { expect(subject.paragraph_underline).to eq true }
     end
-    
+
   end
-  
+
   
   #-------------------------------------------------------------
   # Public Methods
@@ -110,6 +111,15 @@ describe Caracal::Core::Models::ParagraphModel do
       
       it { expect(subject.runs.size).to eq length + 1 }
     end
+
+    # .br
+    describe '.br' do
+      let!(:length) { subject.runs.length }
+      
+      before { subject.br }
+      
+      it { expect(subject.runs.size).to eq length + 1 }
+    end
     
     # .text
     describe '.text' do
@@ -159,4 +169,4 @@ describe Caracal::Core::Models::ParagraphModel do
     
   end
   
-end
+end

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

@@ -101,14 +101,14 @@ describe Caracal::Core::Models::TableCellModel do
     
     describe 'content functions' do
     
-      # .br
-      describe '.br' do
+      # .p
+      describe '.p' do
         let!(:size) { subject.contents.size }
       
-        before { subject.br }
+        before { subject.p }
       
         it { expect(subject.contents.size).to eq size + 1 }
-        it { expect(subject.contents.last).to be_a(Caracal::Core::Models::LineBreakModel) }
+        it { expect(subject.contents.last).to be_a(Caracal::Core::Models::ParagraphModel) }
       end
     
       # .img
@@ -218,4 +218,4 @@ describe Caracal::Core::Models::TableCellModel do
     
   end
   
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Trade Infomatics
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -105,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,7 +115,6 @@ files:
 - 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
@@ -165,7 +165,6 @@ 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
@@ -226,7 +225,6 @@ 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

data/lib/caracal/core/line_breaks.rb

@@ -1,29 +0,0 @@
-require 'caracal/core/models/line_break_model'
-
-
-module Caracal
-  module Core
-    
-    # This module encapsulates all the functionality related to adding line
-    # breaks to the document.
-    #
-    module LineBreaks
-      def self.included(base)
-        base.class_eval do
-          
-          #-------------------------------------------------------------
-          # Public Methods
-          #-------------------------------------------------------------
-          
-          def br
-            model     = Caracal::Core::Models::LineBreakModel.new()
-            contents << model
-            model
-          end
-          
-        end
-      end
-    end
-    
-  end
-end

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

@@ -1,25 +0,0 @@
-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