rocx 0.6.0 → 0.7.0

data/lib/rocx/properties/page_size.rb

@@ -0,0 +1,21 @@
+module Rocx
+  module Properties
+    class PageSize < ComplexProperty
+      tag :pgSz
+
+      attribute :code, expects: :integer
+      attribute :height, expects: :positive_integer, displays_as: :h
+      attribute :orientation, expects: :valid_orientation, displays_as: :orient
+      attribute :width, expects: :positive_integer, displays_as: :w
+
+      VALID_PAGE_ORIENTATIONS = %i(portrait landscape)
+
+    private
+
+      def valid_orientation(value)
+        valid_in? value, VALID_PAGE_ORIENTATIONS
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/{borders.rb → paragraph_borders.rb}

@@ -1,6 +1,6 @@
 module Rocx
   module Properties
-    class Borders < ComplexProperty
+    class ParagraphBorders < ComplexProperty
       attr_reader :left, :right, :top, :bottom, :between, :bar
 
       def initialize
@@ -13,9 +13,10 @@ module Rocx
       end
 
       tag :pBdr
+      name "borders"
 
       def render?
-        !renderable_borders.length.zero?
+        renderable_borders.any?
       end
 
       def to_xml(xml)

data/lib/rocx/properties/rtl_gutter.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class RtlGutter < BooleanProperty
+    end
+  end
+end

data/lib/rocx/properties/section_type.rb

@@ -0,0 +1,13 @@
+module Rocx
+  module Properties
+    class SectionType < ValueProperty
+      tag :type
+      name "type"
+
+      def ok_values
+        %i(continuous evenPage nextColumn nextPage oddPage)
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/tabs.rb

@@ -1,46 +1,7 @@
 module Rocx
   module Properties
-    class Tabs < BaseProperty
-      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
-
-    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
+    class Tabs < ContainerProperty
+      child_class :tab
 
     end
   end

data/lib/rocx/properties/vertical_text_alignment.rb

@@ -0,0 +1,12 @@
+module Rocx
+  module Properties
+    class VerticalTextAlignment < ValueProperty
+      tag :vAlign
+
+      def ok_values
+        %i(both bottom center top)
+      end
+
+    end
+  end
+end

data/lib/rocx/property_builder.rb

@@ -0,0 +1,72 @@
+module Rocx
+  module PropertyBuilder
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      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
+
+          instance_variable_get "@#{name}"
+        end
+        CODE
+      end
+
+      def properties
+        @properties ||= {}
+      end
+    end
+
+  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
+    end
+
+  end
+end

data/lib/rocx/section.rb

@@ -0,0 +1,34 @@
+module Rocx
+  class Section
+    include PropertyBuilder
+
+    properties_tag :sectPr
+
+    property :columns
+    property :document_grid
+    property :line_numbering
+    property :page_borders
+    property :page_margins
+    property :page_numbering
+    property :page_size
+    property :paper_source
+
+    value_property :bidi
+    value_property :form_protection
+    value_property :rtl_gutter
+    value_property :text_direction
+    value_property :type, as: :section_type
+    value_property :vertical_alignment, as: :vertical_text_alignment
+
+    def to_xml(xml)
+      property_xml xml
+    end
+
+  private
+
+    def namespace
+      :w
+    end
+
+  end
+end

data/lib/rocx/version.rb

@@ -1,3 +1,3 @@
 module Rocx
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/elements/ruby_spec.rb

@@ -5,11 +5,11 @@ describe Rocx::Elements::Ruby do
 
   it_should_use tag: :ruby, name: "ruby"
 
-  it_should_have_property :font_size, as_instance_of: :phonetic_guide_font_size, with_value: 1
-  it_should_have_property :base_font_size, as_instance_of: :phonetic_guide_base_font_size, with_value: 1
-  it_should_have_property :font_size_raise, as_instance_of: :phonetic_guide_font_size_raise, with_value: 1
-  it_should_have_property :language, as_instance_of: :phonetic_guide_language, with_value: "ja-JP"
-  it_should_have_property :alignment, as_instance_of: :phonetic_guide_alignment, with_value: :left
+  it_should_have_value_property :font_size, as_instance_of: :phonetic_guide_font_size, with_value: 1
+  it_should_have_value_property :base_font_size, as_instance_of: :phonetic_guide_base_font_size, with_value: 1
+  it_should_have_value_property :font_size_raise, as_instance_of: :phonetic_guide_font_size_raise, with_value: 1
+  it_should_have_value_property :language, as_instance_of: :phonetic_guide_language, with_value: "ja-JP"
+  it_should_have_value_property :alignment, as_instance_of: :phonetic_guide_alignment, with_value: :left
 
   context "for base text" do
     before(:each) do

data/spec/parts/document_spec.rb

@@ -29,4 +29,67 @@ describe Rocx::Parts::Document do
 
     it_should_output_correct_xml part: "empty_document"
   end
+
+  context "with only one section" do
+    before(:each) do
+      @doc = described_class.new
+
+      section = Rocx::Section.new
+      section.bidi = true
+
+      doc << section
+
+      paragraph = Rocx::Elements::Paragraph.new
+
+      first_run = Rocx::Elements::Run.new
+      first_run << Rocx::Elements::Text.new("This is just a test run.")
+      paragraph << first_run
+
+      second_run = Rocx::Elements::Run.new
+      second_run << Rocx::Elements::Text.new("But this isn't!")
+      paragraph << second_run
+
+      doc << paragraph
+    end
+
+    it_should_output_correct_xml part: "document_with_one_section"
+  end
+
+  context "with multiple sections" do
+    before(:each) do
+      @doc = described_class.new
+
+      section = Rocx::Section.new
+      section.bidi = true
+
+      doc << section
+
+      paragraph = Rocx::Elements::Paragraph.new
+
+      first_run = Rocx::Elements::Run.new
+      first_run << Rocx::Elements::Text.new("This is just a test run.")
+      paragraph << first_run
+
+      second_run = Rocx::Elements::Run.new
+      second_run << Rocx::Elements::Text.new("But this isn't!")
+      paragraph << second_run
+
+      doc << paragraph
+
+      section = Rocx::Section.new
+      section.text_direction = :lr
+
+      doc << section
+
+      paragraph = Rocx::Elements::Paragraph.new
+
+      first_run = Rocx::Elements::Run.new
+      first_run << Rocx::Elements::Text.new("This is just a test run.")
+      paragraph << first_run
+
+      doc << paragraph
+    end
+
+    it_should_output_correct_xml part: "document_with_multiple_sections"
+  end
 end

data/spec/properties/column_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Rocx::Properties::Column do
+  include PropertyTestMacros
+
+  it_should_use tag: :col, name: "column", value: [1, 1]
+
+  for_attribute(:space) do
+    with_value(2) do
+      it_should_assign_successfully 1, 1
+      it_should_output "<w:col w:space=\"2\" w:w=\"1\"/>", 1, 1
+    end
+
+    with_value(-1) do
+      it_should_raise_an_exception
+    end
+
+    with_value(12.1) do
+      it_should_raise_an_exception
+    end
+
+    with_value(:big) do
+      it_should_raise_an_exception
+    end
+  end
+
+  for_attribute(:width) do
+    with_value(2) do
+      it_should_assign_successfully 1, 1
+      it_should_output "<w:col w:space=\"1\" w:w=\"2\"/>", 1, 1
+    end
+
+    with_value(-1) do
+      it_should_raise_an_exception
+    end
+
+    with_value(12.1) do
+      it_should_raise_an_exception
+    end
+
+    with_value(:big) do
+      it_should_raise_an_exception
+    end
+  end
+
+end

data/spec/properties/columns_spec.rb

@@ -0,0 +1,174 @@
+require "spec_helper"
+
+describe Rocx::Properties::Columns do
+  include PropertyTestMacros
+
+  it_should_use tag: :cols, name: "columns"
+
+  context "when trying to add columns, it" do
+    before(:each) do
+      @instance = described_class.new
+    end
+
+    it "should raise an exception if the column to be added isn't a column at all" do
+      expect { instance << [] }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "when there are no columns" do
+    before(:each) do
+      @instance = described_class.new
+    end
+
+    it "should not output any XML" do
+      expect(xml(instance)).to eq("")
+    end
+  end
+
+  context "when there are columns" do
+    before(:each) do
+      @instance = described_class.new
+      instance << Rocx::Properties::Column.new(1234, 5678)
+      instance << Rocx::Properties::Column.new(8765, 4321)
+    end
+
+    it "should output the correct XML" do
+      expect(xml(instance)).to eq("<w:cols>\n    <w:col w:space=\"1234\" w:w=\"5678\"/>\n    <w:col w:space=\"8765\" w:w=\"4321\"/>\n  </w:cols>")
+    end
+  end
+
+  for_attribute(:equal_width) do
+    before(:each) do
+      @instance = described_class.new
+      @instance << Rocx::Properties::Column.new(1, 1)
+    end
+
+    context "when the value is true" do
+      before(:each) do
+        @value = true
+      end
+
+      it "should accept the value" do
+        expect { instance.send("#{attribute}=", value) }.to_not raise_error
+      end
+
+      it "should output the correct value" do
+        instance.send("#{attribute}=", value)
+        expect(xml(instance)).to eq("<w:cols w:equalWidth=\"true\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+      end
+    end
+
+    for_attribute(:number) do
+      before(:each) do
+        @instance = described_class.new
+        @instance << Rocx::Properties::Column.new(1, 1)
+      end
+
+      context "when the value is 1" do
+        before(:each) do
+          @value = 1
+        end
+
+        it "should accept the value" do
+          expect { instance.send("#{attribute}=", value) }.to_not raise_error
+        end
+
+        it "should output the correct value" do
+          instance.send("#{attribute}=", value)
+          expect(xml(instance)).to eq("<w:cols w:num=\"1\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+        end
+      end
+
+      context "when the value is -1" do
+        before(:each) do
+          @value = -1
+        end
+
+        it "should accept the value" do
+          expect { instance.send("#{attribute}=", value) }.to_not raise_error
+        end
+
+        it "should output the correct value" do
+          instance.send("#{attribute}=", value)
+          expect(xml(instance)).to eq("<w:cols w:num=\"-1\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+        end
+      end
+
+      with_value(1.3) do
+        it_should_raise_an_exception
+      end
+
+      with_value(:a_lot) do
+        it_should_raise_an_exception
+      end
+    end
+
+    for_attribute(:separator) do
+      before(:each) do
+        @instance = described_class.new
+        @instance << Rocx::Properties::Column.new(1, 1)
+      end
+
+      context "when the value is true" do
+        before(:each) do
+          @value = true
+        end
+
+        it "should accept the value" do
+          expect { instance.send("#{attribute}=", value) }.to_not raise_error
+        end
+
+        it "should output the correct value" do
+          instance.send("#{attribute}=", value)
+          expect(xml(instance)).to eq("<w:cols w:sep=\"true\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+        end
+      end
+    end
+
+    for_attribute(:space) do
+      before(:each) do
+        @instance = described_class.new
+        @instance << Rocx::Properties::Column.new(1, 1)
+      end
+
+      context "when the value is 1" do
+        before(:each) do
+          @value = 1
+        end
+
+        it "should accept the value" do
+          expect { instance.send("#{attribute}=", value) }.to_not raise_error
+        end
+
+        it "should output the correct value" do
+          instance.send("#{attribute}=", value)
+          expect(xml(instance)).to eq("<w:cols w:space=\"1\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+        end
+      end
+
+      context "when the value is -1" do
+        before(:each) do
+          @value = -1
+        end
+
+        it "should accept the value" do
+          expect { instance.send("#{attribute}=", value) }.to_not raise_error
+        end
+
+        it "should output the correct value" do
+          instance.send("#{attribute}=", value)
+          expect(xml(instance)).to eq("<w:cols w:space=\"-1\">\n    <w:col w:space=\"1\" w:w=\"1\"/>\n  </w:cols>")
+        end
+      end
+
+      with_value(1.3) do
+        it_should_raise_an_exception
+      end
+
+      with_value(:a_lot) do
+        it_should_raise_an_exception
+      end
+    end
+
+  end
+end