scoped_search 2.7.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1847a5debfd78493233e7bb02f6ab09e7f97716
-  data.tar.gz: 1956d02a802a331f3ee7b8e6a555b09d49104942
+  metadata.gz: af5bbaee1bcd8c43d9a31e7facd1cbb132b6de4c
+  data.tar.gz: 3f7bbad05696d74941c0f878b5c9aea2f87ad242
 SHA512:
-  metadata.gz: 26c1ffaeb3af331ff878db933bebec8c7e56066801ba5c94fc2771c3d07f8c1da6699bf4ec14b932ef318b42ecfc576eb17c984f8f1bdae450658cb5adb2c720
-  data.tar.gz: 34a33ccb2d74cecc67ea7fca254f9d4ab05e3f00c355bca71772104128b6c7b0f625fe866623c8353b1e9e8dcbd09483a23e1f848d4ea20e5814880949bd449e
+  metadata.gz: 1057f7ecafc42146520d82c06ccb045854df6b941b68ffadfae12177888b12582dd79f8ca0d2087a6e22b610545755b77be3e20fa77a7b98ba79bad04f3571b0
+  data.tar.gz: 8a6795724808b89895fe7eaa90d99fd7f3aef5e5afefd8a178ba6ca70d1a6f2ded74585a56d12af7c841eeb2c76d037af7e980ad9df75005a2561ef2c37715aa

data/.travis.yml

@@ -1,38 +1,29 @@
+
 language: ruby
-script: bundle exec rake
-before_script:
-  - psql -c 'create database scoped_search_test;' -U postgres
-  - mysql -e 'create database scoped_search_test;'
+
+sudo: false
+
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.1
   - ruby-head
-  - jruby-18mode
   - jruby-19mode
   - jruby-head
+
 gemfile:
- - Gemfile.activerecord2
  - Gemfile.activerecord3
- - Gemfile.activerecord4
+ - Gemfile.activerecord40
+ - Gemfile.activerecord41
+
+before_script:
+  - psql -c 'create database scoped_search_test;' -U postgres
+  - mysql -e 'create database scoped_search_test;'
+
+script: bundle exec rake
+
 matrix:
   include:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: 2.0.0
-      gemfile: Gemfile.activerecord2
-    - rvm: 2.1.1
-      gemfile: Gemfile.activerecord2
-  exclude:
-    - rvm: jruby-18mode
-      gemfile: Gemfile.activerecord2
-    - rvm: jruby-19mode
-      gemfile: Gemfile.activerecord2
-    - rvm: jruby-head
-      gemfile: Gemfile.activerecord2
-    - rvm: 1.8.7
-      gemfile: Gemfile.activerecord4
-    - rvm: jruby-18mode
-      gemfile: Gemfile.activerecord4

data/CHANGELOG.rdoc

@@ -0,0 +1,193 @@
+= Changelog
+
+This page describes the changes that have been made to *scoped_search* over its history.
+
+Please add an entry to the "Unreleased changes" section in your pull requests.
+
+=== Unreleased changes
+
+*Nothing yet*
+
+=== Version 3.0
+
+- Add support for ActiveRecord 4.1
+- Drop support for Ruby 1.8
+- Drop support for ActiveRecord 2.
+- No longer require jQuery UI automatically; you have to do this yourself now.
+- Auto completion: deprecate javascript helpers in favor of asset pipeline.
+- Remove some deprecated 1.x APIs.
+- Upgraded to RSpec 3.
+- Extract Oracle query builder enhancements to plugin gem: https://github.com/wvanbergen/scoped_search-oracle_enhanced
+- Extract H2 query builder enhancements to plugin gem: https://github.com/wvanbergen/scoped_search-h2
+
+=== Version 2.7.1
+
+- Fix order SQL generation issue on PostgreSQL for the autocompleter.
+
+=== Version 2.7.0
+
+- Allow setting a default sort order
+- Fix a sorting bug for field names starting with `desc`.
+- SQL generation fixes.
+- Improve test coverage
+
+=== Version 2.6.5
+
+- Allow disabling certain fields for autocompletion.
+
+=== Version 2.6.4
+
+- jQuery 1.9 support for automplete helpers.
+
+=== Version 2.6.3
+
+- Bugfixes in querying plymorphic has many through relations.
+
+=== Version 2.6.2
+
+- Add support for querying plymorphic has many through relations.
+
+=== Version 2.6.1
+
+- Fix a SQL generation bug.
+
+=== Version 2.6.0
+
+- Improve logic for querying one to many relations.
+- Add a Railtie for better Rails integration.
+- Project infrastructure changes: remove infinity test, update LICENSE
+
+=== Version 2.5.1
+
+- Fixes to asset pipeline for auto completer UI helpers.
+- Use bundler for gem release management
+
+=== Version 2.5.0
+
+- Add support for ActiveRecord 4.0
+- Add support for Ruby 2.0
+- Fix encoding bug
+
+=== Version 2.4.1
+
+- Add asset pipeline support for autocompleter UI helpers
+- Fix query parser bug.
+
+=== Version 2.4.0
+
+- Raise an appropriate exception when referring to a database field that does not exists.
+- Drop support for GROUP BY; just use DISTINCT for these use cases
+- Add support for PostgreSQL full text search.
+- Many bugfixes.
+- Improved specs.
+- Add Travis CI testing for all supported databases.
+
+=== Version 2.3.7
+
+- Add support for IN and NOT IN queries.
+- Bug fix in SQL generation.
+
+=== Version 2.3.6
+
+- Minor bugfixes in auto completer.
+
+=== Version 2.3.5
+
+- Small bugfixes in auto completer.
+
+=== Version 2.3.4
+
+- Small bugfixes.
+
+=== Version 2.3.3
+
+- Add filtering and limiting support to autocompleter.
+- Documentation updates
+
+=== Version 2.3.2
+
+<i>Retracted</i>
+
+=== Version 2.3.1
+
+- Raise exception when trying to run an invalid query.
+- Several bug fixes in SQL generation
+- Several other minor bugfixes.
+
+=== Version 2.3.0
+
+- Added support for querying key-value relations.
+- Improved querying of relations.
+- Add support for syntax and value autocompletion of queries.
+- Add Rails UI helpers for autocompletion
+- Localized handling of dates
+- Fixed some Ruby 1.9 compatibility issues
+- Test coverage enhancements
+- Improved project infrastructure with infinity test and bundler.
+
+=== Version 2.2.1
+
+- Fix a parsing bug that would cause exceptions to be raised on certain queries.
+- Upgrade to RSpec 2
+- Fixed some Ruby 1.9 compatibility issues
+
+=== Version 2.2.0
+
+- Improved gem release management rake tasks.
+
+=== Version 2.1.1
+
+- Better handling of <tt>NULL</tt> values when evaluating queries.
+- Improved support for ActiveRecord 3.0.
+- Added an incomplete Oracle adapter.
+
+=== Version 2.1.0
+
+- Support for multiple search profiles.
+- Documentation improvements.
+
+=== Version 2.0.1
+
+- Improved project infrastructure and documentation
+
+=== Version 2.0
+
+- Complete rewrite, to support a more complex query language. It now supports operators, logical constructs including parentheses, NULL checks, searching in a single field only.
+- More fine-grained control over in what fields should be searched by using a new definition syntax. (The old syntax is still available for backwards compatibility.
+- Migrated testsuite from Test::Unit to RSpec.
+
+=== Version 1.2
+
+- Ruby 1.9 compatibility
+
+=== Version 1.1
+
+- Support for integer fields
+- RCov integrated in testuite
+
+=== Version 1.0
+
+- RDoc documentation
+- Improved testsuite
+
+=== Version 0.7
+
+- Use the <tt>ILIKE</tt> operator in PostgreSQL for case insensitive search.
+- Tests can be run on different DBMSs.
+
+=== Version 0.6
+
+- Search in associated models as well using <tt>ActiveRecord</tt> associations.
+
+=== Version 0.3
+
+- Detection of column types so they can be handled properly
+- Date based queries supported on date and time fields
+
+=== Version 0.2
+
+- <tt>OR</tt> keyword supported in query language
+
+=== Version 0.1.0
+
+- Initial version

data/CONTRIBUTING.rdoc

@@ -0,0 +1,38 @@
+= Contributing
+
+Scoped search is an open source project, and hence we are open for contributions from anybody.
+
+== Reporting issues
+
+When reporting an issue, make sure to include the following information so we can pinpoint the problem faster:
+
+- What query did you use?
+- What is the search definition used on your models?
+- What do the tables involved in your search definition look like? Please include the type of the fields.
+- A sample of records. Which one did you expect to be included in the result
+
+Finally, please include the following information about your environment.
+
+- What version of scoped search you are using (e.g. 2.0).
+- What database, including version you are using. (e.g. PostgreSQL 9.3)
+- What version of ActiveRecord you are using (e.g. 4.1).
+- What version of Ruby you are using (e.g. MRI 2.1.1)
+
+Please test your problem with the latest released version first. It's the only version that we support.
+
+
+== Submitting pull requests
+
+We will gladly accept contributions to this library. Just fork it, make your changes and open a pull request. In order to keep the quality of this library high, and maintain it in the long run, we will code review your changes before merging. We sometimes do not accept changes if we feel it is outside the scope of the project. Feel free to contact if you are unsure.
+
+To get started understanding the structure of the library, read https://github.com/wvanbergen/scoped_search/wiki/Design-and-internals. It has a short overview of the different components and how they work together.
+
+To get your code accepted as quickly as possible, keep the following in mind:
+
+- Don't break backwards compatibility. If for some reason you really have to, please contact us first.
+- Follow code conventions. They are not written down, so try to follow the style of the surrounding code.
+- Make sure RDoc comments for the methods you add or change are up to date. You can use Yardoc extensions.
+- Add or update specs for the functionality you add or change.
+- Make sure that the specs pass for every version of ActiveRecord, every version of Ruby, and every database we support. Feel free to rely on Travis CI to do this (https://travis-ci.org/wvanbergen/scoped_search/).
+- Do <b>not</b> update <tt>ScopedSearch::VERSION</tt>.
+- Add an short entry describing your changes to the "Unreleased changes" section of <tt>CHANGELOG.rdoc</tt>.

data/{Gemfile.activerecord4 → Gemfile.activerecord40}

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'activerecord', '~> 4.0.0.beta1'
+gem 'activerecord', '~> 4.0.0'
 
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'

data/{Gemfile.activerecord2 → Gemfile.activerecord41}

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'activerecord', '~> 2'
+gem 'activerecord', '~> 4.1.0'
 
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'
@@ -11,6 +11,6 @@ end
 
 platforms :ruby do
   gem 'sqlite3'
-  gem 'mysql2', '~> 0.2.6'
+  gem 'mysql2', '~> 0.3.11'
   gem 'pg'
 end

data/README.rdoc

@@ -11,22 +11,16 @@ auto-completer and a value auto-completer. It also comes with a set of helpers t
 to create a clean web UI with sorting and an ajax auto-completer.
 
 == Preview
+
 A demo application using the scoped search can be found here: http://github.com/abenari/scoped_search_demo_app
 A running version of the demo application can be found here: http://scope-search-demo.heroku.com
-A Rails 3.2 demo with assets pipeline and twitter bootstrap theame https://github.com/abenari/search-demo2
+A Rails 3.2 demo with assets pipeline and twitter bootstrap: theme https://github.com/abenari/search-demo2
 
 == Installing
-For a Rails 3 application add the following line in your Gemfile, and run <tt>bundle install</tt>:
-
-  gem "scoped_search"
 
-For Rails 2 Add the following code to your Rails configuration in <tt>config/environment.rb</tt>,
-and run <tt>rake gems:install</tt> to install the gem.:
+Add the following line in your Gemfile, and run <tt>bundle install</tt>:
 
-  Rails::Initializer.run do |config|
-    ...
-    config.gem 'scoped_search'
-  end
+  gem "scoped_search"
 
 == Usage
 
@@ -59,7 +53,7 @@ actually chain the call with other scopes, or with will_paginate. An example:
 
 === Search profiles
 
-If you include a :profile option to the scoped_searchcall, the fields specified will only
+If you include a :profile option to the scoped_search call, the fields specified will only
 be searched when you include this :profile into the search_for command as well:
 
   class User < ActiveRecord::Base
@@ -70,7 +64,7 @@ be searched when you include this :profile into the search_for command as well:
 This will only search the :public_information column:
 
   User.search_for('blah blah blah')
-  
+
 And this will only search the :private_information column:
 
   User.search_for('blah blah blah', :profile => :members)
@@ -116,17 +110,18 @@ For more info, see the the project wiki: http://github.com/wvanbergen/scoped_sea
 
 == Additional resources
 
-* Source code: http://github.com/wvanbergen/scoped_search/tree
-* Project wiki: http://github.com/wvanbergen/scoped_search/wiki
-* Issue tracker: http://github.com/wvanbergen/scoped_search/issues
-* RDoc documentation: http://rdoc.info/projects/wvanbergen/scoped_search
-* wvanbergen's blog posts: http://techblog.floorplanner.com/tag/scoped_search
-* abenari's blog: http://scopedsearch.wordpress.com/
+* Project wiki: https://github.com/wvanbergen/scoped_search/wiki
+* Issue tracker: https://github.com/wvanbergen/scoped_search/issues
+* RDoc documentations: http://www.rubydoc.info/gems/scoped_search
+* Source code: https://github.com/wvanbergen/scoped_search
+
+- See CHANGELOG.rdoc for the changes to this library over time.
+- See CONTRIBUTING.rdoc if you want to report bugs, or help out on this project.
 
 == License
 
 This plugin is released under the MIT license (see LICENSE).
 
-This plugin was originally developed for Floorplanner.com by Willem van Bergen 
-(https://github.com/wvanbergen) with help from Wes Hays (https://github.com/weshays). 
+This plugin was originally developed for Floorplanner.com by Willem van Bergen
+(https://github.com/wvanbergen) with help from Wes Hays (https://github.com/weshays).
 The current maintainer is Amos Benari (https://github.com/abenari).

data/app/assets/stylesheets/scoped_search.scss

@@ -1,7 +1,3 @@
-/*
- *= require jquery.ui.autocomplete
- */
-
 // Opacity
 @mixin opacity($opacity) {
   opacity: $opacity / 100;

data/lib/scoped_search.rb

@@ -18,6 +18,7 @@ module ScopedSearch
   module ClassMethods
 
     def self.extended(base)
+      super
       base.class_attribute :scoped_search_definition
     end
 
@@ -37,31 +38,6 @@ module ScopedSearch
     end
   end
 
-  # The <tt>BackwardsCompatibility</tt> module can be included into
-  # <tt>ActiveRecord::Base</tt> to provide the <tt>searchable_on</tt> search
-  # field definition syntax that is compatible with scoped_seach 1.x
-  #
-  # Currently, it is included into <tt>ActiveRecord::Base</tt> by default, but
-  # this may change in the future. So, please uodate to the newer syntax as
-  # soon as possible.
-  module BackwardsCompatibility
-
-    # Defines fields to search on using a syntax compatible with scoped_search 1.x
-    def searchable_on(*fields)
-
-      options = fields.last.kind_of?(Hash) ? fields.pop : {}
-      # TODO: handle options?
-
-      fields.each do |field|
-        if relation = self.reflections.keys.detect { |relation| field.to_s =~ Regexp.new("^#{relation}_(\\w+)$") }
-          scoped_search(:in => relation.to_sym, :on => $1.to_sym)
-        else
-          scoped_search(:on => field)
-        end
-      end
-    end
-  end
-
   # The default scoped_search exception class.
   class Exception < StandardError
   end
@@ -84,7 +60,7 @@ module ScopedSearch
 end
 
 # Load all lib files
-require "scoped_search/version"
+require 'scoped_search/version'
 require 'scoped_search/definition'
 require 'scoped_search/query_language'
 require 'scoped_search/query_builder'
@@ -92,7 +68,6 @@ require 'scoped_search/auto_complete_builder'
 
 # Import the search_on method in the ActiveReocrd::Base class
 ActiveRecord::Base.send(:extend, ScopedSearch::ClassMethods)
-ActiveRecord::Base.send(:extend, ScopedSearch::BackwardsCompatibility)
 
 # Rails & Compass integration
 require 'scoped_search/railtie' if defined?(::Rails)