restpack_serializer 0.4.25 → 0.4.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d870c817c227fbac2102919ec10f69e727b61d4
-  data.tar.gz: 14b4250d2a77c3d60b9e5c8872150b54503ff1f2
+  metadata.gz: 25923489c94e8e3dfc5b1406afddb1de14555e30
+  data.tar.gz: ba2c8686002cb5d6223df146d00d6a050a66b8b3
 SHA512:
-  metadata.gz: 69e3fc5bc5c44d9c29ed24df5a06a326264e350d8147b9956ea1181546fdef97996145f0c3a7aabb081b5033129ca3e6ca3536ceca7d31c44e01b36c06ab49bb
-  data.tar.gz: fe92f589efcf2273642b1c88d13415d9e75034d79e0eb50c993841a0c9aa6c8689b06a8b474cc1080df6dc69b5931b9a556460f53b2ae1add05e1c947d90d7f6
+  metadata.gz: 02e14de37827c4b899aa05e5d8bae3e8c5a6a3cb2348d2666bf4861933c3b6149e90df576fb10d2f541bb0a868fcc88de004fbe0b321377f1e94c281c30f04c3
+  data.tar.gz: 11dda7d263ad9263051518a7516c6bfa0f23575128b62d09889c4839db48c2caf6ce481091415a642c51b8d9ef4b8e1bfcc632e79e688b00b68db0db25be94b2

data/README.md

@@ -345,6 +345,23 @@ Side-loading is available when filtering:
 
  * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?artist_ids=2,3&include=artists,songs
 
+## Sorting
+
+Sorting attributes can be defined with the `can_sort_by` option:
+
+ ```ruby
+class Account
+    include RestPack::Serializer
+    attributes :id, :application_id, :created_by, :name, :href
+
+    can_sort_by :id, :name
+end
+```
+
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?sort=id
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?sort=-name
+ * http://restpack-serializer-sample.herokuapp.com/api/v1/albums.json?sort=name,-id
+
 ## Running Tests
 
 `bundle`

data/lib/restpack_serializer/options.rb

@@ -1,7 +1,8 @@
 module RestPack::Serializer
   class Options
     attr_accessor :page, :page_size, :include, :filters, :serializer,
-                  :model_class, :scope, :context, :include_links
+                  :model_class, :scope, :context, :include_links,
+                  :sorting
 
     def initialize(serializer, params = {}, scope = nil, context = {})
       params.symbolize_keys! if params.respond_to?(:symbolize_keys!)
@@ -10,6 +11,7 @@ module RestPack::Serializer
       @page_size = RestPack::Serializer.config.page_size
       @include = []
       @filters = filters_from_params(params, serializer)
+      @sorting = sorting_from_params(params, serializer)
       @serializer = serializer
       @model_class = serializer.model_class
       @scope = scope || model_class.send(:all)
@@ -42,6 +44,11 @@ module RestPack::Serializer
       @filters.sort.map {|k,v| "#{k}=#{v.join(',')}" }.join('&')
     end
 
+    def sorting_as_url_params
+      sorting_values = sorting.map { |k, v| v == :asc ? k : "-#{k}" }.join(',')
+      "sort=#{sorting_values}"
+    end
+
     private
 
     def filters_from_params(params, serializer)
@@ -53,5 +60,18 @@ module RestPack::Serializer
       end
       filters
     end
+
+    def sorting_from_params(params, serializer)
+      sort_values = params[:sort] && params[:sort].split(',')
+      return {} if sort_values.blank? || serializer.serializable_sorting_attributes.blank?
+      sorting_parameters = {}
+
+      sort_values.each do |sort_value|
+        sort_order = sort_value[0] == '-' ? :desc : :asc
+        sort_value = sort_value.gsub(/\A\-/, '').downcase.to_sym
+        sorting_parameters[sort_value] = sort_order if serializer.serializable_sorting_attributes.include?(sort_value)
+      end
+      sorting_parameters
+    end
   end
 end

data/lib/restpack_serializer/serializable/attributes.rb

@@ -2,7 +2,7 @@ module RestPack::Serializer::Attributes
   extend ActiveSupport::Concern
 
   def default_href
-    "#{RestPack::Serializer.config.href_prefix}/#{self.class.key}/#{@model.id}"
+    "#{RestPack::Serializer.config.href_prefix}/#{self.class.key}/#{@model.to_param}"
   end
 
   module ClassMethods

data/lib/restpack_serializer/serializable/paging.rb

@@ -8,6 +8,7 @@ module RestPack::Serializer::Paging
 
     def page_with_options(options)
       page = options.scope_with_filters.page(options.page).per(options.page_size)
+      page = page.reorder(options.sorting) if options.sorting.any?
 
       result = RestPack::Serializer::Result.new
       result.resources[self.key] = serialize_page(page, options)
@@ -58,6 +59,7 @@ module RestPack::Serializer::Paging
       params << "page=#{page}" unless page == 1
       params << "page_size=#{options.page_size}" unless options.default_page_size?
       params << "include=#{options.include.join(',')}" if options.include.any?
+      params << options.sorting_as_url_params if options.sorting.any?
       params << options.filters_as_url_params if options.filters.any?
 
       url += '?' + params.join('&') if params.any?

data/lib/restpack_serializer/serializable/sortable.rb

@@ -0,0 +1,14 @@
+module RestPack::Serializer::Sortable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    attr_reader :serializable_sorting_attributes
+
+    def can_sort_by(*attributes)
+      @serializable_sorting_attributes = []
+      attributes.each do |attribute|
+        @serializable_sorting_attributes << attribute.to_sym
+      end
+    end
+  end
+end

data/lib/restpack_serializer/serializable.rb

@@ -7,6 +7,7 @@ require_relative "serializable/resource"
 require_relative "serializable/single"
 require_relative "serializable/side_loading"
 require_relative "serializable/symbolizer"
+require_relative "serializable/sortable"
 
 module RestPack
   module Serializer
@@ -26,6 +27,7 @@ module RestPack
     include RestPack::Serializer::Attributes
     include RestPack::Serializer::Filterable
     include RestPack::Serializer::SideLoading
+    include RestPack::Serializer::Sortable
 
     class InvalidInclude < Exception; end
 

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.4.25'
+    VERSION = '0.4.26'
   end
 end

data/spec/fixtures/db.rb

@@ -57,6 +57,8 @@ module MyApp
   end
 
   class Song < ActiveRecord::Base
+    default_scope -> { order(id: :asc) }
+
     attr_accessible :title, :artist, :album
 
     belongs_to :artist

data/spec/fixtures/serializers.rb

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

data/spec/serializable/options_spec.rb

@@ -59,6 +59,33 @@ describe RestPack::Serializer::Options do
     end
   end
 
+  context 'with sorting parameters' do
+    describe 'with no params' do
+      let(:params) { { } }
+      it { subject.sorting.should == {} }
+    end
+    describe 'with a sorting value' do
+      let(:params) { { 'sort' => 'Title' } }
+      it { subject.sorting.should == { title: :asc } }
+      it { subject.sorting_as_url_params.should == 'sort=title' }
+    end
+    describe 'with a descending sorting value' do
+      let(:params) { { 'sort' => '-title' } }
+      it { subject.sorting.should == { title: :desc } }
+      it { subject.sorting_as_url_params.should == 'sort=-title' }
+    end
+    describe 'with multiple sorting values' do
+      let(:params) { { 'sort' => '-Title,ID' } }
+      it { subject.sorting.should == { title: :desc, id: :asc } }
+      it { subject.sorting_as_url_params.should == 'sort=-title,id' }
+    end
+    describe 'with a not allowed sorting value' do
+      let(:params) { { 'sort' => '-title,album_id,id' } }
+      it { subject.sorting.should == { title: :desc, id: :asc } }
+      it { subject.sorting_as_url_params.should == 'sort=-title,id' }
+    end
+  end
+
   context 'scopes' do
     describe 'with default scope' do
       it { subject.scope.should == MyApp::Song.all }

data/spec/serializable/paging_spec.rb

@@ -180,6 +180,28 @@ describe RestPack::Serializer::Paging do
       end
     end
 
+    context 'when sorting' do
+      context 'with no sorting' do
+        let(:params) { {} }
+
+        it "uses the model's sorting" do
+          page[:songs].first[:id].to_i.should < page[:songs].last[:id].to_i
+        end
+      end
+
+      context 'with descending title sorting' do
+        let(:params) { { sort: '-title' } }
+
+        it 'returns a page with sorted songs' do
+          page[:songs].first[:title].should > page[:songs].last[:title]
+        end
+
+        it 'includes the sorting in page hrefs' do
+          page[:meta][:songs][:next_href].should == '/songs?page=2&sort=-title'
+        end
+      end
+    end
+
     context "with custom scope" do
       before do
         FactoryGirl.create(:album, year: 1930)

data/spec/serializable/serializer_spec.rb

@@ -15,6 +15,10 @@ describe RestPack::Serializer do
     def self.table_name
       "people"
     end
+
+    def to_param
+      id.to_s
+    end
   end
 
   context "bare bones serializer" do

data/spec/serializable/sortable_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RestPack::Serializer::Sortable do
+  class CustomSerializer
+    include RestPack::Serializer
+    attributes :a, :b, :c
+
+    can_sort_by :a, :c
+  end
+
+  it 'captures the specified sorting attributes' do
+    CustomSerializer.serializable_sorting_attributes.should == [:a, :c]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.25
+  version: 0.4.26
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -231,6 +231,7 @@ files:
 - lib/restpack_serializer/serializable/resource.rb
 - lib/restpack_serializer/serializable/side_loading.rb
 - lib/restpack_serializer/serializable/single.rb
+- lib/restpack_serializer/serializable/sortable.rb
 - lib/restpack_serializer/serializable/symbolizer.rb
 - lib/restpack_serializer/version.rb
 - restpack_serializer.gemspec
@@ -249,6 +250,7 @@ files:
 - spec/serializable/side_loading/has_many_spec.rb
 - spec/serializable/side_loading/side_loading_spec.rb
 - spec/serializable/single_spec.rb
+- spec/serializable/sortable_spec.rb
 - spec/spec_helper.rb
 - spec/support/factory.rb
 homepage: https://github.com/RestPack
@@ -290,6 +292,7 @@ test_files:
 - spec/serializable/side_loading/has_many_spec.rb
 - spec/serializable/side_loading/side_loading_spec.rb
 - spec/serializable/single_spec.rb
+- spec/serializable/sortable_spec.rb
 - spec/spec_helper.rb
 - spec/support/factory.rb
 has_rdoc: