primalize 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 211551a4a7fc66702f544d35f053e4e9f65d1fe1
-  data.tar.gz: b6f715a19f9b32fae1b4c025ae195ed1643faf65
+  metadata.gz: f69cd6e3d6c2859c98e3b06bc321cad0bec7bb3f
+  data.tar.gz: c5a9ced0a23efc1a5e48a5a4d69e044d164e1413
 SHA512:
-  metadata.gz: 1557c13cf41e2924453083053dd5de8b08b258cbdca01a2f55cf9d72f2f1a6ab048bb94fe564467346daea9292f8a436fd932db6dca4fc989d4b1a8aebf601ab
-  data.tar.gz: 133145cfb6bca06af9fd920eca885aa16707ca2af8b49e7c4c059112d65052232af87ab6a7e6049d701497c143e15008a22ae8be8fe5a6b1e18e756518e63a2e
+  metadata.gz: d35467a882797f1b5601493a04359b1f3fd0daf8de59784d51ff18bdb561dce5409e80527bfa935c98535fadf89e44bfd1b75db0ba5753e656e9d1cd3850918c
+  data.tar.gz: 740af8f5e9a39a3f64329389c169898c7771df48b018ac586d44b29459f3d02feeed898540539b25d6f2f5d8782ba470d30613887335a4ddbf845ea7e53fa9a5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    primalize (0.2.0)
+    primalize (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -79,7 +79,37 @@ Or install it yourself as:
 
 ## Usage
 
-If you need to primalize a single object, you subclass `Primalize::Single` and specify the attributes and types of the result as in the example above. But reducing the object's attributes to a hash isn't all you do in most apps. You may also need to do some coercion. For example, if you have an object whose `city` isn't stored as a string but you need to translate it to one:
+If you need to primalize a single object, you subclass `Primalize::Single` and specify the attributes and types of the result as in the example above.
+
+### Supported types
+
+The complete list of supported types are:
+
+- `integer`: whole numbers
+- `float`: floating-point numbers
+- `number`: any numeric value
+- `string`: text
+- `boolean`: explicitly `true` or `false` (not "truthy" or "falsy" values)
+- `array(*types)`: an array containing values of the specified types
+  - Example: `array(string, integer)`
+- `optional(*types)`: any of the specified types or `nil`
+  - Example: `optional(string)`, both `"foo"` and `nil` are acceptable values
+- `enum(*values)`: must be one of the specified values
+  - Example: `enum('requested', 'shipped', 'delivered')`
+- `timestamp`: a `Date`, `Time`, or `DateTime` value
+- `any(*types)`: any value of the given types
+  - Example: `any(string, integer)` will only match on strings and integers
+  - If no types are specified, any value will match
+- `primalize(YourPrimalizerClass)`: primalizes the specified attribute with the given `Primalize::Single` subclass
+  - Example: `primalize(OrderSerializer)`
+- `object(**types)`: a hash of the specified structure
+  - Example: `object(id: integer, name: string)`
+  - Only the required keys need to be specified. The rest of the hash will pass.
+  - If no keys are specified, all of them are optional and it will match any hash.
+
+### Attribute coercion
+
+Reducing the object's attributes to a hash isn't all you do in most apps. You may also need to do some coercion. For example, if you have an object whose `city` isn't stored as a string but you need to translate it to one:
 
 ```ruby
 class ShipmentSerializer < Primalize::Single
@@ -90,6 +120,8 @@ class ShipmentSerializer < Primalize::Single
 end
 ```
 
+### Virtual attributes
+
 You can also generate attributes that don't exist on the object being primalized by defining methods on the primalizer:
 
 ```ruby
@@ -117,9 +149,9 @@ end
 By default, subclasses of `Primalize::Single` will raise an `ArgumentError` if there is a mismatch between the types declared in its `attributes` call and what is passed in to be primalized. In production, you might not want that to happen, so you can change that in your production config:
 
 ```ruby
-Primalize::Single.type_mismatch_handler = proc do |attr, type, value|
-  msg = "Type mismatch: #{attr} is expected to be #{type.inspect}, but is a #{value.inspect} - " +
-    caller.grep(Regexp.new(Rails.root))
+Primalize::Single.type_mismatch_handler = proc do |primalizer, attr, type, value|
+  msg = "Type mismatch: #{primalizer.name}##{attr} is expected to be #{type.inspect}, but is a #{value.inspect}\n"
+  msg << caller.grep(Regexp.new(Rails.root)).join("\n") # Include application stack trace
 
   Slack.notify '#bugs', msg
 end

data/lib/primalize/single.rb

@@ -174,6 +174,10 @@ module Primalize
     class Number
       include Type
 
+      def initialize &coercion
+        @coercion = coercion
+      end
+
       def === value
         ::Numeric === value
       end
@@ -266,6 +270,10 @@ module Primalize
 
       TYPES = [Time, Date, DateTime].freeze
 
+      def initialize &coercion
+        @coercion = coercion
+      end
+
       def === value
         TYPES.any? { |type| type === value }
       end
@@ -321,6 +329,7 @@ module Primalize
 
       def initialize types, &coercion
         @types = types
+        @coercion = coercion
       end
 
       def === value

data/lib/primalize/version.rb

@@ -1,3 +1,3 @@
 module Primalize
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primalize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-09 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler