@@ -1,8 +1,22 @@ +# ScopedSearch is the base module for the scoped_search plugin. This file +# defines some modules and exception classes, loads the necessary files, and +# installs itself in ActiveRecord. +# +# The ScopedSearch module defines two modules that can be mixed into +# ActiveRecord::Base as class methods. <tt>ScopedSearch::ClassMethods</tt> +# will register the scoped_search class function, which can be used to define +# the search fields. <tt>ScopedSearch::BackwardsCompatibility</tt> will +# register the <tt>searchable_on</tt> method for backwards compatibility with +# previous scoped_search versions (1.x). module ScopedSearch - # The ClassMethods module will be included into the ActiveRecord::Base class to add - # the ActiveRecord::Base.scoped_search method and the ActiveRecord::Base.search_for - # named scope. + # The current scoped_search version. Do not change thisvalue by hand, + # because it will be updated automatically by the gem release script. + VERSION = "2.0.1" + + # The ClassMethods module will be included into the ActiveRecord::Base class + # to add the <tt>ActiveRecord::Base.scoped_search</tt> method and the + # <tt>ActiveRecord::Base.search_for</tt> named scope. module ClassMethods # Export the scoped_search method fo defining the search options. @@ -21,14 +35,16 @@ module ScopedSearch end end - # The BackwardsCompatibility module can be included into ActiveRecord::Base to provide - # a search field definition syntax that is compatible with scoped_seach 1.x + # 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 ActiveRecord::Base by default, but this may change in - # the future. So, please uodate to the newer syntax as soon as possible. + # 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.2 + # 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 : {} @@ -44,7 +60,7 @@ module ScopedSearch end end - # The default ScopedSearch exception class. + # The default scoped_search exception class. class Exception < StandardError end lib/scoped_search.rb @@ -252,8 +252,14 @@ module ScopedSearch end end + # The MysqlAdapter makes sure that case sensitive comparisons are used + # when using the (not) equals operator, regardless of the field's + # collation setting. class MysqlAdapter < ScopedSearch::QueryBuilder + # Patches the default <tt>sql_operator</tt> method to add + # <tt>BINARY</tt> after the equals and not equals operator to force + # case-sensitive comparisons. def sql_operator(operator, field) if [:ne, :eq].include?(operator) && field.textual? "#{SQL_OPERATORS[operator]} BINARY" @@ -263,8 +269,13 @@ module ScopedSearch end end + # The PostgreSQLAdapter make sure that searches are case sensitive when + # using the like/unlike operators, by using the PostrgeSQL-specific + # <tt>ILIKE operator</tt> instead of <tt>LIKE</tt>. class PostgreSQLAdapter < ScopedSearch::QueryBuilder + # Switches out the default LIKE operator for ILIKE in the default + # <tt>sql_operator</tt> method. def sql_operator(operator, field) case operator when :like then 'ILIKE' @@ -275,7 +286,7 @@ module ScopedSearch end end - # Include the modu;es into the corresponding classes + # Include the modules into the corresponding classes # to add SQL generation capabilities to them. Definition::Field.send(:include, QueryBuilder::Field) lib/scoped_search/query_builder.rb @@ -1,7 +1,10 @@ Gem::Specification.new do |s| s.name = 'scoped_search' - s.version = '2.0.0' - s.date = '2009-08-26' + + # Do not change the version and date fields by hand. This will be done + # automatically by the gem release script. + s.version = "2.0.0" + s.date = "2009-08-26" s.summary = "A Rails plugin to search your models with a simple query language, implemented using a named_scope" s.description = <<EOS @@ -22,6 +25,8 @@ EOS s.rdoc_options << '--title' << s.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source' s.extra_rdoc_files = ['README.rdoc'] + # Do not change the files and test_files fields by hand. This will be done + # automatically by the gem release script. s.files = %w(LICENSE README.rdoc Rakefile init.rb lib lib/scoped_search lib/scoped_search.rb lib/scoped_search/adapters.rb lib/scoped_search/definition.rb lib/scoped_search/query_builder.rb lib/scoped_search/query_language lib/scoped_search/query_language.rb lib/scoped_search/query_language/ast.rb lib/scoped_search/query_language/parser.rb lib/scoped_search/query_language/tokenizer.rb spec spec/database.yml spec/integration spec/integration/api_spec.rb spec/integration/ordinal_querying_spec.rb spec/integration/relation_querying_spec.rb spec/integration/string_querying_spec.rb spec/lib spec/lib/database.rb spec/lib/matchers.rb spec/lib/mocks.rb spec/spec_helper.rb spec/unit spec/unit/ast_spec.rb spec/unit/definition_spec.rb spec/unit/parser_spec.rb spec/unit/query_builder_spec.rb spec/unit/tokenizer_spec.rb tasks tasks/database_tests.rake tasks/github-gem.rake) s.test_files = %w(spec/integration/api_spec.rb spec/integration/ordinal_querying_spec.rb spec/integration/relation_querying_spec.rb spec/integration/string_querying_spec.rb spec/unit/ast_spec.rb spec/unit/definition_spec.rb spec/unit/parser_spec.rb spec/unit/query_builder_spec.rb spec/unit/tokenizer_spec.rb) end \ No newline at end of file scoped_search.gemspec 07bbb16b75ee854d06fae3f39ae338223f84b0f4 Willem van Bergen willem@vanbergen.org http://github.com/wvanbergen/scoped_search/commit/33a9de9e2f7bf2a40e26b64fe9b61304f32fd64e 33a9de9e2f7bf2a40e26b64fe9b61304f32fd64e 2009-10-01T21:49:55-07:00 2009-10-01T21:49:55-07:00 Added VERSION constant and improved documentation. 02465debd524d47a5c6906441135cc71d32b87c1 Willem van Bergen willem@vanbergen.org