Commit 8c38a003235d67bb7d50055b28b338517339fa67

Added get_all to load all objects of type self
README.txt
(29 / 9)
  
137137 >> fast_car.save
138138 => {:revision=>"3335068490", :id=>"B1D0576DA2E7846550DCD61DCC8CDAE4"}
139139
140 We could also use the alias get instead of get_by_id
141 >> loading_the_fast_car = RacingCar.get_by_id(db_address, "B1D0576DA2E7846550DCD61DCC8CDAE4")
140 >> loading_the_fast_car = RacingCar.get(db_address, "B1D0576DA2E7846550DCD61DCC8CDAE4")
142141 => #<RacingCar:0x129fddc @races_won=1, @revision="3335068490", @location="http://localhost:5984/mydb", @id="B1D0576DA2E7846550DCD61DCC8CDAE4">
143142
144143 >> loading_the_fast_car.revision == fast_car.revision && loading_the_fast_car.id == fast_car.id
……
160160 >> my_balloon.save
161161 => {:revision=>"1118628227", :id=>"ASD21"}
162162
163 >> other_balloon = Balloon.get_by_id("123")
163 >> other_balloon = Balloon.get("123")
164164 => #<Balloon:0x12a6024 @id="123", @location="http://localhost:5984/mydb", @revision="1234">
165165
166166
……
222222 >> the_pizza.save("http://localhost:5984/mydb")
223223 => {:revision=>"3412312521", :id=>"88781A212BB4676B48B352B209A4D979"}
224224
225 >> hans_pizza = Pizza.get_by_id("88781A212BB4676B48B352B209A4D979","http://localhost:5984/mydb")
225 >> hans_pizza = Pizza.get("88781A212BB4676B48B352B209A4D979","http://localhost:5984/mydb")
226226 => #<Pizza:0x12989c4 @id="88781A212BB4676B48B352B209A4D979", @slices_left=1, @location="http://localhost:5984/mydb", @owner_name="Hans", @revision="3412312521", @my_pizza=false>
227227
228228 >> hans_pizza.my_pizza?
……
237237 => {:revision=>"2414021920", :id=>"88781A212BB4676B48B352B209A4D979"}
238238
239239
240It is possible to load all objects of a certain type with the +all+ parameter
241
242 require 'rubygems'
243 require 'couch_object'
244
245 class Balloon
246 include CouchObject::Persistable
247 database 'http://localhost:5984/mydb'
248 end
249
250 >> Balloon.new.save
251 >> Balloon.new.save
252 >> Balloon.new.save
253 >> Balloon.new.save
254 >> Balloon.new.save
255 >> Balloon.new.save
256 >> balloons = Balloon.all
257 >> balloons.size
258 => 6
259
260
240261You can also have timestamps added automatically to your class using the +add_timestamp_for+ method which takes the values +:on_create+ and +:on_update+.
241262
242263 require 'rubygems'
……
330330 >> my_home.save
331331 => {:revision=>"519758193", :id=>"3E8E2F7A0AE7DACC7D537ECE5220C6FF"}
332332
333 >> your_home = House.get_by_id("3E8E2F7A0AE7DACC7D537ECE5220C6FF")
333 >> your_home = House.get("3E8E2F7A0AE7DACC7D537ECE5220C6FF")
334334 >> your_home.owner.name
335335 => "Sebastian"
336336
……
404404 => {:revision=>"1793606849", :id=>"C65B9837CD572FC66931F12392A3181E"}
405405
406406
407 >> home_from_db = House.get_by_id("C65B9837CD572FC66931F12392A3181E")
407 >> home_from_db = House.get("C65B9837CD572FC66931F12392A3181E")
408408 => #<House:0x1229790 @revision="1793606849", @id="C65B9837CD572FC66931F12392A3181E", @location="http://localhost:5984/mydb">
409409
410410 All relations are lazily loaded the first time they are needed.
……
504504
505505 Example:
506506
507 >> home_from_db = House.get_by_id("C65B9837CD572FC66931F12392A3181E")
507 >> home_from_db = House.get("C65B9837CD572FC66931F12392A3181E")
508508 => #<House:0x1229790 @revision="1793606849", @id="C65B9837CD572FC66931F12392A3181E", @location="http://localhost:5984/mydb">
509509
510510 Make sure the relations are NOT loaded
……
538538 >> my_home.save
539539 => {:id=>"4CDC2355A21DDC4D8887882540A84A14", :revision=>"3659215175"}
540540
541 >> loaded_home = House.get_by_id("4CDC2355A21DDC4D8887882540A84A14")
541 >> loaded_home = House.get("4CDC2355A21DDC4D8887882540A84A14")
542542
543543 We want to add a book to the "has" relation without loading the already saved book and bed
544544 >> loaded_home.do_not_load_has_many_relations
……
684684 instance_WITHOUT_smart_save_activated_2 = NotSoSmartClass.get("dong")
685685
686686The same as in the example above can be achieved with the convenience
687method +get_with_smart_save+ which takes the same parameters as +get_by_id+.
687method +get_with_smart_save+ which takes the same parameters as +get+.
688688The same example could therefor also be written as:
689689
690690 class NotSoSmartClass
lib/couch_object/error_classes.rb
(1 / 1)
  
101101
102102 #
103103 # Is raised when one the CouchDB returns an error which isn't covered
104 # by one of the functions above
104 # by one of the error classes above
105105 #
106106 class CouchDBError < StandardError
107107 end
lib/couch_object/persistable.rb
(62 / 1)
  
208208
209209 end
210210
211 #
212 # Loads all objects of its own type from the database
213 # It uses the get_from_view method
214 #
215 # Takes:
216 # * db_uri (string) as the URI to the database.
217 # Defaults to the db_uri set in the class if defined
218 #
219 # Returns:
220 # * An array of all objects of the type of the object
221 # the +get_all+ method is called on
222 #
223 # Raises:
224 # * CouchObject::Errors::StandardError if the view for loading
225 # the objects doesn't exist and can't be created.
226 #
227 def get_all(db_uri = self.location)
228
229 raise CouchObject::Errors::NoDatabaseLocationSet if db_uri.nil?
230
231 view_name = "couch_object_load_objects"
232
233 results = []
234
235 begin
236
237 results = get_from_view("_view/#{view_name}/of_type_self", \
238 {:key => self.to_s,
239 :db_uri => db_uri} )
240
241 rescue CouchObject::Errors::MissingView, CouchObject::Errors::CouchDBError
242
243 # The view doesn't exist. It means this is the first
244 # time this script is used for a given database, or the user
245 # has deleted the view
246 view_code_query = JSON.unparse(
247 {
248 "_id" => "_design/#{view_name}",
249 "language" => "text/javascript",
250 "views" =>
251 {
252 "of_type_self" => "function(doc){map(doc.class, doc);}"
253 }
254 }
255 )
256
257 db = CouchObject::Database.open(db_uri)
258
259 if (response = db.put("_design%2F#{view_name}", \
260 view_code_query))
261 results = get_all(db_uri)
262 else
263 raise CouchObject::Errors::DatabaseSaveFailed, "Couldn't create the view..."
264 end
265 end
266
267 return results
268
269 end
270 alias all get_all
271
211272 protected
212273 #
213274 # This recursive method initializes new instances of self and
……
964964 view_code_query))
965965 results = couch_load_has_many_relations(which_relation)
966966 else
967 raise CouchObject::Errors::StandardError, "Couldn't create the view..."
967 raise CouchObject::Errors::DatabaseSaveFailed, "Couldn't create the view..."
968968 end
969969 end
970970
spec/persistable/loading.rb
(4 / 1)
  
290290
291291 end
292292
293
294293 it "should be able to return instances from a view with different objects" do
295294 response = HTTPResponse.new(@view_content_mixed)
296295 @db.should_receive(:get).with("foo").and_return(response)
……
332332 {:db_uri => "foo"})}.
333333 should raise_error(CouchObject::Errors::MissingView)
334334
335 end
336
337 it "should be able to load all objects of a given type" do
338
335339 end
336340
337341end
spec/persistable/loading_spec.rb
(48 / 2)
  
11require File.dirname(__FILE__) + '/persistable_helper.rb'
22
3describe CouchObject::Persistable, "for loading objects:" do
3describe CouchObject::Persistable, "for loading objects:" do |variable|
4
5end
46 before(:each) do
57 @bike = Bike.new
68 @with_location = WithStorageLocation.new
……
104104
105105 end
106106
107 it "should have the alias 'get' for get_by_id" do
108 Bike.respond_to?(:get).should == true
109 end
107110end
108111
109112describe CouchObject::Persistable, "for loading object with subobject:" do
……
295295
296296 end
297297
298
299298 it "should be able to return instances from a view with different objects" do
300299 response = HTTPResponse.new(@view_content_mixed)
301300 @db.should_receive(:get).with("foo").and_return(response)
……
338338 should raise_error(CouchObject::Errors::MissingView)
339339
340340 end
341end
341342
343describe CouchObject::Persistable, "#get_all" do
344 before(:each) do
345 @db = mock("mock db")
346 CouchObject::Database.stub!(:open).and_return(@db)
347 end
348
349 it "should have a method to load all objects of its own type" do
350 Bike.respond_to?(:get_all).should == true
351 end
352 it "should raise an error for objects that don't have a database location" do
353 lambda { Bike.get_all }.should raise_error(CouchObject::Errors::NoDatabaseLocationSet)
354 end
355 it "should get objects from the get_from_view method" do
356 Bike.should_receive(:get_from_view).and_return([])
357 Bike.get_all("foo_db").should == []
358 end
359 it "should return an error if it can't create a new view" do
360 Bike.should_receive(:get_from_view).once.with("_view/couch_object_load_objects/of_type_self", {:key => "Bike", :db_uri => "foo_location"}).and_raise(CouchObject::Errors::MissingView)
361 # DB is stubbed
362 @db.should_receive(:put).and_return(false)
363 lambda{Bike.get_all("foo_location")}.should raise_error(CouchObject::Errors::DatabaseSaveFailed)
364 end
365 # it "should create a new view if it doesn't exist" do
366 # Bike.should_receive(:get_from_view).once.with("_view/couch_object_load_objects/of_type_self", {:key => "Bike", :db_uri => "foo_location"}).and_raise(CouchObject::Errors::MissingView)
367 #
368 # # DB is stubbed
369 # @db.should_receive(:put).and_return(true)
370 # # TODO
371 # # then it calls itself again, which I can't stub out... and since it
372 # # doesn't actually create a view in the spec it fails again...
373 # # and there we have an infinite loop... somebody fix please?
374 # Bike.get_all("foo_location").should == []
375 # end
376 it "should return an empty array if no objects can be found" do
377 Bike.should_receive(:get_from_view).once.with("_view/couch_object_load_objects/of_type_self", {:key => "Bike", :db_uri => "foo_location"}).and_return([])
378 Bike.get_all("foo_location").should == []
379 end
380 it "should have an alias 'all' for get_all" do
381 Bike.respond_to?(:all).should == true
382 end
383
342384end