simple_serializer 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGU3YmExMWM5OGZjZjc0ZGZjMDM5YzQxZTc0MDdmZWZkNDI1NmExYQ==
+    OTM2MDJkNDRiNjk0YmQ5Y2M3Mzk1YzQ2MTAzZjJkNWFhNWUwZTU0Ng==
   data.tar.gz: !binary |-
-    MjcyZmFhZTUzZjkxZjcwYjZlOGYwM2M0NTMzNDRlMWU1ZmI2Njg2NQ==
+    YmE2MmYzZWFlMGRjZWE0MDdmYjYyNGRjYjA3NWUxNzNlZTNhMDU4NA==
 SHA512:
   metadata.gz: !binary |-
-    YTE5MmQ4NmVjMWMzYjg1MjVlNDVkZGYzZjIyMmNhYTdjMTViMGViZTlkNzE5
-    MDE1NjBjMTk3MDMyMDAyZjdjYmE5NzFmMTY5NDU2YmIyYThhNTc2ODAxMzE1
-    MzM3ZmE1NmQ0OTYwYjBhMjE0MzMxNzE0Y2VmYzFhZmNmN2U5ZmY=
+    MzMyNjg5ZDc1YjcxYzg5YjQ2MTQzMTk4NWFiYjc3ZTU0YmIyYjYyM2FmOTFi
+    YjdkOTg2MDUxYTI2MmNkYzNmMDEwNjVhYTMwNzU1OGQzZjRkYmNmZWViYmEw
+    YTJiODMzMDhjMzVlOTQ2NGVlMjVhOWY4MDdhZmEwMDkxOTJiOGU=
   data.tar.gz: !binary |-
-    NzU5YzE0YzFiZTkyOWM2NzU3YzFmNDg4NDEyMDVkOWMzZDRhMjllZTllODM4
-    NDY2MTdkYWI1ZmQ1MWMzMzRmZGYyMDgxOGMzMDFhOGRlYmE5YjgzMTRlNjQz
-    MWVjMTBkMGRlMWY3Y2NiMzA5NjRmNWIxZGIxNjQ4YjQxNmEyM2Q=
+    ZmMyZDllMDA5YWM5ZWY0MGEzMDY5OTUyMmNhMmYwMmViZjNmOGI4YWE4ZmNl
+    MmIwZGYxMDIzZWE3MGY0MTMxNjJhNzI4NjNmMTIyNzg4OWViNGNhOGQwNjk1
+    Yzg2ZjJlZGE3Nzk1NjE5ZjFlZDZiYjJmNTQzMGVjOTYwMTk3NmY=

data/lib/simple_serializer/deserializer.rb

@@ -1,14 +1,15 @@
 # Simple framelet for deserialization
 #
 #    class SomeDeserializer < SimpleSerializer::Deserializer
-#      data_attributes :site_id, :name, :category_id, :integration_key
+#      object_attributes :site_id, :name, :category, :integration_key
 #
-#      def integration_key(old_integration_key)
-#        "XX#{@data[:other_attr]}XX#{old_integration_key}XX"
+#      def integration_key
+#        "XX#{data[:other_attr]}XX#{data[:integration_key]}XX"
 #      end
 #
-#      def set_category_id(category_id)
-#        object.category = InventoryStatusCategory.from_id(category_id)
+#      # Set a field regardless of presence in data hash
+#      def set_site_id
+#        object.site_id = 99
 #      end
 #    end
 #
@@ -22,22 +23,22 @@
 module SimpleSerializer
 class Deserializer
   class << self
-    attr_accessor :_attributes
+    attr_accessor :_object_attributes
 
     def inherited(base)
-      base._attributes = []
+      base._object_attributes = []
     end
 
-    def data_attributes(*attrs)
-      @_attributes.concat attrs
+    def object_attributes(*attrs)
+      @_object_attributes.concat attrs
 
       attrs.each do |attr|
-        define_method attr do |datum|
-          datum
+        define_method attr do
+          @data[attr]
         end unless method_defined?(attr)
 
-        define_method "set_#{attr}" do |datum|
-          object.send("#{attr}=", send(attr, datum))
+        define_method "set_#{attr}" do
+          object.send("#{attr}=", send(attr)) if @data.has_key?(attr)
         end unless method_defined?("set_#{attr}")
       end
     end
@@ -51,7 +52,7 @@ class Deserializer
     end
   end
 
-  attr_accessor :object
+  attr_reader :object, :data
 
   def initialize(object, data)
     @object = object
@@ -59,8 +60,8 @@ class Deserializer
   end
 
   def deserialize
-    self.class._attributes.dup.each do |name|
-      send("set_#{name}", @data[name])
+    self.class._object_attributes.dup.each do |name|
+      send("set_#{name}")
     end
     object
   end

data/lib/simple_serializer/serializer.rb

