nano-store 0.3.13 → 0.3.14

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.3-p194
+rvm ruby-1.9.3

data/Rakefile

@@ -10,7 +10,7 @@ Motion::Project::App.setup do |app|
   app.redgreen_style = :full
   app.files += Dir.glob(File.join(app.project_dir, 'lib/nano_store/*.rb'))
   app.pods do
-    pod 'NanoStore', '~> 2.1.4'
+    pod 'NanoStore', '~> 2.1.5'
   end
 end
 

data/lib/nano_store.rb

@@ -15,5 +15,5 @@ Motion::Project::App.setup do |app|
   app.files.unshift(File.join(File.dirname(__FILE__), 'nano_store/finder.rb'))
 
   app.pods ||= Motion::Project::CocoaPods.new(app)
-  app.pods.pod 'NanoStore', '~> 2.1.4'  
+  app.pods.pod 'NanoStore', '~> 2.1.5'
 end

data/lib/nano_store/finder.rb

@@ -6,7 +6,7 @@ module NanoStore
       else
         sort_options = {}
       end
-      
+
       if sort_options.empty?
         self.store.objectsOfClassNamed(self.bare_class_name)
       else
@@ -51,7 +51,7 @@ module NanoStore
 
       expressions = expressions_with_options(options)
       search.expressions = expressions
-      
+
       sort_descriptors = sort_descriptor_with_options(sort_options)
       search.sort = sort_descriptors
       search.filterClass = self.bare_class_name
@@ -62,7 +62,7 @@ module NanoStore
 
       searchResults
     end
-    
+
     # find model keys by criteria
     #
     # Return array of keys
@@ -95,7 +95,7 @@ module NanoStore
       else
         raise "unexpected parameters #{arg}"
       end
-      
+
       search = NSFNanoSearch.searchWithStore(self.store)
 
       expressions = expressions_with_options(options)
@@ -111,15 +111,32 @@ module NanoStore
 
       searchResults
     end
-    
+
+    # find a model by key
+    #
+    # Return an object or nil (if not found)
+    #
+    # Examples:
+    # User.find_by_key(my_key)
+    def find_by_key(key)
+      search = NSFNanoSearch.searchWithStore(self.store)
+      search.key = key
+
+      error_ptr = Pointer.new(:id)
+      searchResult = search.searchObjectsWithReturnType(NSFReturnObjects, error:error_ptr).first
+      raise NanoStoreError, error_ptr[0].description if error_ptr[0]
+
+      searchResult.last if searchResult
+    end
+
     def bare_class_name
       self.to_s.split("::").last
     end
-    
+
     private
     def expressions_with_options(options)
       expressions = []
-      
+
       options.each do |key, val|
         attribute = NSFNanoPredicate.predicateWithColumn(NSFAttributeColumn, matching:NSFEqualTo, value:key.to_s)
         expression = NSFNanoExpression.expressionWithPredicate(attribute)
@@ -144,12 +161,12 @@ module NanoStore
       end
       return expressions
     end
-    
+
     SORT_MAPPING = {
       'asc' => true,
       'desc' => false,
     }
-    
+
     def sort_descriptor_with_options(options)
       sorter = options.collect do |opt_key, opt_val|
         if SORT_MAPPING.keys.include?(opt_val.to_s.downcase)

data/lib/nano_store/version.rb

@@ -1,3 +1,3 @@
 module NanoStore
-  VERSION = "0.3.13"
+  VERSION = "0.3.14"
 end

data/nano-store.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = NanoStore::VERSION
 
-  gem.add_dependency 'bubble-wrap', '~> 1.1.0'
-  gem.add_dependency 'motion-cocoapods', '~> 1.1.0'
+  gem.add_dependency 'bubble-wrap', '~> 1.1.4'
+  gem.add_dependency 'motion-cocoapods', '>= 1.2.0'
   gem.add_development_dependency 'motion-redgreen'
 end

data/spec/finder_spec.rb

@@ -17,26 +17,26 @@ describe "Finder" do
   after do
     NanoStore.shared_store = nil
   end
-  
+
   before do
     NanoStore.shared_store = NanoStore.store
 
     user = stub_user("Bob", 10, Time.now)
     user.save
-      
+
     user2 = stub_user("Amy", 11, Time.now)
     user2.save
-    
+
     user3 = stub_user("Carl", 4, Time.now)
     user3.save
   end
-  
+
   it "create object in their class" do
     NanoStore.shared_store.allObjectClasses.should == ["User"]
     Car.create(:name => "Bob")
     NanoStore.shared_store.allObjectClasses.sort.should == ["User", "Car"].sort
   end
-  
+
   it "search object traditional way: supply key, operator and value" do
     users = User.find(:name, NSFEqualTo, "Bob")
     users.should.not.be.nil
@@ -69,7 +69,7 @@ describe "Finder" do
     users.collect(&:name).include?("Amy").should == true
     users.collect(&:name).include?("Bob").should == false
   end
-  
+
 
   it "search object with multiple parameters" do
     stub_user("Ronald", 18, Time.now).save
@@ -84,13 +84,13 @@ describe "Finder" do
     user = users.first
     user.name.should.be == "Ronald"
     user.age.should.be == 59
-    
+
     users = User.find(:name => { NSFEqualTo => "Ronald" }, :age => { NSFLessThan => 30 })
-    users.size.should == 2    
+    users.size.should == 2
     user = users.first
     user.name.should.be == "Ronald"
   end
-  
+
   it "sort search results" do
     stub_user("Alan", 39, Time.now).save
     stub_user("Cat", 29, Time.now).save
@@ -126,13 +126,30 @@ describe "Finder" do
     user.name.should == "Bob"
     user.class.should == User
   end
-  
+
+  it "find object by key" do
+    name = "Julien"
+    age = 32
+    created_at = Time.now
+    user = stub_user("Julien", 32, Time.now)
+    user.save
+    user2 = User.find_by_key(user.key)
+    user2.should.not.be.nil
+    user2.key.should == user.key
+    user2.name.should == user.name
+    user2.age.should == user.age
+  end
+
+  it "should not find object by key" do
+    User.find_by_key("invalid-key").should.be.nil
+  end
+
   it "find all objects" do
     User.count.should == 3
     users = User.all
     users.size.should == 3
   end
-  
+
   it "find all objects, sorted" do
     stub_user("Alan", 39, Time.now).save
     stub_user("Cat", 29, Time.now).save
@@ -153,7 +170,7 @@ describe "Finder" do
     Car.all.size.should == 1
     Car.all.first.key.should == car.key
   end
-  
+
   it "#find only return objects of the class" do
     car = Car.create(:name => "Honda")
     Car.find.size.should == 1

data/vendor/Podfile.lock

@@ -1,5 +1,11 @@
+
 PODS:
-  - NanoStore (2.1.4)
+- NanoStore (2.1.5)
 
 DEPENDENCIES:
-  - NanoStore (~> 2.1.4)
+- NanoStore (~> 2.1.5)
+
+SPEC CHECKSUMS:
+  NanoStore: 440272829dfe13db7f1c68de74fc3562475463fe
+
+COCOAPODS: 0.15.1

data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoBag.h

@@ -0,0 +1,312 @@
+/*
+     NSFNanoBag.h
+     NanoStore
+     
+     Copyright (c) 2010 Webbo, L.L.C. All rights reserved.
+     
+     Redistribution and use in source and binary forms, with or without modification, are permitted
+     provided that the following conditions are met:
+     
+     * Redistributions of source code must retain the above copyright notice, this list of conditions
+     and the following disclaimer.
+     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+     and the following disclaimer in the documentation and/or other materials provided with the distribution.
+     * Neither the name of Webbo nor the names of its contributors may be used to endorse or promote
+     products derived from this software without specific prior written permission.
+     
+     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+     PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
+     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+     PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+     SUCH DAMAGE.
+ */
+
+/*! @file NSFNanoBag.h
+ @brief A bag is a loose collection of objects stored in a document store.
+ */
+
+/** @class NSFNanoBag
+ * A bag is a loose collection of objects stored in a document store.
+ *
+ * @note
+ * The objects must conform to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink. For your convenience, NanoStore provides you with NSFNanoObject, which is the standard
+ * way of storing and retrieving objects from/to a bag.
+ *
+ * @par
+ * It's more efficient to make your storage objects \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant, thus eliminating the need to convert your objects to/from
+ * objects of type NSFNanoObject.
+ *
+ * @details <b>Example:</b>
+ @code
+ // Instantiate a NanoStore and open it
+ NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
+ [nanoStore removeAllObjectsFromStoreAndReturnError:nil];
+ 
+ // Add some data to a bag
+ NSFNanoBag *bag = [NSFNanoBag bag];
+ NSDictionary *info = ...;
+ NSFNanoObject *obj1 = [NSFNanoObject nanoObjectWithDictionary:info];
+ NSFNanoObject *obj2 = [NSFNanoObject nanoObjectWithDictionary:info];
+ NSFNanoObject *obj3 = [NSFNanoObject nanoObjectWithDictionary:info];
+ [bag addObjectsFromArray:[NSArray arrayWithObjects:obj1, obj2, obj3, nil] error:nil];
+ 
+ // Add the bag and its objects to the document store
+ [nanoStore addObject:bag error:nil];
+ 
+ // Obtain the bags from the document store
+ NSArray *bags = [nanoStore bags];
+ 
+ // Close the document store
+ [nanoStore closeWithError:nil];
+ @endcode
+*/
+
+#import "NSFNanoObjectProtocol.h"
+
+@interface NSFNanoBag : NSObject <NSFNanoObjectProtocol, NSCopying>
+
+/** * The store where the bag is located.  */
+@property (nonatomic, weak, readonly) NSFNanoStore *store;
+/** * The name of the bag.  */
+@property (nonatomic, copy, readwrite) NSString *name;
+/** * The UUID of the bag.  */
+@property (nonatomic, copy, readonly) NSString *key;
+/** * Dictionary of NSString (key) and id<NSFNanoObjectProtocol> (value). */
+@property (nonatomic, readonly) NSDictionary *savedObjects;
+/** * Dictionary of NSString (key) and id<NSFNanoObjectProtocol> (value). */
+@property (nonatomic, readonly) NSDictionary *unsavedObjects;
+/** * Dictionary of NSString (key) and id<NSFNanoObjectProtocol> (value). */
+@property (nonatomic, readonly) NSDictionary *removedObjects;
+/** * To determine whether the bag has uncommited changes.  */
+@property (nonatomic, assign, readonly) BOOL hasUnsavedChanges;
+
+/** @name Creating and Initializing Bags
+ */
+
+//@{
+
+/** * Creates and returns an empty bag.
+ * @return An empty bag upon success, nil otherwise.
+ */
+
++ (NSFNanoBag *)bag;
+
+/** * Creates and returns a bag adding to it the objects contained in the given array.
+ * @param theObjects an array of objects conforming to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink.
+ * @return A bag only containing the objects with conform to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink upon success, nil otherwise.
+ * @throws NSFUnexpectedParameterException is thrown if theObjects is nil.
+ * @warning If theObjects is nil, an NSFUnexpectedParameterException will be thrown. Use + bag; instead.
+ * @see \link initBagWithNanoObjects: - (NSFNanoBag*)initBagWithNanoObjects:(NSArray *)theObjects \endlink
+ */
+
++ (NSFNanoBag *)bagWithObjects:(NSArray *)theObjects;
+
+/** * Creates and returns an empty bag with the specified name
+ * @param theName the name of the bag. Can be nil.
+ * @return An empty bag upon success, nil otherwise.
+ */
+
++ bagWithName:(NSString *)theName;
+
+/** * Creates and returns a bag with the specified name adding to it the objects contained in the given array.
+ * @param theName the name of the bag. Can be nil.
+ * @param theObjects is a required array of objects conforming to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink.
+ * @return A bag only containing the objects with conform to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink upon success, nil otherwise.
+ * @throws NSFUnexpectedParameterException is thrown if theObjects is nil.
+ * @warning If theObjects is nil, an NSFUnexpectedParameterException will be thrown.
+ * @see \link initBagWithNanoObjects: - (NSFNanoBag*)initBagWithNanoObjects:(NSArray *)theObjects \endlink
+ */
+
++ bagWithName:(NSString *)theName andObjects:(NSArray *)theObjects;
+
+/** * Initializes a newly allocated bag with the specified name adding to it the objects contained in the given array.
+ * @param theName the name of the bag. Can be nil.
+ * @param theObjects is a required array of objects conforming to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink.
+ * @return A bag only containing the objects with conform to the \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink upon success, nil otherwise.
+ * @throws NSFUnexpectedParameterException is thrown if theObjects is nil.
+ * @warning If theObjects is nil, an NSFUnexpectedParameterException will be thrown.
+ * @see \link bagWithObjects: + (NSFNanoBag*)bagWithObjects:(NSArray *)theObjects \endlink
+ */
+
+- (id)initBagWithName:(NSString *)theName andObjects:(NSArray *)someObjects;
+
+//@}
+
+/** @name Adding and Removing Objects
+ */
+
+//@{
+
+/** * Adds an \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant object to the bag.
+ * @param theObject is added to the bag.
+ * @param outError is used if an error occurs. May be NULL.
+ * @return YES upon success, NO otherwise.
+ * @warning This value cannot be nil and it must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @throws NSFNonConformingNanoObjectProtocolException is thrown if the object is non-\link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink compliant.
+ * @see \link addObjectsFromArray:error: - (BOOL)addObjectsFromArray:(NSArray *)theObjects error:(out NSError **)outError \endlink
+ */
+
+- (BOOL)addObject:(id <NSFNanoObjectProtocol>)theObject error:(out NSError **)outError;
+
+/** * Adds a series of \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant objects to the bag.
+ * @param theObjects is an array of objects to be added to the bag. The objects must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @param outError is used if an error occurs. May be NULL.
+ * @return YES upon success, NO otherwise.
+ * @warning The objects of the array must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @throws NSFNonConformingNanoObjectProtocolException is thrown if the object is non-\link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink compliant.
+ * @see \link addObject:error: - (BOOL)addObject:(id <NSFNanoObjectProtocol>)theObject error:(out NSError **)outError \endlink
+ */
+
+- (BOOL)addObjectsFromArray:(NSArray *)theObjects error:(out NSError **)outError;
+
+/** * Removes the specified object from the bag.
+ * @param theObject the object to be removed from the bag.
+ * @warning The object must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @see \link removeObjectsInArray: - (void)removeObjectsInArray:(NSArray *)theObjects \endlink
+ * @see \link removeObjectWithKey: - (void)removeObjectWithKey:(NSString *)theObjectKey \endlink
+ * @see \link removeObjectsWithKeysInArray: - (void)removeObjectsWithKeysInArray:(NSArray *)theKeys \endlink
+ * @see \link removeAllObjects - (void)removeAllObjects \endlink
+ */
+
+- (void)removeObject:(id <NSFNanoObjectProtocol>)theObject;
+
+/** * Empties the bag of all its elements.
+ * @see \link removeObject: - (void)removeObject:(id <NSFNanoObjectProtocol>)theObject \endlink
+ * @see \link removeObjectsInArray: - (void)removeObjectsInArray:(NSArray *)theObjects \endlink
+ * @see \link removeObjectWithKey: - (void)removeObjectWithKey:(NSString *)theObjectKey \endlink
+ * @see \link removeObjectsWithKeysInArray: - (void)removeObjectsWithKeysInArray:(NSArray *)theKeys \endlink
+ */
+
+- (void)removeAllObjects;
+
+/** * Removes the list of objects from the bag.
+ * @param theObjects the list of objects to be removed from the bag.
+ * @warning The objects of the array must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @see \link removeObject: - (void)removeObject:(id <NSFNanoObjectProtocol>)theObject \endlink
+ * @see \link removeObjectWithKey: - (void)removeObjectWithKey:(NSString *)theObjectKey \endlink
+ * @see \link removeObjectsWithKeysInArray: - (void)removeObjectsWithKeysInArray:(NSArray *)theKeys \endlink
+ * @see \link removeAllObjects - (void)removeAllObjects \endlink
+ */
+
+- (void)removeObjectsInArray:(NSArray *)theObjects;
+
+/** * Removes the object with a given key from the bag.
+ * @param theObjectKey the key of the object to be removed from the bag.
+ * @warning The object referenced by theObjectKey must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @see \link removeObject: - (void)removeObject:(id <NSFNanoObjectProtocol>)theObject \endlink
+ * @see \link removeObjectsInArray: - (void)removeObjectsInArray:(NSArray *)theObjects \endlink
+ * @see \link removeObjectsWithKeysInArray: - (void)removeObjectsWithKeysInArray:(NSArray *)theKeys \endlink
+ * @see \link removeAllObjects - (void)removeAllObjects \endlink
+ */
+
+- (void)removeObjectWithKey:(NSString *)theObjectKey;
+
+/** * Removes from the bag the objects specified by elements in a given array.
+ * @param theKeys an array of objects specifying the keys to remove from the bag
+ * @warning The objects referenced by theKeys must be \link NSFNanoObjectProtocol::initNanoObjectFromDictionaryRepresentation:forKey:store: NSFNanoObjectProtocol\endlink-compliant.
+ * @see \link removeObject: - (void)removeObject:(id <NSFNanoObjectProtocol>)theObject \endlink
+ * @see \link removeObjectsInArray: - (void)removeObjectsInArray:(NSArray *)theObjects \endlink
+ * @see \link removeObjectWithKey: - (void)removeObjectWithKey:(NSString *)theObjectKey \endlink
+ * @see \link removeAllObjects - (void)removeAllObjects \endlink
+ */
+
+- (void)removeObjectsWithKeysInArray:(NSArray *)theKeys;
+
+//@}
+
+/** @name Saving, Reloading and Undoing
+ */
+
+//@{
+
+/** * Saves the bag and its contents. Also, saves all the changes made since the last save.
+ * @param outError is used if an error occurs. May be NULL.
+ * @return YES upon success, NO otherwise.
+ * @note Check property hasUnsavedChanges to find out whether the bag has unsaved contents.
+ * @see \link reloadBagWithError: - (BOOL)reloadBagWithError:(out NSError **)outError \endlink
+ * @see \link undoChangesWithError: - (BOOL)undoChangesWithError:(out NSError **)outError \endlink
+ */
+
+- (BOOL)saveAndReturnError:(out NSError **)outError;
+
+/** * Refreshes the bag to match the contents stored in the document store. The unsaved contents are preserved.
+ * @param outError is used if an error occurs. May be NULL.
+ * @return YES upon success, NO otherwise.
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link saveAndReturnError: - (BOOL)saveAndReturnError:(out NSError **)outError \endlink
+ * @see \link undoChangesWithError: - (BOOL)undoChangesWithError:(out NSError **)outError \endlink
+ */
+
+- (BOOL)reloadBagWithError:(out NSError **)outError;
+
+/** * Discards the changes made in the bag.
+ * @param outError is used if an error occurs. May be NULL.
+ * @return YES upon success, NO otherwise.
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link saveAndReturnError: - (BOOL)saveAndReturnError:(out NSError **)outError \endlink
+ * @see \link reloadBagWithError: - (BOOL)reloadBagWithError:(out NSError **)outError \endlink
+ */
+
+- (BOOL)undoChangesWithError:(out NSError **)outError;
+
+//@}
+
+/** @name Inflating and Deflating
+ */
+
+//@{
+
+/** * Inflates the bag by reconstructing the objects flattened with - (void)deflateBag;
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link deflateBag - (void)deflateBag \endlink
+ */
+
+- (void)inflateBag;
+
+/** * Releases memory by "flattening" the objects from the bag.
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link inflateBag - (void)inflateBag \endlink
+ */
+
+- (void)deflateBag;
+
+//@}
+
+/** @name Miscellaneous
+ */
+
+//@{
+
+/** * Returns the number of objects currently in the bag.
+ * @return The number of objects currently in the bag.
+ */
+
+- (NSUInteger)count;
+
+/** * Compares the receiving bag to another bag.
+ * @param otherNanoBag is a bag.
+ * @return YES if the contents of otherNanoBag are equal to the contents of the receiving bag, otherwise NO.
+ */
+
+- (BOOL)isEqualToNanoBag:(NSFNanoBag *)otherNanoBag;
+
+/** * Returns a dictionary that contains the information stored in the bag.
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link description - (NSString *)description \endlink
+ */
+
+- (NSDictionary *)dictionaryRepresentation;
+
+/** * Returns a string representation of the bag.
+ * @note Check properties savedObjects, unsavedObjects and removedObjects to find out the current state of the bag.
+ * @see \link dictionaryRepresentation - (NSDictionary *)dictionaryRepresentation \endlink
+ */
+
+- (NSString *)description;
+
+//@}
+
+@end