kanade 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dba2011d31645033e7e65d4d964804457e84a7ff
-  data.tar.gz: 0c762aaa23b5e9d9d491a9ab79a9bb410b1aa2fb
+  metadata.gz: 25723d77b3f99e8994da9fd4aa44eba091198831
+  data.tar.gz: 9458dddba1f8fdff1041ab11cd79a5c83e9c8183
 SHA512:
-  metadata.gz: bf867ed2aef8b77e996ec53596abb54cb38ddbf960862e9980b528fafa7714efe7b87fdb82d281cb83f357421dec047013630d314958b09947d4d3095c366b09
-  data.tar.gz: 0befa0235c6abdfe73090c88a7309b7a596a5f7cdffa170df670a479bce3019faa511068b73b30e2be87e5fe3229bf9094d2d66469cca6d8a9bdc1ff27c54c83
+  metadata.gz: 66d8f6cdb94ce27c648957e5089d7884101b0087a5916da253acfab3f4c2905b31ac8117282c1b73785fcad7d0589ce4c0692e6147609402e0f0cbdbffe4ddd1
+  data.tar.gz: b5b0884a344d5f26b314231d569e6c300ead110eac7dd47217f396378c9ecc9573c35af615c23bbe0779880c03e5bee3973e9692ce813fa4ecdc6d84a7a38390

data/.editorconfig

@@ -4,6 +4,7 @@
 root = true
 
 [*]
+end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true

data/.gitignore

@@ -5,8 +5,10 @@
 doc
 .yardoc
 
+# Development file
+.devel
+pkg
+
 # IDE-specific
 *.swp
 
-# Development file
-.devel

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanade (0.1.0.beta1)
+    kanade (0.1.0.beta2)
       activesupport
 
 GEM

data/lib/kanade/converter/bool.rb

@@ -1,22 +1,24 @@
-module Kanade
-  module Converter
-    class Bool < Base
-      Engine.register_converter!(self)
-
-      def serialize(term, _)
-        return nil if term.nil?
-        term.to_s
-      end
-      def deserialize(term, _)
-        return nil if term.nil?
-        return term if term.is_a?(FalseClass)
-        return term if term.is_a?(TrueClass)
-        term ? true : false
-      end
-
-      def from_string(term)
-        term.downcase === 'true'
-      end
-    end
-  end
-end
+module Kanade
+  module Converter
+    class Bool < Base
+      Engine.register_converter!(self)
+
+      def serialize(term, _)
+        return nil if term.nil?
+        return true if term.is_a?(TrueClass)
+        return false if term.is_a?(FalseClass)
+        raise NotSupportedError.new("Trying to serialize a bool, but given unknown object")
+      end
+      def deserialize(term, _)
+        return nil if term.nil?
+        return term if term.is_a?(FalseClass)
+        return term if term.is_a?(TrueClass)
+        term ? true : false
+      end
+
+      def from_string(term)
+        term.downcase === 'true'
+      end
+    end
+  end
+end

data/lib/kanade/converter/dto.rb

@@ -0,0 +1,17 @@
+module Kanade
+  module Converter
+    class Dto < Base
+      Engine.register_converter!(self)
+
+      def serialize(term, field_info)
+        term
+      end
+
+      def deserialize(term, field_info)
+        return nil if term.nil?
+        raise NotSupportedError.new('DTO-based field only can be filled with nil / respective DTO object') unless term.is_a?(field_info.options[:of])
+        return term
+      end
+    end
+  end
+end

data/lib/kanade/converter/list.rb

@@ -3,14 +3,31 @@ module Kanade
     class List < Base
       Engine.register_converter!(self)
 
-      def serialize(term, _)
+      def serialize(term, field_info)
         return nil if term.nil?
-        term.to_s
       end
-      def deserialize(term, _)
+      def deserialize(term, field_info)
         return nil if term.nil?
-        return term if term.is_a?(BigDecimal)
-        ::BigDecimal.new(term)
+        #binding.pry unless term.is_a?(Array)
+        raise NotSupportedError.new("Value must be array or nil!") unless term.is_a?(Array)
+
+        term.map do |t|
+          conversion_method =
+            if field_info.options[:of].is_a?(Class) and field_info.options[:of] < Kanade::Dto
+              :dto
+            else
+              field_info.options[:of]
+            end
+
+          # Kalau begini caranya, field_info bisa enggak konsisten.
+          # Ada yang nyimpen informasinya dirinya sendiri, ada juga
+          # yang nyimpen informasi parent-nya.
+          converter = Engine.converter(conversion_method)
+          binding.pry if converter.nil?
+          raise NotSupportedError.new("Unregistered conversion method: #{conversion_method}") if converter.nil?
+          converter.deserialize(t, field_info)
+        end
+
       end
     end
   end

data/lib/kanade/converter/time.rb

@@ -1,25 +1,26 @@
-require 'time'
-
-module Kanade
-  module Converter
-    class Time < Base
-      Engine.register_converter!(self)
-
-      def serialize(term, _)
-        return nil if term.nil?
-        term.iso8601(0)
-      end
-      def deserialize(term, _)
-        return nil if term.nil?
-        return term if term.is_a?(Time)
-        return term if term.is_a?(Date)
-        # WARNING: Parse does not really parse TZ!
-        # Consider using ActiveSupport?
-        ::Time.parse(term)
-      end
-
-      configurable :time_format, :iso8601
-      configurable :time_msec_round, 0
-    end
-  end
-end
+require 'time'
+
+module Kanade
+  module Converter
+    class Time < Base
+      Engine.register_converter!(self)
+
+      def serialize(term, _)
+        return nil if term.nil?
+        term.iso8601(0)
+      end
+      def deserialize(term, _)
+        return nil if term.nil?
+        return term if term.is_a?(::Time)
+        return term if term.is_a?(Date)
+        # WARNING: Parse does not really parse TZ!
+        # Consider using ActiveSupport?
+
+        ::Time.parse(term)
+      end
+
+      configurable :time_format, :iso8601
+      configurable :time_msec_round, 0
+    end
+  end
+end

data/lib/kanade/dto.rb

@@ -1,47 +1,56 @@
-module Kanade
-  class Dto
-    class_attribute :__fields
-    class_attribute :__definer
-
-    def self.field(name_sym, *options)
-      raise NotSupportedError.new('Field must be a symbol!') unless name_sym.is_a?(Symbol)
-      raise NotSupportedError.new('Cant use reserved name (__fields)') if name == :__fields
-
-      if self.__definer != self.name
-        self.__fields = array_dup(self.__fields) || []
-        self.__definer = self.name
-      end
-
-      name = name_sym.to_s.freeze
-      variable_ref = "@#{name}".freeze
-      option = options.last
-      converter = Engine.converter(option[:as])
-      key_name = option[:with]
-
-      raise Kanade::NotSupportedError.new("Converter #{option[:as]} is not registered") if converter.nil?
-
-      field = FieldInfo.new
-      field.converter = converter
-      field.key_json = key_name
-      field.key_ruby = name
-      field.sym = name_sym
-      field.options = option
-
-      define_method "#{name}=" do |value|
-        instance_variable_set(variable_ref, field.convert(value))
-      end
-
-      define_method "#{name}" do
-        instance_variable_get(variable_ref)
-      end
-
-      self.__fields << field
-    end
-
-    private
-      def self.array_dup(arr)
-        return nil if arr.nil?
-        arr.map(&:dup)
-      end
-  end
-end
+module Kanade
+  class Dto
+    class_attribute :__fields
+    class_attribute :__definer
+
+    def self.field(name_sym, *options)
+      raise NotSupportedError.new('Field must be a symbol!') unless name_sym.is_a?(Symbol)
+      raise NotSupportedError.new('Cant use reserved name (__fields)') if name == :__fields
+
+      if self.__definer != self.name
+        self.__fields = array_dup(self.__fields) || []
+        self.__definer = self.name
+      end
+
+      option = options.last
+
+      conversion_method = option[:as]
+
+      if option[:as].is_a?(Class) and option[:as] < Dto
+        conversion_method = :dto
+        option[:of] = option[:as]
+        option[:as] = :dto
+      end
+
+      name = name_sym.to_s.freeze
+      variable_ref = "@#{name}".freeze
+      converter = Engine.converter(conversion_method)
+      key_name = option[:with]
+
+      raise Kanade::NotSupportedError.new("Converter #{conversion_method} is not registered") if converter.nil?
+
+      field = FieldInfo.new
+      field.converter = converter
+      field.key_json = key_name
+      field.key_ruby = name
+      field.sym = name_sym
+      field.options = option
+
+      define_method "#{name}=" do |value|
+        instance_variable_set(variable_ref, field.convert(value))
+      end
+
+      define_method "#{name}" do
+        instance_variable_get(variable_ref)
+      end
+
+      self.__fields << field
+    end
+
+    private
+      def self.array_dup(arr)
+        return nil if arr.nil?
+        arr.map(&:dup)
+      end
+  end
+end

data/lib/kanade/engine.rb

@@ -1,87 +1,149 @@
-require 'json'
-
-module Kanade
-  class Engine
-    @@converters = {}
-    @@name_resolvers = {}
-
-    def initialize(configuration=nil)
-      @config = configuration || Kanade::Config.default
-    end
-
-    def configure
-      yield @config
-    end
-
-    def serialize(object)
-      traverse_field(object).to_json
-    end
-
-    def traverse_field(object)
-      raise NotSupportedError.new("Serializer only works for Kanade::Dto, and #{object.class.name} does not extend Kanade::Dto") unless object.is_a?(Kanade::Dto)
-
-      stacks = []
-      result = {}
-      stacks += object.__fields
-
-      object.__fields.each do |field|
-        name = field.key_json || name_to_json(field.sym)
-        value = field.converter.serialize(object.send(field.sym), field)
-        result[name] = value
-      end
-
-      result
-    end
-
-    def deserialize(definition, json)
-      raise NotSupportedError.new("Can not process non-class!") unless definition.is_a?(Class)
-      raise NotSupportedError.new("Can not process other than DTO!") unless definition < Dto
-      result = definition.new
-      raw = JSON.parse json
-      result.__fields.each do |field|
-        name = field.key_json || name_to_json(field.sym)
-        value = raw[name]
-        next if value.nil?
-
-        result.send("#{field.key_ruby}=", value)
-      end
-      result
-    end
-
-    def self.register_converter!(klass)
-      key = klass.name.split('::').last.underscore.to_sym
-
-      return if key === :base
-
-      # We don't support multiple converter for now
-      raise NotSupportedError.new("#{key} registered twice") if not @@converters[key].nil?
-
-      @@converters[key] = klass.new
-    end
-
-    def self.register_name_resolver!(klass)
-      key = klass.name.split('::').last.underscore.to_sym
-
-      return if key === :base
-
-      # We don't support multiple converter for now
-      raise NotSupportedError.new("#{key} registered twice") if not @@name_resolvers[key].nil?
-
-      @@name_resolvers[key] = klass.new
-    end
-
-    def name_to_ruby(string)
-      strategy = @config.contract
-      @@name_resolvers[strategy].deserialize(string)
-    end
-
-    def name_to_json(sym)
-      strategy = @config.contract
-      @@name_resolvers[strategy].serialize(sym)
-    end
-
-    def self.converter(sym)
-      @@converters[sym]
-    end
-  end
-end
+require 'json'
+
+module Kanade
+  class Engine
+    @@converters = {}
+    @@name_resolvers = {}
+
+    def initialize(configuration=nil)
+      @config = configuration || Kanade::Config.default
+    end
+
+    def configure
+      yield @config
+    end
+
+    def serialize(object)
+      traverse_field(object).to_json
+    end
+
+    def traverse_field(object)
+      return nil if object.nil?
+      raise NotSupportedError.new("Serializer only works for Kanade::Dto, and #{object.class.name} does not extend Kanade::Dto") unless object.class < Kanade::Dto
+
+      result = {}
+
+      object.__fields.each do |field|
+        name = field.key_json || name_to_json(field.sym)
+
+        if field.options[:as] == :list
+          value = serialize_list(object.send(field.sym), field)
+        elsif field.options[:as] == :dto
+          value = traverse_field(object.send(field.sym))
+        else
+          value = field.converter.serialize(object.send(field.sym), field)
+        end
+        result[name] = value
+      end
+
+      result
+    end
+
+    def serialize_list(list, field_info)
+      return nil if list.nil?
+      list.map do |entry|
+        if field_info.options[:of].is_a?(Class) and field_info.options[:of] < Dto
+          traverse_field(entry)
+        else
+          conversion_method = field_info.options[:of]
+          # TODO how to refer to static field?
+          converter = Engine.converter(conversion_method)
+
+          raise NotSupportedError.new("Can not process unknown converter! #{conversion_method}") if converter.nil?
+
+          converter.serialize(entry, field_info)
+        end
+      end
+    end
+
+    def deserialize(definition, json)
+      raise NotSupportedError.new("Can not process non-class!") unless definition.is_a?(Class)
+      raise NotSupportedError.new("Can not process other than DTO!") unless definition < Dto
+
+      hash = JSON.parse(json)
+      deserialize_object(definition, hash)
+    end
+
+    # IF engine contains deserialization logic, we can no more
+    # unit test the converters. Seems like, the conversion logic
+    # must be outsourced to its respective converter
+    def deserialize_object(definition, hash)
+      return nil if hash.nil?
+      result = definition.new
+      result.__fields.each do |field|
+        name = field.key_json || name_to_json(field.sym)
+
+        if field.options[:as] == :list
+          value = deserialize_list(hash[name], field)
+        elsif field.options[:as] == :dto
+          value = deserialize_object(field.options[:of], hash[name])
+        else
+          value = hash[name]
+        end
+
+        next if value.nil?
+
+        result.send("#{field.key_ruby}=", value)
+      end
+      result
+    end
+
+    def deserialize_list(value, field_info)
+      return nil if value.nil?
+
+      # Catatan pribadi: Jadi "of" itu harusnya mengandung field definition?
+      # bukan of: Product, tapi of: {as: :dto, of: Product}
+      # dengan field definition ini, kita bisa membuat hal yang lebih konfleks, misal:
+      # of: {as: :symbol, mapping: {success: 'RES_SUCCESS'}}
+      value.map do |v|
+        if field_info.options[:of].is_a?(Class) and field_info.options[:of] < Dto
+          deserialize_object(field_info.options[:of], v)
+        else
+          conversion_method = field_info.options[:of]
+          # TODO how to refer to static field?
+          converter = Engine.converter(conversion_method)
+
+          raise NotSupportedError.new("Can not process unknown converter! #{conversion_method}") if converter.nil?
+
+          converter.deserialize(v, field_info)
+        end
+      end
+    end
+
+    def self.register_converter!(klass)
+      key = klass.name.split('::').last.underscore.to_sym
+
+      return if key === :base
+
+      # We don't support multiple converter for now
+      raise NotSupportedError.new("#{key} registered twice") if not @@converters[key].nil?
+
+      @@converters[key] = klass.new
+    end
+
+    def self.register_name_resolver!(klass)
+      key = klass.name.split('::').last.underscore.to_sym
+
+      return if key === :base
+
+      # We don't support multiple converter for now
+      raise NotSupportedError.new("#{key} registered twice") if not @@name_resolvers[key].nil?
+
+      @@name_resolvers[key] = klass.new
+    end
+
+    def name_to_ruby(string)
+      strategy = @config.contract
+      @@name_resolvers[strategy].deserialize(string)
+    end
+
+    def name_to_json(sym)
+      strategy = @config.contract
+      @@name_resolvers[strategy].serialize(sym)
+    end
+
+    def self.converter(sym)
+      @@converters[sym]
+    end
+  end
+end

data/lib/kanade/version.rb

@@ -1,3 +1,3 @@
 module Kanade
-  VERSION = '0.1.0.beta1'
+  VERSION = '0.1.0.beta2'
 end

data/spec/fixtures/catalog_camel_case.json

@@ -1,19 +1,20 @@
-{
-  "id": 3,
-  "products": [
-    {
-      "id": 100,
-      "name": "Cat Plushie",
-      "expireAt": null,
-      "price": "19.95",
-      "available": true
-    },
-    {
-      "id": 101,
-      "name": "Taco",
-      "expireAt": "2016-09-21 13:52:44 +0700",
-      "price": "5.0",
-      "available": true
-    }
-  ]
-}
+{
+  "id": 3,
+  "serials": [100, 105, 444],
+  "products": [
+    {
+      "id": 100,
+      "name": "Cat Plushie",
+      "expireAt": null,
+      "price": "19.95",
+      "available": true
+    },
+    {
+      "id": 101,
+      "name": "Taco",
+      "expireAt": "2016-09-21T13:52:44+07:00",
+      "price": "5.0",
+      "available": true
+    }
+  ]
+}

data/spec/fixtures/refund_report.json

@@ -6,5 +6,10 @@
     "expireAt": "2019-03-30T06:52:44+09:00",
     "price": "99.95",
     "available": true
+  },
+  "addendumReport" : {
+    "ID": 1234,
+    "affectedProduct": null,
+    "addendumReport": null
   }
 }

data/spec/fixtures/refund_report.rb

@@ -1,4 +1,5 @@
-class RefundReport
+class RefundReport < Kanade::Dto
   field :refund_id, as: :fixnum, with: 'ID'
   field :affected_product, as: Product
+  field :addendum_report, as: RefundReport
 end

data/spec/integration/ignore_unknown_field_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe 'Serialization Integration' do
+  it 'tests should be exist' do
+    skip 'TODO'
+  end
+end

data/spec/integration/simple_deserialization_integration_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 require_relative '../fixtures/product'
 require_relative '../fixtures/product_wrong'
+require_relative '../fixtures/refund_report'
+require_relative '../fixtures/catalog'
 
 RSpec.describe 'Deserialization Integration' do
 
@@ -53,6 +55,70 @@ RSpec.describe 'Deserialization Integration' do
   end
 
   context 'Array of products' do
+    let(:object) do
+      @engine.deserialize(Catalog, json_of(:catalog_camel_case))
+    end
+
+    subject do
+      object
+    end
+
+    it 'has correct id' do
+      expect(subject.id).to eq(3)
+      expect(subject.id).to_not eq('3')
+    end
+
+    it 'has serials of fixnum' do
+      expect(subject.serials).to eq([100, 105, 444])
+      expect(subject.serials).to_not eq([100, '105', 444])
+    end
+
+    it 'has multiple products' do
+      expect(subject.products.count).to eq(2)
+    end
+
+    it 'has correct order of products' do
+      expect(subject.products[0].id).to eq(100)
+      expect(subject.products[0].name).to eq('Cat Plushie')
+      expect(subject.products[0].expire_at).to be_nil
+      expect(subject.products[0].price).to eq(BigDecimal.new('19.95'))
+      expect(subject.products[0].price).to_not eq('19.95')
+      expect(subject.products[0].available).to eq(true)
+
+      expect(subject.products[1].id).to eq(101)
+      expect(subject.products[1].name).to eq('Taco')
+      expect(subject.products[1].expire_at).to eq(Time.parse('2016-09-21T13:52:44+07:00'))
+      expect(subject.products[1].price).to eq(BigDecimal.new('5.0'))
+      expect(subject.products[1].price).to_not eq('5.0')
+      expect(subject.products[1].available).to eq(true)
+    end
+  end
+
+  context 'Nested object' do
+    let(:object) do
+      @engine.deserialize(RefundReport, json_of(:refund_report))
+    end
+
+    subject do
+      object
+    end
+
+    it 'has correct ID' do
+      expect(subject.refund_id).to eq(9321)
+    end
 
+    it 'has correct nested product' do
+      expect(subject.affected_product.id).to eq(451)
+      expect(subject.affected_product.name).to eq('Digital Camera')
+      expect(subject.affected_product.expire_at).to eq(Time.parse('2019-03-30T06:52:44+09:00'))
+      expect(subject.affected_product.price).to eq(BigDecimal.new('99.95'))
+      expect(subject.affected_product.available).to eq(true)
+    end
+
+    it 'has correct addendum report' do
+      expect(subject.addendum_report.refund_id).to eq(1234)
+      expect(subject.addendum_report.affected_product).to be_nil
+      expect(subject.addendum_report.addendum_report).to be_nil
+    end
   end
 end

data/spec/integration/simple_serialization_integration_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
+require_relative '../fixtures/catalog'
 require_relative '../fixtures/product'
 require_relative '../fixtures/product_wrong'
+require_relative '../fixtures/refund_report'
 
 RSpec.describe 'Serialization Integration' do
 
@@ -69,6 +71,58 @@ RSpec.describe 'Serialization Integration' do
   end
 
   context 'Array of products' do
+    subject { @engine.serialize(target) }
 
+    let(:target) do
+      catalog = Catalog.new
+      catalog.serials = [100, 105, 444]
+      catalog.id = 3
+
+      product1 = Product.new
+      product1.id = 100
+      product1.name = 'Cat Plushie'
+      product1.expire_at = nil
+      product1.price = '19.95'
+      product1.available = true
+
+      product2 = Product.new
+      product2.id = 101
+      product2.name = 'Taco'
+      product2.expire_at = '2016-09-21T13:52:44+07:00'
+      product2.price = 5
+      product2.available = true
+
+      catalog.products = []
+      catalog.products << product1
+      catalog.products << product2
+      catalog
+    end
+
+    it { is_expected.to be_json_of(:catalog_camel_case) }
+  end
+
+  context 'Nested object' do
+    subject { @engine.serialize(target) }
+
+    let(:target) do
+      report = RefundReport.new
+      report.refund_id = '9321'
+
+      product = Product.new
+      product.id = 451
+      product.name = 'Digital Camera'
+      product.expire_at = Time.parse('2019-03-30T06:52:44+09:00')
+      product.price = BigDecimal.new('99.95')
+      product.available = true
+
+      addendum_report = RefundReport.new
+      addendum_report.refund_id = 1234
+
+      report.addendum_report = addendum_report
+      report.affected_product = product
+      report
+    end
+
+    it { is_expected.to be_json_of :refund_report  }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kanade
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - Mufid Afif
@@ -133,6 +133,7 @@ files:
 - lib/kanade/converter/base.rb
 - lib/kanade/converter/big_decimal.rb
 - lib/kanade/converter/bool.rb
+- lib/kanade/converter/dto.rb
 - lib/kanade/converter/fixnum.rb
 - lib/kanade/converter/float.rb
 - lib/kanade/converter/list.rb
@@ -157,6 +158,7 @@ files:
 - spec/fixtures/refund_report.rb
 - spec/fixtures/simple_product.json
 - spec/integration/class_consistency_spec.rb
+- spec/integration/ignore_unknown_field_spec.rb
 - spec/integration/simple_deserialization_integration_spec.rb
 - spec/integration/simple_serialization_integration_spec.rb
 - spec/matchers/json_matcher.rb
@@ -200,6 +202,7 @@ test_files:
 - spec/fixtures/refund_report.rb
 - spec/fixtures/simple_product.json
 - spec/integration/class_consistency_spec.rb
+- spec/integration/ignore_unknown_field_spec.rb
 - spec/integration/simple_deserialization_integration_spec.rb
 - spec/integration/simple_serialization_integration_spec.rb
 - spec/matchers/json_matcher.rb