ixtlan-babel 0.2.1 → 0.3.0

data/lib/ixtlan-babel.rb

@@ -1,4 +1,2 @@
 require 'ixtlan/babel/serializer'
-require 'ixtlan/babel/deserializer'
 require 'ixtlan/babel/factory'
-require 'ixtlan/babel/no_timestamp_serializer'

data/lib/ixtlan/babel/factory.rb

@@ -29,11 +29,11 @@ module Ixtlan
         @map.merge!(custom_serializers)
       end
 
-      def add(clazz, &block)
-        @map[clazz.to_s] = block
+      def add( clazz, &block )
+        @map[ clazz.to_s ] = block
       end
 
-      def new(resource)
+      def new_serializer( resource )
         if resource.respond_to?(:model)
           model = resource.model
         elsif resource.respond_to? :collect
@@ -41,16 +41,25 @@ module Ixtlan
             return EmptyArraySerializer.new
           else
             r = resource.first
-            model = r.respond_to?(:model) ? r.model : r.class
+            model = r.respond_to?( :model ) ? r.model : r.class
           end
         else
           model = resource.class
         end
-        ser = const_retrieve("#{model}Serializer").new(resource)
-        ser.add_custom_serializers(@map)
+        ser = const_retrieve( "#{model}Serializer" ).new( resource )
+        ser.add_custom_serializers( @map )
         ser
       end
 
+      def new( resource )
+        warn 'DEPRECATED use new_serializer instead'
+        new_serializer( resource )
+      end
+
+      def new_filter( clazz )
+        const_retrieve( "#{clazz}Filter" ).new( clazz )
+      end
+
       def const_retrieve( const )
         obj = Object
         const.split(/::/).each do |part|

data/lib/ixtlan/babel/params_filter.rb

@@ -0,0 +1,57 @@
+require 'ixtlan/babel/hash_filter'
+require 'ixtlan/babel/filter_config'
+
+module Ixtlan
+  module Babel
+    class ParamsFilter
+
+      def initialize( model_class )
+        @model_class = model_class
+      end
+
+      private
+
+      def self.config
+        @config ||= FilterConfig.new
+      end
+
+      def filter
+        @filter ||= HashFilter.new
+      end
+
+      protected
+
+      def self.default_context_key(default)
+        config.default_context_key(default)
+      end
+
+      def self.add_context(key, options = {})
+        config[key] = options
+      end
+
+      def self.root( root )
+        config.root = root
+      end
+
+      public
+
+      def use(context_or_options)
+        @context_or_options = context_or_options
+        self
+      end
+      def filter_it( data )
+        filter.options = self.class.config.single_options( @context_or_options )
+        data = data[ filter.options[ :root ] ] if filter.options[ :root ]
+        keeps = {}
+        ( filter.options[ :keep ] || [] ).each do |k|
+          keeps[ k.to_s ] = data[ k.to_s ] || data[ k.to_sym ]
+        end
+        [ filter.filter( data ), keeps ]
+      end
+
+      def new( data )
+        @model_class.new( filter( data ) )
+      end
+    end
+  end
+end

data/lib/ixtlan/babel/params_filter.rb~

@@ -0,0 +1,57 @@
+require 'ixtlan/babel/hash_filter'
+require 'ixtlan/babel/filter_config'
+
+module Ixtlan
+  module Babel
+    class ParamsFilter
+
+      def initialize( model_class )
+        @model_class = model_class
+      end
+
+      private
+
+      def self.config
+        @config ||= FilterConfig.new
+      end
+
+      def filter
+        @filter ||= HashFilter.new
+      end
+
+      protected
+
+      def self.default_context_key(default)
+        config.default_context_key(default)
+      end
+
+      def self.add_context(key, options = {})
+        config[key] = options
+      end
+
+      def self.root( root )
+        config.root = root
+      end
+
+      public
+
+      def use(context_or_options)
+        @context_or_options = context_or_options
+        self
+      end
+      def filter_it( data )
+        filter.options = self.class.config.single_options( @context_or_options )
+        data = data[ self.class.config.root ] if self.class.config.root
+        keeps = {}
+        ( filter.options[ :keep ] || [] ).each do |k|
+          keeps[ k.to_s ] = data[ k.to_s ]
+        end
+        [ filter.filter( data ), keeps ]
+      end
+
+      def new( data )
+        @model_class.new( filter( data ) )
+      end
+    end
+  end
+end

data/spec/hash_filter_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'ixtlan/babel/deserializer'
 
 class Hash
   def attributes

data/spec/model_filter_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'virtus'
+require 'ixtlan/babel/deserializer'
 
 class Address
   include Virtus
@@ -82,15 +83,23 @@ describe Ixtlan::Babel::ModelFilter do
     json = serializer.to_json(:except => ['id'])  
     result = deserializer.from_json(json, :except => ['id'])  
     
+    expected = Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+
     # travis sees empty array and locally it is nil :(
-    result.attributes[ :phone_numbers ] ||= []
-    result.attributes.must_equal Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+    result.phone_numbers ||= []
+
+    result.attributes.keys.dup.each do |k|
+      result.attributes[ k ].must_equal expected[ k ]
+    end
 
     result = deserializer.from_json(json)
 
     # travis sees empty array and locally it is nil :(
-    result.attributes[ :phone_numbers ] ||= []
-    result.attributes.must_equal Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+    result.phone_numbers ||= []
+
+    result.attributes.keys.dup.each do |k|
+      result.attributes[ k ].must_equal expected[ k ]
+    end
   end
 
   it 'should serialize and deserialize with only' do
@@ -98,14 +107,20 @@ describe Ixtlan::Babel::ModelFilter do
     result = deserializer.from_json(json, :only => ['name'])
 
     # travis sees empty array and locally it is nil :(
-    result.attributes[ :phone_numbers ] ||= []
-    result.attributes.must_equal Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+    result.phone_numbers ||= []
+
+    expected = Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+    result.attributes.keys.dup.each do |k|
+      result.attributes[ k ].must_equal expected[ k ]
+    end
 
     result = deserializer.from_json(json)
 
     # travis sees empty array and locally it is nil :(
-    result.attributes[ :phone_numbers ] ||= []
-    result.attributes.must_equal Hash[:name => person['name'], :address=>nil, :phone_numbers=>[], :id => nil]
+    result.phone_numbers ||= []
+    result.attributes.keys.dup.each do |k|
+      result.attributes[ k ].must_equal expected[ k ]
+    end
   end
 
   it 'should serialize and deserialize with nested only' do

