rocx 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9bb4b4bab84d40e70d311607aa9fcf27ede7b44
-  data.tar.gz: d2f2f6aa0ddf9e421ac86e31296554e68f53f8a9
+  metadata.gz: 087387779bf11613186b3a7e1192ed99ca739b52
+  data.tar.gz: c3277390bd9fbfd8fe17743ea8762849010fe559
 SHA512:
-  metadata.gz: dabe3d744f0c26832981c7c9bd9b265ef6684645a892cb190eb5c67d7e01a926234d370e9e8aa76839b3e2c0920a323bd567bd08234c96aa46b3db1663e615ed
-  data.tar.gz: 558350fdb7d8bd5de5ba2c36cc5f3a2f49f3b5fcf8f38198d07f6d8ad6d6325471c0df7ce180ac59ec5e09afef00afc7e00a95fd61fa325ef7156719a5849a34
+  metadata.gz: 0b756fec89e558eae5aaec023459d78e223f2ee12d347d5c36f435fab62a31840708d2815131251f606d90afdc8ef2b65f223ab97acc9119af585075a9d743e4
+  data.tar.gz: 8174d565f6469b87d99a0bc4121bbd3fb886148d474049000ba562cbd2cc5abb45670d3c4e5fd7bb41cd82543396cbc5e75a15956d312547411bfef974a86cf1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rocx (0.6.0)
+    rocx (0.7.0)
       nokogiri
       open_xml_package
 

data/lib/rocx.rb

@@ -1,8 +1,10 @@
 require "rocx/attribute_builder"
+require "rocx/property_builder"
 require "rocx/properties"
 require "rocx/elements"
 require "rocx/package"
 require "rocx/parts"
+require "rocx/section"
 require "rocx/style"
 
 module Rocx

data/lib/rocx/elements/container.rb

@@ -1,51 +1,9 @@
 module Rocx
   module Elements
     class Container < Element
-      attr_reader :children
-
-      class << self
-        def properties_tag(*args)
-          @properties_tag = args.first if args.any?
-          @properties_tag
-        end
-
-        def value_property(name, as: nil)
-          attr_reader name
-
-          properties[name] = (as || name).to_s
-
-          class_eval <<-CODE, __FILE__, __LINE__ + 1
-          def #{name}=(value)
-            property_key = "#{name}".to_sym
-            class_name = properties[property_key].split("_").map(&:capitalize).join
-            prop_class = Rocx::Properties.const_get class_name
-            instance_variable_set "@#{name}", prop_class.new(value)
-          end
-          CODE
-        end
-
-        def property(name, as: nil)
-          properties[name] = (as || name).to_s
-
-          class_eval <<-CODE, __FILE__, __LINE__ + 1
-          def #{name}
-            property_key = "#{name}".to_sym
-            class_name = properties[property_key].split("_").map(&:capitalize).join
-            prop_class = Rocx::Properties.const_get class_name
-
-            if instance_variable_get("@#{name}").nil?
-              instance_variable_set "@#{name}", prop_class.new
-            end
+      include PropertyBuilder
 
-            instance_variable_get "@#{name}"
-          end
-          CODE
-        end
-
-        def properties
-          @properties ||= {}
-        end
-      end
+      attr_reader :children
 
       def initialize
         @children = []
@@ -64,18 +22,6 @@ module Rocx
 
     private
 
-      def property_xml(xml)
-        props = properties.keys.map(&method(:send)).compact
-        return if props.none?(&:render?)
-        xml[namespace].public_send(properties_tag) {
-          props.each { |prop| prop.to_xml(xml) }
-        }
-      end
-
-      def properties
-        self.class.properties
-      end
-
       def properties_tag
         self.class.properties_tag || default_properties_tag
       end

data/lib/rocx/elements/paper_source.rb

@@ -0,0 +1,11 @@
+module Rocx
+  module Properties
+    class PaperSource < ComplexProperty
+      tag :paperSrc
+
+      attribute :first, expects: :integer
+      attribute :other, expects: :integer
+
+    end
+  end
+end

data/lib/rocx/elements/paragraph.rb

@@ -1,6 +1,7 @@
 module Rocx
   module Elements
     class Paragraph < Container
+      attr_reader :section_properties
       tag :p
 
       value_property :alignment
@@ -28,7 +29,7 @@ module Rocx
       value_property :widow_control
       value_property :word_wrap
 
-      property :borders
+      property :borders, as: :paragraph_borders
       property :conditional_formatting
       property :frame
       property :indentation
@@ -36,6 +37,20 @@ module Rocx
       property :shading
       property :spacing
       property :tabs
+
+      def section_properties=(section)
+        raise ArgumentError, "Section properties must be an instance of Rocx::Section" unless section.is_a?(Rocx::Section)
+        @section_properties = section
+      end
+
+      def to_xml(xml)
+        xml[namespace].public_send(tag, xml_attributes) {
+          section_properties.to_xml(xml) unless section_properties.nil?
+          property_xml(xml)
+          children.each { |child| child.to_xml(xml) }
+        }
+      end
+
     end
   end
 end

