rocx 0.5.6

data/lib/rocx/properties/contextual_spacing.rb

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

data/lib/rocx/properties/div_id.rb

@@ -0,0 +1,23 @@
+module Rocx
+  module Properties
+    class DivId < BaseProperty
+
+      def valid?
+        value.is_a?(Integer)
+      end
+
+      def invalid_message
+        "Invalid value for #{name}; acceptable values are integers"
+      end
+
+      def tag
+        :divId
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, "w:val" => value)
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/indentation.rb

@@ -0,0 +1,31 @@
+module Rocx
+  module Properties
+    class Indentation
+      attr_reader :value
+
+      OK_KEYS = [:end, :endChars, :firstLine, :firstLineChars, :hanging, :hangingChars, :start, :startChars]
+
+      def initialize(value)
+        @value = value
+        raise ArgumentError invalid_message unless valid?
+      end
+
+      def invalid_message
+        "Invalid value for indentation"
+      end
+
+      def valid?
+        value.keys.all?(&OK_KEYS.method(:member?))
+      end
+
+      def to_xml(xml)
+        return unless value.length > 0
+        namespaced_values = value.each_with_object({}) do |(prop, value), values|
+          values["w:#{prop}"] = value
+        end
+        xml["w"].ind(namespaced_values) if value
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/italics.rb

@@ -0,0 +1,11 @@
+module Rocx
+  module Properties
+    class Italics < ToggleProperty
+
+      def tag
+        :i
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/keep_lines.rb

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

data/lib/rocx/properties/keep_next.rb

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

data/lib/rocx/properties/kinsoku.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class Kinsoku < OnOffProperty
+    end
+  end
+end

data/lib/rocx/properties/mirror_indent.rb

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

data/lib/rocx/properties/on_off_property.rb

@@ -0,0 +1,15 @@
+module Rocx
+  module Properties
+    class OnOffProperty < BaseProperty
+
+      def ok_values
+        [nil, :on, :off]
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, "w:val" => value) if value
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/outline_level.rb

@@ -0,0 +1,23 @@
+module Rocx
+  module Properties
+    class OutlineLevel < BaseProperty
+
+      def valid?
+        value.is_a?(Integer) && value >= 0
+      end
+
+      def invalid_message
+        "Invalid value for #{name}; acceptable values are integers greater than or equal to 0"
+      end
+
+      def tag
+        :outlineLvl
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag, "w:val" => value)
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/overflow_punctuation.rb

@@ -0,0 +1,15 @@
+module Rocx
+  module Properties
+    class OverflowPunctuation < BooleanProperty
+
+      def name
+        "overflow_punctuation"
+      end
+
+      def tag
+        :overflowPunct
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/page_break_before.rb

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

data/lib/rocx/properties/snap_to_grid.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class SnapToGrid < OnOffProperty
+    end
+  end
+end

data/lib/rocx/properties/supress_auto_hyphens.rb

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

data/lib/rocx/properties/supress_line_numbers.rb

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

data/lib/rocx/properties/supress_overlap.rb

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

data/lib/rocx/properties/toggle_property.rb

@@ -0,0 +1,15 @@
+module Rocx
+  module Properties
+    class ToggleProperty < BaseProperty
+
+      def ok_values
+        [nil, true, false]
+      end
+
+      def to_xml(xml)
+        xml["w"].public_send(tag) if value
+      end
+
+    end
+  end
+end

data/lib/rocx/properties/widow_control.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class WidowControl < OnOffProperty
+    end
+  end
+end

data/lib/rocx/properties/word_wrap.rb

@@ -0,0 +1,6 @@
+module Rocx
+  module Properties
+    class WordWrap < OnOffProperty
+    end
+  end
+end

data/lib/rocx/style.rb

@@ -0,0 +1,38 @@
+module Rocx
+  class Style
+    attr_reader :name, :type, :run, :paragraph
+
+    def initialize(name, type, run={}, paragraph={})
+      @name = name
+      @type = type
+      @run = run
+      @paragraph = paragraph
+    end
+
+    def build_xml(xml)
+      xml["w"].style("w:styleId" => name, "w:type" => type) {
+        xml["w"].name("w:val" => name)
+        paragraph_as_xml(xml)
+        run_as_xml(xml)
+      }
+    end
+
+  private
+
+    def paragraph_as_xml(xml)
+      xml["w"].pPr { xml_properties(xml, paragraph) }
+    end
+
+    def run_as_xml(xml)
+      xml["w"].rPr { xml_properties(xml, run) }
+    end
+
+    def xml_properties(xml, properties)
+      properties.each do |property, options|
+        namespace, tag = property.split(":")
+        xml[namespace].send(tag, options)
+      end
+    end
+
+  end
+end

data/lib/rocx/version.rb

@@ -0,0 +1,3 @@
+module Rocx
+  VERSION = "0.5.6"
+end

data/rocx.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rocx/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rocx"
+  gem.version       = Rocx::VERSION
+  gem.authors       = ["Gene Doyel"]
+  gem.email         = ["gene.doyel@cph.org"]
+  gem.description   = %q{Create Microsoft Word (.docx) files.}
+  gem.summary       = %q{Using a simple API, create docx files programmatically, including bullet points, titles, headings, page breaks and tables!}
+  gem.homepage      = "https://github.com/genebot/rocx"
+  gem.required_ruby_version = "~> 2.0"
+
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "open_xml_package"
+
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "turn"
+  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"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = Dir.glob('test/**/*_test.rb')
+  gem.require_paths = ["lib"]
+end

data/test/data/elements/break_element.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:br/>
+</root>

data/test/data/elements/break_with_attributes_element.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:br w:type="page" w:clear="left"/>
+</root>

data/test/data/elements/paragraph_element.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:p>
+    <w:pPr>
+      <w:jc w:val="center"/>
+    </w:pPr>
+  </w:p>
+</root>

data/test/data/elements/paragraph_with_runs_element.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:p>
+    <w:pPr>
+      <w:ind w:start="720" w:end="-1440"/>
+    </w:pPr>
+    <w:r>
+      <w:t>Hey Run 1</w:t>
+    </w:r>
+    <w:r>
+      <w:t>Hey Run 2</w:t>
+    </w:r>
+  </w:p>
+</root>

data/test/data/elements/run_element.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:r>
+    <w:rPr>
+      <w:i/>
+    </w:rPr>
+  </w:r>
+</root>

data/test/data/elements/symbol_element.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:sym w:font="Wingdings" w:char="43fd"/>
+</root>

data/test/data/elements/text_element.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<root xmlns:w="http://wnamespace.org">
+  <w:t xml:space="preserve">Banana</w:t>
+</root>

data/test/data/parts/content_types_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Default Extension="xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/><Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Default Extension="png" ContentType="image/png"/><Override PartName="/word/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml"/><Override PartName="/word/settings.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml"/></Types>

data/test/data/parts/document_with_children_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><w:document xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:mo="http://schemas.microsoft.com/office/mac/office/2008/main" xmlns:mv="urn:schemas-microsoft-com:mac:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="w14 wp14"><w:body><w:p><w:r><w:t>This is just a test run.</w:t></w:r><w:r><w:t>But this isn't!</w:t></w:r></w:p></w:body></w:document>

data/test/data/parts/empty_document_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><w:document xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:mo="http://schemas.microsoft.com/office/mac/office/2008/main" xmlns:mv="urn:schemas-microsoft-com:mac:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="w14 wp14"><w:body/></w:document>

data/test/data/parts/global_rels_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="/word/document.xml" Id="R08806881ac3c45ac"/></Relationships>

data/test/data/parts/rels_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="/word/styles.xml" Id="Rf06246a95c004384"/><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" Target="/word/settings.xml" Id="R1efaa81aac7a4831"/></Relationships>

data/test/data/parts/settings_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"/>

data/test/data/parts/styles_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><w:styles xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:docDefaults><w:rPrDefault><w:rPr><w:lang w:bidi="ar-SA" w:eastAsia="en-US" w:val="en-US"/></w:rPr></w:rPrDefault><w:pPrDefault><w:pPr><w:spacing w:after="0" w:line="240" w:lineRule="auto"/></w:pPr></w:pPrDefault></w:docDefaults></w:styles>

data/test/data/parts/styles_with_custom_style_part.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><w:styles xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:docDefaults><w:rPrDefault><w:rPr><w:lang w:bidi="ar-SA" w:eastAsia="en-US" w:val="en-US"/></w:rPr></w:rPrDefault><w:pPrDefault><w:pPr><w:spacing w:after="0" w:line="240" w:lineRule="auto"/></w:pPr></w:pPrDefault></w:docDefaults><w:style w:styleId="coolStyle" w:type="paragraph"><w:name w:val="coolStyle"/><w:pPr><w:ind w:firstLine="0" w:left="0" w:right="0"/><w:jc w:val="left"/></w:pPr><w:rPr/></w:style></w:styles>

data/test/data/styles/character_styles.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<styleFoo xmlns:w="http://wnamespace.com">
+  <w:style w:styleId="anotherCoolStyle" w:type="character">
+    <w:name w:val="anotherCoolStyle"/>
+    <w:pPr/>
+    <w:rPr>
+      <w:rFonts w:ascii="Times New Roman" w:cs="Times New Roman" w:hAnsi="Times New Roman"/>
+      <w:color w:val="FF0000"/>
+      <w:sz w:val="20"/>
+      <w:b w:val="0"/>
+      <w:i w:val="0"/>
+      <w:u w:val="none"/>
+    </w:rPr>
+  </w:style>
+</styleFoo>

data/test/data/styles/paragraph_styles.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<styleFoo xmlns:w="http://wnamespace.com">
+  <w:style w:styleId="coolStyle" w:type="paragraph">
+    <w:name w:val="coolStyle"/>
+    <w:pPr>
+      <w:ind w:firstLine="0" w:left="0" w:right="0"/>
+      <w:jc w:val="left"/>
+    </w:pPr>
+    <w:rPr/>
+  </w:style>
+</styleFoo>

data/test/elements/break_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+class BreakTest < Test::Unit::TestCase
+  attr_reader :break_node
+
+  context "when creating a new break, it" do
+    should "not accept invalid values for the clear property" do
+      assert_raises ArgumentError do
+        @break_node = Rocx::Elements::Break.new(clear: :obviouslyInvalid)
+      end
+    end
+
+    should "not accept invalid values for the break_type property" do
+      assert_raises ArgumentError do
+        @break_node = Rocx::Elements::Break.new(break_type: :invalidType)
+      end
+    end
+  end
+
+  context "after initial creation, it" do
+    should "still not accept invalid values for the clear property" do
+      assert_raises ArgumentError do
+        @break_node = Rocx::Elements::Break.new
+        break_node.clear = :invalid
+      end
+    end
+
+    should "still not accept invalid values for the break_type property" do
+      assert_raises ArgumentError do
+        @break_node = Rocx::Elements::Break.new
+        break_node.break_type :weird
+      end
+    end
+  end
+
+  context "when generating XML" do
+    context "and both property is nil, it" do
+      should "omit the attributes" do
+        @break_node = Rocx::Elements::Break.new
+        break_xml = build_xml { |xml| break_node.to_xml(xml) }
+        assert_equal element_xml("break"), break_xml
+      end
+    end
+
+    context "and a property isn't nil, it" do
+      should "include that attribute" do
+        @break_node = Rocx::Elements::Break.new(break_type: :page, clear: :left)
+        break_xml = build_xml { |xml| break_node.to_xml(xml) }
+        assert_equal element_xml("break_with_attributes"), break_xml
+      end
+    end
+  end
+
+end