acts_as_wild_searchable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,58 @@
+= ActsAsWildSearchable
+---------
+This plugin allows you to search in your models on each of its attributes using <b>wild cards</b>.
+The default behavior is to chain the search parameters using "or" and wild cards in both sides.
+This behavior can be changed by adding the :clause=>"and" and the :left=>true or :right=>true parameters
+
+== GEM Location
+  gem 'act_as_wild_searchable', :git => 'http://github.com/canimus/act_as_wild_searchable.git'
+
+== Installation
+  bundle install
+  
+== Tested Versions
+* Rails 3.2.3
+
+== Usage
+
+=== Query Basics
+
+* the +_like?+ method
+
+  Consider that you model has the name attribute
+    User.name_like? "John"
+
+* the +chain+ capabilities
+
+  To chain various queries just add another query after the usage of the like? method
+    User.name_like?("John").where(:id => 1)
+
+* the +multiple_search+ 
+
+  You can add as many clauses and by default will be added using an "or" clause
+    User.name_like? "John","David", "Peter" # Produces where (name like ? or name like ? or name like ?, "%John%", "%David%", "%Peter%")
+
+* the +left+ 
+
+  You can position the wild card with a hash addition to the call
+    User.name_like? "John","David", :left => true # Produces where (name like ? or name like ?,  "%John", "%David")
+
+* the +right+ 
+
+  You can position the wild card with a hash addition to the call
+    User.name_like? "John","David", :right => true # Produces where (name like ? or name like ?,  "John%", "David%")
+
+* the +clause+ 
+
+  You can change the default behavior for the wild card search by addint the clause hash
+    User.name_like? "John","David", :clause => "and" # Produces where (name like ? and name like ?,  "%John%", "%David%")
+    
+
+  
+
+=== General configuration options
+
+You can configure the following attributes that will locate the wild card for your search
+  left              # false by default
+  right             # false by default
+  clause            # "or" by default

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsWildSearchable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/acts_as_wild_searchable.rb

@@ -0,0 +1,87 @@
+# This module extends the capabilities
+# of a rails model class exnteded of ActiveRecord::Base
+# to allow searching on each of its attributes
+# using a percentage wild card based on an
+# array of options which can include 2 different types
+# of entries: Strings and Hashes
+# * Strings: will be used as search conditions
+# * Hashes: will be only taken if they match: clause, left or right and their respective values are true
+#
+# Author::    Herminio Vazquez  (mailto:canimus@gmail.com)
+# Copyright:: Copyright (c) 2012 Perforchestor
+# License::   Distributes under the same terms as Ruby
+
+# This module extends the capabilities to 
+# perform queries in a rails model
+# by implementing the method missing on the class
+# and allowing the usage of _like? on every attribute
+# and the side of the wild card for searching
+module ActsAsWildSearchable
+  extend ActiveSupport::Concern
+  
+  def self.included(base) # :nodoc:
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def acts_as_wild_searchable(options={})
+      # Code definition for search capabilities here
+    end    
+    
+    def method_missing(method_name, *args)
+      # Verify that method start with attribute name followed by like?
+      if match = method_name.to_s.match(/^([a-zA-Z]\w*)_like\?$/)
+        apply_filter(match.captures.first, args)
+      else
+        super
+      end
+    end
+    
+    private 
+
+    # This method contains all the logic of the plugin
+    # as it recognizes the parameters sent to the method
+    # and executes the query in the model class
+    # bold: Returns an ActiveRecord::Relation
+    # Which means that can be chainable with other ActiveRecord::Relations
+    def apply_filter(capture, filter)
+      
+      clauses = filter.select { |element| 
+        element.kind_of? Hash 
+      }.reduce({:clause=>"or"}) { |h, pairs| pairs.each { |k,v| h[k]=v}; h}
+      
+      conditions = filter.select { |element| 
+        element.kind_of? String
+      }.map { |condition| 
+          wild_condition = "#{condition}"
+          if (clauses.has_key?(:left) and clauses[:left]) 
+            wild_condition.insert(0, "%")
+          end
+
+          if (clauses.has_key?(:right) and clauses[:right]) 
+            wild_condition<<"%"
+          end
+
+          unless (wild_condition.start_with?("%") or wild_condition.end_with?("%"))
+            wild_condition = "%#{condition}%"
+          end
+
+          wild_condition
+      }         
+      
+        sentences = conditions.map { |x| "#{capture} like ?" }
+      
+      if (clauses.has_key?(:clause) and clauses[:clause]=="and" )
+        join_type = " and "
+      else
+        join_type = " or "
+      end
+      sentences = sentences.join(join_type) if sentences.size > 1
+      sentences = sentences.first if sentences.size == 1      
+      where conditions.prepend sentences
+    end
+    
+  end
+  
+  ActiveRecord::Base.send :include, ActsAsWildSearchable
+end

data/lib/acts_as_wild_searchable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsWildSearchable
+  VERSION = "0.0.1"
+end

data/lib/tasks/acts_as_wild_searchable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_wild_searchable do
+#   # Task goes here
+# end

data/test/acts_as_wild_searchable_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class ActsAsWildSearchableTest < ActiveSupport::TestCase
+  test "modules exists" do
+    assert_kind_of Module, ActsAsWildSearchable
+  end
+  
+  test "query_single_no_clause_no_wild" do    
+    query = User.name_like?("Herminio")
+    assert query.explain.include?("name like '%Herminio%'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+  
+  test "query_multiple_no_clause_no_wild" do    
+    query = User.name_like?("Herminio", "Kalli")
+    assert query.explain.include?("name like '%Herminio%' or name like '%Kalli%'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+  
+  test "query_single_no_clause_wild_left" do    
+    query = User.name_like?("Herminio", :left=>true)
+    assert query.explain.include?("name like '%Herminio'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+
+  test "query_single_no_clause_wild_right" do    
+    query = User.name_like?("Herminio", :right=>true)
+    assert query.explain.include?("name like 'Herminio%'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+  
+  test "query_or_left" do    
+    query = User.name_like?("Herminio", "Kalli", :clause => "or", :left=>true)
+    assert query.explain.include?("name like '%Herminio' or name like '%Kalli'")
+    assert_kind_of ActiveRecord::Relation, query
+  end 
+  
+  test "query_and_left" do
+    query = User.name_like?("Herminio", "Kalli", :clause => "and", :left=>true)
+    assert query.explain.include?("name like '%Herminio' and name like '%Kalli'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+  
+  test "query_or_right" do
+    query = User.name_like?("Herminio", "Kalli", :clause => "or", :right=>true)
+    assert query.explain.include?("name like 'Herminio%' or name like 'Kalli%'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+
+  test "query_and_right" do
+    query = User.name_like?("Herminio", "Kalli", :clause => "and", :right=>true)
+    assert query.explain.include?("name like 'Herminio%' and name like 'Kalli%'")
+    assert_kind_of ActiveRecord::Relation, query
+  end
+
+  
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.