README.md in bubble-wrap-0.3.1 vs README.md in bubble-wrap-0.4.0
- old
+ new
@@ -1,92 +1,64 @@
# 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
```ruby
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).
+If you wish to only include the `HTTP` wrapper:
-## HTTP
+```ruby
+require 'bubble-wrap/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:
+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 `+=`.
-```ruby
-BubbleWrap::HTTP.get("https://api.github.com/users/mattetti") do |response|
- p response.body.to_str
-end
-```
+2. Now, you can use BubbleWrap extension in your app:
```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)
+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
+## Core
-A collection of useful methods about the current device:
+### App
-Examples:
-```ruby
-> Device.iphone?
-# true
-> Device.ipad?
-# false
-> Device.orientation
-# :portrait
-> Device.simulator?
-# true
-```
-
-## App
-
A module with useful methods related to the running application
```ruby
> App.documents_path
# "/Users/mattetti/Library/Application Support/iPhone Simulator/5.0/Applications/EEC6454E-1816-451E-BB9A-EE18222E1A8F/Documents"
@@ -98,23 +70,58 @@
# "io.bubblewrap.testSuite"
> App.alert("BubbleWrap is awesome!")
# 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
-## Gestures
+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
+
Extra methods on `UIView` for working with gesture recognizers. A gesture recognizer can be added using a normal Ruby block, like so:
```ruby
view.whenTapped do
UIView.animateWithDuration(1,
@@ -125,22 +132,31 @@
end
```
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:
```ruby
def viewWillAppear(animated)
@foreground_observer = notification_center.observe UIApplicationWillEnterForegroundNotification do |notification|
@@ -159,5 +175,106 @@
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).