attribute_serializer 0.4.0 → 0.4.1

data/Rakefile

@@ -1,5 +1,5 @@
 task :default => [:test]
- 
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gs|
@@ -8,14 +8,14 @@ begin
     gs.summary  = "Takes an object, serializes the attributes to an ordered hash based on a pre-defined schema"
     gs.email    = "myles@myles.id.au"
     gs.authors  = ["Myles Byrne"]
-    gs.add_development_dependency('riot', '>= 0.10.13')
+    gs.add_development_dependency('exemplor', '>= 3000.1.0')
     gs.files.include %(lib/attribute_serializer.rb) # jewler used to include files in lib automatically, what happened?
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Install jeweler to build gem"
 end
- 
+
 task :test do
-  ruby '-rubygems', "test.rb"
+  ruby '-rubygems', "examples.rb"
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/examples.rb

@@ -0,0 +1,149 @@
+require 'exemplor'
+require 'lib/attribute_serializer'
+
+def OHash &blk
+  ActiveSupport::OrderedHash.new.tap(&blk)
+end
+
+Class.class_eval do
+  def create(hash)
+    self.new.tap do |o| hash.each { |k,v| o.send("#{k}=", v) } end
+  end
+end
+
+eg.helpers do
+
+  def self.mem(name, &blk)
+    define_method name do
+      instance_variable_get("@#{name}") or
+      instance_variable_set("@#{name}", blk.call)
+    end
+  end
+
+  mem :article_class do
+    Class.new { attr_accessor :id, :title, :body, :author }
+  end
+
+  mem :author_class do
+    Class.new { attr_accessor :name, :email }
+  end
+
+end
+
+eg "Serializable object" do
+  AttributeSerializer article_class, %w(id title body)
+
+  article = article_class.create(
+    :id    => 1,
+    :title => "Contextual Attributes",
+    :body  => "The layer you've always wanted for generating your json"
+  )
+
+  expected_hash = OHash do |h|
+    h['id']    = 1
+    h['title'] = "Contextual Attributes"
+    h['body']  = "The layer you've always wanted for generating your json"
+  end
+
+  # AttributeSerializer(article) is equivalent to:
+  # AttributeSerializer(article,:default)
+  Assert(AttributeSerializer(article) == expected_hash)
+end
+
+eg "Serializable subclass object" do
+  subclass = Class.new(article_class) { attr_accessor :photo_url }
+
+  # AttributeSerializer only defined for *ancestor class*
+  AttributeSerializer article_class, %w(id title body)
+
+  photo_post = subclass.create(
+    :id        => 1,
+    :title     => "Contextual Attributes",
+    :body      => "The layer you've always wanted for generating your json",
+    :photo_url => "http://foobar.com/lemonparty.jpg"
+  )
+
+  expected_hash = OHash do |h|
+    h['id']    = 1
+    h['title'] = "Contextual Attributes"
+    h['body']  = "The layer you've always wanted for generating your json"
+  end
+
+  # Serialization on instance of *subclass*
+  Assert(AttributeSerializer(photo_post) == expected_hash)
+
+  # define AttributeSerializer for the actual class
+  AttributeSerializer subclass, %w(id title body photo_url)
+
+  expected_hash['photo_url'] = "http://foobar.com/lemonparty.jpg"
+
+  # Serialization on instance of subclass now that there's a serializer for it
+  Assert(AttributeSerializer(photo_post) == expected_hash)
+end
+
+eg "Object with nested serializable attribute" do
+  article_class = Class.new { attr_accessor :id, :author }
+
+  AttributeSerializer author_class, %w(name email)
+  AttributeSerializer article_class, %w(id author) do
+    # no implicit support for nesting, intentionally
+    def author
+      AttributeSerializer delegatee.author
+    end
+  end
+
+  article = article_class.create(
+    :id     => 1,
+    :author => author_class.create(
+      :name  => "Myles",
+      :email => "myles@"
+    )
+  )
+
+  expected_hash = OHash do |h|
+    h['id']     = 1
+    h['author'] = OHash do |h|
+      h['name']  = "Myles"
+      h['email'] = "myles@"
+    end
+  end
+
+  Assert(AttributeSerializer(article) == expected_hash)
+end
+
+eg "Array of serializable objects" do
+  AttributeSerializer author_class, %w(name email)
+
+  array = [
+    author_class.create(:name => "Myles",   :email => 'myles@'),
+    author_class.create(:name => "Gabriel", :email => 'gabriel@')
+  ]
+
+  expected_array = [
+    OHash { |h| h['name'] = "Myles";   h['email'] = 'myles@' },
+    OHash { |h| h['name'] = "Gabriel"; h['email'] = 'gabriel@' }
+  ]
+
+  Assert(AttributeSerializer(array) == expected_array)
+end
+
+eg "Non-default serializer" do
+  AttributeSerializer article_class, :summary, %w(id title)
+
+  article = article_class.create(
+    :id    => 1,
+    :title => "Contextual Attributes",
+    :body  => "The layer you've always wanted for generating your json"
+  )
+
+  expected_hash = OHash do |h|
+    h['id'] = 1
+    h['title'] = "Contextual Attributes"
+  end
+
+  Assert(AttributeSerializer(article, :summary) == expected_hash)
+end
+
+eg "Hashes are passed straight through" do
+  Assert(AttributeSerializer({ :foo => 'bar' }) == { :foo => 'bar' })
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Myles Byrne
@@ -14,21 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-24 00:00:00 -05:00
+date: 2010-05-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: riot
+  name: exemplor
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 3000
+        - 1
         - 0
-        - 10
-        - 13
-        version: 0.10.13
+        version: 3000.1.0
   type: :development
   version_requirements: *id001
 description: 
@@ -43,8 +43,8 @@ files:
 - .gitignore
 - Rakefile
 - VERSION
+- examples.rb
 - lib/attribute_serializer.rb
-- test.rb
 has_rdoc: true
 homepage: http://github.com/quackingduck/attribute_serializer
 licenses: []

data/test.rb

@@ -1,149 +0,0 @@
-require 'riot'
-require 'lib/attribute_serializer'
-
-def OHash &blk
-  ActiveSupport::OrderedHash.new.tap(&blk)
-end
-
-Class.class_eval do
-  def create(hash)
-    self.new.tap do |o| hash.each { |k,v| o.send("#{k}=", v) } end
-  end
-end
-
-class Author
-  attr_accessor :name, :email
-end
-
-class BlogPost
-  attr_accessor :id, :title, :body, :author
-end
-
-class PhotoBlogPost < BlogPost
-  attr_accessor :photo_url
-end
-
-context "Formatable object, default formator" do
-  setup do
-    AttributeSerializer BlogPost, %w(id title body)
-
-    BlogPost.create(
-      :id    => 1,
-      :title => "Contextual Attributes",
-      :body  => "The layer you've always wanted for generating your json"
-    )
-  end
-
-  asserts('produces the correct hash') do
-    AttributeSerializer topic # equivalent to AttributeSerializer(topic,:default)
-  end.equals(OHash { |h|
-    h['id']    = 1
-    h['title'] = "Contextual Attributes"
-    h['body']  = "The layer you've always wanted for generating your json"
-  })
-end
-
-context "Formatable subclass object, default formator" do
-  setup do
-    # define AttributeSerializer for *ancestor class*
-    AttributeSerializer BlogPost, %w(id title body)
-
-    @post = PhotoBlogPost.create(
-      :id        => 1,
-      :title     => "Contextual Attributes",
-      :body      => "The layer you've always wanted for generating your json",
-      :photo_url => "http://foobar.com/lemonparty.jpg"
-    )
-  end
-
-  asserts('produces the correct hash') do
-    AttributeSerializer topic # equivalent to AttributeSerializer(topic,:default)
-  end.equals(OHash { |h|
-    h['id']    = 1
-    h['title'] = "Contextual Attributes"
-    h['body']  = "The layer you've always wanted for generating your json"
-  })
-
-  context "with subclass serializer" do
-    setup do
-      AttributeSerializer PhotoBlogPost, %w(id title body photo_url)
-      @post
-    end
-
-    asserts('produces the correct hash') do
-      AttributeSerializer topic # equivalent to AttributeSerializer(topic,:default)
-    end.equals(OHash { |h|
-      h['id']        = 1
-      h['title']     = "Contextual Attributes"
-      h['body']      = "The layer you've always wanted for generating your json"
-      h['photo_url'] = "http://foobar.com/lemonparty.jpg"
-    })
-  end
-
-end
-
-context "Nested formatable attrib" do
-  setup do
-    AttributeSerializer Author, %w(name email)
-
-    AttributeSerializer BlogPost, %w(id author) do
-      # no implicit support for nesting, intentionally
-      def author
-        AttributeSerializer formatee.author
-      end
-    end
-
-    BlogPost.create(
-      :id     => 1,
-      :author => Author.create(
-        :name  => "Myles",
-        :email => "myles@"
-      )
-    )
-  end
-
-  asserts('produces the correct hash') { AttributeSerializer(topic, :default) }.
-  equals(OHash { |h|
-    h['id']     = 1
-    h['author'] = OHash do |h|
-      h['name']  = "Myles"
-      h['email'] = "myles@"
-    end
-  })
-end
-
-context "Array of formatable objects" do
-  setup do
-    AttributeSerializer Author, %w(name email)
-    [ Author.create(:name => "Myles",   :email => 'myles@'),
-      Author.create(:name => "Gabriel", :email => 'gabriel@') ]
-  end
-
-  asserts('produces the correct hash') { AttributeSerializer(topic, :default) }.
-  equals([
-    OHash { |h| h['name'] = "Myles";   h['email'] = 'myles@' },
-    OHash { |h| h['name'] = "Gabriel"; h['email'] = 'gabriel@' }
-  ])
-end
-
-context "A non-default formatter" do
-  setup do
-    AttributeSerializer BlogPost, :summary, %w(id title)
-    BlogPost.create(
-      :id    => 1,
-      :title => "Contextual Attributes",
-      :body  => "The layer you've always wanted for generating your json"
-    )
-  end
-
-  asserts('produces the correct hash') { AttributeSerializer(topic, :summary) }.
-  equals(
-    OHash { |h| h['id'] = 1; h['title'] = "Contextual Attributes" }
-  )
-end
-
-context "Hashes are passed straight through" do
-  setup { AttributeSerializer({ :foo => 'bar' }) }
-  
-  asserts_topic.equals({:foo => 'bar'})
-end