Parsistence 0.3.7 → 0.3.9

data/README.md

@@ -20,13 +20,16 @@ Create an instance:
 
 ```ruby
 p = Post.new
+
+p.respond_to?(:title) #=> true
+
 p.title = "Why RubyMotion Is Better Than Objective-C"
 p.author = "Josh Symonds"
 p.body = "trololol"
 p.saveEventually
 ```
 
-`Parsistence::Model` objects will `respond_to?` to all methods available to [`PFObject`](https://parse.com/docs/ios/api/Classes/PFObject.html) in the Parse iOS SDK. You can also access the `PFObject` instance directly with, you guessed it, `Parsistence::Model#PFObject`.
+`Parsistence::Model` objects will `respond_to?` to all methods available to [`PFObject`](https://parse.com/docs/ios/api/Classes/PFObject.html) in the Parse iOS SDK, as well as 'fields' getters and setters. You can also access the `PFObject` instance directly with, you guessed it, `Parsistence::Model#PFObject`.
 
 ### Users
 

data/lib/Parsistence/Model.rb

@@ -18,7 +18,7 @@ module Parsistence
       method = method.to_sym
       setter = false
       
-      if method.to_s.include?("=")
+      if setter?(method)
         setter = true
         method = method.split("=")[0].to_sym
       end
@@ -45,7 +45,31 @@ module Parsistence
         super
       end
     end
-    
+
+    def getter?(method)
+      !setter?(method)
+    end
+
+    def setter?(method)
+      method.to_s.include?("=")
+    end
+
+    # Override of ruby's respond_to?
+    # 
+    # @param [Symbol] method
+    # @return [Bool] true/false
+    def respond_to?(method)
+      if setter?(method)
+        method = method.to_s.split("=")[0]
+      end
+
+      method = method.to_sym unless method.is_a? Symbol
+
+      return true if fields.include?(method) || relations.include?(method)
+
+      super
+    end 
+
     def fields
       self.class.send(:get_fields)
     end
@@ -62,9 +86,13 @@ module Parsistence
     end
 
     def setField(field, value)
-      return @PFObject.send("#{field}=", value) if RESERVED_KEYS.include?(field)
-      return @PFObject[field] = value if fields.include? field.to_sym
-      raise "Parsistence Exception: Invalid field name #{field} for object #{self.class.to_s}" unless fields.include? field.to_sym
+      if RESERVED_KEYS.include?(field) || fields.include?(field.to_sym)
+        return @PFObject.removeObjectForKey(field.to_s) if value.nil?
+        return @PFObject.send("#{field}=", value) if RESERVED_KEYS.include?(field)
+        return @PFObject[field] = value
+      else
+        raise "Parsistence Exception: Invalid field name #{field} for object #{self.class.to_s}"
+      end
     end
 
     def getRelation(field)
@@ -97,6 +125,9 @@ module Parsistence
       raise "Parsistence Exception: Invalid relation name #{field} for object #{self.class.to_s}"
     end
 
+    # Returns all of the attributes of the Model
+    # 
+    # @return [Hash] attributes of Model
     def attributes
       attributes = {}
       fields.each do |f|
@@ -105,6 +136,11 @@ module Parsistence
       @attributes = attributes
     end
 
+    # Sets the attributes of the Model
+    # 
+    # @param [Hash] of attribute, values to set on the Model
+    # @return [Hash] that you gave it
+    # @note will throw an error if a key is invalid
     def attributes=(hashValue)
       hashValue.each do |k, v|
         if v.respond_to?(:each) && !v.is_a?(PFObject)
@@ -117,13 +153,17 @@ module Parsistence
       end
     end
 
+    # Save the current state of the Model to Parse
+    #
+    # @note calls before/after_save hooks
+    # @note before_save MUST return true, or save will not be called on PFObject
+    # @note does not save if validations fail
+    # 
+    # @return [Bool] true/false
     def save
       saved = false
       unless before_save == false
-        reset_errors
-        self.attributes.each do |field, value|
-          validateField field, value
-        end
+        self.validate
 
         if @errors && @errors.length > 0
           saved = false
@@ -138,6 +178,22 @@ module Parsistence
     def before_save; end
     def after_save; end
 
+    def validate
+      reset_errors
+      self.attributes.each do |field, value|
+        validateField field, value
+      end
+    end
+
+    # Checks to see if the current Model has errors
+    #
+    # @return [Bool] true/false
+    def is_valid?
+      self.validate
+      return false if @errors && @errors.length > 0
+      true
+    end
+
     def delete
       deleted = false
       unless before_delete == false
@@ -200,10 +256,19 @@ module Parsistence
     end
 
     module ClassMethods
+      
+      # set the fields for the current Model
+      #   used in method_missing
+      #
+      # @param [Symbol] one or more fields
       def fields(*args)
         args.each {|arg| field(arg)}
       end
     
+      # set a field for the current Model
+      #
+      # @param [Symbol] field
+      # (see #fields)
       def field(name)
         @fields ||= [:objectId]
         @fields << name.to_sym
@@ -214,10 +279,18 @@ module Parsistence
         @fields ||= []
       end
 
+      # set the relations for the current Model
+      #   used in method_missing
+      #
+      # @param [Symbol] one or more relations
       def relations(*args)
         args.each { |arg| relation(arg)}
       end
 
+      # set a relation for the current Model
+      #
+      # @param [Symbol] relation
+      # (see #relations)
       def relation(name)
         @relations ||= []
         @relations << name.to_sym
@@ -262,6 +335,9 @@ module Parsistence
         @belongs_to_attributes[field] ||= { class_name: field }
       end
 
+      # require a certain field to be present (not nil And not an empty String)
+      # 
+      # @param [Symbol, Hash] field and options (now only has message)
       def validates_presence_of(field, opts={})
         @presenceValidationMessages ||= {}
         @presenceValidationMessages[field] = opts[:message] if opts[:message]
@@ -280,7 +356,7 @@ module Parsistence
         @presenceValidations ||= []
         @presenceValidations << field
       end
-    end
+   end
     
     def self.included(base)
       base.extend(ClassMethods)

data/lib/Parsistence/Query.rb

@@ -65,42 +65,62 @@ module Parsistence
       @includes = []
     end
 
+    def checkKey(key)
+      # Sanity check for mis-entered keys.
+      tmp = self.klass.new
+      unless tmp.respond_to?(key.to_sym)
+        $stderr.puts "Parsistence Warning: No field '#{key}' found for #{self.klass.to_s} query."
+      end
+    end
+
     def createQuery
-      query = PFQuery.queryWithClassName(self.klass.to_s)
+      if self.klass.to_s == "User"
+        query = PFUser.query
+      else
+        query = PFQuery.queryWithClassName(self.klass.to_s)
+      end
       @includes.each do |include|
         query.includeKey(include)
       end
       
       @conditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, equalTo: value)
       end
       @inConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, containedIn: value)
       end
       @negativeConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, notEqualTo: value)
       end
       @ltConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, lessThan: value)
       end
       @gtConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, greaterThan: value)
       end
       @lteConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, lessThanOrEqualTo: value)
       end
       @gteConditions.each do |key, value|
+        checkKey key
         value = value.PFObject if value.respond_to?(:PFObject)
         query.whereKey(key, greaterThanOrEqualTo: value)
       end
       first = true
       @order.each do |field, direction|
+        checkKey field
         if first
           query.orderByAscending(field) if direction && direction == :asc
           query.orderByDescending(field) if direction && direction == :desc
@@ -117,6 +137,16 @@ module Parsistence
       query
     end
 
+    # TODO: Get this working.
+    # def count(&callback)
+    #   query = createQuery
+      
+    #   myKlass = self.klass
+    #   query.countObjectsInBackgroundWithBlock (lambda { |item_count, error|
+    #     callback.call item_count, error
+    #   })
+    # end
+
     def fetch(&callback)
       if @limit && @limit == 1
         fetchOne(&callback) 
@@ -127,6 +157,13 @@ module Parsistence
       self
     end
 
+    # @deprecated
+    # Grab all results that match query
+    # 
+    # @param [Block] callback block
+    # @return [Nil]
+    # 
+    # (see #all)
     def fetchAll(&callback)
       query = createQuery
       
@@ -137,6 +174,13 @@ module Parsistence
       })
     end
 
+    # @deprecated
+    # Grab first result that matches query
+    # 
+    # @param [Block] callback block
+    # @return [Nil]
+    # 
+    # (see #first)
     def fetchOne(&callback)
       limit(0, 1)
       query = createQuery
@@ -148,23 +192,33 @@ module Parsistence
       })
     end
 
-    # Query methods
+    # @deprecated
+    # (see #eq)
     def where(*conditions, &callback)
       eq(conditions.first)
       fetch(&callback)
       nil
     end
 
+    # Grab all results that match query
+    # 
+    # @param [Block] callback block
+    # @return [Nil]
     def all(&callback)
       fetchAll(&callback)
       nil
     end
 
+    # Grab first result that matches query
+    # 
+    # @param [Block] callback block
+    # @return [Nil]
     def first(&callback)
       fetchOne(&callback)
       nil
     end
     
+    # Prints current Query conditions to STDERR
     def showQuery
       $stderr.puts "Conditions: #{@conditions.to_s}"
       $stderr.puts "negativeConditions: #{@negativeConditions.to_s}"
@@ -178,7 +232,11 @@ module Parsistence
       $stderr.puts "offset: #{@offset.to_s}"
     end
 
-    # Query parameter methods
+    # Limit number of results
+    # 
+    # @param [Integer] offset
+    # @param [Integer] number to limit, if not passed, first arg is used for limit
+    # @return [Object] self
     def limit(offset, number = nil)
       if number.nil?
         number = offset
@@ -189,6 +247,10 @@ module Parsistence
       self
     end
 
+    # Order query results
+    # 
+    # @param [Hash] of field - order-direction
+    # @return [Object] self
     def order(*fields)
       fields.each do |field|
         @order.merge! field
@@ -196,6 +258,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key == value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def eq(*fields)
       fields.each do |field|
         @conditions.merge! field
@@ -203,6 +269,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key != value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def notEq(*fields)
       fields.each do |field|
         @negativeConditions.merge! field
@@ -210,6 +280,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key < value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def lt(*fields)
       fields.each do |field|
         @ltConditions.merge! field
@@ -217,6 +291,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key > value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def gt(*fields)
       fields.each do |field|
         @gtConditions.merge! field
@@ -224,6 +302,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key is in an array of values
+    # 
+    # @param [Hash] of key-value pairs, value is an array
+    # @return [Object] self
     def in(*fields)
       fields.each do |field|
         @inConditions.merge! field
@@ -231,6 +313,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key <= value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def lte(*fields)
       fields.each do |field|
         @lteConditions.merge! field
@@ -238,6 +324,10 @@ module Parsistence
       self
     end
 
+    # Query for fields where key >= value
+    # 
+    # @param [Hash] of key-value pairs
+    # @return [Object] self
     def gte(*fields)
       fields.each do |field|
         @gteConditions.merge! field
@@ -245,6 +335,10 @@ module Parsistence
       self
     end
 
+    # Include related object in query
+    # 
+    # @param [Hash] of symbols
+    # @return [Object] self
     def includes(*fields)
       fields.each do |field|
         @includes << field

data/lib/Parsistence/User.rb

@@ -29,6 +29,22 @@ module Parsistence
       self.PFUser.password = value
     end
 
+    def signUp
+      saved = false
+      unless before_save == false
+        self.validate
+
+        if @errors && @errors.length > 0
+          saved = false
+        else
+          saved = @PFObject.signUp
+        end
+
+        after_save if saved
+      end
+      saved
+    end
+
     module ClassMethods
       include Parsistence::Model::ClassMethods
 

data/lib/Parsistence/version.rb

@@ -1,3 +1,3 @@
 module Parsistence
-  VERSION = "0.3.7"
+  VERSION = "0.3.9" unless defined? Parsistence::VERSION
 end

metadata

@@ -1,37 +1,27 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: Parsistence
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.3.9
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 7
-  version: 0.3.7
 platform: ruby
-authors: 
+authors:
 - Jamon Holmgren
 - Silas J. Matson
 - Alan deLevie
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-11 00:00:00 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies: []
-
 description: Your models on RubyMotion and Parse in a persistence.js style pattern.
-email: 
+email:
 - jamon@clearsightstudio.com
 - silas@clearsightstudio.com
 - adelevie@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Parsistence.gemspec
@@ -45,36 +35,27 @@ files:
 - lib/Parsistence/version.rb
 homepage: https://github.com/clearsightstudio/Parsistence
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: Parsistence
-rubygems_version: 1.8.24
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: Your models on RubyMotion and Parse in a persistence.js style pattern.
 test_files: []
-
+has_rdoc: