restpack-resource 0.0.9 → 0.1.0

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 group :test do
   gem 'rake', '~> 10.0.3'
   gem 'rspec', :require => 'spec'
-  gem 'datamapper', '~> 1.2.0'
   gem 'dm-sqlite-adapter', '~> 1.2.0'
   gem 'factory_girl', '~> 4.2.0'
 end

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,4 @@
-# restpack-resource [![Build Status](https://api.travis-ci.org/RestPack/restpack-resource.png?branch=master)](https://travis-ci.org/RestPack/restpack-resource) [![Code Climate](https://codeclimate.com/github/RESTpack/restpack-resource.png)](https://codeclimate.com/github/RESTpack/restpack-resource) [![Dependency Status](https://gemnasium.com/RestPack/restpack-resource.png)](https://gemnasium.com/RestPack/restpack-resource)
+# restpack-resource [![Build Status](https://api.travis-ci.org/RestPack/restpack-resource.png?branch=master)](https://travis-ci.org/RestPack/restpack-resource) [![Code Climate](https://codeclimate.com/github/RestPack/restpack-resource.png)](https://codeclimate.com/github/RestPack/restpack-resource) [![Dependency Status](https://gemnasium.com/RestPack/restpack-resource.png)](https://gemnasium.com/RestPack/restpack-resource)
 
 RESTful resource paging, side-loading, filtering and sorting. 
 

data/Rakefile

@@ -1,3 +1,5 @@
+require_relative 'lib/restpack-resource/version'
+
 task :default => :test
 task :test => :spec
 

data/lib/restpack-resource/resource.rb

@@ -23,7 +23,36 @@ module RestPack
 
     module ClassMethods
       def model_as_resource(model)
-        model.as_resource() 
+        model ? model.as_resource() : nil
+      end
+      
+      def association_relationships(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?
+        relationships
+      end
+      
+      def get_child_models(relationship, foreign_keys, page_size)
+        child_key_name = relationship.child_key.first.name
+        relationship.child_model.all(child_key_name.to_sym => foreign_keys).page({ per_page: page_size })
+      end
+      
+      def get_one_to_many_side_loads(relationship, foreign_keys)
+        result = {}            
+        children = get_child_models(relationship, foreign_keys, 100) #TODO: GJ: configurable side-load page size
+        result[:resources] = children.map {|c| c.as_resource() }
+        result[:count_key] = "#{relationship.child_model_name.downcase}_count".to_sym
+        result[:count] = children.pager.total
+        result
+      end
+      
+      def extract_includes_array_from_params(params)
+        params[:includes].nil? ? [] : params[:includes].split(',')
+      end
+      
+      def invalid_include(relationship)
+        raise InvalidInclude, "#{self.name}.#{relationship.name} can't be included when paging #{self.name.pluralize.downcase}"
       end
     end
   end

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

@@ -11,66 +11,67 @@ module RestPack
       protected
       
       def get_paged_resource(options)
-        page = get_page(options)        
+        paged_models = get_paged_models(options)        
 
         paged_resource = {
-          :page => page.pager.current_page,
-          :page_count => page.pager.total_pages,
-          :count => page.pager.total,
-          :previous_page => page.pager.previous_page,
-          :next_page => page.pager.next_page
+          :page => paged_models.pager.current_page,
+          :page_count => paged_models.pager.total_pages,
+          :count => paged_models.pager.total,
+          :previous_page => paged_models.pager.previous_page,
+          :next_page => paged_models.pager.next_page
         }
 
-        paged_resource[self.resource_collection_name] = page.map { |item| model_as_resource(item) }
+        paged_resource[self.resource_collection_name] = paged_models.map { |model| model_as_resource(model) }
 
-        unless page.empty?
+        unless paged_models.empty?
           options[:includes].each do |association|
-            add_side_loads(paged_resource, page, association)
+            paged_resource.merge! get_side_loads(paged_models, association)
           end
         end
 
         paged_resource
       end
       
-      def get_page(options)
+      def get_paged_models(options)
         order = options[:sort_by]
         order = order.desc if order && options[:sort_direction] == :descending
         
         options[:scope].all(:conditions => options[:filters]).page(options[:page], :order => order)
       end
       
-      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?
+      def get_side_loads(paged_models, association)
+        side_loads = {}
+        resources = []
 
-        side_loaded_entities = []
-
-        relationships.each do |relationship|
+        association_relationships(association).each do |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 ? model_as_resource(relation) : 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| model_as_resource(c) }
-            
-            count_key = "#{relationship.child_model_name.downcase}_count".to_sym
-            paged_resource[count_key] = children.pager.total
+            resources += get_many_to_one_side_loads(paged_models, relationship)
+          elsif relationship.is_a? DataMapper::Associations::OneToMany::Relationship    
+            foreign_keys = get_foreign_keys(paged_models, relationship)        
+            side_load = get_one_to_many_side_loads(relationship, foreign_keys)
+            resources += side_load[:resources]
+            side_loads[side_load[:count_key]] = side_load[:count]
           else
-            raise InvalidInclude, "#{self.name}.#{relationship.name} can't be included when paging #{self.name.pluralize.downcase}"
+            invalid_include relationship
           end
         end
         
-        side_loaded_entities.uniq!
-        side_loaded_entities.compact!
-        paged_resource[association] = side_loaded_entities
+        side_loads[association] = resources.uniq.compact
+        side_loads
+      end
+      
+      def get_many_to_one_side_loads(paged_models, relationship)
+        paged_models.map do |model|
+          relation = model.send(relationship.name.to_sym)
+          model_as_resource(relation)
+        end
+      end
+      
+      
+      
+      def get_foreign_keys(paged_models, relationship)
+        parent_key_name = relationship.parent_key.first.name
+        paged_models.map {|e| e.send(parent_key_name)}.uniq
       end
       
       def resource_collection_name
@@ -80,7 +81,7 @@ module RestPack
       def build_paged_options(params, overrides)        
         options = overrides.reverse_merge( #overrides take precedence over params
           :page => params[:page],
-          :includes => params[:includes].nil? ? [] : params[:includes].split(','),
+          :includes => extract_includes_array_from_params(params),
           :filters =>  self.extract_filters_from_params(params),
           :sort_by => params[:sort_by], 
           :sort_direction => params[:sort_direction]

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

@@ -1,6 +1,5 @@
 module RestPack
   module Resource
-    #NOTE: GJ: this need a great big refactor
     module Single      
       def single_resource(params = {}, overrides = {})
         options = build_single_options(params, overrides)
@@ -16,51 +15,40 @@ module RestPack
         resource = model_as_resource(model)
         
         options[:includes].each do |association|
-          add_single_side_loads(resource, model, association)
+          resource.merge! get_single_side_loads(model, association)
         end
         
         resource
       end
       
-      def add_single_side_loads(resource, model, 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?
+      def get_single_side_loads(model, association)        
+        side_loads = {}
+        resources = []
 
-        side_loaded_entities = []
-
-        relationships.each do |relationship|
+        association_relationships(association).each do |relationship|
           if relationship.is_a? DataMapper::Associations::ManyToOne::Relationship
             relation = model.send(relationship.name.to_sym)
-            
-            side_loaded_entities << (relation ? model_as_resource(relation) : nil)
+            resources << model_as_resource(relation)
           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_key = model.send(parent_key_name)
-                
-            #TODO: GJ: configurable side-load page size
-            children = relationship.child_model.all(child_key_name.to_sym => foreign_key).page({ per_page: 100 })
-            side_loaded_entities += children.map { |c| model_as_resource(c) }
+            foreign_keys = [model.send(parent_key_name)]
             
-            count_key = "#{relationship.child_model_name.downcase}_count".to_sym
-            resource[count_key] = children.pager.total
+            side_load = get_one_to_many_side_loads(relationship, foreign_keys)
+            resources += side_load[:resources]
+            side_loads[side_load[:count_key]] = side_load[:count]
           else
-            raise InvalidInclude, "#{self.name}.#{relationship.name} can't be included when paging #{self.name.pluralize.downcase}"
+            invalid_include relationship
           end
         end
-        
-        side_loaded_entities.uniq!
-        side_loaded_entities.compact!
-        
-        resource[association] = side_loaded_entities
+
+        side_loads[association] = resources.uniq.compact
+        side_loads
       end
       
       def build_single_options(params, overrides)        
         options = overrides.reverse_merge( #overrides take precedence over params
           :id => params[:id],
-          :includes => params[:includes].nil? ? [] : params[:includes].split(',') #TODO: GJ: refactor, repeated in pageable
+          :includes => extract_includes_array_from_params(params)
         )
         
         options.reverse_merge!( #defaults

data/lib/restpack-resource/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Resource
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 end

data/restpack-resource.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_dependency 'activesupport', '~> 3.2.11'
+  gem.add_dependency 'datamapper', '~> 1.2.0'
   gem.add_dependency 'dm-pager', '~> 1.1.0'
   
   gem.add_development_dependency 'rspec', '~> 2.12'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restpack-resource
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: datamapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: dm-pager
   requirement: !ruby/object:Gem::Requirement
@@ -102,21 +118,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1427584335195097292
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1427584335195097292
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '...'