cdq 1.0.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec68953e11bba01e74f3eee7eaab74c2c0e23242
-  data.tar.gz: 7108f694c4c3a2fd0d38734198a9167577953781
+SHA256:
+  metadata.gz: 1cf56ea93694970f2f7e38947189765b8593fa4ee81572a5e996f14a1c1fd6a9
+  data.tar.gz: 45c3fe30524de6445c893aaf055a136a4b9d29720eb96eb3b6aa262f2dea1fc5
 SHA512:
-  metadata.gz: dd58cf6e1101052c91fd7b3a3a367ed6f827746941ba4728859769dc2ceced4facc7c1ce231af3231bd71c0e66085093d518fba8af07aaeda77755721596072a
-  data.tar.gz: 96880f37bcea7dbc6a31e10626551a6fcdc1cd1f6109aece29d552ee016d13ff674c9d7dbee508b375dc42eae834e565809c4503f4c30f7fd03c37570bfbf2cc
+  metadata.gz: 0e599a61c04c2ed8455cac38934e77dbe2aea38237c2c1546fed69f7ef912290f425f97c9c2d8c8b05989ce933162158c66adb9bb983e6dfb7954fec1a3785c6
+  data.tar.gz: '0964a35ccbf50c8c0363e8db31d4cbfe55b971dcac085be1729fa9ff1cfbaa4e8e01a6084195ecfc384c4c71904744a841eb308ef9d47c22854cdef87989d481'

data/README.md

@@ -5,10 +5,11 @@ Core Data Query (CDQ) is a library to help you manage your Core Data stack
 while using RubyMotion.  It uses a data model file, which you can generate in
 XCode, or you can use [ruby-xcdm](https://github.com/infinitered/ruby-xcdm).
 
-[![Dependency Status](https://gemnasium.com/infinitered/cdq.png)](https://gemnasium.com/infinitered/cdq)
 [![Build Status](https://travis-ci.org/infinitered/cdq.png?branch=master)](https://travis-ci.org/infinitered/cdq)
 [![Gem Version](https://badge.fury.io/rb/cdq.png)](http://badge.fury.io/rb/cdq)
 
+CDQ is maintained by [Infinite Red](http://infinite.red), a web and mobile development company based in Portland, OR and San Francisco, CA.
+
 ## Get Started
 1. [Introducing CDQ](#introducingCDQ)
 2. [Greenfield Quick Start Tutorial](https://github.com/infinitered/cdq/wiki/Greenfield-Quick-Start)
@@ -96,7 +97,6 @@ app root, and they are versioned for automatic migrations, and this is what they
   schema "0001 initial" do
 
     entity "Article" do
-
       string    :body,        optional: false
       integer32 :length
       boolean   :published,   default: false
@@ -109,7 +109,9 @@ app root, and they are versioned for automatic migrations, and this is what they
     entity "Author" do
       float :fee
       string :name, optional: false
-      has_many :articles
+
+      # Deleting an author will delete all associated articles
+      has_many :articles, deletionRule: "Cascade"
     end
 
   end
@@ -213,6 +215,8 @@ all the data over to your main context all at once.  CDQ makes that easy too:
   cdq.save
 ```
 
+CDQ will automatically set the object's property `created_at` to `Time.now` if it exists. If you want to use this ActiveRecord-like automatic attribute, make sure to add `datetime :created_at` to your schema's model definition.
+
 ### Reading
 
 ```ruby
@@ -229,8 +233,34 @@ all the data over to your main context all at once.  CDQ makes that easy too:
   cdq.save
 ```
 
+You can also update multiple attributes of a single object:
+
+```ruby
+  author = Author.first
+  author.update(name: "Mark Twain", publish_count: 30, first_published: 1865)
+  cdq.save
+```
+
+The update command will raise an `UnknownAttributeError` if you try and set an attribute that doesn't exist on the object so it's good practice to sanitize the data before you call `update`:
+
+```ruby
+  new_author_data = {
+    name: "Mark Twain",
+    publish_count: 30,
+    first_published: 1865,
+    some_attribute_that_doesnt_exist_on_author: "balderdash!"
+  }  
+  sanitized = new_author_data.keep_if{|k,_| Author.attribute_names.include?(k) }
+
+  author = Author.first
+  author.update(sanitized)
+  cdq.save
+```
+
 **NOTE** Custom class methods will have to `include CDQ` in order to have access to the `cdq` object. If you're calling `cdq` from a class method, you also have to `extend CDQ`.
 
+CDQ will automatically set the object's property `updated_at` to `Time.now` if it exists. If you want to use this ActiveRecord-like automatic attribute, make sure to add `datetime :updated_at` to your schema's model definition.
+
 ### Deleting
 ```ruby
   author = Author.first
@@ -382,8 +412,71 @@ defining and using named scopes:
 query generator for an entity, but `cdq(:attribute)` starts a predicate for an
 attribute.
 
+## Reserved model attributes
+
+CDQ does some smart automatic attribute setting. If you add attributes `:created_at` and/or `:updated_at` to a model in your schema file, whenever a record is created or updated, these properties will be updated accordingly. Therefore, you can not define your own `:created_at` or `:updated_at` model attributes. These attributes must be of type `datetime`. Note that these attributes aren't set until you call `cdq.save`
+
+Example:
+
+```ruby
+schema "0001 initial" do
+  entity "Author" do
+    string :name, optional: false
+
+    datetime :created_at
+    datetime :updated_at
+  end
+end
+```
+
+```ruby
+a = Author.create(name: "Le Guin")
+# Notice that the properties aren't set yet
+#
+# <Author: 0x1175f9540> (entity: Author; id: 0x117504810
+# <x-coredata:///Author/tA4E22210-72CF-4272-BF2C-0C5C63A55B072> ; data: {
+#     name: "Le Guin";
+#     created_at: nil;
+#     updated_at: nil;
+# })
+
+cdq.save
+
+puts a # Original reference to created Author object
+# <Author: 0x1175f9540> (entity: Author; id: 0x117504810
+# <x-coredata:///Author/tA4E22210-72CF-4272-BF2C-0C5C63A55B072> ; data: {
+#     name: "Le Guin";
+#     created_at: 2015-08-19 20:44:40 +0000;
+#     updated_at: 2015-08-19 20:44:40 +0000;
+# })
+
+a.name = "Some Other Guy"
+puts a
+# Note that nothing has changed except the name:
+#
+# <Author: 0x1175f9540> (entity: Author; id: 0x117504810
+# <x-coredata:///Author/tA4E22210-72CF-4272-BF2C-0C5C63A55B072> ; data: {
+#     name: "Some Other Guy";
+#     created_at: 2015-08-19 20:44:40 +0000;
+#     updated_at: 2015-08-19 20:44:40 +0000;
+# })
+
+cdq.save
+puts a
+# <Author: 0x1175f9540> (entity: Author; id: 0x117504810
+# <x-coredata:///Author/tA4E22210-72CF-4272-BF2C-0C5C63A55B072> ; data: {
+#     name: "Some Other Guy";
+#     created_at: 2015-08-19 20:44:40 +0000;
+#     updated_at: 2015-08-19 20:47:40 +0000;
+# })
+```
+
+Also note that you should never use `object_id` as a model attribute as it will conflict with an internally generated property.
+
 ## iCloud
 
+**Removed as of version 2.0.0.  If you still need this, pin cdq gem to before version 2.0.0**
+
 As of version 0.1.10, there is some experimental support for iCloud, written by
 @katsuyoshi.  Please try it out and let us know how it's working for you.  To
 enable, initialize like this:
@@ -415,3 +508,7 @@ $ rake args='-com.apple.CoreData.SQLDebug 3'
 ```
 
 `com.apple.CoreData.SQLDebug` takes a value between 1 and 3; the higher the value, the more verbose the output.
+
+## Premium Support
+
+[CDQ](https://github.com/infinitered/cdq), as an open source project, is free to use and always will be. [Infinite Red](https://infinite.red/) offers premium CDQ support and general mobile app design/development services. Email us at [hello@infinite.red](mailto:hello@infinite.red) to get in touch with us for more details.

data/lib/cdq/version.rb

@@ -1,4 +1,4 @@
 
 module CDQ
-  VERSION = '1.0.8'
+  VERSION = '2.0.0'
 end

data/motion/cdq/config.rb

@@ -1,6 +1,5 @@
 module CDQ
 
-
   # = Configure the CDQ Stack
   #
   # This class wraps the YAML configuration file that will allow you to
@@ -14,8 +13,6 @@ module CDQ
   #   [model_name]                The root name for the model file (relative to the bundle directory)
   #   [app_group_id]              The app group id set in iTunes member center (group.com.mycompany.myapp)
   #   [app_group_container_uuid]  WORKAROUND: The app group's UUID for iOS Simulator 8.1 which doesn't return an app group container path from the id
-  #   [icloud]                    If it's true, CDQ works with iCloud.
-  #   [icloud_container]          Set id of iCloud container if you use iCloud. If it's nil, use first container listed in the com.apple.developer.ubiquity-container-identifiers entitlement array.
   #
   # Using the config file is not necessary.  If you do not include it, the bundle display name
   # will be used.  For most people with a new app, this is what you want to do, especially if
@@ -26,7 +23,7 @@ module CDQ
   #
   class CDQConfig
 
-    attr_reader :config_file, :database_name, :database_dir, :model_name, :name, :icloud, :icloud_container, :app_group_id, :app_group_container_uuid
+    attr_reader :config_file, :database_name, :database_dir, :model_name, :name, :app_group_id, :app_group_container_uuid
 
     def initialize(config_file)
       h = nil
@@ -50,15 +47,6 @@ module CDQ
       @model_name = h['model_name'] || h[:model_name] || name
       @app_group_id = h['app_group_id'] || h[:app_group_id]
       @app_group_container_uuid = h['app_group_container_uuid'] || h[:app_group_container_uuid]
-      @icloud = begin
-        case h['icloud'] || h[:icloud]
-        when true, 1
-          true
-        else
-          false
-        end
-      end
-      @icloud_container = h['icloud_container'] || h[:icloud_container]
     end
     
     def database_url

data/motion/cdq/context.rb

@@ -76,18 +76,6 @@ module CDQ
       self.stack = []
     end
 
-    # Create and push a new context with the specified concurrency type.  Its parent
-    # will be set to the previous head context.  If a block is supplied, the new context
-    # will exist for the duration of the block and then the previous state will be restore_managerd.
-    #
-    # REMOVE1.1
-    #
-    def new(concurrency_type, &block)
-      deprecate "cdq.contexts.new() is deprecated.  Use push() or create()"
-      context = create(concurrency_type)
-      push(context, {}, &block)
-    end
-
     # Create a new context by type, setting upstream to the topmost context if available,
     # or to the persistent store coordinator if not.  Return the context but do NOT push it
     # onto the stack.

data/motion/cdq/store.rb

@@ -15,8 +15,6 @@ module CDQ
     def new(opts = {})
       @config = opts[:config] || CDQConfig.default
       @model_manager = opts[:model_manager] || CDQ.cdq.models
-      @icloud = opts[:icloud] || opts[:iCloud] || @config.icloud
-      @icloud_container = @config.icloud_container
     end
 
     def current
@@ -24,7 +22,10 @@ module CDQ
     end
 
     def reset!
+      path = @config.database_url.absoluteString
       NSFileManager.defaultManager.removeItemAtURL(@config.database_url, error: nil)
+      NSFileManager.defaultManager.removeItemAtURL(NSURL.URLWithString("#{path}-shm"), error: nil)
+      NSFileManager.defaultManager.removeItemAtURL(NSURL.URLWithString("#{path}-wal"), error: nil)
     end
 
     def invalid?
@@ -37,72 +38,10 @@ module CDQ
       if invalid?
         raise "No model found.  Can't create a persistent store coordinator without it."
       else
-        if @icloud
-          create_icloud_store
-        else
-          create_local_store
-        end
+        create_local_store
       end
     end
 
-    def create_icloud_store
-      coordinator = NSPersistentStoreCoordinator.alloc.initWithManagedObjectModel(@model_manager.current)
-
-      Dispatch::Queue.concurrent.async {
-        # get icloud first container
-        url = @config.database_url
-        icloud_url = NSFileManager.defaultManager.URLForUbiquityContainerIdentifier(@icloud_container)
-        if icloud_url
-          error = Pointer.new(:object)
-          icloud_url = icloud_url.URLByAppendingPathComponent("data")
-          error = Pointer.new(:object)
-          options = { NSMigratePersistentStoresAutomaticallyOption => true,
-                      NSInferMappingModelAutomaticallyOption => true,
-                      NSPersistentStoreUbiquitousContentNameKey => url.path.lastPathComponent.gsub(".", "_"),
-                      NSPersistentStoreUbiquitousContentURLKey => icloud_url,
-                    }
-          coordinator.lock
-          store = coordinator.addPersistentStoreWithType(NSSQLiteStoreType,
-                                                     configuration:nil,
-                                                     URL:url,
-                                                     options:options,
-                                                     error:error)
-          coordinator.unlock
-
-          if store.nil?
-            error[0].userInfo['metadata'] && error[0].userInfo['metadata'].each do |key, value|
-              NSLog "#{key}: #{value}"
-            end
-            raise error[0].userInfo['reason']
-          end
-
-        else
-          error = Pointer.new(:object)
-          options = { NSMigratePersistentStoresAutomaticallyOption => true,
-                      NSInferMappingModelAutomaticallyOption => true }
-          url = @config.database_url
-          mkdir_p File.dirname(url.path)
-          store = coordinator.addPersistentStoreWithType(NSSQLiteStoreType,
-                                                         configuration:nil,
-                                                         URL:url,
-                                                         options:options,
-                                                         error:error)
-          if store.nil?
-            error[0].userInfo['metadata'] && error[0].userInfo['metadata'].each do |key, value|
-              NSLog "#{key}: #{value}"
-            end
-            raise error[0].userInfo['reason']
-          end
-        end
-        Dispatch::Queue.main.after(0) {
-          # This block is executed in a next run loop.
-          # So the managed object context has a store coordinator in this point.
-          NSNotificationCenter.defaultCenter.postNotificationName(STORE_DID_INITIALIZE_NOTIFICATION, object:coordinator)
-        }
-      }
-      coordinator
-    end
-
     def create_local_store
       coordinator = NSPersistentStoreCoordinator.alloc.initWithManagedObjectModel(@model_manager.current)
       error = Pointer.new(:object)

data/motion/managed_object.rb

@@ -99,6 +99,16 @@ class CDQManagedObject < CoreDataQueryManagedObjectBase
 
   end
 
+  def update(args)
+    args.each do |k,v|
+      if respond_to?("#{k}=")
+        self.send("#{k}=", v)
+      else
+        raise UnknownAttributeError.new("#{self.class} does not respond to `#{k}=`")
+      end
+    end if args.is_a?(Hash)
+  end
+
   # Register this object for destruction with the current context.  Will not
   # actually be removed until the context is saved.
   #
@@ -211,3 +221,5 @@ class CDQManagedObject < CoreDataQueryManagedObjectBase
   end
 
 end
+
+class UnknownAttributeError < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdq
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - infinitered
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-xcdm
@@ -29,16 +29,16 @@ dependencies:
   name: motion-yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
 description: Core Data Query for RubyMotion
 email:
 - ken@infinitered.com
@@ -93,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A streamlined library for working with Core Data outside XCode