docx_generator 0.1.0 → 0.1.1

data/lib/docx_generator/element.rb

@@ -1,52 +1,52 @@
-module DocxGenerator
-
-  # Represent an XML element. This class should not be used directly by the users of the library.
-  class Element
-
-    # Create a new XML element.
-    # @param name [String] The name of the XML element.
-    # @param attributes [Hash] The attributes of the XML element.
-    # @param content [Array] An array of the children of the XML element (other XML elements).
-    def initialize(name, attributes = {}, content = [])
-      @name = name
-      @attributes = attributes
-      @content = content
-    end
-    
-    # Add an XML element in the content of this XML element.
-    # @param element[DocxGenerator::Element] The XML element to add.
-    def add(element)
-      @content << element
-    end
-    
-    # Generate the XML for the element.
-    # @return [String] The XML produced for the element.
-    def generate
-      output = ""
-      if @content.length != 0
-        output += "<#{@name}#{generate_attributes}>"
-        @content.each do |element|
-          if element.respond_to?(:generate)
-            output += element.generate
-          else
-            output += element.to_s
-          end
-        end
-        output += "</#{@name}>"
-      else
-        output += "<#{@name}#{generate_attributes} />"
-      end
-      output
-    end
-    alias :to_s :generate
-    
-    private
-      def generate_attributes
-        output = ""
-        @attributes.each do |name, value|
-          output += " #{name}=\"#{value}\""
-        end
-        output
-      end
-  end
-end
+module DocxGenerator
+
+  # Represent an XML element. This class should not be used directly by the users of the library.
+  class Element
+
+    # Create a new XML element.
+    # @param name [String] The name of the XML element.
+    # @param attributes [Hash] The attributes of the XML element.
+    # @param content [Array] An array of the children of the XML element (other XML elements).
+    def initialize(name, attributes = {}, content = [])
+      @name = name
+      @attributes = attributes
+      @content = content
+    end
+    
+    # Add an XML element in the content of this XML element.
+    # @param element[DocxGenerator::Element] The XML element to add.
+    def add(element)
+      @content << element
+    end
+    
+    # Generate the XML for the element.
+    # @return [String] The XML produced for the element.
+    def generate
+      output = ""
+      if @content.length != 0
+        output += "<#{@name}#{generate_attributes}>"
+        @content.each do |element|
+          if element.respond_to?(:generate)
+            output += element.generate
+          else
+            output += element.to_s
+          end
+        end
+        output += "</#{@name}>"
+      else
+        output += "<#{@name}#{generate_attributes} />"
+      end
+      output
+    end
+    alias :to_s :generate
+    
+    private
+      def generate_attributes
+        output = ""
+        @attributes.each do |name, value|
+          output += " #{name}=\"#{value}\""
+        end
+        output
+      end
+  end
+end

data/lib/docx_generator/version.rb

@@ -1,4 +1,4 @@
-module DocxGenerator
-  # Version of DocxGenerator.
-  VERSION = "0.1.0"
-end
+module DocxGenerator
+  # Version of DocxGenerator.
+  VERSION = "0.1.1"
+end

data/lib/docx_generator/word.rb

@@ -1,9 +1,9 @@
-require 'docx_generator/word/base'
-require 'docx_generator/word/extensions'
-require 'docx_generator/word/formatting'
-
-module DocxGenerator
-  # Namesapce for all XML Elements defined in the standard.
-  module Word
-  end
+require 'docx_generator/word/base'
+require 'docx_generator/word/extensions'
+require 'docx_generator/word/formatting'
+
+module DocxGenerator
+  # Namesapce for all XML Elements defined in the standard.
+  module Word
+  end
 end

data/lib/docx_generator/word/base.rb

