restful_query 0.3.3 → 0.3.4

data/History.txt

@@ -1,3 +1,9 @@
+== 0.3.4 2011-08-15
+
+* Added support for extra options to sort. Specifically this allows you to do NULLS FIRST/LAST
+* You can supply :sort_options => to the restful query parser that will get added to all sorts
+* Changed single_sort => true to the default
+
 == 0.3.3 2011-05-15
 
 * Added 'restful_query/rails' for bundler requires

data/lib/restful_query.rb

@@ -9,7 +9,7 @@ rescue LoadError
 end
 
 module RestfulQuery
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 
   class Error < RuntimeError; end
 end

data/lib/restful_query/parser.rb

@@ -1,15 +1,16 @@
 module RestfulQuery
   class Parser
-    attr_reader :query, :exclude_columns, :map_columns, :integer_columns, :options
+    attr_reader :query, :exclude_columns, :map_columns, :integer_columns, :options, :default_sort_options
 
     def initialize(query, options = {})
       @options         = options || {}
       @exclude_columns = columns_from_options(:exclude, options)
       @integer_columns = columns_from_options(:integer, options)
       @map_columns     = options[:map_columns] || {}
-      @default_sort    = options[:default_sort] ? [Sort.parse(options[:default_sort])] : []
-      @single_sort     = options[:single_sort] || false
+      @single_sort     = options[:single_sort] || true
+      @default_sort_options = options[:sort_options] || {}
       @query           = (query || {}).dup
+      @query['_sort'] ||= options[:default_sort] if options[:default_sort]
       @default_join    = @query.delete(:join) || :and
       extract_sorts_from_conditions
       map_conditions
@@ -18,7 +19,7 @@ module RestfulQuery
     def conditions
       conditions_hash.values.flatten
     end
-    
+
     def has_conditions?
       !conditions.empty?
     end
@@ -32,46 +33,46 @@ module RestfulQuery
       join_string = (join == :or) ? ' OR ' : ' AND '
       conditions_string = []
       conditions_values = []
-      conditions.each do |c| 
+      conditions.each do |c|
         ca = c.to_condition_array
         conditions_string << ca[0]
         conditions_values << ca[1]
       end
       conditions_values.unshift(conditions_string.join(join_string))
     end
-    
+
     def to_query_hash
       hash = @query
       hash['_sort'] = sorts.collect {|s| s.to_s } unless sorts.empty?
       hash
     end
-            
+
     def sort_sql
       @sorts.collect {|s| s.to_sql }.join(', ')
     end
-    
+
     def has_sort?
       !sorts.empty?
     end
-    
+
     def sorts
       @sorts ||= []
     end
-    
+
     def sorted_columns
       sorts.collect {|s| s.column }
     end
-    
+
     def sorted_by?(column_name)
       column = map_column(column_name)
       sorted_columns.include?(column.to_s)
     end
-    
+
     def sort(column_name)
       column = map_column(column_name)
       sorts.detect {|s| s && s.column == column }
     end
-    
+
     def set_sort(column_name, direction)
       column = map_column(column_name)
       if new_sort = self.sort(column_name)
@@ -86,7 +87,7 @@ module RestfulQuery
       end
       new_sort
     end
-    
+
     def clear_default_sort!
       @sorts.reject! {|s| s == @default_sort.first }
     end
@@ -108,7 +109,7 @@ module RestfulQuery
         []
       end
     end
-    
+
     def extract_sorts_from_conditions
       @sorts = sorts_from_hash(@query.delete('_sort'))
       @sorts = @default_sort if @sorts.empty?
@@ -142,25 +143,26 @@ module RestfulQuery
         end
       end
     end
-     
+
     def sorts_from_hash(sorts)
       sort_conditions = [sorts].flatten.compact
-      sort_conditions.collect do |c| 
+      sort_conditions.collect do |c|
         s = Sort.parse(c)
         s.column = map_column(s.column)