@@ -4,7 +4,7 @@
 # and dependence on ActiveModel
 #
 #    class SomeSerializer < SimpleSerializer::Serializer
-#      attributes :id, :name, :category_id, :errors
+#      hash_attributes :id, :name, :category_id, :errors
 #
 #      def category_id
 #        object.category.try(:id)
@@ -25,14 +25,14 @@
 module SimpleSerializer
   class Serializer
     class << self
-      attr_accessor :_attributes
+      attr_accessor :_hash_attributes
 
       def inherited(base)
-        base._attributes = []
+        base._hash_attributes = []
       end
 
-      def attributes(*attrs)
-        @_attributes.concat attrs
+      def hash_attributes(*attrs)
+        @_hash_attributes.concat attrs
 
         attrs.each do |attr|
           define_method attr do
@@ -58,15 +58,15 @@ module SimpleSerializer
       @object = object
     end
 
-    def attributes
-      self.class._attributes.dup.each_with_object({}) do |name, hash|
+    def extract_attributes
+      self.class._hash_attributes.dup.each_with_object({}) do |name, hash|
         hash[name] = send(name)
       end
     end
 
     def serialize(_={})
       return nil if object.nil?
-      attributes
+      extract_attributes
     end
     alias :as_json :serialize
   end

data/lib/simple_serializer/version.rb

@@ -1,3 +1,3 @@
 module SimpleSerializer
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/simple_serializer.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["seank@nulogy.com"]
   spec.summary       = %q{Very simple framelet for serializing/deserializing objects to hashes.}
   spec.description   = %q{Very simple framelet for serializing/deserializing objects to hashes.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/nulogy/simple_serializer"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/unit/simple_serializer/deserializer_spec.rb

@@ -6,7 +6,7 @@ describe SimpleSerializer::Deserializer do
   let(:object) { double }
 
   class TestDeserializer < SimpleSerializer::Deserializer
-    data_attributes :field1
+    object_attributes :field1
   end
 
   describe 'deserialize' do
@@ -18,12 +18,18 @@ describe SimpleSerializer::Deserializer do
       expect(result).to be object
     end
 
+    it 'does not set attributes when the hash key is not set' do
+      expect(object).to_not receive(:field1=)
+
+      TestDeserializer.deserialize(object, {})
+    end
+
     describe 'attribute value transformation' do
       class TestTransformingDeserializer < SimpleSerializer::Deserializer
-        data_attributes :field1
+        object_attributes :field1
 
-        def field1(datum)
-          datum + 1
+        def field1
+          data[:field1] + 1
         end
       end
 
@@ -35,20 +41,19 @@ describe SimpleSerializer::Deserializer do
       end
     end
 
-    describe "attribute key transformation" do
+    describe 'attribute setter override' do
       class TestMappingDeserializer < SimpleSerializer::Deserializer
-        data_attributes :association_id
+        object_attributes :association
 
-        def set_association_id(datum)
-          object.association = datum
+        def set_association
+          object.association = 'static'
         end
       end
 
-      it 'maps keys' do
-        attrs = {association_id: 1}
-        expect(object).to receive(:association=).with(1)
+      it 'maps keys regardless of presence in data hash' do
+        expect(object).to receive(:association=).with('static')
 
-        TestMappingDeserializer.deserialize(object, attrs)
+        TestMappingDeserializer.deserialize(object, {})
       end
     end
   end

data/spec/unit/simple_serializer/serializer_spec.rb

@@ -6,7 +6,7 @@ describe SimpleSerializer::Serializer do
   let(:object) { double }
 
   class TestSerializer < SimpleSerializer::Serializer
-    attributes :field1, :field2
+    hash_attributes :field1, :field2
   end
 
   describe 'serialize' do
@@ -20,7 +20,7 @@ describe SimpleSerializer::Serializer do
 
     describe 'value transformation' do
       class TestTransformingSerializer < SimpleSerializer::Serializer
-        attributes :field1
+        hash_attributes :field1
 
         def field1
           object.field1 + 1
@@ -35,6 +35,18 @@ describe SimpleSerializer::Serializer do
         expect(result).to eq({field1: 2})
       end
     end
+
+    # This should work in a Rails controller when the ActiveModelSerializers gem is loaded:
+    #
+    #   render json: object, serializer: TestSerializer
+    it 'is api-compatible with ActiveModel::Serializer' do
+      object = double(field1: 1, field2: 2)
+      options = {}
+
+      result = TestSerializer.new(object, options).serialize(options)
+
+      expect(result).to eq({field1: 1, field2: 2})
+    end
   end
 
   describe 'serialize_array' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean Kirby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,7 +72,7 @@ files:
 - spec/unit/simple_serializer/deserializer_spec.rb
 - spec/unit/simple_serializer/serializer_spec.rb
 - spec/unit_spec_helper.rb
-homepage: ''
+homepage: https://github.com/nulogy/simple_serializer
 licenses:
 - MIT
 metadata: {}