posterboy 0.0.1

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Durran Jordan
+
+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/lib/posterboy.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+require 'active_record'
+require 'active_support/concern'
+require 'posterboy/document'
+require 'posterboy/version'
+
+module Posterboy #:nodoc:
+  extend ActiveSupport::Concern
+
+  # This is the base query used to perform a full-text search in Postgre.
+  QUERY = "to_tsvector('english', documents.search_text) @@ plainto_tsquery('english', ?)"
+
+  # Operators for performing different types of searches.
+  OPERATORS = { and: '&', or: '|' }
+
+  included do
+
+    # Each searchable model has a reference to a single {#Posterboy::Document},
+    # which is where the searchable attributes will get stored.
+    has_one \
+      :document,
+      as: :searchable,
+      inverse_of: :searchable,
+      class_name: "Posterboy::Document"
+
+    # The search scope takes a space separated list of terms to perform an
+    # AND query on. This should be configurable in the future.
+    #
+    # @example
+    #   User.search('Syd London')
+    #
+    # @param [ Symbol ] operator The type of search to perform.
+    # @param [ String ] term The words to search on.
+    #
+    # @return [ ActiveRecord::Relation ] The matching records.
+    scope :search, lambda { | operator, term |
+      if term.present?
+        {
+          include: [:document],
+          conditions: [ QUERY, term.gsub(' ', " #{OPERATORS[:operator]} ") ]
+        }
+     end
+    }
+
+    # Update the searchable {#Document} after each save.
+    set_callback :save, :after, :update_document
+
+    # Searchable fields are stored here.
+    class_inheritable_accessor :searchables
+  end
+
+  private
+
+  # Get the actual values for the attributes that have been defined as
+  # searchable.
+  #
+  # @example
+  #   user.searchable_values
+  #
+  # @return [ Array ] The actual values for this record.
+  def searchable_values
+    [].tap do |values|
+      searchables.each do |searchable|
+        searchable.is_a?(Hash) ?
+          values << send(searchable.to_a[0][0]).map(&searchable.to_a[0][1]) :
+          values << send(searchable)
+      end
+    end
+  end
+
+  # Updates or creates the document with the supplied attribute values with
+  # each save.
+  #
+  # @example
+  #   user.update_document
+  def update_document
+    if searchables
+      text = searchable_values.flatten.join(' ')
+      return document.update_attribute(:search_text, text) if document
+      create_document(search_text: text)
+    end
+  end
+
+  module ClassMethods
+
+    # Macro to define which attributes should be searched on.
+    #
+    # @example
+    #   class User < ActiveRecord::Base
+    #     has_many :tags, through: :user_tags
+    #
+    #     search_on :first_name, :last_name, tags: :name
+    #   end
+    #
+    # @param [ Array<Symbol> ] args The attributes to search on.
+    def search_on(*args)
+      self.searchables = args
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Posterboy)

data/lib/posterboy/document.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module Posterboy
+  class Document < ActiveRecord::Base
+    belongs_to :searchable, polymorphic: true, inverse_of: :document
+    set_table_name :documents
+  end
+end

data/lib/posterboy/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Posterboy #:nodoc:
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: posterboy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Durran Jordan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug-wrapper
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Adds full-text search to Active Record models on PostgreSQL
+email: 
+- durran@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/posterboy/document.rb
+- lib/posterboy/version.rb
+- lib/posterboy.rb
+- MIT_LICENSE
+- README
+has_rdoc: true
+homepage: http://github.com/durran/posterboy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 398691525175066671
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: posterboy
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: PostgreSQL Search Done Easy
+test_files: []
+