ixtlan-babel 0.5.0 → 0.7.0

data/spec/model_serializer_spec.rb~

@@ -0,0 +1,158 @@
+require_relative 'spec_helper'
+require 'ixtlan/babel/model_serializer'
+require 'virtus'
+require 'multi_json'
+require 'json'
+
+class Address
+  include Virtus
+
+  attribute :street, String
+  attribute :zipcode, String
+end
+class Area
+  include Virtus
+
+  attribute :code, String
+  attribute :iso, String
+end
+class PhoneNumber
+  include Virtus
+
+  attribute :prefix, Integer
+  attribute :number, String
+  attribute :area, Area
+end
+class Person
+  include Virtus
+
+  attribute :id, String
+  attribute :name, String
+  attribute :address, Address
+
+  attr_accessor :phone_numbers, :age, :children_names
+
+  def phone_numbers
+    @phone_numbers ||= [PhoneNumber.new(
+        :prefix => 12,
+        :number => '123',
+        :area => Area.new( :code => '001', :iso => 'us' ) )]
+  end
+
+  def age
+    @age ||= 123
+  end
+
+  def children_names
+    @children_names ||= ['anna', 'jack', 'rama', 'mia']
+  end
+
+  def children_ages
+    @children_ages ||= [12, 3, 6, 9]
+  end
+end
+
+class ASerializer
+  include Ixtlan::Babel::ModelSerializer
+  attributes :id, :name
+end
+
+class MethodsSerializer < ASerializer
+  attributes :age, :children_names, :children_ages
+end
+
+class PhoneSerializer
+  include Ixtlan::Babel::ModelSerializer
+  attributes :prefix, :number
+end
+
+class AddressSerializer
+  include Ixtlan::Babel::ModelSerializer
+  attributes :street, :zipcode
+end
+
+class NestedListSerializer < ASerializer
+  attribute :address, AddressSerializer
+  attribute :phone_numbers, Array[PhoneSerializer]
+end
+class AreaSerializer
+  include Ixtlan::Babel::ModelSerializer
+  attributes :code, :iso
+end
+
+class Phone2Serializer < PhoneSerializer
+  attribute :area, AreaSerializer
+end
+class DeepNestedSerializer < NestedListSerializer
+  attribute :phone_numbers, Array[Phone2Serializer]
+end
+
+describe Ixtlan::Babel::ModelSerializer do
+  let( :person ) do
+    Person.new( :id => 987,
+                :name => 'me and the corner',
+                :address => Address.new( :street => 'Foo 12',
+                                          :zipcode => '12345' ) )
+  end
+
+  it 'should serialize with methods' do
+    data = MethodsSerializer.new( person )
+    result = MultiJson.load(data.to_json)
+    result.must_equal Hash[ "id"=>"987",
+                            "name"=>"me and the corner",
+                            "age"=>123,
+                            "children_names"=> [ "anna",
+                                                 "jack",
+                                                 "rama",
+                                                 "mia" ],
+                            "children_ages"=>[ 12, 3, 6, 9 ] ]
+    data.id.must_equal person.id
+    data.name.must_equal person.name
+    data.age.must_equal person.age
+    data.children_ages.must_equal person.children_ages
+  end
+
+  it 'should serialize' do
+    data = ASerializer.new( person )
+    result = MultiJson.load(data.to_json)
+    result.must_equal Hash[ "id"=>"987", "name"=>"me and the corner" ]
+    data.id.must_equal person.id
+    data.name.must_equal person.name
+    data.age.must_equal person.age
+  end
+
+  it 'should serialize with nested list' do
+    data = NestedListSerializer.new( person )
+    result = MultiJson.load( data.to_json )
+    result.must_equal Hash[ "id"=>"987", "name"=>"me and the corner" ,
+                            "address"=> {
+                              "street"=>"Foo 12",
+                              "zipcode"=>"12345"
+                            },
+                            "phone_numbers"=> [ { "prefix"=>12,
+                                                  "number"=>"123" } ] ]
+    data.phone_numbers[0].prefix.must_equal result['phone_numbers'][0]['prefix']
+    data.phone_numbers[0].number.must_equal result['phone_numbers'][0]['number']
+  end
+
+  it 'should serialize and deserialize with nested include' do
+    data = DeepNestedSerializer.new( person )
+    result = MultiJson.load( data.to_json )
+    result.must_equal Hash[ "id"=>"987", "name"=>"me and the corner" ,
+                            "address"=> {
+                              "street"=>"Foo 12",
+                              "zipcode"=>"12345"
+                            },
+                            "phone_numbers"=> [ { "prefix"=>12,
+                                                  "number"=>"123",
+                                                  "area"=> {
+                                                    "code"=>"001",
+                                                    "iso"=>"us"
+                                                  }
+                                                } ] ]
+    data.phone_numbers[0].prefix.must_equal result['phone_numbers'][0]['prefix']
+    data.phone_numbers[0].number.must_equal result['phone_numbers'][0]['number']
+    data.phone_numbers[0].area.code.must_equal result['phone_numbers'][0]['area']['code']
+    data.phone_numbers[0].area.iso.must_equal result['phone_numbers'][0]['area']['iso']
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-$LOAD_PATH << File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
+# single spec setup
+$LOAD_PATH.unshift File.expand_path( '../../lib', __FILE__ )
+
+#require 'awesome_print'
+
 gem 'minitest'
 require 'minitest/autorun'
-require 'json'
-require 'ixtlan-babel'

data/spec/spec_helper.rb~

@@ -0,0 +1,8 @@
+# single spec setup
+$LOAD_PATH.unshift File.expand_path( '../../lib', __FILE__ )
+
+require 'pry'
+require 'awesome_print'
+
+gem 'minitest'
+require 'minitest/autorun'

metadata

@@ -1,157 +1,138 @@
 --- !ruby/object:Gem::Specification
 name: ixtlan-babel
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
-- Christian Meier
-autorequire:
+- mkristian
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  prerelease: false
+        version: '10.3'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: minitest
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-  prerelease: false
+        version: '5.3'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: virtus
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-  prerelease: false
+        version: '1.10'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: multi_json
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  prerelease: false
+        version: '1.0'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: json
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-  prerelease: false
-  type: :development
-description: babel offers a filter for hashes and with that comes json/yaml/xml de/serialization of models which provides a hash representationi. possible models are activerecord, activemodel, resources from datamapper, virtus
+        version: '1.0'
+description: filter for hashes and serialization of POROs into a hash representation.
+  both the filter and hash reprensentation use a similar DSL to define which attributes
+  are used/allowed
 email:
 - m.kristian@web.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
 - lib/ixtlan-babel.rb
+- lib/ixtlan-babel.rb~
 - lib/ixtlan/babel/config.rb~
-- lib/ixtlan/babel/filter_config.rb
 - lib/ixtlan/babel/params_filter.rb~
-- lib/ixtlan/babel/model_filter.rb
+- lib/ixtlan/babel/common_filters.rb
+- lib/ixtlan/babel/common_filters.rb~
 - lib/ixtlan/babel/dm_validation_errors_serializer.rb~
 - lib/ixtlan/babel/hash_filter.rb~
-- lib/ixtlan/babel/params_filter.rb
 - lib/ixtlan/babel/serializer.rb~
 - lib/ixtlan/babel/factory.rb
 - lib/ixtlan/babel/abstract_filter.rb~
 - lib/ixtlan/babel/hash_only_filter.rb~
-- lib/ixtlan/babel/context.rb
-- lib/ixtlan/babel/dm_validation_errors_serializer.rb
+- lib/ixtlan/babel/model_serializer.rb
 - lib/ixtlan/babel/model_filter.rb~
-- lib/ixtlan/babel/serializer.rb
+- lib/ixtlan/babel/model_serializer.rb~
 - lib/ixtlan/babel/filter_config.rb~
 - lib/ixtlan/babel/context.rb~
-- lib/ixtlan/babel/abstract_filter.rb
 - lib/ixtlan/babel/factory.rb~
 - lib/ixtlan/babel/hash_filter.rb
-- spec/params_filter_dsl_spec.rb
 - spec/model_filter_spec.rb~
 - spec/params_filter_spec.rb~
 - spec/model_filter_with_methods_spec.rb~
-- spec/params_filter_spec.rb
 - spec/params_filter_dsl_spec.rb~
 - spec/hash_filter_spec.rb~
-- spec/model_filter_with_dsl_spec.rb
-- spec/model_filter_with_methods_spec.rb
+- spec/model_serializer_spec.rb~
+- spec/spec_helper.rb~
 - spec/spec_helper.rb
 - spec/hash_filter_spec.rb
 - spec/model_filter_with_methods.spec.rb~
-- spec/model_filter_spec.rb
-- MIT-LICENSE
-- README.md
+- spec/model_serializer_spec.rb
+- Rakefile
 - Gemfile
-homepage: https://github.com/mkristian/ixtlan-babel
+homepage: http://github.com/mkristian/ixtlan-babel
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+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.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
 specification_version: 4
-summary: babel offers a filter for hashes and with that comes json/yaml/xml de/serialization of models which provides a hash representation
+summary: filter for hashes and serialization of POROs into a hash representation
 test_files:
-- spec/params_filter_dsl_spec.rb
-- spec/params_filter_spec.rb
-- spec/model_filter_with_dsl_spec.rb
-- spec/model_filter_with_methods_spec.rb
 - spec/hash_filter_spec.rb
-- spec/model_filter_spec.rb
+- spec/model_serializer_spec.rb

data/lib/ixtlan/babel/abstract_filter.rb

@@ -1,46 +0,0 @@
-#
-# Copyright (C) 2013 Christian Meier
-#
-# 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.
-#
-require 'ixtlan/babel/context'
-module Ixtlan
-  module Babel
-    class AbstractFilter
-
-      attr_accessor :options
-
-      def options
-        @options || {}
-      end
-
-      def add_custom_serializers( map )
-        @map = map
-      end
-
-      def serialize( data )
-        if @map && ser = @map[ data.class.to_s ]
-          ser.call(data)
-        else
-          data
-        end
-      end
-
-    end
-  end
-end

data/lib/ixtlan/babel/context.rb

@@ -1,67 +0,0 @@
-#
-# Copyright (C) 2013 Christian Meier
-#
-# 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.
-#
-module Ixtlan
-  module Babel
-    class Context
-
-      def initialize( options )
-        @only = options[ :only ].collect { |o| o.to_s } if options[ :only ]
-        @except = ( options[:except] || [] ).collect { |e| e.to_s }
-
-        opts = options[ :include ]
-        @include = case opts
-                   when Array
-                     opts.collect { |i| i.to_s }
-                   when Hash
-                     Hash[ opts.collect { |k,v| [ k.to_s, v ] } ]
-                   else
-                     []
-                   end
-        @methods = (options[:methods] || []).collect { |m| m.to_s }
-      end
-
-      def methods
-        @methods + ( @include.is_a?( Array ) ? @include : @include.keys ) 
-      end
-
-      def allowed?( key )
-        ( @only && @only.include?( key ) ) || ( @only.nil? && !@except.include?( key ) ) || @methods.include?( key )
-      end
-
-      def include?( key )
-        @include.include?( key ) || @methods.include?( key ) 
-      end
-
-      def array?
-        @include.is_a?( Array )
-      end
-
-      def []( key )
-        if @include.include?( key )
-          self.class.new( @include.is_a?( Array ) ? {} : @include[ key ] )
-        else
-          self.class.new( @methods.is_a?( Array ) ? {} : @methods[ key ] )
-        end
-      end
-
-    end
-  end
-end