restpack_serializer 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90d1438faf15f90e22381b152265374f8ad53543
-  data.tar.gz: 0fcbd12fbc3df348107fe579e5ea9e5103901529
+  metadata.gz: 477bc16aca491e5318b8665a209f293ac5d4b933
+  data.tar.gz: 9f5e498a6996a42b0e6cada857128a23412e5126
 SHA512:
-  metadata.gz: 0d4d76207155ad77ae9547c4f2439c9c6d5a7c8b9c5463aabf1d93e4d21d567c9e51169536a18f5619d407919b61c867bd754829e9095eea81dc2f67b166df04
-  data.tar.gz: 2900f4a1a0bbfe320d5daf0e5194a72d65f917a015b159253a8a5004007a52b1470fed900e9ba9abc9ea23bfce6b1ad69a934c5633b764893f35df6720ee75be
+  metadata.gz: a9c20b94f9c75a1b18c38dd89a7e32686cc94e9c6101f29d52dbe937bb01d034047b8b8933886e89549a7433e77f417ac2a4a6e958f740797301944652ab1323
+  data.tar.gz: ed68635e42185820ff8d39fc4b5ad5e4f76c33f0f89e67fbe326228c2c2c8c0623309f28976ba625d543297dd30beaec86a586d8cd1956218bf5d811da1d3f5a

data/README.md

@@ -311,3 +311,8 @@ end
 Side-loading is available when filtering:
 
  * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?artist_ids=2,3&include=artists,songs
+
+## Running Tests
+
+`bundle`
+`rake spec`

data/lib/restpack_serializer/options.rb

@@ -1,8 +1,9 @@
 module RestPack::Serializer
   class Options
-    attr_accessor :page, :page_size, :include, :filters, :serializer, :model_class, :scope, :include_links
+    attr_accessor :page, :page_size, :include, :filters, :serializer,
+                  :model_class, :scope, :context, :include_links
 
-    def initialize(serializer, params = {}, scope = nil)
+    def initialize(serializer, params = {}, scope = nil, context = {})
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
 
       @page = 1
@@ -12,6 +13,7 @@ module RestPack::Serializer
       @serializer = serializer
       @model_class = serializer.model_class
       @scope = scope || model_class.send(:all)
+      @context = context
       @include_links = true
 
       @page = params[:page].to_i if params[:page]

data/lib/restpack_serializer/serializable/paging.rb

@@ -2,8 +2,8 @@ module RestPack::Serializer::Paging
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def page(params = {}, scope = nil)
-      page_with_options RestPack::Serializer::Options.new(self, params, scope)
+    def page(params = {}, scope = nil, context = {})
+      page_with_options RestPack::Serializer::Options.new(self, params, scope, context)
     end
 
     def page_with_options(options)
@@ -13,7 +13,7 @@ module RestPack::Serializer::Paging
       )
 
       result = RestPack::Serializer::Result.new
-      result.resources[self.key] = serialize_page(page)
+      result.resources[self.key] = serialize_page(page, options)
       result.meta[self.key] = serialize_meta(page, options)
 
       if options.include_links
@@ -31,8 +31,8 @@ module RestPack::Serializer::Paging
 
     private
 
-    def serialize_page(page)
-      page.map { |model| self.as_json(model) }
+    def serialize_page(page, options)
+      page.map { |model| self.as_json(model, options.context) }
     end
 
     def serialize_meta(page, options)

data/lib/restpack_serializer/serializable/resource.rb

@@ -2,8 +2,8 @@ module RestPack::Serializer::Resource
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def resource(params = {}, scope = nil)
-      page_with_options RestPack::Serializer::Options.new(self, params, scope)
+    def resource(params = {}, scope = nil, context = {})
+      page_with_options RestPack::Serializer::Options.new(self, params, scope, context)
     end
   end
 end

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.11'
+    VERSION = '0.4.12'
   end
 end

data/spec/fixtures/serializers.rb

@@ -4,6 +4,10 @@ module MyApp
     attributes :id, :title, :album_id
     can_include :albums, :artists
     can_filter_by :title
+
+    def title
+      @context[:reverse_title?] ? @model.title.reverse : @model.title
+    end
   end
 
   class AlbumSerializer

data/spec/serializable/paging_spec.rb

@@ -7,8 +7,10 @@ describe RestPack::Serializer::Paging do
   end
 
   context "#page" do
-    let(:page) { MyApp::SongSerializer.page(params) }
+    let(:page) { MyApp::SongSerializer.page(params, scope, context) }
     let(:params) { { } }
+    let(:scope) { nil }
+    let(:context) { { } }
 
     context "with defaults" do
       it "page defaults to 1" do
@@ -61,6 +63,15 @@ describe RestPack::Serializer::Paging do
       end
     end
 
+    context "with context" do
+      let(:context) { { reverse_title?: true } }
+
+      it "returns reversed titles" do
+        first = MyApp::Song.first
+        page[:songs].first[:title].should == first.title.reverse
+      end
+    end
+
     it "serializes results" do
       first = MyApp::Song.first
       page[:songs].first.should == {

data/spec/serializable/resource_spec.rb

@@ -6,14 +6,24 @@ describe RestPack::Serializer::Resource do
     @song = @album.songs.first
   end
 
-  let(:resource) { MyApp::SongSerializer.resource(params) }
+  let(:resource) { MyApp::SongSerializer.resource(params, scope, context) }
   let(:params) { { id: @song.id } }
+  let(:scope) { nil }
+  let(:context) { { } }
 
   it "returns a resource by id" do
     resource[:songs].count.should == 1
     resource[:songs][0][:id].should == @song.id.to_s
   end
 
+  context "with context" do
+    let(:context) { { reverse_title?: true } }
+
+    it "returns reversed titles" do
+      resource[:songs][0][:title].should == @song.title.reverse
+    end
+  end
+
   describe "side-loading" do
     let(:params) { { id: @song.id, include: 'albums' } }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.4.12
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -269,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Model serialization, paging, side-loading and filtering
@@ -290,3 +290,4 @@ test_files:
 - spec/serializable/side_loading/side_loading_spec.rb
 - spec/spec_helper.rb
 - spec/support/factory.rb
+has_rdoc: