restpack-resource 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restpack-resource (0.0.3)
+    restpack-resource (0.0.4)
       activesupport (~> 3.2.11)
       dm-pager (~> 1.1.0)
 

data/lib/restpack-resource/resource/pageable.rb

@@ -16,7 +16,7 @@ module RestPack
         paged_resource = {
           :page => page.pager.current_page,
           :page_count => page.pager.total_pages,
-          :total => page.pager.total,
+          :count => page.pager.total,
           :previous_page => page.pager.previous_page,
           :next_page => page.pager.next_page
         }
@@ -25,7 +25,7 @@ module RestPack
 
         unless page.empty?
           options[:includes].each do |association|
-            paged_resource[association] = side_load(page, association)
+            add_side_loads(paged_resource, page, association)
           end
         end
 
@@ -39,7 +39,7 @@ module RestPack
         options[:scope].all(:conditions => options[:filters]).page(options[:page], :order => order)
       end
       
-      def side_load(page, association)
+      def add_side_loads(paged_resource, page, association)
         target_model_name = association.to_s.singularize.capitalize              
         relationships = self.relationships.select {|r| r.target_model.to_s == target_model_name }
         raise InvalidInclude if relationships.empty?
@@ -47,18 +47,30 @@ module RestPack
         side_loaded_entities = []
 
         relationships.each do |relationship|
-          unless relationship.is_a? DataMapper::Associations::ManyToOne::Relationship
+          if relationship.is_a? DataMapper::Associations::ManyToOne::Relationship
+            side_loaded_entities += page.map do |entity| #TODO: GJ: PERF: we can bypass datamapper associations and get by a list of ids instead
+              relation = entity.send(relationship.name.to_sym)
+              relation ? relation.to_resource : nil
+            end
+          elsif relationship.is_a? DataMapper::Associations::OneToMany::Relationship
+            parent_key_name = relationship.parent_key.first.name
+            child_key_name = relationship.child_key.first.name        
+            foreign_keys = page.map {|e| e.send(parent_key_name)}.uniq
+                
+            #TODO: GJ: configurable side-load page size
+            children = relationship.child_model.all(child_key_name.to_sym => foreign_keys).page({ per_page: 100 })
+            side_loaded_entities += children.map { |c| c.to_resource }
+            
+            count_key = "#{relationship.child_model_name.downcase}_count".to_sym
+            paged_resource[count_key] = children.pager.total
+          else
             raise InvalidInclude, "#{self.name}.#{relationship.name} can't be included when paging #{self.name.pluralize.downcase}"
           end
-          side_loaded_entities += page.map do |entity| #TODO: GJ: PERF: we can bypass datamapper associations and get by a list of ids instead
-            relation = entity.send(relationship.name.to_sym)
-            relation ? relation.to_resource : nil
-          end
-          side_loaded_entities.uniq!
-          side_loaded_entities.compact!
         end
         
-        side_loaded_entities
+        side_loaded_entities.uniq!
+        side_loaded_entities.compact!
+        paged_resource[association] = side_loaded_entities
       end
       
       def resource_collection_name

data/lib/restpack-resource/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Resource
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/resource/filterable_spec.rb

@@ -12,12 +12,12 @@ describe RestPack::Resource do
         
         it "should return the total count" do
           result = Song.paged_resource()
-          result[:total].should == 12
+          result[:count].should == 12
         end
         
         it "should filter results" do
           result = Song.paged_resource(artist_id: @artist.id)
-          result[:total].should == 3
+          result[:count].should == 3
         end
       end
     end

data/spec/resource/pageable_spec.rb

@@ -11,7 +11,7 @@ describe RestPack::Resource do
         it "should return an empty array" do
           result = Song.paged_resource()
           result.should_not == nil
-          result[:songs].should_not == nil
+          result[:songs].should == []
         end
       end
       
@@ -23,7 +23,7 @@ describe RestPack::Resource do
         it "has a valid first page" do
           result = Artist.paged_resource()
           result[:page].should == 1
-          result[:total].should == 16
+          result[:count].should == 16
           result[:page_count].should == 2
           result[:previous_page].should == nil
           result[:next_page].should == 2
@@ -38,51 +38,67 @@ describe RestPack::Resource do
           result[:artists].size.should == 6
         end
       
-        context "when including relations" do        
-          it "should not allow invalid relations" do
-            expect do
-              Artist.paged_resource(:includes => 'invalid_relations')
-            end.to raise_error(RestPack::Resource::InvalidInclude, "Artist.invalid_relations is not an includable relation")
-          end
-        
-          it "should not allow includes that have not been specified with 'resource_can_include' NEW" do
-            expect do
-              Comment.paged_resource(:includes => 'songs')
-            end.to raise_error(RestPack::Resource::InvalidInclude, "Comment.songs is not an includable relation")
-          end
-        
-          it "should not allow a 'has_many' include when paging" do
-            expect do
-              Artist.paged_resource(:includes => 'songs')
-            end.to raise_error(RestPack::Resource::InvalidInclude, "Artist.songs can't be included when paging artists")
-          end
-        
-          it "should return related entities from a 'belongs_to' relationship" do
-            result = Song.paged_resource(:includes => 'artists')
-            result.should_not == nil
-            result[:artists].should_not == nil
-            result[:artists].size.should == 10
-          end
-        
-          it "should allow multiple includes" do
-            result = Song.paged_resource(:includes => 'artists,users')
-            result.should_not == nil
-            result[:artists].should_not == nil
-            result[:artists].size.should == 10
-            result[:users].size.should == 20
-          end
-        
+        context "when side-loading" do
           it "should return related entities with their #to_resource representation" do
             result = Song.paged_resource(:includes => 'users')
             result[:users][0][:custom].should == 'This is custom data'
           end
-        
+
           context "when specifying overrides" do
             it "should give overrides precidence" do
               result = Artist.paged_resource({ page: 2 }, { page: 3 })
               result[:page].should == 3
             end
           end
+          
+          it "should not allow invalid relations" do
+            expect do
+              Artist.paged_resource(:includes => 'invalid_relations')
+            end.to raise_error(RestPack::Resource::InvalidInclude, "Artist.invalid_relations is not an includable relation")
+          end
+
+          
+          context "ManyToOne" do
+            it "should not allow includes that have not been specified with 'resource_can_include'" do
+              expect do
+                Comment.paged_resource(:includes => 'songs')
+              end.to raise_error(RestPack::Resource::InvalidInclude, "Comment.songs is not an includable relation")
+            end
+
+            it "should return related entities from a 'belongs_to' relationship" do
+              result = Song.paged_resource(:includes => 'artists')
+              result.should_not == nil
+              result[:artists].should_not == nil
+              result[:artists].size.should == 10
+            end
+
+            it "should allow multiple includes" do
+              result = Song.paged_resource(:includes => 'artists,users')
+              result.should_not == nil
+              result[:artists].should_not == nil
+              result[:artists].size.should == 10
+              result[:users].size.should == 20
+            end
+          end
+          
+          
+          context "OneToMany" do
+            before(:each) do
+              @artist_with_two_songs = Artist.first
+              create(:song, artist: @artist_with_two_songs)
+            end
+            
+            it "should return related entities from a 'has n' relationship" do
+              result = Artist.paged_resource(:includes => 'songs')
+              result.should_not == nil
+              result[:songs].should_not == nil
+              result[:songs].size.should == 11
+              
+              result[:songs].select { |song| song.artist == @artist_with_two_songs }.length.should == 2
+              result[:song_count].should == 11
+            end
+          end
+          
         end
       end
     end

data/spec/resource/sortable_spec.rb

@@ -18,23 +18,23 @@ describe RestPack::Resource do
         
         it "should default to ascending" do
           result = Artist.paged_resource(:sort_by => :id)
-          result[:total].should == Artist.count
+          result[:count].should == Artist.count
           result[:artists].first[:id].should == 1
           result[:artists].last[:id].should == 10
         end
 
         it "should allow sort_direction of descending" do
           result = Artist.paged_resource(:sort_by => :id, :sort_direction => :descending)
-          result[:total].should == Artist.count
+          result[:count].should == Artist.count
           result[:artists].first[:id].should == 20
           result[:artists].last[:id].should == 11
         end
 
         it "should allow sort_by and sort_direction to be string or symbol" do
           result = Artist.paged_resource(:sort_by => 'id', :sort_direction => 'descending')
-          result[:total].should == Artist.count
+          result[:count].should == Artist.count
           result = Artist.paged_resource(:sort_by => :id, :sort_direction => :descending)
-          result[:total].should == Artist.count
+          result[:count].should == Artist.count
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restpack-resource
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport