hermod 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e882154a69ab0cd386b9df39efb15a103979d364
-  data.tar.gz: 10f3968ac6ba1eff02da89697699d7c688aa5ad5
+  metadata.gz: c6dae991640bdc325837ebadb8cb95977923ce59
+  data.tar.gz: dd973e128dd2e53e411f807fe0257394fb861362
 SHA512:
-  metadata.gz: 7fb42ae9eea2b519e5bf048a3d5d8ca52c7d6952a30938b05bb92e1ba128076bba712eecaca4ffe27d56b487fa7168ad5dcd97edcee5a272923ba5fa6bf978df
-  data.tar.gz: 604fd4890a7868c2f03a7183be4ccf2d93582b2be427d051f653cc3cae104b35232e2f106833b8dbf5846dcde14fb7dd3147947329e0ad924491010e4e503454
+  metadata.gz: a83c5e10ad93e618c4b128d3302b86af810e93cfd4368181dcc59006151bf490685d6fa26fb94950863b085bba98334c473ff14854a1e2942b3318d0dd0dc2ab
+  data.tar.gz: c7b4f98c51ef71385f2fd202c192745f7fc914dfdcd9254126bf08d675f9f48ab5eae9b97bb57ed959e3b88fb1b5f18b5edfdbcd5f76292d77497cc8c98f2558

data/Gemfile

@@ -3,8 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in xml-section.gemspec
 gemspec
 
-gem "pry-byebug", "~> 1.3.3"
-gem "pry-rescue", "~> 1.4.1"
-gem "pry-stack_explorer", "~> 0.4.9.1"
+gem "pry-byebug", "~> 1.3.3", platform: [:mri_20, :mri_21]
+gem "pry-debugger", "~> 0.2.3", platform: :mri_19
 gem "pry-doc", "~> 0.6.0"
 gem "bond", "~> 0.5.1"

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest, all_after_pass: true, include: ["lib"] do
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/hermod.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2"
+  spec.required_ruby_version = ">= 1.9.3"
 
   spec.add_runtime_dependency "libxml-ruby", "~> 2.7", ">= 2.7.0"
   spec.add_runtime_dependency "activesupport", "> 3.2", "< 5"
@@ -28,5 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_development_dependency "guard", "~> 2.6.1"
+  spec.add_development_dependency "guard-minitest", "~> 2.3.1"
   spec.add_development_dependency "nokogiri", "~> 1.5"
 end

data/lib/hermod/input_mutator.rb

@@ -0,0 +1,13 @@
+module Hermod
+  class InputMutator
+    attr_reader :mutator_proc
+
+    def initialize(mutator_proc)
+      @mutator_proc = mutator_proc
+    end
+
+    def mutate!(values, attributes)
+      mutator_proc.call(values, attributes)
+    end
+  end
+end

data/lib/hermod/validators/allowed_values.rb

@@ -0,0 +1,26 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks the given value is in a predefined list of allowed values
+    class AllowedValues < Base
+      attr_reader :allowed_values
+
+      # Sets up the validator with the list of allowed values
+      def initialize(allowed_values)
+        @allowed_values = allowed_values
+      end
+
+      private
+
+      def test
+        allowed_values.include? value
+      end
+
+      def message
+        list_of_values = allowed_values.to_sentence(last_word_connector: ", or ", two_words_connector: " or ")
+        "must be one of #{list_of_values}, not #{value}"
+      end
+    end
+  end
+end

data/lib/hermod/validators/attributes.rb

@@ -0,0 +1,29 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks the attributes are in a list of allowed attributes
+    class Attributes < Base
+      attr_reader :allowed_attributes, :bad_attributes
+
+      # Public: Sets up the list of allowed attributes
+      def initialize(allowed_attributes)
+        @allowed_attributes = allowed_attributes
+      end
+
+      private
+
+      def test
+        @bad_attributes = [] # reset this for each time the validator is used
+        attributes.each do |attribute, _|
+          bad_attributes << attribute unless allowed_attributes.include? attribute
+        end
+        bad_attributes == []
+      end
+
+      def message
+        "has attributes it doesn't accept: #{bad_attributes.to_sentence}"
+      end
+    end
+  end
+end

data/lib/hermod/validators/base.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/array/conversions'
+
+module Hermod
+  module Validators
+    class Base
+      attr_reader :value, :attributes
+
+      # Public: Runs the test for the validator returning true if it passes and
+      # raising if it fails
+      #
+      # Raises a Hermod::InvalidInputError if the test fails
+      # Returns true if it succeeds
+      def valid?(value, attributes)
+        @value, @attributes = value, attributes
+        !!test || raise(InvalidInputError, message)
+      end
+
+      private
+
+      # Private: override in subclasses to implement the logic for that
+      # validator
+      #
+      # Returns a boolean
+      def test
+        raise NotImplementedError
+      end
+
+      # Private: override in subclasses to provide a more useful error message
+      #
+      # Returns a string
+      def message
+        "is invalid"
+      end
+    end
+  end
+end

data/lib/hermod/validators/non_negative.rb

@@ -0,0 +1,19 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks a number is not negative
+    class NonNegative < Base
+
+      private
+
+      def test
+        value >= 0
+      end
+
+      def message
+        "cannot be negative"
+      end
+    end
+  end
+end

data/lib/hermod/validators/non_zero.rb

@@ -0,0 +1,19 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks the value is not zero
+    class NonZero < Base
+
+      private
+
+      def test
+        value.to_i != 0
+      end
+
+      def message
+        "cannot be zero"
+      end
+    end
+  end
+end

data/lib/hermod/validators/range.rb

@@ -0,0 +1,28 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks a value is in the given range
+    class Range < Base
+      attr_reader :range
+
+      def initialize(range_or_min, max = nil)
+        if max
+          @range = range_or_min..max
+        else
+          @range = range_or_min
+        end
+      end
+
+      private
+
+      def test
+        range.cover?(value)
+      end
+
+      def message
+        "must be between #{range.min} and #{range.max}"
+      end
+    end
+  end
+end

data/lib/hermod/validators/regular_expression.rb

@@ -0,0 +1,25 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks the value matches the given regular expression
+    class RegularExpression < Base
+      attr_reader :pattern
+
+      # Sets up the pattern the value is expected to match
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      private
+
+      def test
+        value =~ pattern
+      end
+
+      def message
+        "#{value.inspect} does not match #{pattern.inspect}"
+      end
+    end
+  end
+end

data/lib/hermod/validators/type_checker.rb

@@ -0,0 +1,37 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # This checks if the given value is an instance of a certain class
+    class TypeChecker < Base
+
+      attr_reader :expected_class, :checker
+
+      # Sets up the validator with the class it is expected to be. You can
+      # optionally pass a block to customise the class matching logic
+      #
+      # Examples
+      #
+      #   TypeChecker.new(Integer)
+      #
+      #   TypeChecker.new(Date) { |value| value.respond_to? :strftime }
+      #
+      def initialize(expected_class, &block)
+        @expected_class = expected_class
+        @checker = block || proc { |value| value.is_a? expected_class }
+      end
+
+      private
+
+      def test
+        checker.call(value)
+      end
+
+      def message
+        expected_class_name = expected_class.name.downcase
+        join_word = (%w(a e i o u).include?(expected_class_name[0]) ? "an" : "a")
+        "must be #{join_word} #{expected_class_name}"
+      end
+    end
+  end
+end

data/lib/hermod/validators/value_presence.rb

@@ -0,0 +1,19 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # checks the value is present
+    class ValuePresence < Base
+
+      private
+
+      def test
+        value.present?
+      end
+
+      def message
+        "isn't optional but no value was provided"
+      end
+    end
+  end
+end

data/lib/hermod/validators/whole_units.rb

@@ -0,0 +1,20 @@
+require 'hermod/validators/base'
+
+module Hermod
+  module Validators
+    # Checks a decimal value has no decimal componant, i.e. it's just a decimal
+    # representation of an integer
+    class WholeUnits < Base
+
+      private
+
+      def test
+        value == value.to_i
+      end
+
+      def message
+        "must be in whole units"
+      end
+    end
+  end
+end

data/lib/hermod/version.rb

@@ -1,3 +1,3 @@
 module Hermod
-  VERSION = "1.0.2"
+  VERSION = "1.2.0"
 end

data/lib/hermod/xml_section_builder.rb

@@ -4,6 +4,16 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/blank'
 
 require 'hermod/xml_node'
+require 'hermod/input_mutator'
+require 'hermod/validators/allowed_values'
+require 'hermod/validators/attributes'
+require 'hermod/validators/type_checker'
+require 'hermod/validators/non_negative'
+require 'hermod/validators/non_zero'
+require 'hermod/validators/range'
+require 'hermod/validators/regular_expression'
+require 'hermod/validators/value_presence'
+require 'hermod/validators/whole_units'
 
 module Hermod
 
@@ -49,175 +59,151 @@ module Hermod
 
     # Public: defines a node for sending a string to HMRC
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def string_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        if options.has_key?(:input_mutator)
-          value, attributes = options[:input_mutator].call(value, attributes)
-        end
-        if value.blank?
-          if options[:optional]
-            return # Don't need to add an empty node
-          else
-            raise InvalidInputError, "#{symbolic_name} isn't optional but no value was provided"
-          end
-        end
-        if options.has_key?(:allowed_values) && !options[:allowed_values].include?(value)
-          raise InvalidInputError,
-            "#{value.inspect} is not in the list of allowed values for #{symbolic_name}: #{options[:allowed_values].inspect}"
-        end
-        if options.has_key?(:matches) && value !~ options[:matches]
-          raise InvalidInputError,
-            "Value #{value.inspect} for #{symbolic_name} doesn't match #{options[:matches].inspect}"
-        end
-        nodes[symbolic_name] << XmlNode.new(xml_name, value.to_s, attributes).rename_attributes(options[:attributes])
+    def string_node(name, options={})
+      mutators = [].tap do |mutators|
+        mutators << InputMutator.new(options.delete(:input_mutator)) if options.has_key? :input_mutator
+      end
+      validators = [].tap do |validators|
+        validators << Validators::AllowedValues.new(options.delete(:allowed_values)) if options.has_key? :allowed_values
+        validators << Validators::RegularExpression.new(options.delete(:matches)) if options.has_key? :matches
+        validators << Validators::ValuePresence.new unless options.delete(:optional)
+        validators << Validators::Attributes.new(options.fetch(:attributes, {}).keys)
+      end
+      create_method(name, mutators, validators, options) do |value, attributes|
+        [value, attributes]
       end
     end
 
     # Public: defines a node for sending an integer to HMRC
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def integer_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        if options.has_key?(:range) && (options[:range][:min] > value || options[:range][:max] < value)
-          raise InvalidInputError,
-            "#{value} is outwith the allowable range for #{symbolic_name}: #{options[:range][:min]} - #{options[:range][:max]}"
+    def integer_node(name, options={})
+      validators = [].tap do |validators|
+        if options.has_key? :range
+          validators << Validators::Range.new(options[:range][:min], options[:range][:max])
+        end
       end
-      nodes[symbolic_name] << XmlNode.new(xml_name, value.to_s, attributes).rename_attributes(options[:attributes]) if value.present?
+      create_method(name, [], validators, options) do |value, attributes|
+        [value.to_s, attributes]
       end
     end
 
     # Public: defines a node for sending a date to HMRC
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def date_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        if value.blank?
-          if options[:optional]
-            return # Don't need to add an empty node
-          else
-            raise InvalidInputError, "#{symbolic_name} isn't optional but no value was provided"
-          end
+    def date_node(name, options={})
+      validators = [].tap do |validators|
+        validators << Validators::ValuePresence.new unless options.delete(:optional)
+        validators << Validators::TypeChecker.new(Date) { |value| value.respond_to? :strftime }
       end
-      unless value.respond_to?(:strftime)
-        raise InvalidInputError, "#{symbolic_name} must be set to a date"
-      end
-      nodes[symbolic_name] << XmlNode.new(xml_name, value.strftime(format_for(:date)), attributes).rename_attributes(options[:attributes])
+
+      create_method(name, [], validators, options) do |value, attributes|
+        [value.strftime(format_for(:date)), attributes]
       end
     end
 
     # Public: defines a node for sending a boolean to HMRC. It will only be
     # sent if the boolean is true.
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def yes_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        if value
-          nodes[symbolic_name] << XmlNode.new(xml_name, YES, attributes).rename_attributes(options[:attributes]) if value.present?
-      end
+    def yes_node(name, options={})
+      create_method(name, [], [], options) do |value, attributes|
+        [(value ? YES : nil), attributes]
       end
     end
 
     # Public: defines a node for sending a boolean to HMRC. A "yes" will be
     # sent if it's true and a "no" will be sent if it's false
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def yes_no_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        nodes[symbolic_name] << XmlNode.new(xml_name, value ? YES : NO, attributes).rename_attributes(options[:attributes])
+    def yes_no_node(name, options={})
+      create_method(name, [], [], options) do |value, attributes|
+        [(value ? YES : NO), attributes]
       end
     end
 
     # Public: defines a node for sending a monetary value to HMRC
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def monetary_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
-
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
-
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        value ||= 0 # nils are zero
-      if !options.fetch(:negative, true) && value < ZERO
-        raise InvalidInputError, "#{symbolic_name} cannot be negative"
-      end
-      # Don't allow fractional values for whole number nodes
-      if options[:whole_units] && value != value.to_i
-        raise InvalidInputError, "#{symbolic_name} must be in whole pounds"
-      end
-      # Don't include optional nodes if they're zero
-      if !(options[:optional] && value.zero?)
-        nodes[symbolic_name] << XmlNode.new(xml_name, sprintf(format_for(:money), value), attributes).rename_attributes(options[:attributes]) if value.present?
+    def monetary_node(name, options={})
+      validators = [].tap do |validators|
+        validators << Validators::NonNegative.new unless options.fetch(:negative, true)
+        validators << Validators::WholeUnits.new if options[:whole_units]
+        validators << Validators::NonZero.new unless options[:optional]
       end
+
+      create_method(name, [], validators, options) do |value, attributes|
+        if options[:optional] && value == 0
+          [nil, attributes]
+        else
+          [sprintf(format_for(:money), value), attributes]
+        end
       end
     end
 
     # Public: defines an XML parent node that wraps other nodes
     #
-    # symbolic_name - the name of the node. This will become the name of the
-    #                 method on the XmlSection.
-    # options       - a hash of options used to set up validations.
+    # name    - the name of the node. This will become the name of the method on the XmlSection.
+    # options - a hash of options used to set up validations.
     #
     # Returns nothing you should rely on
-    def parent_node(symbolic_name, options={})
-      raise DuplicateNodeError, "#{symbolic_name} is already defined" if @node_order.include? symbolic_name
-      @node_order << symbolic_name
+    def parent_node(name, options={})
+      create_method(name, [], [], options) do |value, attributes|
+        [value, attributes]
+      end
+    end
+
+    private
 
-      xml_name = options.fetch(:xml_name, symbolic_name.to_s.camelize)
+    # Private: creates a method with a given name that uses a set of mutators
+    # and a set of validators to change and validate the input according to
+    # certain options. This is used to implement all the node type methods.
+    #
+    # name -       the name of the new method
+    # mutators -   an array of InputMutator objects (normally one) that change the value and attributes in some way
+    # validators - an array of Validator::Base subclasses that are applied to the value and attributes and raise
+    #              errors under given conditions
+    # block -      a block that takes the value and attributes and does any post-validation mutation on them
+    #
+    # Returns nothing you should rely on
+    def create_method(name, mutators, validators, options = {}, &block)
+      raise DuplicateNodeError, "#{name} is already defined" if @node_order.include? name
+      @node_order << name
+      xml_name = options.fetch(:xml_name, name.to_s.camelize)
+
+      @new_class.send :define_method, name do |value, attributes = {}|
+        mutators.each { |mutator| value, attributes = mutator.mutate!(value, attributes) }
+        begin
+          validators.each { |validator| validator.valid?(value, attributes) }
+        rescue InvalidInputError => ex
+          raise InvalidInputError, "#{name} #{ex.message}"
+        end
 
-      @new_class.send :define_method, symbolic_name do |value, attributes={}|
-        nodes[symbolic_name] << XmlNode.new(xml_name, value, attributes).rename_attributes(options[:attributes]) if value.present?
+        value, attributes = instance_exec(value, attributes, &block)
+        if value.present?
+          nodes[name] << XmlNode.new(xml_name, value, attributes).rename_attributes(options[:attributes])
+        end
       end
     end
+
   end
 end

data/lib/hermod.rb

@@ -1,5 +1,7 @@
 require 'hermod/xml_section'
 
+I18n.enforce_available_locales = false
+
 # The namespace for the gem
 module Hermod
 end

data/spec/hermod/validators/allowed_values_spec.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe AllowedValues do
+      subject do
+        AllowedValues.new(%w(Antelope Bear Cat Dog Elephant))
+      end
+
+      it "permits values in the list" do
+        subject.valid?("Cat", {}).must_equal true
+      end
+
+      it "raises an error for values not in the list" do
+        ex = proc { subject.valid?("Albatross", {}) }.must_raise InvalidInputError
+        ex.message.must_equal "must be one of Antelope, Bear, Cat, Dog, or Elephant, not Albatross"
+      end
+    end
+  end
+end

data/spec/hermod/validators/attributes_spec.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe Attributes do
+      subject do
+        Attributes.new([:species, :genus])
+      end
+
+      it "permits attributes in the list" do
+        subject.valid?(nil, {species: "Felis catus", genus: "Felis"}).must_equal true
+      end
+
+      it "raises an error for attributes not in the list" do
+        ex = proc { subject.valid?(nil, {phylum: "Chordata"}) }.must_raise InvalidInputError
+        ex.message.must_equal "has attributes it doesn't accept: phylum"
+      end
+    end
+  end
+end

data/spec/hermod/validators/base_spec.rb

@@ -0,0 +1,25 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe Base do
+      subject do
+        Base.new
+      end
+
+      it "doesn't implement a test" do
+        proc { subject.valid?(nil, {}) }.must_raise NotImplementedError
+      end
+
+      it "has a default error message" do
+        class TestValidator < Base
+          def test
+            false
+          end
+        end
+        ex = proc { TestValidator.new.valid?(nil, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "is invalid"
+      end
+    end
+  end
+end

data/spec/hermod/validators/non_negative_spec.rb

@@ -0,0 +1,24 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe NonNegative do
+      subject do
+        NonNegative.new
+      end
+
+      it "allows positive values" do
+        subject.valid?(1, {}).must_equal true
+      end
+
+      it "allows zero values" do
+        subject.valid?(0, {}).must_equal true
+      end
+
+      it "raises an error for negative values" do
+        ex = proc { subject.valid?(-1, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "cannot be negative"
+      end
+    end
+  end
+end

data/spec/hermod/validators/non_zero_spec.rb

@@ -0,0 +1,24 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe NonZero do
+      subject do
+        NonZero.new
+      end
+
+      it "allows positive values" do
+        subject.valid?(1, {}).must_equal true
+      end
+
+      it "allows negative values" do
+        subject.valid?(-1, {}).must_equal true
+      end
+
+      it "raises an error for zero values" do
+        ex = proc { subject.valid?(0, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "cannot be zero"
+      end
+    end
+  end
+end

data/spec/hermod/validators/range_spec.rb

@@ -0,0 +1,25 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe Range do
+      subject do
+        Range.new(1..7)
+      end
+
+      it "allows values in the range" do
+        subject.valid?(1, {}).must_equal true
+        subject.valid?(7, {}).must_equal true
+      end
+
+      it "raises an error for values outwith the range" do
+        ex = proc { subject.valid?(0, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "must be between 1 and 7"
+      end
+
+      it "can also take a min and max as arguments" do
+        Range.new(1, 7).valid?(3, {}).must_equal true
+      end
+    end
+  end
+end

data/spec/hermod/validators/regular_expression_spec.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe RegularExpression do
+      subject do
+        RegularExpression.new(/\A[A-Z]{2} [0-9]{6} [A-D]\z/x)
+      end
+
+      it "allows values that match the pattern" do
+        subject.valid?("AB123456C", {}).must_equal true
+      end
+
+      it "raises an error for values that don't match the pattern" do
+        ex = proc { subject.valid?("fish", {}) }.must_raise InvalidInputError
+        ex.message.must_equal "\"fish\" does not match /\\A[A-Z]{2} [0-9]{6} [A-D]\\z/x"
+      end
+    end
+  end
+end

data/spec/hermod/validators/type_checker_spec.rb

@@ -0,0 +1,29 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe TypeChecker do
+      it "uses a default block that checks the value is an instance of the given class" do
+        checker = TypeChecker.new(Integer)
+        checker.valid?(1, {}).must_equal true
+        proc { checker.valid?(1.0, {}) }.must_raise InvalidInputError
+      end
+
+      it "allows you to give a block to be more discerning" do
+        checker = TypeChecker.new(Date) {|val| val.respond_to? :strftime }
+        dateish = Minitest::Mock.new
+        dateish.expect :strftime, "today"
+        checker.valid?(dateish, {}).must_equal true
+        proc { checker.valid?(Minitest::Mock.new, {}) }.must_raise InvalidInputError
+      end
+
+      it "gives the correct message" do
+        ex = proc { TypeChecker.new(Integer).valid?(1.0, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "must be an integer"
+
+        ex = proc { TypeChecker.new(Float).valid?(1, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "must be a float"
+      end
+    end
+  end
+end

data/spec/hermod/validators/value_presence_spec.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe ValuePresence do
+      subject do
+        ValuePresence.new
+      end
+
+      it "allows values that are present" do
+        subject.valid?(1, {}).must_equal true
+      end
+
+      it "raises an error for missing values" do
+        ex = proc { subject.valid?(nil, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "isn't optional but no value was provided"
+      end
+    end
+  end
+end

data/spec/hermod/validators/whole_units_spec.rb

@@ -0,0 +1,20 @@
+require "minitest_helper"
+
+module Hermod
+  module Validators
+    describe WholeUnits do
+      subject do
+        WholeUnits.new
+      end
+
+      it "allows values that are in whole units" do
+        subject.valid?(1.0, {}).must_equal true
+      end
+
+      it "raises an error for values with a fractional componant" do
+        ex = proc { subject.valid?(3.1415, {}) }.must_raise InvalidInputError
+        ex.message.must_equal "must be in whole units"
+      end
+    end
+  end
+end

data/spec/hermod/xml_section_builder/integer_node_spec.rb

@@ -0,0 +1,29 @@
+require "minitest_helper"
+
+module Hermod
+  describe XmlSection do
+
+    IntegerXml = XmlSection.build do |builder|
+      builder.integer_node :day_of_the_week, range: {min: 1, max: 7}
+    end
+
+    describe "Integer nodes" do
+      subject do
+        IntegerXml.new
+      end
+
+      it "should accept a valid number" do
+        subject.day_of_the_week 7
+        value_of_node("DayOfTheWeek").must_equal "7"
+      end
+
+      it "should raise an error if the number is above the maximum" do
+        proc { subject.day_of_the_week 8 }.must_raise InvalidInputError
+      end
+
+      it "should raise an error if the number is below the minimum" do
+        proc { subject.day_of_the_week 0 }.must_raise InvalidInputError
+      end
+    end
+  end
+end

data/spec/hermod/xml_section_builder/monetary_node_spec.rb

@@ -41,9 +41,9 @@ module Hermod
         value_of_node("Pension").must_equal "-100.00"
       end
 
-      it "should not allow pennies for whole unit nodes" do
+      it "should not allow decimal values for whole unit nodes" do
         ex = proc { subject.pension BigDecimal.new("12.34") }.must_raise InvalidInputError
-        ex.message.must_equal "pension must be in whole pounds"
+        ex.message.must_equal "pension must be in whole units"
       end
     end
   end

data/spec/hermod/xml_section_builder/string_node_spec.rb

@@ -18,7 +18,6 @@ module Hermod
       subject do
         StringXml.new do |string_xml|
           string_xml.greeting "Hello"
-          string_xml.name "World"
         end
       end
 
@@ -33,7 +32,7 @@ module Hermod
 
       it "should raise an error when the regex validation fails" do
         ex = proc { subject.title "Laird" }.must_raise InvalidInputError
-        ex.message.must_equal %{Value "Laird" for title doesn't match /\\ASir|Dame\\z/}
+        ex.message.must_equal %(title "Laird" does not match /\\ASir|Dame\\z/)
       end
 
       it "should require all non-optional nodes to have content" do
@@ -53,7 +52,7 @@ module Hermod
 
       it "should raise an error if the value is not in the list of allowed values" do
         ex = proc { subject.mood "Jubilant" }.must_raise InvalidInputError
-        ex.message.must_equal %{"Jubilant" is not in the list of allowed values for mood: ["Happy", "Sad", "Hangry"]}
+        ex.message.must_equal "mood must be one of Happy, Sad, or Hangry, not Jubilant"
       end
 
       it "should use the given keys for attributes" do
@@ -63,7 +62,12 @@ module Hermod
       end
 
       it "should raise an error if given an attribute that isn't expected" do
-        proc { subject.title "Sir", knight: "yes" }.must_raise KeyError
+        proc { subject.title "Sir", knight: "yes" }.must_raise InvalidInputError
+      end
+
+      it "should not include empty, optional nodes" do
+        subject.name ""
+        nodes("Name").must_be_empty
       end
     end
   end

data/spec/minitest_helper.rb

@@ -1,8 +1,12 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'hermod'
 
-require 'minitest/autorun'
-require 'pry-rescue/minitest'
+require "minitest/autorun"
+require "minitest/hell"
+require "minitest/reporters"
+require "nokogiri"
+
+Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new
 
 require 'nokogiri'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermod
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Harry Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -92,6 +92,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -119,17 +161,40 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - hermod.gemspec
 - lib/hermod.rb
+- lib/hermod/input_mutator.rb
 - lib/hermod/sanitisation.rb
+- lib/hermod/validators/allowed_values.rb
+- lib/hermod/validators/attributes.rb
+- lib/hermod/validators/base.rb
+- lib/hermod/validators/non_negative.rb
+- lib/hermod/validators/non_zero.rb
+- lib/hermod/validators/range.rb
+- lib/hermod/validators/regular_expression.rb
+- lib/hermod/validators/type_checker.rb
+- lib/hermod/validators/value_presence.rb
+- lib/hermod/validators/whole_units.rb
 - lib/hermod/version.rb
 - lib/hermod/xml_node.rb
 - lib/hermod/xml_section.rb
 - lib/hermod/xml_section_builder.rb
+- spec/hermod/validators/allowed_values_spec.rb
+- spec/hermod/validators/attributes_spec.rb
+- spec/hermod/validators/base_spec.rb
+- spec/hermod/validators/non_negative_spec.rb
+- spec/hermod/validators/non_zero_spec.rb
+- spec/hermod/validators/range_spec.rb
+- spec/hermod/validators/regular_expression_spec.rb
+- spec/hermod/validators/type_checker_spec.rb
+- spec/hermod/validators/value_presence_spec.rb
+- spec/hermod/validators/whole_units_spec.rb
 - spec/hermod/xml_section_builder/date_node_spec.rb
+- spec/hermod/xml_section_builder/integer_node_spec.rb
 - spec/hermod/xml_section_builder/monetary_node_spec.rb
 - spec/hermod/xml_section_builder/parent_node_spec.rb
 - spec/hermod/xml_section_builder/string_node_spec.rb
@@ -150,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,7 +228,18 @@ signing_key:
 specification_version: 4
 summary: A Ruby library for talking to the HMRC Government Gateway.
 test_files:
+- spec/hermod/validators/allowed_values_spec.rb
+- spec/hermod/validators/attributes_spec.rb
+- spec/hermod/validators/base_spec.rb
+- spec/hermod/validators/non_negative_spec.rb
+- spec/hermod/validators/non_zero_spec.rb
+- spec/hermod/validators/range_spec.rb
+- spec/hermod/validators/regular_expression_spec.rb
+- spec/hermod/validators/type_checker_spec.rb
+- spec/hermod/validators/value_presence_spec.rb
+- spec/hermod/validators/whole_units_spec.rb
 - spec/hermod/xml_section_builder/date_node_spec.rb
+- spec/hermod/xml_section_builder/integer_node_spec.rb
 - spec/hermod/xml_section_builder/monetary_node_spec.rb
 - spec/hermod/xml_section_builder/parent_node_spec.rb
 - spec/hermod/xml_section_builder/string_node_spec.rb