muster 0.0.7 → 0.0.8

data/Authors

@@ -1,2 +1,2 @@
-- Chris Laco <claco@chrislaco.com?
-- Nikica Jokić (neektza@gmail.com)
+- Chris Laco <claco@chrislaco.com>
+- Nikica Jokić <neektza@gmail.com>

data/Changes

@@ -1,6 +1,10 @@
+= 0.0.8
+
+* Added JoinsExpressions to ActiveRecord Strategy (includes) (neektza)
+
 = 0.0.7
 
-* Added JoinsExpressions to ActiveRecord Strategy (neektza)
+* Added JoinsExpressions to ActiveRecord Strategy (joins) (neektza)
 
 = 0.0.6
 

data/lib/muster/strategies/active_record.rb

@@ -42,7 +42,8 @@ module Muster
           :limit    => pagination[:limit],
           :offset   => pagination[:offset],
           :where    => self.parse_where(query_string),
-          :joins    => self.parse_joins(query_string)
+          :joins    => self.parse_joins(query_string),
+          :includes => self.parse_includes(query_string)
         )
 
         parameters.regular_writer('pagination', pagination[:pagination].symbolize_keys)
@@ -131,6 +132,22 @@ module Muster
 
         return results[:joins] || {}
       end
+      
+      # Returns includes clauses for AR queries
+      #
+      # @param query_string [String] the original query string to parse join statements from
+      #
+      # @return [Hash]
+      #
+      # @example
+      #
+      #   value = self.parse_joins('includes=authors')  #=> {'includes' => 'authors'}
+      def parse_includes( query_string )
+        strategy = Muster::Strategies::JoinsExpression.new(:field => :includes)
+        results  = strategy.parse(query_string)
+
+        return results[:includes] || {}
+      end
 
     end
   end

data/lib/muster/version.rb

@@ -1,4 +1,4 @@
 module Muster
   # Current version of Muster
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/muster/strategies/active_record_spec.rb

@@ -6,7 +6,7 @@ describe Muster::Strategies::ActiveRecord do
 
   describe '#parse' do
     it 'returns a Muster::Results instance' do
-      subject.parse('').should == {"select"=>[], "order"=>[], "limit"=>30, "offset"=>nil, "where"=>{}, "joins"=>{}, "pagination"=>{:page=>1, :per_page=>30}}
+      subject.parse('').should == {"select"=>[], "order"=>[], "limit"=>30, "offset"=>nil, "where"=>{}, "joins"=>{}, "includes"=>{}, "pagination"=>{:page=>1, :per_page=>30}}
       subject.parse('').should be_an_instance_of(Muster::Results)
     end
 
@@ -67,6 +67,24 @@ describe Muster::Strategies::ActiveRecord do
       end
     end
 
+    context 'includes' do
+      it 'returns single value in Array' do
+        subject.parse('includes=author')[:includes].should eq ['author']
+      end
+      
+      it 'returns multiple values in Array' do
+        subject.parse('includes=author,voter')[:includes].should eq ['author', 'voter']
+      end
+
+      it 'returns a nested hash of separated values' do
+        subject.parse('includes=author.country.name')[:includes].should eq [{'author' => { 'country' => 'name'}}]
+      end
+      
+      it 'returns an array of nested hashes' do
+        subject.parse('includes=author.country.name,activity.rule')[:includes].should eq [{'author' => { 'country' => 'name'}}, {'activity' => 'rule'}]
+      end
+    end
+
     context 'pagination' do
       it 'returns default will paginate compatible pagination' do
         subject.parse('')[:pagination].should == {:page => 1, :per_page => 30}
@@ -132,24 +150,28 @@ describe Muster::Strategies::ActiveRecord do
 
     context 'the full monty' do
       it 'returns a hash of all options' do
-        query_string = 'select=id,guid,name&where=name:foop&order=id:desc&order=name&page=3&page_size=5'
+        query_string = 'select=id,guid,name&where=name:foop&order=id:desc&order=name&page=3&page_size=5&includes=author.country,comments&joins=activity'
         results = subject.parse(query_string)
 
         results[:select].should == ['id', 'guid', 'name']
         results[:where].should  == {'name' => 'foop'}
         results[:order].should  == ['id desc', 'name asc']
+        results[:includes].should == [{'author' => 'country'}, 'comments']
+        results[:joins].should == ['activity']
         results[:pagination].should == {:page => 3, :per_page => 5}
         results[:offset].should == 10
         results[:limit].should == 5
       end
 
       it 'supports indifferent access' do
-        query_string = 'select=id,guid,name&where=name:foop&order=id:desc&order=name&page=3&page_size=5'
+        query_string = 'select=id,guid,name&where=name:foop&order=id:desc&order=name&page=3&page_size=5&includes=author.country,comments&joins=activity'
         results = subject.parse(query_string)
 
         results['select'].should == ['id', 'guid', 'name']
         results['where'].should  == {'name' => 'foop'}
         results['order'].should  == ['id desc', 'name asc']
+        results['includes'].should == [{'author' => 'country'}, 'comments']
+        results['joins'].should == ['activity']
         results['pagination'].should == {:page => 3, :per_page => 5}
         results['offset'].should == 10
         results['limit'].should == 5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muster
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport