restful_query 0.3.0 → 0.3.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+tmp*
+pkg*
+.specification
+_site*

data/History.txt

@@ -1,3 +1,9 @@
+== 0.3.1 2010-02-16
+
+* Parser takes a :map_columns option which maps aliases column names
+* The parser now strips all conditions with blank values. If you actually want
+to compare on a blank value, use the convertable value ':blank'
+
 == 0.3.0 2009-08-10
 
 * Vast improvements/enhancements

data/README.rdoc

@@ -54,11 +54,7 @@ http://code.quirkey.com/restful_query
 To install as a gem:
 
   sudo gem install restful_query
-  
-or from github:
-
-  sudo gem install quirkey-restful_query -s http://gems.github.com
-  
+    
 To install as a rails plugin
   
   ./script/plugin install git://github.com/quirkey/restful_query.git

data/Rakefile

@@ -1,33 +1,30 @@
-%w[rubygems rake rake/clean hoe fileutils newgem rubigen].each { |f| require f }
+%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/restful_query'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec('restful_query') do |p|
-  p.version = RestfulQuery::VERSION
-  p.developer('Aaron Quint', 'aaron@quirkey.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name       = 'quirkey'
-  p.summary              = 'Simple ActiveRecord and Sequel queries from a RESTful and safe interface'
-  p.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.}
-  p.url                  = 'http://code.quirkey.com/restful_query'
-  p.extra_deps         = [
-    ['activesupport','>= 2.2.0'],
-    ['chronic','>= 0.2.3']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"],
-    ['Shoulda', '>= 1.2.0']
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = %q{restful_query}
+    s.version = RestfulQuery::VERSION
+    s.authors = ["Aaron Quint"]
+    s.summary = 'Simple ActiveRecord and Sequel queries from a RESTful and safe interface'
+    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.rubyforge_project = %q{quirkey}
+    s.add_runtime_dependency(%q<activesupport>, [">= 2.2.0"])
+    s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
+    s.add_development_dependency(%q<Shoulda>, [">= 1.2.0"])
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+task :default => :test

data/lib/restful_query/condition.rb

@@ -22,7 +22,9 @@ module RestfulQuery
       ':true'  => true,
       ':false' => false,
       ':nil'   => nil,
-      ':null'  => nil
+      ':null'  => nil,
+      ':blank' => '',
+      ':empty' => ''
     }.freeze
     
     ENGLISH_OPERATOR_MAPPING = {

data/lib/restful_query/parser.rb

@@ -1,11 +1,12 @@
 module RestfulQuery
   class Parser
-    attr_reader :query, :exclude_columns, :integer_columns, :options
+    attr_reader :query, :exclude_columns, :map_columns, :integer_columns, :options
 
     def initialize(query, options = {})
       @options         = options || {}
-      @exclude_columns = options[:exclude_columns] ? [options.delete(:exclude_columns)].flatten.collect {|c| c.to_s } : []
-      @integer_columns = options[:integer_columns] ? [options.delete(:integer_columns)].flatten.collect {|c| c.to_s } : []
+      @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
       @query           = (query || {}).dup
@@ -44,12 +45,7 @@ module RestfulQuery
       hash['_sort'] = sorts.collect {|s| s.to_s } unless sorts.empty?
       hash
     end
-        
-    def self.sorts_from_hash(sorts)
-      sort_conditions = [sorts].flatten.compact
-      sort_conditions.collect {|c| Sort.parse(c) }
-    end
-    
+            
     def sort_sql
       @sorts.collect {|s| s.to_sql }.join(', ')
     end
@@ -66,16 +62,19 @@ module RestfulQuery
       sorts.collect {|s| s.column }
     end
     
-    def sorted_by?(column)
+    def sorted_by?(column_name)
+      column = map_column(column_name)
       sorted_columns.include?(column.to_s)
     end
     
-    def sort(column)
-      sorts.detect {|s| s && s.column == column.to_s }
+    def sort(column_name)
+      column = map_column(column_name)
+      sorts.detect {|s| s && s.column == column }
     end
     
-    def set_sort(column, direction)
-      if new_sort = self.sort(column)
+    def set_sort(column_name, direction)
+      column = map_column(column_name)
+      if new_sort = self.sort(column_name)
         if direction.nil?
           self.sorts.reject! {|s| s.column == column.to_s }
         else
@@ -111,7 +110,7 @@ module RestfulQuery
     end
     
     def extract_sorts_from_conditions
-      @sorts = self.class.sorts_from_hash(@query.delete('_sort'))
+      @sorts = sorts_from_hash(@query.delete('_sort'))
       @sorts = @default_sort if @sorts.empty?
     end
 
@@ -133,15 +132,35 @@ module RestfulQuery
       # with a normalized array of conditions
       conditions.each do |condition|
         column, operator, value = condition['column'], condition['operator'] || 'eq', condition['value']
-        unless exclude_columns.include?(column.to_s)
+        unless exclude_columns.include?(column.to_s) || value == ''
           condition_options = {}
           condition_options[:chronic] = true if chronic_columns.include?(column.to_s)
           condition_options[:integer] = true if integer_columns.include?(column.to_s)
           condition_options.merge!(condition['options'] || {})
-          add_condition_for(column, Condition.new(column, value, operator, condition_options))
+          column_name = map_column(column)
+          add_condition_for(column, Condition.new(column_name, value, operator, condition_options))
         end
       end
     end
      
+    def sorts_from_hash(sorts)
+      sort_conditions = [sorts].flatten.compact
+      sort_conditions.collect do |c| 
+        s = Sort.parse(c)
+        s.column = map_column(s.column)
+        s
+      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

data/lib/restful_query.rb

@@ -11,12 +11,12 @@ rescue LoadError
 end
 
 module RestfulQuery
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
   
   class Error < RuntimeError; end
 end
 
 
-%w{condition sort parser}.each do |lib|
+%w{condition sort parser can_query}.each do |lib|
   require File.join("restful_query","#{lib}.rb")
 end

data/rails/init.rb

@@ -1,4 +1,3 @@
 require File.join(File.dirname(__FILE__),'..','lib','restful_query.rb')
-require File.join(File.dirname(__FILE__),'..','lib','restful_query', 'can_query.rb')
 
 ActiveRecord::Base.send(:include, RestfulQuery::CanQuery)

data/restful_query.gemspec

@@ -1,23 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{restful_query}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2009-08-10}
+  s.date = %q{2010-02-16}
   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.email = ["aaron@quirkey.com"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "init.rb", "lib/restful_query.rb", "lib/restful_query/can_query.rb", "lib/restful_query/condition.rb", "lib/restful_query/parser.rb", "lib/restful_query/sort.rb", "lib/sequel/extensions/restful_query.rb", "rails/init.rb", "restful_query.gemspec", "tasks/restful_query_tasks.rake", "test/test_helper.rb", "test/test_restful_query_can_query.rb", "test/test_restful_query_condition.rb", "test/test_restful_query_parser.rb", "test/test_restful_query_sort.rb"]
-  s.homepage = %q{http://code.quirkey.com/restful_query}
-  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "init.rb",
+     "lib/restful_query.rb",
+     "lib/restful_query/can_query.rb",
+     "lib/restful_query/condition.rb",
+     "lib/restful_query/parser.rb",
+     "lib/restful_query/sort.rb",
+     "lib/sequel/extensions/restful_query.rb",
+     "rails/init.rb",
+     "restful_query.gemspec",
+     "tasks/restful_query_tasks.rake",
+     "test/test_helper.rb",
+     "test/test_restful_query_can_query.rb",
+     "test/test_restful_query_condition.rb",
+     "test/test_restful_query_parser.rb",
+     "test/test_restful_query_sort.rb"
+  ]
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{quirkey}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple ActiveRecord and Sequel queries from a RESTful and safe interface}
-  s.test_files = ["test/test_helper.rb", "test/test_restful_query_can_query.rb", "test/test_restful_query_condition.rb", "test/test_restful_query_parser.rb", "test/test_restful_query_sort.rb"]
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_restful_query_can_query.rb",
+     "test/test_restful_query_condition.rb",
+     "test/test_restful_query_parser.rb",
+     "test/test_restful_query_sort.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -26,21 +57,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.2.0"])
       s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
-      s.add_development_dependency(%q<newgem>, [">= 1.5.2"])
       s.add_development_dependency(%q<Shoulda>, [">= 1.2.0"])
-      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.2.0"])
       s.add_dependency(%q<chronic>, [">= 0.2.3"])
-      s.add_dependency(%q<newgem>, [">= 1.5.2"])
       s.add_dependency(%q<Shoulda>, [">= 1.2.0"])
-      s.add_dependency(%q<hoe>, [">= 2.3.3"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.2.0"])
     s.add_dependency(%q<chronic>, [">= 0.2.3"])
-    s.add_dependency(%q<newgem>, [">= 1.5.2"])
     s.add_dependency(%q<Shoulda>, [">= 1.2.0"])
-    s.add_dependency(%q<hoe>, [">= 2.3.3"])
   end
 end
+

data/test/test_restful_query_condition.rb

@@ -80,6 +80,16 @@ class RestfulQueryConditionTest < Test::Unit::TestCase
         end
       end
       
+      context "with a value of ':blank'" do
+        setup do
+          @condition = RestfulQuery::Condition.new('created_at', ':blank')
+        end
+        
+        should "convert value to true true" do
+          assert_equal('', @condition.value)
+        end
+      end
+      
       context "with the IN operator" do
         setup do
           @condition = RestfulQuery::Condition.new('year', '1995,2005,2006', 'in')

data/test/test_restful_query_parser.rb

@@ -100,6 +100,50 @@ 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' => ''})
+        end
+
+        should "return parser object" do
+          assert @parser.is_a?(RestfulQuery::Parser)
+        end
+
+        should "not include conditions for blank values" do
+          assert @parser.conditions_for('created_at')
+          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 => {
+            'section' => 'section_id',
+            '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 
+          assert @sort.is_a?(RestfulQuery::Sort)
+          assert_equal 'ASC', @sort.direction
+          assert_equal 'category_id', @sort.column
+        end
+      end
 
       context "with sort as a single string" do
         setup do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restful_query
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-10 00:00:00 -04:00
+date: 2010-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.2.3
     version: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.2
-    version: 
 - !ruby/object:Gem::Dependency 
   name: Shoulda
   type: :development
@@ -52,30 +42,19 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.0
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
 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: 
-- aaron@quirkey.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
+- LICENSE
+- README.rdoc
 files: 
+- .gitignore
 - History.txt
 - LICENSE
-- Manifest.txt
 - README.rdoc
 - Rakefile
 - init.rb
@@ -94,13 +73,12 @@ files:
 - test/test_restful_query_parser.rb
 - test/test_restful_query_sort.rb
 has_rdoc: true
-homepage: http://code.quirkey.com/restful_query
+homepage: 
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/Manifest.txt

@@ -1,20 +0,0 @@
-History.txt
-LICENSE
-Manifest.txt
-README.rdoc
-Rakefile
-init.rb
-lib/restful_query.rb
-lib/restful_query/can_query.rb
-lib/restful_query/condition.rb
-lib/restful_query/parser.rb
-lib/restful_query/sort.rb
-lib/sequel/extensions/restful_query.rb
-rails/init.rb
-restful_query.gemspec
-tasks/restful_query_tasks.rake
-test/test_helper.rb
-test/test_restful_query_can_query.rb
-test/test_restful_query_condition.rb
-test/test_restful_query_parser.rb
-test/test_restful_query_sort.rb