docx_generator 0.1.0 → 0.1.1

data/lib/docx_generator.rb

@@ -1,9 +1,9 @@
-require 'docx_generator/version'
-require 'docx_generator/element'
-require 'docx_generator/word'
-require 'docx_generator/dsl'
-require 'zip/zip'
-
-# Main module of the library.
-module DocxGenerator
-end
+require 'docx_generator/version'
+require 'docx_generator/element'
+require 'docx_generator/word'
+require 'docx_generator/dsl'
+require 'zip'
+
+# Main module of the library.
+module DocxGenerator
+end

data/lib/docx_generator/dsl.rb

@@ -1,10 +1,10 @@
-require 'docx_generator/dsl/document'
-require 'docx_generator/dsl/paragraph'
-require 'docx_generator/dsl/text'
-
-module DocxGenerator
-  # Namespace for the classes to be used directly by users.
-  module DSL
-
-  end
+require 'docx_generator/dsl/document'
+require 'docx_generator/dsl/paragraph'
+require 'docx_generator/dsl/text'
+
+module DocxGenerator
+  # Namespace for the classes to be used directly by users.
+  module DSL
+
+  end
 end

data/lib/docx_generator/dsl/document.rb

@@ -1,75 +1,84 @@
-module DocxGenerator
-  module DSL
-    class Document
-      attr_reader :filename
-    
-      def initialize(filename, &block)
-        @filename = filename + ".docx"
-        @objects = [] # It contains all the DSL elements
-        yield self if block
-      end
-      
-      # Could be better
-      def save
-        content_types = generate_content_types
-        rels = generate_rels
-        document = generate_document
-        
-        File.delete(@filename) if File.exists?(@filename)
-        Zip::ZipFile.open(@filename, Zip::ZipFile::CREATE) do |docx|
-          docx.mkdir('_rels')
-          docx.mkdir('word')
-          docx.get_output_stream('[Content_Types].xml') { |f| f.puts content_types }
-          docx.get_output_stream('_rels/.rels') { |f| f.puts rels }
-          docx.get_output_stream('word/document.xml') { |f| f.puts document }
-        end
-      end
-
-      def paragraph(options = {}, &block)
-        par = DocxGenerator::DSL::Paragraph.new(options)
-        yield par if block
-        @objects << par
-      end
-
-      def add(*objects)
-        objects.each do |object|
-          @objects << object
-        end
-        self
-      end
-      
-      private
-      
-        def generate_content_types
-          <<EOF
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
-  <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
-  <Default Extension="xml" ContentType="application/xml"/>
-  <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>
-</Types>
-EOF
-        end
-        
-        def generate_rels
-          <<EOF
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
-  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
-</Relationships>
-EOF
-        end
-        
-        def generate_document
-          content = []
-          @objects.each do |object|
-            content << object.generate
-          end
-
-          '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
-          Word::Document.new({ "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main" },
-            [ Word::Body.new(content) ]).to_s
-        end
-    end
-  end
-end
+module DocxGenerator
+  module DSL
+    # Represent the docx document.
+    class Document
+      # Filename of the document (without the docx extension).
+      attr_reader :filename
+    
+      # Create a new docx document.
+      # @param filename [String] The filename of the docx file, without the docx extension.
+      def initialize(filename, &block)
+        @filename = filename + ".docx"
+        @objects = [] # It contains all the DSL elements
+        yield self if block
+      end
+      
+      # Save the docx document to the target location.
+      def save
+        generate_archive(generate_content_types, generate_rels, generate_document)
+      end
+
+      # Add a new paragraph to the document.
+      # @param options [Hash] Formatting options for the paragraph. See the full list in DocxGenerator::DSL::Paragraph.
+      def paragraph(options = {}, &block)
+        par = DocxGenerator::DSL::Paragraph.new(options)
+        yield par if block
+        @objects << par
+      end
+
+      # Add other objects to the document.
+      # @param objects [Object] Objects (like paragraphs).
+      # @return [DocxGenerator::DSL::Document] The document object.
+      def add(*objects)
+        objects.each do |object|
+          @objects << object
+        end
+        self
+      end
+      
+      private
+      
+        def generate_content_types
+          <<EOF
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
+  <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
+  <Default Extension="xml" ContentType="application/xml"/>
+  <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>
+</Types>
+EOF
+        end
+        
+        def generate_rels
+          <<EOF
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
+</Relationships>
+EOF
+        end
+        
+        def generate_document
+          content = []
+          @objects.each do |object|
+            content << object.generate
+          end
+
+          '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
+          Word::Document.new({ "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main" },
+            [ Word::Body.new(content) ]).to_s
+        end
+
+        def generate_archive(content_types, rels, document)
+          File.delete(@filename) if File.exists?(@filename)
+          Zip::File.open(@filename, Zip::File::CREATE) do |docx|
+            docx.mkdir('_rels')
+            docx.mkdir('word')
+            docx.get_output_stream('[Content_Types].xml') { |f| f.puts content_types }
+            docx.get_output_stream('_rels/.rels') { |f| f.puts rels }
+            docx.get_output_stream('word/document.xml') { |f| f.puts document }
+          end
+        end
+    end
+  end
+end

data/lib/docx_generator/dsl/paragraph.rb

@@ -1,72 +1,125 @@
-module DocxGenerator
-  module DSL
-    class Paragraph
-      def initialize(options = {}, &block)
-        @objects = []
-        @options = options
-        yield self if block
-      end
-
-      def alignment(value)
-        @options[:alignment] = value
-      end
-
-      def no_space
-        @objects << DocxGenerator::Word::Extensions::NoSpace.new
-      end
-
-      def text(text_fragment, options = {}, &block)
-        text_object = DocxGenerator::DSL::Text.new(text_fragment, options)
-        yield text_object if block
-        @objects << text_object
-      end
-
-      def generate
-        text_fragments = generate_text_fragments
-        options = generate_paragraph_options
-        if options
-          Word::Paragraph.new({}, text_fragments.unshift(options))
-        else
-          Word::Paragraph.new({}, text_fragments)
-        end
-      end
-
-      def add(*objects)
-        objects.each do |object|
-          @objects << object
-        end
-        self
-      end
-
-      private
-        def generate_text_fragments
-          text_fragments = []
-          @objects.each do |object|
-            if object.respond_to?(:generate)
-              text_fragments << object.generate << Word::Extensions.space
-            elsif object.class == DocxGenerator::Word::Extensions::NoSpace
-              text_fragments.pop
-            end
-          end
-          text_fragments.pop # In order to remove the last space added
-          text_fragments
-        end
-
-        def generate_paragraph_options
-          unless @options.empty?
-            parsed_options = []
-            @options.each do |option, value|
-              parsed_options << parse_paragraph_option(option, value)
-            end
-            Word::ParagraphProperties.new(parsed_options)
-          end
-        end
-
-        def parse_paragraph_option(option, value)
-          case option
-            when :alignment then Word::Alignment.new(value)
-          end
-        end
-    end
-  end
-end
+module DocxGenerator
+  module DSL
+    # Represent a paragraph with formatting options
+    class Paragraph
+      # Create a new paragraph with the formatting options specified.
+      # The formatting properties can be passed with a Hash or they could be set by calling the methods on the object (either in the block or not).
+      # @param options [Hash] Formatting options.
+      # @option options [Boolean] alignment The alignment of the paragraph. See the specification for the complete list.
+      # @option options [Hash] spacing Various spacing options for the paragraph. See the specification for more details.
+      # @option options [Hash] indentation Various indentation properties for the paragraph. See the specification for more details.
+      # @option options [Array] tabs Custom tabulation stops. See the specification for more details.
+      def initialize(options = {}, &block)
+        @objects = []
+        @options = options
+        yield self if block
+      end
+
+      # Set the alignment of the paragraph. See the specification for more details.
+      # @param value [String] The alignment of the paragraph. See the specification for the complete list.
+      def alignment(value)
+        @options[:alignment] = value
+      end
+
+      # Set various spacing options for the paragraph. See the specification for more details.
+      # @param options [Hash] Various spacing options for the paragraph. See the specification for more details.
+      def spacing(options)
+        @options[:spacing] = options
+      end
+
+      # Set various indentation properties for the paragraph. See the specification for more details.
+      # @param properties [Hash] Various indentation properties for the paragraph. See the specification for more details.
+      def indentation(properties)
+        @options[:indentation] = properties
+      end
+
+      # Set custom tabulation stops. See the specification for more details.
+      # @param tab_stops [Array] Custom tabulation stops.
+      def tabs(tab_stops)
+        @options[:tabs] = tab_stops
+      end
+
+      # Prevent the addition of a space between two text fragments.
+      def no_space
+        @objects << DocxGenerator::Word::Extensions::NoSpace.new
+      end
+
+      # Add a newline
+      def newline
+        @objects << DocxGenerator::Word::Extensions::Newline.new
+      end
+
+      # Add a tabulation
+      def tab
+        @objects << DocxGenerator::Word::Tab.new
+      end
+
+      # Add a new text fragment to the paragraph.
+      # @param text_fragment [String] The text fragment.
+      # @param options [Hash] Formatting options for the text fragment. See the full list in DocxGenerator::DSL::Text.
+      def text(text_fragment, options = {}, &block)
+        text_object = DocxGenerator::DSL::Text.new(text_fragment, options)
+        yield text_object if block
+        @objects << text_object
+      end
+
+      # Generate the XML element objects.
+      # @return [DocxGenerator::Word::Paragraph] A Word::Paragraph object representing the paragraph.
+      def generate
+        text_fragments = generate_text_fragments
+        options = generate_paragraph_options
+        if options
+          Word::Paragraph.new({}, text_fragments.unshift(options))
+        else
+          Word::Paragraph.new({}, text_fragments)
+        end
+      end
+
+      # Add other objects to the paragraph.
+      # @param objects [Object] Objects (like text fragments).
+      # @return [DocxGenerator::DSL::Paragraph] The paragraph object.
+      def add(*objects)
+        objects.each do |object|
+          @objects << object
+        end
+        self
+      end
+
+      private
+        def generate_text_fragments
+          text_fragments = []
+          @objects.each do |object|
+            if object.class == DocxGenerator::Word::Extensions::NoSpace
+              text_fragments.pop
+            elsif object.class == DocxGenerator::Word::Extensions::Newline
+              text_fragments.pop
+              text_fragments << object.generate
+            elsif object.respond_to?(:generate)
+              text_fragments << object.generate << Word::Extensions.space
+            end
+          end
+          text_fragments.pop if text_fragments.last.to_s == Word::Extensions.space.to_s # In order to remove the last space added
+          text_fragments
+        end
+
+        def generate_paragraph_options
+          unless @options.empty?
+            parsed_options = []
+            @options.each do |option, value|
+              parsed_options << parse_paragraph_option(option, value)
+            end
+            Word::ParagraphProperties.new(parsed_options)
+          end
+        end
+
+        def parse_paragraph_option(option, value)
+          case option
+            when :alignment then Word::Alignment.new(value)
+            when :spacing then Word::Spacing.new(value)
+            when :indentation then Word::Indentation.new(value)
+            when :tabs then Word::Tabs.new(value)
+          end
+        end
+    end
+  end
+end

data/lib/docx_generator/dsl/text.rb

@@ -1,71 +1,121 @@
-module DocxGenerator
-  module DSL
-    class Text
-      def initialize(text_fragment, options = {}, &block)
-        @text_fragment = text_fragment
-        @options = options
-        yield self if block
-      end
-
-      def bold(value)
-        @options[:bold] = value
-      end
-
-      def italics(value)
-        @options[:italics] = value
-      end
-
-      def underline(value)
-        @options[:underline] = value
-      end
-
-      def size(value)
-        @options[:size] = value
-      end
-
-      def superscript(value)
-        @options[:superscript] = value
-      end
-
-      def subscript(value)
-        @options[:subscript] = value
-      end
-
-      def generate
-        options = generate_text_options
-        text = Word::Text.new({}, [@text_fragment])
-        if options
-          Word::Run.new({}, [options, text])
-        else
-          Word::Run.new({}, [text])
-        end
-      end
-
-      def to_s
-        generate.to_s
-      end
-
-      private
-        def generate_text_options
-          unless @options.empty?
-            parsed_options = []
-            @options.each do |option, value|
-              parsed_options << parse_text_option(option, value)
-            end
-            Word::RunProperties.new(parsed_options)
-          end
-        end
-
-        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)
-            when :superscript then Word::VerticalAlign.new("superscript")
-            when :subscript then Word::VerticalAlign.new("subscript")
-          end
-        end
-    end
-  end
-end
+module DocxGenerator
+  module DSL
+    # Represent a text fragment with formatting options
+    class Text
+      # Create a new text fragment with the text specified.
+      # The formatting properties can be passed with a Hash or they could be set by calling the methods on the object (either in the block or not).
+      # @param text_fragment [String] The text fragment.
+      # @param options [Hash] Formatting options.
+      # @option options [Boolean] bold If the text should be in bold.
+      # @option options [Boolean] italics If the text should be in italics.
+      # @option options [Hash] underline The style of the underline and other options. See the specification for more details.
+      # @option options [Integer] size The size of the text (in points).
+      # @option options [Boolean] superscript If the text should be in superscript.
+      # @option options [Boolean] subscript If the text should be in subscript.
+      # @option options [Boolean] caps If the text should be displayed in capital letters.
+      # @option options [Boolean] small_caps If the text should be displayed in small capital letters.
+      # @option options [String] font The name of the font.
+      def initialize(text_fragment, options = {}, &block)
+        @text_fragment = text_fragment
+        @options = options
+        yield self if block
+      end
+
+      # Set whether the text should be in bold or not.
+      # @param value [Boolean] Whether the text should be in bold or not.
+      def bold(value)
+        @options[:bold] = value
+      end
+
+      # Set whether the text should be in italics or not.
+      # @param value [Boolean] Whether the text should be in italics or not.
+      def italics(value)
+        @options[:italics] = value
+      end
+
+      # Set the style of the underline and other options. See the specification for more details.
+      # @param value [Hash] The style of the underline and other options. See the specification for more details.
+      def underline(value)
+        @options[:underline] = value
+      end
+
+      # Set the size of the text (in points).
+      # @param value [Integer] The size of the text (in points).
+      def size(value)
+        @options[:size] = value
+      end
+
+      # Set whether the text should be in superscript.
+      # @param value [Boolean] Whether the text should be in superscript.
+      def superscript(value)
+        @options[:superscript] = value
+      end
+
+      # Set whether the text should be in subscript.
+      # @param value [Boolean] Whether the text should be in subscript.
+      def subscript(value)
+        @options[:subscript] = value
+      end
+
+      # Set whether the text should be displayed in capital letters.
+      # @param value [Boolean] Whether the text should be displayed in capital letters.
+      def caps(value)
+        @options[:caps] = value
+      end
+
+      # Set whether the text should be displayed in small capital letters.
+      # @param value [Boolean] Whether the text should be displayed in small capital letters.
+      def small_caps(value)
+        @options[:small_caps] = value
+      end
+
+      # Set the name of the font.
+      # @param value [String] The name of the font
+      def font(value)
+        @options[:font] = value
+      end
+
+      # Generate the XML element objects.
+      # @return [DocxGenerator::Word::Run] A Word::Run object representing the text fragment.
+      def generate
+        options = generate_text_options
+        text = Word::Text.new({}, [@text_fragment])
+        if options
+          Word::Run.new({}, [options, text])
+        else
+          Word::Run.new({}, [text])
+        end
+      end
+
+      # Generate the XML representation of the text fragment
+      def to_s
+        generate.to_s
+      end
+
+      private
+        def generate_text_options
+          unless @options.empty?
+            parsed_options = []
+            @options.each do |option, value|
+              parsed_options << parse_text_option(option, value)
+            end
+            Word::RunProperties.new(parsed_options)
+          end
+        end
+
+        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)
+            when :superscript then Word::VerticalAlign.new("superscript")
+            when :subscript then Word::VerticalAlign.new("subscript")
+            when :caps then Word::CapitalLetters.new(value)
+            when :small_caps then Word::SmallCapitalLetters.new(value)
+            when :font then Word::Font.new(value)
+          end
+        end
+    end
+  end
+end