data/spec/params_filter_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'ixtlan/babel/params_filter'
+
+class A; end
+class AFilter < Ixtlan::Babel::ParamsFilter
+
+end
+
+class Hash
+  def attributes
+    self
+  end
+  def method_missing(method)
+    self[method.to_s]
+  end
+end
+
+describe Ixtlan::Babel::ParamsFilter do
+  let(:data) do
+    {
+      'id' => 987,
+      'name' => 'me and the corner',
+      'address' => { 'street' => 'Foo 12', 'zipcode' => '12345' },
+      'phone_numbers' => { 
+        'prefix' => 12, 
+        'number' => '123',
+        'area' => { 'code' => '001', 'iso' => 'us'}
+      }
+    }
+  end
+
+  let(:factory) { Ixtlan::Babel::Factory.new }
+  let(:filter) { factory.new_filter( A ) }
+  let(:deserializer) { Ixtlan::Babel::Deserializer.new(Hash) }
+
+  it 'should filter a hash' do
+    json = filter.filter_it( data )
+    json[0].must_equal Hash[ 'id' => data['id'], 'name' => data['name'] ]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with keep' do
+    json = filter.use( :keep => ['id'] ).filter_it( data )
+    json[0].must_equal Hash[ 'id' => data['id'], 'name' => data['name'] ]
+    json[1].must_equal Hash[ 'id' => data['id'] ]
+  end
+
+  it 'should filter a hash with root' do
+    json = filter.use( :root => 'my' ).filter_it( 'my' => data )
+    json[0].must_equal Hash[ 'id' => data['id'], 'name' => data['name'] ]
+    json[1].must_equal Hash[]
+  end  
+
+  it 'should filter a hash with include list' do
+    json = filter.use( :include => ['address', 'phone_numbers'] ).filter_it( data )
+
+    data['phone_numbers'].delete('area')
+    json[0].must_equal Hash[data]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with except' do
+    json = filter.use( :except => ['id'] ).filter_it( data )
+    json[0].must_equal Hash['name' => data['name']]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with except and keep' do
+    json = filter.use( :except => ['id'], :keep => ['id'] ).filter_it( data )
+    json[0].must_equal Hash['name' => data['name']]
+    json[1].must_equal Hash['id' => data['id']]
+  end
+
+  it 'should filter a hash with only' do
+    json = filter.use( :only => ['name'] ).filter_it( data )
+    json[0].must_equal Hash['name' => data['name']]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with only and keep' do
+    json = filter.use( :only => ['name'], :keep => ['id'] ).filter_it( data )
+    json[0].must_equal Hash['name' => data['name']]
+    json[1].must_equal Hash['id' => data['id']]
+  end
+
+  it 'should filter a hash with nested only' do
+    json = filter.use( :include => { 'address' => {:only => ['street']}} ).filter_it( data )
+    data.delete('phone_numbers')
+    data['address'].delete('zipcode')
+    json[0].must_equal Hash[data]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with nested except' do
+    json = filter.use( :include => { 'address' => {:except => ['zipcode']}} ).filter_it( data ) 
+    data.delete('phone_numbers')
+    data['address'].delete('zipcode')
+    json[0].must_equal Hash[data]
+    json[1].must_equal Hash[]
+  end
+
+  it 'should filter a hash with nested include' do
+    json = filter.use( :include => { 'address' => {}, 'phone_numbers' => { :include => ['area']}} ).filter_it( data ) 
+    json[0].must_equal Hash[data]
+    json[1].must_equal Hash[]
+  end
+end

data/spec/params_filter_spec.rb~

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+class Hash
+  def attributes
+    self
+  end
+  def method_missing(method)
+    self[method.to_s]
+  end
+end
+
+describe Ixtlan::Babel::HashFilter do
+  let(:data) do
+    data = {
+      'id' => 987,
+      'name' => 'me and the corner',
+      'address' => { 'street' => 'Foo 12', 'zipcode' => '12345' },
+      'phone_numbers' => { 
+        'prefix' => 12, 
+        'number' => '123',
+        'area' => { 'code' => '001', 'iso' => 'us'}
+      }
+    }
+    class Hash
+      def self.new(hash = nil, &block) 
+        if hash
+          self[hash]
+        else 
+          super &block
+        end
+      end
+    end
+    data
+  end
+
+  let(:serializer) { Ixtlan::Babel::Serializer.new(data) }
+  let(:deserializer) { Ixtlan::Babel::Deserializer.new(Hash) }
+
+  it 'should serialize and deserialize a hash' do
+    json = serializer.to_json
+    result = deserializer.from_json(json)
+    result.must_equal Hash['id' => data['id'], 'name' => data['name']]
+  end
+
+  it 'should serialize and deserialize a hash with root' do
+    json = serializer.to_json :root => 'my'
+    result = deserializer.from_json(json, :root => 'my')
+    result.must_equal Hash['id' => data['id'], 'name' => data['name']]
+  end  
+
+  it 'should serialize and deserialize a hash with include list' do
+    json = serializer.to_json(:include => ['address', 'phone_numbers']) 
+    result = deserializer.from_json(json, :include => ['address', 'phone_numbers'])
+    data['phone_numbers'].delete('area')
+    result.must_equal Hash[data]
+  end
+
+  it 'should serialize and deserialize a hash with except' do
+    json = serializer.to_json(:except => ['id'])  
+    result = deserializer.from_json(json, :except => ['id'])  
+    result.must_equal Hash['name' => data['name']]
+    result = deserializer.from_json(json)  
+    result.must_equal Hash['name' => data['name']]
+  end
+
+  it 'should serialize and deserialize a hash with only' do
+    json = serializer.to_json(:only => ['name']) 
+    result = deserializer.from_json(json, :only => ['name'])
+    result.must_equal Hash['name' => data['name']]
+    result = deserializer.from_json(json)
+    result.must_equal Hash['name' => data['name']]
+  end
+
+  it 'should serialize and deserialize a hash with nested only' do
+    json = serializer.to_json(:include => { 'address' => {:only => ['street']}})
+    data.delete('phone_numbers')
+    data['address'].delete('zipcode')
+    result = deserializer.from_json(json, :include => { 'address' => {:only => ['street']}})
+    result.must_equal data
+    result = deserializer.from_json(json, :include => ['address'])
+    result.must_equal data
+  end
+
+  it 'should serialize and deserialize a hash with nested except' do
+    json = serializer.to_json(:include => { 'address' => {:except => ['zipcode']}}) 
+    data.delete('phone_numbers')
+    data['address'].delete('zipcode')
+    result = deserializer.from_json(json, :include => { 'address' => {:except => ['zipcode']}})
+    result.must_equal data
+    result = deserializer.from_json(json, :include => ['address'])
+    result.must_equal data
+  end
+
+  it 'should serialize and deserialize a hash with nested include' do
+    json = serializer.to_json(:include => { 'address' => {}, 'phone_numbers' => { :include => ['area']}}) 
+    result = deserializer.from_json(json, :include => { 'address' => {}, 'phone_numbers' => { :include => ['area']}})
+    result.must_equal data
+  end
+end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: ixtlan-babel
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
-- Kristian Meier
+- Christian Meier
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-12-29 00:00:00 Z
+date: 2013-01-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -34,18 +34,19 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json_pure
+  name: copyright-header
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
         - 1
-        - 6
-        version: "1.6"
+        - 0
+        - 7
+        version: 1.0.7
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -80,6 +81,21 @@ dependencies:
         version: 0.5.0
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        version: "1.7"
+  type: :development
+  version_requirements: *id005
 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
 email: 
 - m.kristian@web.de
@@ -93,9 +109,11 @@ files:
 - lib/ixtlan-babel.rb
 - lib/ixtlan/babel/deserializer.rb
 - lib/ixtlan/babel/hash_filter.rb
+- lib/ixtlan/babel/params_filter.rb
 - lib/ixtlan/babel/abstract_filter.rb
 - lib/ixtlan/babel/no_timestamp_serializer.rb
 - lib/ixtlan/babel/filter_config.rb
+- lib/ixtlan/babel/params_filter.rb~
 - lib/ixtlan/babel/context.rb
 - lib/ixtlan/babel/factory.rb
 - lib/ixtlan/babel/model_filter.rb~
@@ -112,17 +130,18 @@ files:
 - spec/model_filter_spec.rb~
 - spec/model_filter_spec.rb
 - spec/model_filter_with_methods_spec.rb~
+- spec/params_filter_spec.rb
 - spec/hash_filter_spec.rb
 - spec/hash_filter_spec.rb~
 - spec/spec_helper.rb
 - spec/model_filter_with_methods_spec.rb
+- spec/params_filter_spec.rb~
 - MIT-LICENSE
 - README.md
 - Gemfile
-- Gemfile.lock
 homepage: https://github.com/mkristian/ixtlan-babel
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -155,5 +174,6 @@ specification_version: 3
 summary: babel offers a filter for hashes and with that comes json/yaml/xml de/serialization of models which provides a hash representation
 test_files: 
 - spec/model_filter_spec.rb
+- spec/params_filter_spec.rb
 - spec/hash_filter_spec.rb
 - spec/model_filter_with_methods_spec.rb

data/Gemfile.lock

@@ -1,24 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ixtlan-babel (0.2.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    backports (2.6.2)
-    json_pure (1.6.1)
-    minitest (4.3.2)
-    rake (10.0.3)
-    virtus (0.5.1)
-      backports (~> 2.6.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ixtlan-babel!
-  json_pure (~> 1.6)
-  minitest (~> 4.3.0)
-  rake (~> 10.0.0)
-  virtus (~> 0.5.0)