sheng 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea5e2737e44d4a27d5d268bdfcefe21e1a3ff51b
-  data.tar.gz: 3245c5ef173eb186beaf1fb78acd487bfd42e04e
+  metadata.gz: a8b81b58b522c27f9eae0f86940da9f8b92743d5
+  data.tar.gz: 5ba6ec64dd3891eb409550801fde1dbe95cdb4f5
 SHA512:
-  metadata.gz: bd6309f22f7c16ddb93dc94d79fe8dbe4cb34c7ec4eb835883fe8afb1127271f8380c70dc79c262ff8da3f7c8d3bb442bd3e6f9b22fcbc3496b17ae4366f532c
-  data.tar.gz: 513affc5751aa7de19dc060c13e99974605d9e30afc57ae1711b8666fcd23294493d1c7790e8df6968fba145bd574d520d11a437e9e185ec3c3d1bcce15bc780
+  metadata.gz: 9c40035114fcc183da71cb81b1e38e315163399fe7925ef1080f35e414d0f8dd800157e0b027ceb3aafdb5f7eb54b90c1d71d9a9e0374e133d969f008a41173e
+  data.tar.gz: 50dc168d3817c280d37e916d77893b8d66ebc81b4c201ce6e1fa90eb4676b9357bb7a2699c7cf20d75672d45fb0aa53c574d12b9e692a3a7161cd7a78a7f18f7

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.7

data/README.md

@@ -1,5 +1,7 @@
 # Sheng
 
+[![Build Status](https://travis-ci.org/renewablefunding/sheng.svg?branch=master)](https://travis-ci.org/renewablefunding/sheng)
+
 A Ruby gem for data merging Word documents.  Given a set of data (as a Hash), and a `.docx` template created in [a specific way](docs/creating_templates.md), you can generate a new Word document with the values from the data substituted in place.
 
 ## Installation

data/docs/creating_templates.md

@@ -18,6 +18,8 @@ Note that any instructions on how specifically to use certain commands in Word a
   * [Basic MergeField Substitution](#basic-mergefield-substitution)
     * [Inline Basic MergeFields](#inline-basic-mergefields)
     * [Filters on String Values](#filters-on-string-values)
+    * [Filters on Numeric Values](#filters-on-numeric-values)
+    * [Basic Arithmetic Operations](#basic-arithmetic-operations)
   * [Checkboxes](#checkboxes)
   * [Sequences](#sequences)
     * [Arrays of Primitives](#arrays-of-primitives)
@@ -223,10 +225,32 @@ Filters can also be chained, and will be applied in which they appear (from left
 
 «a_basic_integer|downcase»
 
+## Filters on Numeric Values
+
+There are also built-in filters available for modifying the output of numeric values (e.g. to round a number or display it as currency).  These filters, if used on non-numeric values, will have no effect.  Strings that can be read as numeric values (like "145.2") will work with these filters.  Unlike the string filters, these numeric filters can accept arguments, to clarify what the filter should do.  The filters are:
+
+| Name | Description | Example Input | Example Command | Example Output |
+| --- | --- | --- | --- | --- |
+| round(n) | Rounds number to n decimal places | 2360.7853 | round(2) | 2360.79 |
+| floor | Truncates decimal portion of number | 2360.7853 | floor | 2360 |
+| currency(x) | Formats number as currency (2 fixed decimals, thousands separator), prepending optional argument | 149020.5 | currency($) | $149,020.50 |
+
+Filters can also be chained, and will be applied in which they appear (from left to right).
+
+### Examples:
+
+«a_basic_float|round(1)»
+
+«a_basic_float|currency($)»
+
+«a_basic_float|floor»
+
 ## 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.
 
+Note, however, that adding formatted numbers (like "1,400.50" and "24,000.20") will result in an unformatted number ("25400.7"), so if you want currency formatting or rounding, you'll want to use the numeric formatting methods shown above.  You can combine arithmetic with filters to accomplish this, as seen in the last example below.
+
 ### Examples:
 
 «25 * 6»
@@ -237,6 +261,8 @@ You can perform basic arithmetic operations within a mergefield, using either ha
 
 «(hair.length * 2) + head.height»
 
+«principal + interest | currency($)»
+
 # Checkboxes
 
 To create a checkbox:

data/lib/sheng/filters/base.rb

@@ -0,0 +1,23 @@
+module Sheng
+  module Filters
+    class Base
+      attr_reader :value, :method, :arguments
+
+      def initialize(method: method, arguments: [])
+        @method = method
+        @arguments = arguments
+      end
+
+      def self.implements(*names)
+        names.each do |name|
+          Sheng::Filters.registry.merge!({ name.to_sym => self })
+        end
+      end
+
+      def filter(value)
+        return value unless value.respond_to?(method)
+        value.send(method, *arguments)
+      end
+    end
+  end
+end

data/lib/sheng/filters/currency_formatting_filter.rb

@@ -0,0 +1,16 @@
+require_relative "base"
+
+module Sheng
+  module Filters
+    class CurrencyFormattingFilter < Base
+      implements :currency
+
+      def filter(value)
+        return value unless Sheng::Support.is_numeric?(value)
+        integer, fractional = ("%00.2f" % value).split(".")
+        integer.reverse!.gsub!(/(\d{3})(?=\d)/, '\\1,').reverse!
+        "#{arguments.first}#{integer}.#{fractional}"
+      end
+    end
+  end
+end

data/lib/sheng/filters/numeric_filter.rb

@@ -0,0 +1,14 @@
+require_relative "base"
+
+module Sheng
+  module Filters
+    class NumericFilter < Base
+      implements :round, :floor
+
+      def filter(value)
+        value = Sheng::Support.typecast_numeric(value)
+        super
+      end
+    end
+  end
+end

data/lib/sheng/filters/string_filter.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Sheng
+  module Filters
+    class StringFilter < Base
+      implements :upcase, :downcase, :capitalize, :titleize, :reverse
+    end
+  end
+end

data/lib/sheng/filters.rb

@@ -0,0 +1,23 @@
+module Sheng
+  module Filters
+    class UnsupportedFilterError < StandardError; end
+
+    class << self
+      def registry
+        @registry ||= {}
+      end
+
+      def filter_for(filter_string)
+        filter_method, args_list = filter_string.split(/[\(\)]/)
+        args = (args_list || "").split(/\s*,\s*/).map { |arg| Sheng::Support.typecast_numeric(arg) }
+        filter_class = registry[filter_method.to_sym]
+        raise UnsupportedFilterError.new(filter_string) unless filter_class
+        filter_class.new(method: filter_method, arguments: args)
+      end
+    end
+  end
+end
+
+require_relative "filters/string_filter"
+require_relative "filters/numeric_filter"
+require_relative "filters/currency_formatting_filter"

data/lib/sheng/merge_field.rb

@@ -5,10 +5,8 @@ module Sheng
     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]+$/
+      key_string: /^(?<prefix>start:|end:|if:|end_if:|unless:|end_unless:)?\s*(?<key>[^\|]+)\s*\|?(?<filters>.*)?/
     }
-    ALLOWED_FILTERS = [:upcase, :downcase, :capitalize, :titleize, :reverse]
 
     class NotAMergeFieldError < StandardError; end
 
@@ -25,7 +23,7 @@ module Sheng
     def initialize(element)
       @element = element
       @xml_document = element.document
-      @instruction_text = mergefield_instruction_text
+      @instruction_text = Sheng::Support.extract_mergefield_instruction_text(element)
     end
 
     def ==(other)
@@ -46,11 +44,7 @@ module Sheng
     end
 
     def raw_key
-      @raw_key ||= mergefield_instruction_text.gsub(REGEXES[:instruction_text], '\1').strip
-    end
-
-    def mergefield_instruction_text
-      Sheng::Support.extract_mergefield_instruction_text(element)
+      @raw_key ||= @instruction_text.gsub(REGEXES[:instruction_text], '\1').strip
     end
 
     def styling_paragraph
@@ -184,15 +178,22 @@ module Sheng
     end
 
     def replace_mergefield(value)
+      value_as_string = if value.is_a?(BigDecimal)
+        value.to_s("F")
+      else
+        value.to_s
+      end
+
       new_run = Sheng::Support.new_text_run(
-        value, xml_document: xml_document, style_run: styling_run
+        value_as_string, xml_document: xml_document, style_run: styling_run
       )
       xml.before(new_run)
       xml.remove
     end
 
     def key_parts
-      @key_parts ||= key.gsub(".", "_DOTSEPARATOR_").
+      @key_parts ||= key.gsub(",", "").
+        gsub(".", "_DOTSEPARATOR_").
         split(/\b|\s/).
         map(&:strip).
         reject(&:empty?).
@@ -203,7 +204,7 @@ module Sheng
 
     def required_variables
       key_parts.reject { |token|
-        REGEXES[:numeric_string].match(token) || MATH_TOKENS.include?(token)
+        Support.is_numeric?(token) || MATH_TOKENS.include?(token)
       }
     end
 
@@ -224,7 +225,7 @@ module Sheng
 
     def get_value(data_set)
       interpolated_string = key_parts.map { |token|
-        if REGEXES[:numeric_string].match(token) || MATH_TOKENS.include?(token)
+        if Support.is_numeric?(token) || MATH_TOKENS.include?(token)
           token
         else
           data_set.fetch(token)
@@ -233,13 +234,13 @@ module Sheng
 
       return interpolated_string unless key_has_math?
 
-      Dentaku::Calculator.new.evaluate!(interpolated_string)
+      Dentaku::Calculator.new.evaluate!(interpolated_string.gsub(",", ""))
     end
 
     def interpolate(data_set)
       value = get_value(data_set)
       replace_mergefield(filter_value(value))
-    rescue DataSet::KeyNotFound, Dentaku::UnboundVariableError
+    rescue DataSet::KeyNotFound, Dentaku::UnboundVariableError, Filters::UnsupportedFilterError
       # 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.
@@ -247,12 +248,9 @@ module Sheng
     end
 
     def filter_value(value)
-      filters.inject(value) { |val, filter|
-        if ALLOWED_FILTERS.include?(filter.to_sym) && val.respond_to?(filter.to_sym)
-          val.send(filter)
-        else
-          val
-        end
+      filters.inject(value) { |val, filter_string|
+        filterer = Filters.filter_for(filter_string)
+        filterer.filter(val)
       }
     end
   end

data/lib/sheng/support.rb

@@ -1,6 +1,8 @@
 module Sheng
   module Support
     class << self
+      NUMERIC_REGEX = /^(0|[1-9][0-9]*|[1-9][0-9]{0,2}(,[0-9]{3,3})*)(\.[0-9]+)?$/
+
       def merge_required_hashes(hsh1, hsh2)
         hsh1.merge(hsh2) do |key, old_value, new_value|
           if [old_value, new_value].all? { |v| v.is_a?(Hash) }
@@ -52,6 +54,20 @@ module Sheng
         end
         label
       end
+
+      def is_numeric?(value)
+        value.is_a?(Numeric) || !!NUMERIC_REGEX.match(value)
+      end
+
+      def typecast_numeric(value)
+        return value if value.is_a?(Numeric) || !NUMERIC_REGEX.match(value)
+        val = value.gsub(",", "").to_d
+        if val.frac == 0
+          val.to_i
+        else
+          val
+        end
+      end
     end
   end
 end

data/lib/sheng/version.rb

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

data/lib/sheng.rb

@@ -7,6 +7,7 @@ require 'sheng/data_set'
 require 'sheng/docx'
 require 'sheng/wml_file'
 require 'sheng/merge_field_set'
+require 'sheng/filters'
 require 'sheng/merge_field'
 require 'sheng/sequence'
 require 'sheng/conditional_block'

data/spec/fixtures/xml_fragments/input/merge_field/currency_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 robots * 6250 + 18.3 | currency(£) \* MERGEFORMAT ">
+      <w:r>
+        <w:rPr>
+          <w:b/>
+          <w:i/>
+          <w:noProof/>
+        </w:rPr>
+        <w:t>«robots * 6250 + 18.3 | currency(£)»</w:t>
+      </w:r>
+    </w:fldSimple>
+  </w:p>
+</w:document>

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

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

data/spec/fixtures/xml_fragments/output/merge_field/currency_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>£18,768.30</w:t>
+    </w:r>
+  </w:p>
+</w:document>

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

@@ -6,7 +6,7 @@
         <w:i/>
         <w:noProof/>
       </w:rPr>
-      <w:t>22</w:t>
+      <w:t>8036447.4</w:t>
     </w:r>
   </w:p>
 </w:document>

data/spec/lib/sheng/filters/currency_formatting_filter_spec.rb

@@ -0,0 +1,20 @@
+require "shared_examples/filters"
+
+describe Sheng::Filters::CurrencyFormattingFilter do
+  test_cases = [
+    { method: :currency, input: 3452341.826, output: "3,452,341.83" },
+    { method: :currency, input: "1645.3", output: "1,645.30" },
+    { method: :currency, arguments: ["¥"], input: "12351.184", output: "¥12,351.18" }
+  ]
+
+  it_behaves_like "a filter", test_cases
+
+  context "with non-numeric value" do
+    describe "#filter" do
+      it "returns unmodified value" do
+        subject = described_class.new(method: :currency)
+        expect(subject.filter("apples")).to eq("apples")
+      end
+    end
+  end
+end

data/spec/lib/sheng/filters/numeric_filter_spec.rb

@@ -0,0 +1,19 @@
+require "shared_examples/filters"
+
+describe Sheng::Filters::NumericFilter do
+  test_cases = [
+    { method: :round, arguments: [2], input: 149.3783, output: 149.38 },
+    { method: :floor, input: 149.3783, output: 149 }
+  ]
+
+  it_behaves_like "a filter", test_cases
+
+  context "with value that does not respond to method" do
+    describe "#filter" do
+      it "returns unmodified value" do
+        subject = described_class.new(method: :round)
+        expect(subject.filter("apples")).to eq("apples")
+      end
+    end
+  end
+end

data/spec/lib/sheng/filters/string_filter_spec.rb

@@ -0,0 +1,22 @@
+require "shared_examples/filters"
+
+describe Sheng::Filters::StringFilter do
+  test_cases = [
+    { method: :upcase, input: "some Good thing", output: "SOME GOOD THING" },
+    { method: :downcase, input: "Emerald CITY", output: "emerald city" },
+    { method: :reverse, input: "A Man a Plan", output: "nalP a naM A" },
+    { method: :capitalize, input: "good will hunting", output: "Good will hunting" },
+    { method: :titleize, input: "good will hunting", output: "Good Will Hunting" }
+  ]
+
+  it_behaves_like "a filter", test_cases
+
+  context "with value that does not respond to method" do
+    describe "#filter" do
+      it "returns unmodified value" do
+        subject = described_class.new(method: :upcase)
+        expect(subject.filter(12345)).to eq(12345)
+      end
+    end
+  end
+end

data/spec/lib/sheng/filters_spec.rb

@@ -0,0 +1,22 @@
+describe Sheng::Filters do
+  before(:each) do
+    allow(described_class).to receive(:registry).
+      and_return(bazinga: Sheng::Filters::Base)
+  end
+
+  describe ".filter_for" do
+    it "returns a filter instance that supports the given string" do
+      allow(Sheng::Filters::Base).to receive(:new).
+        with(method: "bazinga", arguments: [12, "hats"]).
+        and_return(:the_filter)
+      expect(described_class.filter_for("bazinga(12, hats)")).
+        to eq(:the_filter)
+    end
+
+    it "raises exception if filter class not found" do
+      expect {
+        described_class.filter_for("unregistered(12, hats)")
+      }.to raise_error(Sheng::Filters::UnsupportedFilterError)
+    end
+  end
+end

data/spec/lib/sheng/merge_field_spec.rb

@@ -27,6 +27,22 @@ describe Sheng::MergeField do
     end
   end
 
+  describe "mergefield with math and currency formatting" do
+    let(:fragment) { xml_fragment('input/merge_field/currency_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({
+          :robots => 3
+        })
+
+        subject.interpolate(dataset)
+        expect(subject.xml_document).to be_equivalent_to xml_fragment('output/merge_field/currency_merge_field')
+      end
+    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 }
@@ -35,9 +51,9 @@ describe Sheng::MergeField do
       it 'interpolates values from dataset into mergefield' do
         dataset = Sheng::DataSet.new({
           :baskets => {
-            :count => 2
+            :count => "2,300.40"
           },
-          :origami => 8
+          :origami => 8.5
         })
 
         subject.interpolate(dataset)
@@ -157,8 +173,8 @@ describe Sheng::MergeField do
     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)
+      allow(subject).to receive(:key).and_return("(numbers.first * numbers.second) + 5.3")
+      expect(subject.get_value(dataset)).to eq(189.3)
     end
 
     it "performs math operations with no dataset lookup" do
@@ -207,6 +223,13 @@ describe Sheng::MergeField do
       expect(subject).to receive(:replace_mergefield).never
       expect(subject.interpolate(:a_dataset)).to be_nil
     end
+
+    it "does not replace and returns nil if unsupported filter requested" do
+      allow(subject).to receive(:get_value).with(:a_dataset).and_return(:got_value)
+      allow(subject).to receive(:filter_value).with(:got_value).and_raise(Sheng::Filters::UnsupportedFilterError)
+      expect(subject).to receive(:replace_mergefield).never
+      expect(subject.interpolate(:a_dataset)).to be_nil
+    end
   end
 
   describe "#xml" do
@@ -314,44 +337,29 @@ describe Sheng::MergeField do
   end
 
   describe "#filter_value" do
-    it "can upcase" do
-      allow(subject).to receive(:filters).and_return(["upcase"])
-      expect(subject.filter_value("HorSes")).to eq("HORSES")
-    end
-
-    it "can downcase" do
-      allow(subject).to receive(:filters).and_return(["downcase"])
-      expect(subject.filter_value("HorSes")).to eq("horses")
-    end
-
-    it "can reverse" do
-      allow(subject).to receive(:filters).and_return(["reverse"])
-      expect(subject.filter_value("Maple")).to eq("elpaM")
-    end
-
-    it "can titleize" do
-      allow(subject).to receive(:filters).and_return(["titleize"])
-      expect(subject.filter_value("ribbons are grand")).to eq("Ribbons Are Grand")
-    end
-
-    it "can capitalize" do
-      allow(subject).to receive(:filters).and_return(["capitalize"])
-      expect(subject.filter_value("ribbons are grand")).to eq("Ribbons are grand")
+    it "looks up filter and returns filtered result" do
+      filter_double = instance_double(Sheng::Filters::Base)
+      allow(subject).to receive(:filters).and_return(["foo"])
+      allow(Sheng::Filters).to receive(:filter_for).with("foo").
+        and_return(filter_double)
+      allow(filter_double).to receive(:filter).with("HorSes").
+        and_return("ponies")
+      expect(subject.filter_value("HorSes")).to eq("ponies")
     end
 
     it "works with multiple filters" do
-      allow(subject).to receive(:filters).and_return(["reverse", "capitalize"])
-      expect(subject.filter_value("maple")).to eq("Elpam")
-    end
-
-    it "does nothing if filter not recognized" do
-      allow(subject).to receive(:filters).and_return(["elephantize"])
-      expect(subject.filter_value("ribbons are grand")).to eq("ribbons are grand")
-    end
-
-    it "does nothing if value doesn't respond to filter" do
-      allow(subject).to receive(:filters).and_return(["upcase"])
-      expect(subject.filter_value(130)).to eq(130)
+      filter1_double = instance_double(Sheng::Filters::Base)
+      filter2_double = instance_double(Sheng::Filters::Base)
+      allow(subject).to receive(:filters).and_return(["foo", "bar"])
+      allow(Sheng::Filters).to receive(:filter_for).with("foo").
+        and_return(filter1_double)
+      allow(Sheng::Filters).to receive(:filter_for).with("bar").
+        and_return(filter2_double)
+      allow(filter1_double).to receive(:filter).with("HorSes").
+        and_return("ponies")
+      allow(filter2_double).to receive(:filter).with("ponies").
+        and_return("Scuba Gear")
+      expect(subject.filter_value("HorSes")).to eq("Scuba Gear")
     end
   end
 

data/spec/lib/sheng/support_spec.rb

@@ -0,0 +1,53 @@
+describe Sheng::Support do
+  describe ".is_numeric?" do
+    it "returns true if given integer" do
+      expect(described_class.is_numeric?(123)).to be true
+    end
+
+    it "returns true if given float" do
+      expect(described_class.is_numeric?(123.4)).to be true
+    end
+
+    it "returns true if given BigDecimal" do
+      expect(described_class.is_numeric?(123.4.to_d)).to be true
+    end
+
+    it "returns true if given valid numeric string" do
+      expect(described_class.is_numeric?("123.4")).to be true
+    end
+
+    it "returns false if given invalid numeric string" do
+      expect(described_class.is_numeric?("0123.4")).to be false
+    end
+
+    it "returns true if given valid numeric string with appropriate commas" do
+      expect(described_class.is_numeric?("1,234.5")).to be true
+    end
+
+    it "returns false if given valid numeric string with appropriate commas" do
+      expect(described_class.is_numeric?("12,34.5")).to be false
+    end
+
+    it "returns false if given non-numeric string" do
+      expect(described_class.is_numeric?("foobar")).to be false
+    end
+  end
+
+  describe ".typecast_numeric" do
+    it "returns given numeric" do
+      expect(described_class.typecast_numeric(123.4)).to eq(123.4)
+    end
+
+    it "returns given non-numeric string" do
+      expect(described_class.typecast_numeric("foobar")).to eq("foobar")
+    end
+
+    it "returns numeric version of integer string" do
+      expect(described_class.typecast_numeric("123")).to eq(123)
+    end
+
+    it "returns numeric version of decimal string" do
+      expect(described_class.typecast_numeric("123.4")).to eq(123.4)
+    end
+  end
+end

data/spec/shared_examples/filters.rb

@@ -0,0 +1,18 @@
+RSpec.shared_examples_for "a filter" do |test_cases|
+  test_cases.map { |tc| tc[:method] }.uniq.each do |method|
+    it "registers self for #{method} method" do
+      expect(Sheng::Filters.registry[method]).to eq(described_class)
+    end
+  end
+
+  test_cases.each do |test_case|
+    context "with #{test_case[:method]} method" do
+      describe "#filter" do
+        it "returns filtered output" do
+          subject = described_class.new(method: test_case[:method], arguments: test_case[:arguments] || [])
+          expect(subject.filter(test_case[:input])).to eq(test_case[:output])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sheng
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ravi Gadad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - ".watchr"
 - Gemfile
 - LICENSE.txt
@@ -175,6 +176,11 @@ files:
 - lib/sheng/conditional_block.rb
 - lib/sheng/data_set.rb
 - lib/sheng/docx.rb
+- lib/sheng/filters.rb
+- lib/sheng/filters/base.rb
+- lib/sheng/filters/currency_formatting_filter.rb
+- lib/sheng/filters/numeric_filter.rb
+- lib/sheng/filters/string_filter.rb
 - lib/sheng/merge_field.rb
 - lib/sheng/merge_field_set.rb
 - lib/sheng/path_helpers.rb
@@ -207,6 +213,7 @@ files:
 - spec/fixtures/xml_fragments/input/merge_field/bad/not_a_real_mergefield_new.xml
 - 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/currency_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
@@ -238,6 +245,7 @@ files:
 - spec/fixtures/xml_fragments/output/conditional_block/inline_exists.xml
 - 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/currency_merge_field.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
@@ -259,10 +267,16 @@ files:
 - spec/lib/sheng/conditional_block_spec.rb
 - spec/lib/sheng/data_set_spec.rb
 - spec/lib/sheng/docx_spec.rb
+- spec/lib/sheng/filters/currency_formatting_filter_spec.rb
+- spec/lib/sheng/filters/numeric_filter_spec.rb
+- spec/lib/sheng/filters/string_filter_spec.rb
+- spec/lib/sheng/filters_spec.rb
 - spec/lib/sheng/merge_field_set_spec.rb
 - spec/lib/sheng/merge_field_spec.rb
 - spec/lib/sheng/sequence_spec.rb
+- spec/lib/sheng/support_spec.rb
 - spec/lib/sheng/wml_file_spec.rb
+- spec/shared_examples/filters.rb
 - spec/spec_helper.rb
 - spec/support/path_helper.rb
 - spec/support/xml_helper.rb
@@ -316,6 +330,7 @@ test_files:
 - spec/fixtures/xml_fragments/input/merge_field/bad/not_a_real_mergefield_new.xml
 - 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/currency_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
@@ -347,6 +362,7 @@ test_files:
 - spec/fixtures/xml_fragments/output/conditional_block/inline_exists.xml
 - 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/currency_merge_field.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
@@ -368,10 +384,16 @@ test_files:
 - spec/lib/sheng/conditional_block_spec.rb
 - spec/lib/sheng/data_set_spec.rb
 - spec/lib/sheng/docx_spec.rb
+- spec/lib/sheng/filters/currency_formatting_filter_spec.rb
+- spec/lib/sheng/filters/numeric_filter_spec.rb
+- spec/lib/sheng/filters/string_filter_spec.rb
+- spec/lib/sheng/filters_spec.rb
 - spec/lib/sheng/merge_field_set_spec.rb
 - spec/lib/sheng/merge_field_spec.rb
 - spec/lib/sheng/sequence_spec.rb
+- spec/lib/sheng/support_spec.rb
 - spec/lib/sheng/wml_file_spec.rb
+- spec/shared_examples/filters.rb
 - spec/spec_helper.rb
 - spec/support/path_helper.rb
 - spec/support/xml_helper.rb