sheng 0.3.2

data/spec/fixtures/xml_fragments/output/sequence/sequence.xml

@@ -0,0 +1,28 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:t>A Radish Summer</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>totally rad</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:t>Elephants Are Not Your Friend</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>stinky</w:t>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/output/sequence/sequence_in_table.xml

@@ -0,0 +1,120 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:tbl>
+    <w:tr>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Meal</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Drink</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Appetizer</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Dessert</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+    </w:tr>
+    <w:tr>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Gravel Noodles</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Asphalt Rollups</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Concrete Cream</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+    </w:tr>
+    <w:tr>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:rPr>
+              <w:noProof/>
+            </w:rPr>
+            <w:t>Steamed Water</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+    </w:tr>
+    <w:tr>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>A Single Olive</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>A Strand of Hair</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:t>Wishes and Hopes</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+    </w:tr>
+    <w:tr>
+      <w:tc>
+        <w:p>
+          <w:r>
+            <w:rPr>
+              <w:noProof/>
+            </w:rPr>
+            <w:t>The Memory of Soda</w:t>
+          </w:r>
+        </w:p>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+      <w:tc>
+      </w:tc>
+    </w:tr>
+  </w:tbl>
+</w:document>

data/spec/fixtures/xml_fragments/output/sequence/sequence_with_section_formatting.xml

@@ -0,0 +1,46 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:pPr>
+      <w:pStyle w:val="fancy"/>
+      <w:sectPr>
+        <w:cols w:num="1" w:space="10"/>
+      </w:sectPr>
+    </w:pPr>
+    <w:r>
+      <w:t>Tumbiblia</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:pPr>
+      <w:pStyle w:val="fancy"/>
+      <w:sectPr>
+        <w:cols w:num="2" w:space="20"/>
+      </w:sectPr>
+    </w:pPr>
+    <w:r>
+      <w:t>Rofronco</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:pPr>
+      <w:pStyle w:val="fancy"/>
+      <w:sectPr>
+        <w:cols w:num="2" w:space="20"/>
+      </w:sectPr>
+    </w:pPr>
+    <w:r>
+      <w:t>Beanipops</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:pPr>
+      <w:pStyle w:val="dumb"/>
+      <w:sectPr>
+        <w:cols w:num="3" w:space="30"/>
+      </w:sectPr>
+    </w:pPr>
+    <w:r>
+      <w:t>Baab</w:t>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/output/sequence/series_with_commas.xml

@@ -0,0 +1,43 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Here's a list of buffoons: </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Snookers</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Fumpleton</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve">, </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Francis</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Oldgark</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve">, and </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Spanky</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> </w:t>
+    </w:r>
+    <w:r>
+      <w:t>McThanks</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve">. Phew. What a list.</w:t>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/output/sequence/series_with_commas_two_items.xml

@@ -0,0 +1,31 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Here's a list of buffoons: </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Snookers</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Fumpleton</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> and </w:t>
+    </w:r>
+    <w:r>
+      <w:t>Spanky</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve"> </w:t>
+    </w:r>
+    <w:r>
+      <w:t>McThanks</w:t>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve">. Phew. What a list.</w:t>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/lib/sheng/check_box_spec.rb

@@ -0,0 +1,87 @@
+describe Sheng::CheckBox do
+  let(:fragment) { xml_fragment('input/check_box/check_box') }
+  let(:element) { fragment.at_xpath(".//w:checkBox/..") }
+  subject { described_class.new(element) }
+
+  describe ".from_element" do
+    it "returns a new instance with the given element" do
+      expect(described_class.from_element(element)).to eq(subject)
+    end
+  end
+
+  describe '#key' do
+    it 'returns w:val attribute of w:name node in xml fragment' do
+      expect(subject.key).to eq 'goats'
+    end
+  end
+
+  describe '#raw_key' do
+    it 'returns key' do
+      expect(subject.raw_key).to eq subject.key
+    end
+  end
+
+  describe '#value_is_truthy?' do
+    context 'given truthy values' do
+      ['true', 'TRuE', true, 1, '1', 'yes'].each do |truthy|
+        given_key = truthy.is_a?(String) ? "'#{truthy}' (as string)" : truthy
+        it "returns true if key is #{given_key} in dataset" do
+          expect(subject.value_is_truthy?(truthy)).to be_truthy
+        end
+      end
+    end
+
+    context 'given falsy values' do
+      ['false', 'FaLSE', false, 0, '0', 'no', '', nil].each do |falsy|
+        given_key = falsy.is_a?(String) ? "'#{falsy}' (as string)" : falsy
+        given_key = 'nil' if falsy.nil?
+        it "returns false if key is #{given_key} in dataset" do
+          expect(subject.value_is_truthy?(falsy)).to be_falsy
+        end
+      end
+    end
+  end
+
+  describe '#interpolate' do
+    let(:dataset) { Sheng::DataSet.new('goats' => 'foofle') }
+
+    it "checks the checkbox if key is truthy in dataset" do
+      allow(subject).to receive(:value_is_truthy?).with('foofle').and_return(true)
+      subject.interpolate(dataset)
+      expect(subject.xml_document).to be_equivalent_to xml_fragment('output/check_box/check_box')
+    end
+
+    it "does not check the checkbox if key is falsy in dataset" do
+      allow(subject).to receive(:value_is_truthy?).with('foofle').and_return(false)
+      subject.interpolate(dataset)
+      expect(subject.xml_document).to be_equivalent_to fragment_with_unchecked_box(subject.xml_document)
+    end
+
+    it "does not uncheck a default checked checkbox if key is truthy in dataset" do
+      default_checked = described_class.new(fragment_with_checked_box(subject.xml_document))
+      allow(default_checked).to receive(:value_is_truthy?).with('foofle').and_return(true)
+      default_checked.interpolate(dataset)
+      expect(default_checked.xml_document).to be_equivalent_to xml_fragment('output/check_box/check_box')
+    end
+
+    it "unchecks a default checked checkbox if key is falsy in dataset" do
+      default_checked = described_class.new(fragment_with_checked_box(subject.xml_document))
+      allow(default_checked).to receive(:value_is_truthy?).with('foofle').and_return(false)
+      default_checked.interpolate(dataset)
+      expect(default_checked.xml_document).to be_equivalent_to fragment_with_unchecked_box(default_checked.xml_document)
+    end
+
+    it "does not check the checkbox if key is not found in dataset" do
+      dataset = Sheng::DataSet.new({})
+      subject.interpolate(dataset)
+      expect(subject.xml_document).to be_equivalent_to fragment_with_unchecked_box(subject.xml_document)
+    end
+
+    it "does not uncheck a checked checkbox if key is not found in dataset" do
+      dataset = Sheng::DataSet.new({})
+      default_checked = described_class.new(fragment_with_checked_box(subject.xml_document))
+      default_checked.interpolate(dataset)
+      expect(default_checked.xml_document).to be_equivalent_to xml_fragment('output/check_box/check_box')
+    end
+  end
+end

data/spec/lib/sheng/conditional_block_spec.rb

@@ -0,0 +1,151 @@
+describe Sheng::ConditionalBlock do
+  let(:fragment) { xml_fragment('input/conditional_block/conditional_block_if') }
+  let(:element) { fragment.xpath("//w:fldChar[contains(@w:fldCharType, 'begin')]").first }
+  let(:merge_field) { Sheng::MergeField.new(element) }
+  subject { described_class.new(merge_field) }
+
+  describe "#raw_key" do
+    it "returns key from start_field" do
+      expect(subject.raw_key).to eq(merge_field.raw_key)
+    end
+  end
+
+  describe '#interpolate' do
+    let(:fragment) { xml_fragment('input/conditional_block/conditional_block_inline') }
+
+    context "inline" do
+      it 'includes if sections when variable truthy' do
+        dataset = Sheng::DataSet.new({
+          :alicorns => 'so tasties'
+        })
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/inline_exists')
+      end
+
+      it 'removes entire section if variable falsy' do
+        dataset = Sheng::DataSet.new({})
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/inline_does_not_exist')
+      end
+    end
+
+    context "with if block" do
+      let(:fragment) { xml_fragment('input/conditional_block/conditional_block_if') }
+
+      it 'includes sections when variable truthy' do
+        dataset = Sheng::DataSet.new({
+          :alicorns => 'so tasties'
+        })
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/if_exists')
+      end
+
+      it 'removes entire section if variable falsy' do
+        dataset = Sheng::DataSet.new({})
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/if_does_not_exist')
+      end
+    end
+
+    context "with unless block" do
+      let(:fragment) { xml_fragment('input/conditional_block/conditional_block_unless') }
+
+      it 'includes sections when variable falsy' do
+        dataset = Sheng::DataSet.new({})
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/unless_does_not_exist')
+      end
+
+      it 'removes entire section if variable truthy' do
+        dataset = Sheng::DataSet.new({
+          :alicorns => 'so tasties'
+        })
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/unless_exists')
+      end
+    end
+
+    context "within a table" do
+      let(:fragment) { xml_fragment('input/conditional_block/conditional_in_table') }
+      let(:dataset_hash) {
+        {
+          :include_dogs => true,
+          :dog_favorites => [
+            { :name => "Fluffy the Android", :megaphone => "YellTheBest" },
+            { :name => "Derek Dog", :megaphone => "Super Primo Loudkins" }
+          ]
+        }
+      }
+
+      it "includes if rows when variable truthy" do
+        dataset = Sheng::DataSet.new(dataset_hash)
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/conditional_in_table_exists')
+      end
+
+      it "removes entire section when variable falsy" do
+        dataset = Sheng::DataSet.new(dataset_hash.merge(:include_dogs => false))
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/conditional_in_table_does_not_exist')
+      end
+    end
+
+    context "with an embedded conditional" do
+      let(:fragment) { xml_fragment('input/conditional_block/embedded_conditional') }
+      let(:dataset_hash) {
+        { :alicorns => true, :scubas => true }
+      }
+
+      it "includes both sections when both are truthy" do
+        dataset = Sheng::DataSet.new(dataset_hash)
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/embedded_conditional_both')
+      end
+
+      it "includes only outside section if inside falsy" do
+        dataset = Sheng::DataSet.new(dataset_hash.merge(:scubas => false))
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/embedded_conditional_outside')
+      end
+
+      it "ignores truthy inside section if outside section is falsy" do
+        dataset = Sheng::DataSet.new(dataset_hash.merge(:alicorns => false))
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/conditional_block/embedded_conditional_inside')
+      end
+    end
+  end
+
+  describe '#new' do
+    context "with unclosed conditional" do
+      let(:fragment) { xml_fragment('input/conditional_block/bad/unclosed_conditional') }
+      it 'raises an exception indicating the missing end tag' do
+        dataset = Sheng::DataSet.new({})
+        expect {
+          subject
+        }.to raise_error(described_class::MissingEndTag, "no end tag for if:alicorns")
+      end
+    end
+
+    context "with badly nested conditional" do
+      let(:fragment) { xml_fragment('input/conditional_block/bad/badly_nested_conditional') }
+      it 'raises an exception indicating the nesting issue' do
+        dataset = Sheng::DataSet.new({})
+        expect {
+          subject
+        }.to raise_error(described_class::ImproperNesting, "expected end tag for unless:pumpkins, got end_if:alicorns")
+      end
+    end
+  end
+end

data/spec/lib/sheng/data_set_spec.rb

@@ -0,0 +1,65 @@
+describe Sheng::DataSet do
+  describe '#new' do
+    it 'raises an argument error if not given a Hash' do
+      not_a_hash = double('Not a Hash')
+      allow(not_a_hash).to receive(:is_a?).with(Hash).and_return(false)
+      expect {
+        described_class.new(not_a_hash)
+      }.to raise_error(ArgumentError, "must be initialized with a Hash")
+    end
+
+    it 'deep symbolizes the given hash and assigns it to #raw_hash' do
+      a_hash = double(Hash, :deep_symbolize_keys => :an_awesome_symbolized_hash)
+      allow(a_hash).to receive(:is_a?).with(Hash).and_return(true)
+      subject = described_class.new(a_hash)
+      expect(subject.raw_hash).to eq :an_awesome_symbolized_hash
+    end
+  end
+
+  describe '#fetch' do
+    let(:raw_hash) {
+      {
+        :rabbits => {
+          :streamlined => [:super_rabbit, :dr_slinky],
+          :slow => :mr_molasses
+        }
+      }
+    }
+    subject { described_class.new(raw_hash) }
+
+    it 'returns a non-hash object found at key' do
+      expect(subject.fetch('rabbits.slow')).to eq :mr_molasses
+      expect(subject.fetch('rabbits.streamlined')).to eq [:super_rabbit, :dr_slinky]
+    end
+
+    it 'raises an error if not given a string' do
+      not_a_string = double('Not a String')
+      allow(not_a_string).to receive(:is_a?).with(String).and_return(false)
+      expect {
+        subject.fetch(not_a_string)
+      }.to raise_error(ArgumentError, "must provide a string")
+    end
+
+    it 'raises a KeyNotFound error if key not found' do
+      expect {
+        subject.fetch('rabbits.funky')
+      }.to raise_error(described_class::KeyNotFound, "did not find in dataset: rabbits.funky (funky not found)")
+    end
+
+    it 'does not raise error on key not found if default given' do
+      expect(subject.fetch('rabbits.funky', :default => "horse")).to eq("horse")
+    end
+
+    it 'raises an error if Hash found at key' do
+      expect {
+        subject.fetch('rabbits')
+      }.to raise_error(described_class::KeyNotFound, "result at rabbits is a Hash")
+    end
+
+    it 'raises an error if key is too long' do
+      expect {
+        subject.fetch('rabbits.slow.but_steady')
+      }.to raise_error(described_class::KeyNotFound, "in rabbits.slow.but_steady, slow did not return a Hash")
+    end
+  end
+end