bubble-wrap 0.3.1 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.0
+
+* Refactored the code and test suite to be more modular and to handle
+  dependencies. One can now require only a subset of BW such as `require 'bubble-wrap/core'` or 'bubble-wrap/http'
+
 ## 0.3.1
 
 * Added App.run_after(delay){ }

data/README.md

@@ -1,6 +1,8 @@
 # BubbleWrap for RubyMotion
 
-A collection of helpers and wrappers used to wrap CocoaTouch code and provide more Ruby like APIs.
+A collection of (tested) helpers and wrappers used to wrap CocoaTouch code and provide more Ruby like APIs.
+
+[BubbleWrap website](http://bubblewrap.io)
 
 ## Installation
 
@@ -10,80 +12,50 @@ gem install bubble-wrap
 
 ## Setup
 
-1. Edit the Rakefile of your RubyMotion project and add the following require line.
+1. Edit the `Rakefile` of your RubyMotion project and add the following require line.
+
 ```ruby
 require 'bubble-wrap'
 ```
-Note: **DON'T** use `app.files =` in your Rakefile to set up your files once you've required BubbleWrap.
-Make sure to append onto the array or use `+=`.
 
-2. Now, you can use BubbleWrap extension in your app:
+BubbleWrap is split into multiple modules so that you can easily choose which parts
+are included at compile-time. 
+
+The above example requires all the wrappers/helpers. If you wish to only
+include the core modules use the following line of code instead:
 
 ```ruby
-class AppDelegate
-  def application(application, didFinishLaunchingWithOptions:launchOptions)
-    puts "#{App.name} (#{documents_path})"
-    true
-  end
-end
+require 'bubble-wrap/core'
 ```
 
-For a more complete list of helper/wrapper descriptions and more details, see the [wiki](https://github.com/mattetti/BubbleWrap/wiki).
-
-## HTTP
-
-`BubbleWrap::HTTP` wraps `NSURLRequest`, `NSURLConnection` and friends to provide Ruby developers with a more familiar and easier to use API.
-The API uses async calls and blocks to stay as simple as possible.
-
-Usage example:
+If you wish to only include the `HTTP` wrapper:
 
 ```ruby
-BubbleWrap::HTTP.get("https://api.github.com/users/mattetti") do |response|
-  p response.body.to_str
-end
+require 'bubble-wrap/http'
 ```
 
-```ruby
-BubbleWrap::HTTP.get("https://api.github.com/users/mattetti", {credentials: {username: 'matt', password: 'aimonetti'}}) do |response|
-  p response.body.to_str # prints the response's body
-end
-```
+
+Note: **DON'T** use `app.files =` in your Rakefile to set up your files once you've required BubbleWrap.
+Make sure to append onto the array or use `+=`.
+
+2. Now, you can use BubbleWrap extension in your app:
 
 ```ruby
-data = {first_name: 'Matt', last_name: 'Aimonetti'}
-BubbleWrap::HTTP.post("http://foo.bar.com/", {payload: data}) do |response|
-  if response.ok?
-    json = BubbleWrap::JSON.parse(response.body.to_str)
-    p json['id']
-  elsif response.status_code.to_s =~ /40\d/
-    alert("Login failed") # helper provided by the kernel file in this repo.
-  else
-    alert(response.error_message)
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    puts "#{App.name} (#{documents_path})"
+    true
   end
 end
 ```
 
-## JSON
+Note: You can also vendor this repository but the recommended way is to
+use the versioned gem.
 
-`BubbleWrap::JSON` wraps `NSJSONSerialization` available in iOS5 and offers the same API as Ruby's JSON std lib.
-
-## Device
 
-A collection of useful methods about the current device:
-
-Examples:
-```ruby
-> Device.iphone?
-# true
-> Device.ipad?
-# false
-> Device.orientation
-# :portrait
-> Device.simulator?
-# true
-```
+## Core
 
-## App
+### App
 
 A module with useful methods related to the running application
 
@@ -100,18 +72,53 @@ A module with useful methods related to the running application
 # creates and shows an alert message.
 > App.run_after(0.5) {  p "It's #{Time.now}"   }
 # Runs the block after 0.5 seconds.
+> App::Persistence['channels'] # application specific persistence storage
+# ['NBC', 'ABC', 'Fox', 'CBS', 'PBS']
+> App::Persistence['channels'] = ['TF1', 'France 2', 'France 3']
+# ['TF1', 'France 2', 'France 3']
 ```
 
-## NSUserDefaults
+Other available methods:
 
-Helper methods added to the class repsonsible for user preferences.
+* `App.notification_center`
+* `App.user_cache`
+* `App.states`
+* `App.frame`
+* `App.delegate`
+* `App.current_locale`
 
-## NSIndexPath
 
-Helper methods added to give `NSIndexPath` a bit more of a Ruby
-interface.
+### Device
+
+A collection of useful methods about the current device:
+
+Examples:
+```ruby
+> Device.iphone?
+# true
+> Device.ipad?
+# false
+> Device.front_camera?
+# true
+> Device.rear_camera?
+# true
+> Device.orientation
+# :portrait
+> Device.simulator?
+# true
+> Device.retina?
+# false
+> Device.screen.width
+# 320
+> Device.screen.height
+# 480
+> Device.screen.widthForOrientation(:landscape_left)
+# 480
+> Device.screen.heightForOrientation(:landscape_left)
+# 320
+```
 
-## Gestures
+### Gestures
 
 Extra methods on `UIView` for working with gesture recognizers. A gesture recognizer can be added using a normal Ruby block, like so:
 
@@ -127,17 +134,26 @@ Extra methods on `UIView` for working with gesture recognizers. A gesture recogn
 
 There are similar methods for pinched, rotated, swiped, panned, and pressed (for long presses). All of the methods return the actual recognizer object, so it is possible to set the delegate if more fine-grained control is needed.
 
-## UIButton
 
-Helper methods to give `UIButton` a Ruby-like interface. Ex:
+
+### JSON
+
+`BubbleWrap::JSON` wraps `NSJSONSerialization` available in iOS5 and offers the same API as Ruby's JSON std lib.
 
 ```ruby
-button.when(UIControlEventTouchUpInside) do
-  self.view.backgroundColor = UIColor.redColor
-end
+BW::JSON.generate({'foo => 1, 'bar' => [1,2,3], 'baz => 'awesome'})
+=> "{\"foo\":1,\"bar\":[1,2,3],\"baz\":\"awesome\"}"
+BW::JSON.parse "{\"foo\":1,\"bar\":[1,2,3],\"baz\":\"awesome\"}"
+=> {"foo"=>1, "bar"=>[1, 2, 3], "baz"=>"awesome"}
 ```
 
-## NSNotificationCenter
+### NSIndexPath
+
+Helper methods added to give `NSIndexPath` a bit more of a Ruby
+interface.
+
+
+### NSNotificationCenter
 
 Helper methods to give NSNotificationCenter a Ruby-like interface:
 
@@ -161,3 +177,104 @@ def reload
   notification_center.post ReloadNotification
 end
 ```
+
+
+### NSUserDefaults
+
+Helper methods added to the class repsonsible for user preferences used
+by the `App::Persistence` module shown below.
+
+### Persistence
+
+Offers a way to persist application specific information using a very
+simple interface:
+
+``` ruby
+> App::Persistence['channels'] # application specific persistence storage
+# ['NBC', 'ABC', 'Fox', 'CBS', 'PBS']
+> App::Persistence['channels'] = ['TF1', 'France 2', 'France 3']
+# ['TF1', 'France 2', 'France 3']
+```
+
+### String
+
+The Ruby `String` class was extended to add `#camelize` and
+`#underscore` methods.
+
+```ruby
+> "matt_aimonetti".camelize
+=> "MattAimonetti"
+> "MattAimonetti".underscore
+=> "matt_aimonetti"
+```
+
+### Time
+
+The `Time` Ruby class was added a class level method to convert a
+iso8601 formatted string into a Time instance.
+
+```ruby
+> Time.iso8601("2012-05-31T19:41:33Z")
+=> 2012-05-31 21:41:33 +0200
+```
+
+### UIControl / UIButton
+
+Helper methods to give `UIButton` a Ruby-like interface. Ex:
+
+```ruby
+button.when(UIControlEventTouchUpInside) do
+  self.view.backgroundColor = UIColor.redColor
+end
+```
+
+### UIViewController
+
+A custom method was added to `UIViewController` to return the content
+frame of a view controller.
+
+
+## HTTP
+
+`BubbleWrap::HTTP` wraps `NSURLRequest`, `NSURLConnection` and friends to provide Ruby developers with a more familiar and easier to use API.
+The API uses async calls and blocks to stay as simple as possible.
+
+To enable it add the following require line to your `Rakefile`:
+```ruby
+require 'bubble-wrap/http'
+```
+
+Usage example:
+
+```ruby
+BubbleWrap::HTTP.get("https://api.github.com/users/mattetti") do |response|
+  p response.body.to_str
+end
+```
+
+```ruby
+BubbleWrap::HTTP.get("https://api.github.com/users/mattetti", {credentials: {username: 'matt', password: 'aimonetti'}}) do |response|
+  p response.body.to_str # prints the response's body
+end
+```
+
+```ruby
+data = {first_name: 'Matt', last_name: 'Aimonetti'}
+BubbleWrap::HTTP.post("http://foo.bar.com/", {payload: data}) do |response|
+  if response.ok?
+    json = BubbleWrap::JSON.parse(response.body.to_str)
+    p json['id']
+  elsif response.status_code.to_s =~ /40\d/
+    alert("Login failed") # helper provided by the kernel file in this repo.
+  else
+    alert(response.error_message)
+  end
+end
+```
+
+
+
+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).

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
 $:.unshift("/Library/RubyMotion/lib")
 require 'motion/project'
+require File.expand_path '../lib/bubble-wrap', __FILE__
+require File.expand_path '../lib/bubble-wrap/http', __FILE__
+
+task :rspec do
+  sh "rspec lib_spec/"
+end
 
 Motion::Project::App.setup do |app|
   app.name = 'testSuite'
@@ -10,10 +16,4 @@ Motion::Project::App.setup do |app|
     app.files << './lib/tests/test_suite_delegate.rb'
     app.delegate_class = 'TestSuiteDelegate'
   end
-
-  app.files += Dir.glob('./lib/bubble-wrap/**/*.rb')
-  wrapper_files = app.files.dup
-  pollution_file = Dir.glob('./lib/pollute.rb')[0]
-  app.files << pollution_file
-  app.files_dependencies pollution_file => wrapper_files
 end

data/bubble-wrap.gemspec

@@ -2,15 +2,20 @@
 require File.expand_path('../lib/bubble-wrap/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Matt Aimonetti", "Francis Chong"]
-  gem.email         = ["mattaimonetti@gmail.com", "francis@ignition.hk"]
+  gem.authors       = ["Matt Aimonetti", "Francis Chong", "James Harton"]
+  gem.email         = ["mattaimonetti@gmail.com", "francis@ignition.hk", "james@sociable.co.nz"]
   gem.description   = "RubyMotion wrappers and helpers (Ruby for iOS) - Making Cocoa APIs more Ruby like, one API at a time. Fork away and send your pull request."
   gem.summary       = "RubyMotion wrappers and helpers (Ruby for iOS) - Making Cocoa APIs more Ruby like, one API at a time. Fork away and send your pull request."
-  gem.homepage      = "https://github.com/mattetti/BubbleWrap"
+  gem.homepage      = "http://bubblewrap.io/"
 
   gem.files         = `git ls-files`.split($\)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(test|spec|lib_spec|features)/})
   gem.name          = "bubble-wrap"
   gem.require_paths = ["lib"]
   gem.version       = BubbleWrap::VERSION
-end
+
+  gem.extra_rdoc_files = gem.files.grep(%r{motion})
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/bubble-wrap.rb

@@ -1,39 +1,4 @@
-require "bubble-wrap/version"
-
-unless defined?(Motion::Project::Config)
-  raise "This file must be required within a RubyMotion project Rakefile."
-end
-
-module Motion
-  module Project
-    class Config
-      # HACK NEEDED since RubyMotion doesn't support full path
-      # dependencies.
-      def files_dependencies(deps_hash)
-        res_path = lambda do |x|
-          path = /^\.?\//.match(x) ? x : File.join('.', x)
-          unless @files.include?(path)
-            App.fail "Can't resolve dependency `#{x}' because #{path} is not in #{@files.inspect}"
-          end
-          path
-        end
-        deps_hash.each do |path, deps|
-          deps = [deps] unless deps.is_a?(Array)
-          @dependencies[res_path.call(path)] = deps.map(&res_path)
-        end
-      end
-    end
-  end
-end
-
-
-Motion::Project::App.setup do |app|
-  wrapper_files = []
-  Dir.glob(File.join(File.dirname(__FILE__), 'bubble-wrap/**/*.rb')).each do |file|
-    app.files << file
-    wrapper_files << file
-  end
-  pollution_file = File.expand_path(File.join(File.dirname(__FILE__), 'pollute.rb'))
-  app.files.unshift pollution_file
-  app.files_dependencies pollution_file => wrapper_files
-end
+require "bubble-wrap/version" unless defined?(BubbleWrap::VERSION)
+require File.expand_path('../bubble-wrap/loader', __FILE__)
+require File.expand_path('../bubble-wrap/core', __FILE__)
+require File.expand_path('../bubble-wrap/http', __FILE__)

data/lib/bubble-wrap/core.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../loader.rb', __FILE__)
+BubbleWrap.require('motion/core.rb')
+BubbleWrap.require('motion/core/**/*.rb') do 
+  file('motion/core/device/screen.rb').depends_on 'motion/core/device.rb'
+  file('motion/core/pollute.rb').depends_on 'motion/core/ns_index_path.rb'
+  file('motion/core/pollute.rb').depends_on 'motion/core/ui_control.rb'
+end

data/lib/bubble-wrap/ext.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../ext/motion_project_config', __FILE__)
+require File.expand_path('../ext/motion_project_app', __FILE__)

data/lib/bubble-wrap/ext/motion_project_app.rb

@@ -0,0 +1,26 @@
+module BubbleWrap
+  module Ext
+    module BuildTask
+
+      def self.extended(base)
+        base.instance_eval do
+          def setup_with_bubblewrap(&block)
+            bw_config = proc do |app|
+              app.files = ::BubbleWrap::Requirement.files + Dir.glob('./app/**/*.rb')
+              app.files_dependencies ::BubbleWrap::Requirement.files_dependencies
+              app.frameworks = ::BubbleWrap::Requirement.frameworks
+              block.call(app)
+            end
+            configs.each_value &bw_config
+            config.validate
+          end
+          alias :setup_without_bubblewrap :setup
+          alias :setup :setup_with_bubblewrap
+        end
+      end
+
+    end
+  end
+end
+
+Motion::Project::App.extend(BubbleWrap::Ext::BuildTask)