motion-objection 0.6.4 → 0.7.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjRiNmUwZGFjYTc5YTI1NzhjMjZhNGY0N2RkMjBlNTA3ODlhMjk3Ng==
+    M2ZmMTNjMGY4YTI4NzhiYTRjYzM1MGFjNDRkNzYwNWQ2Zjk1ZTUzNw==
   data.tar.gz: !binary |-
-    MTllOWVhZmIxMDJmZDdhODkzNTUxYmRhY2JhZThkNjAxNmU1ZDMzMA==
+    N2NkMTk5ZjUwMWNkMmZiNGU3YTBhOWM3ZmM0ZjgyMmEzZWM1NjMzOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWYwNTU1OGU3Yjg4MjZhMDk2NDcyNjRmNDMwNzkxOTBhZjIwYTBmYjUxZDQ3
-    ZDc0YzMyMTNkNGE0NmUyYTI0MjNiNDc2ODc4NDBlZDYyY2JjNDFiNTQxYTBm
-    ZGM5ZWQxYTdlOGY0MTNlYTIxZGJmZWQzZmE1MDZmMDBiN2JhM2E=
+    YjNkYzhjODFhNjhkMzg5ZjA4ZDliMzg5MTk3MDI2MjNhYzQyYjliOWEyZTM1
+    MDQ1ZDIzMGEwODAzYjE4NDNhYmYxOTJhZjg2ZmM4NDIxYjk5MjFiYmVhNTkz
+    MWNjYzdjZmJiN2QxYzMzODY4NjllYzgzZTI1ZGMzMGI5NWM4ODE=
   data.tar.gz: !binary |-
-    NjYyODg0NzQ4NTRjMTliMTg0MDE0MDFjYzUyYWI2NzQ0ZmE0YWE0ZDliMTIw
-    NmI3YTUzYTI0MGFmYzYwZjMxOGI0NDg1MjQwNTIwYjM3OTA1ODQxZWQzZDc2
-    OGZkNjFlYTg4NzcyMTA1ZWRkYjczMjQ1Yjk4ZWZkMGZmM2JiODI=
+    N2UxMTIwZGQ5MzZjNDdmOThhYmM5OTc0ODA4ZjBhYmVjZmY1ZmFhODk3NjI1
+    ZTUwMjhjMjJhYWI3YzU1Nzg1YzFmNGU3NmY4NmQ3YTI5NmZlNTdkMjI2MzNj
+    MDQyNDYyMDQ2ODRhMjU0OGM5ZDZmNjdmMDI4N2UxOWMzYThlYmU=

data/README.md

@@ -1,50 +1,90 @@
 motion-objection
 ================
 
-Wrapping the dependency injection library [Objection](https://github.com/atomicobject/objection) in RubyMotion.
+Motion-objection wraps the Objective-C dependency injection library [Objection](https://github.com/atomicobject/objection) in Ruby so that it can be used in [RubyMotion](http://www.rubymotion.com/). It has all of the power (and speed) of Objection and the declarative affordances that the Ruby language provides.
 
 <!-- [![Build Status](https://travis-ci.org/atomicobject/motion-objection.png)](https://travis-ci.org/atomicobject/motion-objection) -->
 [![Gem Version](https://badge.fury.io/rb/motion-objection.png)](http://badge.fury.io/rb/motion-objection)
 [![Code Climate](https://codeclimate.com/github/atomicobject/motion-objection.png)](https://codeclimate.com/github/atomicobject/motion-objection)
 
-## Install
+## Installation
+
+
 ```bash
 gem install motion-objection
 ```
-## Basic Example
+
+## Basic Usage
+
+A class can declare requires component objects by mixing in <code>Objection::Compose</code> and calling the <code>.compose_with</code> method 
 
 ```ruby
 class Car
   include Objection::Compose
-  compose_with :engine, :brakes, factory: JSObjectFactory
+  compose_with :engine, :brakes
 end
+```
+
+Where <code>:engine</code> and <code>:brakes</code> are assumed to be the <code>Engine</code> and <code>Brakes</code> classes. Classes that are namespaced can be declared as well by separating the namespaces using the <code>/</code> character.
 
+```ruby
 class Engine
   include Objection::Compose
-  singleton
   compose_with 'engine/crank_shaft', 'engine/rod'
 
-  def shift(wat)
-    puts "SHIFT!"
-  end
-
   class CrankShaft
   end 
 
   class Rod
   end
 end
+```
+
+Sometimes you may need to declare the component object _and_ the class that is associated with it.
 
+```ruby
 class Brakes
-  def brake!
+compose_with factory: JSObjectFactory
+end
+```
+
+## Singletons
+
+Singletons can be declared by calling the <code>.singleton</code> method in the class body. Singletons should really only be necessary if they contain _shared state_. Otherwise it behooves you to avoid singletons in order to reduce the memory footprint of an application.
+
+```ruby
+class Holder
+include Objection::Compose
+singleton
+end
+```
+
+## Awaking from Objection
+
+Since Objection utilizes _setter_ based injection the initializer does not guarentee that all the object's dependencies have been satisfied.
+
+The `awoke` class method can be given a block which will be invoked once the object has been fully instantiated.
+
+```ruby
+class Ship
+  awoke do
+    # Bootstrap listeners
+  end
+  
+  awoke do
+    # Setup other stuff
   end
 end
 ```
 
-## Initializers
+## Default Initializers
+
+Objection uses [Key-Value Coding](http://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/KeyValueCoding/Articles/KeyValueCoding.html) to compose an instance with its dependencies -- it does not use initializer injection.
+
+By default Objection initializes an object using the <code>init</code> initializer. A custom initializer can be declared using the <code>.initializer</code> method.
 
 ```ruby
-class ViewController < NSObject
+class ViewController < UIViewController
   include Objection::Compose
   initializer "initWithNibName:bundle:", "Home"
 
@@ -59,8 +99,48 @@ class ViewController < NSObject
 end
 ```
 
-## Default Injector
+## Modules
+
+Modules contribution configuration information to the Injector. Typically, this includes bindings for dependencies that the Injector cannot provide. For example, <code>UIApplication.sharedApplication</code> or the main application window.
+
+```ruby
+class AppModule < JSObjectionModule
+  def initialize(window, application: application)
+    @window = window
+    @application = application
+  end
+  
+  def configure
+    bind @window, toClass: UIWindow
+    bind @application, toClass: UIApplication
+  end
+end
+```
+
+There are a number of other configuration methods a module [provides](https://github.com/atomicobject/objection#modules).
+
+## Bootstraping an Application
+
+Typically an application is bootstrapped in the application delegate where an injector is created and set as the default injector via <code>.default_injector=</code>.
 
 ```ruby
-Objection.default_injector = Objection.injector AppModule.new, SecondaryModule.new
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    initialize_objection
+    Objection.default_injector[ApplicationBootstrapper].bootstrap!
+    true
+  end
+  
+    def initialize_objection
+    @window = UIWindow.alloc.initWithFrame(UIScreen.mainScreen.bounds)
+    injector = Objection.injector(BankersDashboardModule.new(@window, UIApplication.sharedApplication))
+    Objection.default_injector = injector
+  end
+end
+
+class ApplicationBootstrapper
+  def bootstrap!
+    # Bootstrap
+  end
+end
 ```

data/lib/motion-objection/awoken.rb

@@ -0,0 +1,27 @@
+module Objection
+  module Awoken
+    def self.included(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def awakeFromObjection
+        # self.send :awoke_from_objection if self.respond_to? :awoke_from_objection
+        if self.class._incantations
+          self.class._incantations.each do |proc|
+            instance_eval &proc
+          end
+        end
+      end
+    end
+    
+    module ClassMethods
+      attr_reader :_incantations
+      def awoken(&block)
+        @_incantations ||= []
+        @_incantations << block
+      end
+    end
+  end
+end

data/lib/motion-objection/compose.rb

@@ -1,10 +1,10 @@
 module Objection
   module Compose
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.send :extend, ClassMethods
     end
 
-    module Initializer
+    module Initializer #:nodoc:
       def objectionInitializer
         @_initializer
       end

data/lib/motion-objection/{jsobjection.rb → extensions/js_objection.rb}

@@ -1,3 +1,3 @@
-class JSObjection
+class JSObjection #:nodoc:
   setPropertyReflector RubyPropertyReflector
 end

data/lib/motion-objection/extensions/ns_object.rb

@@ -0,0 +1,3 @@
+class NSObject
+  include Objection::Awoken
+end

data/lib/motion-objection/version.rb

@@ -1,3 +1,3 @@
 module Objection
-  VERSION = "0.6.4"
+  VERSION = "0.7.1"
 end

data/spec/helpers/objection_classes.rb

@@ -1,16 +1,27 @@
 class Car
   include Objection::Compose
+  attr_reader :started
   compose_with :engine, :brakes, factory: JSObjectFactory  
+
 end
 
 class EagerCar
   include Objection::Compose
   singleton
   class<<self; attr_accessor :awoke; end
+  attr_accessor :awoke
+
+  def boom
+    puts @boom
+  end
 
-  def awakeFromObjection
+  awoken do
     self.class.awoke = true
   end
+
+  awoken do
+    self.awoke = true
+  end
 end
 
 class Engine

data/spec/objection_spec.rb

@@ -69,7 +69,9 @@ describe "Objection" do
 
     it "has support for eager singletons" do
       @injector = Objection.injector EagerSingletonModule.new
+
       EagerCar.awoke.should.equal true
+      @injector[EagerCar].awoke.should.equal true
     end
 
     it "has support for an injector with a module" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-objection
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.1
 platform: ruby
 authors:
 - Justin DeWind
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: motion-cocoapods
@@ -40,13 +40,15 @@ files:
 - Rakefile
 - app/app_delegate.rb
 - lib/motion-objection.rb
+- lib/motion-objection/awoken.rb
 - lib/motion-objection/compose.rb
+- lib/motion-objection/extensions/js_objection.rb
+- lib/motion-objection/extensions/js_objection_injector.rb
+- lib/motion-objection/extensions/ns_object.rb
+- lib/motion-objection/extensions/string.rb
 - lib/motion-objection/inflector.rb
-- lib/motion-objection/jsobjection.rb
-- lib/motion-objection/jsobjection_injector.rb
 - lib/motion-objection/objection.rb
 - lib/motion-objection/ruby_property_reflector.rb
-- lib/motion-objection/string.rb
 - lib/motion-objection/version.rb
 - motion_objection.gemspec
 - resources/Default-568h@2x.png