restful_serializer 0.1.2 → 0.1.3

data/lib/restful.rb

@@ -124,6 +124,11 @@ module Restful
   # Route prefix for api calls.
   mattr_accessor :api_prefix
 
+  # Default url options for ActionController::UrlWriter.
+  # (Generally you must provide {:host => 'example.com'})
+  mattr_accessor :default_url_options
+  self.default_url_options = {}
+
   # Hash for configuration Restful models.
   mattr_accessor :model_configuration
   self.model_configuration = {}

data/lib/restful/serializer.rb

@@ -3,27 +3,55 @@ require 'deep_merge'
 
 module Restful
 
-  module UrlForHelpers
-
-    # Used to construct and attempt to call named routes by providing resource
-    # strings out of which a named route method name will be constructed:
-    #
-    # Options:
-    #
-    # * :resources => a symbol, string or array of same describing segments of
-    #   the helper method name.  e.g. [:user, :comments] => user_comments (to
-    #   which _url will be appended...)
-    # * :method => overrides the use of :resources and :prefix
-    # * :args => any arguments to be passed to the named_route when it is called
-    #
-    # = Example
-    #
-    #   get_url_for(:resources => [:user, :comments], :args => 1)
-    #   # => send("#{Restful.api_prefix}_user_comments_url", 1)
-    #   # which if it exists is likely to return something like:
-    #   # "http://example.com/user/1/comments"
-    #
-    def get_url_for(options)
+  # Used to construct and attempt to call named routes by providing resource
+  # strings out of which a named route method name will be constructed:
+  #
+  # Options:
+  #
+  # * :resources => a symbol, string or array of same describing segments of
+  #   the helper method name.  e.g. [:user, :comments] => user_comments (to
+  #   which _url will be appended...)
+  # * :method => overrides the use of :resources and :prefix
+  # * :args => any arguments to be passed to the named_route when it is called
+  #
+  # = Example
+  #
+  #   Url.for(:resources => [:user, :comments], :args => 1)
+  #   # => send("#{Restful.api_prefix}_user_comments_url", 1)
+  #   # which if it exists is likely to return something like:
+  #   # "http://example.com/user/1/comments"
+  #
+  class Url
+    include ActionController::UrlWriter
+    @@initialized = false
+
+    attr_accessor :options
+
+    class << self
+   
+      # Sets ActionController::UrlWriter.default_url_options from Restful.default_url_options.
+      # Attempting to do this during Rails initialization results in botched routing, presumably
+      # because of how ActionController::UrlWriter initializes when you include it into a class.
+      # So this method is called lazily. 
+      def initialize_default_url_options
+        unless @@initialized
+          self.default_url_options = Restful.default_url_options
+          @@initialized = true
+        end
+      end
+
+      # Helper for generating url strings from resource options.
+      def for(options)
+        new(options).to_s
+      end
+    end
+
+    def initialize(options)
+      self.options = options
+      Url.initialize_default_url_options
+    end
+
+    def to_s
       url_for = [options[:method], 'url'] if options.include?(:method)
       url_for ||= [Restful.api_prefix, options[:resources], 'url'].flatten.compact
       url_for = url_for.join('_').downcase
@@ -32,21 +60,33 @@ module Restful
 
   end
 
-  class Serializer
-    include ActionController::UrlWriter
-    include UrlForHelpers
-    attr_accessor :subject, :base_klass, :klass, :options, :shallow
- 
-    class << self
+  # Provides some utility functions for acting deeply on hashes.
+  class DeepHash < ::Hash
 
-      alias_method :serializer_default_url_options=, :default_url_options= 
-      # Set ActionController::UrlWriter.default_url_options for all Serializer
-      # actions.
-      def default_url_options=(options)
-        self.serializer_default_url_options = options
-        Association.default_url_options = options
+    class << self
+      def deeply_stringify_keys!(object)
+        case object 
+          when ::Hash 
+            then
+              object.stringify_keys!
+              recurse_on = object.values
+          when Array then recurse_on = object
+        end
+        recurse_on.each do |member|
+          deeply_stringify_keys!(member)
+        end if recurse_on
+        return object 
       end
     end
+
+    # Walks the graph, and destructively applies stringify_keys!
+    def deeply_stringify_keys!
+      return DeepHash.deeply_stringify_keys!(self)
+    end
+  end
+
+  class Serializer
+    attr_accessor :subject, :base_klass, :klass, :options, :shallow
  
     def initialize(subject, *args)
       self.subject = subject
@@ -109,9 +149,9 @@ module Restful
 
     def href 
       unless @href
-        @href = get_url_for(:method => options[:url_for], :args => subject.id) if options.include?(:url_for)
-        @href = get_url_for(:resources => klass, :args => subject.id) unless @href
-        @href = get_url_for(:resources => base_klass, :args => subject.id) unless @href || base_klass == klass
+        @href = Url.for(:method => options[:url_for], :args => subject.id) if options.include?(:url_for)
+        @href = Url.for(:resources => klass, :args => subject.id) unless @href
+        @href = Url.for(:resources => base_klass, :args => subject.id) unless @href || base_klass == klass
       end
       return @href
     end
@@ -119,16 +159,16 @@ module Restful
     private
 
     def _serialize_active_record
-      restful = {
-        klass => ActiveRecord::Serialization::Serializer.new(subject, active_record_serialization_options).serializable_record,
-      }
+      restful = DeepHash[
+        klass => ActiveRecord::Serialization::Serializer.new(subject, active_record_serialization_options).serializable_record
+      ]
       restful['name'] = name if name
       restful['href'] = href
       associations.each do |association|
         restful["#{association.name}_href"] = association.href 
       end unless shallow
 
-      return restful
+      return restful.deeply_stringify_keys!
     end
 
     def _serialize_array
@@ -143,8 +183,6 @@ module Restful
 
   # Handle for information about an ActiveRecord association.
   class Association
-    include ActionController::UrlWriter
-    include UrlForHelpers
     attr_accessor :name, :association_name, :association, :subject, :subject_klass
     
     def initialize(subject, subject_klass, association_name, name = nil)
@@ -161,7 +199,7 @@ module Restful
 
     def href
       if singular?
-        href = get_url_for(:resources => association_name, :args => subject.send(association.name).id)
+        href = Url.for(:resources => association_name, :args => subject.send(association.name).id)
       else
         href = collective_href
       end
@@ -170,8 +208,8 @@ module Restful
 
     def collective_href
       # try url_for nested resources first
-      unless href = get_url_for(:resources => [subject_klass, association_name], :args => subject.id)
-        href = get_url_for(:resources => association_name)
+      unless href = Url.for(:resources => [subject_klass, association_name], :args => subject.id)
+        href = Url.for(:resources => association_name)
       end
       return href 
     end

data/lib/restful/version.rb

@@ -1,3 +1,3 @@
 module Restful
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/restful_spec.rb

@@ -8,6 +8,10 @@ describe Restful do
     Restful.api_prefix.should == 'foo'
   end
 
+  it "should have a default_url_options accessor" do
+    Restful.default_url_options.should == {}
+  end
+
   it "should have a model_configuration accessor" do
     Restful.model_configuration.should == {}
   end

data/spec/serializer_spec.rb

@@ -69,7 +69,7 @@ describe Restful::Serializer do
 
   before(:each) do
     @foo = Foo.new(:name => 'A foo')
-    Restful::Serializer.default_url_options = { :host => 'test.org' }
+    Restful.default_url_options = { :host => 'test.org' }
   end
 
   after(:each) do
@@ -99,14 +99,6 @@ describe Restful::Serializer do
     rs.klass.should == 'foo'
   end
 
-  it "should set default url options" do
-    Restful::Serializer.default_url_options.should == { :host => 'test.org' }
-    Restful::Association.default_url_options.should == { :host => 'test.org' }
-    Restful::Serializer.default_url_options = opts = { :host => 'foo' }
-    Restful::Serializer.default_url_options.should == opts
-    Restful::Association.default_url_options.should == opts
-  end
-
   it "should serialize" do
     @foo.save!
     rs = Restful::Serializer.new(@foo)
@@ -139,7 +131,7 @@ describe Restful::Serializer do
         'name' => @foo.fancy_name,
         'foo' => { 
           'name' => @foo.name,
-          :a_method => @foo.a_method,
+          'a_method' => @foo.a_method,
         },
         'href' => "http://test.org/prefix/foos/#{@foo.id}",
       }
@@ -169,7 +161,7 @@ describe Restful::Serializer do
         'foo' => { 
           'id' => @foo.id,
           'name' => @foo.name,
-          :a_method => @foo.a_method,
+          'a_method' => @foo.a_method,
         },
         'href' => "http://test.org/prefix/foos/#{@foo.id}",
       }
@@ -285,7 +277,7 @@ describe Restful::Serializer do
           'name' => @bar1.name,
           'bar'  =>  {
             'name' => @bar1.name,
-            :dingos => [
+            'dingos' => [
               { 'name' => @dingo1.name, 'id' => @dingo1.id, }, 
               { 'name' => @dingo2.name, 'id' => @dingo2.id, }, 
             ],
@@ -298,7 +290,7 @@ describe Restful::Serializer do
           'name' => @bar2.name,
           'bar'  =>  {
             'name' => @bar2.name,
-            :dingos => [
+            'dingos' => [
               { 'name' => @dingo3.name, 'id' => @dingo3.id, }, 
               { 'name' => @dingo4.name, 'id' => @dingo4.id, }, 
             ],
@@ -399,3 +391,29 @@ describe Restful::Serializer do
     end
   end
 end
+
+describe Restful::DeepHash do
+  it "should deeply stringify keys" do
+    h = Restful::DeepHash[
+      :foo => {
+        :bar => 1
+      },
+      :members => [
+        { :id => 1 },
+        { :id => 2 },
+      ]
+    ]
+    h2 = h.deeply_stringify_keys!
+    h.should == {
+      'foo' => {
+        'bar' => 1,
+      },
+      'members' => [
+        { 'id' => 1 },
+        { 'id' => 2 },
+      ],
+    }
+    h.should equal(h2)
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: restful_serializer
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Josh Partlow
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 -07:00
+date: 2011-05-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency