wherewolf 0.6.0 → 0.7.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+
+env:
+  - RAILS_VERSION=""
+  - RAILS_VERSION="~>3.2.0"
+  - RAILS_VERSION="~>3.1.0"
+  - RAILS_VERSION="~>3.0.0"

data/Gemfile

@@ -4,14 +4,18 @@ gem "arel"
 gem "parslet"
 
 group :development do
-  gem "shoulda"
-  gem "rdoc"
-  gem "bundler"
+  gem "simplecov", :require => false
   gem "jeweler"
+  gem "bundler"
+  gem "rdoc"
   gem "guard"
   gem "guard-test"
-  gem "simplecov", :require => false
+end
+
+group :test do
+  gem "shoulda"
   gem "sqlite3"
   gem "rails"
   gem "mocha"
+  gem "rake"
 end

data/Gemfile.lock

@@ -130,6 +130,7 @@ DEPENDENCIES
   mocha
   parslet
   rails
+  rake
   rdoc
   shoulda
   simplecov

data/{README.rdoc → README.md}

@@ -1,8 +1,8 @@
-= wherewolf
+# wherewolf [![Build Status](https://secure.travis-ci.org/madpilot/wherewolf.png)](http://travis-ci.org/madpilot/wherewolf) 
 
 Makes adding filtering and searching to your REST API crazy easy.
 
-== Problem
+## Problem
 
 Most RESTful APIs expose a "/index" endpoint that return all of objects at a given endpoint. That is fine until you need the ability to filter them.
 
@@ -28,7 +28,7 @@ Ok, it doesn't read amazingly, but this is an API, so encoding that stuff is tri
 
 Wherewolf will take that string and converts it in to ARel, so your clients can run arbitary queries against your API.
 
-== Get started
+## Get started
 
 The easiest way is to use Bundler:
 
@@ -36,9 +36,11 @@ The easiest way is to use Bundler:
 
 Then for every model that you want to by queryable, do this:
 
-    class Player < ActiveRecord::Base
-      has_query_parsing
-    end
+```ruby
+class Player < ActiveRecord::Base
+  has_query_parsing
+end
+```
 
 This will add the "where_query" and "order_query" methods, which you pass your query string in to.
 
@@ -46,78 +48,92 @@ has_query_parsing can take two options: whitelist and blacklist which allow you
 
 Setting whitelist will mean ONLY those columns will be searchable
 
-    class Player < ActiveRecord::Base
-      has_query_parsing :whitelist => [ :name ]   # Only name will be searchable
-    end
+```ruby
+class Player < ActiveRecord::Base
+  has_query_parsing :whitelist => [ :name ]   # Only name will be searchable
+end
 
 Setting blacklist will remove those columns from the list
 
-    class Player < ActiveRecord::Base
-      has_query_parsing :blacklist => [ :name ]   # Name will not be searchable
-    end
+class Player < ActiveRecord::Base
+  has_query_parsing :blacklist => [ :name ]   # Name will not be searchable
+end
+```
 
 Both whitelist and blacklist can take a proc if you want to lazy evaluate
 
-    class Player < ActiveRecord::Base
-      has_query_parsing :whitelist => proc { |model| model.accessible_attributes.map(&:to_sym) }
-    end
+```ruby
+class Player < ActiveRecord::Base
+  has_query_parsing :whitelist => proc { |model| model.accessible_attributes.map(&:to_sym) }
+end
+```
 
 would restrict the searchable columns to those exposed by accessible_attributes
 
-== Example
+## Example
 
 For a real-life, running example, check out: http://wherewolf.herokuapp.com/
 
-    player = Player.where_query("(position = wing || position = lock) && first_cap < 1905-01-01").order('first_cap')
-    # Returns all players that play 'wing' or 'lock', and played before 1905-01-01
+```ruby
+player = Player.where_query("(position = wing || position = lock) && first_cap < 1905-01-01").order('first_cap')
+# Returns all players that play 'wing' or 'lock', and played before 1905-01-01
 
-    player = Player.where_query('name = "John Eales"')
-    # Returns all players names 'John Eales'
+player = Player.where_query('name = "John Eales"')
+# Returns all players names 'John Eales'
 
-    player = Player.where_query("first_cap >= 1905-01-01 && active = false")
-    # Returns all inactitve players that played after 1905-01-01.
+player = Player.where_query("first_cap >= 1905-01-01 && active = false")
+# Returns all inactitve players that played after 1905-01-01.
 
-    player = Player.where_query("first_cap != null")
-    # Returns all players who have received their first cap (ie first_cap is NOT nil)
-    
-    player = Player.where_query('name ~= "Peter%"')
-    # Returns all players who's name starts with Peter
+player = Player.where_query("first_cap != null")
+# Returns all players who have received their first cap (ie first_cap is NOT nil)
+
+player = Player.where_query('name ~= "Peter%"')
+# Returns all players who's name starts with Peter
+```
 
 As you can see, where_query returns an ARel object, so you chain other statements to it.
 
-== Order
+## Order
 
 You can also supply an order_query to handle ordering
 
-    player = Player.order_query("name asc")
-    # Order by name asc
-    
-    player = Player.order_query("name desc")
-    # Order by name desc
-    
-    player = Player.order_query("name")
-    # By default ordering is ascending
+```ruby
+player = Player.order_query("name asc")
+# Order by name asc
+
+player = Player.order_query("name desc")
+# Order by name desc
+
+player = Player.order_query("name")
+# By default ordering is ascending
 
-    player = Player.order_query("name desc, position desc")
-    # You can also have multiple order columns
+player = Player.order_query("name desc, position desc")
+# You can also have multiple order columns
+```
 
 Of course, you can nest them...
 
-    player = Player.where_query("first_cap != null").order_query('name desc')
+```ruby
+player = Player.where_query("first_cap != null").order_query('name desc')
+```
 
-== Errors
+## Errors
 
 At the moment, error handling is very primitive. Just capture
 
-    Wherewolf::ParseError
+```ruby
+Wherewolf::ParseError
+```
 
 You can print out a simple error message like so
 
-    begin
-      Player.where_query('name ~= "Patrick%" || (position = "fail)')
-    rescue Wherewolf::ParseError => e
-      puts e.error_message
-    end
+```ruby
+begin
+  Player.where_query('name ~= "Patrick%" || (position = "fail)')
+rescue Wherewolf::ParseError => e
+  puts e.error_message
+end
+```
 
 Will print out
 
@@ -125,13 +141,15 @@ Will print out
 
 You can get the character number by:
 
-    begin
-      Player.where_query('name ~= "Patrick%" || (position = "fail)')
-    rescue Wherewolf::ParseError => e
-      e.position # This value will be 28
-    end
+```ruby
+begin
+  Player.where_query('name ~= "Patrick%" || (position = "fail)')
+rescue Wherewolf::ParseError => e
+  e.position # This value will be 28
+end
+```
 
-== To Do
+## To Do
 
 * Better error messages (Give a clue as to why parsing failed)
 * Aliases such for operators, such as 'and', 'or' etc
@@ -139,7 +157,7 @@ You can get the character number by:
 * More edge case testing
 * Ability to call named scopes
 
-== Contributing to wherewolf
+## Contributing to wherewolf
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -149,7 +167,6 @@ You can get the character number by:
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2012 Myles Eftos. See LICENSE.txt for
-further details.
+Copyright (c) 2012 [MadPilot Productions](http://www.madpilot.com.au/). See LICENSE.txt for further details.

data/Rakefile

@@ -22,7 +22,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Wherewolf allows you to consume search terms as strings without worrying about database injections. It parses the query and converts it into ARel. It's great for creating filterable REST APIs.}
   gem.email = "myles@madpilot.com.au"
   gem.authors = ["Myles Eftos"]
-  gem.version = "0.6.0"
+  gem.version = "0.7.0"
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/lib/wherewolf/where/processor.rb

@@ -20,16 +20,16 @@ module Wherewolf
 
       def process(ast, table)
         operation = ast.keys.first
-        self.send("process_#{operation}".to_sym, ast[operation], table) if self.respond_to?("process_#{operation}".to_sym)
+        self.send("process_#{operation}".to_sym, ast[operation], table) if self.respond_to?("process_#{operation}".to_sym, true)
       end
 
   protected
       def process_and(ast, table)
-        process(ast[:left], table).and(process(ast[:right], table))     
+        process(ast[:left], table).and(process(ast[:right], table))
       end
 
       def process_or(ast, table)
-        process(ast[:left], table).or(process(ast[:right], table))     
+        process(ast[:left], table).or(process(ast[:right], table))
       end
 
       def process_eq(ast, table)

data/wherewolf.gemspec

@@ -5,24 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = "wherewolf"
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Myles Eftos"]
-  s.date = "2012-10-12"
+  s.date = "2013-08-16"
   s.description = "Wherewolf allows you to consume search terms as strings without worrying about database injections. It parses the query and converts it into ARel. It's great for creating filterable REST APIs."
   s.email = "myles@madpilot.com.au"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "lib/wherewolf.rb",
     "lib/wherewolf/order/parser.rb",
@@ -54,43 +55,31 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<arel>, [">= 0"])
       s.add_runtime_dependency(%q<parslet>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<guard>, [">= 0"])
       s.add_development_dependency(%q<guard-test>, [">= 0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<rails>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
       s.add_dependency(%q<arel>, [">= 0"])
       s.add_dependency(%q<parslet>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<guard>, [">= 0"])
       s.add_dependency(%q<guard-test>, [">= 0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<rails>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
     s.add_dependency(%q<arel>, [">= 0"])
     s.add_dependency(%q<parslet>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<guard>, [">= 0"])
     s.add_dependency(%q<guard-test>, [">= 0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<rails>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wherewolf
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arel
-  requirement: &70363111528740 !ruby/object:Gem::Requirement
+  requirement: &70230414498620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363111528740
+  version_requirements: *70230414498620
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &70363111528260 !ruby/object:Gem::Requirement
+  requirement: &70230414497280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363111528260
+  version_requirements: *70230414497280
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &70363111527780 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &70230414496000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363111527780
+  version_requirements: *70230414496000
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &70363111527300 !ruby/object:Gem::Requirement
+  name: jeweler
+  requirement: &70230414495000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363111527300
+  version_requirements: *70230414495000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70363111526820 !ruby/object:Gem::Requirement
+  requirement: &70230414494320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363111526820
+  version_requirements: *70230414494320
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70363111526340 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &70230414493480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363111526340
+  version_requirements: *70230414493480
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70363111525860 !ruby/object:Gem::Requirement
+  requirement: &70230414526800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,54 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363111525860
+  version_requirements: *70230414526800
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &70363111525380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70363111525380
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &70363111524900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70363111524900
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70363111524420 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70363111524420
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70363126234820 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70363126234820
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70363126233820 !ruby/object:Gem::Requirement
+  requirement: &70230414526240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363126233820
+  version_requirements: *70230414526240
 description: Wherewolf allows you to consume search terms as strings without worrying
   about database injections. It parses the query and converts it into ARel. It's great
   for creating filterable REST APIs.
@@ -151,14 +107,15 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/wherewolf.rb
 - lib/wherewolf/order/parser.rb
@@ -192,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3222849472552349803
+      hash: 2295607200233817462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: