parse-stack 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6f0c40c8f93d0487d4f85c4de8c71ac067a5f9f
-  data.tar.gz: d36ba2fd71de6fc4e15af83d32c8ed7eda024a9f
+  metadata.gz: a1138b12b68494580dd0ca427544dc4780a52ddd
+  data.tar.gz: f077b1ab3767c747c2257ab5f35539fbab5aa7a7
 SHA512:
-  metadata.gz: 99b5d7fe4fa3a9adad714477dd9e857de7fd761e750081acdfd83cee41862d40629640bd8c95e3dec26e654e5e86195f20a4f338df26a997ab2ee9ecd773278d
-  data.tar.gz: 0c9a75165cc1d90ce634eee97335c55241a7d97fbe156a75416be8483f084f33eb71f0ce945648e73bd1f3de3a1f571fbda51dc787b874ea1ca29de86aea66b2
+  metadata.gz: 0c21522c5712cc64b2d7ec0c7842fb42e5514ef86460a8aee92e61238a926bad5f2cc0e9b27545de98fda0f5dfb700a596fad6847fa6b981cdd0e7b49a55c5f0
+  data.tar.gz: ab980694c184fb24ed72ad8a9440703d189e98f9cef6c8d6c0ca7dba6760fbc8fcddf5846ebe4aeac0915aa0743d0a95e6a527c5519d503236713db8c1a8b22f

data/Changes.md

@@ -1,5 +1,13 @@
 # Parse-Stack Changes
 
+1.1
+-----------
+- In Query `join` has been renamed to `matches`.
+- Not In Query `exclude` has been renamed to `excludes` for consistency.
+- Parse::Query now has a `:key` operation to be usd when passing sub-queries to `select` and `matches`
+- Improves query supporting `select`, `matches`, `matches` and `excludes`.
+- Regular expression queries for `like` now send regex options
+
 1.0.10
 -----------
 - Fixes issues with setting default values as dirty when using the builder or before_save hook.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parse-stack (1.0.10)
+    parse-stack (1.1.0)
       active_model_serializers (>= 0.9, < 1)
       activemodel (>= 4, < 5)
       activesupport (>= 4, < 5)
@@ -14,7 +14,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    active_model_serializers (0.9.4)
+    active_model_serializers (0.9.5)
       activemodel (>= 3.2)
     activemodel (4.2.6)
       activesupport (= 4.2.6)
@@ -30,7 +30,7 @@ GEM
     builder (3.2.2)
     coderay (1.1.1)
     debug_inspector (0.0.2)
-    dotenv (2.1.0)
+    dotenv (2.1.1)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.10.0)
@@ -41,7 +41,7 @@ GEM
     minitest (5.8.4)
     moneta (0.8.0)
     multipart-post (2.0.0)
-    parallel (1.7.0)
+    parallel (1.8.0)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)

data/README.md

@@ -302,7 +302,11 @@ class Post < Parse::Object
 	property :comment_count, :integer, default: 0
 
 	# the published date. Maps to "publishDate"
-	property :publish_date, :date, ->{ DateTime.now }
+	property :publish_date, :date, default: ->{ DateTime.now }
+
+  # use lambda to access the instance object.
+  # Set draft_date to the created_at date if empty.
+  property :draft_date, :date, default: lambda { |x| x.created_at }
 
 	# maybe whether it is currently visible
 	property :visible, :boolean
@@ -823,11 +827,11 @@ If you only need to know the result count for a query, provide count a non-zero
 
 ```ruby
  # get number of songs with a play_count > 10
- Song.count(:play_count.gt => 10)
+ Song.count :play_count.gt => 10
 
  # same
  query = Parse::Query.new("Song")
- query.where play_count.gt => 10
+ query.where :play_count.gt => 10
  query.count
 
 ```
@@ -862,7 +866,6 @@ When a query API is made, the results are cached in the query object in case you
 
 ```
 
-
 ### Expressions
 The set of supported expressions based on what is available through the Parse REST API. _For those who don't prefer the DataMapper style syntax, we have provided method accessors for each of the expressions._
 
@@ -871,11 +874,11 @@ Specify a field to sort by.
 
 ```ruby
  # order updated_at ascending order
