docx_generator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e7df426c133c37b61b38793acb9170ea8a679c1
-  data.tar.gz: 280949c5112c2173d160605878d8166b563eae30
+  metadata.gz: 24ad7dac74a46bba80074d78c61c3036b3edc4b0
+  data.tar.gz: 04ac19428d41ec7102c40f7906483b624f1c776b
 SHA512:
-  metadata.gz: 53c4c1b3963c15d5cbd56025f38d0ff2b25e3ac2744f01d148d64db0fa7effe51b37e591be3d73a777fe035aa9c581b0d03603bcecc062d79664c1682ad019b7
-  data.tar.gz: 020ccf60bc99bc5a032fd7ab7f5ed31a0372572483d484086f736ceb926bdffce209c81451e6208960049aa3b66f73113492b03a55ea1cd01666a7a70b7d0e9e
+  metadata.gz: 1cae7f9f66f6db08762573726408bf48ec5133e59e67a27f75c757a5d2c03f53c173303714c639d8b5033638a8a1af1ac55db729a7188660550249d33738d301
+  data.tar.gz: bc8f8b9857b4e64168da542135aaab693bab4105b0ed28ddf06d2f8d3d3bdd0d9c3f6c8cc61bab214eeafd8e26e0f36e358d5b26dd6abe19e6f16f588e9c1060

data/CHANGES

@@ -1,3 +1,9 @@
+# Version 0.0.2
+
+- Underline text
+- Change the font size
+- Align paragraphs
+
 # Version 0.0.1 (2013-05-11)
 
 Initial version

data/README.md

@@ -36,6 +36,8 @@ document.add_paragraph("Simple string of text and", document.text("some formatte
 document.save
 ```
 
+You can see more examples in the `examples` directory.
+
 ## Contributing
 
 1. Fork it
@@ -43,3 +45,5 @@ document.save
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/557c5048ed09993a48f60e0aa0869ab3 "githalytics.com")](http://githalytics.com/magicienap/docx_generator)

data/examples/basic_paragraph.rb

@@ -1,7 +1,8 @@
 require 'docx_generator'
 
 document = DocxGenerator::Document.new("basic_paragraph")
-document.add_paragraph("Simple string of text and", document.text("some formatted text", bold: true, italics: true))
+document.add_paragraph(document.text("Title", underline: { style: "double" }, size: 20), alignment: "center")
+document.add_paragraph("Simple string of text and", document.text("some formatted text", bold: true, italics: true, underline: { style: "single" }))
 document.add_paragraph(document.text("Antoine", bold: true), "How are you today?")
 document.add_paragraph(document.text("John", bold: true), document.text("(whispering)", bold: true, italics: true), "How are you today?")
 document.save

data/lib/docx_generator/document.rb

@@ -24,12 +24,24 @@ module DocxGenerator
     # text_fragments : Word::Text or String
     # Later: Paragraph Object, with Text Object
     def add_paragraph(*text_fragments)
+      arguments = {}
       content = []
       text_fragments.each do |text_fragment|
-        content.push(text_fragment.respond_to?(:generate) ? text_fragment : text(text_fragment))
-        content.push Word::Extensions.space
+        if text_fragment.respond_to?(:keys)
+          arguments = text_fragment
+        else
+          content.push(text_fragment.respond_to?(:generate) ? text_fragment : text(text_fragment))
+          content.push Word::Extensions.space
+        end
       end
       content.pop
+      if arguments.length != 0
+        options = []
+        arguments.each do |option, value|
+          options.push parse_paragraph_option(option, value)
+        end
+        content.unshift Word::ParagraphProperties.new({}, options)
+      end
       @content.push Word::Paragraph.new({}, content)
       self
     end
@@ -39,7 +51,7 @@ module DocxGenerator
       if arguments.length != 0
         options = []
         arguments.each do |option, value|
-          options.push parse_option(option, value)
+          options.push parse_text_option(option, value)
         end
         content.push Word::RunProperties.new({}, options)
       end
@@ -75,10 +87,18 @@ EOF
           [ Word::Body.new({}, @content) ]).to_s
       end
       
-      def parse_option(option, value)
+      def parse_text_option(option, value)
         case option
           when :bold then Word::Bold.new(value)
           when :italics then Word::Italics.new(value)
+          when :underline then Word::Underline.new(value)
+          when :size then Word::Size.new(value)
+        end
+      end
+
+      def parse_paragraph_option(option, value)
+        case option
+          when :alignment then Word::Alignment.new(value)
         end
       end
   end

data/lib/docx_generator/version.rb

@@ -1,3 +1,3 @@
 module DocxGenerator
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/docx_generator/word/base.rb

@@ -17,6 +17,12 @@ module DocxGenerator
         super("w:p", attributes, content)
       end
     end
+
+    class ParagraphProperties < Element
+      def initialize(attributes = {}, content = [])
+        super("w:pPr", attributes, content)
+      end
+    end
     
     class Run < Element
       def initialize(attributes = {}, content = [])

data/lib/docx_generator/word/formatting.rb

@@ -13,5 +13,31 @@ module DocxGenerator
         super("w:i", arguments)
       end
     end
+
+    class Underline < Element
+      def initialize(arguments = { "w:val" => "single" })
+        final_arguments = {}
+        arguments.each do |option, value|
+          case option
+            when :style then final_arguments["w:val"] = value
+            else final_arguments[option] = value
+          end
+        end
+        super("w:u", final_arguments)
+      end
+    end
+
+    class Size < Element
+      # size : The font size in points
+      def initialize(size)
+        super("w:sz", { "w:val" => size*2 })
+      end
+    end
+
+    class Alignment < Element
+      def initialize(value)
+        super("w:jc", { "w:val" => value })
+      end
+    end
   end
 end

data/spec/docx_generator/document_spec.rb

@@ -62,6 +62,13 @@ describe DocxGenerator::Document do
     it "should return the current document" do
       document.add_paragraph(["The first characters", "and the last ones."]).should be(document)
     end
+
+    context "with styles" do
+      it "should align the paragraph" do
+        document.add_paragraph(document.text("The first characters"), "and the last ones.", alignment: "center").save
+        open_file("word/document.xml").should include("<w:p><w:pPr><w:jc w:val=\"center\" /></w:pPr><w:r><w:t>The first characters</w:t></w:r><w:r><w:t xml:space=\"preserve\"> </w:t></w:r><w:r><w:t>and the last ones.</w:t></w:r></w:p>")
+      end
+    end
   end
   
   describe "#text" do
@@ -77,6 +84,14 @@ describe DocxGenerator::Document do
       it "should return a text in italics" do
         DocxGenerator::Document.new("word").text("Text", italics: true).to_s.should eq("<w:r><w:rPr><w:i w:val=\"true\" /></w:rPr><w:t>Text</w:t></w:r>")
       end
+      
+      it "should return an underlined text" do
+        DocxGenerator::Document.new("word").text("Text", underline: { style: "single" }).to_s.should eq("<w:r><w:rPr><w:u w:val=\"single\" /></w:rPr><w:t>Text</w:t></w:r>")
+      end
+
+      it "should return a text with a font size" do
+        DocxGenerator::Document.new("word").text("Text", size: 20).to_s.should eq("<w:r><w:rPr><w:sz w:val=\"40\" /></w:rPr><w:t>Text</w:t></w:r>")
+      end
     end
   end
 end

data/spec/docx_generator/word/base_spec.rb

@@ -22,6 +22,13 @@ describe DocxGenerator::Word::Paragraph do
   end
 end
 
+describe DocxGenerator::Word::ParagraphProperties do
+  it "should render a w:pPr element" do
+    DocxGenerator::Word::ParagraphProperties.new.to_s.should eq("<w:pPr />")
+    DocxGenerator::Word::ParagraphProperties.new({}, ["Text"]).to_s.should eq("<w:pPr>Text</w:pPr>")
+  end
+end
+
 describe DocxGenerator::Word::Run do
   it "should render a w:r element" do
     DocxGenerator::Word::Run.new.to_s.should eq("<w:r />")

data/spec/docx_generator/word/formatting_spec.rb

@@ -15,3 +15,22 @@ describe DocxGenerator::Word::Italics do
     DocxGenerator::Word::Italics.new(false).to_s.should eq("<w:i w:val=\"false\" />")
   end
 end
+
+describe DocxGenerator::Word::Underline do
+  it "should render a w:u element" do
+    DocxGenerator::Word::Underline.new.to_s.should eq("<w:u w:val=\"single\" />")
+    DocxGenerator::Word::Underline.new(style: "double").to_s.should eq("<w:u w:val=\"double\" />")
+  end
+end
+
+describe DocxGenerator::Word::Size do
+  it "should render a w:sz element" do
+    DocxGenerator::Word::Size.new(20).to_s.should eq("<w:sz w:val=\"40\" />")
+  end
+end
+
+describe DocxGenerator::Word::Alignment do
+  it "should render a w:jc element" do
+    DocxGenerator::Word::Alignment.new("center").to_s.should eq("<w:jc w:val=\"center\" />")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Antoine Proulx
@@ -137,6 +137,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- basic_paragraph.docx
 - docx_generator.gemspec
 - examples/basic_paragraph.rb
 - lib/docx_generator.rb