motion_model 0.2.1 → 0.2.2

data/CHANGELOG

@@ -11,3 +11,13 @@ to the column metadata.
   if not specified in new or create.
   
 2012-09-06: Added block-style finders. Added delete method.
+
+2012-09-07: IMPORTANT! PLEASE READ! Two new methods were added
+            to MotionModel to support persistence:
+            
+            Task#serialize_to_file(file_name)
+            Task.deserialize_from_file(file_name)
+            
+            Note that serialize operates on an instance and
+            deserialize is a class method that creates an
+            instance.

data/README.md

@@ -132,44 +132,23 @@ Things That Work
     @tasks = Task.order{|one, two| two.details <=> one.details}.all # Get tasks ordered descending by :details
     ```
 
-* Serialization using `NSCoder` works. Basically, you might do something like this
-  in your `AppDelegate`:
+* Serialization is part of MotionModel. So, in your `AppDelegate` you might do something like this:
 
   ```ruby
-  def load_data
-    if File.exist? documents_file("my_fine.dat")
-      error_ptr = Pointer.new(:object)
-      
-      data = NSData.dataWithContentsOfFile(documents_file('my_fine.dat'), options:NSDataReadingMappedIfSafe, error:error_ptr)
-      
-      if data.nil?
-        error = error_ptr[0]
-        show_user_scary_warning error
-      else
-        @my_data_tree = NSKeyedUnarchiver.unarchiveObjectWithData(data)
-      end
-    else
-      show_user_first_time_welcome
-    end
-  end
+    @tasks = Task.deserialize_from_file('tasks.dat')
   ```
   
   and of course on the "save" side:
   
   ```ruby
-  error_ptr = Pointer.new(:object)
-
-  data = NSKeyedArchiver.archivedDataWithRootObject App.delegate.events
-  unless data.writeToFile(documents_file('my_fine.dat'), options: NSDataWritingAtomic, error: error_ptr)
-    error = error_ptr[0]
-    show_scary_message error
+    @tasks.serialize_to_file('tasks.dat')
   end
   ```
   
-  Note that the archiving of any arbitrarily complex set of relations is
-  automatically handled by `NSCoder` provided you conform to the coding
-  protocol. When you declare your columns, `MotionModel` understands how
-  to serialize your data so you need take no further action.
+  Note that the this serialization of any arbitrarily complex set of relations
+  is automatically handled by `NSCoder` provided you conform to the coding
+  protocol. When you declare your columns, `MotionModel` understands how to
+  serialize your data so you need take no further action.
   
 * Relations, in principle work. This is a part I'm still noodling over
   so it's not really safe to use them. In any case, how I expect it will

data/Rakefile

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+require "bundler/gem_tasks"
 $:.unshift("/Library/RubyMotion/lib")
 require 'motion/project'
 

data/lib/motion_model/model.rb

@@ -38,6 +38,8 @@
 #
     
 module MotionModel
+  class PersistFileError < Exception; end
+  
   module Model
     class Column
       attr_accessor :name
@@ -223,6 +225,37 @@ module MotionModel
       def each(&block)
         raise ArgumentError.new("each requires a block") unless block_given?
         @collection.each{|item| yield item}
+      end      
+      
+      # Returns the unarchived object if successful, otherwise false
+      #
+      # Note that subsequent calls to serialize/deserialize methods
+      # will remember the file name, so they may omit that argument.
+      #
+      # Raises a +MotionModel::PersistFileFailureError+ on failure.
+      def deserialize_from_file(file_name = nil)
+        @file_name ||= file_name
+        new_object = self.new
+        
+        if File.exist? documents_file(@file_name)
+          error_ptr = Pointer.new(:object)
+      
+          data = NSData.dataWithContentsOfFile(documents_file(file_name), options:NSDataReadingMappedIfSafe, error:error_ptr)
+      
+          if data.nil?
+            error = error_ptr[0]
+            raise MotionModel::PersistFileFailureError.new "Error when reading the data: #{error}"
+          else
+            return NSKeyedUnarchiver.unarchiveObjectWithData(data)
+          end
+        else
+          return false
+        end
+      end
+
+      def documents_file(file_name)
+        file_path = File.join NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, true), file_name
+        file_path
       end
       
     end
@@ -311,7 +344,7 @@ module MotionModel
 
     def initWithCoder(coder)
       self.init
-      self.class.instance_variable_get("@_columns").each do |attr|
+      columns.each do |attr|
         # If a model revision has taken place, don't try to decode
         # something that's not there.
         new_tag_id = 1
@@ -330,7 +363,7 @@ module MotionModel
     end
     
     def encodeWithCoder(coder)
-      self.class.instance_variable_get("@_columns").each do |attr|
+      columns.each do |attr|
         coder.encodeObject(self.send(attr), forKey: attr.to_s)
       end
     end
@@ -373,6 +406,28 @@ ERRORINFO
       end
     end
 
+    # Serializes data to a persistent store (file, in this
+    # terminology). Serialization is synchronous, so this
+    # will pause your run loop until complete.
+    #
+    # +file_name+ is the name of the persistent store you
+    # want to use. If you omit this, it will use the last
+    # remembered file name.
+    #
+    # Raises a +MotionModel::PersistFileFailureError+ on failure.
+    def serialize_to_file(file_name = nil)
+      @file_name ||= file_name
+      error_ptr = Pointer.new(:object)
+
+      data = NSKeyedArchiver.archivedDataWithRootObject self
+      unless data.writeToFile(self.class.documents_file(file_name), options: NSDataWritingAtomic, error: error_ptr)
+        # De-reference the pointer.
+        error = error_ptr[0]
+
+        # Now we can use the `error' object.
+        raise MotionModel::PersistFileFailureError.new "Error when writing data: #{error}"
+      end
+    end
   end
 end
 

data/lib/motion_model/version.rb

@@ -1,3 +1,3 @@
 module MotionModel
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/model_spec.rb

@@ -325,5 +325,22 @@ describe "Creating a model" do
     end
         
   end
+end
+
+describe 'persistence' do
+  before do
+    Task.delete_all
+    %w(one two three).each do |task|
+      @tasks = Task.create(:name => "name #{task}")
+    end
+    @tasks.serialize_to_file('test.dat')
+  end
   
-end
+  it 'reads persisted model data' do
+    tasks = Task.deserialize_from_file('test.dat')
+    
+    Task.first.name.should == 'name one'
+    Task.last.name.should  == 'name three'
+    Task.count.should      == 3
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion_model
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies: []
 description: Simple model and validation mixins for RubyMotion
 email: