objectifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a71bbcefb888b422bb26aaa6a066f0452b4eaa60
-  data.tar.gz: 93a3dfef0ad8fc02ec4d6f60e1a03eaa03c53a78
+  metadata.gz: 815817635baa45e7a1ddf70cfbecd860b2b33e64
+  data.tar.gz: 64be5d2076c97859304f5ab810849ec98f08c1f2
 SHA512:
-  metadata.gz: a6012c2e53a65516f6b84b718c7be7976ef13a0dba305f8bed87d4dbc6c4634a1c40fa2d809ec793156475cea69f3575d6beae751534c347ce2f6ea746ed68c1
-  data.tar.gz: 480c670c84094cc87cd2753e7deeb7e58c6468bc15036b5e460fce4ba8aa3c6ecfa0fcecb413991b6bed3265d0655fb5c27b78d2bd394d5b5bc34064a196126d
+  metadata.gz: 584bd0a3fa9f96bb636acd0c7318bcdd276762e010f00f266a951596599a58b47e038a213266f02e0527a912cfc792756be4909af797837f691b44865166460b
+  data.tar.gz: 1d16c9f434d6167cd271cbd66a962af5763a705fbdad55ee0c2cda00a18c6a8a9b3c40bef5c62fb9d6fa4b25e2727aa55cb939e40f6987fbf4891781babf34d6

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## UNRELEASED
+
+
+## 0.3.0 2017-03-07
+
+### Added
+Tests for built-in transformer functions
+
+### Changed
+Floating point transformer to not silently convert strings to zero
+
+### Changed
+Transformer type keys to be symbols instead of constants
+
+
 ## 0.2.0 2016-10-16
 
 ### Added
@@ -9,6 +24,7 @@ Change Log file.
 Gem dependencies fixed for development and runtime to only require
 MRI 1.9.3 and later.
 
+
 ## 0.1.0 2016-10-13
 
 ### Added

data/README.md

@@ -1,5 +1,6 @@
 # Objectifier
 
+[![Gem Version](https://badge.fury.io/rb/objectifier.svg)](https://badge.fury.io/rb/objectifier)
 [![Build Status](https://travis-ci.org/wiggly/objectifier.svg?branch=master)](https://travis-ci.org/wiggly/objectifier)
 
 De-serialise plain hashes into objects.
@@ -31,27 +32,27 @@ Create custom transformers, create an objectifier and use it to de-serialise has
 ```
   require 'objectifier'
   require 'money'
-  
+
   # Add a custom tranformer for Money values
   Objectifier.factories.add_type(
-    Money,
+    :money,
     ->(name, value) {
       Objectifier::ValueResult.new(name, Money.new(value["amount"], value["code"]))
     })
 
   # define an objectifier that can be used to de-serialise a given format
   obj = Objectifier.define do
-    item :name, type: String, required: false
+    item :name, type: :string, required: false
 
-    items :accounts, type: Integer
+    items :accounts, type: :integer
 
-    item :budget, type: Money
+    item :budget, type: :money
 
-    item :length, type: Integer, required: false
+    item :length, type: :integer, required: false
 
     map :activity do
-      item :clicks, type: Integer
-      item :ctr, type: Float
+      item :clicks, type: :integer
+      item :ctr, type: :float
     end
   end
 

data/TODO.md

@@ -0,0 +1,17 @@
+# TODO
+
+## Add nillable items
+
+We should allow some things to be nil. The key is present but the value may be nil instead of either fully required or not required.
+
+## Decide whether or not using class names for the transformer types is a good idea (probably not)
+
+## Add Struct in addition to Map types
+
+## Make transformer factory configurable on a per-objectifier basis
+
+## Re-factor so that scalar/array/map also come from transformer factory?
+
+## Add default values for optional items?
+
+## Pass transformer factory through transformers so they can access transformers that exist when de-serializing objects

data/example/money/example.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift('../../lib')
+require 'objectifier'
+require 'pp'
+require 'money'
+
+#
+# To run this example you will have to install the 'money' gem
+#
+
+#
+# Money objectifier example to show how custom transformers can be created
+# to deserialize types that Objectifier does not know about
+#
+# We have a structure representing a bank account. It contains;
+#
+# id - integer, required
+#
+# balance - money
+#
+# overdraft_limit - money
+#
+
+Objectifier.factories.add_type(
+  Money,
+  ->(name, value) {
+    return Objectifier::ErrorResult.err(name, "'value' not present") unless value.key?("amount")
+    return Objectifier::ErrorResult.err(name, "'code' not present") unless value.key?("code")
+
+    Objectifier::ValueResult.new(name, Money.new(value["amount"], value["code"]))
+  })
+
+obj = Objectifier.define do
+  item :id, type: Integer
+  item :balance, type: Money
+  item :credit_limit, type: Money, required: false
+end
+
+puts "Objectifier"
+pp obj
+
+# example 1 - complete data
+parameters = {
+  "id" => 42,
+  "balance" => { "amount" => 100_00, "code" => "CAD" },
+  "credit_limit" => { "amount" => (-300_00), "code" => "CAD" },
+}
+
+puts "\nComplete Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 2 - required data
+parameters = {
+  "id" => 42,
+  "balance" => { "amount" => 100_00, "code" => "CAD" },
+}
+
+puts "\nRequired Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 3 - missing a required field
+parameters = {
+  "id" => 42,
+  "credit_limit" => { "amount" => (-300_00), "code" => "CAD" },
+}
+
+puts "\nIncomplete Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 4 - malformed data
+parameters = {
+  "id" => 42,
+  "balance" => { "amount" => 100_00, "code" => "CAD" },
+  "credit_limit" => { "code" => "CAD" },
+}
+
+puts "\nMalformed Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end

data/example/simple/example.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift('../../lib')
+require 'objectifier'
+require 'pp'
+
+#
+# Simple objectifier example
+#
+# We have a structure representing a person. It contains;
+#
+# name - string, required
+#
+# email - string required
+#
+# dob - string, optional
+# If not present in the data provided it will not be present in the structure returned.
+#
+# location - map, required
+# This map contains lattidue and longitude.
+#
+# It is required since at least one of its children is required.
+#
+#
+
+obj = Objectifier.define do
+  item :name, type: String
+  item :email, type: String
+  item :dob, type: String, required: false # TODO: add date/time to the set of builtin transformers
+  map :location do
+    item :lat, type: Float
+    item :lng, type: Float
+  end
+end
+
+puts "Objectifier"
+pp obj
+
+# example 1 - complete data
+parameters = {
+  "name" => "John Doe",
+  "email" => "john.doe@example.com",
+  "dob" => "1964-03-21",
+  "location" => {
+    "lat" => 51.5077,
+    "lng" => -0.1279,
+  },
+}
+
+puts "\nComplete Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 2 - required data
+parameters = {
+  "name" => "John Doe",
+  "email" => "john.doe@example.com",
+  "location" => {
+    "lat" => 51.5077,
+    "lng" => -0.1279,
+  },
+}
+
+puts "\nRequired Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 3 - missing a required field
+parameters = {
+  "name" => "John Doe",
+  "dob" => "1964-03-21",
+  "location" => {
+    "lat" => 51.5077,
+    "lng" => -0.1279,
+  },
+}
+
+puts "\nIncomplete Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end
+
+
+# example 4 - malformed data
+parameters = {
+  "name" => "John Doe",
+  "email" => "john.doe@example.com",
+  "dob" => "1964-03-21",
+  "location" => {
+    "lat" => "fred",
+    "lng" => -0.1279,
+  },
+}
+
+puts "\nMalformed Data Result"
+result = obj.call(parameters)
+
+if result.success?
+  pp result.value
+else
+  pp result
+end

data/lib/objectifier/array_value.rb

@@ -27,10 +27,6 @@ module Objectifier
       end
     end
 
-    def pp(indent = "")
-      "#{indent} #{to_s}"
-    end
-
     protected
 
     def key_present(parameters)

data/lib/objectifier/map_value.rb

@@ -35,18 +35,6 @@ module Objectifier
       true
     end
 
-    def pp(indent = "")
-      next_indent = "#{indent}  "
-      str = "#{indent} #{@scope} {\n"
-      str << @rules.values.map { |r| r.pp(next_indent) }.join("\n")
-      str << "\n#{indent}}\n"
-      str
-    end
-
-    def to_s
-      pp("")
-    end
-
     # examine parameters and return a hash of massaged data or an error results
     def call(parameters)
 

data/lib/objectifier/scalar_value.rb

@@ -22,15 +22,10 @@ module Objectifier
       elsif key_present(parameters)
         transform(key_value(parameters))
       else
-        # TODO: this is not a failure...
         SuccessResult.new(@name)
       end
     end
 
-    def pp(indent = "")
-      "#{indent} #{to_s}"
-    end
-
     def to_s
       "scalar %s - type: %s - required: %s" % [ @name, @type.to_s, @required.to_s ]
     end

data/lib/objectifier/transformer_factory.rb

@@ -4,16 +4,41 @@ module Objectifier
   class TransformerFactory
     def initialize
       @t = Hash.new { |h,k| raise "unknown type #{@type}" }
-      @t[String] = ->(name, value) { ValueResult.new(name, value.to_s) }
-      @t[Integer] = ->(name, value) {
+
+      @t[:boolean] = lambda do |name, value|
+        case value
+        when true, 'true', 1, '1'
+          ValueResult.new(name, true)
+        when false, 'false', 0, '0'
+          ValueResult.new(name, false)
+        else
+          ErrorResult.err(name, 'not boolean')
+        end
+      end
+
+      @t[:symbol] = ->(name, value) { ValueResult.new(name, value.to_sym) }
+
+      @t[:string] = ->(name, value) { ValueResult.new(name, value.to_s) }
+
+      @t[:integer] = lambda do |name, value|
         begin
           ValueResult.new(name, Integer(value))
         rescue => e
           ErrorResult.err(name, e.message)
         end
-      }
-      @t[Fixnum] = @t[Integer]
-      @t[Float] = ->(name, value) { ValueResult.new(name, value.to_f) }
+      end
+
+      @t[:fixnum] = @t[:integer]
+
+      @t[:bignum] = @t[:integer]
+
+      @t[:float] = lambda do |name, value|
+        begin
+          ValueResult.new(name, Float(value))
+        rescue => e
+          ErrorResult.err(name, e.message)
+        end
+      end
     end
 
     def add_type(type, transformer)

data/lib/objectifier/version.rb

@@ -1,3 +1,3 @@
 module Objectifier
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: objectifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nigel Rantor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,8 +152,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
+- example/money/example.rb
+- example/simple/example.rb
 - lib/objectifier.rb
 - lib/objectifier/array_value.rb
 - lib/objectifier/map_value.rb
@@ -182,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: De-serialize plain hashes into real object graphs