motion-addressbook 0.0.1 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    motion-addressbook (0.0.1)
+    motion-addressbook (0.1.0)
       bubble-wrap
 
 GEM

data/README.md

@@ -20,36 +20,68 @@ Or install it yourself as:
 
 ## Usage
 
-### List all people
+### Instantiating a person object
+
+There are 3 ways to instantiate a person object
+
+### To get a new person not yet connected to the iOS Address Book
 
 ```ruby
-    AddressBook::Person.all
-    # => [#<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>,
-    #     #<AddressBook::Person:0x6d550a0 @attributes={:first_name=>"Laurent", :last_name=>"Sansonetti", :job_title=>nil, :department=>nil, :organization=>"HipByte"} @ab_person=#<__NSCFType:0x6df97d0>>]
+AddressBook::Person.new
+# => #<AddressBook::Person:0x8c67ca0 @attributes={:first_name=>nil, :last_name=>nil, :job_title=>nil, :department=>nil, :organization=>nil} @new_record=true @ab_person=#<__NSCFType:0x6d832e0>>
 ```
 
+### To get a list of existing people from the iOS Address Book
 
-### Create a new Contact and save in Contacts app
+Get all people with `.all`
+
+```ruby
+AddressBook::Person.all
+# => [#<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>,
+#     #<AddressBook::Person:0x6d550a0 @attributes={:first_name=>"Laurent", :last_name=>"Sansonetti", :job_title=>nil, :department=>nil, :organization=>"HipByte"} @ab_person=#<__NSCFType:0x6df97d0>>]
+```
+
+Get a list of all people matching one attribute with `.find_all_by_XXX`
+
+```ruby
+AddressBook::Person.find_all_by_email('alex@example.com')
+# => [#<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>]
+```
+
+Get the first person matching one attribute with `find_by_XXX`
+
+```ruby
+AddressBook::Person.find_by_email('alex@example.com')
+# => #<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>
+```
+
+Get a list of all people matching several attributes with `.where`
 
 ```ruby
-    alex = AddressBook::Person.new(:first_name => 'Alex', :last_name => 'Rothenberg', :email => 'alex@example.com')
-    alex.save
+AddressBook::Person.where(:email => 'alex@example.com', :first_name => 'Alex')
+# => [#<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>]
 ```
 
-### Get an existing Contact
+To look for an existing person or get a new one if none is found `find_or_new_by_XXX`
+
+```ruby
+AddressBook::Person.find_or_new_by_email('alex@example.com')
+# => #<AddressBook::Person:0xe4e3a80 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0xe4bbef0>>
+```
+
+### Create a new Contact and save in Contacts app
 
 ```ruby
-    alex = AddressBook::Person.new(:first_name => 'Alex', :email => 'alex@example.com')
-    alex.last_name
-    # => 'Rothenberg'
+AddressBook::Person.create(:first_name => 'Alex', :last_name => 'Rothenberg', :email => 'alex@example.com')
+# => #<AddressBook::Person:0xe4e3a80 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0xe4bbef0>>
 ```
 
 ### Update existing contact
 
 ```ruby
-    alex = AddressBook::Person.new(:first_name => 'Alex', :email => 'alex@example.com')
-    alex.job_title = 'RubyMotion Developer'
-    alex.save
+alex = AddressBook::Person.find_by_email('alex@example.com')
+alex.job_title = 'RubyMotion Developer'
+alex.save
 ```
 
 ## Contributing

data/lib/motion-addressbook/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module Addressbook
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/motion/address_book/multi_value.rb

@@ -1,12 +1,12 @@
 module AddressBook
   class MultiValue
     attr_reader :multivalueIdentifier, :ab_multi_values
-    
+
     def initialize(ab_multi_values=nil)
       @ab_multi_values = ab_multi_values ? ABMultiValueCreateMutableCopy(ab_multi_values) : ABMultiValueCreateMutable(KABMultiStringPropertyType)
       # @ab_multi_values = ABMultiValueCreateMutable(KABMultiStringPropertyType)
     end
-    
+
     def set(ab_label, value)
       return if values.include? value  #temp because blank? not working
       if blank?(ab_label)
@@ -22,25 +22,25 @@ module AddressBook
         set(ab_label, value)
       end
     end
-    
+
     def values
       ABMultiValueCopyArrayOfAllValues(@ab_multi_values) || []
     end
-    
+
     def include? value
       return false if values.nil?
       values.include? value
     end
-    
+
     private
     def blank?(ab_label)
       index_for(ab_label) == -1
     end
-      
+
     def index_for(ab_label)
       return -1 # Keep getting this error :(  <ArgumentError: invalid value for Integer: "_$!<Work>!$_">
       # ABMultiValueGetIndexForIdentifier(@ab_multi_values, ab_label)
     end
-      
+
   end
 end

data/motion/address_book/person.rb

@@ -2,9 +2,15 @@ module AddressBook
   class Person
     attr_reader :attributes, :error, :ab_person
 
-    def initialize(attributes, ab_person = nil)
+    def initialize(attributes={}, ab_person = nil)
       @attributes = attributes
-      load_ab_person(ab_person)
+      if ab_person.nil?
+        @new_record = true
+      else
+        @ab_person = ab_person
+        load_ab_person
+        @new_record = false
+      end
     end
 
     def self.all
@@ -24,9 +30,22 @@ module AddressBook
       ABAddressBookAddRecord(address_book, ab_person, error)
       ABAddressBookSave(address_book, error )
       @address_book = nil #force refresh
+      @new_record = false
+    end
+    
+    def self.where(conditions)
+      all.select do |person|
+        person.meets? conditions
+      end
+    end
+    
+    def meets?(conditions)
+      conditions.keys.all? do |attribute|
+        send(attribute) == conditions[attribute]
+      end
     end
 
-    def attribute_map
+    def self.attribute_map
       { :first_name   => KABPersonFirstNameProperty,
         :last_name    => KABPersonLastNameProperty,
         :job_title    => KABPersonJobTitleProperty,
@@ -34,22 +53,95 @@ module AddressBook
         :organization => KABPersonOrganizationProperty
       }
     end
+    def attribute_map
+      self.class.attribute_map
+    end
 
     def method_missing(name, *args)
-      name.to_s =~ /^(\w*)(=?)$/
-      attribute_name = $1.to_sym unless $1.nil?
-      if attribute_map.include? attribute_name
-        if $2 == '='
-          set_field(attribute_map[attribute_name], args.first)
-          attributes[attribute_name] = args.first
-        else
-          attributes[attribute_name] ||= get_field(attribute_map[attribute_name])
-        end
+      if attribute_name = getter?(name)
+        get(attribute_name)
+      elsif attribute_name = setter?(name)
+        set(attribute_name, args.first)
       else
         super
       end
     end
 
+    def self.method_missing(name, *args)
+      if attribute_name = all_finder?(name)
+        find_all_by(attribute_name, args.first)
+      elsif attribute_name = first_finder?(name)
+        find_by(attribute_name, args.first)
+      elsif attribute_name = finder_or_new?(name)
+        find_or_new_by(attribute_name, args.first)
+      else
+        super
+      end
+    end    
+    def self.is_attribute?(attribute_name)
+      return false if attribute_name.nil?
+      attribute_map.include?(attribute_name.to_sym) || [:email, :phone_number].include?( attribute_name.to_sym)
+    end
+    
+    def getter?(method_name)
+      if self.class.is_attribute? method_name
+        method_name
+      else
+        nil
+      end
+    end
+    def setter?(method_name)
+      method_name.to_s =~ /^(\w*)=$/
+      if self.class.is_attribute? $1
+        $1
+      else
+        nil
+      end
+    end
+    def self.all_finder?(method_name)
+      method_name.to_s =~ /^find_all_by_(\w*)$/
+      if is_attribute? $1
+        $1
+      else
+        nil
+      end
+    end
+    def self.first_finder?(method_name)
+      method_name.to_s =~ /^find_by_(\w*)$/
+      if is_attribute? $1
+        $1
+      else
+        nil
+      end
+    end
+    def self.finder_or_new?(method_name)
+      method_name.to_s =~ /^find_or_new_by_(\w*)$/
+      if is_attribute? $1
+        $1
+      else
+        nil
+      end
+    end
+    
+    def get(attribute_name)
+      attributes[attribute_name.to_sym] ||= get_field(attribute_map[attribute_name])
+    end
+    
+    def set(attribute_name, value)
+      set_field(attribute_map[attribute_name.to_sym], value)
+      attributes[attribute_name.to_sym] = value
+    end
+    
+    def self.find_all_by(attribute_name, criteria)
+      where({attribute_name.to_sym => criteria})
+    end
+    def self.find_by(attribute_name, criteria)
+      find_all_by(attribute_name, criteria).first
+    end
+    def self.find_or_new_by(attribute_name, criteria)
+      find_by(attribute_name, criteria) || new({attribute_name.to_sym => criteria})
+    end
+      
     def photo
       ABPersonCopyImageData(ab_person)
     end
@@ -74,11 +166,18 @@ module AddressBook
     def email_values
       emails.values
     end
+    
+    # UGH - kinda arbitrary way to deal with multiple values.  DO SOMETHING BETTER.
+    def email
+      @attributes[:email] ||= email_values.first
+    end
+    def phone_number
+      @attributes[:phone_number] ||= phone_number_values.first
+    end
 
     # private
 
-    def load_ab_person(ab_person = nil)
-      @ab_person = ab_person || find_or_new
+    def load_ab_person
       set_field(KABPersonFirstNameProperty,    attributes[:first_name  ]) unless attributes[:first_name  ].nil?
       set_field(KABPersonLastNameProperty,     attributes[:last_name   ]) unless attributes[:last_name   ].nil?
       set_field(KABPersonJobTitleProperty,     attributes[:job_title   ]) unless attributes[:job_title   ].nil?
@@ -104,16 +203,32 @@ module AddressBook
       MultiValue.new(ABRecordCopyValue(ab_person, field))
     end
 
+    def ab_person
+      if @ab_person.nil?
+        @ab_person = new_ab_person
+        load_ab_person
+      end
+      @ab_person
+    end
+
     def find_or_new
       if new_record?
-        ab_person = ABPersonCreate()
-        ABAddressBookAddRecord(address_book, ab_person, error )
-        ab_person
+        new_ab_person
       else
         existing_record
       end
     end
 
+    def new_ab_person
+      ab_person = ABPersonCreate()
+      # ABAddressBookAddRecord(address_book, ab_person, error )
+      ab_person
+    end
+    
+    def new_record?
+      !!@new_record
+    end
+
     def existing_records
       potential_matches = ABAddressBookCopyPeopleWithName(address_book, attributes[:first_name])
       potential_matches.select do |record|
@@ -125,9 +240,9 @@ module AddressBook
     def exists?
       !new_record?
     end
-    def new_record?
-      existing_record.nil?
-    end
+    # def new_record?
+    #   existing_record.nil?
+    # end
     def existing_record
       # what if there are more than one match? email should be unique but ...
       existing_records.first

data/spec/address_book/person_spec.rb

@@ -1,4 +1,8 @@
+def unique_email
+  "alex_#{Time.now.to_i}@example.com"
+end
 describe AddressBook::Person do
+
   describe '.all' do
     before do
       @person = AddressBook::Person.create({:first_name => 'Alex', :last_name=>'Rothenberg'})
@@ -7,19 +11,94 @@ describe AddressBook::Person do
       all_names = AddressBook::Person.all.map do |person|
         [person.first_name, person.last_name]
       end
-      all_names.should.include? ['Alex', 'Rothenberg'] 
+      all_names.should.include? ['Alex', 'Rothenberg']
     end
-    
-    it 'should get bigger when we create another' 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)
     end
   end
 
+  describe 'ways of creating and finding people' do
+    describe 'new' do
+      before do
+        @alex = AddressBook::Person.new(:first_name => 'Alex', :last_name => 'Testy', :email => 'alex@example.com')
+      end
+      it 'should create but not save in the address book' do
+        @alex.should.be.new_record
+        @alex.first_name.should == 'Alex'
+        @alex.last_name.should  == 'Testy'
+        @alex.email_values.should     == ['alex@example.com']
+      end
+    end
+
+    describe 'existing' do
+      before do
+        AddressBook::Person.create(:first_name => 'Alex', :last_name => 'Testy', :email => 'alex@example.com')
+      end
+      describe '.find_by_all_email' do
+        it 'should find matches' do
+          alexes = AddressBook::Person.find_all_by_email 'alex@example.com'
+          alexes.should.not.be.empty
+          alexes.each do |alex|
+            alex.email.should == 'alex@example.com'
+          end
+        end
+        it 'should give empty list when nothing matches' do
+          alexes = AddressBook::Person.find_all_by_email unique_email
+          alexes.should == []
+        end
+      end
+      describe '.find_by_email' do
+        it 'should find match' do
+          alex = AddressBook::Person.find_by_email 'alex@example.com'
+          alex.email.should == 'alex@example.com'
+        end
+        it 'should give empty list when nothing matches' do
+          alexes = AddressBook::Person.find_by_email unique_email
+          alexes.should.be.nil
+        end
+      end
+      describe '.where' do
+        it 'should find matches' do
+          alexes = AddressBook::Person.where(:email => 'alex@example.com')
+          alexes.should.not.be.empty
+          alexes.each do |alex|
+            alex.email.should == 'alex@example.com'
+          end
+        end
+        it 'should give empty list when nothing matches' do
+          alexes = AddressBook::Person.where(:email => unique_email)
+          alexes.should == []
+        end
+      end
+    end
+
+  #   describe 'new or existing' do
+  #     before do
+  #       AddressBook::Person.create(:first_name => 'Alex', :last_name => 'Testy', :email => 'alex@example.com')
+  #     end
+  #     it 'should find an existing person' do
+  #       alex = AddressBook::Person.find_or_new_by_email('alex@example.com')
+  #       alex.should.not.be.new_record
+  #       alex.email.should      == 'alex@example.com'
+  #       alex.first_name.should == 'Alex'
+  #       alex.last_name.should  == 'Testy'
+  #     end
+  #     it 'should return new person when no match found' do
+  #       never_before_used_email = unique_email
+  #       alex = AddressBook::Person.find_or_new_by_email(never_before_used_email)
+  #       alex.should.be.new_record
+  #       alex.email.should == never_before_used_email
+  #       alex.first_name.should == nil
+  #     end
+  #   end
+  end
+
   describe 'save' do
     before do
-      unique_email = "alex_#{Time.now.to_i}@example.com"
       @attributes = {:first_name=>'Alex', :last_name=>'Testy',
                      :job_title => 'Developer', :department => 'Development', :organization => 'The Company',
                      :mobile_phone => '123 456 7890', :office_phone => '987 654 3210',
@@ -73,7 +152,6 @@ describe AddressBook::Person do
           @ab_person.photo = data
           UIImagePNGRepresentation(@ab_person.photo).should.equal data
         end
-
       end
 
       it 'should be able to get the phone numbers' do
@@ -100,7 +178,7 @@ describe AddressBook::Person do
         @attributes[:job_title   ] = 'i got promoted'
         @attributes[:office_phone] = '111 222 3333'
         # @attributes[:department  ] = nil
-        @ab_person = AddressBook::Person.new(@attributes)
+        @ab_person = AddressBook::Person.find_or_new_by_email(@attributes[:email])
       end
 
       it 'should know it is not new' do
@@ -110,23 +188,12 @@ describe AddressBook::Person do
       end
 
       describe 'updating' do
-        before do
-          @ab_person.save
-          @new_ab_person = AddressBook::Person.new :first_name=>@attributes[:first_name], :email => @attributes[:email]
-        end
         it 'should be able to get each of the single value fields' do
-          @new_ab_person.first_name.should.equal   @attributes[:first_name  ]
-          @new_ab_person.last_name.should.equal    @attributes[:last_name   ]
-          @new_ab_person.job_title.should.equal    @attributes[:job_title   ]
-          @new_ab_person.department.should.equal   @attributes[:department  ]
-          @new_ab_person.organization.should.equal @attributes[:organization]
-        end
-        it 'should be able to get the phone numbers (we never delete and just add - not sure if this is "right")' do
-          @new_ab_person.phone_number_values.should.equal [@attributes[:mobile_phone], '987 654 3210', @attributes[:office_phone]]
-        end
-
-        it 'should be able to get the emails' do
-          @new_ab_person.email_values.should.equal [@attributes[:email] ]
+          @ab_person.save
+          @new_ab_person = AddressBook::Person.find_by_email @ab_person.email
+          @new_ab_person.first_name = 'New First Name'
+          @new_ab_person.save
+          AddressBook::Person.find_by_email(@ab_person.email).first_name.should == 'New First Name'
         end
       end
 
@@ -134,4 +201,70 @@ describe AddressBook::Person do
 
   end
 
+  describe 'method missing magic' do
+    before do
+      @person = AddressBook::Person.new
+    end
+    describe 'getters' do
+      it 'should have a getter for each attribute' do
+        @person.getter?('first_name'  ).should.be truthy
+        @person.getter?('last_name'   ).should.be truthy
+        @person.getter?('job_title'   ).should.be truthy
+        @person.getter?('department'  ).should.be truthy
+        @person.getter?('organization').should.be truthy
+      end
+      it 'should know what is not a getter' do
+        @person.getter?('nonesense'        ).should.be falsey
+        @person.getter?('first_name='      ).should.be falsey
+        @person.getter?('find_all_by_email').should.be falsey
+        @person.getter?('find_by_email'    ).should.be falsey
+      end
+    end
+    describe 'setters' do
+      it 'should have a setter for each attribute' do
+        @person.setter?('first_name='  ).should.be truthy
+        @person.setter?('last_name='   ).should.be truthy
+        @person.setter?('job_title='   ).should.be truthy
+        @person.setter?('department='  ).should.be truthy
+        @person.setter?('organization=').should.be truthy
+      end
+      it 'should know what is not a setter' do
+        @person.setter?('nonesense='       ).should.be falsey
+        @person.setter?('first_name'       ).should.be falsey
+        @person.setter?('find_all_by_email').should.be falsey
+        @person.setter?('find_by_email'    ).should.be falsey
+      end
+    end
+    describe 'all_finders' do
+      it 'should have a finder for each attribute' do
+        AddressBook::Person.all_finder?('find_all_by_first_name'  ).should.be truthy
+        AddressBook::Person.all_finder?('find_all_by_last_name'   ).should.be truthy
+        AddressBook::Person.all_finder?('find_all_by_job_title'   ).should.be truthy
+        AddressBook::Person.all_finder?('find_all_by_department'  ).should.be truthy
+        AddressBook::Person.all_finder?('find_all_by_organization').should.be truthy
+      end
+      it 'should know what is not a finder' do
+        AddressBook::Person.all_finder?('nonesense'    ).should.be falsey
+        AddressBook::Person.all_finder?('first_name'   ).should.be falsey
+        AddressBook::Person.all_finder?('first_name='  ).should.be falsey
+        AddressBook::Person.all_finder?('find_by_email').should.be falsey
+      end
+    end
+    describe 'first_finders' do
+      it 'should have a finder for each attribute' do
+        AddressBook::Person.first_finder?('find_by_first_name'  ).should.be truthy
+        AddressBook::Person.first_finder?('find_by_last_name'   ).should.be truthy
+        AddressBook::Person.first_finder?('find_by_job_title'   ).should.be truthy
+        AddressBook::Person.first_finder?('find_by_department'  ).should.be truthy
+        AddressBook::Person.first_finder?('find_by_organization').should.be truthy
+      end
+      it 'should know what is not a finder' do
+        AddressBook::Person.first_finder?('nonesense'        ).should.be falsey
+        AddressBook::Person.first_finder?('first_name'       ).should.be falsey
+        AddressBook::Person.first_finder?('first_name='      ).should.be falsey
+        AddressBook::Person.first_finder?('find_all_by_email').should.be falsey
+      end
+    end
+end
+
 end

data/spec/helpers/bacon_matchers.rb

@@ -0,0 +1,11 @@
+# 1.should.be truthy
+# false.should.not.be truthy
+def truthy()
+  lambda { |obj| !!obj }
+end
+
+# 1.should.not.be falsey
+# false.should..be falsey
+def falsey()
+  lambda { |obj| !obj }
+end

data/spec/helpers/person_helpers.rb

@@ -0,0 +1,5 @@
+def unique_email(email='alex@example.com')
+  name, domain = email.split('@')
+  "#{name}_#{Time.now.to_i}@#{domain}"
+end
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-addressbook
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -79,6 +79,8 @@ files:
 - motion/address_book/person.rb
 - spec/address_book/multi_value_spec.rb
 - spec/address_book/person_spec.rb
+- spec/helpers/bacon_matchers.rb
+- spec/helpers/person_helpers.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -93,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4038011897139577156
+      hash: 2222188653506619315
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4038011897139577156
+      hash: 2222188653506619315
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -112,3 +114,5 @@ summary: A RubyMotion wrapper around the iOS Address Book framework
 test_files:
 - spec/address_book/multi_value_spec.rb
 - spec/address_book/person_spec.rb
+- spec/helpers/bacon_matchers.rb
+- spec/helpers/person_helpers.rb