serialize_with_options 0.2.1 → 0.3.0

data/README.markdown

@@ -1,6 +1,8 @@
 SerializeWithOptions
 ====================
 
+[![Code Climate](https://codeclimate.com/github/vigetlabs/serialize_with_options.png)](https://codeclimate.com/github/vigetlabs/serialize_with_options)
+
 This plugin is designed to make creating XML and JSON APIs for your Rails apps dead simple. We noticed a lot of repetition when creating API responses in our controllers. With this plugin, you can set the serialization options for a model with a simple DSL, rather than repeating them in every controller that includes it.
 
 
@@ -76,7 +78,7 @@ And run "`bundle install`"
 
 * * *
 
-Copyright (c) 2009-2011 David Eisinger ([Viget Labs][vgt]), released under the MIT license.
+Copyright (c) 2009-2014 David Eisinger & Zachary Porter ([Viget Labs][vgt]), released under the MIT license.
 
 [ser]: http://api.rubyonrails.org/classes/ActiveRecord/Serialization.html
 [vgt]: http://www.viget.com/

data/lib/serialize_with_options.rb

@@ -67,25 +67,18 @@ module SerializeWithOptions
   end
 
   module InstanceMethods
-    def to_xml(opts = {})
-      set, opts = parse_serialization_options(opts)
-      super(self.class.serialization_options(set).deep_merge(opts))
-    end
-
-    def as_json(opts = nil)
-      set, opts = parse_serialization_options(opts)
-      super(self.class.serialization_options(set).deep_merge(opts || {}))
+    %w(to_xml to_json as_json).each do |method_name|
+      define_method method_name do |*args|
+        set, opts = parse_serialization_options(args)
+        super self.class.serialization_options(set).deep_merge(opts)
+      end
     end
 
     private
 
-    def parse_serialization_options(opts)
-      if opts.is_a? Symbol
-        set  = opts
-        opts = {}
-      else
-        set  = :default
-      end
+    def parse_serialization_options(args)
+      opts = args.extract_options!
+      set = args.shift || :default
 
       [set, opts]
     end

data/lib/serialize_with_options/version.rb

@@ -1,3 +1,3 @@
 module SerializeWithOptions
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/serialize_with_options.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "activerecord", "~> 3.0"
+  s.add_dependency "activerecord", "~> 4.0"
 
   s.add_development_dependency "shoulda"
   s.add_development_dependency "sqlite3"

data/test/serialize_with_options_test.rb

@@ -78,7 +78,7 @@ class Review < ActiveRecord::Base
   end
 end
 
-class SerializeWithOptionsTest < Test::Unit::TestCase
+class SerializeWithOptionsTest < Minitest::Test
   def self.should_serialize_with_options
     should "include active_record attributes" do
       assert_equal @user.name, @user_hash["name"]
@@ -181,19 +181,33 @@ class SerializeWithOptionsTest < Test::Unit::TestCase
 
       should "serialize the associated object properly" do
         review_hash = Hash.from_xml(@review.to_xml)
-        assert_equal @user.email, review_hash["review"]["reviewable"]["email"]
+        assert_equal @user.name, review_hash["review"]["reviewable"]["name"]
       end
     end
 
     context "being converted to JSON" do
       setup do
-        @user_hash = JSON.parse(@user.to_json)["user"]
-        @post_hash = JSON.parse(@post.to_json)["post"]
-        @blog_post_hash = JSON.parse(@blog_post.to_json)["blog_post"]
+        @user_hash = JSON.parse(@user.to_json)
+        @post_hash = JSON.parse(@post.to_json)
+        @blog_post_hash = JSON.parse(@blog_post.to_json)
       end
 
       should_serialize_with_options
     end
+    
+    context 'passing options to the serializer' do
+      setup do
+        @user_hash = @user.as_json(:with_email, :root => 'custom_root')['custom_root']
+      end
+      
+      should "include active_record attributes" do
+        assert_equal @user.name, @user_hash["name"]
+      end
+
+      should "exclude specified attributes" do
+        assert_equal @user.email, @user_hash["email"]
+      end
+    end
 
     context "serializing associated models" do
       setup do
@@ -202,7 +216,7 @@ class SerializeWithOptionsTest < Test::Unit::TestCase
       end
 
       should "find associations with multi-word names" do
-        user_hash = JSON.parse(@user.to_json(:with_check_ins))["user"]
+        user_hash = JSON.parse(@user.to_json(:with_check_ins))
         assert_equal @check_in.code_name, user_hash['check_ins'].first['code_name']
       end
 

data/test/test_helper.rb

@@ -3,7 +3,7 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
 require 'active_record'
-require 'test/unit'
+require 'minitest/autorun'
 require 'shoulda'
 require 'json'
 require 'serialize_with_options'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serialize_with_options
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70169796710200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70169796710200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70169796709760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70169796709760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70169796709180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70169796709180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple XML and JSON APIs for your Rails app
 email:
 - david.eisinger@gmail.com
@@ -82,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: serialize_with_options
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple XML and JSON APIs for your Rails app