kanade 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dba2011d31645033e7e65d4d964804457e84a7ff
+  data.tar.gz: 0c762aaa23b5e9d9d491a9ab79a9bb410b1aa2fb
+SHA512:
+  metadata.gz: bf867ed2aef8b77e996ec53596abb54cb38ddbf960862e9980b528fafa7714efe7b87fdb82d281cb83f357421dec047013630d314958b09947d4d3095c366b09
+  data.tar.gz: 0befa0235c6abdfe73090c88a7309b7a596a5f7cdffa170df670a479bce3019faa511068b73b30e2be87e5fe3229bf9094d2d66469cca6d8a9bdc1ff27c54c83

data/.editorconfig

@@ -0,0 +1,14 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+# [*.md]
+# trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,12 @@
+# Alphabetically by category first, then by term.
+# For sorting, omit dot for dot files
+
+# Documentation
+doc
+.yardoc
+
+# IDE-specific
+*.swp
+
+# Development file
+.devel

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.1
+notifications:
+  email:
+    on_success: change
+on_failure: change

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    kanade (0.1.0.beta1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    timecop (0.8.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  kanade!
+  pry
+  rake
+  rspec (~> 3.5)
+  timecop
+  yard
+
+BUNDLED WITH
+   1.13.1

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Muhammad Mufid Afif
+
+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-id.md

@@ -0,0 +1,81 @@
+# Rubygem Kanade!
+
+> かなでる 【奏でる】
+> ichidan verb → conjugation / intransitive:
+> to play an instrument (esp. string instruments)
+
+Kanade membuat lantunan kode yang harmonis antara kode Ruby
+dan kode JSON. Apapun sumbernya. JSON-REST? Ayo. Hanya membaca
+dari lokal? Tidak apa. Kanade menerima untaian string dari JSON
+dan menerjemahkannya. Kanade pun dapat melakukan sebaliknya,
+dengan menerjemahkan object transfer data ke JSON.
+
+## Instalasi
+
+    gem 'kanade'
+
+## Menggunakan Kanade
+
+Buatlah sebuah berkas DTO, misalnya:
+
+    class List < Kanade::Dto
+      field :id, as: :fixnum
+      field :name, as: :string
+      field :expire_at, as: :date_time
+      field :price, as: :big_decimal
+      field :available, as: :bool
+    end
+
+    class Product < Kanade::Dto
+      field :id, as: :fixnum
+      field :name, as: :string
+      field :expire_at, as: :date_time
+      field :price, as: :big_decimal
+      field :available, as: :bool
+    end
+
+Terjemahkan dari JSON:
+
+    File.read()
+
+## Sintaks
+
+Untuk mendefinisikan field:
+
+    field :field_name,
+          as: :int, # Tipe data
+          from: 'TheFieldName', # Nama field di JSON apabila tidak standar
+          allow_null: true, # Ubah menjadi false agar Kanade melempar exception ketika bertemu nilai yang null
+
+Tipe data yang tersedia dari asal (built-in):
+
+- `:big_decimal`
+- `:bool`
+- `:fixnum`
+- `:float`
+- `:string`
+- `:symbol`
+- `:time`
+- Atau, objek apapun yang meng-extend `Kanade::Dto`
+
+## Menambahkan Pengkonversian untuk Tipe Data Khusus
+
+    engine = Kanade::Engine.new
+    engine.configure |c|
+      c.add_converter :
+    end
+
+## Strategi Penamaan Field
+
+Secara default, Kanade akan menggunakan mekanisme penamaan
+snake_case. Tidak dapat dipungkiri bahwa penamaan ini
+tidak lazim untuk beberapa landasan, misalnya di Java.
+Sesuaikan saja Anda menerima dari data dengan kontrak apa.
+
+    engine = Kanade::Engine.new
+    engine.configure |c|
+      c.naming_strategy :pascal_case
+    end
+
+Kanade akan otomatis mengkonversi penamaan di JSON menjadi
+konvensi Ruby (`snake_case`)

data/README.md

@@ -0,0 +1,3 @@
+# Kanade - Harmonize External API with Strong-typed Ruby Object [![Build Status](https://travis-ci.org/mufid/kanade.png)](https://travis-ci.org/mufid/kanade)
+
+A JSON parser (intended for client). Like Gson / Jackson / JSON.NET, but for Ruby.

data/ROADMAP.md

@@ -0,0 +1,11 @@
+# Roadmap
+
+- 0.x.x --> Early generation of working Kanade
+- 1.x.x --> First mature release. Expect internal API changes (Naming strategy, Converter, Configurable)
+- 2.x.x --> Second mature release. Expect external API changes (Engine, DTO)
+
+
+Use module?
+http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html
+
+or not?

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+require "rspec/core/rake_task"
+require "yard"
+require 'bundler'
+
+begin
+  Bundler.setup :default, :development
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => error
+  $stderr.puts error.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit error.status_code
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Generate all of the docs"
+YARD::Rake::YardocTask.new do |config|
+  config.files = Dir["lib/**/*.rb"]
+end
+
+desc "Default: run tests and generate docs"
+task :default => [ :spec, :yard ]

data/kanade.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'kanade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kanade"
+  spec.version       = Kanade::VERSION
+  spec.authors       = ["Mufid Afif"]
+  spec.email         = ["mufid@outlook.com"]
+  spec.summary       = %q{ Strong-typed JSON to Ruby object serializer/deserializer }
+  spec.description   = %q{ Strong-typed JSON to Ruby object serializer/deserializer }
+  spec.homepage      = "https://github.com/mufid/kanade"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.start_with?("bower_components") || f.start_with?("website") || f.start_with?("bin") || f.start_with?("example")
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # We use active support inflection, case conversion, and a lot more.
+  # Yes yes yes we need to be independent from active support, but this
+  # is good enough for now.
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "timecop"
+end

data/lib/kanade/all.rb

@@ -0,0 +1,14 @@
+require_relative 'engine'
+require_relative 'dto'
+require_relative 'config/default'
+require_relative 'field_info'
+
+require_relative 'naming_strategy/base'
+(Dir["#{File.dirname(__FILE__)}/naming_strategy/*.rb"].reject{|x| x.match(/base/) }).each do |path|
+  require path
+end
+
+require_relative 'converter/base'
+(Dir["#{File.dirname(__FILE__)}/converter/*.rb"].reject{|x| x.match(/base/) }).each do |path|
+  require path
+end

data/lib/kanade/config/default.rb

@@ -0,0 +1,10 @@
+module Kanade
+  class Config
+    def self.default
+      Config.new
+    end
+
+    attr_accessor :contract
+    attr_accessor :enum
+  end
+end

data/lib/kanade/converter/base.rb

@@ -0,0 +1,19 @@
+module Kanade
+  module Converter
+    class Base
+      # STORED OBJECT --> JSON String
+      def serialize(term, field_info)
+        raise NotSupportedError
+      end
+
+      # JSON String / Input object --> Ruby object
+      def deserialize(term, field_info)
+        raise NotSupportedError
+      end
+
+      def self.configurable(name, default)
+      end
+
+    end
+  end
+end

data/lib/kanade/converter/big_decimal.rb

@@ -0,0 +1,19 @@
+require 'bigdecimal'
+
+module Kanade
+  module Converter
+    class BigDecimal < 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?(BigDecimal)
+        ::BigDecimal.new(term)
+      end
+    end
+  end
+end

data/lib/kanade/converter/bool.rb

@@ -0,0 +1,22 @@
+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

data/lib/kanade/converter/fixnum.rb

@@ -0,0 +1,15 @@
+module Kanade
+  module Converter
+    class Fixnum < Base
+      Engine.register_converter!(self)
+      def serialize(term, _)
+        return nil if term.nil?
+        term.to_i
+      end
+      def deserialize(term, _)
+        return nil if term.nil?
+        term.to_i
+      end
+    end
+  end
+end

data/lib/kanade/converter/float.rb

@@ -0,0 +1,16 @@
+module Kanade
+  module Converter
+    class Float < Base
+      Engine.register_converter!(self)
+      def serialize(term, _)
+        return nil if term.nil?
+        term.to_f
+      end
+      def deserialize(term, _)
+        return nil if term.nil?
+        return term if term.is_a?(Float)
+        term.to_f
+      end
+    end
+  end
+end

data/lib/kanade/converter/list.rb

@@ -0,0 +1,17 @@
+module Kanade
+  module Converter
+    class List < 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?(BigDecimal)
+        ::BigDecimal.new(term)
+      end
+    end
+  end
+end

data/lib/kanade/converter/string.rb

@@ -0,0 +1,17 @@
+module Kanade
+  module Converter
+    class String < 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?(String)
+        term.to_s
+      end
+    end
+  end
+end

data/lib/kanade/converter/symbol.rb

@@ -0,0 +1,20 @@
+module Kanade
+  module Converter
+    class Symbol < Base
+      Engine.register_converter!(self)
+
+      def serialize(term, field_info)
+        return nil if term.nil?
+        term.to_s
+      end
+
+      def deserialize(term, field_info)
+        return nil if term.nil?
+        return term if term.is_a?(String)
+        term.to_s
+      end
+
+      configurable :symbol_contract, :camel_case
+    end
+  end
+end

data/lib/kanade/converter/time.rb

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,47 @@
+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

data/lib/kanade/engine.rb

@@ -0,0 +1,87 @@
+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

data/lib/kanade/field_info.rb

@@ -0,0 +1,15 @@
+module Kanade
+  class FieldInfo
+    # Set the value of this field. Might
+    # be type casted
+    def convert(term)
+      converter.deserialize(term, self)
+    end
+
+    attr_accessor :converter
+    attr_accessor :sym
+    attr_accessor :key_json
+    attr_accessor :key_ruby
+    attr_accessor :options
+  end
+end

data/lib/kanade/naming_strategy/base.rb

@@ -0,0 +1,20 @@
+module Kanade
+  module NamingStrategy
+    class Base
+      ##
+      # Ruby --> JSON
+      def serialize(term)
+        raise NotImplementedException
+      end
+      ##
+      # JSON --> Ruby
+      def deserialize(term)
+        raise NotImplementedException
+      end
+
+      def self.configurable(name)
+        # Do nothing for now
+      end
+    end
+  end
+end

data/lib/kanade/naming_strategy/camel_case.rb

@@ -0,0 +1,14 @@
+module Kanade
+  module NamingStrategy
+    class CamelCase < Base
+      Engine.register_name_resolver!(self)
+
+      def serialize(term)
+        ActiveSupport::Inflector.camelize(term, false)
+      end
+      def deserialize(term)
+        term.underscore.to_sym
+      end
+    end
+  end
+end