motion-addressbook 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a59a907d0d36c0d0686a4b6455df055b334c54d
-  data.tar.gz: f5e42916903f43b8c06b80d759d1f31771434db8
+  metadata.gz: 062e2ed0b9018682964f43fcaf0711c7c9147cc6
+  data.tar.gz: ac3392b93c651c531dd6f506ffc9e6d5c1f272fb
 SHA512:
-  metadata.gz: 3bb1564f7250614c5d5c9e1413b514661860ff89460fa11f1aa1fddbb11f815ee3d967c95d971ac9f4a7bb396d35f0be43483cf0c9411186eb2762b6836c122a
-  data.tar.gz: 13cb80adb5b232de7e6d2aa355b1754252d06d64c0d74cff0a53bde0ca9d7385b8a1853e5085921d3f7a67da234af25dd022a5352268c7c3d4e362cdab5b5959
+  metadata.gz: fe803b3bf9eeae54d44b33ce8bd8f1c9016ca5ce62ba36c47a15da3b2fa0a09cca2141e7314c10b756a0a42afa0fbd9b64df8cf5b3b523963858de94721ef85a
+  data.tar.gz: 0e3dd574fd3eb184f6408843613315816095cb69f4653465d056f29d0c8ae2d128c03eb782fbfe516d7eb9b4f616fc270971927914d61df16e6b942d362980ec

data/README.md

@@ -175,6 +175,15 @@ alex.job_title = 'RubyMotion Developer'
 alex.save
 ```
 
+Or to alter all the attributes at once (preserve the record identifier
+but change some or all of the values):
+
+```ruby
+alex = AddressBook::Person.find_by_email('alex@example.com')
+alex.replace({:first_name=>"Alex", :last_name=>"Rider", ...})
+alex.save
+```
+
 ### Contact Groups
 
 ```ruby
@@ -186,6 +195,27 @@ g.members
 => [#<AddressBook::Person:2: {:first_name=>"Daniel", :last_name=>"Higgins", ...}>]
 ```
 
+### Notifications (\* iOS only \*)
+
+The iOS Address Book does not deliver notifications of changes through
+the standard Notification Center. `motion-addressbook` wraps the
+framework `ABAddressBookRegisterExternalChangeCallback` call with an
+optional handler that converts the update event to an iOS
+notification.
+
+```ruby
+ab.observe!
+
+App.notification_center.observe :addressbook_updated do |notification|
+  NSLog "Address Book was changed!"
+end
+```
+
+The notification must be explicitly enabled in your application. In
+some cases iOS appears to trigger multiple notifications for the same
+change event, and if you are doing many changes at once you will
+receive a long stream of notifications.
+
 ## Contributing
 
 1. Fork it

data/lib/motion-addressbook/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module Addressbook
-    VERSION = "1.6.3"
+    VERSION = "1.7.0"
   end
 end

data/motion-addressbook.gemspec

@@ -4,6 +4,7 @@ require File.expand_path('../lib/motion-addressbook/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.name          = "motion-addressbook"
   gem.version       = Motion::Addressbook::VERSION
+  gem.license       = 'MIT'
 
   gem.authors       = ["Alex Rothenberg", "Jason May"]
   gem.email         = ["alex@alexrothenberg.com", "jmay@pobox.com"]

data/motion/address_book.rb

@@ -13,9 +13,14 @@ module AddressBook
     end
   end
 
+  def instance
+    @instance ||= AddrBook.new
+  end
+
   def count
     if App.ios?
-      ABAddressBookGetPersonCount(address_book)
+      # ABAddressBookGetPersonCount(address_book)
+      instance.count
     else
       address_book.count
     end

data/motion/address_book/ios/addr_book.rb

@@ -28,6 +28,14 @@ module AddressBook
     def activate!
       @ab = LiveAddrBook.new(AddressBook.address_book)
     end
+
+    def observe!
+      @notifier = Proc.new do |ab_instance, always_nil, context|
+        App.notification_center.post :addressbook_updated, self
+      end
+      ab.register_callback(@notifier)
+    end
+
     def authorized?
       AddressBook.authorized?
     end
@@ -143,8 +151,8 @@ module AddressBook
     def sources
       ABAddressBookCopyArrayOfAllSources(ab)
     end
-    def register_callback(callback, context)
-      ABAddressBookRegisterExternalChangeCallback(ab, callback, context)
+    def register_callback(callback)
+      ABAddressBookRegisterExternalChangeCallback(ab, callback, nil)
     end
   end
 end

data/motion/address_book/osx/addr_book.rb

@@ -4,6 +4,7 @@ module AddressBook
 
     def initialize
       @ab = ABAddressBook.addressBook
+      yield self if block_given?
     end
     def people(opts = {})
       if opts[:local]
@@ -58,9 +59,9 @@ module AddressBook
       end
     end
 
-    def notify_changes(callback, context)
+    def observe!
       App.notification_center.observe KABDatabaseChangedExternallyNotification do |notification|
-        callback.call(context)
+        App.notification_center.post :addressbook_updated, self
       end
     end
 

data/spec/ios/address_book/person_spec.rb

@@ -18,12 +18,12 @@ describe AddressBook::Person do
         @alex.should.not.exists?
       end
       it 'should have initial values' do
-        @alex.first_name.should == 'Alex'
+        @alex.first_name.should.equal 'Alex'
         @alex.last_name.should  == 'Testy'
-        @alex.email_values.should == [@data[:emails][0][:value]]
+        @alex.email_values.should.equal [@data[:emails][0][:value]]
       end
       it 'should have a composite name' do
-        @alex.composite_name.should == 'Alex Testy'
+        @alex.composite_name.should.equal 'Alex Testy'
       end
     end
 
@@ -39,9 +39,9 @@ describe AddressBook::Person do
         it 'should find match' do
           @alex.uid.should.not.be.nil
           alex = AddressBook::Person.find_by_uid @alex.uid
-          alex.uid.should == @alex.uid
+          alex.uid.should.equal @alex.uid
           alex.email_values.should.include? @email
-          alex.first_name.should == 'Alex'
+          alex.first_name.should.equal 'Alex'
           alex.last_name.should  == 'Testy'
         end
       end
@@ -52,13 +52,13 @@ describe AddressBook::Person do
           alexes.each do |alex|
             alex.uid.should != nil
             alex.email_values.should.include? @email
-            alex.first_name.should == 'Alex'
+            alex.first_name.should.equal 'Alex'
             alex.last_name.should  == 'Testy'
           end
         end
         it 'should give empty list when nothing matches' do
           alexes = AddressBook::Person.find_all_by_email unique_email
-          alexes.should == []
+          alexes.should.equal []
         end
       end
       describe '.find_by_email' do
@@ -66,7 +66,7 @@ describe AddressBook::Person do
           alex = AddressBook::Person.find_by_email @email
           alex.uid.should.not.be.nil
           alex.email_values.should.include? @email
-          alex.first_name.should == 'Alex'
+          alex.first_name.should.equal 'Alex'
           alex.last_name.should  == 'Testy'
         end
         it 'should give empty list when nothing matches' do
@@ -81,13 +81,13 @@ describe AddressBook::Person do
           alexes.each do |alex|
             alex.uid.should != nil
             alex.email_values.should.include? @email
-            alex.first_name.should == 'Alex'
+            alex.first_name.should.equal 'Alex'
             alex.last_name.should  == 'Testy'
           end
         end
         it 'should give empty list when nothing matches' do
           alexes = AddressBook::Person.where(:email => unique_email)
-          alexes.should == []
+          alexes.should.equal []
         end
       end
 
@@ -102,7 +102,7 @@ describe AddressBook::Person do
         it 'should get bigger when we create another' do
           initial_people_count = AddressBook::Person.all.size
           @person = AddressBook::Person.create({:first_name => 'Alex2', :last_name=>'Rothenberg2'})
-          AddressBook::Person.all.size.should == (initial_people_count + 1)
+          AddressBook::Person.all.size.should.equal (initial_people_count + 1)
           @person.delete!
         end
       end
@@ -121,17 +121,17 @@ describe AddressBook::Person do
         alex = AddressBook::Person.find_or_new_by_email(@email)
         alex.should.not.be.new_record
         alex.uid.should != nil
-        alex.first_name.should == 'Alex'
+        alex.first_name.should.equal 'Alex'
         alex.last_name.should  == 'Testy'
-        alex.emails.attributes.map{|r| r[:value]}.should == [@email]
+        alex.emails.attributes.map{|r| r[:value]}.should.equal [@email]
       end
       it 'should return new person when no match found' do
         never_before_used_email = unique_email
         new_person = AddressBook::Person.find_or_new_by_email(never_before_used_email)
         new_person.should.be.new_record
         new_person.should.not.exists
-        new_person.email_values.should == [never_before_used_email]
-        new_person.first_name.should == nil
+        new_person.email_values.should.equal [never_before_used_email]
+        new_person.first_name.should.equal nil
       end
     end
   end
@@ -284,7 +284,7 @@ describe AddressBook::Person do
         end
 
         it 'should have a composite name' do
-          @ab_person.composite_name.should == 'Mr. Alex Q. Testy III'
+          @ab_person.composite_name.should.equal 'Mr. Alex Q. Testy III'
         end
 
         it 'should be able to count the emails' do
@@ -325,8 +325,8 @@ describe AddressBook::Person do
       it 'should know it is not new' do
         @ab_person.should.not.be.new_record
         @ab_person.should.be.exists
-        @ab_person.first_name.should == 'Alex'
-        @ab_person.department.should == 'Development'
+        @ab_person.first_name.should.equal 'Alex'
+        @ab_person.department.should.equal 'Development'
       end
 
       it 'should not change ID' do
@@ -341,7 +341,7 @@ describe AddressBook::Person do
 
         it 'should be able to get each of the single value fields' do
           @match = AddressBook::Person.find_by_email(@ab_person.email_values.first)
-          @match.first_name.should == 'New First Name'
+          @match.first_name.should.equal 'New First Name'
           @match.uid.should.equal @ab_person.uid
         end
       end
@@ -494,4 +494,26 @@ describe AddressBook::Person do
       ordered.should.equal [@p1, @p2, @p4, @p5, @p3]
     end
   end
+
+  describe "notifications" do
+    before do
+      @ab1 = AddressBook::AddrBook.new
+      @ab2 = AddressBook::AddrBook.new
+      @ab1.observe!
+      @ab2.observe!
+      @notifications = 0
+      App.notification_center.observe :addressbook_updated do |notification|
+        @notifications += 1
+      end
+
+      @alice = @ab2.create_person({first_name: 'Alice'})
+      @bob = @ab1.create_person({first_name: 'Bob'})
+      @alice.delete!
+      @bob.delete!
+    end
+
+    it "should be notified of every change" do
+      @notifications.should.equal 4
+    end
+  end
 end

data/spec/ios/helpers/spec_helper.rb

@@ -2,6 +2,15 @@
 # instance from destruction when the spec suite runs. Specifically,
 # the contents of the iOS Address Book, which is global to all
 # applications.
+#
+# WARNING: Altering the simulator configuration at runtime is a risky
+# practice. If we use `Kernel.system` instead of backquotes when
+# invoking `mv` and `rm` below, the simulator throws a warning:
+#
+#    The iOS Simulator libSystem was initialized out of order.  This
+#    is most often caused by running host executables or inserting
+#    host dylibs.  In the future, this will cause an abort.
+#
 
 SIMULATOR_ROOT = "#{ENV['HOME']}/../.."
 AB_PATH = SIMULATOR_ROOT + "/Library/AddressBook"
@@ -12,21 +21,28 @@ def protect_existing_address_book
   # iOS layer protects them, but shelling out is still allowed so we
   # can alter the world that way.
 
-  unless AddressBook.authorized?
-    warn "BLOCKING FOR AUTHORIZATION"
-    AddressBook.request_authorization
-  end
-
   warn "PROTECTING EXISTING ADDRESS BOOK IN SIMULATOR"
 
-  `mv \"#{AB_PATH}\" "#{AB_PATH_BAK}"`
+  `rm -rf \"#{AB_PATH_BAK}\"`
+  `mv \"#{AB_PATH}\" \"#{AB_PATH_BAK}\"`
+  # Kernel.system "rm -rf \"#{AB_PATH_BAK}\""
+  # Kernel.system "mv \"#{AB_PATH}\" \"#{AB_PATH_BAK}\""
 end
 
 at_exit do
   warn "RESTORING ORIGINAL ADDRESS BOOK IN SIMULATOR"
 
-  `rm -rf \"#{AB_PATH}\"`
-  `mv \"#{AB_PATH_BAK}\" "#{AB_PATH}"`
+  Kernel.system "rm -rf \"#{AB_PATH}\""
+  Kernel.system "mv \"#{AB_PATH_BAK}\" \"#{AB_PATH}\""
+end
+
+def wait_for_authorization
+  @semaphore = Dispatch::Semaphore.new(0)
+  AddressBook::AddrBook.new do
+    @semaphore.signal
+  end
+  @semaphore.wait
 end
 
 protect_existing_address_book
+wait_for_authorization

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-addressbook
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Alex Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -95,7 +95,8 @@ files:
 - spec/osx/helpers/hacks.rb
 - spec/osx/helpers/person_helpers.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A RubyMotion wrapper around the iOS & OSX Address Book frameworks