scoped-search 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+.bundle

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem "rspec-rails", ">= 2.0.0.beta.17"
+gem 'jeweler'
+gem "rails", ">= 3.0.0.beta4"
+gem "ruby-debug"
+
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Novagile, Written by Nicolas Blanco.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,125 @@
+h1. ScopedSearch
+
+ScopedSearch is a plugin to easily create search forms and do column ordering.
+It is written specifically for Rails 3 and is compatible with both ActiveRecord and "Mongoid":http://www.mongoid.org.
+
+ScopeSearch is Copyright (c) 2010 Novagile, written by "Nicolas Blanco":http://github.com/slainer68
+
+h2. Philosophy
+
+I've begun writing this plugin because I really like "Searchlogic":http://github.com/binarylogic/searchlogic from "Ben Johnson":http://www.binarylogic.com.
+I was using it in all my Rails 2 Active Record projects.
+
+Searchlogic has a feature that dynamically adds a lot of scopes in your models. But a feature from Searchlogic I really like is the ability to create an object
+that binds to your models scopes and being able to use it directly in a form. You can add many fields in your search forms, and the controller stays
+the same. I really wanted the same behaviour in Rails 3 and compatible with both ActiveRecord and Mongoid.
+
+h2. Installation
+
+For now, ScopedSearch is under development.
+You may use it as plugin or as a gem.
+
+**Gem**
+
+Edit your Gemfile and add :
+
+<pre>
+  gem 'scoped-search'
+</pre>
+
+**Plugin**
+
+<pre>
+  rails plugin install git://github.com/novagile/scoped-search.git
+</pre>
+
+ScopedSearch does not dynamically include itself in ActiveRecord or Mongoid, you have to include it in your models where you want to use it.
+
+Simply include the ScopedSearch::Model module in your models like this...
+
+<pre>
+  class Post < ActiveRecord::Base
+    include ScopedSearch::Model
+  
+    scope :retrieve, lambda { |q| where("title like ?", "%#{q}%") }
+    scope :state_equals, lambda { |state| where( {:state => state }) }
+    scope :published, where(:published => true)
+    ...
+</pre>
+
+In your ApplicationHelper, include the ScopedSearch::Helpers module :
+
+<pre>
+  module ApplicationHelper
+    include ScopedSearch::Helpers
+  end
+</pre>
+
+h2. Console testing
+
+You can test the search object in a console!
+
+<pre>
+  > search = Post.scoped_search
+   => #<ScopedSearch::Base...>
+  > search.count
+   => 4
+  > search.all.map(&:body)
+   => ["test", "lalala", "foo", "bar"] 
+  > search.retrieve = "foo"
+   => "foo"
+  > search.count
+   => 1 
+  > search.all
+   => [#<Post id: 3, title: nil, body: "foo"...]
+</pre>
+
+h2. Usage
+
+Then in your controller you can do like this :
+
+<pre>
+  class PostsController < ApplicationController
+    def index
+      @search = Post.scoped_search(params[:search])
+      @posts = @search.all # or @search.paginate(...), or you can even continue the scope chain ! Just add your scopes like this : @search.build_relation.other_scope.other_other_scope... :)
+      ...
+</pre>
+
+In your view, you can create a form that takes your search object as parameter, like this :
+
+<pre>
+  <%= form_for @search do |f| %>
+    <%= f.text_field :retrieve %>
+    <%= f.select :state_equals, ["pending", "accepted", "deleted"] %>
+    <%= submit_tag "Search" %>
+  <% end %>
+</pre>
+
+h2. Column ordering
+
+You want to get column ordering for free? Sure!
+In your model, use the scoped_order method like this :
+
+<pre>
+  class Post < ActiveRecord::Base
+    ...
+    scoped_order :title, created_at, :updated_at # , ...
+    ...
+</pre>
+
+It will add two scopes for each column, named "ascend_by_column_name" and "descend_by_column_name" (like Searchlogic).
+
+Then in your views, you may use the order_for_scoped_search view helper like this :
+
+<pre>
+  <table>
+    <tr>
+      <th><%= link_to "Title", order_for_scoped_search(:title) %></th>
+      ...
+</pre>
+
+h2. Notes
+
+This plugin is new and under development, patches and contributions are welcome! Please fork and make pull requests, thanks!
+

data/Rakefile

@@ -0,0 +1,35 @@
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "scoped-search"
+    gem.summary = %Q{Easily implement search forms and column ordering based on your models scopes}
+    gem.description = %Q{Easily implement search forms and column ordering based on your models scopes. For Rails 3, compatible with ActiveRecord and Mongoid.}
+    gem.email = "slainer68@gmail.com"
+    gem.homepage = "http://github.com/novagile/scoped-search"
+    gem.authors = ["slainer68"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scoped_search #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/init.rb

@@ -0,0 +1,2 @@
+require "scoped_search"
+

data/lib/scoped_search.rb

@@ -0,0 +1,103 @@
+# ScopedSearch, Copyright (c) 2010 Novagile.
+# Written by Nicolas Blanco.
+# Licensed under MIT license.
+#
+class ScopedSearch
+  class Base
+    extend ActiveModel::Naming
+    
+    SINGLE_SCOPES_VALUES = %w(true 1)
+    
+    attr_reader :attributes, :model_class, :attributes_merged
+    
+    def initialize(klass, options)
+      @model_class       = klass
+      @attributes        = options
+      @attributes_merged = @attributes.reverse_merge(klass.scopes.keys.inject({}) { |m,o| m[o] = nil; m; })
+
+      @attributes_merged.each do |attribute, value|
+        class_eval <<-RUBY
+          def #{attribute}
+            @attributes[:#{attribute}]
+          end
+          
+          def #{attribute}=(val)
+            @attributes[:#{attribute}] = val
+          end
+        RUBY
+      end
+    end
+    
+    def build_relation
+      return model_class if attributes.empty?
+      attributes.reject { |k,v| v.blank? }.inject(model_class) do |s, k|
+        if model_class.scopes.keys.include?(k.first.to_sym)
+          k.size == 2 && SINGLE_SCOPES_VALUES.include?(k.last.to_s) ? s.send(k.first) : s.send(*k)
+        else
+          s
+        end
+      end
+    end
+    
+    def to_key; nil; end
+    
+    def method_missing(method_name, *args)
+      build_relation.send(method_name, *args)
+    end
+  end
+  
+  module Helpers
+    extend ActiveSupport::Concern
+    
+    def form_for(record, *args, &block)
+      if record.is_a?(ScopedSearch::Base)
+        options = args.extract_options!
+        options.symbolize_keys!
+
+        options.reverse_merge!({ :url => polymorphic_path(record.model_class), :as => :search })
+        options[:html] ||= {}
+        options[:html].reverse_merge!({ :method => :get })
+        args << options
+      end
+
+      super(record, *args, &block)
+    end
+    
+    # TODO :
+    # refactor this ?
+    def order_for_scoped_search(column, search_param = :search)
+      search_order = params[search_param].present? && params[search_param]["ascend_by_#{column}"].present? ? { "descend_by_#{column}" => true } : { "ascend_by_#{column}" => true }
+      
+      params[search_param] ||= {}
+      search_without_order = params[search_param].clone
+      search_without_order.delete_if { |k,v| k.to_s.starts_with?("ascend_by") || k.to_s.starts_with?("descend_by") }
+      
+      params.merge(search_param => search_without_order.merge(search_order))
+    end
+  end
+  
+  module Model
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def scoped_search(options={})
+        ScopedSearch::Base.new(self, options.present? ? options : {})
+      end
+      
+      def scoped_order(*columns_names)
+        if defined?(Mongoid) && self.include?(Mongoid::Document)
+          columns_names.each do |column_name|
+            scope :"ascend_by_#{column_name}",  order_by([column_name.to_sym, :desc])
+            scope :"descend_by_#{column_name}", order_by([column_name.to_sym, :asc])
+          end
+        else
+          columns_names.each do |column_name|
+            scope :"ascend_by_#{column_name}",  order("#{column_name} asc")
+            scope :"descend_by_#{column_name}", order("#{column_name} desc")
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/scoped_search_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+%w(blahblah foo bar pipo waouhhh pipomolo).each do |title|
+  Post.create(:title => title, :body => "blah", :published => title.include?("pipo"))
+end
+
+describe 'ScopedSearch' do
+  it 'should respond to scoped_search and return a ScopedSearch::Base object' do
+    Post.should respond_to(:scoped_search)
+    Post.scoped_search.should be_a(ScopedSearch::Base)
+  end
+  
+  it 'should have the same count when initializing an empty search' do
+    Post.count.should == 6
+    
+    @search = Post.scoped_search
+    @search.count.should == 6
+  end
+  
+  describe 'initialization' do
+    it 'should be possible to initialize without a hash and change attributes later' do
+      @search = Post.scoped_search
+      @search.attributes.should == {}
+      
+      @search.retrieve = "pipo"
+      @search.published = true
+      @search.attributes.should have(2).elements
+      @search.attributes[:retrieve].should == "pipo"
+      @search.attributes[:published].should == true
+    end
+    
+    it 'should be possible to initialize with a hash' do
+      @search = Post.scoped_search({ :retrieve => "pipo", :published => true })
+      @search.attributes.should have(2).elements
+      
+      @search.retrieve.should == "pipo"
+      @search.published.should == true
+    end
+  end
+  
+  describe 'searching' do
+    it 'should be possible to search with one parameter' do
+      @search = Post.scoped_search({ :retrieve => "foo" })
+      @search.retrieve.should == "foo"
+      @search.count.should == 1
+      
+      @search.all.should have(1).element
+      @search.retrieve = nil
+      @search.count.should == 6
+    end
+    
+    it 'should be possible to search with multiple parameters' do
+      @search = Post.scoped_search({ :retrieve => "foo", :published => true })
+      @search.retrieve.should == "foo"
+      @search.published.should == true
+      @search.count.should == 0
+      
+      @search.all.should have(0).element
+      @search.retrieve = nil
+      @search.count.should == 2
+      @search.all.should have(2).elements
+    end
+  end
+  
+  it 'should be possible to build the relation' do
+    @search = Post.scoped_search({ :retrieve => "foo" })
+    @search.build_relation.should be_a(ActiveRecord::Relation)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'ruby-debug'
+require 'rspec'
+
+require "active_record"
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts do |t|
+    t.string :title
+    t.text :body
+    t.boolean :published
+
+    t.timestamps
+  end
+end
+
+require File.dirname(__FILE__) + '/../lib/scoped_search'
+
+class Post < ActiveRecord::Base
+  include ScopedSearch::Model
+  
+  scope :published, where(:published => true)
+  scope :retrieve, lambda { |q| where("title like ?", "%#{q}%") }
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: scoped-search
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- slainer68
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Easily implement search forms and column ordering based on your models scopes. For Rails 3, compatible with ActiveRecord and Mongoid.
+email: slainer68@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- lib/scoped_search.rb
+- spec/scoped_search_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/novagile/scoped-search
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily implement search forms and column ordering based on your models scopes
+test_files: 
+- spec/scoped_search_spec.rb
+- spec/spec_helper.rb