+        s.options = default_sort_options
         s
       end
-    end 
-    
+    end
+
     def columns_from_options(column_type, options)
       option = "#{column_type}_columns".to_sym
       options[option] ? [options.delete(option)].flatten.collect {|c| c.to_s } : []
     end
-    
+
     def map_column(column_name)
       map_columns[column_name.to_s] || column_name.to_s
     end
-    
-    
+
+
   end
-end
+end

data/lib/restful_query/sort.rb

@@ -1,11 +1,11 @@
 module RestfulQuery
   class InvalidDirection < Error; end
-  
+
   class Sort
     include Comparable
-    
-    attr_reader :column, :direction
-    
+
+    attr_reader :column, :direction, :options
+
     DIRECTIONS = {
       'up' => 'ASC',
       'asc' => 'ASC',
@@ -14,37 +14,51 @@ module RestfulQuery
       'desc' => 'DESC',
       'DESC' => 'DESC'
     }.freeze
-    
-    
-    def initialize(column, direction)
+
+
+    def initialize(column, direction, options = {})
       self.column    = column
       self.direction = direction
+      self.options = options
     end
-    
+
     def self.parse(sort_string, split_on = /\-|\ /)
       return unless sort_string
-      column, direction = sort_string.split(split_on)
-      new(column, direction)
+      column, direction, options = sort_string.split(split_on, 3)
+      new(column, direction, options)
     end
-    
+
     def column=(column)
       @column = column.to_s
     end
-    
+
     def direction=(direction)
       @direction = DIRECTIONS[direction.to_s]
       raise(InvalidDirection, "'#{direction}' is not a valid order direction") unless @direction
     end
-    
+
+    def options=(options)
+      @options = if options.is_a?(String)
+        opts = {}
+        options.split(/ /).each_slice(2) do |k|
+          k.map! {|v| v.to_s.downcase.to_sym }
+          opts[k[0]] = k[1]
+        end
+        opts
+      else
+        options || {}
+      end
+    end
+
     def reverse_direction
       direction == 'ASC' ? 'DESC' : 'ASC'
     end
-    
+
     def ==(other)
       return false unless other.is_a?(Sort)
       column == other.column && direction == other.direction
     end
-    
+
     # Makes a roundabout for directions nil -> desc -> asc -> nil
     def self.next_direction(current_direction)
       case current_direction.to_s.downcase
@@ -56,17 +70,23 @@ module RestfulQuery
         'desc'
       end
     end
-    
+
     def next_direction
       self.class.next_direction(direction)
     end
-    
+
     def to_s(join = '-')
-      "#{column}#{join}#{direction.downcase}"
+      s = "#{column}#{join}#{direction.downcase}"
+      s << " #{options.inspect}" unless options.empty?
+      s
     end
-            
+
     def to_sql
-      "#{column} #{direction}"
+      sql = "#{column} #{direction}"
+      unless options.empty?
+        sql << ' ' << options.to_a.flatten.collect {|k| k.to_s.upcase }.join(' ')
+      end
+      sql
     end
   end
-end
+end

data/restful_query.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restful_query}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2011-05-17}
+  s.date = %q{2011-08-15}
   s.description = %q{RestfulQuery provides a simple interface in front of a complex parser to parse specially formatted query hashes into complex SQL queries. It includes ActiveRecord and Sequel extensions.}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -39,11 +39,10 @@ Gem::Specification.new do |s|
   ]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{quirkey}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Simple ActiveRecord and Sequel queries from a RESTful and safe interface}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/test/test_restful_query_parser.rb

@@ -100,7 +100,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
           assert_not_equal Chronic.parse('1 day ago').to_s, @parser.conditions_for(:updated_at).first.value.to_s
         end
       end
-      
+
       context "with blank values" do
         setup do
           new_parser_from_hash({'isblank' => ''})
@@ -115,7 +115,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
           assert_nil @parser.conditions_for('isblank')
         end
       end
