attribute_serializer 0.4.1 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/examples.rb

@@ -146,4 +146,8 @@ end
 
 eg "Hashes are passed straight through" do
   Assert(AttributeSerializer({ :foo => 'bar' }) == { :foo => 'bar' })
+end
+
+eg "Arrays of strings are passed straight through" do
+  Assert(AttributeSerializer(['a','b']) == ['a','b'])
 end

data/lib/attribute_serializer.rb

@@ -12,7 +12,7 @@ module AttributeSerializer
       @attribs = attribs
       @delegate_class = DelegateClass(klass)
       @delegate_class.class_eval do
-        def delegatee; __getobj__ end        
+        def delegatee; __getobj__ end
         def id; formatee.id end # DelegateClass was written before object_id became the new world order
         alias_method :formatee, :delegatee # this was a stupid name
       end
@@ -49,6 +49,7 @@ module AttributeSerializer
   end
 
   def generate_single(klass, context_name, object)
+    return object if klass == String
     context = context_for(klass, context_name)
     raise ArgumentError, "no contextual attributes setup for #{klass}:#{context_name}" unless context
     context.generate(object)
@@ -64,9 +65,11 @@ module AttributeSerializer
 
 end
 
-# The interface
+# Public: Define a serializer or serialize an object or collection
 #
-# A default formatter:
+# Examples
+#
+# Define a default serializer on your class:
 #
 #   AttributeSerializer BlogPost, %w(id created_at title body) do
 #     def body
@@ -74,18 +77,22 @@ end
 #     end
 #   end
 #
-# Then call with:
+# Then serialize and instance like:
 #
 #   AttributeSerializer @post
 #
-# You can also define other formatters
+# You can also define other serializers:
 #
 #   AttributeSerializer BlogPost, :summary, %w(id created_at title)
 #
-# And you AttributeSerializer can produce formatted collections:
+# And serialize collections:
 #
 #   AttributeSerializer @posts, :summary
 #
+# AttributeSerializer returns an OrderedHash as the serialization, it's up to
+# you to call #to_json or #to_yaml on that object
+#
+# Returns an OrderedHash serialization when given an object or collection
 def AttributeSerializer(*args, &blk)
   if args.first.is_a?(Class)
     klass, context_name, attribs = (args.size == 3) ? args : [args[0], :default, args[1]]

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_serializer
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Myles Byrne
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-15 00:00:00 -05:00
+date: 2010-05-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: exemplor
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 24027
         segments: 
         - 3000
         - 1
@@ -55,23 +58,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Takes an object, serializes the attributes to an ordered hash based on a pre-defined schema