data/lib/rocx/parts/document.rb

@@ -1,22 +1,36 @@
 module Rocx
   module Parts
     class Document < BasePart
-      attr_reader :children
+      attr_reader :children, :current_section
 
       def initialize
         @children = []
       end
 
       def <<(child)
-        children << child
+        if child.is_a?(Rocx::Section)
+          set_section(child)
+        else
+          children << child
+        end
+      end
+
+      def set_section(section)
+        if current_section.nil?
+          @current_section = section
+        else
+          children.last.section_properties = current_section
+          @current_section = section
+        end
       end
 
       def to_xml
         build_xml do |xml|
           xml.document(root_namespaces) {
-            xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == 'w' }
-            xml['w'].body {
+            xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
+            xml["w"].body {
               children.each { |child| child.to_xml(xml) }
+              current_section.to_xml(xml) unless current_section.nil?
             }
           }
         end

data/lib/rocx/properties.rb

@@ -11,6 +11,7 @@ require "rocx/properties/integer_property"
 require "rocx/properties/positive_integer_property"
 require "rocx/properties/on_off_property"
 require "rocx/properties/toggle_property"
+require "rocx/properties/container_property"
 require "rocx/properties/style"
 Dir.glob("#{File.join(File.dirname(__FILE__), "properties", "*.rb")}").each do |file|
   require file

data/lib/rocx/properties/column.rb

@@ -0,0 +1,16 @@
+module Rocx
+  module Properties
+    class Column < ComplexProperty
+      tag :col
+
+      attribute :space, expects: :positive_integer
+      attribute :width, expects: :positive_integer, displays_as: :w
+
+      def initialize(space, width)
+        self.space = space
+        self.width = width
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/columns.rb

@@ -0,0 +1,13 @@
+module Rocx
+  module Properties
+    class Columns < ContainerProperty
+      tag :cols
+      child_class :column
+
+      attribute :equal_width, expects: :true_or_false
+      attribute :number, expects: :integer, displays_as: :num
+      attribute :separator, expects: :true_or_false, displays_as: :sep
+      attribute :space, expects: :integer
+    end
+  end
+end

data/lib/rocx/properties/container_property.rb

@@ -0,0 +1,63 @@
+module Rocx
+  module Properties
+    class ContainerProperty < BaseProperty
+      include Enumerable
+      include AttributeBuilder
+
+      class << self
+        def child_class(*args)
+          if args.any?
+            prop_name = args.first.to_s.capitalize
+            child_class_obj = Rocx::Properties.const_get prop_name
+            @child_class = Rocx::Properties.const_get prop_name
+          end
+
+          @child_class
+        end
+      end
+
+      def initialize
+        @children = []
+      end
+
+      def <<(child)
+        raise ArgumentError, invalid_child_message unless valid_child?(child)
+        children << child
+      end
+
+      def each(*args, &block)
+        children.each *args, &block
+      end
+
+      def render?
+        !children.length.zero?
+      end
+
+      def to_xml(xml)
+        return unless render?
+
+        xml["w"].public_send(tag, xml_attributes) {
+          each { |child| child.to_xml(xml) }
+        }
+      end
+
+    private
+
+      attr_reader :children
+
+      def invalid_child_message
+        class_name = self.class.to_s.split(/::/).last
+        "#{class_name} must be instances of Rocx::Properties::#{child_class}"
+      end
+
+      def valid_child?(child)
+        child.is_a?(child_class)
+      end
+
+      def child_class
+        self.class.child_class
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/document_grid.rb

@@ -0,0 +1,20 @@
+module Rocx
+  module Properties
+    class DocumentGrid < ComplexProperty
+      tag :docGrid
+
+      attribute :char_space, expects: :integer
+      attribute :line_pitch, expects: :integer
+      attribute :type, expects: :valid_grid_type
+
+      VALID_GRID_TYPES = %i(default lines linesAndChars snapToChars)
+
+    private
+
+      def valid_grid_type(value)
+        valid_in? value, VALID_GRID_TYPES
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/form_protection.rb

@@ -0,0 +1,7 @@
+module Rocx
+  module Properties
+    class FormProtection < ToggleProperty
+      tag :formProt
+    end
+  end
+end

data/lib/rocx/properties/line_numbering.rb

@@ -0,0 +1,21 @@
+module Rocx
+  module Properties
+    class LineNumbering < ComplexProperty
+      tag :lnNumType
+
+      attribute :count_by, expects: :integer
+      attribute :distance, expects: :positive_integer
+      attribute :restart, expects: :valid_line_numbering_restart
+      attribute :start, expects: :integer
+
+      VALID_LINE_NUMBERING_RESTARTS = %i(continuous newPage newSection)
+
+    private
+
+      def valid_line_numbering_restart(value)
+        valid_in? value, VALID_LINE_NUMBERING_RESTARTS
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/page_borders.rb

