ripple_searchable 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ripple_searchable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Ronai
+
+MIT License
+
+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.md

@@ -0,0 +1,67 @@
+# RippleSearchable
+
+Mongoid / Active Record style query criteria DSL and Scoping for Ripple
+using RIAK's solr search interface.
+
+RippleSearchable adds chainable Criteria methods such as :where, :lt, :lte, :gt, :gte, :between
+along with :sort, :skip, :limit options to your Ripple::Document models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ripple_searchable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ripple_searchable
+
+## Usage
+
+### Criteria:
+
+Any of the following criteria can be chained:
+
+    :where, :lt, :lte, :gt, :gte, :between, with sort, :skip, :limit
+
+=== Example:
+
+```ruby
+  Product.where(tags: "nerd", name: "joe", something: 2).or({can_sell:
+1}, {can_sell: 3}).between(availibility: 1..3, price: [3,
+12]).gte(quantity: 0, ratings: 5).sort(created_at, :desc).limit(5)
+```
+
+### Scoping
+
+Mongoid / Active Record style named scopes:
+
+=== Example:
+
+```ruby
+  class Product
+    include Ripple::Document
+
+    scope :active, where(active: true)
+    scope :avail, ->(count){ where(quantity: count)}
+
+  end
+```
+
+See docs for method details.
+
+TODO: Write better docs.
+
+## Contributing
+
+This gem is still under heavy development. Feel free to contribute.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ripple_searchable/criteria.rb

@@ -0,0 +1,305 @@
+require 'active_support/concern'
+
+module Ripple
+
+  class CriteriaError < StandardError; end
+
+  # chainable Criteria methods such as :where, :lt, :lte, :gt, :gte, :between, 
+  # with sort, :skip, :limit options
+  class Criteria
+
+    include Translation
+    include Enumerable
+
+    attr_accessor :selector, :klass, :options, :response, :cached, :total, :docs, :document_ids
+
+    def initialize(klass)
+      @selector, @klass, @options, @documents, @cached = "", klass, {}
+      clear_cache
+    end
+
+    # Main criteria selector to search records
+    #
+    # === Example
+    #
+    #   Model.where(tags: "nerd", name: "Joe", something: 2)
+    #
+    # will append this selector:
+    # "(tags:nerd AND name:Joe AND something:2)"
+    def where(selector = nil)
+      case selector
+      when String
+        add_restriction selector
+      when Hash
+        add_restriction to_lucene_pair(selector)
+      end
+      self
+    end
+
+    # Add an OR selector
+    #
+    # === Example
+    #
+    #   Product.or({name: "Pants"}, {name: "Shirt"})
+    #
+    # will append this selector:
+    # "((name:Pants) OR (name:Shirt))"
+    def or(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          add_restriction(to_lucene_pair(crit, operator: "OR"), operator: "OR" )
+        end
+      end
+      self
+    end
+
+    alias :any_of :or
+
+    # Add an Range selector. Values in the passed hash can be either a Range or an Array.
+    # of the passed hash has multiple elements, the condition will be AND.
+    # The range is inclusive.
+    #
+    # === Example
+    #
+    #   Product.between(availibility: 1..3, price: [12, 20])
+    #
+    # will append this selector:
+    # "((availibility:[1 TO 3] AND price:[12 TO 20]))"
+    def between(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          add_restriction(to_lucene_pair(crit, operator: "BETWEEN"))
+        end
+      end
+      self
+    end
+
+    # Add a 'less or equal than' selector
+    #
+    # === Example
+    #
+    #   Product.lte(quantity: 10, ratings: 5)
+    #
+    # will append this selector:
+    # "((quantity:[* TO 10] AND ratings:[* TO 5]))"
+    def lte(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          crit.each {|k,v| crit[k]=Array.wrap(v).unshift(10**20)}
+          add_restriction(to_lucene_pair(crit, operator: "BETWEEN"))
+        end
+      end
+      self
+    end
+
+    # Add a 'greater or equal than' selector
+    #
+    # === Example
+    #
+    #   Product.gte(quantity: 0, ratings: 5)
+    #
+    # will append this selector:
+    # "((quantity:[0 TO *] AND ratings:[5 TO *]))"
+    def gte(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          crit.each {|k,v| crit[k]=Array.wrap(v).push(10**20)}
+          add_restriction(to_lucene_pair(crit, operator: "BETWEEN"))
+        end
+      end
+      self
+    end
+
+    # Add a 'less than' selector
+    #
+    # === Example
+    #
+    #   Product.lt(quantity: 10, ratings: 5)
+    #
+    # will append this selector:
+    # "((quantity:{* TO 10} AND ratings:{* TO 5}))"
+    def lt(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          crit.each {|k,v| crit[k]=Array.wrap(v).unshift("*")}
+          add_restriction(to_lucene_pair(crit, operator: "BETWEEN", exclusive: true))
+        end
+      end
+      self
+    end
+
+    # Add a 'greater than' selector
+    #
+    # === Example
+    #
+    #   Product.gt(quantity: 0, ratings: 5)
+    #
+    # will append this selector:
+    # "((quantity:{0 TO *} AND ratings:{5 TO *}))"
+    def gt(*criterion)
+      add_restriction do
+        criterion.each do |crit|
+          crit.each {|k,v| crit[k]=Array.wrap(v).push("*")}
+          add_restriction(to_lucene_pair(crit, operator: "BETWEEN", exclusive: true))
+        end
+      end
+      self
+    end
+
+    # Add sort options to criteria
+    #
+    # === Example
+    #
+    #   Product.between(availibility:[1,3]).sort(availibility: :asc, created_at: :desc)
+    #
+    # will append this sort option:
+    # "availibility asc, created_at desc"
+    def sort(sort_options)
+      case sort_options
+      when String
+        add_sort_option sort_options
+      when Hash
+        sort_options.each {|k,v| add_sort_option "#{k} #{v.downcase}"}
+      end
+      self
+    end
+
+    alias :order_by :sort
+    alias :order :sort
+
+    # Add limit option to criteria. Useful for pagination. Default is 10.
+    #
+    # === Example
+    #
+    #   Product.between(availibility:[1,3]).limit(10)
+    #
+    # will limit the number of returned documetns to 10
+    def limit(limit)
+      clear_cache
+      self.options[:rows] = limit
+      self
+    end
+
+    alias :rows :limit
+
+    # Add skip option to criteria. Useful for pagination. Default is 0.
+    #
+    # === Example
+    #
+    #   Product.between(availibility:[1,3]).skip(10)
+    #
+    def skip(skip)
+      clear_cache
+      self.options[:start] = skip
+      self
+    end
+
+    alias :start :skip
+
+
+    # Executes the search query
+    def execute
+      raise CriteriaError, t('empty_selector_error') if self.selector.blank?
+      @response = @klass.search self.selector, self.options
+    end
+
+    # Returns the matched documents
+    def documents
+      if @cached
+        @documents
+      else
+        parse_response
+        @cached = true
+        @documents = self.klass.find self.document_ids
+      end
+    end
+
+    def each(&block)
+      documents.each(&block)
+    end
+
+    # Total number of matching documents
+    def total
+      parse_response
+      @total
+    end
+
+    # Array of matching document id's
+    def document_ids
+      parse_response
+      @document_ids
+    end
+
+    def merge(criteria)
+      add_restriction criteria.selector
+      self.options.merge!(criteria.options)
+      self
+    end
+
+    def method_missing(name, *args, &block)
+      if klass.respond_to?(name)
+        klass.send(:with_scope, self) do
+          klass.send(name, *args, &block)
+        end
+      end
+    end
+
+  private
+
+    def clear_cache
+      @documents, @cached, @response, @total, @docs, @document_ids = [], false
+    end
+
+    def parse_response
+      execute if @response.blank?
+      self.total = @response["response"]["numFound"]
+      self.docs = @response["response"]["docs"]
+      self.document_ids = self.docs.map {|e| e["id"]}
+    rescue
+      clear_cache
+      raise CriteriaError, t('failed_query')
+    end
+
+    def add_restriction(*args, &block)
+      clear_cache
+      options = args.extract_options!
+      operator = options[:operator] || "AND"
+      restriction = args.first
+      separator = @selector.present? ? " #{operator} " : ""
+      if block_given?
+        @selector << "#{separator}("
+        yield
+        @selector << ")"
+      else
+        @selector << "#{separator unless @selector[-1] == '('}(#{restriction})"
+      end
+    end
+
+    def add_sort_option(*args)
+      clear_cache
+      args.each do |s|
+        if options[:sort].present?
+          options[:sort] << ", #{s}"
+        else
+          options[:sort] = s
+        end
+      end
+    end
+
+    def to_lucene_pair(conditions, options = {})
+      operator = options[:operator] || "AND"
+      if operator == "BETWEEN"
+        conditions.map do |k,v|
+          case v
+          when Range, Array
+            "#{k}:#{options[:exclusive] ? '{' : '['}#{v.first} TO #{v.last}#{options[:exclusive] ? '}' : ']'}"
+          when String
+            "#{k}: #{v}"
+          end
+        end.join(" AND ")
+      else
+        conditions.map {|k,v| "#{k}:#{v}"}.join(" #{operator} ")
+      end
+    end
+  end
+end

data/lib/ripple_searchable/scoping.rb

@@ -0,0 +1,73 @@
+require 'active_support/concern'
+
+module Ripple
+  module Scoping
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :default_scoping
+      class_attribute :scopes
+      self.scopes = {}
+    end
+
+    module ClassMethods
+
+      def scope(name, value, &block)
+        name = name.to_sym
+        #valid_scope_name?(name)
+        scopes[name] = {
+          scope: strip_default_scope(value),
+          extension: Module.new(&block)
+        }
+        define_scope_method(name)
+      end
+
+      def scope_stack
+        Thread.current[:"#{self.bucket_name}_scope_stack"] ||= []
+      end
+
+      def with_default_scope
+        default_scoping || scope_stack.last || Criteria.new(self)
+      end
+
+      def with_scope(criteria)
+        scope_stack.push(criteria)
+        begin
+          yield criteria
+        ensure
+          scope_stack.pop
+        end
+      end
+
+    protected
+
+      def valid_scope_name?(name)
+        if logger && respond_to?(name, true)
+          logger.warn "Creating scope :#{name}. " \
+                      "Overwriting existing method #{self.name}.#{name}."
+        end
+      end
+
+      def define_scope_method(name)
+        (class << self; self; end).class_eval <<-SCOPE
+          def #{name}(*args)
+            scoping = scopes[:#{name}]
+            scope, extension = scoping[:scope].(*args), scoping[:extension]
+            criteria = with_default_scope.merge(scope)
+            criteria.extend(extension)
+            criteria
+          end
+        SCOPE
+      end
+
+      def strip_default_scope(value)
+        if value.is_a?(Criteria)
+          ->{ value}
+        else
+          value
+        end
+      end
+
+    end
+  end
+end

data/lib/ripple_searchable/searchable.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+
+module Ripple
+  module Searchable
+
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    unless method_defined? :id
+      define_method :id do
+        self.key
+      end
+    end
+
+    module ClassMethods
+
+      attr_accessor :criteria
+
+      delegate :where, :or, :any_of, :gte, :lte, :gt, :lt, :between, :sort, to: :criteria
+
+      # Performs a search via the Solr interface.
+      def search(*args)
+        Ripple.client.search(self.bucket_name, *args)
+      end
+
+      def criteria
+        @criteria = Criteria.new(self)
+      end
+    end
+
+  end
+end

data/lib/ripple_searchable/version.rb

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

data/lib/ripple_searchable.rb

@@ -0,0 +1,12 @@
+require 'ripple'
+require 'ripple/translation'
+require 'active_support/concern'
+require 'ripple_searchable/version'
+require 'ripple_searchable/searchable'
+require 'ripple_searchable/criteria'
+require 'ripple_searchable/scoping'
+
+Ripple::Document.class_eval do
+  include Ripple::Searchable
+  include Ripple::Scoping
+end

data/ripple_searchable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ripple_searchable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Ronai"]
+  gem.email         = ["computadude@me.com"]
+  gem.description   = %q{Mongoid / Active Record style query criteria and scoping for Ripple}
+  gem.summary       = %q{Mongoid / Active Record style query criteria and scoping for Ripple}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ripple_searchable"
+  gem.require_paths = ["lib"]
+  gem.version       = RippleSearchable::VERSION
+
+  gem.add_dependency "activesupport", [">= 3.0.0", "< 3.3.0"]
+  gem.add_dependency "activemodel", [">= 3.0.0", "< 3.3.0"]
+  gem.add_dependency "ripple", ">=1.0.0.beta2"
+
+  gem.add_development_dependency "rails", '3.2.8'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: ripple_searchable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Ronai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: ripple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: Mongoid / Active Record style query criteria and scoping for Ripple
+email:
+- computadude@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ripple_searchable.rb
+- lib/ripple_searchable/criteria.rb
+- lib/ripple_searchable/scoping.rb
+- lib/ripple_searchable/searchable.rb
+- lib/ripple_searchable/version.rb
+- ripple_searchable.gemspec
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Mongoid / Active Record style query criteria and scoping for Ripple
+test_files: []
+has_rdoc: