leanback 0.2.1 → 0.2.2

data/Changelog.rdoc

@@ -0,0 +1,8 @@
+=Leanback 0.2.2
+July 13, 2011:-
+* No need to call add_finder() method directly anymore. find_by() now adds a finder index to the database if one doesn't already exist.
+Example:
+The method:
+ Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
+will add the finder to the database if one doesn't already exist. No need to call  
+ Couchdb.add_finder(:database => 'contacts', :key => 'email')

data/README.rdoc

@@ -77,21 +77,31 @@ Retrieve all documents in a database
   puts d["phone"]
  end  
 
-===To Find documents by key
-First add a finder/index to the database. Let's say we want to add an index to quickly search the database by an email value.
- Couchdb.add_finder(:database => 'contacts', :key => 'email')
-
-We have just added a find_by_email index to the database.
 
-Now to find documents by email key (example: to find all contacts with email = 'nancy@mail.com')
+===To Find documents by key
+To find documents by email key (example: to find all contacts with email = 'nancy@mail.com')
  Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
  # => [{"_id"=>"Nancy", "_rev"=>"1-d15a83d2a23b495c19df2595b636ecc8", "firstname"=>"Nancy", "lastname"=>"Lee",
                    "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female"}]
 
+To find all contacts with lastname = 'Smith'
+ Couchdb.find_by( :database => 'contacts', :lastname => 'Smith')  
+ # => [{"_id"=>"john", "_rev"=>"5-642689e0a50843d6fa508159a01b4fd4", "firstname"=>"John", "lastname"=>"Smith",
+                   "email"=>"john@mail.com", "gender"=>"male"}]
+
+To find all female contacts 
+ Couchdb.find_by( :database => 'contacts', :gender => 'female') 
+ # => [{"_id"=>"Nancy", "_rev"=>"1-d15a83d2a23b495c19df2595b636ecc8", "firstname"=>"Nancy", "lastname"=>"Lee",
+                  "phone"=>"347-808-3734", "email"=>"nancy@mail.com", "gender"=>"female"}]
+
+
 ====How it works
 The method
- Couchdb.add_finder(:database => 'contacts', :key => 'email') 
-creates a new design document in the contacts database called _design/email_finder with a view called find_by_email
+ Couchdb.find_by(:database => 'contacts', :email => 'nancy@mail.com')  
+will query the 'contacts' database for a design_document called _design/email_finder and a view called find_by_email with key = "nancy@mail.com".
+It sends a  
+ GET http://127.0.0.1:5984/contacts/_design/email_finder/_view/find_by_email?key="nancy@mail.com"
+This returns all contacts with email = 'nancy@mail.com'. Leanback will parse the native JSON results to return only the data values. If the design_document and view doesn't exist Leanback will create it in the database. See the source below;
  {
    "_id": "_design/email_finder",
    "_rev": "7-da7f3c0bf183f4a36a82013bd0ea6537",
@@ -106,15 +116,15 @@ creates a new design document in the contacts database called _design/email_find
    }
  }
 
-The method
- Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
-will query the find_by_email view created above, with a
- GET http://127.0.0.1:5984/contacts/_design/email_finder/_view/find_by_email?key="nancy@mail.com"
-This returns all contacts with email = 'nancy@mail.com'.
-Leanback parses the native JSON results to return only the data values.
+If you ran 
+ Couchdb.find_by( :database => 'contacts', :lastname => 'Smith')  
+ Couchdb.find_by( :database => 'contacts', :gender => 'female') 
+you will notice the following design_documents have been added to the database 
+ _design/lastname_finder
+ _design/gender_finder
 
 ====Usage
-You also can do 
+You can do 
   docs = Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
      docs.each do |d| 
  	puts d["_rev"]
@@ -132,8 +142,6 @@ You also can do
       nancy@mail.com
       347-808-3734
 
-
-
 ===Query a permanent view
  view = { :database => "contacts", :design_doc => 'my_views', :view => 'get_female_contacts'}
  Couchdb.find view 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/leanback.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leanback}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Obi Akubue"]
-  s.date = %q{2011-07-11}
+  s.date = %q{2011-07-13}
   s.description = %q{lightweight Ruby interface to CouchDB}
   s.email = %q{obioraakubue@yahoo.com}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "Changelog.rdoc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/lib/leanback.rb

@@ -194,7 +194,17 @@ def self.find_by(options)
  view_name = 'find_by_' + index
   
  view = { :database => db_name, :design_doc => design_doc_name, :view => view_name}
- find view,search_term
+ docs = find view,search_term
+
+ #add a finder/index if one doesn't already exist in the database
+ #then find_by_key
+ if(docs.is_a?(Hash))#when finder doesn't exist docs returns {"error"=>"not_found", "reason"=>"missing"} 
+  if (docs.keys[0].to_s == "error") &&  (docs.values[0].to_s == "not_found") && (docs.keys[1].to_s == "reason") 
+      add_finder(:database => db_name, :key => index)
+      docs = find view,search_term
+  end
+ end #end of first if
+ return docs
 end
 
  #return a list of all docs in the database

data/test/test_leanback.rb

@@ -24,8 +24,10 @@ class TestLeanback < Test::Unit::TestCase
   end
 
  should "find items by key" do
-     docs = Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')  
-     #puts docs.inspect
+     docs = Couchdb.find_by( :database => 'contacts', :email => 'nancy@mail.com')
+     #docs = Couchdb.find_by( :database => 'contacts', :lastname => 'Smith') 
+     #docs = Couchdb.find_by( :database => 'contacts', :gender => 'female') 
+     puts docs.inspect
  end
 
   should "view document doc" do
@@ -39,7 +41,7 @@ class TestLeanback < Test::Unit::TestCase
     view = { :database => "contacts", :design_doc => 'more_views', :view => 'get_email'}
     puts 'viewing design doc...'
     hash = Couchdb.find view 
-    puts hash.inspect
+    #puts hash.inspect
   end
 
   should "Create a design doc/permanent view" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Obi Akubue
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-11 00:00:00 -04:00
+date: 2011-07-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,6 +110,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- Changelog.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -135,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 235560335
+      hash: -928313619
       segments: 
       - 0
       version: "0"