scoped_search 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5ac5265b984d6208df025b20dd336950d9bdbb
-  data.tar.gz: 3643c8835b43e6333e24d44473b1b29c3ec7ac91
+  metadata.gz: 3b15c18415944dcdf767c8ab154ac00186290c2b
+  data.tar.gz: ca8384a89a6887ae0335b02fe7d8e0341654c063
 SHA512:
-  metadata.gz: 7d760759a261eda13744cad755263a056213315859bc925e5ea814cd0e214e19941dc6b3e07572f80b0bf10058359d6895f663a9249b894fa53297c9f81a7efa
-  data.tar.gz: 4b9580f1b55aeaf6f74b64847318361d58f1e3a7477376b1db4921861ec95db3ba8594f7a6f5915f097fdd9313b2fb9bd30b26afc53c2199d3f367d8fa54c336
+  metadata.gz: 3534f6ce7a7c2d0edc4c3d5ca1fe5c43bf21ef51491861d298da837dcb949d86a237df26680f1273a9f8ec88a0bf6b139efd8e801747e9c994435628f66dd343
+  data.tar.gz: 7fedaf4f620b8f77b5dd3594a77810f51632ac7a8d0d5ac33ea946c34ae4b085eb85ca7502ebe2c8955b93d1f9c5940ba76422ef180fe4177709d1290878d13e

data/.travis.yml

@@ -15,6 +15,7 @@ rvm:
 - "2.1"
 - "2.2.2"
 - "2.3.1"
+- "2.4.0"
 - ruby-head
 - jruby-19mode
 - jruby-head
@@ -22,6 +23,7 @@ rvm:
 gemfile:
 - Gemfile.activerecord42
 - Gemfile.activerecord50
+- Gemfile.activerecord51
 
 matrix:
   allow_failures:
@@ -33,3 +35,7 @@ matrix:
       gemfile: Gemfile.activerecord50
     - rvm: "2.1"
       gemfile: Gemfile.activerecord50
+    - rvm: "2.0"
+      gemfile: Gemfile.activerecord51
+    - rvm: "2.1"
+      gemfile: Gemfile.activerecord51

data/CHANGELOG.rdoc

@@ -8,6 +8,17 @@ Please add an entry to the "Unreleased changes" section in your pull requests.
 
 *Nothing yet*
 
+=== Version 4.1.0
+
+- Add support for ActiveRecord and ActionView 5.1
+- Add support for Ruby 2.4
+- Support calling `search_for` on an STI subclass, returning only records of the
+  subclass type. (#112)
+- Inherited search definitions: when defining search fields on both STI parents
+  and subclasses, the subclass can now be searched on all fields, including
+  those inherited from the parent. Only works for STI classes. (#135)
+- Add 'tomorrow' and 'from now' keywords for searching future dates (#162)
+
 === Version 4.0.0
 
 - Drop support for Ruby 1.9

data/Gemfile

@@ -1,8 +1,11 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'actionview'
 gem 'activerecord'
 
+gem 'nokogiri', '~> 1.6.0' if RUBY_VERSION.start_with?('2.0')
+
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'
   gem 'activerecord-jdbcmysql-adapter'

data/Gemfile.activerecord42

@@ -1,8 +1,11 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'actionview', '~> 4.2.0'
 gem 'activerecord', '~> 4.2.0'
 
+gem 'nokogiri', '~> 1.6.0' if RUBY_VERSION.start_with?('2.0')
+
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'
   gem 'activerecord-jdbcmysql-adapter'

data/Gemfile.activerecord50

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'actionview', '~> 5.0.0'
 gem 'activerecord', '~> 5.0.0'
 
 platforms :jruby do

data/Gemfile.activerecord51

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'actionview', '>= 5.1.0.beta1', '< 5.2'
+gem 'activerecord', '>= 5.1.0.beta1', '< 5.2'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+end
+
+platforms :ruby do
+  gem 'sqlite3', '~> 1.3.6'
+  gem 'mysql2', '>= 0.3.18', '< 0.5'
+  gem 'pg', '~> 0.18'
+end

data/lib/scoped_search.rb

@@ -24,9 +24,14 @@ module ScopedSearch
 
     # Export the scoped_search method fo defining the search options.
     # This method will create a definition instance for the class if it does not yet exist,
-    # and use the object as block argument and retun value.
+    # or if a parent definition exists then it will create a new one inheriting it,
+    # and use the object as block argument and return value.
     def scoped_search(*definitions)
       self.scoped_search_definition ||= ScopedSearch::Definition.new(self)
+      unless self.scoped_search_definition.klass == self  # inheriting the parent
+        self.scoped_search_definition = ScopedSearch::Definition.new(self)
+      end
+
       definitions.each do |definition|
         if definition[:on].kind_of?(Array)
           definition[:on].each { |field| self.scoped_search_definition.define(definition.merge(:on => field)) }

data/lib/scoped_search/auto_complete_builder.rb

@@ -229,12 +229,14 @@ module ScopedSearch
       options << '"2 hours ago"'
       options << 'Today'
       options << 'Yesterday'
+      options << 'Tomorrow'
       options << 2.days.ago.strftime('%A')
       options << 3.days.ago.strftime('%A')
       options << 4.days.ago.strftime('%A')
       options << 5.days.ago.strftime('%A')
       options << '"6 days ago"'
       options << 7.days.ago.strftime('"%b %d,%Y"')
+      options << '2 weeks from now'
       options
     end
 

data/lib/scoped_search/definition.rb

@@ -81,11 +81,10 @@ module ScopedSearch
         @word_size        = word_size
 
         # Store this field in the field array
-        definition.fields[rename ? rename.to_sym : @field] ||= self
-        definition.unique_fields << self
+        definition.define_field(rename || @field, self)
 
         # Store definition for aliases as well
-        aliases.each { |al| definition.fields[al.to_sym] ||= self }
+        aliases.each { |al| definition.define_field(al, self) }
       end
 
       # The ActiveRecord-based class that belongs to this field.
@@ -193,14 +192,29 @@ module ScopedSearch
 
     attr_accessor :profile, :default_order
 
+    def super_definition
+      klass.superclass.try(:scoped_search_definition)
+    end
+
+    def define_field(name, field)
+      @profile ||= :default
+      @profile_fields[@profile] ||= {}
+      @profile_fields[@profile][name.to_sym] ||= field
+      @profile_unique_fields[@profile] ||= []
+      @profile_unique_fields[@profile] = (@profile_unique_fields[@profile] + [field]).uniq
+      field
+    end
+
     def fields
       @profile ||= :default
       @profile_fields[@profile] ||= {}
+      super_definition ? super_definition.fields.merge(@profile_fields[@profile]) : @profile_fields[@profile]
     end
 
     def unique_fields
       @profile ||= :default
       @profile_unique_fields[@profile] ||= []
+      super_definition ? (super_definition.unique_fields + @profile_unique_fields[@profile]).uniq : @profile_unique_fields[@profile]
     end
 
     # this method return definitions::field object from string
@@ -241,13 +255,16 @@ module ScopedSearch
     end
 
     # Try to parse a string as a datetime.
-    # Supported formats are Today, Yesterday, Sunday, '1 day ago', '2 hours ago', '3 months ago','Jan 23, 2004'
+    # Supported formats are Today, Yesterday, Sunday, '1 day ago', '2 hours ago', '3 months ago', '4 weeks from now', 'Jan 23, 2004'
     # And many more formats that are documented in Ruby DateTime API Doc.
     def parse_temporal(value)
       return Date.current if value =~ /\btoday\b/i
       return 1.day.ago.to_date if value =~ /\byesterday\b/i
+      return 1.day.from_now.to_date if value =~ /\btomorrow\b/i
       return (eval($1.strip.gsub(/\s+/,'.').downcase)).to_datetime if value =~ /\A\s*(\d+\s+\b(?:hours?|minutes?)\b\s+\bago)\b\s*\z/i
       return (eval($1.strip.gsub(/\s+/,'.').downcase)).to_date     if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bago)\b\s*\z/i
+      return (eval($1.strip.gsub(/from\s+now/i,'from_now').gsub(/\s+/,'.').downcase)).to_datetime if value =~ /\A\s*(\d+\s+\b(?:hours?|minutes?)\b\s+\bfrom\s+now)\b\s*\z/i
+      return (eval($1.strip.gsub(/from\s+now/i,'from_now').gsub(/\s+/,'.').downcase)).to_date     if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bfrom\s+now)\b\s*\z/i
       DateTime.parse(value, true) rescue nil
     end
 
@@ -274,12 +291,13 @@ module ScopedSearch
 
     # Registers the search_for named scope within the class that is used for searching.
     def register_named_scope! # :nodoc
-      definition = self
-      @klass.scope(:search_for, proc { |query, options|
-        klass = definition.klass
+      @klass.define_singleton_method(:search_for) do |query = '', options = {}|
+        # klass may be different to @klass if the scope is called on a subclass
+        klass = self
+        definition = klass.scoped_search_definition
 
         search_scope = klass.all
-        find_options = ScopedSearch::QueryBuilder.build_query(definition, query || '', options || {})
+        find_options = ScopedSearch::QueryBuilder.build_query(definition, query || '', options)
         search_scope = search_scope.where(find_options[:conditions])   if find_options[:conditions]
         search_scope = search_scope.includes(find_options[:include])   if find_options[:include]
         search_scope = search_scope.joins(find_options[:joins])        if find_options[:joins]
@@ -287,7 +305,7 @@ module ScopedSearch
         search_scope = search_scope.references(find_options[:include]) if find_options[:include]
 
         search_scope
-      })
+      end
     end
 
     # Registers the complete_for method within the class that is used for searching.

data/lib/scoped_search/rails_helper.rb

@@ -47,10 +47,10 @@ module ScopedSearch
       unless selected_sort.nil?
         css_classes = html_options[:class] ? html_options[:class].split(" ") : []
         if selected_sort == ascend
-          as = "▲ #{as}"
+          as = "▲ ".html_safe + as
           css_classes << "ascending"
         else
-          as = "&#9660;&nbsp;#{as}"
+          as = "&#9660;&nbsp;".html_safe + as
           css_classes << "descending"
         end
         html_options[:class] = css_classes.join(" ")
@@ -61,13 +61,7 @@ module ScopedSearch
 
       as = raw(as) if defined?(RailsXss)
 
-      a_link(as, html_escape(url_for(url_options)),html_options)
-    end
-
-    def a_link(name, href, html_options)
-      tag_options = tag_options(html_options)
-      link = "<a href=\"#{href}\"#{tag_options}>#{name}</a>"
-      return link.respond_to?(:html_safe) ? link.html_safe : link
+      content_tag(:a, as, html_options.merge(href: url_for(url_options)))
     end
   end
 end

data/lib/scoped_search/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/spec/integration/api_spec.rb

@@ -21,13 +21,6 @@ describe ScopedSearch, "API" do
     ScopedSearch::RSpec::Database.close_connection
   end
 
-  context 'for unprepared ActiveRecord model' do
-
-    it "should respond to :scoped_search to setup scoped_search for the model" do
-      Class.new(ActiveRecord::Base).should respond_to(:scoped_search)
-    end
-  end
-
   context 'for a prepared ActiveRecord model' do
 
     before(:all) do
@@ -44,8 +37,22 @@ describe ScopedSearch, "API" do
       @class.should respond_to(:search_for)
     end
 
-    it "should return a ActiveRecord::Relation instance" do
+    it "should return a ActiveRecord::Relation instance with no arguments" do
+      @class.search_for.should be_a(ActiveRecord::Relation)
+    end
+
+    it "should return a ActiveRecord::Relation instance with one argument" do
       @class.search_for('query').should be_a(ActiveRecord::Relation)
     end
+
+    it "should return a ActiveRecord::Relation instance with two arguments" do
+      @class.search_for('query', {}).should be_a(ActiveRecord::Relation)
+    end
+
+    it "should respect existing scope" do
+      @class.create! field: 'a'
+      record = @class.create! field: 'ab'
+      @class.where(field: 'ab').search_for('field ~ a').should eq([record])
+    end
   end
 end

data/spec/integration/auto_complete_spec.rb

@@ -91,7 +91,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       end
 
       it "should complete when query is already distinct" do
-        Foo.uniq.complete_for('int =').length.should > 0
+        Foo.distinct.complete_for('int =').length.should > 0
       end
 
       it "should raise error for unindexed field" do

data/spec/integration/ext_method_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+# These specs will run on all databases that are defined in the spec/database.yml file.
+# Comment out any databases that you do not have available for testing purposes if needed.
+ScopedSearch::RSpec::Database.test_databases.each do |db|
+
+  describe ScopedSearch, "using a #{db} database" do
+
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+
+      @class = ScopedSearch::RSpec::Database.create_model(alpha: :integer, beta_id: :integer) do |klass|
+        klass.send(:define_singleton_method, :test_ext_alpha) do |key, operator, value|
+          { conditions: "#{key} = ?", parameter: [value.to_i * 2] }
+        end
+        klass.scoped_search on: :alpha, ext_method: :test_ext_alpha
+      end
+
+      @class2 = ScopedSearch::RSpec::Database.create_model(int: :integer) do |klass|
+        klass.has_one @class.table_name.to_sym, foreign_key: :beta_id
+      end
+      c2table = @class2.table_name.to_sym
+      @class.belongs_to c2table, foreign_key: :beta_id
+
+      @class.send(:define_singleton_method, :test_ext_beta) do |key, operator, value|
+        { joins: c2table, conditions: "#{c2table}.int = ?", parameter: [value.to_i] }
+      end
+      @class.scoped_search relation: c2table, on: :int, rename: :beta, ext_method: :test_ext_beta
+
+      @class.create!(alpha: 1)
+      @beta = @class2.create!(int: 42)
+      @two = @class.create!(alpha: 2, beta_id: @beta.id)
+    end
+
+    after(:all) do
+      ScopedSearch::RSpec::Database.drop_model(@class)
+      ScopedSearch::RSpec::Database.drop_model(@class2)
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    it 'should find record via conditions + parameter' do
+      @class.search_for('alpha = 1').should == [@two]
+    end
+
+    it 'should find record via joins + conditions + parameter' do
+      @class.search_for('beta = 42').should == [@two]
+    end
+  end
+end

data/spec/integration/ordinal_querying_spec.rb

@@ -166,6 +166,8 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @curent_record = @class.create!(:timestamp => Time.current, :date => Date.current)
         @hour_ago_record = @class.create!(:timestamp => Time.current - 1.hour, :date => Date.current)
         @day_ago_record = @class.create!(:timestamp => Time.current - 1.day, :date => Date.current - 1.day)
+        @tomorrow_record = @class.create!(:timestamp => Time.current + 1.day, :date => Date.current + 1.day)
+        @week_from_now_record = @class.create!(:timestamp => Time.current + 1.week, :date => Date.current + 1.week)
         @month_ago_record = @class.create!(:timestamp => Time.current - 1.month, :date => Date.current - 1.month)
         @year_ago_record = @class.create!(:timestamp => Time.current - 1.year, :date => Date.current - 1.year)
       end
@@ -174,6 +176,8 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @curent_record.destroy
         @hour_ago_record.destroy
         @day_ago_record.destroy
+        @tomorrow_record.destroy
+        @week_from_now_record.destroy
         @month_ago_record.destroy
         @year_ago_record.destroy
       end
@@ -186,6 +190,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @class.search_for('date = yesterday').length.should == 1
       end
 
+      it "should accept Tomorrow as date format" do
+        @class.search_for('date = tomorrow').length.should == 1
+      end
+
       it "should find all timestamps and date from today using the = operator" do
         @class.search_for('= Today').length.should == 2
       end
@@ -198,16 +206,24 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @class.search_for('date < "2 days ago"').length.should == 2
       end
 
-       it "should accept 3 hours ago as date format" do
-        @class.search_for('timestamp > "3 hours ago"').length.should == 2
-       end
+      it "should accept 3 hours ago as date format" do
+        @class.search_for('timestamp > "3 hours ago"').length.should == 4
+      end
+
+      it "should accept 1 week from now as date format" do
+        @class.search_for('date < "1 week from now"').length.should == 6
+      end
+
+      it "should accept 1 month ago as date format" do
+        @class.search_for('date > "1 month ago"').length.should == 5
+      end
 
-       it "should accept 1 month ago as date format" do
-        @class.search_for('date > "1 month ago"').length.should == 3
-       end
+      it "should accept 1 month from now as date format" do
+        @class.search_for('date < "1 month from now"').length.should == 7
+      end
 
       it "should accept 1 year ago as date format" do
-        @class.search_for('date > "1 year ago"').length.should == 4
+        @class.search_for('date > "1 year ago"').length.should == 6
       end
 
     end

data/spec/{unit → integration}/rails_helper_spec.rb

@@ -1,19 +1,10 @@
 require "spec_helper"
+require "action_view"
 require "scoped_search/rails_helper"
 
-module ActionViewHelperStubs
-  def html_escape(str)
-    str
-  end
-
-  def tag_options(options)
-    ""
-  end
-end
-
 describe ScopedSearch::RailsHelper do
   include ScopedSearch::RailsHelper
-  include ActionViewHelperStubs
+  include ActionView::Helpers
 
   let(:params) { HashWithIndifferentAccess.new(:controller => "resources", :action => "search") }
 
@@ -71,26 +62,21 @@ describe ScopedSearch::RailsHelper do
     sort("other")
   end
 
-  it "should add no styling by default" do
-    should_receive(:url_for)
-    should_receive(:a_link).with('Field', anything, hash_excluding(:class))
-    sort("field")
+  it "should set :href and no :class on anchor" do
+    should_receive(:url_for).and_return('/example')
+    sort("field").should == '<a href="/example">Field</a>'
   end
 
   it "should add ascending style for current ascending sort order " do
-    should_receive(:url_for)
-    should_receive(:a_link).with('&#9650;&nbsp;Field', anything, hash_including(:class => 'ascending'))
-
+    should_receive(:url_for).and_return('/example')
     params[:order] = "field ASC"
-    sort("field")
+    sort("field").should == '<a class="ascending" href="/example">&#9650;&nbsp;Field</a>'
   end
 
   it "should add descending style for current descending sort order " do
-    should_receive(:url_for)
-    should_receive(:a_link).with('&#9660;&nbsp;Field', anything, hash_including(:class => 'descending'))
-
+    should_receive(:url_for).and_return('/example')
     params[:order] = "field DESC"
-    sort("field")
+    sort("field").should == '<a class="descending" href="/example">&#9660;&nbsp;Field</a>'
   end
 
   context 'with ActionController::Parameters' do

data/spec/integration/scope_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+# These specs will run on all databases that are defined in the spec/database.yml file.
+# Comment out any databases that you do not have available for testing purposes if needed.
+ScopedSearch::RSpec::Database.test_databases.each do |db|
+
+  describe ScopedSearch, "using a #{db} database" do
+
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+
+      @class = ScopedSearch::RSpec::Database.create_model(:field => :string) do |klass|
+        klass.scoped_search :on => :field
+      end
+    end
+
+    after(:all) do
+      ScopedSearch::RSpec::Database.drop_model(@class)
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    context '.search_for' do
+      it "should respect existing scope" do
+        @class.create! field: 'a'
+        record = @class.create! field: 'ab'
+        @class.where(field: 'ab').search_for('field ~ a').should eq([record])
+      end
+    end
+  end
+end

data/spec/integration/sti_querying_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+# These specs will run on all databases that are defined in the spec/database.yml file.
+# Comment out any databases that you do not have available for testing purposes if needed.
+ScopedSearch::RSpec::Database.test_databases.each do |db|
+
+  describe ScopedSearch, "using a #{db} database" do
+
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+
+      @related_class = ScopedSearch::RSpec::Database.create_model(int: :integer)
+
+      @parent_class = ScopedSearch::RSpec::Database.create_model(int: :integer, type: :string, related_id: :integer) do |klass|
+        klass.scoped_search on: :int
+      end
+      @subclass1 = ScopedSearch::RSpec::Database.create_sti_model(@parent_class)
+      @subclass2 = ScopedSearch::RSpec::Database.create_sti_model(@parent_class) do |klass|
+        klass.belongs_to @related_class.table_name.to_sym, foreign_key: :related_id
+        klass.scoped_search on: :int, rename: :other_int
+        klass.scoped_search relation: @related_class.table_name, on: :int, rename: :related_int
+      end
+
+      @related_class.has_many @subclass1.table_name.to_sym
+
+      @record1 = @subclass1.create!(int: 7)
+      @related_record1 = @related_class.create!(int: 42)
+      @record2 = @subclass2.create!(int: 9, related_id: @related_record1.id)
+    end
+
+    after(:all) do
+      @record1.destroy
+      @record2.destroy
+
+      ScopedSearch::RSpec::Database.drop_model(@parent_class)
+      ScopedSearch::RSpec::Database.drop_model(@related_class)
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    context 'querying STI parent and subclasses' do
+      it "should find a record using the parent class" do
+        @parent_class.search_for('int = 7').should eq([@record1])
+      end
+
+      it "should find a record using the subclass" do
+        @subclass1.search_for('int = 7').should eq([@record1])
+      end
+
+      it "should not find a record using the wrong subclass" do
+        @subclass2.search_for('int = 7').should eq([])
+        @subclass2.search_for('int = 9').should eq([@record2])
+      end
+
+      it "parent should not recognize field from subclass" do
+        lambda { @parent_class.search_for('related_int = 9') }.should raise_error(ScopedSearch::QueryNotSupported, "Field 'related_int' not recognized for searching!")
+      end
+
+      it "should autocomplete int field on parent" do
+        @parent_class.complete_for('').should contain(' int ')
+      end
+
+      it "should autocomplete int field on subclass" do
+        @subclass1.complete_for('').should contain(' int ')
+      end
+
+      it "should autocomplete int, other_int, related_int fields on subclass" do
+        @subclass2.complete_for('').should contain(' int ')
+        @subclass2.complete_for('').should contain(' other_int ')
+        @subclass2.complete_for('').should contain(' related_int ')
+      end
+    end
+
+    context 'querying definition on STI subclass' do
+      it "should find a record using subclass definition" do
+        @subclass2.search_for('other_int = 9').should eq([@record2])
+      end
+
+      it "should find a record via relation" do
+        @subclass2.search_for('related_int = 42').should eq([@record2])
+      end
+    end
+  end
+end

data/spec/lib/database.rb

@@ -58,6 +58,13 @@ module ScopedSearch::RSpec::Database
     return klass
   end
 
+  def self.create_sti_model(parent)
+    klass_name = "#{parent.table_name}_#{rand}".gsub(/\W/, '')
+    klass = ScopedSearch::RSpec::Database.const_set(klass_name.classify, Class.new(parent))
+    yield(klass) if block_given?
+    return klass
+  end
+
   def self.drop_model(klass)
     klass.constants.grep(/\AHABTM_/).each do |habtm_class|
       ActiveRecord::Migration.drop_table(klass.const_get(habtm_class).table_name)

data/spec/lib/mocks.rb

@@ -10,10 +10,17 @@ module ScopedSearch::RSpec::Mocks
     ar_mock.stub(:scope).with(:search_for, anything)
     ar_mock.stub(:connection).and_return(mock_database_connection)
     ar_mock.stub(:ancestors).and_return([ActiveRecord::Base])
+    ar_mock.stub(:superclass).and_return(ActiveRecord::Base)
     ar_mock.stub(:columns_hash).and_return({'existing' => double('column')})
     return ar_mock
   end
 
+  def mock_activerecord_subclass(parent)
+    ar_mock = mock_activerecord_class
+    ar_mock.stub(:superclass).and_return(parent)
+    return ar_mock
+  end
+
   def mock_database_connection
     c_mock = double('ActiveRecord::Base.connection')
     return c_mock

data/spec/unit/definition_spec.rb

@@ -6,6 +6,7 @@ describe ScopedSearch::Definition do
     @klass      = mock_activerecord_class
     @definition = ScopedSearch::Definition.new(@klass)
     @definition.stub(:setup_adapter)
+    @klass.stub(:scoped_search_definition).and_return(@definition)
   end
 
   describe ScopedSearch::Definition::Field do
@@ -62,14 +63,65 @@ describe ScopedSearch::Definition do
 
   describe '#initialize' do
     it "should create the named scope when" do
-      @klass.should_receive(:scope).with(:search_for, instance_of(Proc))
       ScopedSearch::Definition.new(@klass)
+      @klass.should respond_to(:search_for)
     end
 
     it "should not create the named scope if it already exists" do
       @klass.stub(:search_for)
-      @klass.should_not_receive(:scope)
+      @klass.should_not_receive(:define_singleton_method)
       ScopedSearch::Definition.new(@klass)
     end
   end
+
+  describe '#define_field' do
+    it "should add to fields" do
+      field = instance_double('ScopedSearch::Definition::Field')
+      @definition.define_field('test', field)
+      @definition.fields.should eq(test: field)
+      @definition.unique_fields.should eq([field])
+    end
+
+    it "should add aliases" do
+      field = instance_double('ScopedSearch::Definition::Field')
+      @definition.define_field('test', field)
+      @definition.define_field('alias', field)
+      @definition.fields.should eq(test: field, alias: field)
+      @definition.unique_fields.should eq([field])
+    end
+
+    it "should ignore duplicate field names" do
+      field1 = instance_double('ScopedSearch::Definition::Field')
+      field2 = instance_double('ScopedSearch::Definition::Field')
+      @definition.define_field('test', field1)
+      @definition.define_field('test', field2)
+      @definition.fields.should eq(test: field1)
+      @definition.unique_fields.should eq([field1, field2])
+    end
+  end
+
+  describe '#fields' do
+    before(:each) do
+      @subklass      = mock_activerecord_subclass(@klass)
+      @subdefinition = ScopedSearch::Definition.new(@subklass)
+      @subdefinition.stub(:setup_adapter)
+    end
+
+    it "should return fields from class" do
+      field = @definition.define(on: 'foo')
+      @definition.fields.should eq(foo: field)
+    end
+
+    it "should return fields from parent class" do
+      field = @definition.define(on: 'foo')
+      @subdefinition.fields.should eq(foo: field)
+    end
+
+    it "should combine fields from class and parent class" do
+      field1 = @definition.define(on: 'foo')
+      field2 = @subdefinition.define(on: 'foo', only_explicit: true)
+      field3 = @subdefinition.define(on: 'bar')
+      @subdefinition.fields.should eq(foo: field2, bar: field3)
+    end
+  end
 end

data/spec/unit/query_builder_spec.rb

@@ -2,9 +2,11 @@ require "spec_helper"
 
 describe ScopedSearch::QueryBuilder do
 
+  let(:klass) { Class.new(ActiveRecord::Base) }
+
   before(:each) do
     @definition = double('ScopedSearch::Definition')
-    @definition.stub(:klass).and_return(Class.new(ActiveRecord::Base))
+    @definition.stub(:klass).and_return(klass)
     @definition.stub(:profile).and_return(:default)
     @definition.stub(:default_order).and_return(nil)
     @definition.stub(:profile=).and_return(true)
@@ -55,4 +57,35 @@ describe ScopedSearch::QueryBuilder do
 
     lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error('my custom message')
   end
+
+  context "with ext_method" do
+    before do
+      @definition = ScopedSearch::Definition.new(klass)
+      @definition.define(:test_field, ext_method: :ext_test)
+    end
+
+    it "should return combined :conditions and :parameter" do
+      klass.should_receive(:ext_test).with('test_field', '=', 'test_val').and_return(conditions: 'field = ?', parameter: ['test_val'])
+      ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val').should eq(conditions: ['(field = ?)', 'test_val'])
+    end
+
+    it "should return :joins and :include" do
+      klass.should_receive(:ext_test).with('test_field', '=', 'test_val').and_return(include: 'test1', joins: 'test2')
+      ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val').should eq(include: ['test1'], joins: ['test2'])
+    end
+
+    it "should raise error when non-hash returned" do
+      klass.should_receive(:ext_test).and_return('test')
+      lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error(ScopedSearch::QueryNotSupported, /should return hash/)
+    end
+
+    it "should raise error when method doesn't exist" do
+      lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error(ScopedSearch::QueryNotSupported, /doesn't respond to 'ext_test'/)
+    end
+
+    it "should ignore exceptions" do
+      klass.should_receive(:ext_test).and_raise('test')
+      ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val').should eq({})
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Amos Benari
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,6 +84,7 @@ files:
 - Gemfile
 - Gemfile.activerecord42
 - Gemfile.activerecord50
+- Gemfile.activerecord51
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -109,11 +110,15 @@ files:
 - spec/database.ruby.yml
 - spec/integration/api_spec.rb
 - spec/integration/auto_complete_spec.rb
+- spec/integration/ext_method_spec.rb
 - spec/integration/key_value_querying_spec.rb
 - spec/integration/ordinal_querying_spec.rb
 - spec/integration/profile_querying_spec.rb
+- spec/integration/rails_helper_spec.rb
 - spec/integration/relation_querying_spec.rb
+- spec/integration/scope_spec.rb
 - spec/integration/set_query_spec.rb
+- spec/integration/sti_querying_spec.rb
 - spec/integration/string_querying_spec.rb
 - spec/lib/database.rb
 - spec/lib/matchers.rb
@@ -124,7 +129,6 @@ files:
 - spec/unit/definition_spec.rb
 - spec/unit/parser_spec.rb
 - spec/unit/query_builder_spec.rb
-- spec/unit/rails_helper_spec.rb
 - spec/unit/tokenizer_spec.rb
 - spec/unit/validators_spec.rb
 homepage: https://github.com/wvanbergen/scoped_search/wiki
@@ -163,11 +167,15 @@ test_files:
 - spec/database.ruby.yml
 - spec/integration/api_spec.rb
 - spec/integration/auto_complete_spec.rb
+- spec/integration/ext_method_spec.rb
 - spec/integration/key_value_querying_spec.rb
 - spec/integration/ordinal_querying_spec.rb
 - spec/integration/profile_querying_spec.rb
+- spec/integration/rails_helper_spec.rb
 - spec/integration/relation_querying_spec.rb
+- spec/integration/scope_spec.rb
 - spec/integration/set_query_spec.rb
+- spec/integration/sti_querying_spec.rb
 - spec/integration/string_querying_spec.rb
 - spec/lib/database.rb
 - spec/lib/matchers.rb
@@ -178,6 +186,5 @@ test_files:
 - spec/unit/definition_spec.rb
 - spec/unit/parser_spec.rb
 - spec/unit/query_builder_spec.rb
-- spec/unit/rails_helper_spec.rb
 - spec/unit/tokenizer_spec.rb
 - spec/unit/validators_spec.rb