simple_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGU3YmExMWM5OGZjZjc0ZGZjMDM5YzQxZTc0MDdmZWZkNDI1NmExYQ==
+  data.tar.gz: !binary |-
+    MjcyZmFhZTUzZjkxZjcwYjZlOGYwM2M0NTMzNDRlMWU1ZmI2Njg2NQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTE5MmQ4NmVjMWMzYjg1MjVlNDVkZGYzZjIyMmNhYTdjMTViMGViZTlkNzE5
+    MDE1NjBjMTk3MDMyMDAyZjdjYmE5NzFmMTY5NDU2YmIyYThhNTc2ODAxMzE1
+    MzM3ZmE1NmQ0OTYwYjBhMjE0MzMxNzE0Y2VmYzFhZmNmN2U5ZmY=
+  data.tar.gz: !binary |-
+    NzU5YzE0YzFiZTkyOWM2NzU3YzFmNDg4NDEyMDVkOWMzZDRhMjllZTllODM4
+    NDY2MTdkYWI1ZmQ1MWMzMzRmZGYyMDgxOGMzMDFhOGRlYmE5YjgzMTRlNjQz
+    MWVjMTBkMGRlMWY3Y2NiMzA5NjRmNWIxZGIxNjQ4YjQxNmEyM2Q=

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_serializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nulogy Corporation
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# SimpleSerializer
+
+Simple framelet for serializing/deserializing objects to hashes.
+
+API compatible with ActiveModel::Serializer but without all the complexity
+and dependence on ActiveModel
+
+# Serializer Usage
+
+```
+class SomeSerializer < SimpleSerializer::Serializer
+  attributes :id, :name, :category_id, :errors
+
+  def category_id
+    object.category.try(:id)
+  end
+
+  def errors
+    ActiveModelErrorsSerializer.serialize_errors(object.errors, true) if object.errors.any?
+  end
+end
+```
+
+Use it:
+
+```
+SomeSerializer.serialize(object)
+SomeSerializer.new(object).serialize
+
+SomeSerializer.serialize_array([object])
+```
+
+# Deserializer Usage
+
+```
+class SomeDeserializer < SimpleSerializer::Deserializer
+  data_attributes :site_id, :name, :category_id, :integration_key
+
+  def integration_key(old_integration_key)
+    "XX#{@data[:other_attr]}XX#{old_integration_key}XX"
+  end
+
+  def set_category_id(category_id)
+    object.category = InventoryStatusCategory.from_id(category_id)
+  end
+end
+```
+
+Use it:
+
+```
+SomeDeserializer.deserialize(object, data)
+SomeDeserializer.new(object, data).deserialize
+
+SomeDeserializer.deserialize_array([object1, object2, ...], [data1, data2, ...])
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/simple_serializer/deserializer.rb

@@ -0,0 +1,68 @@
+# Simple framelet for deserialization
+#
+#    class SomeDeserializer < SimpleSerializer::Deserializer
+#      data_attributes :site_id, :name, :category_id, :integration_key
+#
+#      def integration_key(old_integration_key)
+#        "XX#{@data[:other_attr]}XX#{old_integration_key}XX"
+#      end
+#
+#      def set_category_id(category_id)
+#        object.category = InventoryStatusCategory.from_id(category_id)
+#      end
+#    end
+#
+# Usage:
+#
+#    SomeDeserializer.deserialize(object, data)
+#    SomeDeserializer.new(object, data).deserialize
+#
+#    SomeDeserializer.deserialize_array([object1, object2, ...], [data1, data2, ...])
+#
+module SimpleSerializer
+class Deserializer
+  class << self
+    attr_accessor :_attributes
+
+    def inherited(base)
+      base._attributes = []
+    end
+
+    def data_attributes(*attrs)
+      @_attributes.concat attrs
+
+      attrs.each do |attr|
+        define_method attr do |datum|
+          datum
+        end unless method_defined?(attr)
+
+        define_method "set_#{attr}" do |datum|
+          object.send("#{attr}=", send(attr, datum))
+        end unless method_defined?("set_#{attr}")
+      end
+    end
+
+    def deserialize_array(objects, data)
+      objects.zip(data).map { |obj, datum| deserialize(obj, datum) }
+    end
+
+    def deserialize(object, data)
+      self.new(object, data).deserialize
+    end
+  end
+
+  attr_accessor :object
+
+  def initialize(object, data)
+    @object = object
+    @data = data
+  end
+
+  def deserialize
+    self.class._attributes.dup.each do |name|
+      send("set_#{name}", @data[name])
+    end
+    object
+  end
+end
+end

data/lib/simple_serializer/serializer.rb

@@ -0,0 +1,73 @@
+# Simple framelet for serialization.
+#
+# API compatible with ActiveModel::Serializer but without all the complexity
+# and dependence on ActiveModel
+#
+#    class SomeSerializer < SimpleSerializer::Serializer
+#      attributes :id, :name, :category_id, :errors
+#
+#      def category_id
+#        object.category.try(:id)
+#      end
+#
+#      def errors
+#        ActiveModelErrorsSerializer.serialize_errors(object.errors, true) if object.errors.any?
+#      end
+#    end
+#
+# Usage:
+#
+#    SomeSerializer.serialize(object)
+#    SomeSerializer.new(object).serialize
+#
+#    SomeSerializer.serialize_array([object])
+#
+module SimpleSerializer
+  class Serializer
+    class << self
+      attr_accessor :_attributes
+
+      def inherited(base)
+        base._attributes = []
+      end
+
+      def attributes(*attrs)
+        @_attributes.concat attrs
+
+        attrs.each do |attr|
+          define_method attr do
+            object.send(attr)
+          end unless method_defined?(attr)
+        end
+      end
+
+      def serialize_array(objects)
+        objects.map { |obj| serialize(obj) }
+      end
+
+      def serialize(object)
+        self.new(object).serialize
+      end
+
+      alias :as_json :serialize
+    end
+
+    attr_accessor :object
+
+    def initialize(object, _={})
+      @object = object
+    end
+
+    def attributes
+      self.class._attributes.dup.each_with_object({}) do |name, hash|
+        hash[name] = send(name)
+      end
+    end
+
+    def serialize(_={})
+      return nil if object.nil?
+      attributes
+    end
+    alias :as_json :serialize
+  end
+end

data/lib/simple_serializer/version.rb

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

data/lib/simple_serializer.rb

@@ -0,0 +1,4 @@
+require 'simple_serializer/version'
+
+module SimpleSerializer
+end

data/simple_serializer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_serializer"
+  spec.version       = SimpleSerializer::VERSION
+  spec.authors       = ["Sean Kirby"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/unit/simple_serializer/deserializer_spec.rb

@@ -0,0 +1,68 @@
+require 'unit_spec_helper'
+require 'simple_serializer/deserializer'
+
+describe SimpleSerializer::Deserializer do
+
+  let(:object) { double }
+
+  class TestDeserializer < SimpleSerializer::Deserializer
+    data_attributes :field1
+  end
+
+  describe 'deserialize' do
+    it 'sets attributes' do
+      attrs = {field1: 1}
+      expect(object).to receive(:field1=).with(1)
+
+      result = TestDeserializer.deserialize(object, attrs)
+      expect(result).to be object
+    end
+
+    describe 'attribute value transformation' do
+      class TestTransformingDeserializer < SimpleSerializer::Deserializer
+        data_attributes :field1
+
+        def field1(datum)
+          datum + 1
+        end
+      end
+
+      it 'maps values' do
+        attrs = {field1: 1}
+        expect(object).to receive(:field1=).with(2)
+
+        TestTransformingDeserializer.deserialize(object, attrs)
+      end
+    end
+
+    describe "attribute key transformation" do
+      class TestMappingDeserializer < SimpleSerializer::Deserializer
+        data_attributes :association_id
+
+        def set_association_id(datum)
+          object.association = datum
+        end
+      end
+
+      it 'maps keys' do
+        attrs = {association_id: 1}
+        expect(object).to receive(:association=).with(1)
+
+        TestMappingDeserializer.deserialize(object, attrs)
+      end
+    end
+  end
+
+  describe 'deserialize_array' do
+    it 'deserializes many objects' do
+      data = [{field1: 1}, {field1: 3}]
+      expect(object).to receive(:field1=).with(1)
+
+      object2 = double
+      expect(object2).to receive(:field1=).with(3)
+
+      result = TestDeserializer.deserialize_array([object, object2], data)
+      expect(result).to eq [object, object2]
+    end
+  end
+end

data/spec/unit/simple_serializer/serializer_spec.rb

@@ -0,0 +1,50 @@
+require 'unit_spec_helper'
+require 'simple_serializer/serializer'
+
+describe SimpleSerializer::Serializer do
+
+  let(:object) { double }
+
+  class TestSerializer < SimpleSerializer::Serializer
+    attributes :field1, :field2
+  end
+
+  describe 'serialize' do
+    it 'sets attributes' do
+      object = double(field1: 1, field2: 2)
+
+      result = TestSerializer.serialize(object)
+
+      expect(result).to eq({field1: 1, field2: 2})
+    end
+
+    describe 'value transformation' do
+      class TestTransformingSerializer < SimpleSerializer::Serializer
+        attributes :field1
+
+        def field1
+          object.field1 + 1
+        end
+      end
+
+      it 'maps values' do
+        object = double(field1: 1)
+
+        result = TestTransformingSerializer.serialize(object)
+
+        expect(result).to eq({field1: 2})
+      end
+    end
+  end
+
+  describe 'serialize_array' do
+    it 'serializes many objects' do
+      object1 = double(field1: 1, field2: 2)
+      object2 = double(field1: 3, field2: 4)
+
+      result = TestSerializer.serialize_array([object1, object2])
+
+      expect(result).to eq([{field1: 1, field2: 2}, {field1: 3, field2: 4}])
+    end
+  end
+end

data/spec/unit_spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simple_serializer'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: simple_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Kirby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Very simple framelet for serializing/deserializing objects to hashes.
+email:
+- seank@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_serializer.rb
+- lib/simple_serializer/deserializer.rb
+- lib/simple_serializer/serializer.rb
+- lib/simple_serializer/version.rb
+- simple_serializer.gemspec
+- spec/unit/simple_serializer/deserializer_spec.rb
+- spec/unit/simple_serializer/serializer_spec.rb
+- spec/unit_spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Very simple framelet for serializing/deserializing objects to hashes.
+test_files:
+- spec/unit/simple_serializer/deserializer_spec.rb
+- spec/unit/simple_serializer/serializer_spec.rb
+- spec/unit_spec_helper.rb