ixtlan-babel 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f025bd8665c42f07f792f3fb8a28331a62e47274
-  data.tar.gz: 4c3df0b63c0574acc37ec06cd33e9f18e0c1c809
+  metadata.gz: 00259cfa886327c377f73044439ec871fcb05e05
+  data.tar.gz: b4e094454585371ad6d79e9787b920691af6b796
 SHA512:
-  metadata.gz: 8b5267f3135e38b8053da3d39a30a87093ccd11f0c9e2837c3264b346dffd96613a17031f3d6ef5e98a34657652475452f12c96bcdcc81484f21021f01ce2dec
-  data.tar.gz: f1be049f637b3dd246fb4f8353f71662e3e3bfd8fe806d3514c82b74f80e839723ed9345b4d5e2cce38c6d290397d2f9eaf59bd36b7bfcff3d61b2bc6713a494
+  metadata.gz: df6693a953826957ce9d074f076c2a0f1072fac6e2816a73b132b4962ad6d8d3c9cf0aa3fe3510b94424fed0b93415dfcde9a3901d18f2a7da581e97ee29648f
+  data.tar.gz: b05cff1c83d9be2acefdb1bac1860e861a46753fbcd57660e9854e5c3f66800af6b007633709663eab25f1aba2c6ef1bdef24891b1b38038fcc0a9613546047e

data/Gemfile

@@ -1,6 +1,9 @@
+# -*- mode: ruby -*-
+
 source 'https://rubygems.org'
 
 gemspec
 
-gem  'copyright-header', '~> 1.0', :platform => :mri, :group => :copyright
+gem 'copyright-header', '~>1.0', :platform => :mri, :group => :copyright
 
+# vim: syntax=Ruby

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Kristian Meier
+Copyright (c) 2008 Kristian Meier
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,19 +1,9 @@
-# babel #
+# Ixtlan Babel #
 
-* [![Build Status](https://secure.travis-ci.org/mkristian/babel.png)](http://travis-ci.org/mkristian/babel) 
+* [![Build Status](https://secure.travis-ci.org/mkristian/ixtlan-babel.png)](http://travis-ci.org/mkristian/ixtlan-babel)
 * [![Dependency Status](https://gemnasium.com/mkristian/ixtlan-babel.png)](https://gemnasium.com/mkristian/ixtlan-babel)
-* [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mkristian/ixtlan-babel)
+* [![Code Climate](https://codeclimate.com/github/mkristian/ixtlan-babel.png)](https://codeclimate.com/github/mkristian/ixtlan-babel)
 
-rails comes with `to_json` and `to_xml` on models and you can give them an option map to control how the whole object tree gets serialized.
-
-the first problem I had was that I needed serveral options map at different controllers/actions so I needed a place to store them. the model itself felt to be the wrong place.
-
-the next problem was that I could include the result of a given method with `:methods => ['age']` but only on the root level of the object tree. but if I wanted to `age` method to be part of the serialization somewhere deep inside the object tree, it is not possible.
-
-please have a look at **spec/filter_spec.rb** how to use it :)
-
-TODO usage
-==========
 
 Contributing
 ------------
@@ -28,4 +18,3 @@ meta-fu
 -------
 
 enjoy :) 
-

data/Rakefile

@@ -0,0 +1,27 @@
+# -*- mode: ruby -*-
+
+task :default => [ :spec ]
+
+task :spec do
+  Dir['spec/*_spec.rb'].each { |f| require File.expand_path( f ) }
+end
+
+task :headers do
+  require 'copyright_header'
+
+  s = Gem::Specification.load( Dir["*gemspec"].first )
+
+  args = {
+    :license => s.license, 
+    :copyright_software => s.name,
+    :copyright_software_description => s.description,
+    :copyright_holders => s.authors,
+    :copyright_years => [Time.now.year],
+    :add_path => 'lib',
+    :output_dir => './'
+  }
+
+  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line.execute
+end
+# vim: syntax=Ruby

data/lib/ixtlan-babel.rb

@@ -1,22 +1 @@
-#
-# 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/serializer'
 require 'ixtlan/babel/factory'

data/lib/ixtlan-babel.rb~

@@ -0,0 +1 @@
+

data/lib/ixtlan/babel/common_filters.rb

@@ -0,0 +1,21 @@
+require 'ixtlan/babel/hash_filter'
+require 'ixtlan/babel/model_serializer'
+
+class Ixtlan::Babel::IdFilter
+  include Ixtlan::Babel::HashFilter
+
+  attributes :id
+end
+
+class Ixtlan::Babel::UpdatedAtFilter
+  include Ixtlan::Babel::HashFilter
+
+  hidden :updated_at
+end
+
+class Ixtlan::Babel::CollectionSerializer
+  include Ixtlan::Babel::ModelSerializer
+
+  attributes :offset, :total_count
+end
+

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

@@ -0,0 +1,14 @@
+require 'ixtlan/babel/hash_filter'
+
+class Ixtlan::Babel::IdFilter
+  include Ixtlan::Babel::HashFilter
+
+  attributes :id
+end
+
+class Ixtlan::Babel::UpdatedAtFilter
+  include Ixtlan::Babel::HashFilter
+
+  hidden :updated_at
+end
+

data/lib/ixtlan/babel/factory.rb

@@ -1,26 +1,8 @@
-#
-# 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/dm_validation_errors_serializer' if defined? DataMapper
+require 'ixtlan/babel/hash_filter'
+require 'ixtlan/babel/model_serializer'
 module Ixtlan
   module Babel
+    
     class Factory
 
       NANOSECONDS_IN_DAY = 86400*10**6
@@ -33,61 +15,59 @@ module Ixtlan
         dt.strftime('%Y-%m-%dT%H:%M:%S.') + ("%06d" % (dt.sec_fraction * NANOSECONDS_IN_DAY ) )[0..6] + dt.strftime('%z')
       end
 
+      DATE_TO_S = Proc.new do |d|
+        d.strftime('%Y-%m-%d' )
+      end
+
       DEFAULT_MAP = {
         'DateTime' => DATE_TIME_TO_S,
+        'Date' => DATE_TO_S,
         'ActiveSupport::TimeWithZone' => TIME_TO_S,
         'Time' => TIME_TO_S
       }
 
-      class EmptyArraySerializer < Array
-        def use(arg)
-          self
-        end
-      end
-
-      def initialize(custom_serializers = {})
+      def initialize( custom_serializers = {} )
         @map = DEFAULT_MAP.dup
-        @map.merge!(custom_serializers)
+        @map.merge!( custom_serializers )
       end
 
-      def add( clazz, &block )
-        @map[ clazz.to_s ] = block
+      def serializer( resource, context = nil )
+        if model = to_model( resource )
+          clazz = '::' + model.to_s
+          to_class( clazz, 'Serializer', context ).new( resource, @map )
+        else
+          []
+        end
       end
 
-      def new_serializer( resource )
+      private
+      def to_model( resource )
         if resource.respond_to?(:model)
-          model = resource.model
-        elsif resource.respond_to?( :collect) &&
-            !resource.respond_to?( :to_hash)
+          resource.model
+        elsif( resource.respond_to?( :collect ) &&
+               !resource.respond_to?( :to_hash ) )
           if resource.empty?
-            return EmptyArraySerializer.new
+            nil
           else
-            r = resource.first
-            model = r.respond_to?( :model ) ? r.model : r.class
+            to_model( resource.first )
           end
         else
-          model = resource.class
+          resource.class
         end
-        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|
-          obj = obj.const_get( part )
+      def to_class( clazz, postfix, context )
+        if context.is_a? Class
+          context
+        else
+          context = context.to_s.split( /_/ ).collect { |s| s.capitalize }.join
+          c = clazz.to_s.sub( /^::/, '' ).sub( /(::)?([a-zA-Z0-9]+)$/, "\\1#{context}\\2#{postfix}" )
+          obj = Object
+          c.split( /::/ ).each do |part|
+            obj = obj.const_get( part )
+          end
+          obj
         end
-        obj
       end
     end
   end

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

@@ -1,25 +1,8 @@
-#
-# 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/hash_filter'
+require 'ixtlan/babel/model_serializer'
 module Ixtlan
   module Babel
+    
     class Factory
 
       NANOSECONDS_IN_DAY = 86400*10**6
@@ -29,67 +12,64 @@ module Ixtlan
       end
 
       DATE_TIME_TO_S = Proc.new do |dt|
-        dt.strftime('%Y-%m-%dT%H:%M:%S.') + ("%06d" % (dt.sec_fraction * NANOSECONDS_IN_DAY ) ) + dt.strftime('%z')
+        dt.strftime('%Y-%m-%dT%H:%M:%S.') + ("%06d" % (dt.sec_fraction * NANOSECONDS_IN_DAY ) )[0..6] + dt.strftime('%z')
       end
-      
+
+      DATE_TO_S = Proc.new do |d|
+        d.strftime('%Y-%m-%d' )
+      end
+
       DEFAULT_MAP = {
         'DateTime' => DATE_TIME_TO_S,
+        'Date' => DATE_TO_S,
         'ActiveSupport::TimeWithZone' => TIME_TO_S,
         'Time' => TIME_TO_S
       }
 
-      class EmptyArraySerializer < Array
-        def use(arg)
-          self
-        end
-      end
-
-      def initialize(custom_serializers = {})
+      def initialize( custom_serializers = {} )
         @map = DEFAULT_MAP.dup
-        @map.merge!(custom_serializers)
+        @map.merge!( custom_serializers )
       end
 
-      def add( clazz, &block )
-        @map[ clazz.to_s ] = block
+      def serializer( resource, context = nil )
+        if model = to_model( resource )
+          clazz = '::' + model.to_s
+          to_class( clazz, 'Serializer', context ).new( resource, @map )
+        else
+          []
+        end
       end
 
-      def new_serializer( resource )
+      private
+      def to_model( resource )
         if resource.respond_to?(:model)
-          model = resource.model
-        elsif resource.respond_to?( :collect) && !resource.respond_to?( :to_hash)
+          resource.model
+        elsif( resource.respond_to?( :collect ) &&
+               !resource.respond_to?( :to_hash ) )
           if resource.empty?
-            return EmptyArraySerializer.new
+            nil
           else
-p resource
-p resource.class
-            r = resource.first
-            model = r.respond_to?( :model ) ? r.model : r.class
-p model
+            to_model( resource.first )
           end
         else
-          model = resource.class
+          resource.class
         end
-        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|
-          obj = obj.const_get( part )
+      def to_class( clazz, postfix, context )
+        if context.is_a? Class
+          context
+        else
+          context = context.to_s.split( /_/ ).collect { |s| s.capitalize }.join
+          c = clazz.to_s.sub( /^::/, '' ).sub( /(::)?([a-zA-Z0-9]+)$/, "\\1#{context}\\2#{postfix}" )
+          obj = Object
+          c.split( /::/ ).each do |part|
+            obj = obj.const_get( part )
+          end
+          obj
         end
-        obj
       end
     end
+
   end
 end

data/lib/ixtlan/babel/hash_filter.rb

@@ -1,65 +1,146 @@
-#
-# 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/abstract_filter'
 module Ixtlan
   module Babel
-    class HashFilter < AbstractFilter
+    
+    module HashFilter
+
+      def self.included( model )
+        model.extend( ClassMethods )
+      end
 
       def filter( data )
-        if data
-          filter_data( data,
-                       Context.new( options ) )
+        @attributes = do_filter( data, self.class.attributes )
+      end
+
+      def hidden( data )
+        @hidden = do_filter( data, self.class.hiddens )
+      end
+
+      def attributes
+        @attributes
+      end
+      alias :params :attributes
+
+      def respond_to? name
+        key = name.to_sym
+        self.class.hiddens.key?( key ) || self.class.attributes.key?( key ) || super
+      end
+
+      def method_missing( name, *args )
+        key = name.to_sym
+        if self.class.hiddens.key?( key )
+          to_attribute( key, 
+                        @hidden[ key ] || @hidden[ key.to_s ], 
+                        self.class.hiddens )
+        elsif self.class.attributes.key?( key )
+          to_attribute( key,
+                        @attributes[ key ] || @attributes[ key.to_s ],
+                        self.class.attributes )      
+        else
+          super
         end
       end
 
-      private
+      def to_attribute( key, v, ref )
+        case v
+        when Hash
+          ref[ key ].replace( v )
+        else
+          v
+        end
+      end
 
-      def filter_array( array, options )
-        array.collect do |item|
-          if item.is_a?( Array ) || item.is_a?( Hash )
-            filter_data( item, options )
+      def do_filter( data, ref )
+        data.reject do |k,v|
+          case v
+          when Hash
+            if babel = ref[ k.to_sym ]
+              v.replace babel.replace( v ).attributes
+              false
+            else
+              true
+            end
+          when ::Array
+            if babel = ref[ k.to_sym ]
+              v.each do |vv|
+                vv.replace babel.replace( vv ).attributes
+              end
+              false
+            else
+              true
+            end        
           else
-            serialize( item )
+            not ref.member?( k.to_sym ) 
           end
         end
       end
+      
+      def initialize
+        super()
+        replace( {} )
+      end
+
+      def replace( data )
+        data = deep_dup( data )
+        filter( data )
+        hidden( data )
+        self
+      end
+
+      private
 
-      def filter_data( data, context )
-        result = {}
+      def deep_dup( data )
+        data = data.dup
         data.each do |k,v|
-          k = k.to_s
-          case v
-          when Hash
-            result[ k ] = filter_data( v,
-                                       context[ k ] ) if context.include?( k )
+          if v.is_a? Hash
+            data[ k ] = deep_dup( v )
+          end
+        end
+      end
+
+      module ClassMethods
+       
+        def attribute( name, type = nil )
+          attributes[ name.to_sym ] = new_instance( type )
+        end
+
+        def hidden( name, type = nil )
+          hiddens[ name.to_sym ] = new_instance( type )
+        end
+
+        def data( meth )
+          (superclass.send( meth ).dup rescue nil) || {}
+        end
+        private :data
+
+        def set( meth, *args )
+          args.each { |a| send( meth, a ) }
+        end
+        private :set
+
+        def attributes( *args )
+          set( :attribute, *args )
+          if args.size == 0
+            @attributes ||= data( :attributes )
+          end
+        end
+
+        def hiddens( *args )
+          set( :hidden, *args )
+          if args.size == 0
+            @hiddens ||= data( :hiddens )
+          end
+        end
+        
+        def new_instance( type )
+          case type
           when Array
-            if context.allowed?( k ) || context.include?( k )
-              result[ k ] = filter_array( v,
-                                          context[ k ] )
-            end
+            type[ 0 ].new
+          when NilClass
+            nil
           else
-            result[ k ] = serialize( v ) if context.allowed?( k )
+            type.new
           end
         end
-        result
       end
     end
   end