motion-momentum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddc2e4b530fce838ceab0386e65b3f0a9b7d8a96
-  data.tar.gz: 07d02f37340b839d82333534cfd24a5bc7b95594
+  metadata.gz: 35bac3aa4e9d7529267bf224811942bf32219fa8
+  data.tar.gz: dd586ab8bc2079b9ed4a14a59eb71d9495116a59
 SHA512:
-  metadata.gz: 4438273e9bb261496f03fa5b78242525b446241a2440bda22ca296433b756db5267f5c53aca4bec1ee80fd4c6c720482155cefebd68aea292c34b63778365ff3
-  data.tar.gz: 1a816fbfd0943af5fc2de2dafcdca02ab86dbad872aa345168b82dde66a210b1feb7b3c876de78efd5b6e482c2e0754dbd5fcfb7c8fa7922b05a13009dcc4ef0
+  metadata.gz: a73b0b4d1edab87c3dc18842a3b9a81583d698b2c81c75a97e4ede89f64e7601f20d9bd87a43d125dbe004365377333bd1638b3455fbfddb97f0fda27f8a025a
+  data.tar.gz: d931218f5ce551404717e292153406dce3627602c9a5405427bfcd6153506d2953ce256ddd2d274c6f7fc1272fee3d8cb3979f7a875dfc1ca9ac89e3e7d6d9a8

data/README.md

@@ -1,12 +1,119 @@
 # Momentum
 
-[![Build Status](https://travis-ci.org/FluffyJack/motion-momentum.png)](https://travis-ci.org/FluffyJack/motion-momentum) [![Code Climate](https://codeclimate.com/github/FluffyJack/motion-momentum.png)](https://codeclimate.com/github/FluffyJack/motion-momentum) [![Dependency Status](https://gemnasium.com/FluffyJack/motion-momentum.png)](https://gemnasium.com/FluffyJack/motion-momentum)
+[![Gem Version](https://badge.fury.io/rb/motion-momentum.png)](http://badge.fury.io/rb/motion-momentum) [![Build Status](https://travis-ci.org/FluffyJack/motion-momentum.png)](https://travis-ci.org/FluffyJack/motion-momentum) [![Code Climate](https://codeclimate.com/github/FluffyJack/motion-momentum.png)](https://codeclimate.com/github/FluffyJack/motion-momentum) [![Dependency Status](https://gemnasium.com/FluffyJack/motion-momentum.png)](https://gemnasium.com/FluffyJack/motion-momentum)
 
 Momentum is a RubyMotion framework for creating iOS and OS X applications the "Rails" way.
 
+I suggest you use this framework with [RMQ](https://github.com/infinitered/rmq) and [CDQ](https://github.com/infinitered/cdq).
+
+This framework is being developed along side the [RubyMotion for Rails Developers book](http://book.motioninmotion.tv/), but my vision for it is most certainly to help the long term happiness of the RubyMotion community. Please share your ideas by submitting an issue here on GitHub. Show support by purchasing the book or [subscribe to my screencasts](https://motioninmotion.tv/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-momentum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-momentum
+
 ## Usage
 
-Proposed ideas can be found in this gist: [https://gist.github.com/FluffyJack/9409243](https://gist.github.com/FluffyJack/9409243)
+This framework is still in it's early days. Feel free to use it, but understand that until v1.x the API may change between releases. Proposed ideas can be found in this gist: [https://gist.github.com/FluffyJack/9409243](https://gist.github.com/FluffyJack/9409243).
+
+### Application Structure
+
+Momentum tries to take a convention-over-configuration approach. A controller called `MainController` will assign it's view to be `MainView`, it's delegate (and the view's `delegate` and `dataSource` attribtues if they exist) to be `MainDelegate`, and it's stylesheet to be `MainStylesheet`, though stylesheets have not been properly integrated yet, and so, using a stylesheet gem is suggested.
+
+The suggested application structure is as follows:
+
+```
+app
+\- app_delegate.rb
+\- controllers
+   \- posts_controller.rb
+\- delegates
+   \- posts_delegate.rb
+\- models
+   \- post.rb
+\- stylesheets
+   \- posts_stylesheet.rb
+\- views
+   \- posts_view.rb
+```
+
+### Controllers
+
+To create a Momentum controller which will help you clean up your controller code, you can just inherit from `Momentum::ViewController` for iOS. OS X support is coming soon and a `Momentum::WindowController` will be available then.
+
+```ruby
+class PostsController < Momentum::ViewController
+  title "Posts"
+
+  def setup
+    self.delegate.data[:posts] = Post.all
+  end
+end
+```
+
+You can also just include the `Momentum::ViewControllerModule`, though this isn't well tested with support for other types of view controllers yet (remember, very early days).
+
+If you want to choose which view, delegate, or stylesheet class is used, you can do so.
+
+```ruby
+class PostsController < Momentum::ViewController
+  view "PostsView"
+  delegate "PostsDelegate"
+  stylesheet "PostsStylesheet"
+  title "Posts"
+
+  def setup
+    self.delegate.data[:posts] = Post.all
+  end
+end
+```
+
+### Views
+
+Views are currently just standard `UIViews`.
+
+```ruby
+class PostsView < UITableView
+end
+```
+
+### Delegates
+
+Delegates are fairly stock standard, but you can inherit from `Momentum::Delegate` to get a nice `data` attribute to pass data to your delegate for you view to consume.
+
+```ruby
+class PostsDelegate < Momentum::Delegate
+  def tableView(tableView, numberOfRowsInSection:section)
+    self.data[:posts].count
+  end
+
+  def tableView(tableView, cellForRowAtIndexPath:indexPath)
+    @reuseIdentifier ||= "CELL_IDENTIFIER"
+
+    cell = tableView.dequeueReusableCellWithIdentifier(@reuseIdentifier) || begin
+      UITableViewCell.alloc.initWithStyle(UITableViewCellStyleDefault, reuseIdentifier:@reuseIdentifier)
+    end
+
+    cell.textLabel.text = self.data[:posts][indexPath.row].title
+
+    cell
+  end
+
+  def tableView(tableView, didSelectRowAtIndexPath:indexPath)
+    # push the detail controller with the post
+  end
+end
+```
 
 ## Contributing
 

data/lib/motion-momentum-ios/controller/view_controller_module.rb

@@ -42,7 +42,7 @@ module Momentum
       self.view.dataSource = self.delegate if self.view.class.instance_methods.include?(:dataSource)
     end
 
-    def viewDidAppear(animated)
+    def viewWillAppear(animated)
       self.setup if self.class.instance_methods.include?(:setup)
     end
 

data/lib/motion-momentum/version.rb

@@ -1,3 +1,3 @@
 module Momentum
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/motion-momentum-ios/controller/view_controller_spec.rb

@@ -43,7 +43,7 @@ describe Momentum::ViewController do
 
     it "calls setup if it's defined when the view appears" do
       CallbackHelper.shared.data[:setup_called] = false
-      @vc.viewDidAppear(true)
+      @vc.viewWillAppear(true)
       CallbackHelper.shared.data[:setup_called].should == true
     end
 
@@ -52,7 +52,7 @@ describe Momentum::ViewController do
     end
 
     it "will still use the title instance variable though" do
-      @vc.viewDidAppear(true)
+      @vc.viewWillAppear(true)
       @vc.title.should == "Custom"
     end
 
@@ -63,7 +63,7 @@ describe Momentum::ViewController do
     before { @vc = NoSetupMockController.new }
 
     it "does not call setup if it's not defined when the view appears" do
-      lambda { @vc.viewDidAppear(true) }.should.not.raise(NoMethodError)
+      lambda { @vc.viewWillAppear(true) }.should.not.raise(NoMethodError)
     end
 
     it "will return nil with no class title or title instance variable" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-momentum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jack Dean Watson-Hamblin