rocx 0.5.6 → 0.5.7

data/lib/rocx/properties/base_property.rb

@@ -16,6 +16,10 @@ module Rocx
         "Invalid value for #{name}; acceptable values are #{ok_values.join(", ")}"
       end
 
+      def render?
+        !value.nil?
+      end
+
       def name
         class_name.gsub(/(.)([A-Z])/, '\1_\2').downcase
       end

data/lib/rocx/properties/border.rb

@@ -0,0 +1,32 @@
+module Rocx
+  module Properties
+    class Border
+      include AttributeBuilder
+
+      attr_reader :tag
+
+      attribute :color, expects: :hex_color
+      attribute :frame, expects: :true_or_false
+      attribute :shadow, expects: :true_or_false
+      attribute :size, expects: :positive_integer, displays_as: :sz
+      attribute :space, expects: :positive_integer
+      attribute :theme_color, expects: :valid_theme_color, displays_as: :themeColor
+      attribute :theme_shade, expects: :hex_digit, displays_as: :themeShade
+      attribute :theme_tint, expects: :hex_digit, displays_as: :themeTint
+      attribute :type, expects: :valid_type, displays_as: :val
+
+      def initialize(tag)
+        @tag = tag
+      end
+
+      def name
+        "border"
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, xml_attributes)
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/borders.rb

@@ -0,0 +1,48 @@
+module Rocx
+  module Properties
+    class Borders
+      attr_reader :left, :right, :top, :bottom, :between, :bar
+
+      def initialize
+        @left = new_border :left
+        @right = new_border :right
+        @top = new_border :top
+        @bottom = new_border :bottom
+        @between = new_border :between
+        @bar = new_border :bar
+      end
+
+      def tag
+        :pBdr
+      end
+
+      def name
+        "borders"
+      end
+
+      def render?
+        !renderable_borders.length.zero?
+      end
+
+      def to_xml(xml)
+        return unless render?
+        xml["w"].public_send(tag) { render_borders_xml(xml) }
+      end
+
+    private
+
+      def render_borders_xml(xml)
+        renderable_borders.each { |border| border.to_xml(xml) }
+      end
+
+      def renderable_borders
+        [@left, @right, @top, @bottom, @between, @bar].select(&:render?)
+      end
+
+      def new_border(direction)
+        Rocx::Properties::Border.new direction
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/compress_punctuation.rb

@@ -0,0 +1,11 @@
+module Rocx
+  module Properties
+    class CompressPunctuation < OnOffProperty
+
+      def tag
+        :topLinePunct
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/frame.rb

@@ -0,0 +1,70 @@
+module Rocx
+  module Properties
+    class Frame
+      include AttributeBuilder
+
+      VALID_ANCHORS = %i(margin page text)
+      VALID_DROP_CAPS = %i(drop margin none)
+      VALID_HEIGHT_RULES = %i(atLeast auto exact)
+      VALID_RELATIVE_HORIZONTAL_POSITIONS = %i(center inside left outside right)
+      VALID_RELATIVE_VERTICAL_POSITIONS = %i(bottom center inline inside outside top)
+      VALID_WRAPS = %i(around auto none notBeside through tight)
+
+      attribute :anchor_lock, expects: :true_or_false, displays_as: :anchorLock
+      attribute :drop_cap, expects: :valid_drop_cap, displays_as: :dropCap
+      attribute :height, expects: :positive_integer, displays_as: :h
+      attribute :height_rule, expects: :valid_height_rule, displays_as: :hRule
+      attribute :horizontal_anchor, expects: :valid_anchor, displays_as: :hAnchor
+      attribute :horizontal_padding, expects: :positive_integer, displays_as: :hSpace
+      attribute :horizontal_position, expects: :integer, displays_as: :x
+      attribute :lines, expects: :positive_integer
+      attribute :relative_horizontal_position, expects: :valid_relative_horizontal_position, displays_as: :xAlign
+      attribute :relative_vertical_position, expects: :valid_relative_vertical_position, displays_as: :yAlign
+      attribute :vertical_anchor, expects: :valid_anchor, displays_as: :vAnchor
+      attribute :vertical_padding, expects: :positive_integer, displays_as: :vSpace
+      attribute :vertical_position, expects: :integer, displays_as: :y
+      attribute :width, expects: :positive_integer, displays_as: :w
+      attribute :wrap, expects: :valid_wrap
+
+      def tag
+        :framePr
+      end
+
+      def name
+        "frame"
+      end
+
+      def to_xml(xml)
+        return if xml_attributes.empty?
+        xml["w"].public_send(tag, xml_attributes)
+      end
+
+    private
+
+      def valid_drop_cap(value)
+        valid_in? value, VALID_DROP_CAPS
+      end
+
+      def valid_anchor(value)
+        valid_in? value, VALID_ANCHORS
+      end
+
+      def valid_height_rule(value)
+        valid_in? value, VALID_HEIGHT_RULES
+      end
+
+      def valid_relative_horizontal_position(value)
+        valid_in? value, VALID_RELATIVE_HORIZONTAL_POSITIONS
+      end
+
+      def valid_relative_vertical_position(value)
+        valid_in? value, VALID_RELATIVE_VERTICAL_POSITIONS
+      end
+
+      def valid_wrap(value)
+        valid_in? value, VALID_WRAPS
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/indentation.rb

@@ -1,6 +1,6 @@
 module Rocx
   module Properties
-    class Indentation
+    class Indentation < BaseProperty
       attr_reader :value
 
       OK_KEYS = [:end, :endChars, :firstLine, :firstLineChars, :hanging, :hangingChars, :start, :startChars]

data/lib/rocx/properties/numbering.rb

@@ -0,0 +1,28 @@
+module Rocx
+  module Properties
+    class Numbering
+      include AttributeBuilder
+
+      attribute :level, expects: :positive_integer, displays_as: :ilvl
+      attribute :id, expects: :positive_integer, displays_as: :numId
+
+      def name
+        "numbering"
+      end
+
+      def tag
+        :numPr
+      end
+
+      def to_xml(xml)
+        return if xml_attributes.empty?
+        xml["w"].public_send(tag) {
+          xml_attributes.each do |tag_name, value|
+            xml.public_send(tag_name, "w:val" => value)
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/shading.rb

@@ -0,0 +1,75 @@
+module Rocx
+  module Properties
+    class Shading
+      include AttributeBuilder
+
+      VALID_SHADING_PATTERNS = %i(clear
+                                  diagCross
+                                  diagStripe
+                                  horzCross
+                                  horzStripe
+                                  nil
+                                  pct10
+                                  pct12
+                                  pct15
+                                  pct20
+                                  pct25
+                                  pct30
+                                  pct35
+                                  pct37
+                                  pct45
+                                  pct5
+                                  pct50
+                                  pct55
+                                  pct60
+                                  pct62
+                                  pct65
+                                  pct70
+                                  pct75
+                                  pct80
+                                  pct85
+                                  pct87
+                                  pct90
+                                  pct95
+                                  reverseDiagStripe
+                                  solid
+                                  thinDiagCross
+                                  thinDiagStripe
+                                  thinHorzCross
+                                  thinHorzStripe
+                                  thinReverseDiagStripe
+                                  thinVertStripe
+                                  vertStripe)
+
+      attribute :color, expects: :hex_color
+      attribute :fill, expects: :hex_color
+      attribute :theme_color, expects: :valid_theme_color, displays_as: :themeColor
+      attribute :theme_fill, expects: :valid_theme_color, displays_as: :themeFill
+      attribute :theme_fill_shade, expects: :hex_digit, displays_as: :themeFillShade
+      attribute :theme_fill_tint, expects: :hex_digit, displays_as: :themeFillTint
+      attribute :theme_shade, expects: :hex_digit, displays_as: :themeShade
+      attribute :theme_tint, expects: :hex_digit, displays_as: :themeTint
+      attribute :pattern, expects: :shading_pattern, displays_as: :val
+
+      def name
+        "shading"
+      end
+
+      def tag
+        :shd
+      end
+
+      def to_xml(xml)
+        return if xml_attributes.empty?
+        xml["w"].public_send(tag, xml_attributes)
+      end
+
+    private
+
+      def shading_pattern(value)
+        valid_in? value, VALID_SHADING_PATTERNS
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/spacing.rb

@@ -0,0 +1,38 @@
+module Rocx
+  module Properties
+    class Spacing
+      include AttributeBuilder
+
+      VALID_LINE_RULES = %i(atLeast auto exact)
+
+      attribute :after, expects: :positive_integer
+      attribute :after_auto, expects: :on_or_off, displays_as: :afterAutospacing
+      attribute :after_lines, expects: :integer, displays_as: :afterLines
+      attribute :before, expects: :positive_integer
+      attribute :before_auto, expects: :on_or_off, displays_as: :beforeAutospacing
+      attribute :before_lines, expects: :integer, displays_as: :beforeLines
+      attribute :line, expects: :integer
+      attribute :line_rule, expects: :valid_line_rule, displays_as: :lineRule
+
+      def name
+        "spacing"
+      end
+
+      def tag
+        :spacing
+      end
+
+      def to_xml(xml)
+        return if xml_attributes.empty?
+        xml["w"].public_send(tag, xml_attributes)
+      end
+
+    private
+
+      def valid_line_rule(value)
+        valid_in? value, VALID_LINE_RULES
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/tab.rb

@@ -0,0 +1,77 @@
+module Rocx
+  module Properties
+    class Tab
+      attr_reader :position, :type, :leader
+
+      VALID_TYPES = %i(bar center clear decimal end num start)
+      VALID_LEADERS = [nil, :dot, :heavy, :hyphen, :middleDot, :none, :underscore]
+
+      def initialize(position, type, leader=nil)
+        self.position = position
+        self.type = type
+        self.leader = leader
+      end
+
+      def position=(value)
+        raise ArgumentError, invalid_position_message unless valid_position?(value)
+        @position = value
+      end
+
+      def type=(value)
+        raise ArgumentError, invalid_type_message unless valid_type?(value)
+        @type = value
+      end
+
+      def leader=(value)
+        raise ArgumentError, invalid_leader_message unless valid_leader?(value)
+        @leader = value
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, xml_attributes)
+      end
+
+      def tag
+        :tab
+      end
+
+      def name
+        "tab"
+      end
+
+    private
+
+      def xml_attributes
+        attrs = { "w:pos" => position,
+                  "w:val" => type}
+        attrs["w:leader"] = leader if leader
+        attrs
+      end
+
+      def invalid_position_message
+        "Invalid position: must be an integer"
+      end
+
+      def valid_position?(value)
+        value.is_a?(Integer)
+      end
+
+      def invalid_type_message
+        "Invalid type: must be one of: #{VALID_TYPES.join(", ")}"
+      end
+
+      def valid_type?(value)
+        VALID_TYPES.member? value
+      end
+
+      def invalid_leader_message
+        "Invalid leader: must be one of: #{VALID_LEADERS.join(", ")}"
+      end
+
+      def valid_leader?(value)
+        VALID_LEADERS.member? value
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/tabs.rb

@@ -0,0 +1,55 @@
+module Rocx
+  module Properties
+    class Tabs
+      include Enumerable
+
+      def initialize
+        @tabs = []
+      end
+
+      def <<(tab)
+        raise ArgumentError, invalid_tab_message unless valid_tab?(tab)
+        tabs << tab
+      end
+
+      def each(*args, &block)
+        tabs.each *args, &block
+      end
+
+      def render?
+        !tabs.length.zero?
+      end
+
+      def to_xml(xml)
+        return unless render?
+
+        xml["w"].public_send(tag) {
+          each { |tab| tab.to_xml(xml) }
+        }
+      end
+
+      def name
+        "tabs"
+      end
+
+      def tag
+        :tabs
+      end
+
+    protected
+
+      attr_reader :tabs
+
+    private
+
+      def invalid_tab_message
+        "Tabs must be instances of Rocx::Properties::Tab"
+      end
+
+      def valid_tab?(tab)
+        tab.is_a?(Rocx::Properties::Tab)
+      end
+
+    end
+  end
+end