@@ -1,82 +1,83 @@
-module DocxGenerator
-  module Word
-    # Represent the `w:document` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Document < Element
-      # Create a new `w:document` element.
-      # @param attributes [Hash] The attributes of the XML element.
-      #   In the case of the `w:document` element, the only attribute should be `w:conformance`. If ommited, the value is `transitional`. If not, the two accepted values are `strict` and `transitional`.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(attributes = {}, content = [])
-        super("w:document", attributes, content)
-      end
-    end
-    
-    # Represent the `w:body` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Body < Element
-      # Create a new `w:body` XML element.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(content = [])
-        super("w:body", {}, content)
-      end
-    end
-    
-    # Represent the `w:p` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Paragraph < Element
-      # Create a new `w:p` element.
-      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:p` element for the possible attributes.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(attributes = {}, content = [])
-        super("w:p", attributes, content)
-      end
-    end
-
-    # Represent the `w:pPr` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class ParagraphProperties < Element
-      # Create a new `w:pPr` XML element.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(content = [])
-        super("w:pPr", {}, content)
-      end
-    end
-
-    # Represent the `w:r` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Run < Element
-      # Create a new `w:r` element.
-      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:r` element for the possible attributes.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(attributes = {}, content = [])
-        super("w:r", attributes, content)
-      end
-    end
-    
-    # Represent the `w:rPr` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class RunProperties < Element
-      # Create a new `w:rPr` XML element.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(content = [])
-        super("w:rPr", {}, content)
-      end
-    end
-    
-    # Represent the `w:t` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Text < Element
-      # Create a new `w:t` element.
-      # @param attributes [Hash] The attributes of the XML element.
-      #   In the case of the `w:t` element, the only attribute should be `xml:space`. It means that the content contains significant whitespace. 
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(attributes = {}, content = [])
-        super("w:t", attributes, content)
-      end
-    end
-
-    # Represent the `w:br` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Break < Element
-      # Create a new `w:br` element.
-      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:br` element for the possible attributes.
-      # @param content [Array] An array of the children of the XML element (other XML elements).
-      def initialize(attributes = {})
-        super("w:br", attributes)
-      end
-    end
-  end
-end
+# Warning: This file has been automatically generated from generator/word_base.rb.
+# It should not be edited by hand. Instead, modify the code generator.
+
+module DocxGenerator
+  module Word
+    # Represent the `w:document` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Document < Element
+      # Create a new `w:document` XML element.
+      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:document` element for the possible attributes.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(attributes = {}, content = [])
+        super("w:document", attributes, content)
+      end
+    end
+
+    # Represent the `w:body` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Body < Element
+      # Create a new `w:body` XML element.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(content = [])
+        super("w:body", {}, content)
+      end
+    end
+
+    # Represent the `w:p` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Paragraph < Element
+      # Create a new `w:p` XML element.
+      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:p` element for the possible attributes.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(attributes = {}, content = [])
+        super("w:p", attributes, content)
+      end
+    end
+
+    # Represent the `w:pPr` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class ParagraphProperties < Element
+      # Create a new `w:pPr` XML element.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(content = [])
+        super("w:pPr", {}, content)
+      end
+    end
+
+    # Represent the `w:r` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Run < Element
+      # Create a new `w:r` XML element.
+      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:r` element for the possible attributes.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(attributes = {}, content = [])
+        super("w:r", attributes, content)
+      end
+    end
+
+    # Represent the `w:rPr` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class RunProperties < Element
+      # Create a new `w:rPr` XML element.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(content = [])
+        super("w:rPr", {}, content)
+      end
+    end
+
+    # Represent the `w:t` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Text < Element
+      # Create a new `w:t` XML element.
+      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:t` element for the possible attributes.
+      # @param content [Array] An array of the children of the XML element (other XML elements).
+      def initialize(attributes = {}, content = [])
+        super("w:t", attributes, content)
+      end
+    end
+
+    # Represent the `w:br` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Break < Element
+      # Create a new `w:br` XML element.
+      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `w:br` element for the possible attributes.
+      def initialize(attributes = {})
+        super("w:br", attributes)
+      end
+    end
+
+  end
+end

data/lib/docx_generator/word/extensions.rb

@@ -1,18 +1,30 @@
-module DocxGenerator
-  module Word
-
-    # Extensions to create some common elements easily.
-    module Extensions
-      def self.space
-        DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Text.new({ "xml:space" => "preserve" }, [" "])])
-      end
-
-      def self.newline
-      	DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Break.new])
-      end
-
-      class NoSpace
-      end
-    end
-  end
-end
+module DocxGenerator
+  module Word
+
+    # Extensions to create some common elements easily.
+    module Extensions
+      def self.space
+        DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Text.new({ "xml:space" => "preserve" }, [" "])])
+      end
+
+      def self.newline
+      	DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Break.new])
+      end
+
+      class Newline
+        def generate
+          DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Break.new])
+        end
+      end
+
+      class Tab
+        def generate
+          DocxGenerator::Word::Run.new({}, [DocxGenerator::Word::Tab.new])
+        end
+      end
+
+      class NoSpace
+      end
+    end
+  end
+end

data/lib/docx_generator/word/formatting.rb

@@ -1,58 +1,162 @@
-module DocxGenerator
-  module Word
-    # Represent the `w:b` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Bold < Element
-      # Create a new `w:b` element.
-      # @param present [Boolean] If bold should be applied to the text.
-      def initialize(present = nil)
-        arguments = (present == nil ? {} : { "w:val" => present })
-        super("w:b", arguments)
-      end
-    end
-    
-    # Represent the `w:i` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Italics < Element
-      # Create a new `w:i` element.
-      # @param present [Boolean] If italics should be applied to the text.
-      def initialize(present = nil)
-        arguments = (present == nil ? {} : { "w:val" => present })
-        super("w:i", arguments)
-      end
-    end
-
-    # Represent the `w:u` element from Office Open XML specification. This class should not be used directly by the users of the library.
-    class Underline < Element
-      # Create a new `w:u` element.
-      # @param arguments [Hash] Arguments for the `w:u` element. See the full list in the specification. You can use `style` instead of `w:val` if you want. The list of all underline patterns can be found in the specification.
-      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
-
-    class VerticalAlign < Element
-      def initialize(value)
-        super("w:vertAlign", { "w:val" => value })
-      end
-    end
-  end
-end
+# This file should be standarized. All the parameters should be named parameters (or maybe only those who take a Hash).
+# All they do is arguments tranformations and they document possible arguments from the specification.
+
+module DocxGenerator
+  module Word
+    # Represent the `w:b` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Bold < Element
+      # Create a new `w:b` element.
+      # @param present [Boolean] If bold should be applied to the text.
+      def initialize(present = nil)
+        arguments = (present == nil ? {} : { "w:val" => present })
+        super("w:b", arguments)
+      end
+    end
+
+    # Represent the `w:i` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Italics < Element
+      # Create a new `w:i` element.
+      # @param present [Boolean] If italics should be applied to the text.
+      def initialize(present = nil)
+        arguments = (present == nil ? {} : { "w:val" => present })
+        super("w:i", arguments)
+      end
+    end
+
+    # Represent the `w:u` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Underline < Element
+      # Create a new `w:u` element.
+      # @param arguments [Hash] Arguments for the `w:u` element. See the full list in the specification. You can use `style` instead of `w:val` if you want. The list of all underline patterns can be found in the specification.
+      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
+
+    # Represent the `w:sz` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Size < Element
+      # Create a new `w:sz` element.
+      # @param size [Number] The size of the text (in points)
+      def initialize(size)
+        super("w:sz", { "w:val" => size*2 })
+      end
+    end
+
+    # Represent the `w:jc` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Alignment < Element
+      # Create a new `w:jc` element.
+      # @param value [String] The type of alignment. The list of all types of alignment can be found in the specification.
+      def initialize(value)
+        super("w:jc", { "w:val" => value })
+      end
+    end
+
+    # Represent the `w:spacing` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Spacing < Element
+      # Create a new `w:spacing` element.
+      # @param arguments [Hash] The different options for the spacing. They can be found in the specification.
+      def initialize(arguments = {})
+        final_arguments = {}
+        arguments.each do |name, value|
+          if name.to_s == "after" || name.to_s == "before"
+            final_arguments["w:" + name.to_s] = (value * 20).round
+          else
+            final_arguments["w:" + name.to_s] = (value * 20 * 12).round
+            final_arguments["w:lineRule"] = "auto"
+          end
+        end
+        super("w:spacing", final_arguments)
+      end
+    end
+
+    # Represent the `w:indent` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Indentation < Element
+      # Create a new `w:indent` element.
+      # @param properties [Hash] The different properties for the indentation. They can be found in the specification.
+      def initialize(arguments = {})
+        final_arguments = {}
+        arguments.each do |name, value|
+          if name.to_s == "first_line"
+            final_arguments["w:firstLine"] = (value * 20).round
+          else
+            final_arguments["w:" + name.to_s] = (value * 20).round
+          end
+        end
+        super("w:ind", final_arguments)
+      end
+    end
+
+    # Represent the `w:tabs` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Tabs < Element
+      # Create a new `w:tabs` element.
+      # @param tab_stops [Array] The tab stops.
+      def initialize(tab_stops)
+        tab_stop_elements = tab_stops.inject([]) do |tab_stop_elements, tab_stop|
+          tab_stop_elements << Tab.new(tab_stop)
+        end
+        super("w:tabs", {}, tab_stop_elements)
+      end
+    end
+
+    # Represent the `w:tab` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Tab < Element
+      # Create a new `w:tab` element.
+      # @param options [Hash] Options for the tab stop. Must be `leader`, `pos` or `val`. See the specification for the possible values for each option.
+      def initialize(options = {})
+        final_arguments = {}
+        options.each do |name, value|
+          if name.to_s == "pos"
+            final_arguments["w:pos"] = (value * 20).round
+          else
+            final_arguments["w:" + name.to_s] = value
+          end
+        end
+        super("w:tab", final_arguments)
+      end
+    end
+
+    # Represent the `w:vertAlign` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class VerticalAlign < Element
+      # Create a new `w:vertAlign` element.
+      # @param value [String] The type of alignment. It should be `baseline`, `subscript` or `superscript`.
+      def initialize(value)
+        super("w:vertAlign", { "w:val" => value })
+      end
+    end
+
+    # Represent the `w:caps` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class CapitalLetters < Element
+      # Create a new `w:caps` element.
+      # @param present [Boolean] If the text should be displayed in capital letters.
+      def initialize(present = nil)
+        arguments = (present == nil ? {} : { "w:val" => present })
+        super("w:caps", arguments)
+      end
+    end
+
+    # Represent the `w:smallCaps` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class SmallCapitalLetters < Element
+      # Create a new `w:smallCaps` element.
+      # @param present [Boolean] If the text should be displayed in small capital letters.
+      def initialize(present = nil)
+        arguments = (present == nil ? {} : { "w:val" => present })
+        super("w:smallCaps", arguments)
+      end
+    end
+
+    # Represent the `w:rFonts` element from Office Open XML specification. This class should not be used directly by the users of the library.
+    class Font < Element
+      # Create a new `w:rFonts` element.
+      # @param name [String] The name of the font.
+      def initialize(name)
+        super("w:rFonts", { "w:ascii" => name })
+      end
+    end
+  end
+end