searchable 0.0.1 → 0.0.3

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@searchable --create

data/README.md

@@ -1,6 +1,11 @@
 # Searchable
 
-TODO: Write a gem description
+With this gem you can implement
+
+1. search by string
+2. filter by starting letter or number
+
+Searching is using "LIKE" syntax.
 
 ## Installation
 
@@ -18,7 +23,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Activate gem in your model:
+
+    has_searchable :name
+
+Update your controller action:
+
+    @projects = Project.search(search_options)
+
+Add @search@ param to url to search. This will find any project with "car" in the name:
+
+    http://localhost:3000/projects?search=car
+
+Add @letter@ param to url to search by starting letter. This will find any project with first letter "C":
+
+    http://localhost:3000/projects?letter=c
+
+Add @letter@ param to url with value "num" to search by numbers. This will find projects with any number in the beginning:
+
+    http://localhost:3000/projects?letter=num
+
+
+### Search form
+
+Here's the simple HAML snippet for search form. You can add it to your index action:
+
+    = form_tag request.path, :method => :get do
+      = text_field_tag :search, params[:search]
+      = submit_tag "Search"
+
+### Letter filter
+
+Here's the simple HAML letter filter snippet. It is generating A, B, C, etc links, "#" link for numbers and reset link (visible only when filter is active).
+
+    - if params[:letter]
+      = link_to "Reset filter", {}
+
+    - if params[:letter] == "num"
+      = link_to "#", {:letter => "num"}
+
+    - ("A".."Z").each do |c|
+      = link_to c, {:letter => c.downcase}
 
 ## Contributing
 

data/lib/searchable.rb

@@ -1,34 +1,43 @@
 require "searchable/version"
 
 module Searchable
-  def has_searchable field
-    @field = field
-    extend InstanceMethods
-  end
+  module ActiveRecord
+    def has_searchable field
+      @field = field
+      extend InstanceMethods
+    end
 
-  module InstanceMethods
-    def search(options = {})
-      case search_method(options)
-      when :string
-        self.where(["#{@field} LIKE ?", "%#{options[:by]}%"])
-      when :letter
-        self.where(["#{@field} LIKE ?", "#{options[:by_letter]}%"])
-      when :numbers
-        self.where(["#{@field} RLIKE ?", '^[0-9]'])
-      else
-        self.where(1)
+    module InstanceMethods
+      def search(options = {})
+        case search_method(options)
+        when :string
+          self.where(["#{@field} LIKE ?", "%#{options[:by]}%"])
+        when :letter
+          self.where(["#{@field} LIKE ?", "#{options[:by_letter]}%"])
+        when :numbers
+          self.where(["#{@field} RLIKE ?", '^[0-9]'])
+        else
+          self.where(1)
+        end
       end
-    end
 
-    private
-    def search_method(options)
-      if options[:by]
-        :string
-      elsif options[:by_letter]
-        options[:by_letter] == "num" ? :numbers : :letter
+      private
+      def search_method(options)
+        if options[:by]
+          :string
+        elsif options[:by_letter]
+          options[:by_letter] == "num" ? :numbers : :letter
+        end
       end
     end
   end
+
+  module Controller
+    def search_options
+      {:by => params[:search], :by_letter => params[:letter]}
+    end
+  end
 end
 
-ActiveRecord::Base.extend Searchable
+ActiveRecord::Base.extend Searchable::ActiveRecord
+ActionController::Base.send :include, Searchable::Controller

data/lib/searchable/version.rb

@@ -1,3 +1,3 @@
 module Searchable
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/searchable.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Stefan Huska"]
   gem.email         = ["stefan.huska@gmail.com"]
   gem.description   = %q{Simple search by LIKE queries}
-  gem.summary       = %q{Searching in rails app}
-  gem.homepage      = "http://www.stefanhuska.sk"
+  gem.summary       = %q{Simple search by LIKE queries}
+  gem.homepage      = "http://github.com/kelso/searchable"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
@@ -26,7 +27,7 @@ files:
 - lib/searchable.rb
 - lib/searchable/version.rb
 - searchable.gemspec
-homepage: http://www.stefanhuska.sk
+homepage: http://github.com/kelso/searchable
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -49,5 +50,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Searching in rails app
+summary: Simple search by LIKE queries
 test_files: []