attribute_serializer 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gemspec
+pkg

data/Rakefile

@@ -0,0 +1,21 @@
+task :default => [:test]
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gs|
+    gs.name     = "attribute_serializer"
+    gs.homepage = "http://github.com/quackingduck/attribute_serializer"
+    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.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"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/attribute_serializer.rb

@@ -0,0 +1,86 @@
+require 'delegate'
+require 'active_support/ordered_hash'
+
+# Implementation
+module AttributeSerializer
+
+  extend self # check it out, singleton
+
+  class Context
+
+    def initialize(klass, attribs, &delegate_methods)
+      @attribs = attribs
+      @delegate_class = DelegateClass(klass)
+      @delegate_class.class_eval do
+        def formatee; __getobj__ end
+        def id; formatee.id end # DelegateClass was written before object_id became the new world order
+      end
+      @delegate_class.class_eval(&delegate_methods) if delegate_methods
+    end
+
+    def generate(object)
+      @delegate = @delegate_class.new(object)
+      ActiveSupport::OrderedHash.new.tap do |h|
+        @attribs.each do |attrib|
+          h[attrib.to_s] = @delegate.send(attrib)
+        end
+      end
+    end
+
+  end
+
+  def contexts
+    @contexts ||= {}
+  end
+
+  def add_context_set(klass, context_name, attribs, &delegate_methods)
+    key = [klass, context_name]
+    contexts[key] = Context.new klass, attribs, &delegate_methods
+  end
+
+  def generate(context_name, object)
+    if object.is_a?(Array)
+      object.map { |o| generate_single(o.class, context_name, o) }
+    else
+      generate_single(object.class, context_name, object)
+    end
+  end
+
+  def generate_single(klass, context_name, object)
+    key = [klass, context_name]
+    raise ArgumentError, "no contextual attributes setup for #{klass}:#{context_name}" unless contexts.keys.include?(key)
+    contexts[key].generate(object)
+  end
+
+end
+
+# The interface
+#
+# A default formatter:
+#
+#   AttributeSerializer BlogPost, %w(id created_at title body) do
+#     def body
+#       Rdiscount.new(formateee.body).to_html
+#     end
+#   end
+#
+# Then call with:
+#
+#   AttributeSerializer @post
+#
+# You can also define other formatters
+#  
+#   AttributeSerializer BlogPost, :summary, %w(id created_at title)
+#
+# And you AttributeSerializer can produce formatted collections:
+#
+#   AttributeSerializer @posts, :summary
+#
+def AttributeSerializer(*args, &blk)
+  if args.first.is_a?(Class)
+    klass, context_name, attribs = (args.size == 3) ? args : [args[0], :default, args[1]]
+    AttributeSerializer.add_context_set klass, context_name, attribs, &blk
+  else
+    AttributeSerializer.generate(args[1] || :default, args[0])
+  end
+end

data/test.rb

@@ -0,0 +1,100 @@
+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
+
+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 # equivanlent 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 "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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_serializer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Myles Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.13
+    version: 
+description: 
+email: myles@myles.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- VERSION
+- lib/attribute_serializer.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/quackingduck/attribute_serializer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Takes an object, serializes the attributes to an ordered hash based on a pre-defined schema
+test_files: []
+