hoodoo 1.12.3 → 1.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cd0bbca0d44ff8c52c354e140565325d8447f10
-  data.tar.gz: 5faa6103ed09143226c2d869069af59c0ea5a76f
+  metadata.gz: 612e215b33df39e4942acbf763c27af9c817f5a2
+  data.tar.gz: 9159951c875326ec7bcdd5d696365563028c7d2d
 SHA512:
-  metadata.gz: b3a8f6e8f61b54b65b9842fffe90aa1e0503fc4678a876ffcdf75de4075792cf8ff1c444bdb9b72c722a9ced24f4916ebfbdff338425c97dbe53c18e153bfd7a
-  data.tar.gz: 47ff963da7a1ff972fba27090290398bfcd35612d5657df877b3f623c3726dbd8e3fd2ed3668df1a43c6df5e3f5caf6b04ec0489bfd0f3ae441aa7ba387eab42
+  metadata.gz: c2c0eeb88c1f8950a3dda6725f1110b8e32b9767c30dfbe4a560c4dbacaaad5d459ccfe71d46de5b850031d459708853aa818cfcc06f241f3176ee4319874403
+  data.tar.gz: b747857c2b8469936e728e81872b80d33016df0a68a2e15a6001794593d216a6c86ec6d30cae97d0c48e6f1d9fd22bb947307a8b29cea398a8b3829d886f6a38

data/lib/hoodoo/presenters/base_dsl.rb

@@ -93,8 +93,12 @@ module Hoodoo
       # &block::    Optional block declaring the fields making up the nested
       #             hash
       #
-      # Example 1 - a Hash where keys must be <= 16 characters long and values
-      #             must match the Hoodoo::Data::Types::Currency type.
+      # == Example 1
+      #
+      # A Hash where keys must be <= 16 characters long and values must match
+      # a <tt>Hoodoo::Data::Types::Currency</tt> type (with the default
+      # Hoodoo::Data::Types namespace use arising from the Symbol passed
+      # to the #type method).
       #
       #     class CurrencyHash < Hoodoo::Presenters::Base
       #       schema do
@@ -108,14 +112,19 @@ module Hoodoo
       #
       # See Hoodoo::Presenters::Hash#keys for more information and examples.
       #
-      # Example 2 - a Hash where keys must be 'one' or 'two', each with a
-      #             value matching the given schema.
+      # == Example 2
+      #
+      # A Hash where keys must be 'one' or 'two', each with a value matching
+      # the given schema. Here, the example assumes that a subclass of
+      # Hoodoo::Presenters::Base has been defined under the name of
+      # <tt>SomeNamespace::Types::Currency</tt>, since this is passed as a
+      # class reference to the #type method.
       #
       #     class AltCurrencyHash < Hoodoo::Presenters::Base
       #       schema do
       #         hash :currencies do
       #           key :one do
-      #             type :Currency
+      #             type SomeNamespace::Types::Currency
       #           end
       #
       #           key :two do
@@ -128,6 +137,69 @@ module Hoodoo
       #
       # See Hoodoo::Presenters::Hash#key for more information and examples.
       #
+      # == Limitations
+      #
+      # The syntax cannot express simple value types. It always describes a
+      # nested object. So, the following describes a Hash called +payload+
+      # which has arbitrary keys each leading to a nested _object_ with
+      # key/value pairs where the key is called +some_value+ and the value
+      # is an arbitrary length String:
+      #
+      #     class NotSoSimpleHash < Hoodoo::Presenters::Base
+      #       schema do
+      #         hash :payload do
+      #           keys do
+      #             text :some_value
+      #           end
+      #         end
+      #       end
+      #     end
+      #
+      # This is a valid piece of Ruby input data for the above which will
+      # render without changes and validate successfully:
+      #
+      #     data = {
+      #       "payload" => {
+      #         "any_key_name"     => { "some_value" => "Any string" },
+      #         "another_key_name" => { "some_value" => "Another string" },
+      #       }
+      #     }
+      #
+      #     NotSoSimpleHash.validate( data )
+      #     # => []
+      #
+      # This is invalid because one of the values is not a String:
+      #
+      #     data = {
+      #       "payload" => {
+      #         "any_key_name"     => { "some_value" => "Any string" },
+      #         "another_key_name" => { "some_value" => 22 },
+      #       }
+      #     }
+      #
+      #     NotSoSimpleHash.validate( data )
+      #     # => [{"code"=>"generic.invalid_string",
+      #     #      "message"=>"Field `payload.another_key_name.some_value` is an invalid string",
+      #     #      "reference"=>"payload.another_key_name.some_value"}]
+      #
+      # This is invalid because the DSL cannot express a simple String value
+      # for the keys:
+      #
+      #     data = {
+      #       "payload" => {
+      #         "any_key_name"     => "Any string",
+      #         "another_key_name" => "Another string",
+      #       }
+      #     }
+      #
+      #     NotSoSimpleHash.validate( data )
+      #     # => [{"code"=>"generic.invalid_object",
+      #     #      "message"=>"Field `payload.any_key_name` is an invalid object",
+      #     #      "reference"=>"payload.any_key_name"},
+      #     #     {"code"=>"generic.invalid_object",
+      #     #      "message"=>"Field `payload.another_key_name` is an invalid object",
+      #     #      "reference"=>"payload.another_key_name"}]
+      #
       def hash( name, options = {}, &block )
         hash = property( name, Hoodoo::Presenters::Hash, options, &block )
         internationalised() if hash.is_internationalised?()
@@ -283,7 +355,7 @@ module Hoodoo
       #               question, e.g. +BasketItem+. The deprecated form of this
       #               interface takes the name of the type to nest as a symbol,
       #               e.g. +:BasketItem+, in which case the Type must be
-      #               declared within nested modules "Hoodoo::Data::Types".
+      #               declared within nested modules Hoodoo::Data::Types.
       #
       # +options+::   Optional options hash. No options currently defined.
       #
@@ -403,7 +475,7 @@ module Hoodoo
       #                   form of this interface takes the name of the type to
       #                   nest as a symbol, e.g. +:Product+, in which case the
       #                   Resource must be declared within nested modules
-      #                   "Hoodoo::Data::Types".
+      #                   Hoodoo::Data::Types.
       #
       # +options+::       Optional options hash. No options currently defined.
       #

data/lib/hoodoo/presenters/types/hash.rb

@@ -84,8 +84,8 @@ module Hoodoo
       # a block is given, use Hoodoo::Presenters::BaseDSL to describe how any
       # of the values in the Hash must look.
       #
-      # +options+:: A +Hash+ of options - currently only +:length => [n]+ is
-      #             supported, which describes the maximum permitted length of
+      # +options+:: A +Hash+ of options; currently only <tt>:length => [n]</tt>
+      #             is supported, describing the maximum permitted length of
       #             the key. If this option is omitted, keys can be any length.
       #
       # Example:

data/lib/hoodoo/services/middleware/middleware.rb

@@ -1,5 +1,5 @@
 ########################################################################
-# File::    service_middleware.rb
+# File::    middleware.rb
 # (C)::     Loyalty New Zealand 2014
 #
 # Purpose:: Rack middleware, declared in a +config.ru+ file in the usual

data/lib/hoodoo/version.rb

@@ -12,6 +12,6 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, ensure that the date in
   # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
   #
-  VERSION = '1.12.3'
+  VERSION = '1.12.4'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.12.4
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio