zerial 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32d1173deb0ea69c92627917636ed2ec9f98b56d
+  data.tar.gz: 6c2fbd532dba93d53468c90a32393583c17af1b8
+SHA512:
+  metadata.gz: e192859c118aa84b8ceae970d22b6e913ec4046cca9ff9b4556cd0f76b6d0ae779b4c651617c26638cae86d4e79fe32983497eff6aa7b5e2575559907c7435d0
+  data.tar.gz: d1d66324a0bc4d2d86de2e39f6963fbe565e5946bfefc912ff367e7b0ef708d78ff984a88e80b0cdbd26e10f1e88bb7be1f4e73653694b365330d75ac0a68b7a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jell
+
+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,39 @@
+# Zerial
+
+Serializer/Deserializer tools
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zerial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zerial
+
+## Usage
+
+A serializer is an object with 4 methods: `to_json`, `as_json`, `from_json` and `from_loaded_json`.
+
+`to_json` and `from_json` are the main entry points of the
+serializer/deserializer, and `as_json` and `from_loaded_json` are
+intermediate processing methods.
+
+See examples in `spec/lib/zerial`
+
+## TODO
+
+* Remove dependency on ActiveSupport
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zerial/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/zerial/base_serializer.rb

@@ -0,0 +1,13 @@
+module Zerial
+  module BaseSerializer
+    def to_json (object)
+      as_json(object).to_json
+    end
+
+    def from_json (json_string)
+      from_loaded_json(
+        JSON.load(json_string)
+      )
+    end
+  end
+end

data/lib/zerial/big_decimal_serializer.rb

@@ -0,0 +1,14 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module BigDecimalSerializer
+    extend BaseSerializer
+    def self.as_json (object)
+      object.to_s
+    end
+
+    def self.from_loaded_json (json)
+      BigDecimal.new(json)
+    end
+  end
+end

data/lib/zerial/collection_serializer.rb

@@ -0,0 +1,24 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  class CollectionSerializer
+    include BaseSerializer
+    attr_reader :element_serializer
+
+    def initialize (element_serializer)
+      @element_serializer = element_serializer
+    end
+
+    def as_json (collection)
+      collection.map { |object|
+        element_serializer.as_json(object)
+      }
+    end
+
+    def from_loaded_json (json)
+      json.map { |element|
+        element_serializer.from_loaded_json(element)
+      }
+    end
+  end
+end

data/lib/zerial/date_serializer.rb

@@ -0,0 +1,15 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module DateSerializer
+    extend BaseSerializer
+
+    def self.as_json(object)
+      object.as_json
+    end
+
+    def self.from_loaded_json (json)
+      Date.parse(json)
+    end
+  end
+end

data/lib/zerial/default_serializer.rb

@@ -0,0 +1,15 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module DefaultSerializer
+    extend BaseSerializer
+
+    def self.as_json (object)
+      object.as_json
+    end
+
+    def self.from_loaded_json (json)
+      json
+    end
+  end
+end

data/lib/zerial/immutable_record_serializer.rb

@@ -0,0 +1,42 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  class ImmutableRecordSerializer
+    include BaseSerializer
+
+    attr_reader :record_class, :serializers
+
+    def initialize (record_class, serializers: {})
+      @record_class = record_class
+      @serializers = serializers
+    end
+
+    def as_json (object)
+      record_class::ATTRIBUTES.reduce({}) do |attributes, attr|
+        attributes.merge(
+          attr.to_s => serializer_for_attribute(attr).as_json(
+            object.public_send(attr)
+          )
+        )
+      end
+    end
+
+    def from_loaded_json (json)
+      record_class.new(
+        record_class::ATTRIBUTES.reduce({}) { |attributes, attr|
+          attributes.merge(
+            attr => serializer_for_attribute(attr).from_loaded_json(
+              json.fetch(attr.to_s)
+            )
+          )
+        }
+      )
+    end
+
+    private
+
+    def serializer_for_attribute (attr)
+      serializers.fetch(attr, DefaultSerializer)
+    end
+  end
+end

data/lib/zerial/money_serializer.rb

@@ -0,0 +1,19 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module MoneySerializer
+    extend BaseSerializer
+    def self.as_json (object)
+      {
+        "cents" => object.cents,
+        "currency" => object.currency_as_string
+      }
+    end
+
+    def self.from_loaded_json (json)
+      Money.new(
+        json.fetch("cents"), json.fetch("currency")
+      )
+    end
+  end
+end

data/lib/zerial/nil_serializer.rb

@@ -0,0 +1,14 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module NilSerializer
+    extend BaseSerializer
+    def self.as_json (object)
+      nil
+    end
+
+    def self.from_loaded_json (json)
+      nil
+    end
+  end
+end

data/lib/zerial/timestamp_serializer.rb

@@ -0,0 +1,14 @@
+require 'zerial/base_serializer'
+
+module Zerial
+  module TimestampSerializer
+    extend BaseSerializer
+    def self.as_json (object)
+      object.iso8601
+    end
+
+    def self.from_loaded_json (json)
+      Time.zone.parse(json)
+    end
+  end
+end

data/lib/zerial/version.rb

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

data/lib/zerial.rb

@@ -0,0 +1,17 @@
+require "zerial/version"
+
+require "zerial/default_serializer"
+
+require "zerial/big_decimal_serializer"
+require "zerial/date_serializer"
+require "zerial/money_serializer"
+require "zerial/nil_serializer"
+require "zerial/timestamp_serializer"
+
+require "zerial/collection_serializer"
+require "zerial/immutable_record_serializer"
+
+require "active_support/core_ext"
+
+module Zerial
+end

data/spec/lib/zerial_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'zerial'
+require 'bigdecimal'
+require 'money'
+require 'immutable_record'
+
+describe Zerial do
+  before do
+    Time.zone = "UTC"
+  end
+
+  def expect_correct_roundtrip (serializer, object)
+    expect(
+      serializer.from_json(serializer.to_json(object))
+    ).to eq(object)
+  end
+
+  describe Zerial::DefaultSerializer do
+    it "uses default as_json" do
+      expect_correct_roundtrip(
+        Zerial::DefaultSerializer,
+        {"hello" => [1, "2"]}
+      )
+    end
+  end
+
+  describe Zerial::BigDecimalSerializer do
+    it "works in a roundtrip" do
+      expect_correct_roundtrip(
+        Zerial::BigDecimalSerializer,
+        BigDecimal.new("12.234")
+      )
+    end
+  end
+
+  describe Zerial::DateSerializer do
+    it "works in a roundtrip" do
+      expect_correct_roundtrip(
+        Zerial::DateSerializer,
+        Date.new(2013, 1 ,1)
+      )
+    end
+  end
+
+  describe Zerial::MoneySerializer do
+    it "works in a roundtrip" do
+      expect_correct_roundtrip(
+        Zerial::MoneySerializer,
+        Money.new(10_00, "SEK")
+      )
+    end
+  end
+
+  describe Zerial::NilSerializer do
+    it "always returns nil when serializing and deserializing" do
+      expect(Zerial::NilSerializer.to_json("hello")).to eq("null")
+      expect(Zerial::NilSerializer.from_json('{"hello": 1}')).to be_nil
+    end
+  end
+
+  describe Zerial::TimestampSerializer do
+    it "works in a roundtrip" do
+      expect_correct_roundtrip(
+        Zerial::TimestampSerializer,
+        Time.current.change(usec: 0)
+      )
+    end
+  end
+
+  describe Zerial::CollectionSerializer do
+    it "serializes the elements of an array with a given serializer" do
+      expect_correct_roundtrip(
+        Zerial::CollectionSerializer.new(
+          Zerial::BigDecimalSerializer
+        ),
+        [BigDecimal.new("10"), BigDecimal.new("0.11111")]
+      )
+    end
+  end
+
+  describe Zerial::ImmutableRecordSerializer do
+    let(:record_class) {
+      ImmutableRecord.new(:attr1, :attr2)
+    }
+    it "can serialize an ImmutableRecord" do
+      expect_correct_roundtrip(
+        Zerial::ImmutableRecordSerializer.new(record_class),
+        record_class.new(attr1: "hello", attr2: 2)
+      )
+    end
+
+    it "can accept specific serializers per attribute" do
+      expect_correct_roundtrip(
+        Zerial::ImmutableRecordSerializer.new(
+          record_class,
+          serializers: {
+            attr1: Zerial::BigDecimalSerializer,
+            attr2: Zerial::MoneySerializer
+          }
+        ),
+        record_class.new(
+          attr1: BigDecimal.new("10"),
+          attr2: Money.new(10, "SEK")
+        )
+      )
+    end
+
+    it "works with deeply nested stuff" do
+      expect_correct_roundtrip(
+        Zerial::ImmutableRecordSerializer.new(
+          record_class,
+          serializers: {
+            attr1: Zerial::CollectionSerializer.new(
+              Zerial::ImmutableRecordSerializer.new(
+                record_class,
+                serializers: {
+                  attr1: Zerial::MoneySerializer,
+                  attr2: Zerial::TimestampSerializer
+                }
+              )
+            ),
+            attr2: Zerial::DateSerializer
+          }
+        ),
+        record_class.new(
+          attr1: [
+            record_class.new(
+              attr1: Money.new(10, "SEK"),
+              attr2: Time.current.change(usec: 0)
+            ),
+            record_class.new(
+              attr1: Money.new(20, "EUR"),
+              attr2: 1.day.ago.change(usec: 0)
+            ),
+          ],
+          attr2: Date.today
+        )
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/zerial.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zerial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zerial"
+  spec.version       = Zerial::VERSION
+  spec.authors       = ["Jell"]
+  spec.email         = ["jean-louis@jawaninja.com"]
+  spec.summary       = %q{Simple JSON serializer}
+  spec.description   = %q{Simple JSON serializer/parser}
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "money"
+  spec.add_development_dependency "immutable_record"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: zerial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: money
+  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'
+- !ruby/object:Gem::Dependency
+  name: immutable_record
+  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: Simple JSON serializer/parser
+email:
+- jean-louis@jawaninja.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zerial.rb
+- lib/zerial/base_serializer.rb
+- lib/zerial/big_decimal_serializer.rb
+- lib/zerial/collection_serializer.rb
+- lib/zerial/date_serializer.rb
+- lib/zerial/default_serializer.rb
+- lib/zerial/immutable_record_serializer.rb
+- lib/zerial/money_serializer.rb
+- lib/zerial/nil_serializer.rb
+- lib/zerial/timestamp_serializer.rb
+- lib/zerial/version.rb
+- spec/lib/zerial_spec.rb
+- spec/spec_helper.rb
+- zerial.gemspec
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple JSON serializer
+test_files:
+- spec/lib/zerial_spec.rb
+- spec/spec_helper.rb
+has_rdoc: