kanade 0.1.0.beta1

data/lib/kanade/naming_strategy/pascal_case.rb

@@ -0,0 +1,12 @@
+module Kanade
+  module NamingStrategy
+    class PascalCase < Base
+      Engine.register_name_resolver!(self)
+
+      def serialize
+      end
+      def deserialize
+      end
+    end
+  end
+end

data/lib/kanade/naming_strategy/snake_case.rb

@@ -0,0 +1,16 @@
+module Kanade
+  module NamingStrategy
+    class SnakeCase < Base
+      Engine.register_name_resolver!(self)
+
+      configurable :always_upcase do |value|
+        false unless value.is_a(FalseClass) or value.is_a(TrueClass)
+      end
+
+      def serialize
+      end
+      def deserialize
+      end
+    end
+  end
+end

data/lib/kanade/version.rb

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

data/lib/kanade.rb

@@ -0,0 +1,16 @@
+# Kanade core
+
+if File.exists?(File.join(File.dirname(__FILE__), '..', '.devel'))
+  puts ' --> WARNING: You are using development mode of this gem'
+  require 'pry'
+end
+
+module Kanade
+  class NotImplementedException < StandardError; end
+  class NotSupportedError < StandardError; end
+end
+
+# TODO: Dependency to active support to become optional
+# require 'active_support/core_ext/class/attribute'
+require 'active_support/all'
+require 'kanade/all'

data/spec/converter/string_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe Kanade::Converter::String do
+
+  let(:converter) { Kanade::Converter::String.new }
+
+  context 'can serialize' do
+    subject { converter.serialize(term, nil) }
+
+    context 'nil object' do
+      let(:term) { nil }
+      it { is_expected.to be_nil }
+    end
+
+    context 'nil string' do
+      let(:term) { 'nil' }
+      it { is_expected.to eq('nil') }
+    end
+
+    context 'real string' do
+      let(:term) { 'mantaap' }
+      it { is_expected.to eq('mantaap') }
+    end
+  end
+
+  context 'can handle value conversion' do
+    subject { converter.serialize(term, nil) }
+
+    context 'test from int 3' do
+      let(:term) { 3 }
+      it { is_expected.to eq('3') }
+      it { is_expected.to_not eq(3) }
+    end
+
+    context 'test from int 100' do
+      let(:term) { 100 }
+      it { is_expected.to eq('100') }
+      it { is_expected.to_not eq(100) }
+    end
+  end
+
+  context 'can deserialize' do
+    subject { converter.deserialize(term, nil) }
+
+    context 'string of number' do
+      let(:term) { '100' }
+      it { is_expected.to eq('100') }
+    end
+
+    context 'nil' do
+      let(:term) { nil }
+      it { is_expected.to be_nil }
+    end
+
+    context 'normal string' do
+      let(:term) { 'Mantaaaap' }
+      it { is_expected.to eq('Mantaaaap') }
+    end
+  end
+
+end

data/spec/fixtures/catalog.rb

@@ -0,0 +1,5 @@
+class Catalog < Kanade::Dto
+  field :id, as: :fixnum
+  field :serials, as: :list, of: :fixnum
+  field :products, as: :list, of: Product
+end

data/spec/fixtures/catalog_camel_case.json

@@ -0,0 +1,19 @@
+{
+  "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
+    }
+  ]
+}

data/spec/fixtures/catalog_pascal_case.json

@@ -0,0 +1,19 @@
+{
+  "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
+    }
+  ]
+}

data/spec/fixtures/product.rb

@@ -0,0 +1,7 @@
+class Product < Kanade::Dto
+  field :id, as: :fixnum
+  field :name, as: :string
+  field :expire_at, as: :time
+  field :price, as: :big_decimal
+  field :available, as: :bool
+end

data/spec/fixtures/product_wrong.rb

@@ -0,0 +1,7 @@
+class ProductWrong < Kanade::Dto
+  field :id, as: :string
+  field :name, as: :string
+  field :expire_at, as: :time
+  field :price, as: :big_decimal
+  field :available, as: :bool
+end

data/spec/fixtures/refund_report.json

@@ -0,0 +1,10 @@
+{
+  "ID": 9321,
+  "affectedProduct": {
+    "id": 451,
+    "name": "Digital Camera",
+    "expireAt": "2019-03-30T06:52:44+09:00",
+    "price": "99.95",
+    "available": true
+  }
+}

data/spec/fixtures/refund_report.rb

@@ -0,0 +1,4 @@
+class RefundReport
+  field :refund_id, as: :fixnum, with: 'ID'
+  field :affected_product, as: Product
+end

data/spec/fixtures/simple_product.json

@@ -0,0 +1,7 @@
+{
+  "id": 101,
+  "name": "Super Duper Enak",
+  "expireAt": "2017-10-10T06:52:44+09:00",
+  "price": "11.0",
+  "available": null
+}

data/spec/integration/class_consistency_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class Udang < Kanade::Dto
+  field :shrimp, as: :string
+end
+
+class Cumi < Kanade::Dto
+  field :edible, as: :bool
+end
+
+class Mangga < Kanade::Dto
+  field :edible, as: :string
+end
+
+class ManggaBali < Mangga
+  field :color, as: :string
+  field :available, as: :bool
+end
+
+RSpec.describe 'Class Consistency' do
+
+  it 'does not respond to non-responding method' do
+    expect(Cumi.new).to respond_to(:edible)
+    expect(Udang.new).to respond_to(:shrimp)
+    expect(Kanade::Dto.new).to_not respond_to(:shrimp)
+    expect(Kanade::Dto.new).to_not respond_to(:edible)
+    expect(Mangga.new).to_not respond_to(:color)
+  end
+
+  it 'behave with correct field' do
+    cumi = Cumi.new
+    cumi.edible = true
+    mangga = Mangga.new
+    mangga.edible = 'yes'
+
+    expect(cumi.edible).to eq(true)
+    expect(mangga.edible).to eq('yes')
+  end
+
+  it 'behave with correct inheritance' do
+    m = ManggaBali.new
+    m.available = 'true'
+    m.edible = 'yes'
+
+    expect(m.available).to eq(true)
+    expect(m.edible).to eq('yes')
+  end
+
+end

data/spec/integration/simple_deserialization_integration_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require_relative '../fixtures/product'
+require_relative '../fixtures/product_wrong'
+
+RSpec.describe 'Deserialization Integration' do
+
+  before(:all) do
+    # Make sure everything has been cleaned up
+    raise StandardError unless @engine.nil?
+
+    @engine = Kanade::Engine.new
+    @engine.configure do |config|
+      config.contract = :camel_case
+      config.enum = :upper_snake_case
+    end
+  end
+
+  context 'Single Product' do
+
+    let(:object) do
+      @engine.deserialize(Product, json_of(:simple_product))
+    end
+
+    context 'correct id' do
+      subject { object.id }
+      it { is_expected.to eq(101) }
+      it { is_expected.not_to eq('101') }
+    end
+
+    context 'correct name' do
+      subject { object.name }
+      it { is_expected.to eq('Super Duper Enak') }
+    end
+
+    context 'correct time conversion' do
+      subject { object.expire_at }
+      it { is_expected.to eq(Time.parse('2017-10-10T06:52:44+09:00')) }
+      it { is_expected.to_not eq(Time.parse('2017-10-10T06:52:44+08:00')) }
+      it { is_expected.to_not eq(Time.parse('2017-10-09T19:52:44+00:00')) }
+    end
+
+    context 'correct price' do
+      subject { object.price }
+      it { is_expected.to eq(BigDecimal.new(11))}
+      it { is_expected.to eq(BigDecimal.new('11.0'))}
+      it { is_expected.to_not eq(BigDecimal.new('1.1'))}
+    end
+
+    context 'correct availability' do
+      subject { object.available }
+      it { is_expected.to be_nil }
+    end
+  end
+
+  context 'Array of products' do
+
+  end
+end

data/spec/integration/simple_serialization_integration_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require_relative '../fixtures/product'
+require_relative '../fixtures/product_wrong'
+
+RSpec.describe 'Serialization Integration' do
+
+  before(:all) do
+    # Make sure everything has been cleaned up
+    raise StandardError unless @engine.nil?
+
+    @engine = Kanade::Engine.new
+    @engine.configure do |config|
+      config.contract = :camel_case
+      config.enum = :upper_snake_case
+    end
+  end
+
+  context 'Single Product' do
+
+    def populate(product)
+      product.id = 101
+      product.name = 'Super Duper Enak'
+      # TODO Do not use ISO8601. Natural date seems broken in Ruby,
+      # but serialization should be seamless. It should work on
+      # our own, too!
+      # product.expire_at = 'Tue, 10 Oct 2017 06:52:44 GMT+9'
+      product.expire_at = '2017-10-10T06:52:44+09:00'
+      product.available = nil
+      product.price = 11
+
+      product
+    end
+
+    let(:target) do
+      populate(Product.new)
+    end
+
+    let(:target_wrong) do
+      populate(ProductWrong.new)
+    end
+
+    it 'can serialize correctly' do
+      result = @engine.serialize(target)
+      expect(result).to be_json_of(:simple_product)
+    end
+
+    it 'can handle value conversion' do
+      target.id = "101"
+      result = @engine.serialize(target)
+      expect(result).to be_json_of(:simple_product)
+    end
+
+    it 'should be fail when a field is set null' do
+      target.price = nil
+      result = @engine.serialize(target)
+      expect(result).to_not be_json_of(:simple_product)
+    end
+
+    it 'should be fail when a field is set differently' do
+      target.price = 3232
+      result = @engine.serialize(target)
+      expect(result).to_not be_json_of(:simple_product)
+    end
+
+    it 'should be fail when data type is wrong' do
+      result = @engine.serialize(target_wrong)
+      expect(result).to_not be_json_of(:simple_product)
+    end
+  end
+
+  context 'Array of products' do
+
+  end
+end

data/spec/matchers/json_matcher.rb

@@ -0,0 +1,13 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_json_of do |fixture_name|
+  path = File.join(File.dirname(__FILE__), '..', 'fixtures', "#{fixture_name.to_s}.json")
+  expected_json = JSON.minify File.read path
+  match do |actual|
+    # return false unless actual.is_a?(String)
+    actual.strip == expected_json.strip
+  end
+  failure_message do |actual|
+    "Expecting '#{expected_json.strip}', but got '#{actual.strip}'"
+  end
+end

data/spec/naming_strategy/camel_case_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe Kanade::NamingStrategy::CamelCase do
+  subject do
+    Kanade::NamingStrategy::CamelCase.new
+  end
+
+  it 'can serialize' do
+    expect(subject.serialize(:camel_case)).to eq('camelCase')
+    expect(subject.serialize(:oneword)).to eq('oneword')
+  end
+
+  it 'can deserialize' do
+    expect(subject.deserialize('camelCase')).to eq(:camel_case)
+    expect(subject.deserialize('oneword')).to eq(:oneword)
+  end
+
+  it 'does not understand dictionary' do
+    expect(subject.serialize(:xml_serializer)).to eq('xmlSerializer')
+    expect(subject.deserialize('xmlSerializer')).to eq(:xml_serializer)
+    expect(subject.deserialize('XMLSerializer')).to eq(:xml_serializer)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'kanade'
+require_relative 'matchers/json_matcher'
+require_relative 'support/json_minify'
+require_relative 'support/json_reader'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.include JsonReader
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/deep_hash_compare.rb

@@ -0,0 +1 @@
+deep_hash_compare.rb

data/spec/support/json_minify.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2014 Geoff Youngs
+# 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.
+#
+# https://github.com/geoffyoungs/json-minify-rb
+#
+module JSON
+  module Minify
+    def self.included(mod)
+      mod.send(:extend, self)
+    end
+    def minify(str)
+      ss, buf = StringScanner.new(str), ''
+
+      until ss.eos?
+        # Remove whitespace
+        if s = ss.scan(/\s+/)
+
+        # Scan punctuation
+        elsif s = ss.scan(/[{},:\]\[]/)
+          buf << s
+
+        # Scan strings
+        elsif s = ss.scan(/""|(".*?[^\\])?"/)
+          buf << s
+
+        # Scan reserved words
+        elsif s = ss.scan(/(true|false|null)/)
+          buf << s
+
+        # Scan numbers
+        elsif s = ss.scan(/-?\d+([.]\d+)?([eE][-+]?[0-9]+)?/)
+          buf << s
+
+        # Remove C++ style comments
+        elsif s = ss.scan(%r<//>)
+          ss.scan_until(/(\r?\n|$)/)
+
+        # Remove C style comments
+        elsif s = ss.scan(%r'/[*]')
+          ss.scan_until(%r'[*]/') or raise SyntaxError, "Unterminated /*...*/ comment - #{ss.rest}"
+
+        # Anything else is invalid JSON
+        else
+          raise SyntaxError, "Unable to pre-scan string: #{ss.rest}"
+        end
+      end
+      buf
+    end
+
+    def minify_parse(buf)
+      JSON.parse(minify(buf))
+    end
+  end
+end
+
+module JSON
+  include JSON::Minify
+end

data/spec/support/json_reader.rb

@@ -0,0 +1,6 @@
+module JsonReader
+  def json_of(fixture_name)
+    path = File.join(File.dirname(__FILE__), '..', 'fixtures', "#{fixture_name.to_s}.json")
+    json = File.read path
+  end
+end