-      
+
       context "with map_columns" do
         setup do
           new_parser_from_hash({'section' => 4, '_sort' => 'category-up'}, {:map_columns => {
@@ -123,22 +123,22 @@ class RestfulQueryParserTest < Test::Unit::TestCase
             'category' => 'category_id'
           }})
         end
-        
+
         should "return parser object" do
           assert @parser.is_a?(RestfulQuery::Parser)
         end
-        
+
         should "set the map_columns attribute" do
           assert @parser.map_columns.is_a?(Hash)
         end
-        
+
         should "map condition column" do
           assert @parser.conditions_for('section')
           assert_equal 'section_id', @parser.conditions_for('section').first.column
         end
-        
+
         should "map sort column" do
-          @sort = @parser.sorts.first 
+          @sort = @parser.sorts.first
           assert @sort.is_a?(RestfulQuery::Sort)
           assert_equal 'ASC', @sort.direction
           assert_equal 'category_id', @sort.column
@@ -155,7 +155,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
         end
 
         should "parse sort string" do
-          @sort = @parser.sorts.first 
+          @sort = @parser.sorts.first
           assert @sort.is_a?(RestfulQuery::Sort)
           assert_equal 'ASC', @sort.direction
           assert_equal 'created_at', @sort.column
@@ -184,26 +184,41 @@ class RestfulQueryParserTest < Test::Unit::TestCase
             assert sort.is_a?(RestfulQuery::Sort)
           end
         end
+      end
 
+      context "with sort options" do
+        setup do
+          new_parser_from_hash({'_sort' => ['created_at-up']}, :sort_options => {:nulls => :first})
+        end
+
+        should "return parser object" do
+          assert @parser.is_a?(RestfulQuery::Parser)
+        end
+
+        should "add sorts to sorts" do
+          assert @parser.sorts
+          assert_equal 1, @parser.sorts.length
+          assert_equal 'created_at ASC NULLS FIRST', @parser.sort_sql
+        end
       end
-      
+
       context "with a default_sort" do
         context "with no sorts defined in the query hash" do
           setup do
             new_parser_from_hash({}, {:default_sort => 'created_at DESC'})
           end
-          
+
           should "return parser object" do
             assert @parser.is_a?(RestfulQuery::Parser)
           end
-        
+
           should "have default sort in sorts" do
             assert @parser.sorts
             assert_equal 1, @parser.sorts.length
             assert_equal 'created_at DESC', @parser.sort_sql
           end
         end
-        
+
         context "with sorts defined in the query hash" do
           setup do
             new_parser_from_hash({'_sort' => 'created_at-up'})
@@ -212,7 +227,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
           should "return parser object" do
             assert @parser.is_a?(RestfulQuery::Parser)
           end
-          
+
           should "have query hash sorts in sorts and not default sort" do
             assert @parser.sorts
             assert_equal 1, @parser.sorts.length
@@ -221,20 +236,20 @@ class RestfulQueryParserTest < Test::Unit::TestCase
         end
       end
     end
-    
+
     context "from an array of conditions" do
       setup do
         @array_of_conditions = [
-          {'column' => 'created_at', 'operator' => 'gt', 'value' => '1 week ago'}, 
-          {'column' => 'created_at', 'operator' => 'lt', 'value' => '1 hour ago'}, 
-          {'column' => 'updated_at', 'operator' => 'lt', 'value' => '1 day ago'}, 
-          {'column' => 'title', 'operator' => 'eq', 'value' => 'Test'}, 
+          {'column' => 'created_at', 'operator' => 'gt', 'value' => '1 week ago'},
+          {'column' => 'created_at', 'operator' => 'lt', 'value' => '1 hour ago'},
+          {'column' => 'updated_at', 'operator' => 'lt', 'value' => '1 day ago'},
+          {'column' => 'title', 'operator' => 'eq', 'value' => 'Test'},
           {'column' => 'other_time', 'operator' => 'gt', 'value' => 'oct 1'},
           {'column'  => 'name', 'value' => 'Aaron'}
         ]
         @parser = RestfulQuery::Parser.new(:conditions => @array_of_conditions)
       end
-      
+
       should "return parser object" do
         assert @parser.is_a?(RestfulQuery::Parser)
       end
@@ -250,7 +265,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
         assert @parser.conditions_for(:name).first.is_a?(RestfulQuery::Condition)
         assert_equal '=', @parser.conditions_for(:name).first.operator
       end
-    
+
     end
 
     context "a loaded parser" do
@@ -327,45 +342,45 @@ class RestfulQueryParserTest < Test::Unit::TestCase
           assert_match(/(([a-z_]) (\<|\>|\=|\<\=|\>\=) \? OR)+/,@conditions[0])
         end
       end
-      
+
       context "to_query_hash" do
         context "with no altering" do
           setup do
             @query_hash = @parser.to_query_hash
           end
-          
+
           should "return hash" do
             assert @query_hash.is_a?(Hash)
           end
-      
+
           should "return initial query hash" do
             assert_equal({'gt' => '1 week ago', 'lt' => '1 hour ago'}, @query_hash['created_at'])
           end
         end
-        
+
         context "with altered sorts" do
           setup do
             @parser.set_sort('title', 'up')
             @parser.set_sort('created_at', 'down')
             @query_hash = @parser.to_query_hash
           end
-          
+
           should "include unaltered sort conditions" do
             assert_equal({'gt' => '1 week ago', 'lt' => '1 hour ago'}, @query_hash['created_at'])
           end
-          
+
           should "include altered sorts" do
             assert_equal(['title-asc','created_at-desc'], @query_hash['_sort'])
           end
         end
       end
-      
+
       context "sorts" do
         setup do
           new_parser_from_hash({'_sort' => ['title-down', 'updated_at-asc']})
-          @sorts = @parser.sorts 
+          @sorts = @parser.sorts
         end
-        
+
         should "return an array of sort objects" do
           assert @sorts
           assert_equal 2, @sorts.length
@@ -373,7 +388,7 @@ class RestfulQueryParserTest < Test::Unit::TestCase
             assert sort.is_a?(RestfulQuery::Sort)
           end
         end
-        
+
         context "sorted_columns" do
           should "return an array of columns" do
             @sorted_columns = @parser.sorted_columns
@@ -381,73 +396,73 @@ class RestfulQueryParserTest < Test::Unit::TestCase
             assert @sorted_columns.include?('title')
           end
         end
-        
+
         context "sorted_by?" do
           should "return true if column is sorted" do
             assert @parser.sorted_by?('title')
           end
-          
+
           should "return false if column is not sorted" do
             assert !@parser.sorted_by?('created_at')
           end
         end
-        
+
         context "sort()" do
           should "return Sort object if column is sorted" do
             sort = @parser.sort('title')
             assert sort.is_a?(RestfulQuery::Sort)
             assert_equal 'title', sort.column
           end
-          
+
           should "return nil if col" do
             assert_nil @parser.sort('created_at')
           end
         end
-        
+
         context "set_sort" do
-          context "with an existing sort" do            
+          context "with an existing sort" do
             setup do
               @parser.set_sort('title','up')
             end
-            
+
             should "not add new sort" do
               assert_equal 2, @parser.sorts.length
             end
-            
+
             should "update sort direction" do
               assert_equal 'ASC', @parser.sort('title').direction
             end
           end
-          
+
           context "with direction: nil" do
             setup do
               @parser.set_sort('title', nil)
             end
-            
+
             should "remove sort" do
               assert_equal 1, @parser.sorts.length
               assert !@parser.sorted_by?('title')
             end
           end
-          
+
           context "with a new sort" do
             setup do
               @parser.set_sort('name', 'down')
             end
-            
+
             should "add sort to sorts" do
               assert_equal 3, @parser.sorts.length
             end
-            
+
             should "set sort direction" do
               assert_equal 'DESC', @parser.sort('name').direction
             end
           end
-          
+
         end
-        
+
       end
-      
+
 
       context "sort_sql" do
         should "join order with ," do

data/test/test_restful_query_sort.rb

@@ -8,16 +8,34 @@ class RestfulQuerySortTest < Test::Unit::TestCase
         setup do
           @sort = RestfulQuery::Sort.new(:attribute, 'up')
         end
-        
+
         should "save column name as string" do
           assert_equal 'attribute', @sort.column
         end
-        
+
         should "interpret direction" do
           assert_equal 'ASC', @sort.direction
         end
       end
-      
+
+      context "with extra options" do
+        setup do
+          @sort = RestfulQuery::Sort.new(:attribute, 'up', :nulls => :first)
+        end
+
+        should "save column name as string" do
+          assert_equal 'attribute', @sort.column
+        end
+
+        should "interpret direction" do
+          assert_equal 'ASC', @sort.direction
+        end
+
+        should "add nulls option" do
+          assert_equal :first, @sort.options[:nulls]
+        end
+      end
+
       context "with an invalid direction" do
         should "raise error" do
           assert_raise(RestfulQuery::InvalidDirection) do
@@ -25,28 +43,28 @@ class RestfulQuerySortTest < Test::Unit::TestCase
           end
         end
       end
-      
+
     end
-    
+
     context "parse" do
       context "with a query hash like condition" do
       setup do
         @sort = RestfulQuery::Sort.parse('long_name_attribute-down')
       end
-      
+
       should "return sort object" do
         assert @sort.is_a?(RestfulQuery::Sort)
       end
-      
+
       should "set column and direction" do
         assert_equal 'long_name_attribute', @sort.column
         assert_equal 'DESC', @sort.direction
       end
       end
-      
+
       context "with a standard SQL like condition" do
         setup do
-          @sort = RestfulQuery::Sort.parse('long_name_attribute DESC')
+          @sort = RestfulQuery::Sort.parse('long_name_attribute DESC NULLS LAST')
         end
 
         should "return sort object" do
@@ -57,16 +75,25 @@ class RestfulQuerySortTest < Test::Unit::TestCase
           assert_equal 'long_name_attribute', @sort.column
           assert_equal 'DESC', @sort.direction
         end
+
+        should "set other options" do
+          assert_equal :last, @sort.options[:nulls]
+        end
       end
     end
-    
+
     context "to_sql" do
       should "join the column and attribute" do
         @sort = RestfulQuery::Sort.new(:attribute, 'down')
         assert_equal 'attribute DESC', @sort.to_sql
       end
+
+      should "parse null option" do
+        @sort = RestfulQuery::Sort.new(:attribute, 'down', :nulls => :last)
+        assert_equal 'attribute DESC NULLS LAST', @sort.to_sql
+      end
     end
-    
+
   end
-  
-end
+
+end

metadata

@@ -1,77 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: restful_query
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 3
-  version: 0.3.3
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Aaron Quint
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-17 00:00:00 -07:00
+date: 2011-08-15 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152029040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.2.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: chronic
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152029040
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: &2152028020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: Shoulda
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152028020
+- !ruby/object:Gem::Dependency
+  name: Shoulda
+  requirement: &2152027080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
-  version_requirements: *id003
-description: RestfulQuery provides a simple interface in front of a complex parser to parse specially formatted query hashes into complex SQL queries. It includes ActiveRecord and Sequel extensions.
+  prerelease: false
+  version_requirements: *2152027080
+description: RestfulQuery provides a simple interface in front of a complex parser
+  to parse specially formatted query hashes into complex SQL queries. It includes
+  ActiveRecord and Sequel extensions.
 email: 
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - History.txt
 - LICENSE
 - README.rdoc
@@ -95,34 +78,26 @@ files:
 has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: quirkey
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple ActiveRecord and Sequel queries from a RESTful and safe interface
 test_files: []
-