motion_record 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 806d2c421426bad6f8c077bcd5a6d12e74015367
-  data.tar.gz: 2a906afefcc90eecd49b3f03badeda1bee7f3171
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzZjNjNiN2I4MWRlMmI3YjU0ZGY1YTY3M2Q0OTg5MGIwZmFjMjQyZQ==
+  data.tar.gz: !binary |-
+    NmRiNTEyMDRhMDQ5MDk0ODg4M2QwZTEyOWY4ZWIwMmVlZWYyN2U4MQ==
 SHA512:
-  metadata.gz: e46095019c1d27c71be32543d3b8896f909a0f64446e4fdd6a76d8e39e2d59fbcb00bdc806206a17fa5554e9b0f73264b7769deb79d5b25dbdc6281d554be082
-  data.tar.gz: f314d3c7defa369ab86623572789dcea5f9c0127e46a45325100a4ccd64b4846779c336a3c31525dd39199403e9525e078cb0eb58c7f454b7159409b38cddf4f
+  metadata.gz: !binary |-
+    NzhjMjI1OTZlZWNkMjRjYzIxOGI3ZTUwOTg4NTc4NWVhM2RmNmU3NmQ1YTAz
+    NmMzMjhjMDUwZDZmYmJhZWMxMjYyMzI0YjdjMmQzZmQ2ZjM5Yjk3MGIyZWNk
+    ZjUxNDBmMjZlODVkMjhkODZhNDIyZWNjNjEzNzFkMmI5ZmI2ODM=
+  data.tar.gz: !binary |-
+    MDUwNjRkYTMwMGQ1MjJmOGViYjU3ODllOTY5Mjc0NWRhOTg4MWMzZGIyMTA0
+    NWZjZWFiODQ5NjYxMGIzY2YzODU1NjlkNzg1NWE0MzBlYmE3YmZlMDI4M2Zh
+    ZGFlMDY3MDE2ODg4NzkwMjg5OGI5Mjg4MjU2NGUxN2VjOWI5ZjU=

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+=========
+
+Version changes are recorded with [GitHub releases](https://github.com/magoosh/motion_record/releases)

data/README.md

@@ -6,6 +6,13 @@ MotionRecord
 Everything you need to start using SQLite as the datastore for your RubyMotion
 app.
 
+* [Installation](#installation)
+* [MotionRecord::Base](#motionrecordbase)
+* [MotionRecord::Schema](#motionrecordschema)
+* [MotionRecord::Scope](#motionrecordscope)
+* [MotionRecord::Serialization](#motionrecordserialization)
+* [MotionRecord::Association](#motionrecordassociation)
+
 :turtle: Android support should be [coming soon](https://github.com/magoosh/motion_record/issues/3)
 
 [![Gem Version](https://badge.fury.io/rb/motion_record.svg)](http://badge.fury.io/rb/motion_record) [![Code Climate](https://codeclimate.com/github/magoosh/motion_record/badges/gpa.svg)](https://codeclimate.com/github/magoosh/motion_record) [![Test Coverage](https://codeclimate.com/github/magoosh/motion_record/badges/coverage.svg)](https://codeclimate.com/github/magoosh/motion_record)
@@ -50,24 +57,29 @@ end
 Attribute methods are inferred from the associated SQLite table definition.
 
 ```ruby
-message = Message.new(subject: "Welcome!", body: "If you have any questions...")
-# => #<Message: @id=nil @subject="Welcome!" @body="If you have any..." ...>
-message.satisfaction
-# => 0.0
+message = Message.new(subject: "Welcome!")
+# => #<Message: @id=nil @subject="Welcome!" @body=nil, @created_at=nil ...>
 ```
 
-Manage persistence with `save!`, `delete!`, and `persisted?`
+Manage persistence with `create`, `save`, `destroy`, and `persisted?`
 
 ```ruby
-message = Message.new(subject: "Welcome!", body: "If you have any questions...")
-message.save!
-message.id
-# => 1
-message.delete!
+message = Message.create(subject: "Welcome!")
+message.body = "If you have any questions, just ask us :)"
+message.save
+#    SQL: UPDATE messages SET subject = ?, body = ?, ... WHERE id = ?
+# Params: ["Welcome!", "If you have any questions, just ask :)", ..., 1]
+message.destroy
 message.persisted?
 # => false
 ```
 
+### Timestamp Columns
+
+If any of the columns are named `created_at` or `updated_at` then they are
+automatically [serialized as Time objects](#motionrecordserialization) and set
+to `Time.now` when the record is created or updated.
+
 MotionRecord::Schema
 --------------------
 
@@ -83,6 +95,7 @@ def application(application, didFinishLaunchingWithOptions:launchOptions)
         t.integer :read_at
         t.integer :remote_id
         t.float   :satisfaction, default: 0.0
+        t.timestamps
       end
     end
 
@@ -163,7 +176,7 @@ class Message < MotionRecord::Base
   serialize :read_at, :time
 end
 
-Message.create!(subject: "Hello!", read_at: Time.now)
+Message.create(subject: "Hello!", read_at: Time.now)
 #    SQL: INSERT INTO messages (subject, body, read_at, ...) VALUES (?, ?, ?...)
 # Params: ["Hello!", nil, 1420099200, ...]
 Message.first.read_at
@@ -186,14 +199,27 @@ class Survey < MotionRecord::Base
   serialize :response, :json
 end
 
-survey = Survey.new(response: {nps: 10, what_can_we_improve: "Nothing :)"})
-survey.save!
+survey = Survey.create(response: {nps: 10, what_can_we_improve: "Nothing :)"})
 #    SQL: INSERT INTO surveys (response) VALUES (?)
 # Params: ['{"nps":10, "what_can_we_improve":"Nothing :)"}']
-Survey.first
+survey
 # => #<Survey: @id=1 @response={"nps"=>10, "what_can_we_improve"=>"Nothing :)"}>
 ```
 
+RubyMotion doesn't have a Date class, but as long as you're okay with using Time
+objects with only the date attributes, you can serialize them to TEXT columns:
+
+```ruby
+class User < MotionRecord::Base
+  serialize :birthday, :date
+end
+
+drake = User.create(birthday: Time.new(1986, 10, 24))
+#    SQL: INSERT INTO users (birthday) VALUES (?)
+# Params: ["1986-10-24"]
+# => #<User: @id=1, @birthday=1986-10-24 00:00:00 UTC>
+```
+
 #### Custom Serializers
 
 To write a custom serializer, extend MotionRecord::Serialization::BaseSerializer

data/lib/motion_record/persistence.rb

@@ -1,16 +1,14 @@
 module MotionRecord
   module Persistence
 
-    def save!
+    TIMESTAMP_COLUMNS = [:created_at, :updated_at]
+
+    def save
       persist!
     end
 
-    def delete!
-      if persisted?
-        self.class.where(primary_key_condition).delete_all
-      else
-        raise "Can't delete unpersisted records"
-      end
+    def destroy
+      delete!
     end
 
     def persisted?
@@ -31,6 +29,7 @@ module MotionRecord
       # HACK: Must ensure that attribute definitions are loaded from the table
       self.class.table_columns
 
+      self.apply_persistence_timestamps
       params = self.to_attribute_hash.reject { |k, _v| k == self.class.primary_key }
       table_params = self.class.serialize_table_params(params)
 
@@ -38,18 +37,44 @@ module MotionRecord
         self.class.where(primary_key_condition).update_all(table_params)
       else
         connection.insert self.class.table_name, table_params
+        if self.class.primary_key
+          # HACK: This assumes that primary keys are monotonically increasing
+          newest_primary_key = self.class.maximum(self.class.primary_key)
+          self.self.instance_variable_set "@#{self.class.primary_key}", newest_primary_key
+        end
       end
 
       self.mark_persisted!
     end
 
+    def delete!
+      if persisted?
+        self.class.where(primary_key_condition).delete_all
+      else
+        raise "Can't delete unpersisted records"
+      end
+    end
+
+    # Update persistence auto-timestamp attributes
+    def apply_persistence_timestamps
+      self.updated_at   = Time.now if self.class.attribute_names.include?(:updated_at)
+      self.created_at ||= Time.now if self.class.attribute_names.include?(:created_at)
+    end
+
     def primary_key_condition
       {self.class.primary_key => self.instance_variable_get("@#{self.class.primary_key}")}
     end
 
     module ClassMethods
-      def create!(attributes={})
-        self.new(attributes).save!
+      # Create a new record
+      #
+      # attributes - a Hash of attribute values
+      #
+      # Returns the created record
+      def create(attributes={})
+        record = self.new(attributes)
+        record.save
+        record
       end
 
       # Sybmol name of the primary key column
@@ -86,6 +111,10 @@ module MotionRecord
       def define_attribute_from_column(column)
         # TODO: handle options
         define_attribute column.name, default: column.default
+
+        if TIMESTAMP_COLUMNS.include?(column.name)
+          serialize column.name, :time
+        end
       end
     end
 

data/lib/motion_record/schema/migration.rb

@@ -13,6 +13,10 @@ module MotionRecord
           connection.table_exists?(table_name)
         end
 
+        def primary_key
+          nil
+        end
+
         def create_table
           table = Schema::TableDefinition.new(table_name, id: false)
           table.integer :version, :null => false

data/lib/motion_record/schema/migrator.rb

@@ -15,7 +15,7 @@ module MotionRecord
         pending_migrations.each do |migration|
           migration.execute
           @migrated_versions << migration.version
-          Schema::Migration.create!(version: migration.version)
+          Schema::Migration.create(version: migration.version)
         end 
       end
 

data/lib/motion_record/schema/table_definition.rb

@@ -36,6 +36,12 @@ module MotionRecord
         @index_definitions << IndexDefinition.new(@name, columns, options)
       end
 
+      # Add :created_at and :updated_at columns to the table
+      def timestamps
+        self.integer(:created_at)
+        self.integer(:updated_at)
+      end
+
       protected
 
       def add_default_primary_column

data/lib/motion_record/serialization.rb

@@ -4,13 +4,15 @@ module MotionRecord
       # Register a new attribute serializer
       #
       # attribute               - Symbol name of the attribute
-      # serializer_class_or_sym - One of :time, :boolean, :json or a custom
+      # serializer_class_or_sym - One of :time, :boolean, :json, :date or a custom
       #                           subclass of Serialization::BaseSerializer
       def serialize(attribute, serializer_class_or_sym)
         if serializer_class_or_sym.is_a?(Symbol)
           self.serializer_classes[attribute] = case serializer_class_or_sym
           when :time
             Serialization::TimeSerializer
+          when :date
+            Serialization::DateSerializer
           when :boolean
             Serialization::BooleanSerializer
           when :json

data/lib/motion_record/serialization/date_serializer.rb

@@ -0,0 +1,63 @@
+# This serializer stores Time objects to TEXT columns, but discards all
+# information except for year, month, and day.
+#
+# (Time is used because RubyMotion doesn't currently support Date objects)
+
+module MotionRecord
+  module Serialization
+    class DateSerializer < BaseSerializer
+
+      # ISO8601 pattern that only matches date strings
+      ISO8601_PATTERN = /\A\s*
+              (-?\d+)-(\d\d)-(\d\d)
+              \s*\z/ix
+
+      def serialize(value)
+        case @column.type
+        when :text
+          self.class.date_to_iso8601(value)
+        else
+          raise "Can't serialize #{value.inspect} to #{@column.type.inspect}"
+        end
+      end
+
+      def deserialize(value)
+        case @column.type
+        when :text
+          self.class.date_from_iso8601(value)
+        else
+          raise "Can't deserialize #{value.inspect} from #{@column.type.inspect}"
+        end
+      end
+
+      # Convert a Time object to an ISO8601 format date string.
+      #
+      # time - the Time to convert
+      #
+      # Returns the String representation
+      def self.date_to_iso8601(time)
+        return nil unless time
+        
+        "%04d-%02d-%02d" % [time.year, time.month, time.day]
+      end
+
+      # Parse an ISO8601 format date string.
+      #
+      # date_str - the String date representation in ISO8601 format
+      #
+      # Returns a Time object
+      def self.date_from_iso8601(date_str)
+        return nil unless date_str
+
+        if (match = ISO8601_PATTERN.match(date_str))
+          year = match[1].to_i
+          mon  = match[2].to_i
+          day  = match[3].to_i
+          Time.utc(year, mon, day)
+        else
+          raise ArgumentError.new("invalid date: #{date_str.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/motion_record/version.rb

@@ -1,3 +1,3 @@
 module MotionRecord
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion_record
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Zach Millman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Mini ActiveRecord for RubyMotion
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,6 +68,7 @@ files:
 - lib/motion_record/serialization.rb
 - lib/motion_record/serialization/base_serializer.rb
 - lib/motion_record/serialization/boolean_serializer.rb
+- lib/motion_record/serialization/date_serializer.rb
 - lib/motion_record/serialization/default_serializer.rb
 - lib/motion_record/serialization/json_serializer.rb
 - lib/motion_record/serialization/time_serializer.rb
@@ -82,12 +84,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []