primalize 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9454407dd6619d27027fc4a5ef40252868dc8ae
-  data.tar.gz: e841a6d57e23800b2fc273141e58ededbe969205
+  metadata.gz: 211551a4a7fc66702f544d35f053e4e9f65d1fe1
+  data.tar.gz: b6f715a19f9b32fae1b4c025ae195ed1643faf65
 SHA512:
-  metadata.gz: 2574db91856d1145c4738ab69831a4862227908f857e78668970c5dd59efe6397a06f79a4d033b2f5a885961fdccbf7afeac4f8334c381524a6dbebe6d320e96
-  data.tar.gz: 7eb666e43e360456289f70537262c1134d966fe47bb9eb89e4cd4d1399a777277957df148182f84cb2724bdfcdb884d1b65794c384a7c11f3cb07ed564632152
+  metadata.gz: 1557c13cf41e2924453083053dd5de8b08b258cbdca01a2f55cf9d72f2f1a6ab048bb94fe564467346daea9292f8a436fd932db6dca4fc989d4b1a8aebf601ab
+  data.tar.gz: 133145cfb6bca06af9fd920eca885aa16707ca2af8b49e7c4c059112d65052232af87ab6a7e6049d701497c143e15008a22ae8be8fe5a6b1e18e756518e63a2e

data/Gemfile.lock

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

data/README.md

@@ -112,6 +112,19 @@ class ShipmentSerializer < Primalize::Single
 end
 ```
 
+### Type Checking
+
+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))
+
+  Slack.notify '#bugs', msg
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/primalize/many.rb

@@ -28,6 +28,10 @@ module Primalize
         define_singleton_method :inspect do
           "enumerable(#{serializer_class.inspect})"
         end
+
+        define_singleton_method :attributes do
+          serializer_class.attributes
+        end
       end
     end
 
@@ -86,5 +90,22 @@ module Primalize
     def to_json
       call.to_json
     end
+
+    def to_csv attr
+      CSV.generate do |csv|
+        result = call[attr]
+
+        csv << self.class.attributes[attr].attributes.keys
+
+        case result
+        when Hash
+          csv << result.values
+        when Array
+          result.each do |hash|
+            csv << hash.values
+          end
+        end
+      end
+    end
   end
 end

data/lib/primalize/single.rb

@@ -1,10 +1,11 @@
 require 'json'
 require 'date'
+require 'csv'
 
 module Primalize
   class Single
-    @type_mismatch_handler = proc do |attr, type, value|
-      raise TypeError, "#{self}##{attr} is specified as #{type.inspect}, but is #{value.inspect}"
+    @type_mismatch_handler = proc do |klass, attr, type, value|
+      raise TypeError, "#{klass}##{attr} is specified as #{type.inspect}, but is #{value.inspect}"
     end
 
     class << self
@@ -24,12 +25,7 @@ module Primalize
 
         attrs.each do |attr, type|
           define_method attr do
-            value = type.coerce(object.public_send(attr))
-            if type === value
-              value
-            else
-              self.class.type_mismatch_handler.call attr, type, value
-            end
+            type.coerce(object.public_send(attr))
           end
         end
       end
@@ -58,6 +54,10 @@ module Primalize
         Float.new(&coerce)
       end
 
+      def number &coerce
+        Number.new(&coerce)
+      end
+
       def optional *types, &coerce
         Optional.new(types, &coerce)
       end
@@ -70,6 +70,14 @@ module Primalize
         Timestamp.new(&coerce)
       end
 
+      def any *types, &coerce
+        Any.new(types, &coerce)
+      end
+
+      def primalize primalizer, &coerce
+        Primalizer.new(primalizer, &coerce)
+      end
+
       def type_mismatch_handler= handler
         @type_mismatch_handler = handler
       end
@@ -90,20 +98,42 @@ module Primalize
     attr_reader :object
 
     def initialize object
+      raise ArgumentError, "#{self.class.inspect} cannot serialize `nil'" if object.nil?
       @object = object
     end
 
     def call
-      self.class.attributes.each_with_object({}) do |(attr, _), hash|
-        hash[attr] = public_send(attr)
+      self.class.attributes.each_with_object({}) do |(attr, type), hash|
+        value = public_send(attr)
+
+        if type === value
+          hash[attr] = value
+        else
+          self.class.type_mismatch_handler.call self.class, attr, type, value
+        end
       end
     end
 
-    # TYPES
+    # CONVERSION
 
-    DEFAULT_COERCION = proc { |arg| arg } # Don't coerce by default
+    def to_json
+      call.to_json
+    end
+
+    def csv_headers
+      self.class.attributes.keys.map(&:to_s)
+    end
+
+    def to_csv
+      hash = call
+      CSV.generate { |csv| csv << hash.values }
+    end
+
+    # TYPES
 
     module Type
+      DEFAULT_COERCION = proc { |arg| arg } # Don't coerce by default
+
       def coerce *args
         (@coercion || DEFAULT_COERCION).call(*args)
       end
@@ -141,6 +171,18 @@ module Primalize
       end
     end
 
+    class Number
+      include Type
+
+      def === value
+        ::Numeric === value
+      end
+
+      def inspect
+        'number'
+      end
+    end
+
     class String
       include Type
 
@@ -203,7 +245,7 @@ module Primalize
 
       def initialize types, &coercion
         @types = types
-        @coercion = coercion || DEFAULT_COERCION
+        @coercion = coercion
       end
 
       def === value
@@ -233,6 +275,30 @@ module Primalize
       end
     end
 
+    class Primalizer
+      include Type
+
+      def initialize primalizer, &coercion
+        @primalizer = primalizer
+        @coercion = coercion || proc do |obj|
+          # FIXME: this is dumb
+          begin
+            primalizer.new(obj).call
+          rescue ArgumentError => e
+            raise TypeError.new(e)
+          end
+        end
+      end
+
+      def === value
+        true
+      end
+
+      def inspect
+        "primalize(#{@primalizer.inspect})"
+      end
+    end
+
     class Optional
       include Type
 
@@ -249,5 +315,22 @@ module Primalize
         "optional(#{@types.map(&:inspect).join(', ')})"
       end
     end
+
+    class Any
+      include Type
+
+      def initialize types, &coercion
+        @types = types
+      end
+
+      def === value
+        @types.empty? || @types.any? { |type| type === value }
+      end
+
+      def inspect
+        params = "(#{@types.map(&:inspect).join(', ')})"
+        "any#{@types.empty? ? nil : params}"
+      end
+    end
   end
 end

data/lib/primalize/version.rb

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

metadata

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