ripplr 0.0.6.beta → 0.0.7.beta

data/README.md

@@ -1,2 +1,38 @@
-Ripplr
-======
+Ripplr (Think Ripple/Solr)
+======
+Ripplr assists with indexing your Ripple documents stored in Riak. Ripplr currently supports simple full text indexing
+using Riak's Solr capabilities. This will evolve to support 2i as well. 
+
+Dependencies
+============
+Ripplr is dependant on `ripple` and `riak-client`. Ripplr is available on RubyGems and can be installed by adding `ripplr` to your Gemfile.
+
+It's simple to use!
+===================
+Once you've installed the Ripplr gem using bundler you can begin setting up your Ripple Documents to be queryable.
+
+To make a document queryable, `include Ripplr::Queryable` and then describe which fields you would like to be queryable by using a `queryable` block.
+
+For example you can define a class as queryable like this:
+```ruby
+class Wod
+  include Ripple::Document
+  include Ripplr::Queryable
+  property :description, String
+  property :notes, String
+  property :performed_at, Time
+  
+  queryable do
+    text :description
+    text :notes
+    time :performed_at
+  end
+end
+```
+And then create, index and search for your documents like so:
+```ruby
+todays_wod = Wod.create :description => 'Lawnmower 8x35lbs. Sqt Jumps 10x. Lunge Twist 20x10lbs ...', :performed_at = Time.now 
+todays_wod.index #add the index for your document
+Wod.search(:description, "jumps") # Search WODs for descriptions that contain jump, returns an array of matching WODs
+```
+

data/lib/ripplr.rb

@@ -1,7 +1,8 @@
+require 'yaml'
 require 'ripplr/queryable'
 require 'ripplr/query_field'
 require 'ripplr/indexers'
+require 'ripplr/criteria'
 require 'ripplr/formatters'
-require 'yaml'
 require 'ripplr/translation'
 require 'ripplr/errors'

data/lib/ripplr/criteria.rb

@@ -0,0 +1,59 @@
+module Ripplr
+  class Criteria
+
+    def initialize(klass, indexer=Ripplr::Indexers::Ripple)
+      @indexer = indexer
+      @target = klass
+    end
+
+    def where(condition)
+      self.condition = condition
+      self
+    end
+
+    def each(&block)
+      results.each do |result|
+        yield result
+      end
+    end
+
+    def size
+      results.size
+    end
+    alias :length :size
+    alias :count :size
+
+    def to_a
+      results
+    end
+
+    def execute
+      return @target.list if condition.nil?
+
+      @indexer.search @target, query
+    end
+
+    def conditions
+      condition
+    end
+
+    private
+    def results
+      @results ||= execute
+      @results
+    end
+
+    def condition
+      @condition
+    end
+
+    def condition=(value)
+      @condition = { @target.queryable_field(value.keys.first) => value.values.first }
+    end
+
+    def query
+      "#{condition.keys.first}: \"#{condition.values.first}\""
+    end
+
+  end
+end

data/lib/ripplr/indexers/ripple.rb

@@ -5,7 +5,7 @@ module Ripplr
         ::Ripple.client.index queryable_obj.bucket_name, queryable_obj.indexes_as
       end
 
-      def self.search(klass, query)
+      def self.search(klass, query, options={})
         results = ::Ripple.client.search(klass.bucket.name, query)["response"]["docs"]
         results.map{|result| klass.find(result["id"])}.reject{|obj| obj.nil?}
       end

data/lib/ripplr/queryable.rb

@@ -29,8 +29,12 @@ module Ripplr
     end
 
     module QueryableClassMethods
-      def search(property, query, indices=Ripplr::Indexers::Ripple)
-        indices.search self, "#{queryable_field(property)}: \"#{query}\""
+      def where(condition)
+        Ripplr::Criteria.new(self).where condition
+      end
+
+      def count
+        self.bucket.list.size
       end
 
       def query_fields
@@ -54,7 +58,6 @@ module Ripplr
         end
       end
 
-      protected
       def queryable_field(property_name)
         matches = query_fields.select{|f| f.for? property_name}
         raise Ripplr::FieldNotQueryableError.new(property_name) if matches.empty?

data/lib/ripplr/version.rb

@@ -1,3 +1,3 @@
 module Ripplr
-  VERSION = "0.0.6.beta"
+  VERSION = "0.0.7.beta"
 end

data/spec/ripplr/criteria_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Ripplr::Criteria do
+
+  describe "searching without a query" do
+    Given { Person.stub(:list).and_return [1,2,3,4,5] }
+    When(:results) { Ripplr::Criteria.new(Person).execute }
+    Then { results.should == [1,2,3,4,5] }
+  end
+
+  describe "searching with a query against a field" do
+    Given (:indexer) { mock }
+    Given { indexer.should_receive(:search).with(Person,"first_name_text: \"skrillex\"").and_return ["Awesome"] }
+    When (:results) { Ripplr::Criteria.new(Person, indexer).where(:first_name => "skrillex").execute }
+    Then { results.should == ["Awesome"] }
+  end
+
+  describe "searching with a query against a different field" do
+    Given (:indexer) { mock }
+    Given { indexer.should_receive(:search).with(Person,"last_name_text: \"Auerbach\"").and_return ["Dan"] }
+    When (:results) { Ripplr::Criteria.new(Person, indexer).where(:last_name => "Auerbach").execute }
+    Then { results.should == ["Dan"] }
+  end
+
+  describe "building a query with unqueryable fields" do
+    Then { expect { Ripplr::Criteria.new(Person).where(:bangarang => 'yes sir') }.to raise_error RuntimeError }
+  end
+
+  describe "treating a criteria object like a collection executes the query" do
+    Given (:criteria) {  Ripplr::Criteria.new(Person, indexer).where(:first_name => "Dan") }
+    Given (:indexer) { mock }
+    Given { indexer.should_receive(:search).with(Person,"first_name_text: \"Dan\"").once.and_return(["Dan"]) }
+
+    context "by calling #each" do
+      Given (:iterated) { Array.new }
+      When { criteria.each {|p| iterated << p } }
+      Then { iterated.should == ["Dan"] }
+    end
+
+    context "by calling #each twice only calls execute once" do
+      Given (:iterated) { Array.new }
+      Given { criteria.each {|p| p } }
+      When { criteria.each {|p| iterated << p } }
+      Then { iterated.should == ["Dan"] }
+    end
+
+    context "by calling #size" do
+      Then { criteria.size.should == 1 }
+    end
+
+    context "by calling #length" do
+      Then { criteria.length.should == 1 }
+    end
+
+    context "by calling #count" do
+      Then { criteria.count.should == 1 }
+    end
+
+    context "by calling to_a" do
+      Then { criteria.to_a.should == ["Dan"] }
+    end
+  end
+
+end

data/spec/ripplr/queryable_spec.rb

@@ -15,21 +15,15 @@ describe Ripplr::Queryable do
     Then { Person.new.bucket_name.should == "people" }
   end
 
-  describe "#search" do
-    context "when using a field that has been defiend as queryable" do
-      Given (:indexer) { mock }
-      Given { indexer.should_receive(:search).with(Person,"first_name_text: \"Dan\"").and_return ["Dan Auerbach"] }
-      When (:result) { Person.search :first_name, "Dan", indexer }
-      Then { result.should == [ "Dan Auerbach" ] }
-    end
-
-    context "when using a field that has not been defined as queryable" do
-      Then { expect { Person.search :full_name, "val" }.to raise_error RuntimeError }
-    end
+  describe "self#count" do
+    Given { Person.bucket.stub(:list).and_return [1,2,3,4,5] }
+    Then { Person.count.should == 5 }
+  end
 
-    context "when the object does not have any queryable fields" do
-      Then { expect { Unqueryable.search :something, "what what" }.to raise_error RuntimeError }
-    end
+  describe "#where" do
+    When (:criteria) { Person.where(:first_name => "Patrick") }
+    Then { criteria.should be_a(Ripplr::Criteria) }
+    Then { criteria.conditions.should == {:first_name_text => "Patrick"} }
   end
 
   describe "#index" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripplr
 version: !ruby/object:Gem::Version
-  version: 0.0.6.beta
+  version: 0.0.7.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -70,6 +70,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- lib/ripplr/criteria.rb
 - lib/ripplr/errors/field_not_queryable_error.rb
 - lib/ripplr/errors.rb
 - lib/ripplr/formatters/riak.rb
@@ -86,6 +87,7 @@ files:
 - Rakefile
 - README.md
 - ripplr.gemspec
+- spec/ripplr/criteria_spec.rb
 - spec/ripplr/indexers/ripple_spec.rb
 - spec/ripplr/query_field_spec.rb
 - spec/ripplr/queryable_spec.rb
@@ -122,6 +124,7 @@ specification_version: 3
 summary: Ripplr is a library to ease the use of Riak Search from within Rails when
   using Ripple and Riak Client.
 test_files:
+- spec/ripplr/criteria_spec.rb
 - spec/ripplr/indexers/ripple_spec.rb
 - spec/ripplr/query_field_spec.rb
 - spec/ripplr/queryable_spec.rb