- Song.all( :order => :updated_at )
+ Song.all :order => :updated_at
 
  # first order by highest like_count, then by ascending name.
  # Note that ascending is the default if not specified (ex. `:name.asc`)
- Song.all( :order => [:like_count.desc, :name])
+ Song.all :order => [:like_count.desc, :name]
 ```
 
 ##### :keys
@@ -883,10 +886,10 @@ Restrict the fields returned by the query. This is useful for larger query resul
 
 ```ruby
  # results only contain :name field
- Song.all(:keys => :name)
+ Song.all :keys => :name
 
  # multiple keys
- Song.all(:keys => [:name,:artist])
+ Song.all :keys => [:name,:artist]
 ```
 
 ##### :includes
@@ -900,7 +903,7 @@ Use on Pointer columns to return the full object. You may chain multiple columns
  Song.all(:includes => :artist)
 
  # Chaining
- Song.all(:includes => [:artist, 'artist.manager'])
+ Song.all :includes => [:artist, 'artist.manager']
 
 ```
 
@@ -908,9 +911,9 @@ Use on Pointer columns to return the full object. You may chain multiple columns
 Limit the number of objects returned by the query. The default is 100, with Parse allowing a maximum of 1000. The framework also allows a value of `:max`. Utilizing this will have the framework continually intelligently utilize `:skip` to continue to paginate through results until an empty result set is received or the `:skip` limit is reached (10,000). When utilizing `all()`, `:max` is the default option for `:limit`.
 
 ```ruby
- Song.all(:limit => 1) # same as Song.first
- Song.all(:limit => 1000) # maximum allowed by Parse
- Song.all(:limit => :max) # up to 11,000 records (theoretical).
+ Song.all :limit => 1 # same as Song.first
+ Song.all :limit => 1000 # maximum allowed by Parse
+ Song.all :limit => :max # up to 11,000 records (theoretical).
 ```
 
 ##### :skip
@@ -918,7 +921,7 @@ Use with limit to paginate through results. Default is 0 with maximum value bein
 
 ```ruby
  # get the next 3 songs after the first 10
- Song.all(:limit => 3, :skip => 10)
+ Song.all :limit => 3, :skip => 10
 ```
 
 ##### :where
@@ -975,18 +978,20 @@ Most of the constraints supported by Parse are available to `Parse::Query`. Assu
  q.where :field.like => /ruby_regex/
  q.where :field.regex => /abc/ # alias
 
- # select (TODO: improve API)
- q.where :field.select => query
+ # select
+ q.where :field.select => query #with key
+ # ex. q.where :city.select => Artist.where(:total_plays.gt => 50, :key => "city")
 
- # don't select (TODO: improve API)
+ # don't select
  q.where :field.reject => query
 
- # matches inQuery (TODO: improve API)
- q.where :field.join => query
+ # matches inQuery
+ q.where :field.matches => query
  q.where :field.in_query => query # alias
 
  # notInQuery (inverse of `join`)
  q.where :field.excludes => query
+ q.where :field.not_in_query => query # alias
 
  # near GeoPoint
  q.where :field.near => geopoint
@@ -1004,6 +1009,23 @@ Most of the constraints supported by Parse are available to `Parse::Query`. Assu
  or_query = query1 | query2 | query3 ...
 ```
 
+## Select and Matching Queries
+Parse-Stack supports sub-select queries. These are referred to in Parse as `$select` and `$dontSelect` for columns that contain values. These are mapped to `select` and `reject` respectively in Parse-Stack. For creating sub-queries where the column field is an object or a pointer, Parse provides `$inQuery` and `$notInQuery`. These are mapped to `matches` and `excludes` respectively in Parse-Stack. To perform these types of sub-query constraints, you pass a different `Parse::Query` instance to the value of the query constraint. Using the example for `$select` from the Parse documentation where you have a class containing sports teams and you store a user's hometown in the user class, you can issue one query to find the list of users whose hometown teams have winning records as follows:
+
+```ruby
+# assume Team class with column of `city`
+users = Parse::User.all :hometown.select => Team.where(:win_pct.gt => 0.5, :key => :city )
+# where={"hometown":{"$select":{"query":{"className":"Team", "limit":100, "where":{"winPct":{"$gt":0.5}}},"key":"city"}}}
+# for https://api.parse.com/1/classes/_User
+```
+
+Using the `matches` and `excludes`, is similar, but are used when the field is a pointer or object. If you wanted to find all `Song` objects where the song's artist has a `city` of `San Diego` and is `approved`, you could use a `matches` query as follows:
+
+```ruby
+songs = Song.all :artist.matches => Artist.where(approved: true, city: "San Diego", limit: 1000)
+# where={"artist": {"$inQuery": {"className":"Team", "limit":1000, "where": {"winPct": {"$gt" :0.5 }}}}}
+```
+
 ## Hooks and Callbacks
 All `Parse::Object` subclasses extend [`ActiveModel::Callbacks`](http://api.rubyonrails.org/classes/ActiveModel/Callbacks.html) for `#save` and `#destroy` operations. You can setup internal hooks for `before`, `during` and `after`. See
 

data/lib/parse/query.rb

@@ -23,7 +23,7 @@ module Parse
     # You can modify the default client being used by all Parse::Query objects by setting
     # Parse::Query.client. You can override individual Parse::Query object clients
     # by changing their client variable to a different Parse::Client object.
-    attr_accessor :table, :client
+    attr_accessor :table, :client, :key
 
     # We have a special class method to handle field formatting. This turns
     # the symbol keys in an operand from one key to another. For example, we can
@@ -109,6 +109,8 @@ module Parse
           order value
         elsif expression == :keys
           keys value
+        elsif expression == :key
+          @key = value
         elsif expression == :skip
           skip value
         elsif expression == :limit
@@ -197,6 +199,13 @@ module Parse
       @where ||= []
       constraint = Parse::Constraint.create operator, value
       return unless constraint.is_a?(Parse::Constraint)
+      # to support select queries where you have to pass a `key` parameter for matching
+      # different tables.
+      if constraint.operand == :key || constraint.operand == "key"
+        @key = constraint.value
+        return
+      end
+
       unless opts[:filter] == false
         constraint.operand = Query.format_field(constraint.operand)
       end

data/lib/parse/query/constraint.rb

@@ -118,8 +118,14 @@ module Parse
       d = @value
       d = { __type: "Date", iso: d.iso8601(3) } if d.respond_to?(:iso8601)
       d = d.pointer if d.respond_to?(:pointer) #simplified query object
+      d = d.to_s if d.is_a?(Regexp)
       #d = d.pointer if d.is_a?(Parse::Object) #simplified query object
-      d = d.source if d.is_a?(Regexp)
+      #  d = d.compile
+      if d.is_a?(Parse::Query)
+        compiled = d.compile(false)
+        compiled["className"] = d.table
+        d = compiled
+      end
       d
     end
 

data/lib/parse/query/constraints.rb

@@ -109,13 +109,23 @@ module Parse
     #This matches a value for a key in the result of a different query
     contraint_keyword :$select
     register :select
+
+    def build
+      select_key = @value.key.present? ? @value.key : @operation.operand
+      select_query = formatted_value
+      { @operation.operand => { key => { query: select_query, key: select_key } } }
+    end
   end
 
   class RejectionConstraint < Constraint
     #requires that a key's value not match a value for a key in the result of a different query
     contraint_keyword :$dontSelect
     register :reject
-
+    def build
+      reject_key = @value.key.present? ? @value.key : @operation.operand
+      reject_query = formatted_value
+      { @operation.operand => { key => { query: reject_query, key: reject_key } } }
+    end
   end
 
   class RegularExpressionConstraint < Constraint
@@ -140,16 +150,15 @@ module Parse
     end
   end
 
-  class JoinQueryConstraint < Constraint
+  class InQueryConstraint < Constraint
     contraint_keyword :$inQuery
-    register :join
+    register :matches
     register :in_query
-
   end
 
-  class DisjointQueryConstraint < Constraint
+  class NotInQueryConstraint < Constraint
     contraint_keyword :$notInQuery
-    register :exclude
+    register :excludes
     register :not_in_query
 
   end

data/lib/parse/stack/version.rb

@@ -1,5 +1,5 @@
 module Parse
   module Stack
-    VERSION = "1.0.10"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse-stack
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony Persaud
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel