rocx 0.5.7 → 0.5.8

data/lib/rocx/properties/toggle_property.rb

@@ -1,6 +1,6 @@
 module Rocx
   module Properties
-    class ToggleProperty < BaseProperty
+    class ToggleProperty < ValueProperty
 
       def ok_values
         [nil, true, false]

data/lib/rocx/properties/underline.rb

@@ -0,0 +1,24 @@
+module Rocx
+  module Properties
+    class Underline < ComplexProperty
+      include AttributeBuilder
+
+      tag :u
+
+      VALID_UNDERLINE_TYPES = %i(dash dashDotDotHeavy dashDotHeavy dashedHeavy dashLong dashLongHeavy dotDash dotDotDash dotted dottedHeavy double none single thick wave wavyDouble wavyHeavy words)
+
+      attribute :color, expects: :hex_color
+      attribute :theme_color, expects: :valid_theme_color
+      attribute :theme_shade, expects: :hex_digit
+      attribute :theme_tint, expects: :hex_digit
+      attribute :type, expects: :valid_underline_type, displays_as: :val
+
+    private
+
+      def valid_underline_type(value)
+        valid_in? value, VALID_UNDERLINE_TYPES
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/value_property.rb

@@ -0,0 +1,29 @@
+module Rocx
+  module Properties
+    class ValueProperty < BaseProperty
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+        raise ArgumentError, invalid_message unless valid?
+      end
+
+      def valid?
+        ok_values.member? value
+      end
+
+      def invalid_message
+        "Invalid value for #{name}; acceptable values are #{ok_values.join(", ")}"
+      end
+
+      def render?
+        !value.nil?
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, "w:val" => value)
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/vertical_alignment.rb

@@ -1,17 +1,10 @@
 module Rocx
   module Properties
-    class VerticalAlignment < BaseProperty
+    class VerticalAlignment < ValueProperty
+      tag :vertAlign
 
       def ok_values
-        %i(auto baseline bottom center top)
-      end
-
-      def to_xml(xml)
-        xml["w"].public_send(tag, "w:val" => value)
-      end
-
-      def tag
-        :textAlignment
+        %i(baseline subscript superscript)
       end
 
     end

data/lib/rocx/properties/web_hidden.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class WebHidden < ToggleProperty
+    end
+  end
+end

data/lib/rocx/version.rb

@@ -1,3 +1,3 @@
 module Rocx
-  VERSION = "0.5.7"
+  VERSION = "0.5.8"
 end

data/rocx.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency "open_xml_package"
 
   gem.add_development_dependency "pry"
-  gem.add_development_dependency "turn"
+  gem.add_development_dependency "rspec"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rr"
-  gem.add_development_dependency "shoulda-context"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "timecop"
 

data/spec/elements/break_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Rocx::Elements::Break do
+  include ElementTestMacros
+
+  context "when creating a new break" do
+    it "should not accept invalid values for the clear property" do
+      expect { described_class.new(clear: :obviouslyInvalid) }.to raise_error(ArgumentError)
+    end
+
+    it "should not accept invalid values for the break_type property" do
+      expect { described_class.new(break_type: :invalidType) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "after initial creation" do
+    before(:each) do
+      @node = described_class.new
+    end
+
+    it "should still not accept invalid values for the clear property" do
+      node = described_class.new
+      expect { node.clear = :invalid }.to raise_error(ArgumentError)
+    end
+
+    it "should still not accept invalid values for the break_type property" do
+      node = described_class.new
+      expect { node.break_type = :weird }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "when both properties are nil" do
+    before(:each) do
+      @node = described_class.new
+    end
+
+    it_should_output_correct_xml
+  end
+
+  context "when either of the properties isn't nil" do
+    before(:each) do
+      @node = described_class.new(break_type: :page, clear: :left)
+    end
+
+    it_should_output_correct_xml node_xml: "break_with_attributes"
+  end
+end

data/spec/elements/paragraph_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Rocx::Elements::Paragraph do
+  include ElementTestMacros
+
+  context "with runs" do
+    before(:each) do
+      @node = described_class.new
+      node.indentation.start = 720
+      node.indentation.end = -1440
+      run = Rocx::Elements::Run.new
+      run << Rocx::Elements::Text.new("Hey Run 1")
+      node << run
+      run = Rocx::Elements::Run.new
+      run << Rocx::Elements::Text.new("Hey Run 2")
+      node << run
+    end
+
+    it_should_output_correct_xml node_xml: "paragraph_with_runs"
+  end
+
+  context "without runs" do
+    before(:each) do
+      @node = described_class.new
+      node.alignment = :center
+    end
+
+    it_should_output_correct_xml
+  end
+
+end

data/spec/elements/run_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Rocx::Elements::Run do
+  include ElementTestMacros
+
+  context "after creation" do
+    before(:each) do
+      @node = described_class.new
+      node.italics = true
+    end
+
+    it_should_output_correct_xml
+  end
+
+end

data/spec/elements/symbol_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Rocx::Elements::Symbol do
+  include ElementTestMacros
+
+  context "always" do
+    before(:each) do
+      @node = described_class.new
+    end
+
+    it "should raise an exception if the char property isn't a 4-digit hex" do
+      expect { node.char = "not valid" }.to raise_error(ArgumentError)
+      expect { node.char = "43fd" }.to_not raise_error
+    end
+  end
+
+  context "with valid attributes" do
+    before(:each) do
+      @node = described_class.new(char: "43fd", font: "Wingdings")
+    end
+
+    it_should_output_correct_xml
+  end
+end

data/spec/elements/text_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Rocx::Elements::Text do
+  include ElementTestMacros
+
+  context "for the space attribute" do
+    it "shoudl require space to be :preserve or nil" do
+      expect { described_class.new("Banana", space: :preserve) }.to_not raise_error
+
+      expect { described_class.new("Banana") }.to_not raise_error
+
+      expect { described_class.new("Banana", space: :the_final_frontier) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "with valid attributes" do
+    before(:each) do
+      @node = described_class.new("Banana", space: :preserve)
+    end
+
+    it_should_output_correct_xml
+  end
+end

data/spec/package_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Rocx::Package do
+  attr_reader :package
+
+  context "when starting a new package" do
+    before(:each) do
+      @package = described_class.new
+    end
+
+    it "should create the content types part" do
+      expect(package.content_types).to be_instance_of(Rocx::Parts::ContentTypes)
+    end
+
+    it "should create the document part" do
+      expect(package.document).to be_instance_of(Rocx::Parts::Document)
+    end
+
+    it "should create the global rels part" do
+      expect(package.global_rels).to be_instance_of(Rocx::Parts::GlobalRels)
+    end
+
+    it "should create the _rels part" do
+      expect(package.rels).to be_instance_of(Rocx::Parts::Rels)
+    end
+
+    it "should create the settings part" do
+      expect(package.settings).to be_instance_of(Rocx::Parts::Settings)
+    end
+
+    it "should create the styles part" do
+      expect(package.styles).to be_instance_of(Rocx::Parts::Styles)
+    end
+  end
+
+  context "when saving a package" do
+    before(:each) do
+      @package = described_class.new
+    end
+
+    it "should write to a OpenXmlPackage" do
+      path = "some_file.docx"
+      mock.instance_of(OpenXmlPackage).write_to(path)
+      package.save(path)
+    end
+  end
+
+end

data/spec/parts/content_types_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Rocx::Parts::ContentTypes do
+  include PartTestMacros
+
+  context "when first creating the content types" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it "should install the preset defaults" do
+      expect(doc.defaults.length).to eq(3)
+    end
+
+    it "should install the present overrides" do
+      expect(doc.overrides.length).to eq(2)
+    end
+  end
+
+  context "after creating the content types" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it "should be able to add additional defaults" do
+      doc.default "coolml", "text/coolml"
+      expect(doc.defaults).to include({"Extension" => "coolml", "ContentType" => "text/coolml"})
+    end
+
+    it_should_output_correct_xml
+  end
+end

data/spec/parts/document_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Rocx::Parts::Document do
+  include PartTestMacros
+
+  context "with child elements" do
+    before(:each) do
+      @doc = described_class.new
+      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_children"
+  end
+
+  context "with no elements" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it_should_output_correct_xml part: "empty_document"
+  end
+end

data/spec/parts/global_rels_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Rocx::Parts::GlobalRels do
+  include PartTestMacros
+
+  context "always" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it_should_output_correct_xml
+  end
+end

data/spec/parts/rels_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Rocx::Parts::Rels do
+  include PartTestMacros
+
+  context "when initially setting up the rels" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it "should automatically create the relationship to the settings file" do
+      expected_relation = { "Type" => "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings",
+                            "Target" => "/word/settings.xml",
+                            "Id" => "R1efaa81aac7a4831" }
+      expect(doc.relationships).to include(expected_relation)
+    end
+
+    it "should automatically create the relationship to the styles file" do
+      expected_relation = { "Type" => "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
+                            "Target" => "/word/styles.xml",
+                            "Id" => "Rf06246a95c004384" }
+      expect(doc.relationships).to include(expected_relation)
+    end
+  end
+
+  context "after setting up the rels" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it "should be possible to add additional relationships" do
+      new_relationship = { "Type" => "nope.com",
+                           "Target" => "/cool/cool.xml",
+                           "Id" => "1234567890" }
+      doc.relationship *new_relationship.values
+      expect(doc.relationships).to include(new_relationship)
+    end
+
+    it_should_output_correct_xml
+  end
+
+end

data/spec/parts/settings_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Rocx::Parts::Settings do
+  include PartTestMacros
+
+  context "always" do
+    before(:each) do
+      @doc = described_class.new
+    end
+
+    it_should_output_correct_xml
+  end
+end