@@ -0,0 +1,59 @@
+module Rocx
+  module Properties
+    class PageBorders < ComplexProperty
+      attr_reader :left, :right, :top, :bottom
+
+      tag :pgBorders
+      attribute :display, expects: :valid_display
+      attribute :offset_from, expects: :valid_offset
+      attribute :z_order, expects: :valid_z_order
+
+      def initialize
+        @left = new_border :left
+        @right = new_border :right
+        @top = new_border :top
+        @bottom = new_border :bottom
+      end
+
+      def render?
+        renderable_borders.any?
+      end
+
+      def to_xml(xml)
+        return unless render?
+        xml["w"].public_send(tag, xml_attributes) { render_borders_xml(xml) }
+      end
+
+      VALID_DISPLAYS = %i(allPages firstPage notFirstPage)
+      VALID_OFFSETS = %i(page text)
+      VALID_Z_ORDERS = %i(front back)
+
+    private
+
+      def render_borders_xml(xml)
+        renderable_borders.each { |border| border.to_xml(xml) }
+      end
+
+      def renderable_borders
+        [@left, @right, @top, @bottom].select(&:render?)
+      end
+
+      def new_border(direction)
+        Rocx::Properties::Border.new direction
+      end
+
+      def valid_display(value)
+        valid_in? value, VALID_DISPLAYS
+      end
+
+      def valid_offset(value)
+        valid_in? value, VALID_OFFSETS
+      end
+
+      def valid_z_order(value)
+        valid_in? value, VALID_Z_ORDERS
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/page_margins.rb

@@ -0,0 +1,15 @@
+module Rocx
+  module Properties
+    class PageMargins < ComplexProperty
+      tag :pgMar
+
+      attribute :bottom, expects: :integer
+      attribute :footer, expects: :positive_integer
+      attribute :gutter, expects: :positive_integer
+      attribute :header, expects: :positive_integer
+      attribute :left, expects: :positive_integer
+      attribute :right, expects: :positive_integer
+      attribute :top, expects: :integer
+    end
+  end
+end

data/lib/rocx/properties/page_numbering.rb

@@ -0,0 +1,87 @@
+module Rocx
+  module Properties
+    class PageNumbering < ComplexProperty
+      tag :pgNumType
+
+      attribute :chapter_separator, expects: :valid_chapter_separator, displays_as: :chapSep
+      attribute :chapter_style, expects: :integer, displays_as: :chapStyle
+      attribute :format, expects: :valid_page_number_format, displays_as: :fmt
+      attribute :start, expects: :integer
+
+      VALID_CHAPTER_SEPARATORS = %i(colon emDash enDash hyphen period)
+      VALID_PAGE_NUMBER_FORMATS = %i(aiueo
+                                     aiueoFullWidth
+                                     arabicAbjad
+                                     arabicAlpha
+                                     bahtText
+                                     bullet
+                                     cardinalText
+                                     chicago
+                                     chineseCounting
+                                     chineseCountingThousand
+                                     chineseLegalSimplified
+                                     chosung
+                                     custom
+                                     decimal
+                                     decimalEnclosedCircle
+                                     decimalEnclosedCircleChinese
+                                     decimalEnclosedFullstop
+                                     decimalEnclosedParen
+                                     decimalFullWidth
+                                     decimalHalfWidth
+                                     decimalZero
+                                     dollarText
+                                     ganada
+                                     hebrew1
+                                     hebrew2
+                                     hex
+                                     hindiConsonants
+                                     hindiCounting
+                                     hindiNumbers
+                                     hindiVowels
+                                     ideographDigital
+                                     ideographEnclosedCircle
+                                     taiwaneseDigital
+                                     ideographLegalTraditional
+                                     ideographTraditional
+                                     ideographZodiac
+                                     ideographZodiacTraditional
+                                     iroha
+                                     irohaFullWidth
+                                     japaneseCounting
+                                     japaneseDigitalTenThousand
+                                     japaneseLegal
+                                     koreanCounting
+                                     koreanDigital
+                                     koreanDigital2
+                                     koreanLegal
+                                     lowerLetter
+                                     lowerRoman
+                                     none
+                                     numberInDash
+                                     ordinal
+                                     ordinalText
+                                     russianLower
+                                     russianUpper
+                                     taiwaneseCounting
+                                     taiwaneseCountingThousand
+                                     thaiCounting
+                                     thaiLetters
+                                     thaiNumbers
+                                     upperLetter
+                                     upperRoman
+                                     vietnameseCounting)
+
+    private
+
+      def valid_chapter_separator(value)
+        valid_in? value, VALID_CHAPTER_SEPARATORS
+      end
+
+      def valid_page_number_format(value)
+        valid_in? value, VALID_PAGE_NUMBER_FORMATS
+      end
+
+    end
+  end
+end