deserializer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016e23ff6b54642bf58daea3210e2ed45011170b
-  data.tar.gz: e897dd40e6b336374169440965eee92f2496e0a9
+  metadata.gz: d2d925b16aaf70730f68ed799b22236a2b4a9c1b
+  data.tar.gz: 291d5ba90c44ddd31eeab94c314f16f414ecf7df
 SHA512:
-  metadata.gz: 66afd6278382e72c8f925be8c05b4fc330c9886714de2860a82915212a1a76df6c72d200c10e0c9c4fa16fdb4005c065f540b45f70328d9f6b12d777da4d239f
-  data.tar.gz: cbe4496605fa6a1b9b1f37caf0affadeade2d833df2e857ff6c30c5158a1e14a616100adc84e79cb25b0807b2d09b803d72d988af7fab1efa4163159fa874f62
+  metadata.gz: df1caed559319d4c42f6770408172d600c8511260126a8eec742d645586d14861e8468999f094d195f0a9462c0bf09efe2afc3f289166f3c42f330e750e96e1d
+  data.tar.gz: 2a87db6f696784599033d89f4b41abad6bb2094890f7a403c83182afab53094c0714a7ff8d276a0a113c00a9e9b9990498f5b723721c5b23dc317dee305e36c5

data/README.md

@@ -130,7 +130,7 @@ with params `{"title" => "lorem", "body" => "ipsum"}`, will give you a hash of `
 `attribute` is the singular version of `attributes`, but like `ActiveModel::Serializer` it can take a `:key`
 ```ruby
 class PostDeserializer < Deserializer::Base
-  attribute :title
+  attribute :title, ignore_empty: true
   attribute :body, key: :text
 end
 ```
@@ -138,6 +138,43 @@ It is symmetric with `ActiveModel::Serializer`, so that :text is what it will ge
 
 For example with params of `{"title" => "lorem", "text" => "ipsum"}` this desrerializer will produce `{title: "lorem", body: "ipsum"}`.
 
+`ignore_empty` is an option to ignore `false`/`nil`/`""`/`[]`/`{}` values that may come into the deserializer. By defualt it will pass the value through. With this option, it will drop the key from the result, turning `{"title" => "", "text" => nil}` into `{}`
+
+`convert_with` allows the deserializer to deserialize and convert a value at the same time. For example, if we have a `Post` model that looks like
+
+```ruby 
+class Post < ActiveRecord::Base
+  belongs_to :post_type # this is a domain table
+end
+```
+
+and we serialize with 
+```ruby
+class PostSerializer < ActiveModel::Serializer
+  attribute :type
+
+  def type
+    object.post_type.symbolic_name
+  end
+end
+```
+
+Then, when we if we get a symbolic name from the controller, but want to work with an id in the backend, we can do something like:
+
+```ruby
+class PostDeserializer < Deserializer::Base
+  attribute :title, ignore_empty: true
+  attribute :body
+  attribute :post_type_id, key: type, convert_with: to_type_id
+
+  def to_type_id(value)
+    Type.find_by_symbolic_name.id
+  end
+end
+```
+
+which would take the params `{"title" => "lorem", "body" => "ipsum", "type" => "BLAGABLAG"}` and produce `{title: "lorem", body: "ipsum", post_type_id: 1}`
+
 
 #### has_one
 NOTE: This is the only association currently supported by `Deserializer`.

data/lib/deserializer/base.rb

@@ -101,10 +101,18 @@ module Deserializer
     def assign_value( attribute, value, options = {} )
       if options[:ignore_empty] && empty?(value)
         return
-      # other options go here
-      else
-        self.object[attribute] = value
       end
+      if options[:convert_with]
+        method = options[:convert_with]
+        if self.respond_to? method
+          self.object[attribute] = self.send method, value
+          return
+        end
+      end
+      # other options go here
+      
+      self.object[attribute] = value
+      
     end
 
     def empty?(value)
@@ -114,4 +122,4 @@ module Deserializer
       value == []
     end
   end
-end
+end

data/lib/deserializer/version.rb

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

data/test/lib/deserializers.rb

@@ -80,4 +80,34 @@ class HasOneWithObjectTargetDeserializer < Deserializer::Base
   def other_thing
     object
   end
+end
+
+class ConversionDeserializer < Deserializer::Base
+  attribute :real_range, convert_with: :to_range
+  attribute :bad_range,  convert_with: :to_range
+
+  def to_range(value)
+    range_array = Array(value)
+    (range_array[0]..range_array[-1])
+  end
+end
+
+class KeyedConversionDeserializer < Deserializer::Base
+  attribute :real_range, convert_with: :to_range, key: :real
+  attribute :bad_range,  convert_with: :to_range, key: :bad
+
+  def to_range(value)
+    range_array = Array(value)
+    (range_array[0]..range_array[-1])
+  end
+end
+
+class NillableConversionDeserializer < Deserializer::Base
+  attribute :real_range, convert_with: :to_range, key: :real, ignore_empty: true
+  attribute :bad_range,  convert_with: :to_range, key: :bad,  ignore_empty: true
+
+  def to_range(value)
+    range_array = Array(value)
+    (range_array[0]..range_array[-1])
+  end
 end

data/test/unit/deserializer_test.rb

@@ -121,4 +121,25 @@ class DeserializerTest < Minitest::Test
       BasicDeserializer.belongs_to :explody
     end
   end
+
+  def test_supports_conversions
+    expected = { real_range: (1..4), bad_range: (1..1)}
+    params   = { real_range: [1, 12, 4], bad_range: 1}
+
+    assert_equal expected, ConversionDeserializer.from_params( params )
+  end
+
+  def test_supports_conversions_with_key
+    expected = { real_range: (1..4), bad_range: (1..1)}
+    params   = { real: [1, 4], bad: 1}
+
+    assert_equal expected, KeyedConversionDeserializer.from_params( params )
+  end
+
+  def test_supports_conversions_with_ignore_empty
+    expected = { real_range: (1..4)}
+    params   = { real: [1, 4], bad: nil}
+
+    assert_equal expected, NillableConversionDeserializer.from_params( params )
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deserializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler