bubble-wrap 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf1fb0a71b37c7e7473219036a4d8304dd7c9fd1
-  data.tar.gz: 1f57a00000623dac2a425cceb6ce5f74ae40eb3e
+  metadata.gz: 77584cd0711e17af5282a0e9f40306916177b6d5
+  data.tar.gz: a12694fd9f1a6e370a9d91f3ed15f3ce74af6469
 SHA512:
-  metadata.gz: e259382ebbc9970d3b264f9a95961807944bb17da2aec89f6af873d4b267e1319d2ac1dfc86cd0a2ef08d205cf9719160a10d7db5bf32c51c8926fdc2f332ec2
-  data.tar.gz: edced4a22d3af5a7f067a08a84176206aa039632adf97b46411582a33f0cd8a6b256f730aecbf73c3a639a51d404d563d163d76973680fecb38b73d661d28c01
+  metadata.gz: e0fa5d162a946c67f83a77b56b84426f42c62770a10a027523cb2ab0e5c0958e9f657ebfb5e5fda060174aaacdc2faaf22e9f6f5b984b8db73a6bf96866495e2
+  data.tar.gz: 18fbc4e01a2091678107341a57d1067d2ec3341dadec26c180baf863cdfb1d034ff69046e04ecd6c5242937ae5ee410b9cf80270d55a30bd8af996be921881ea

data/.travis.yml

@@ -1,12 +1,17 @@
 language: objective-c
 before_install:
-    - (ruby --version)
-    - sudo chown -R travis ~/Library/RubyMotion
-    - mkdir -p ~/Library/RubyMotion/build
-    - sudo motion update
+  - (ruby --version)
+  - sudo chown -R travis ~/Library/RubyMotion
+  - sudo mkdir -p ~/Library/RubyMotion/build
+  - sudo chown -R travis ~/Library/RubyMotion/build
+  - sudo motion update
+gemfile:
+  - Gemfile
 script:
-    - bundle install
-    - bundle exec rake clean
-    - bundle exec rake spec
-    - bundle exec rake clean
-    - bundle exec rake spec osx=true
+  - bundle install --jobs=3 --retry=3
+  - bundle exec rake clean
+  - bundle exec rake spec
+  - bundle exec rake clean
+  - bundle exec rake spec target=7.1
+  - bundle exec rake clean
+  - bundle exec rake spec osx=true

data/CHANGELOG.md

@@ -1,10 +1,29 @@
 ## Unreleased
 
-[Commit history](https://github.com/rubymotion/BubbleWrap/compare/v1.4.0...master)
+[Commit history](https://github.com/rubymotion/BubbleWrap/compare/v1.9.0...master)
+
+## 1.9.0
+
+[Commit history](https://github.com/rubymotion/BubbleWrap/compare/v1.8.0...v1.9.0)
+
+* Add support for `keyboardType` on first input field of `BW::UIAlertView` ([#406](https://github.com/rubymotion/BubbleWrap/pull/406))
+* Implement #+ and #- for NSIndexPath to incr/decr row ([#420](https://github.com/rubymotion/BubbleWrap/pull/420))
+* Extract CoreMotion classes to make it easier to use and more maintainable ([#454](https://github.com/rubymotion/BubbleWrap/pull/454))
+* Motion extract classes ([#454](https://github.com/rubymotion/BubbleWrap/pull/454))
+* Added RSS fields: creator, category, encoded  ([#461](https://github.com/rubymotion/BubbleWrap/pull/461))
+* KVO `observe!` and ability to pass multiple key paths to `observe` ([#460](https://github.com/rubymotion/BubbleWrap/pull/460))
+* `App.short_version` ([#466](https://github.com/rubymotion/BubbleWrap/pull/466))
+* Bump the required version of iOS to >= 7 ([#424](https://github.com/rubymotion/BubbleWrap/pull/424))
+* Bump the required version of iOS to >= 7 ([#424](https://github.com/rubymotion/BubbleWrap/pull/424))
+* Fixes to CoreLocation ([#422](https://github.com/rubymotion/BubbleWrap/pull/422)) & ([#432](https://github.com/rubymotion/BubbleWrap/pull/432))
+* Adds default text option to BW::UIAlertView ([#467](https://github.com/rubymotion/BubbleWrap/pull/467))
+* Bump the minimum required RubyMotion version to `3.12`.
+
+## ... nothing to see here... move along.
 
 ## 1.4.0
 
-[Commit history](https://github.com/rubymotion/BubbleWrap/compare/v1.3.0...master)
+[Commit history](https://github.com/rubymotion/BubbleWrap/compare/v1.3.0...v1.4.0)
 
 * Added `BW::Mail` for sending emails ([#247](https://github.com/rubymotion/BubbleWrap/pull/247))
 * Added `BW::SMS` for sending SMS/iMessages ([#287](https://github.com/rubymotion/BubbleWrap/pull/287))

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    bubble-wrap (1.8.0)
+    bubble-wrap (1.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bacon (1.2.0)
     metaclass (0.0.4)
-    mocha (0.11.4)
+    mocha (0.14.0)
       metaclass (~> 0.0.1)
-    mocha-on-bacon (0.2.1)
-      mocha (>= 0.9.8)
-    rake (10.3.2)
+    mocha-on-bacon (0.2.2)
+      mocha (>= 0.13.0)
+    rake (10.4.2)
     webstub (1.1.2)
 
 PLATFORMS
@@ -25,3 +25,6 @@ DEPENDENCIES
   mocha-on-bacon (~> 0.2)
   rake (~> 10.0)
   webstub (~> 1.1)
+
+BUNDLED WITH
+   1.10.4

data/README.md

@@ -7,6 +7,7 @@ A collection of (tested) helpers and wrappers used to wrap Cocoa Touch and AppKi
 
 [![Code Climate](https://codeclimate.com/github/rubymotion/BubbleWrap.svg)](https://codeclimate.com/github/rubymotion/BubbleWrap)
 [![Build Status](https://travis-ci.org/rubymotion/BubbleWrap.svg?branch=master)](https://travis-ci.org/rubymotion/BubbleWrap)
+[![Gem Version](https://badge.fury.io/rb/bubble-wrap.png)](http://badge.fury.io/rb/bubble-wrap)
 [![Dependency Status](https://gemnasium.com/rubymotion/BubbleWrap.png)](https://gemnasium.com/rubymotion/BubbleWrap)
 
 ## Installation
@@ -26,7 +27,7 @@ require 'bubble-wrap'
 If you using Bundler:
 
 ```ruby
-gem "bubble-wrap", "~> 1.8.0"
+gem "bubble-wrap", "~> 1.9.0"
 ```
 
 BubbleWrap is split into multiple modules so that you can easily choose which parts are included at compile-time.
@@ -79,6 +80,12 @@ If you wish to only include the `SMS` wrapper:
 require 'bubble-wrap/sms'
 ```
 
+If you wish to only include the `Motion` (CoreMotion) wrapper:
+
+```ruby
+require 'bubble-wrap/motion'
+```
+
 If you wish to only include the `NetworkIndicator` wrapper:
 
 ```ruby
@@ -298,6 +305,11 @@ BW::JSON.parse "{\"foo\":1,\"bar\":[1,2,3],\"baz\":\"awesome\"}"
 Helper methods added to give `NSIndexPath` a bit more of a Ruby
 interface.
 
+```ruby
+index_path = table_view.indexPathForCell(cell)
+index_path + 1 # NSIndexPath for next cell in the same section
+=> #<NSIndexPath:0x120db8e0>
+```
 
 ### NSNotificationCenter
 
@@ -376,6 +388,32 @@ class ExampleViewController < UIViewController
 end
 ```
 
+You can remove observers using `unobserve` method.
+
+**Since: > version 1.9.0**
+
+Optionally, multiple key paths can be passed to the `observer` method:
+
+``` ruby
+class ExampleViewController < UIViewController
+  include BW::KVO
+
+  def viewDidLoad
+    @label = UILabel.alloc.initWithFrame [[20,20],[280,44]]
+    @label.text = ""
+    view.addSubview @label
+
+    observe(@label, [:text, :textColor]) do |old_value, new_value, key_path|
+      puts "Hello from viewDidLoad for #{key_path}!"
+    end
+  end
+end
+```
+
+Also you can use `observe!` method to register observer that will immediately
+return initial value. Note that in this case only new value will be passed to
+the block.
+
 
 ### String
 
@@ -416,6 +454,10 @@ BW::Location.get(purpose: 'We need to use your GPS because...') do |result|
   p "To Lat #{result[:to].latitude}, Long #{result[:to].longitude}"
 end
 ```
+*Note: `result[:from]` will return `nil` the first time location services are started.*
+
+The `:previous` key in the `BW::Location.get()` result hash will always return an array of zero or more additional `CLLocation` objects aside from the locations returned from the `:to` and `:from` hash keys.  While in most scenarios this array will be empty, per [Apple's Documentation](https://developer.apple.com/library/IOs/documentation/CoreLocation/Reference/CLLocationManagerDelegate_Protocol/index.html#//apple_ref/occ/intfm/CLLocationManagerDelegate/locationManager:didUpdateLocations:) if there are deferred updates or multiple locations that arrived before they could be delivered, multiple locations will be returned in an order of oldest to newest.
+
 
 ```ruby
 BW::Location.get_compass do |result|
@@ -1210,9 +1252,18 @@ Ow!
 => nil
 ```
 
-# Suggestions?
+# Contributing
 
 Do you have a suggestion for a specific wrapper? Feel free to open an
 issue/ticket and tell us about what you are after. If you have a
 wrapper/helper you are using and are thinking that others might enjoy,
-please send a pull request (with tests if possible).
+please send a pull request with tests. If you need help writing the tests,
+send the pull request anyways and we'll try to help you out with that.
+
+1. Create an issue in GitHub to make sure your PR will be accepted
+2. Fork the BubbleWrap repository
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Write tests for your changes and ensure they pass locally (`bundle exec rake spec && bundle exec rake spec osx=true`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -32,9 +32,15 @@ Motion::Project::App.setup do |app|
       app.spec_files -= Dir.glob("./spec/motion/#{package}/**/*.rb")
     end
   else
+    app.deployment_target = '7.1'
+    app.info_plist['NSLocationAlwaysUsageDescription'] = 'Description'
+    app.info_plist['NSLocationWhenInUseUsageDescription'] = 'Description'
+
     app.spec_files -= Dir.glob("./spec/motion/**/osx/**.rb")
   end
-  app.version = '1.2.3'
+
+  app.version       = '1.2.3'
+  app.short_version = '3.2.1'
 end
 
 namespace :spec do

data/lib/bubble-wrap/camera.rb

@@ -9,4 +9,4 @@ BubbleWrap.require_ios("camera") do
     file('motion/core/device/ios/camera.rb').depends_on ['motion/core/ios/device.rb', 'motion/util/constants.rb']
     file('motion/core/device/ios/screen.rb').depends_on 'motion/core/ios/device.rb'
   end
-end
+end

data/lib/bubble-wrap/core.rb

@@ -10,7 +10,7 @@ BubbleWrap.require('motion/core/device/*.rb')
 BubbleWrap.require_ios do
   BubbleWrap.require('motion/core/ios/**/*.rb')
   BubbleWrap.require('motion/core/device/ios/**/*.rb')
-  
+
   require 'bubble-wrap/camera'
   require 'bubble-wrap/ui'
 end

data/lib/bubble-wrap/font.rb

@@ -1,4 +1,4 @@
 require 'bubble-wrap/loader'
 BubbleWrap.require_ios("font") do
   BubbleWrap.require('motion/font/font.rb')
-end
+end

data/lib/bubble-wrap/loader.rb

@@ -48,13 +48,13 @@ unless defined?(BubbleWrap::LOADER_PRESENT)
 
     def after_config(config)
       BubbleWrap.require_ios do
-        ios7_files = 'motion/ios/7/uiactivity_view_controller_constants.rb'
-        if config.send(:deployment_target).to_f >= 7.0
-          ::BubbleWrap.require(ios7_files)
+        ios8_files = 'motion/ios/8/location_constants.rb'
+        if config.send(:deployment_target).to_f >= 8.0
+          ::BubbleWrap.require(ios8_files)
           before_config(config)
         else
           config.files = config.files.reject {|s|
-            s.include?(ios7_files)
+            s.include?(ios8_files)
           }
         end
       end

data/lib/bubble-wrap/media.rb

@@ -11,4 +11,4 @@ BubbleWrap.require_ios("media") do
     file('motion/media/player.rb').depends_on 'motion/core/string.rb'
     file('motion/media/player.rb').uses_framework('MediaPlayer')
   end
-end
+end

data/lib/bubble-wrap/motion.rb

@@ -5,6 +5,12 @@ BubbleWrap.require_ios('motion') do
   BubbleWrap.require('motion/core/string.rb')
   BubbleWrap.require('motion/motion/**/*.rb') do
     file('motion/motion/motion.rb').depends_on 'motion/util/constants.rb'
+
+    file('motion/motion/accelerometer.rb').depends_on('motion/motion/motion.rb')
+    file('motion/motion/device_motion.rb').depends_on('motion/motion/motion.rb')
+    file('motion/motion/gyroscope.rb').depends_on('motion/motion/motion.rb')
+    file('motion/motion/magnetometer.rb').depends_on('motion/motion/motion.rb')
+
     file('motion/motion/motion.rb').uses_framework('CoreMotion')
   end
-end
+end

data/lib/bubble-wrap/version.rb

@@ -1,4 +1,4 @@
 module BubbleWrap
-  VERSION = '1.8.0' unless defined?(BubbleWrap::VERSION)
-  MIN_MOTION_VERSION = '2.17'
+  VERSION = '1.9.0' unless defined?(BubbleWrap::VERSION)
+  MIN_MOTION_VERSION = '3.12'
 end

data/motion/core/app.rb

@@ -62,6 +62,10 @@ module BubbleWrap
       info_plist['CFBundleVersion']
     end
 
+    def short_version
+      info_plist['CFBundleShortVersionString']
+    end
+
     # @return [NSLocale] locale of user settings
     def current_locale
       languages = NSLocale.preferredLanguages

data/motion/core/device/ios/camera_wrapper.rb

@@ -52,4 +52,4 @@ module BubbleWrap
       end
     end
   end
-end
+end

data/motion/core/device/ios/screen.rb

@@ -78,7 +78,7 @@ module BubbleWrap
       # compensating for screen rotation (which
       # can do your head in).
       def width_for_orientation(o=orientation)
-        return height if (o == :landscape_left) || (o == :landscape_right) 
+        return height if (o == :landscape_left) || (o == :landscape_right)
         width
       end
 
@@ -86,7 +86,7 @@ module BubbleWrap
       # compensating for screen rotation (which
       # can do your head in).
       def height_for_orientation(o=orientation)
-        return width if (o == :landscape_left) || (o == :landscape_right) 
+        return width if (o == :landscape_left) || (o == :landscape_right)
         height
       end
     end

data/motion/core/device/osx/screen.rb

@@ -15,4 +15,4 @@ module BubbleWrap
       end
     end
   end
-end
+end

data/motion/core/device/screen.rb

@@ -4,4 +4,4 @@ module BubbleWrap
 
     end
   end
-end
+end

data/motion/core/ios/device.rb

@@ -13,7 +13,7 @@ module BubbleWrap
     def ipad?(idiom=UIDevice.currentDevice.userInterfaceIdiom)
       idiom == UIUserInterfaceIdiomPad
     end
-    
+
     # Verifies that the device having a long screen (4 inch iPhone/iPod)
     # @return [TrueClass, FalseClass] true will be returned if the device is an iPhone/iPod with 4 inche screen, false otherwise.
     def long_screen?(idiom=UIDevice.currentDevice.userInterfaceIdiom, screen_height=UIScreen.mainScreen.bounds.size.height)

data/motion/core/ios/ns_index_path.rb

@@ -0,0 +1,11 @@
+module NSIndexPathWrap
+
+  def +(aNumber)
+    self.class.indexPathForRow(row+aNumber, inSection:section)
+  end
+
+  def -(aNumber)
+    self.class.indexPathForRow(row-aNumber, inSection:section)
+  end
+
+end

data/motion/core/json.rb

@@ -21,10 +21,10 @@ module BubbleWrap
       raise ParserError, error[0].description if error[0]
       if block_given?
         yield obj
-      else 
+      else
         obj
       end
-      
+
     end
 
     def self.generate(obj)

data/motion/core/kvo.rb

@@ -18,93 +18,156 @@
 # @see https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/KeyValueObserving/KeyValueObserving.html#//apple_ref/doc/uid/10000177i
 module BubbleWrap
   module KVO
-    COLLECTION_OPERATIONS = [ NSKeyValueChangeInsertion, NSKeyValueChangeRemoval, NSKeyValueChangeReplacement ]
-    DEFAULT_OPTIONS = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld
+    class Registry
+      COLLECTION_OPERATIONS = [ NSKeyValueChangeInsertion, NSKeyValueChangeRemoval, NSKeyValueChangeReplacement ]
+      OPTION_MAP = {
+        new: NSKeyValueChangeNewKey,
+        old: NSKeyValueChangeOldKey
+      }
+
+      attr_reader :callbacks, :keys
+
+      def initialize(value_keys = [:old, :new])
+        @keys = value_keys.inject([]) do |acc, key|
+          value_change_key = OPTION_MAP[key]
+
+          if value_change_key.nil?
+            raise RuntimeError, "Unknown value change key #{key}. Possible keys: #{OPTION_MAP.keys}"
+          end
+
+          acc << value_change_key
+        end
 
-    def observe(*arguments, &block)
-      unless [1,2].include?(arguments.length)
-        raise ArgumentError, "wrong number of arguments (#{arguments.length} for 1 or 2)"
+        @callbacks = Hash.new do |hash, key|
+          hash[key] = Hash.new do |subhash, subkey|
+            subhash[subkey] = Array.new
+          end
+        end
       end
 
-      key_path = arguments.pop
-      target   = arguments.pop || self
+      def add(target, key_path, &block)
+        return if target.nil? || key_path.nil? || block.nil?
 
-      target.addObserver(self, forKeyPath:key_path, options:DEFAULT_OPTIONS, context:nil) unless registered?(target, key_path)
-      add_observer_block(target, key_path, &block)
-    end
+        block.weak! if BubbleWrap.use_weak_callbacks?
 
-    def unobserve(*arguments)
-      unless [1,2].include?(arguments.length)
-        raise ArgumentError, "wrong number of arguments (#{arguments.length} for 1 or 2)"
+        callbacks[target][key_path.to_s] << block
       end
 
-      key_path = arguments.pop
-      target   = arguments.pop || self
+      def remove(target, key_path)
+        return if target.nil? || key_path.nil?
 
-      return unless registered?(target, key_path)
+        key_path = key_path.to_s
 
-      target.removeObserver(self, forKeyPath:key_path)
-      remove_observer_block(target, key_path)
-    end
+        callbacks[target].delete(key_path)
 
-    def unobserve_all
-      return if @targets.nil?
+        # If there no key_paths left for target, remove the target key
+        if callbacks[target].empty?
+          callbacks.delete(target)
+        end
+      end
+
+      def registered?(target, key_path)
+        callbacks[target].has_key? key_path.to_s
+      end
+
+      def remove_all
+        callbacks.clear
+      end
 
-      @targets.each do |target, key_paths|
-        key_paths.each_key do |key_path|
-          target.removeObserver(self, forKeyPath:key_path)
+      def each_key_path
+        callbacks.each do |target, key_paths|
+          key_paths.each_key do |key_path|
+            yield target, key_path
+          end
         end
       end
-      remove_all_observer_blocks
-    end
 
-    # Observer blocks
+      private
 
-    private
-    def registered?(target, key_path)
-      !@targets.nil? && !@targets[target].nil? && @targets[target].has_key?(key_path.to_s)
+      def observeValueForKeyPath(key_path, ofObject: target, change: change, context: context)
+        key_paths = callbacks[target] || {}
+        blocks = key_paths[key_path] || []
+
+        args = change.values_at(*keys)
+        args << key_path
+
+        blocks.each do |block|
+          block.call(*args)
+        end
+      end
     end
 
-    def add_observer_block(target, key_path, &block)
-      return if target.nil? || key_path.nil? || block.nil?
+    DEFAULT_OPTIONS = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld
+    IMMIDEATE_OPTIONS = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionInitial
 
-      block.weak! if BubbleWrap.use_weak_callbacks?
+    def observe(target = self, key_paths, &block)
+      key_paths = [key_paths].flatten
 
-      @targets ||= {}
-      @targets[target] ||= {}
-      @targets[target][key_path.to_s] ||= []
-      @targets[target][key_path.to_s] << block
+      key_paths.each do |key_path|
+        if not observers_registry.registered?(target, key_path)
+          target.addObserver(observers_registry, forKeyPath:key_path, options:DEFAULT_OPTIONS, context:nil)
+        end
+
+        # Add block even if observer is registed, so multiplie blocks can be invoked.
+        observers_registry.add(target, key_path, &block)
+      end
     end
 
-    def remove_observer_block(target, key_path)
-      return if @targets.nil? || target.nil? || key_path.nil?
+    def observe!(target = self, key_paths, &block)
+      key_paths = [key_paths].flatten
 
-      key_paths = @targets[target]
-      key_paths.delete(key_path.to_s) if !key_paths.nil?
-      if key_paths.nil? || key_paths.length == 0
-        @targets.delete(target)
+      key_paths.each do |key_path|
+        registered = immediate_observers_registry.registered?(target, key_path)
+
+        immediate_observers_registry.add(target, key_path, &block)
+
+        # We need to first register the block, and then call addObserver, because
+        # observeValueForKeyPath will fire immedeately.
+        if not registered
+          target.addObserver(immediate_observers_registry, forKeyPath:key_path, options: IMMIDEATE_OPTIONS, context:nil)
+        end
       end
     end
 
-    def remove_all_observer_blocks
-      @targets.clear unless @targets.nil?
+    def unobserve(target = self, key_paths)
+      remove_from_registry_if_exists(target, key_paths, observers_registry)
+    end
+
+    def unobserve!(target = self, key_paths)
+      remove_from_registry_if_exists(target, key_paths, immediate_observers_registry)
     end
 
-    # NSKeyValueObserving Protocol
+    def unobserve_all
+      observers_registry.each_key_path do |target, key_path|
+        target.removeObserver(observers_registry, forKeyPath:key_path)
+      end
 
-    def observeValueForKeyPath(key_path, ofObject: target, change: change, context: context)
-      key_paths = @targets[target] || {}
-      blocks = key_paths[key_path] || []
-      blocks.each do |block|
-        args = [change[NSKeyValueChangeOldKey], change[NSKeyValueChangeNewKey]]
-        args << change[NSKeyValueChangeIndexesKey] if collection?(change)
-        block.call(*args)
+      immediate_observers_registry.each_key_path do |target, key_path|
+        target.removeObserver(immediate_observers_registry, forKeyPath:key_path)
       end
+
+      observers_registry.remove_all
+      immediate_observers_registry.remove_all
+    end
+
+    private
+    def observers_registry
+      @observers_registry ||= Registry.new
     end
 
-    def collection?(change)
-      COLLECTION_OPERATIONS.include?(change[NSKeyValueChangeKindKey])
+    def immediate_observers_registry
+      @immediate_observers_registry ||= Registry.new([:new])
     end
 
+    def remove_from_registry_if_exists(target, key_paths, registry)
+      key_paths = [key_paths].flatten
+
+      key_paths.each do |key_path|
+        if registry.registered?(target, key_path)
+          target.removeObserver(registry, forKeyPath:key_path)
+          registry.remove(target, key_path)
+        end
+      end
+    end
   end
 end