sa-detector 0.3.0

data/README.md

@@ -0,0 +1,55 @@
+# Stand Alone Detector
+
+This gem is created for simple addition of search by a certain parameter. Additionally sorting the records by the position of the search phrase in the parameter.
+
+## Installation
+
+Gemfile:
+
+    gem 'sa-detector'
+
+## How to use
+
+Suppose there is a class named 'Document' with the parameter named 'title':
+
+    create_table :documents do |t|
+      t.string :title
+      t.string :annotation
+    end
+
+### Search only
+
+You need to add **searchable_by** inside class.
+
+    # For search by one parameter
+
+    class Document < ActiveRecord::Base
+      searchable_by :title
+    end
+
+    # For search by multiple parameters
+
+    class Document < ActiveRecord::Base
+      searchable_by :title, :annotation
+    end
+
+And then you can search using the following command:
+
+    Document.search_with params[:search_query]
+
+### Search and sort by only one parameter
+
+**TODO:** add support for multiple parameters
+
+You need to add **searchable_and_sortable_by** inside class:
+
+    class Document < ActiveRecord::Base
+      searchable_and_sortable_by :title
+    end
+
+And then you can search and sort using the following command:
+
+    Document.search_and_sort_with params[:search_query]
+
+The result is an array of found records, sorted by the positions of search phrase in the parameter.
+

data/init.rb

@@ -0,0 +1 @@
+require 'sa_detector'

data/lib/sa_detector.rb

@@ -0,0 +1 @@
+require 'sa_detector/active_record'

data/lib/sa_detector/active_record.rb

@@ -0,0 +1,43 @@
+module SaDetector
+  module ActiveRecord
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def searchable_by *attributes
+        @@attributes = attributes
+
+        class << self
+          define_method "search_with" do |query|
+            query = query.to_s.downcase
+
+            sql = [@@attributes.map{ |attribute| "LOWER(#{self.table_name}.#{attribute}) LIKE ?" }.join(" OR ")]
+            sql += Array.new(@@attributes.count, "%#{query}%")
+            self.where(sql)
+          end
+        end
+      end
+
+      def searchable_and_sortable_by attribute
+        @@attribute = attribute
+
+        class << self
+          define_method "search_and_sort_with" do |query|
+            query = query.to_s.downcase
+
+            result = self.where("LOWER(#{self.table_name}.#{@@attribute}) LIKE ?", "%#{query}%")
+            result.size > 0 ? self.sort_for_search_results(result, query) : []
+          end
+
+          define_method "sort_for_search_results" do |result, query|
+            result.sort{ |a,b| a[@@attribute].downcase.index(query) <=> b[@@attribute].downcase.index(query) }
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include SaDetector::ActiveRecord }
+

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: sa-detector
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Artem Kornienko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-09 00:00:00.000000000 Z
+dependencies: []
+description: Simple gem for searching and sorting data.
+email: send.this.to.moff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sa_detector/active_record.rb
+- lib/sa_detector.rb
+- README.md
+- init.rb
+homepage: http://rubygems.org/gems/sa-detector
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Stand Alone Detector
+test_files: []