cdq 0.1.2 → 0.1.5

data/motion/cdq/context.rb

@@ -14,6 +14,7 @@ module CDQ
     # return to the previous state.
     #
     def push(context, &block)
+      @has_been_set_up = true
       if block_given?
         save_stack do
           push_to_stack(context)
@@ -41,6 +42,9 @@ module CDQ
     # The current context at the top of the stack.
     #
     def current
+      if stack.empty? && !@has_been_set_up
+        new(NSMainQueueConcurrencyType)
+      end
       stack.last
     end
 
@@ -61,6 +65,7 @@ module CDQ
     # will exist for the duration of the block and then the previous state will be restore_managerd.
     #
     def new(concurrency_type, &block)
+      @has_been_set_up = true
       context = NSManagedObjectContext.alloc.initWithConcurrencyType(concurrency_type)
       if current
         context.parentContext = current

data/motion/cdq/partial_predicate.rb

@@ -1,37 +1,80 @@
 
 module CDQ
+
+  # A partial predicate is an intermediate state while constructing a
+  # query. It knows which attribute to use as the left operand, and
+  # then offers a range of methods to specify which operation to use,
+  # and what value to use as the right operand.  They are most commonly
+  # created via the <tt>where</tt>, <tt>and</tt>, and <tt>or</tt>
+  # methods on query, and sometimes via the main <tt>cdq</tt> method.
+
   class CDQPartialPredicate < CDQObject
 
     attr_reader :key, :scope, :operation
 
-    OPERATORS = {
-      :eq => [NSEqualToPredicateOperatorType, :equal],
-      :ne => [NSNotEqualToPredicateOperatorType, :not_equal],
-      :lt => [NSLessThanPredicateOperatorType, :less_than],
-      :le => [NSLessThanOrEqualToPredicateOperatorType, :less_than_or_equal],
-      :gt => [NSGreaterThanPredicateOperatorType, :greater_than],
-      :ge => [NSGreaterThanOrEqualToPredicateOperatorType, :greater_than_or_equal],
-      :contains => [NSContainsPredicateOperatorType, :include],
-      :matches => [NSMatchesPredicateOperatorType],
-      :in => [NSInPredicateOperatorType],
-      :begins_with => [NSBeginsWithPredicateOperatorType],
-      :ends_with => [NSEndsWithPredicateOperatorType]
-    }
-
     def initialize(key, scope, operation = :and)
       @key = key
       @scope = scope
       @operation = operation
     end
 
-    OPERATORS.each do |op, (type, synonym)|
-      define_method(op) do |value, options = 0|
-        make_scope(type, value, options)
-      end
-      alias_method synonym, op if synonym
-    end
+    # Equality
+    # @returns a new CDQQuery with the predicate appended
+    def eq(value, options = 0);           make_scope(NSEqualToPredicateOperatorType, value, options); end
+
+    # Inequality
+    # @returns a new CDQQuery with the predicate appended
+    def ne(value, options = 0);           make_scope(NSNotEqualToPredicateOperatorType, value, options); end
+
+    # Less Than
+    # @returns a new CDQQuery with the predicate appended
+    def lt(value, options = 0);           make_scope(NSLessThanPredicateOperatorType, value, options); end
+
+    # Less Than or Equal To
+    # @returns a new CDQQuery with the predicate appended
+    def le(value, options = 0);           make_scope(NSLessThanOrEqualToPredicateOperatorType, value, options); end
+
+    # Greater Than
+    # @returns a new CDQQuery with the predicate appended
+    def gt(value, options = 0);           make_scope(NSGreaterThanPredicateOperatorType, value, options); end
+
+    # Greater Than or Equal To
+    # @returns a new CDQQuery with the predicate appended
+    def ge(value, options = 0);           make_scope(NSGreaterThanOrEqualToPredicateOperatorType, value, options); end
+
+    # Contains Substring
+    # @returns a new CDQQuery with the predicate appended
+    def contains(substr, options = 0);    make_scope(NSContainsPredicateOperatorType, substr, options); end
+
+    # Matches Regexp
+    # @returns a new CDQQuery with the predicate appended
+    def matches(regexp, options = 0);     make_scope(NSMatchesPredicateOperatorType, regexp, options); end
+
+    # List membership
+    # @returns a new CDQQuery with the predicate appended
+    def in(list, options = 0);            make_scope(NSInPredicateOperatorType, list, options); end
+
+    # Begins With String
+    # @returns a new CDQQuery with the predicate appended
+    def begins_with(substr, options = 0); make_scope(NSBeginsWithPredicateOperatorType, substr, options); end
+
+    # Ends With String
+    # @returns a new CDQQuery with the predicate appended
+    def ends_with(substr, options = 0);   make_scope(NSEndsWithPredicateOperatorType, substr, options); end
+
+    # Between Min and Max Values
+    # @returns a new CDQQuery with the predicate appended
+    def between(min, max);                make_scope(NSBetweenPredicateOperatorType, [min, max]); end
+
+
+    alias_method :equal, :eq
+    alias_method :not_equal, :ne
+    alias_method :less_than, :lt
+    alias_method :less_than_or_equal, :le
+    alias_method :greater_than, :gt
+    alias_method :greater_than_or_equal, :ge
+    alias_method :include, :contains
 
-    def between(min, max);   make_scope(NSBetweenPredicateOperatorType, [min, max]); end
 
     private
 

data/motion/cdq/query.rb

@@ -1,7 +1,16 @@
 
 module CDQ
+
+  #
+  # CDQ Queries are the primary way of describing a set of objects.
+  #
   class CDQQuery < CDQObject
 
+    # @private
+    #
+    # This is a singleton object needed to represent "empty" in limit and
+    # offset, because they need to be able to accept nil as a real value.
+    #
     EMPTY = Object.new
 
     attr_reader :predicate, :sort_descriptors
@@ -14,6 +23,10 @@ module CDQ
       @saved_key = opts[:saved_key]
     end
 
+    # Return or set the fetch limit.  If passed an argument, return a new
+    # query with the specified limit value.  Otherwise, return the current
+    # value.
+    #
     def limit(value = EMPTY)
       if value == EMPTY
         @limit
@@ -22,6 +35,10 @@ module CDQ
       end
     end
 
+    # Return or set the fetch offset.  If passed an argument, return a new
+    # query with the specified offset value.  Otherwise, return the current
+    # value.
+    #
     def offset(value = EMPTY)
       if value == EMPTY
         @offset
@@ -30,7 +47,36 @@ module CDQ
       end
     end
 
-    # Combine this query with others in an intersection ("and") relationship
+    # Combine this query with others in an intersection ("and") relationship. Can be
+    # used to begin a new query as well, especially when called in its <tt>where</tt>
+    # variant.
+    #
+    # The query passed in can be a wide variety of types:
+    #
+    # Symbol: This is by far the most common, and it is also a special
+    # case -- the return value when passing a symbol is a CDQPartialPredicate,
+    # rather than CDQQuery. Methods on CDQPartialPredicate are then comparison
+    # operators against the attribute indicated by the symbol itself, which take
+    # a value operand.  For example:
+    #
+    #   query.where(:name).equal("Chuck").and(:title).not_equal("Manager")
+    #
+    # @see CDQPartialPredicate
+    #
+    # String: Interpreted as an NSPredicate format string.  Additional arguments are
+    # the positional parameters.
+    #
+    # NilClass: If the argument is nil (most likely because it was omitted), and there
+    # was a previous use of a symbol, then reuse that last symbol. For example:
+    #
+    #   query.where(:name).contains("Chuck").and.contains("Norris")
+    #
+    # CDQQuery: If you have another CDQQuery from somewhere else, you can pass it in directly.
+    #
+    # NSPredicate: You can pass in a raw NSPredicate and it will work as you'd expect.
+    #
+    # Hash: Each key/value pair is treated as equality and anded together.
+    #
     def and(query = nil, *args)
       merge_query(query, :and, *args) do |left, right|
         NSCompoundPredicate.andPredicateWithSubpredicates([left, right])
@@ -38,26 +84,20 @@ module CDQ
     end
     alias_method :where, :and
 
-    # Combine this query with others in a union ("or") relationship
+    # Combine this query with others in a union ("or") relationship.  Accepts
+    # all the same argument types as <tt>and</tt>.
     def or(query = nil, *args)
       merge_query(query, :or, *args) do |left, right|
         NSCompoundPredicate.orPredicateWithSubpredicates([left, right])
       end
     end
 
-    # Create a new query with the same values as this one, optionally overriding
-    # any of them in the options
-    def clone(opts = {})
-      self.class.new(locals.merge(opts))
-    end
-
-    def locals
-      { sort_descriptors: sort_descriptors,
-        predicate: predicate,
-        limit: limit,
-        offset: offset }
-    end
-
+    # Add a new sort key.  Multiple invocations add additional sort keys rather than replacing
+    # old ones.
+    #
+    #   @param key The attribute to sort on
+    #   @param dir The sort direction (default = :ascending)
+    #
     def sort_by(key, dir = :ascending)
       if dir.to_s[0,4].downcase == 'desc'
         ascending = false
@@ -68,6 +108,7 @@ module CDQ
       clone(sort_descriptors: @sort_descriptors + [NSSortDescriptor.sortDescriptorWithKey(key, ascending: ascending)])
     end
 
+    # Return an NSFetchRequest that will implement this query
     def fetch_request
       NSFetchRequest.new.tap do |req|
         req.predicate = predicate
@@ -79,6 +120,19 @@ module CDQ
 
     private
 
+    # Create a new query with the same values as this one, optionally overriding
+    # any of them in the options
+    def clone(opts = {})
+      self.class.new(locals.merge(opts))
+    end
+
+    def locals
+      { sort_descriptors: sort_descriptors,
+        predicate: predicate,
+        limit: limit,
+        offset: offset }
+    end
+
     def merge_query(query, operation, *args, &block)
       key_to_save = nil
       case query

data/motion/cdq/targeted_query.rb

@@ -108,8 +108,6 @@ module CDQ #:nodoc:
     # Create a new entity in the current context.  Accepts a hash of attributes that will be assigned to
     # the newly-created entity.  Does not save the context.
     #
-    # [TODO: Will apply validation.]
-    #
     def create(*args)
       new(*args)
     end

data/templates/model/spec/models/name.rb

@@ -9,7 +9,7 @@ describe '<%= @name_camel_case %>' do
     cdq.reset!
   end
 
-  it 'should be a <%= @name_camel_case %> entity'
+  it 'should be a <%= @name_camel_case %> entity' do
     <%= @name_camel_case %>.entity_description.name.should == '<%= @name_camel_case %>'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdq
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - infinitered
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-xcdm
@@ -53,21 +53,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- Gemfile
-- Gemfile.lock
 - README.md
-- Rakefile
-- app/app_delegate.rb
-- app/test_models.rb
-- bin/cdq
-- cdq.gemspec
-- lib/cdq.rb
+- LICENSE
 - lib/cdq/cli.rb
 - lib/cdq/generators.rb
 - lib/cdq/version.rb
-- motion/cdq.rb
+- lib/cdq.rb
 - motion/cdq/collection_proxy.rb
 - motion/cdq/config.rb
 - motion/cdq/context.rb
@@ -79,34 +70,17 @@ files:
 - motion/cdq/relationship_query.rb
 - motion/cdq/store.rb
 - motion/cdq/targeted_query.rb
+- motion/cdq.rb
 - motion/managed_object.rb
-- resources/CDQ.xcdatamodeld/.xccurrentversion
-- resources/CDQ.xcdatamodeld/0.0.1.xcdatamodel/contents
-- resources/Default-568h@2x.png
-- resources/KEEPME
-- schemas/001_baseline.rb
-- spec/cdq/collection_proxy_spec.rb
-- spec/cdq/config_spec.rb
-- spec/cdq/context_spec.rb
-- spec/cdq/managed_object_spec.rb
-- spec/cdq/model_spec.rb
-- spec/cdq/module_spec.rb
-- spec/cdq/object_proxy_spec.rb
-- spec/cdq/object_spec.rb
-- spec/cdq/partial_predicate_spec.rb
-- spec/cdq/query_spec.rb
-- spec/cdq/relationship_query_spec.rb
-- spec/cdq/store_spec.rb
-- spec/cdq/targeted_query_spec.rb
-- spec/helpers/thread_helper.rb
-- spec/integration_spec.rb
 - templates/init/schemas/0001_initial.rb
 - templates/model/app/models/name.rb
 - templates/model/spec/models/name.rb
-- vendor/cdq/ext/CoreDataQueryManagedObjectBase.h
 - vendor/cdq/ext/CoreDataQueryManagedObjectBase.m
-homepage: http://github.com/infinitered/cdq
-licenses: []
+- vendor/cdq/ext/CoreDataQueryManagedObjectBase.h
+- bin/cdq
+homepage: http://infinitered.com/cdq
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -127,20 +101,5 @@ rubyforge_project:
 rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: Core Data Query for RubyMotion
-test_files:
-- spec/cdq/collection_proxy_spec.rb
-- spec/cdq/config_spec.rb
-- spec/cdq/context_spec.rb
-- spec/cdq/managed_object_spec.rb
-- spec/cdq/model_spec.rb
-- spec/cdq/module_spec.rb
-- spec/cdq/object_proxy_spec.rb
-- spec/cdq/object_spec.rb
-- spec/cdq/partial_predicate_spec.rb
-- spec/cdq/query_spec.rb
-- spec/cdq/relationship_query_spec.rb
-- spec/cdq/store_spec.rb
-- spec/cdq/targeted_query_spec.rb
-- spec/helpers/thread_helper.rb
-- spec/integration_spec.rb
+summary: A streamlined library for working with Core Data outside XCode
+test_files: []

data/.gitignore

@@ -1,12 +0,0 @@
-.repl_history
-.*.sw?
-build
-vendor/cdq/ext/build-*
-vendor/cdq/ext/ext.bridgesupport
-resources/*.nib
-resources/*.momd
-resources/*.storyboardc
-examples/**/*.nib
-tags
-.rbenv-version
-pkg

data/.travis.yml

@@ -1,2 +0,0 @@
-language: objective-c
-before_install: ruby --version

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rake'
-gem 'motion-stump', :group => :spec
-gem 'cdq', :path => '.'

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cdq (0.1.2)
-      motion-yaml
-      ruby-xcdm (~> 0.0, >= 0.0.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.2.16)
-      i18n (~> 0.6, >= 0.6.4)
-      multi_json (~> 1.0)
-    builder (3.2.2)
-    i18n (0.6.9)
-    motion-stump (0.3.0)
-    motion-yaml (1.2)
-    multi_json (1.8.2)
-    plist (3.1.0)
-    rake (10.1.0)
-    ruby-xcdm (0.0.5)
-      activesupport (~> 3.2)
-      builder (~> 3.2)
-      plist (~> 3.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  cdq!
-  motion-stump
-  rake

data/Rakefile

@@ -1,28 +0,0 @@
-$:.unshift("/Library/RubyMotion/lib")
-require 'motion/project/template/ios'
-
-require 'bundler'
-require 'bundler/gem_tasks'
-
-Motion::Project::App.setup do |app|
-  # Use `rake config' to see complete project settings.
-  app.name = 'CDQ'
-  app.vendor_project('vendor/cdq/ext', :static)
-end
-
-if ARGV.join(' ') =~ /spec/
-  Bundler.require :default, :spec
-else
-  Bundler.require
-end
-
-require 'cdq'
-require 'motion-stump'
-require 'ruby-xcdm'
-require 'motion-yaml'
-
-task :"build:simulator" => :"schema:build"
-task :"build:simulator" => :"schema:build"
-task :"build:simulator" => :"schema:build"
-task :"build:simulator" => :"schema:build"
-task :"build:simulator" => :"schema:build"