sheng 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f74c4e33aa2c6d02047cba5d9939aae549a4d6
-  data.tar.gz: 9e5f6b49e52c00e894d799fb9e000d7fb070efad
+  metadata.gz: ea5e2737e44d4a27d5d268bdfcefe21e1a3ff51b
+  data.tar.gz: 3245c5ef173eb186beaf1fb78acd487bfd42e04e
 SHA512:
-  metadata.gz: 98a4c1d780fb682610f7745dee718bad9b9d2ada521e8ac92f62b86e36ade25cc87f125a47fc2e701228d997b06d6d468eceda32e77d08a6554ddb9026f7875c
-  data.tar.gz: 4540354d8578d52ca6d26a9f4b186ec1eeaa051c74857ec13b189bb642673cf554d88c8f95b88f2c08efd55d8df73783c718e732ab700934b72d5ea07c2a1b33
+  metadata.gz: bd6309f22f7c16ddb93dc94d79fe8dbe4cb34c7ec4eb835883fe8afb1127271f8380c70dc79c262ff8da3f7c8d3bb442bd3e6f9b22fcbc3496b17ae4366f532c
+  data.tar.gz: 513affc5751aa7de19dc060c13e99974605d9e30afc57ae1711b8666fcd23294493d1c7790e8df6968fba145bd574d520d11a437e9e185ec3c3d1bcce15bc780

data/.ruby-version

@@ -1 +1 @@
-2.1.1
+2.1.

data/docs/creating_templates.md

@@ -223,6 +223,20 @@ Filters can also be chained, and will be applied in which they appear (from left
 
 «a_basic_integer|downcase»
 
+## Basic Arithmetic Operations
+
+You can perform basic arithmetic operations within a mergefield, using either hardcoded numeric values or variable names.  The operators allowed are + (addition), - (subtraction), * (multiplication), and / (division).  The usual order of precedence applies with these operators, and you can use parenthesis to control that precedence.
+
+### Examples:
+
+«25 * 6»
+
+«8.3 + 5.232»
+
+«(2.1 + 5) * 18»
+
+«(hair.length * 2) + head.height»
+
 # Checkboxes
 
 To create a checkbox:

data/lib/sheng/merge_field.rb

@@ -1,8 +1,14 @@
+require "dentaku"
+
 module Sheng
   class MergeField
-    AllowedFilters = [:upcase, :downcase, :capitalize, :titleize, :reverse]
-    InstructionTextRegex = /^\s*MERGEFIELD(.*)\\\* MERGEFORMAT\s*$/
-    KeyRegex = /^(start:|end:|if:|end_if:|unless:|end_unless:)?\s*([^\|\s]+)\s*\|?(.*)?/
+    MATH_TOKENS = %w[+ - / * ( )]
+    REGEXES = {
+      instruction_text: /^\s*MERGEFIELD(.*)\\\* MERGEFORMAT\s*$/,
+      key_string: /^(?<prefix>start:|end:|if:|end_if:|unless:|end_unless:)?\s*(?<key>[^\|]+)\s*\|?(?<filters>.*)?/,
+      numeric_string: /^[-+]?[0-9]*\.?[0-9]+$/
+    }
+    ALLOWED_FILTERS = [:upcase, :downcase, :capitalize, :titleize, :reverse]
 
     class NotAMergeFieldError < StandardError; end
 
@@ -31,16 +37,16 @@ module Sheng
     end
 
     def key
-      raw_key.gsub(KeyRegex, '\2')
+      raw_key.match(REGEXES[:key_string])[:key].strip
     end
 
     def filters
-      match = raw_key.match(KeyRegex)
-      match.captures[2].split("|").map(&:strip)
+      match = raw_key.match(REGEXES[:key_string])
+      match[:filters].split("|").map(&:strip)
     end
 
     def raw_key
-      @raw_key ||= mergefield_instruction_text.gsub(InstructionTextRegex, '\1').strip
+      @raw_key ||= mergefield_instruction_text.gsub(REGEXES[:instruction_text], '\1').strip
     end
 
     def mergefield_instruction_text
@@ -84,7 +90,7 @@ module Sheng
 
     def block_prefix
       @potential_prefix ||= begin
-        potential_prefix = raw_key.match(KeyRegex).captures[0]
+        potential_prefix = raw_key.match(REGEXES[:key_string])[:prefix]
         potential_prefix && potential_prefix.gsub(/\:$/, '')
       end
     end
@@ -185,10 +191,55 @@ module Sheng
       xml.remove
     end
 
+    def key_parts
+      @key_parts ||= key.gsub(".", "_DOTSEPARATOR_").
+        split(/\b|\s/).
+        map(&:strip).
+        reject(&:empty?).
+        map { |token|
+          token.gsub("_DOTSEPARATOR_", ".")
+        }
+    end
+
+    def required_variables
+      key_parts.reject { |token|
+        REGEXES[:numeric_string].match(token) || MATH_TOKENS.include?(token)
+      }
+    end
+
+    def required_hash(placeholder: nil)
+      required_variables.inject({}) { |assembled, variable|
+        parts = variable.split(/\./)
+        last_key = parts.pop
+        hash = parts.reverse.inject(last_key => placeholder) do |memo, key|
+          memo = { key => memo }; memo
+        end
+        Sheng::Support.merge_required_hashes(assembled, hash)
+      }
+    end
+
+    def key_has_math?
+      !(MATH_TOKENS & key_parts).empty?
+    end
+
+    def get_value(data_set)
+      interpolated_string = key_parts.map { |token|
+        if REGEXES[:numeric_string].match(token) || MATH_TOKENS.include?(token)
+          token
+        else
+          data_set.fetch(token)
+        end
+      }.join(" ")
+
+      return interpolated_string unless key_has_math?
+
+      Dentaku::Calculator.new.evaluate!(interpolated_string)
+    end
+
     def interpolate(data_set)
-      value = data_set.fetch(key)
+      value = get_value(data_set)
       replace_mergefield(filter_value(value))
-    rescue DataSet::KeyNotFound
+    rescue DataSet::KeyNotFound, Dentaku::UnboundVariableError
       # Ignore this error; we'll collect all uninterpolated fields later and
       # raise a new exception, so we can list all the fields in an error
       # message.
@@ -197,7 +248,7 @@ module Sheng
 
     def filter_value(value)
       filters.inject(value) { |val, filter|
-        if AllowedFilters.include?(filter.to_sym) && val.respond_to?(filter.to_sym)
+        if ALLOWED_FILTERS.include?(filter.to_sym) && val.respond_to?(filter.to_sym)
           val.send(filter)
         else
           val

data/lib/sheng/merge_field_set.rb

@@ -36,6 +36,8 @@ module Sheng
       nodes.inject({}) do |node_list, node|
         hsh = if node.is_a?(ConditionalBlock)
           node.required_hash(placeholder)
+        elsif node.is_a?(MergeField)
+          node.required_hash(placeholder: placeholder)
         else
           value = node.is_a?(Block) ? [node.required_hash(placeholder)].compact : placeholder
           key_parts = node.key.split(/\./)

data/lib/sheng/support.rb

@@ -47,7 +47,7 @@ module Sheng
             label << label_part.text
           end
         end
-        unless label.match(MergeField::InstructionTextRegex)
+        unless label.match(MergeField::REGEXES[:instruction_text])
           raise MergeField::NotAMergeFieldError.new(label)
         end
         label

data/lib/sheng/version.rb

@@ -1,3 +1,3 @@
 module Sheng
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/sheng.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "nokogiri", "~> 1.6"
   spec.add_dependency "rubyzip", "~> 1.1.1"
   spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "dentaku", "~> 2.0"
 end

data/spec/fixtures/trees/merge_field_set.yml

@@ -10,6 +10,10 @@
     :key: color
   - :type: merge_field
     :key: size
+  - :type: merge_field
+    :key: dimensions.width * dimensions.height
+  - :type: merge_field
+    :key: (dimensions.width * 2) + (dimensions.height * 2)
 - :type: check_box
   :key: veggies.green.spinach
 - :type: merge_field

data/spec/fixtures/xml_fragments/input/merge_field/math_merge_field.xml

@@ -0,0 +1,14 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:fldSimple w:instr=" MERGEFIELD  baskets.count * (3 + origami) \* MERGEFORMAT ">
+      <w:r>
+        <w:rPr>
+          <w:b/>
+          <w:i/>
+          <w:noProof/>
+        </w:rPr>
+        <w:t>«baskets.count * (3 + origami)»</w:t>
+      </w:r>
+    </w:fldSimple>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/input/merge_field_set/merge_field_set.xml

@@ -54,6 +54,32 @@
       </w:r>
     </w:fldSimple>
   </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Area: </w:t>
+    </w:r>
+    <w:fldSimple w:instr=" MERGEFIELD dimensions.width * dimensions.height \* MERGEFORMAT ">
+      <w:r>
+        <w:rPr>
+          <w:noProof/>
+        </w:rPr>
+        <w:t>«dimensions.width * dimensions.height»</w:t>
+      </w:r>
+    </w:fldSimple>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Circumference: </w:t>
+    </w:r>
+    <w:fldSimple w:instr=" MERGEFIELD (dimensions.width * 2) + (dimensions.height * 2) \* MERGEFORMAT ">
+      <w:r>
+        <w:rPr>
+          <w:noProof/>
+        </w:rPr>
+        <w:t>«(dimensions.width * 2) + (dimensions.height * 2)»</w:t>
+      </w:r>
+    </w:fldSimple>
+  </w:p>
   <w:p>
     <w:fldSimple w:instr=" MERGEFIELD end:person.socks \* MERGEFORMAT ">
       <w:r w:rsidR="00455C8A">

data/spec/fixtures/xml_fragments/output/merge_field/math_merge_field.xml

@@ -0,0 +1,12 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>22</w:t>
+    </w:r>
+  </w:p>
+</w:document>

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

@@ -36,6 +36,28 @@
       <w:t>Stumungous</w:t>
     </w:r>
   </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Area: </w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>70</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Circumference: </w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>38</w:t>
+    </w:r>
+  </w:p>
   <w:p>
     <w:r>
       <w:rPr>
@@ -52,6 +74,28 @@
       <w:t>Teensy</w:t>
     </w:r>
   </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Area: </w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>364</w:t>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Sock Circumference: </w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>82</w:t>
+    </w:r>
+  </w:p>
   <w:ffData>
     <w:name w:val="veggies.green.spinach"/>
     <w:enabled/>

data/spec/lib/sheng/merge_field_set_spec.rb

@@ -28,8 +28,8 @@ describe Sheng::MergeFieldSet do
           :first_name => 'Brad',
           :last_name => 'Tucklemoof',
           :socks => [
-            { :color => 'Green', :size => 'Stumungous' },
-            { :color => 'Whitish', :size => 'Teensy' }
+            { :color => 'Green', :size => 'Stumungous', :dimensions => { :width => 14, :height => 5 } },
+            { :color => 'Whitish', :size => 'Teensy', :dimensions => { :width => 28, :height => 13 } }
           ]
         },
         :veggies => { :green => { :spinach => true } }
@@ -117,15 +117,49 @@ describe Sheng::MergeFieldSet do
   describe '#required_hash' do
     it 'returns skeleton hash demonstrating required data for interpolation' do
       expect(subject.required_hash).to eq({
-        "person" => { "first_name" => nil, "last_name" => nil, "socks" => [{"color"=>nil, "size"=>nil}] },
-        "veggies"=> { "green" => { "spinach" => nil } }
+        "person" => {
+          "first_name" => nil,
+          "last_name" => nil,
+          "socks" => [
+            {
+              "color" => nil,
+              "size" => nil,
+              "dimensions" => {
+                "width" => nil,
+                "height" => nil
+              }
+            }
+          ]
+        },
+        "veggies"=> {
+          "green" => {
+            "spinach" => nil
+          }
+        }
       })
     end
 
     it 'uses given value as placeholder for mergefields/checkboxes' do
       expect(subject.required_hash(:foo)).to eq({
-        "person" => { "first_name" => :foo, "last_name" => :foo, "socks" => [{"color"=>:foo, "size"=>:foo}] },
-        "veggies"=> { "green" => { "spinach" => :foo } }
+        "person" => {
+          "first_name" => :foo,
+          "last_name" => :foo,
+          "socks" => [
+            {
+              "color" => :foo,
+              "size" => :foo,
+              "dimensions" => {
+                "width" => :foo,
+                "height" => :foo
+              }
+            }
+          ]
+        },
+        "veggies"=> {
+          "green" => {
+            "spinach" => :foo
+          }
+        }
       })
     end
 

data/spec/lib/sheng/merge_field_spec.rb

@@ -27,6 +27,25 @@ describe Sheng::MergeField do
     end
   end
 
+  describe "mergefield with math operations" do
+    let(:fragment) { xml_fragment('input/merge_field/math_merge_field') }
+    let(:element) { fragment.xpath("//w:fldSimple[contains(@w:instr, 'MERGEFIELD')]").first }
+
+    describe '#interpolate' do
+      it 'interpolates values from dataset into mergefield' do
+        dataset = Sheng::DataSet.new({
+          :baskets => {
+            :count => 2
+          },
+          :origami => 8
+        })
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/merge_field/math_merge_field')
+      end
+    end
+  end
+
   describe "new style merge field" do
     let(:fragment) { xml_fragment('input/merge_field/new_merge_field') }
     let(:element) { fragment.xpath("//w:fldChar[contains(@w:fldCharType, 'begin')]").first }
@@ -124,16 +143,70 @@ describe Sheng::MergeField do
     end
   end
 
-  describe '#interpolate' do
-    it 'interpolates filtered values from dataset into mergefield' do
-      dataset = Sheng::DataSet.new({
-        :ocean => { :fishy => "scrumblefish" }
+  describe "#get_value" do
+    let(:dataset) {
+      Sheng::DataSet.new({
+        :ocean => { :fishy => "scrumblefish" },
+        :numbers => { :first => 23, :second => 8 }
       })
+    }
+
+    it "returns value from dataset when given simple lookup" do
+      allow(subject).to receive(:key).and_return("ocean.fishy")
+      expect(subject.get_value(dataset)).to eq("scrumblefish")
+    end
+
+    it "performs math operations on values from dataset" do
+      allow(subject).to receive(:key).and_return("(numbers.first * numbers.second) + 5")
+      expect(subject.get_value(dataset)).to eq(189)
+    end
+
+    it "performs math operations with no dataset lookup" do
+      allow(subject).to receive(:key).and_return("2 + (3*5)")
+      expect(subject.get_value(dataset)).to eq(17)
+    end
+
+    it "raises exception if key not found in simple lookup" do
+      allow(subject).to receive(:key).and_return("oliver.twist")
+      expect {
+        subject.get_value(dataset)
+      }.to raise_error(Sheng::DataSet::KeyNotFound)
+    end
+
+    it "raises exception if key not found in math formula" do
+      allow(subject).to receive(:key).and_return("oliver.twist * 15")
+      expect {
+        subject.get_value(dataset)
+      }.to raise_error(Sheng::DataSet::KeyNotFound)
+    end
+
+    it "raises exception if interpolated math formula includes invalid symbols" do
+      allow(subject).to receive(:key).and_return("ocean.fishy * 15")
+      expect {
+        subject.get_value(dataset)
+      }.to raise_error(Dentaku::UnboundVariableError)
+    end
+  end
 
+  describe '#interpolate' do
+    it 'interpolates filtered values from dataset into mergefield' do
+      allow(subject).to receive(:get_value).with(:a_dataset).and_return("scrumblefish")
       allow(subject).to receive(:filter_value).with("scrumblefish").and_return("l33tphish")
-      subject.interpolate(dataset)
+      subject.interpolate(:a_dataset)
       expect(subject.xml_document).to be_equivalent_to xml_fragment('output/merge_field/merge_field')
     end
+
+    it "does not replace and returns nil if any keys not found" do
+      allow(subject).to receive(:get_value).with(:a_dataset).and_raise(Sheng::DataSet::KeyNotFound)
+      expect(subject).to receive(:replace_mergefield).never
+      expect(subject.interpolate(:a_dataset)).to be_nil
+    end
+
+    it "does not replace and returns nil if calculation error encountered" do
+      allow(subject).to receive(:get_value).with(:a_dataset).and_raise(Dentaku::UnboundVariableError.new([]))
+      expect(subject).to receive(:replace_mergefield).never
+      expect(subject.interpolate(:a_dataset)).to be_nil
+    end
   end
 
   describe "#xml" do
@@ -148,6 +221,20 @@ describe Sheng::MergeField do
     end
   end
 
+  describe "#required_variables" do
+    it "returns key parts that are not operators or numeric" do
+      allow(subject).to receive(:key).and_return("cat.toes   * 15 + (yawns / 2.0)")
+      expect(subject.required_variables).to eq(["cat.toes", "yawns"])
+    end
+  end
+
+  describe "#key_parts" do
+    it "returns key split on all word boundaries except dot separators" do
+      allow(subject).to receive(:key).and_return("cat.toes   * 15 + (yawns / 2.0)")
+      expect(subject.key_parts).to eq(["cat.toes", "*", "15", "+", "(", "yawns", "/", "2.0", ")"])
+    end
+  end
+
   describe '#key' do
     it 'returns the raw key with start/end metadata stripped off' do
       allow(subject).to receive(:raw_key).and_return('start:whipple.dooter')
@@ -160,6 +247,11 @@ describe Sheng::MergeField do
       allow(subject).to receive(:raw_key).and_return("whumpies | cook | dress(frock)")
       expect(subject.key).to eq 'whumpies'
     end
+
+    it 'returns key even if it contains math operations' do
+      allow(subject).to receive(:raw_key).and_return("whumpies * 3 | cook | dress(frock)")
+      expect(subject.key).to eq 'whumpies * 3'
+    end
   end
 
   describe "#filters" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sheng
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Ravi Gadad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: A Ruby gem for data merging Word documents.
 email:
 - ravi@renewfund.com
@@ -194,6 +208,7 @@ files:
 - spec/fixtures/xml_fragments/input/merge_field/bad/not_a_real_mergefield_old.xml
 - spec/fixtures/xml_fragments/input/merge_field/bad/unclosed_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/inline_merge_field.xml
+- spec/fixtures/xml_fragments/input/merge_field/math_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/new_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/split_merge_field.xml
@@ -224,6 +239,7 @@ files:
 - spec/fixtures/xml_fragments/output/conditional_block/unless_does_not_exist.xml
 - spec/fixtures/xml_fragments/output/conditional_block/unless_exists.xml
 - spec/fixtures/xml_fragments/output/merge_field/inline_merge_field.xml
+- spec/fixtures/xml_fragments/output/merge_field/math_merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field/merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field/split_merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field_set/complex_nesting_and_reuse.xml
@@ -270,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for data merging Word documents, using native MergeFields as placeholders
@@ -301,6 +317,7 @@ test_files:
 - spec/fixtures/xml_fragments/input/merge_field/bad/not_a_real_mergefield_old.xml
 - spec/fixtures/xml_fragments/input/merge_field/bad/unclosed_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/inline_merge_field.xml
+- spec/fixtures/xml_fragments/input/merge_field/math_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/new_merge_field.xml
 - spec/fixtures/xml_fragments/input/merge_field/split_merge_field.xml
@@ -331,6 +348,7 @@ test_files:
 - spec/fixtures/xml_fragments/output/conditional_block/unless_does_not_exist.xml
 - spec/fixtures/xml_fragments/output/conditional_block/unless_exists.xml
 - spec/fixtures/xml_fragments/output/merge_field/inline_merge_field.xml
+- spec/fixtures/xml_fragments/output/merge_field/math_merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field/merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field/split_merge_field.xml
 - spec/fixtures/xml_fragments/output/merge_field_set/complex_nesting_and_reuse.xml