rocx 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9566d9952e4f4b81a945e27bc633c7367bcfa2c9
-  data.tar.gz: 23feeec4fecf2d69f371afcb15c1f42ecc5a2041
+  metadata.gz: 7ebac9d8d2e707e65cf407ccc36232723b714808
+  data.tar.gz: 31d5f1ddbf1b278ffd9e7f28a615bd53e58c5f05
 SHA512:
-  metadata.gz: de7d040a6ce8215a2cb59f4a5edeb40a44cc5ef60bb93780bbe4eff81573426e5cdaaa270d1d5718f498b016b88aeee0fc4107abfe39ee976a3c69ae8825fb86
-  data.tar.gz: 0ff4f77e0df501a0d137146aa397fc8dced38476e6b970ef32cdeccf1416be399d5a77784c66b9dddf1baf584c67fd9aa8446e2b85141e189c1ec4332dfbc77c
+  metadata.gz: ff8b3600a3cb1319f49cfc4abef91b0494973f21f4cf3b8c958d860bf61c2223fdb32fe7b4f6bd959096fe5198cb10349ffb4d15417b24f48d067055deb5258d
+  data.tar.gz: 2227d88abf6fe8c3829fce89535b371af53302c0c761b63569fbd9d0b0831bc7acc80f383f09e3a0d7cf80ae1c2afa90978f14ba543f9f11330693aa1b2ec175

data/.travis.yml

@@ -0,0 +1,6 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test

data/Gemfile.lock

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

data/lib/rocx.rb

@@ -1,7 +1,7 @@
+require "rocx/properties"
 require "rocx/elements"
 require "rocx/package"
 require "rocx/parts"
-require "rocx/properties"
 require "rocx/style"
 
 module Rocx

data/lib/rocx/elements/base_container.rb

@@ -9,7 +9,7 @@ module Rocx
           @properties_tag
         end
 
-        def property(name)
+        def value_property(name)
           attr_reader name
 
           define_method "#{name}=" do |value|
@@ -21,6 +21,21 @@ module Rocx
           properties << name
         end
 
+        def property(name)
+          define_method "#{name}" do
+            class_name = name.to_s.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
+
+            instance_variable_get "@#{name}"
+          end
+
+          properties << name
+        end
+
         def properties
           @properties ||= []
         end
@@ -46,7 +61,7 @@ module Rocx
 
       def property_xml(xml)
         props = properties.map(&method(:send)).compact
-        return if props.empty?
+        return if props.none?(&:render?)
         xml[namespace].public_send(properties_tag) {
           props.each { |prop| prop.to_xml(xml) }
         }

data/lib/rocx/elements/paragraph.rb

@@ -5,27 +5,39 @@ module Rocx
       namespace :w
       properties_tag :pPr
 
-      property :alignment
-      property :auto_adjust_right_indent
-      property :auto_space_de
-      property :auto_space_dn
-      property :bidi
-      property :conditional_formatting
-      property :contextual_spacing
-      property :div_id
-      property :keep_lines
-      property :keep_next
-      property :indentation
-      property :mirror_indent
-      property :outline_level
-      property :overflow_punctuation
-      property :page_break_before
-      property :snap_to_grid
-      property :supress_auto_hyphens
-      property :supress_line_numbers
-      property :supress_overlap
-      property :widow_control
-      property :word_wrap
+      value_property :alignment
+      value_property :auto_adjust_right_indent
+      value_property :auto_space_de
+      value_property :auto_space_dn
+      value_property :bidi
+      value_property :compress_punctuation
+      value_property :conditional_formatting
+      value_property :contextual_spacing
+      value_property :div_id
+      value_property :keep_lines
+      value_property :keep_next
+      value_property :indentation
+      value_property :mirror_indent
+      value_property :outline_level
+      value_property :overflow_punctuation
+      value_property :page_break_before
+      value_property :snap_to_grid
+      value_property :style
+      value_property :supress_auto_hyphens
+      value_property :supress_line_numbers
+      value_property :supress_overlap
+      value_property :textbox_tight_wrap
+      value_property :text_direction
+      value_property :vertical_alignment
+      value_property :widow_control
+      value_property :word_wrap
+
+      property :borders
+      property :frame
+      property :numbering
+      property :shading
+      property :spacing
+      property :tabs
     end
   end
 end

data/lib/rocx/elements/run.rb

@@ -4,8 +4,8 @@ module Rocx
       tag_name :r
       namespace :w
       properties_tag :rPr
-      property :italics
-      property :bold
+      value_property :italics
+      value_property :bold
 
     end
   end

data/lib/rocx/elements/style.rb

@@ -0,0 +1,19 @@
+module Rocx
+  module Properties
+    class Style < BaseProperty
+
+      def valid?
+        !value.nil?
+      end
+
+      def tag
+        :pStyle
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, "w:val" => value)
+      end
+
+    end
+  end
+end

data/lib/rocx/parts/base_part.rb

@@ -15,6 +15,10 @@ module Rocx
       end
 
       def read
+        strip_whitespace to_xml
+      end
+
+      def to_xml
         raise NotImplementedError
       end
 

data/lib/rocx/parts/content_types.rb

@@ -28,19 +28,15 @@ module Rocx
         overrides << {"PartName" => part_name, "ContentType" => content_type}
       end
 
-      def read
-        xml = build_xml do |xml|
+      def to_xml
+        build_xml do |xml|
           xml.Types(xmlns: "http://schemas.openxmlformats.org/package/2006/content-types") {
             defaults.each { |default| xml.Default(default) }
             overrides.each { |override| xml.Override(override) }
           }
         end
-        strip_whitespace(xml)
       end
 
     end
   end
 end
-
-
-

data/lib/rocx/parts/document.rb

@@ -11,8 +11,8 @@ module Rocx
         children << child
       end
 
-      def read
-        xml = build_xml do |xml|
+      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 {
@@ -20,7 +20,6 @@ module Rocx
             }
           }
         end
-        strip_whitespace(xml)
       end
 
     private

data/lib/rocx/parts/global_rels.rb

@@ -2,13 +2,12 @@ module Rocx
   module Parts
     class GlobalRels < BasePart
 
-      def read
-        xml = build_xml do |xml|
+      def to_xml
+        build_xml do |xml|
           xml.Relationships(xmlns: "http://schemas.openxmlformats.org/package/2006/relationships") {
             xml.Relationship(document_relation_attributes)
           }
         end
-        strip_whitespace(xml)
       end
 
     private

data/lib/rocx/parts/rels.rb

@@ -21,15 +21,14 @@ module Rocx
         relationships << {"Type" => type, "Target" => target, "Id" => id}
       end
 
-      def read
-        xml = build_xml do |xml|
+      def to_xml
+        build_xml do |xml|
           xml.Relationships(xmlns: "http://schemas.openxmlformats.org/package/2006/relationships") {
             relationships.each do |rel|
               xml.Relationship(rel)
             end
           }
         end
-        strip_whitespace(xml)
       end
 
     private

data/lib/rocx/parts/settings.rb

@@ -7,13 +7,12 @@ module Rocx
         @settings = []
       end
 
-      def read
-        xml = build_standalone_xml do |xml|
+      def to_xml
+        build_standalone_xml do |xml|
           xml.settings("xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main") {
             xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
           }
         end
-        strip_whitespace(xml)
       end
 
     end

data/lib/rocx/parts/styles.rb

@@ -11,15 +11,14 @@ module Rocx
         @styles << style
       end
 
-      def read
-        xml = build_standalone_xml do |xml|
+      def to_xml
+        build_standalone_xml do |xml|
           xml.styles(root_namespaces) {
             xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
             add_default_styles(xml)
             styles.each { |style| style.build_xml(xml) }
           }
         end
-        strip_whitespace(xml)
       end
 
     private

data/lib/rocx/properties/alignment.rb

@@ -1,6 +1,6 @@
 module Rocx
   module Properties
-    class Alignment
+    class Alignment < BaseProperty
       attr_reader :value
 
       OK_VALUES = [:both, :center, :distribute, :end, :highKashida, :lowKashida, :mediumKashida, :numTab, :start, :thaiDistribute]

data/lib/rocx/properties/attribute_builder.rb

@@ -0,0 +1,283 @@
+module Rocx
+  module Properties
+    module AttributeBuilder
+
+      VALID_THEME_COLORS = %i(accent1 accent2 accent3 accent4 accent5 accent6 background1 background2 dark1 dark2 followedHyperlink hyperlink light1 light2 none text1 text2)
+
+      VALID_TYPES = %i(apples
+                       archedScallops
+                       babyPacifier
+                       babyRattle
+                       balloons3Colors
+                       balloonsHotAir
+                       basicBlackDashes
+                       basicBlackDots
+                       basicBlackSquares
+                       basicThinLines
+                       basicWhiteDashes
+                       basicWhiteDots
+                       basicWhiteSquares
+                       basicWideInline
+                       basicWideMidline
+                       basicWideOutline
+                       bats
+                       birds
+                       birdsFlight
+                       cabins
+                       cakeSlice
+                       candyCorn
+                       celticKnotwork
+                       certificateBanner
+                       chainLink
+                       champagneBottle
+                       checkedBarBlack
+                       checkedBarColor
+                       checkered
+                       christmasTree
+                       circlesLines
+                       circlesRectangles
+                       classicalWave
+                       clocks
+                       compass
+                       confetti
+                       confettiGrays
+                       confettiOutlines
+                       confettiStreamers
+                       confettiWhite
+                       cornerTriangles
+                       couponCutoutDashes
+                       couponCutoutDots
+                       crazyMaze
+                       creaturesButterfly
+                       creaturesFish
+                       creaturesInsects
+                       creaturesLadyBug
+                       crossStitch
+                       cup
+                       custom
+                       dashDotStroked
+                       dashed
+                       dashSmallGap
+                       decoArch
+                       decoArchColor
+                       decoBlocks
+                       diamondsGray
+                       dotDash
+                       dotDotDash
+                       dotted
+                       double
+                       doubleD
+                       doubleDiamonds
+                       doubleWave
+                       earth1
+                       earth2
+                       earth3
+                       eclipsingSquares1
+                       eclipsingSquares2
+                       eggsBlack
+                       fans
+                       film
+                       firecrackers
+                       flowersBlockPrint
+                       flowersDaisies
+                       flowersModern1
+                       flowersModern2
+                       flowersPansy
+                       flowersRedRose
+                       flowersRoses
+                       flowersTeacup
+                       flowersTiny
+                       gems
+                       gingerbreadMan
+                       gradient
+                       handmade1
+                       handmade2
+                       heartBalloon
+                       heartGray
+                       hearts
+                       heebieJeebies
+                       holly
+                       houseFunky
+                       hypnotic
+                       iceCreamCones
+                       inset
+                       lightBulb
+                       lightning1
+                       lightning2
+                       mapleLeaf
+                       mapleMuffins
+                       mapPins
+                       marquee
+                       marqueeToothed
+                       moons
+                       mosaic
+                       musicNotes
+                       nil
+                       none
+                       northwest
+                       outset
+                       ovals
+                       packages
+                       palmsBlack
+                       palmsColor
+                       paperClips
+                       papyrus
+                       partyFavor
+                       partyGlass
+                       pencils
+                       people
+                       peopleHats
+                       peopleWaving
+                       poinsettias
+                       postageStamp
+                       pumpkin1
+                       pushPinNote1
+                       pushPinNote2
+                       pyramids
+                       pyramidsAbove
+                       quadrants
+                       rings
+                       safari
+                       sawtooth
+                       sawtoothGray
+                       scaredCat
+                       seattle
+                       shadowedSquares
+                       shapes1
+                       shapes2
+                       sharksTeeth
+                       shorebirdTracks
+                       single
+                       skyrocket
+                       snowflakeFancy
+                       snowflaskes
+                       sombrero
+                       southwest
+                       stars
+                       stars3d
+                       starsBlack
+                       starsShadowed
+                       starsTop
+                       sun
+                       swirligig
+                       thick
+                       thickThinLargeGap
+                       thickThinMediumGap
+                       thickThinSmallGap
+                       thinThickLargeGap
+                       thinThickMediumGap
+                       thinThickSmallGap
+                       thinThickThinLargeGap
+                       thinThickThinMediumGap
+                       thinThickThinSmallGap
+                       threeDEmboss
+                       threeDEngrave
+                       tornPaper
+                       tornPaperBlack
+                       trees
+                       triangle1
+                       triangle2
+                       triangleCircle1
+                       triangleCircle2
+                       triangleParty
+                       triangle
+                       triple
+                       twistedLines1
+                       twistedLines2
+                       vine
+                       wave
+                       waveline
+                       weavingAngles
+                       weavingBraid
+                       weavingRibbon
+                       weavingStrips
+                       whiteFlowers
+                       woodwork
+                       xIllusions
+                       zanyTriangles
+                       zigZag
+                       zigZagStitch)
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def attribute(name, expects: nil, displays_as: nil)
+          attr_reader name
+
+          define_method "#{name}=" do |value|
+            send(expects, value)
+            instance_variable_set "@#{name}", value
+          end
+
+          attributes[name] = displays_as || name
+        end
+
+        def attributes
+          @attributes ||= {}
+        end
+      end
+
+      def render?
+        attributes.keys.map(&method(:send)).any?
+      end
+
+      def attributes
+        self.class.attributes
+      end
+
+    private
+
+      def xml_attributes
+        attributes.each_with_object({}) do |(name, display), attrs|
+          value = send(name)
+          attrs["w:#{display}"] = value if value
+        end
+      end
+
+      def true_or_false(value)
+        message = "Invalid #{name}: frame must be true or false"
+        raise ArgumentError, message unless [true, false].member? value
+      end
+
+      def hex_color(value)
+        message = "Invalid #{name}: must be :auto or a hex color, e.g. 4F1B8C"
+        raise ArgumentError, message unless value == :auto || value =~ /[0-9A-F]{6}/
+      end
+
+      def hex_digit(value)
+        message = "Invalid #{name}: must be a two-digit hex number, e.g. BF"
+        raise ArgumentError, message unless value =~ /[0-9A-F]{2}/
+      end
+
+      def integer(value)
+        message = "Invalid #{name}: must be an integer"
+        raise ArgumentError, message unless value.is_a?(Integer)
+      end
+
+      def positive_integer(value)
+        message = "Invalid #{name}: must be a positive integer"
+        raise ArgumentError, message unless value.is_a?(Integer) && value >= 0
+      end
+
+      def on_or_off(value)
+        valid_in? value, [:on, :off]
+      end
+
+      def valid_theme_color(value)
+        valid_in? value, VALID_THEME_COLORS
+      end
+
+      def valid_type(value)
+        valid_in? value, VALID_TYPES
+      end
+
+      def valid_in?(value, list)
+        message = "Invalid #{name}: must be one of #{list.join(", ")}"
+        raise ArgumentError, message unless list.member?(value)
+      end
+
+    end
+  end
+end