search_redux 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05db95b0f1118f55c5e23b538d535fd045c1f423
+  data.tar.gz: 37ecb95b3b84d3e6654561f917529c8f7455aed7
+SHA512:
+  metadata.gz: f83575ea4ced7d460ab58edd6ab1a2651e586e48d717da44ad1af4a7af3b5048646cb436e2295f6a5017a2012773f29a59f49464d814e35ea62825142c40d578
+  data.tar.gz: bf3d3f9024b2e449e73125da20cd223df7478201008d6ed98691f4304285a9717f8b852c7b464bd93d57efc766e5018223c14d9d2c6df28da160071927ce6054

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# Full text search redux
+
+The current version is just a code extract of a simple text search logic using  Postgres [functionality](http://www.postgresql.org/docs/8.3/static/textsearch.html) and a simple fallback for other RDBMs (e.g. Mysql)
+
+For now the usage is limited, it expects a `title` and a `content` column.
+
+## Installation
+
+Include the gem in your Gemfile:
+
+```ruby
+gem 'search_redux'
+```
+
+## Quick start
+
+```ruby
+class MyModel
+  act_as_searchable
+end
+
+class MyController
+  def index
+    an_article = MyModel.text_search 'query phrase'
+  end
+end
+```

data/lib/search_redux.rb

@@ -0,0 +1,27 @@
+require 'search_redux/version'
+require 'search_redux/errors'
+require 'search_redux/helpers'
+require 'search_redux/glue'
+require 'search_redux/searchable'
+require 'search_redux/rdbms/mysql'
+require 'search_redux/rdbms/postgres'
+
+require 'search_redux/railtie'
+
+module SearchRedux
+  extend Helpers
+
+  module ClassMethods
+    def act_as_searchable(options = {})
+      attr_accessor :searchable
+
+      @searchable = SearchRedux::Searchable.new options
+    end
+
+    def text_search(query)
+      raise(Errors::ActAsSearchableUnintialized, 'Use act_as_searchable') unless @searchable
+
+      @searchable.full_text_search(query, self)
+    end
+  end
+end

data/lib/search_redux/errors.rb

@@ -0,0 +1,9 @@
+module SearchRedux
+  class Error < StandardError; end
+
+  module Errors
+    class ActAsSearchableUnintialized < SearchRedux::Error; end
+
+    class NoQuery < SearchRedux::Error; end
+  end
+end

data/lib/search_redux/glue.rb

@@ -0,0 +1,7 @@
+module SearchRedux
+  module Glue
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/search_redux/helpers.rb

@@ -0,0 +1,16 @@
+module SearchRedux
+  module Helpers
+    def select_best_query_strategy(adapter, query)
+      case adapter
+      when /mysql.*/i
+        SearchRedux::Mysql.compatible_search(query)
+      when /postgres.*/i
+        SearchRedux::Postgres.compatible_search(query)
+      end
+    end
+
+    def db_adapter
+      ActiveRecord::Base::connection.adapter_name
+    end
+  end
+end

data/lib/search_redux/railtie.rb

@@ -0,0 +1,20 @@
+module SearchRedux
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    initializer 'search_redux.insert_into_active_record' do |app|
+      SearchRedux::Railtie.insert
+    end
+
+    # rake_tasks { load 'tasks/search_redux.rake' }
+  end
+
+  class Railtie
+    def self.insert
+      if defined? ActiveRecord
+        # do the dew
+        ActiveRecord::Base.send(:include, SearchRedux::Glue)
+      end
+    end
+  end
+end

data/lib/search_redux/rdbms/mysql.rb

@@ -0,0 +1,7 @@
+module SearchRedux
+  class Mysql
+    def self.compatible_search(query)
+      ->(obj) { obj.where("title like :q or content like :q", q: "%#{query}%") }
+    end
+  end
+end

data/lib/search_redux/rdbms/postgres.rb

@@ -0,0 +1,30 @@
+module SearchRedux
+  class Postgres
+    class << self
+      attr_accessor :sanitized_query
+
+      def compatible_search(options)
+        query           = options[:query]
+
+        rank_query      = rank_sql options[:rank], query
+        search_query    = search_sql options[:columns]
+
+        ->(obj) { obj.where(search_query, q: query).order(rank_query) }
+      end
+
+      def rank_sql(rank_column, query)
+        sanitized_query = ActionController::Base.helpers.sanitize(query)
+
+        "ts_rank(to_tsvector(#{rank_column}), plainto_tsquery('#{sanitized_query}')) desc"
+      end
+
+      def search_sql(columns)
+        template = ->(column_name) {
+          return "to_tsvector('english', #{column_name}) @@ plainto_tsquery(:q)"
+        }
+
+        columns.map { |c| template.call(c) }.join(' OR ')
+      end
+    end
+  end
+end

data/lib/search_redux/searchable.rb

@@ -0,0 +1,35 @@
+module SearchRedux
+  extend Helpers
+
+  class Searchable
+    attr_accessor :columns
+    attr_accessor :rank
+    attr_reader   :options
+
+    def self.default_options
+      @default_options ||= {
+        :columns => %w(title content),
+        :rank    => 'title'
+      }
+    end
+
+    def initialize(options = {})
+      options = self.class.default_options.merge(options)
+
+      @options = options
+    end
+
+    def full_text_search(query, active_record_instance)
+      if query.present?
+        @options.merge! :query => query
+
+        adapter  = SearchRedux.db_adapter
+        strategy = SearchRedux.select_best_query_strategy(adapter, @options)
+
+        strategy.call(active_record_instance)
+      else
+        active_record_instance.scoped
+      end
+    end
+  end
+end

data/lib/search_redux/version.rb

@@ -0,0 +1,3 @@
+module SearchRedux
+  VERSION = '0.0.4' unless defined? SearchRedux::VERSION
+end

data/search_redux.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'search_redux/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'search_redux'
+  s.version       = SearchRedux::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = 'Add a text_search method to your models.'
+  s.description   = 'Simple ActiveRecord full text search.'
+  s.author        = 'Marian Posaceanu'
+  s.email         = 'contact@marianposaceanu.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/dakull/search_redux'
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_dependency('activerecord', '>= 3.0.0')
+  s.add_dependency('activemodel', '>= 3.0.0')
+  s.add_dependency('activesupport', '>= 3.0.0')
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: search_redux
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Marian Posaceanu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Simple ActiveRecord full text search.
+email: contact@marianposaceanu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/search_redux.rb
+- lib/search_redux/errors.rb
+- lib/search_redux/glue.rb
+- lib/search_redux/helpers.rb
+- lib/search_redux/railtie.rb
+- lib/search_redux/rdbms/mysql.rb
+- lib/search_redux/rdbms/postgres.rb
+- lib/search_redux/searchable.rb
+- lib/search_redux/version.rb
+- search_redux.gemspec
+homepage: https://github.com/dakull/search_redux
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Add a text_search method to your models.
+test_files: []