omnis 0.6.3 → 0.6.5

data/lib/omnis/mongo_query.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'monadic'
 
 module Omnis
   module MongoQuery
@@ -13,7 +14,7 @@ module Omnis
     module ClassMethods
       include Omnis::Query::ClassMethods
 
-      attr_reader :page_param_name, :items_per_page
+      attr_reader :page_param_name, :items_per_page,  :sort_param_name, :sort_default_field, :sort_default_order
       def field_list
         @fields ||= []
       end
@@ -25,6 +26,12 @@ module Omnis
         @page_param_name = page_param_name
         @items_per_page  = opts[:items_per_page] || 10
       end
+
+      def sort(sort_param_name, opts={})
+        @sort_param_name  = sort_param_name
+        @sort_default_field = opts[:default][0]
+        @sort_default_order = (opts[:default][1] || :asc).to_sym
+      end
     end
 
     module InstanceMethods
@@ -39,6 +46,10 @@ module Omnis
                          :param_names => extracted_param_names(extracted_operators)})
       end
 
+      def items_per_page
+        self.class.items_per_page || 20
+      end
+
       private
       def page
         return 0 unless @input_params.has_key? page_param_name
@@ -55,8 +66,17 @@ module Omnis
         self.class.page_param_name || :page
       end
 
-      def items_per_page
-        self.class.items_per_page || 20
+
+      def sort_param_name
+        self.class.sort_param_name
+      end
+
+      def sort_default_field
+        self.class.sort_default_field
+      end
+
+      def sort_default_order
+        self.class.sort_default_order || :asc
       end
 
       def mongo_operator(operator)
@@ -73,10 +93,42 @@ module Omnis
       end
 
       def mongo_opts(extracted_operators)
-        params_with_extra_fields = extracted_operators.collect(&:opts).select {|e| e.has_key? :field}
-        extra_fields = params_with_extra_fields.map {|e| e[:field]}
-        fields = self.class.field_list + extra_fields
-        { :limit => items_per_page, :skip => skip, :fields => fields }
+        {}.tap do |opts|
+          params_with_extra_fields = extracted_operators.collect(&:opts).select {|e| e.has_key? :field}
+          extra_fields = params_with_extra_fields.map {|e| e[:field]}
+          opts[:fields] = self.class.field_list + extra_fields
+          opts[:limit]  = items_per_page
+          opts[:skip]   = skip
+          opts[:sort]   = sort_opts if sort_opts.all?
+        end
+      end
+
+      def sort_opts
+        sort_args = (@input_params[sort_param_name] || '').split ','
+
+        sort_order = sort_args[1]
+        sort_order ||= sort_default_order
+        sort_order = sort_order.to_sym
+        sort_order = :asc unless [:asc, :desc].include? sort_order
+
+        @sort_opts = [sort_field(sort_args), sort_order]
+      end
+
+      def sort_field(sort_args)
+        sort_field   = sort_args[0]
+        sort_field ||= sort_default_field
+        return nil unless sort_field
+
+        custom_sort_field = get_custom_sort_field(sort_field)
+
+        custom_sort_field ? custom_sort_field : sort_field
+      end
+
+      def get_custom_sort_field(sort_field)
+        sort_field_param = self.class.params[sort_field.to_sym]
+        if sort_field_param && sort_field_param.opts.has_key?(:field)
+          sort_field   = sort_field_param.opts[:field]
+        end
       end
 
       def extracted_param_names(extracted_operators)

data/lib/omnis/query.rb

@@ -21,7 +21,7 @@ module Omnis
       def extract(params)
         value = @extractor.(params) if params.keys.include? name    # only run extractor if the param was in the request (params)
         value ||= default_value                                     # if there is a default, apply it
-        return value if extracted_result_is_an_operator? value
+        return value if is_operator? value
         return @operator.new(@name, value, @opts) unless value.nil?
       end
 
@@ -32,7 +32,7 @@ module Omnis
       end
 
       private
-      def extracted_result_is_an_operator?(value)
+      def is_operator?(value)
         value.is_a? Omnis::Operators::NullOperator
       end
     end

data/lib/omnis/version.rb

@@ -1,3 +1,3 @@
 module Omnis
-  VERSION = "0.6.3"
+  VERSION = "0.6.5"
 end

data/spec/lib/omnis/mongo_query_spec.rb

@@ -87,10 +87,76 @@ describe Omnis::MongoQuery do
       t = TestPageDefaultQuery.new({})
       t.to_mongo.opts.should == { :limit => 20, :skip => 0, :fields => []}
     end
+
     it "page defaults and page given" do
       t = TestPageDefaultQuery.new({"page" => 2})
       t.to_mongo.opts.should == { :limit => 20, :skip => 40, :fields => []}
     end
+
+    it "works with a custom paging param" do
+      class TestPageCustomPagingParamQuery
+        include Omnis::MongoQuery
+        page :fancy_pants, :items_per_page => 20
+      end
+
+      m = TestPageCustomPagingParamQuery.new("fancy_pants" => 2).to_mongo
+      m.opts.should == { :limit => 20, :skip => 40, :fields => []}
+    end
+
+    it "allows to get items_per_page" do
+      t = TestPageDefaultQuery.new({})
+      t.items_per_page.should == 20
+    end
+  end
+
+  context 'sorting' do
+    class TestSortQuery
+      include Omnis::MongoQuery
+      param :ref_provider,  Equals, :field => 'services.ref_provider'
+      param :ref_anixe,     Equals
+      param :name,          Equals
+      sort :sort, :default => [:ref_anixe, :asc]
+    end
+
+    it 'default sort order' do
+      m = TestSortQuery.new({}).to_mongo
+      m.opts[:sort].should == [:ref_anixe, :asc]
+    end
+
+    it 'ascending by default' do
+      m = TestSortQuery.new("sort" => "name").to_mongo
+      m.opts[:sort].should == ['name', :asc]
+    end
+
+    it 'ascending for invalid sort order' do
+      m = TestSortQuery.new("sort" => "name,kupa").to_mongo
+      m.opts[:sort].should == ['name', :asc]
+    end
+
+    it 'ascending' do
+      m = TestSortQuery.new("sort" => "name,asc").to_mongo
+      m.opts[:sort].should == ['name', :asc]
+    end
+
+    it 'descending' do
+      m = TestSortQuery.new("sort" => "name,desc").to_mongo
+      m.opts[:sort].should == ['name', :desc]
+    end
+
+    it 'uses the supplied optional field for sorting' do
+      m = TestSortQuery.new("sort" => "ref_provider").to_mongo
+      m.opts[:sort].should == ['services.ref_provider', :asc]
+    end
+
+    it 'works with a custom sorting param' do
+      class TestSortCustomQuery
+        include Omnis::MongoQuery
+        param :name,      Equals
+        sort :fancy_pants, :default => [:ref_anixe, :asc]
+      end
+      m = TestSortCustomQuery.new("fancy_pants" => "name,desc").to_mongo
+      m.opts[:sort].should == ['name', :desc]
+    end
   end
 
   context 'practical use case with predefined params' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omnis
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport