rucola 0.0.1 → 0.0.2

data/lib/rucola/nib.rb

@@ -34,10 +34,10 @@ module Rucola
         @data['IBClasses']
       end
       
-      def add_class(class_name)
+      def add_class(class_name, superclass_name = 'NSObject')
         classes.push({
           'CLASS' => class_name,
-          'SUPERCLASS' => 'NSObject',
+          'SUPERCLASS' => superclass_name,
           'LANGUAGE' => 'ObjC'
         })
       end

data/lib/rucola/plugin.rb

@@ -0,0 +1,57 @@
+require 'osx/cocoa'
+
+module Rucola
+  # Abstract base class for Rucola plugins
+  # override the methods in your plugin to get code run at appropriate times
+  class Plugin
+    @@plugins = []
+    
+    def self.plugins
+      @@plugins
+    end
+    
+    def self.inherited(subclass)
+      @@plugins << subclass.new
+    end
+    
+    def self.before_boot
+      plugins.each { |p| p.before_boot }
+    end
+    
+    def self.after_boot
+      plugins.each { |p| p.after_boot }
+    end
+    
+    def self.before_process(initializer)
+      plugins.each {|p| p.before_process(initializer) }
+    end
+    
+    def self.after_process(initializer)
+      plugins.each {|p| p.after_process(initializer) }
+    end
+    
+    def self.after_launch
+      plugins.each {|p| p.after_launch }
+    end
+    
+    def before_boot; end
+    def after_boot; end
+    def before_process(initializer); end
+    def after_process(initializer); end
+    def after_launch; end
+  end
+  
+  # This class is used to be able to run hooks when the app has started.
+  class PluginRunner < OSX::NSObject
+    def initialize
+      center = OSX::NSNotificationCenter.defaultCenter
+      center.addObserver_selector_name_object(self, :after_launch, OSX::NSApplicationDidFinishLaunchingNotification, nil)
+    end
+
+    def after_launch(notification)
+      Rucola::Plugin.after_launch
+    end
+    
+    @instance = self.alloc.init
+  end
+end

data/lib/rucola/rucola_support/initialize_hooks.rb

@@ -8,10 +8,17 @@ module Rucola
       end
     end
   
+    # Calls all the hooks that have been added to the queue.
+    #
+    # It will also call the method +after_init+, but only if you have defined it.
+    # Create this method to do work that you would normally do in +initialize+ or +init+.
     def initialize
       # get the hooks, if they exist let them all do their after initialization work.
       hooks = self.class.instance_variable_get(:@_rucola_initialize_hooks)
       hooks.each { |hook| self.instance_eval(&hook) } unless hooks.nil?
+      
+      # also call after_init for custom initialization code.
+      send :after_init if respond_to? :after_init # TODO: test
     end
   
     def self.included(base) # :nodoc

data/lib/rucola/rucola_support/notifications/notifications.rb

@@ -38,7 +38,7 @@ module Rucola
         #     # This will make sure that :win_ is expanded to :window_ in the notifications that you register.
         #     notification_prefix :win => :window
         #
-        #     notify_on :win_did_become_key do |notification|
+        #     when :win_did_become_key do |notification|
         #       # code
         #     end
         #   end
@@ -48,6 +48,13 @@ module Rucola
           (@_notification_prefixes ||= {}).merge! prefixes
         end
         
+        # Creates a notification and posts it to the reciever
+        def fire_notification(notification, obj)
+          notification_name = resolve_notification_name(notification)
+          OSX::NSNotificationCenter.defaultCenter.postNotificationName_object(notification_name, obj)
+        end
+        alias_method :post_notification, :fire_notification
+        
         # Registers the object for the given notification and executes the given block when the
         # notification is posted to the OSX::NSNotificationCenter.defaultCenter.
         #
@@ -68,33 +75,8 @@ module Rucola
         #
         # You can even register shortcut prefixes. See +notification_prefix+.
         def notify_on(notification, &block)
-          notification_name = notification
-          
-          if notification_name.is_a? Symbol
-            notification_name = notification_name.to_s
-            
-            # first check if this notification_name uses a shortcut prefix
-            splitted_notification_name = notification_name.split('_')
-            prefix = splitted_notification_name.first.to_sym
-            if @_notification_prefixes and @_notification_prefixes.has_key? prefix
-              notification_name = @_notification_prefixes[prefix].to_s << '_' << splitted_notification_name[1..-1].join('_')
-            end
-
-            begin
-              # try with only Notification appended
-              notification_name = notification_name.camel_case << 'Notification'
-              OSX.const_get(notification_name)
-            rescue NameError
-              begin
-                # then try with NS prepended
-                notification_name = 'NS' << notification_name
-                OSX.const_get(notification_name)
-              rescue NameError
-                raise NameError, "Unable to find the notification corresponding to :#{notification}"
-              end
-            end
-          end
           
+          notification_name = resolve_notification_name(notification)
           method_name = "_handle_#{notification_name.snake_case}".to_sym
           
           # define the handle method
@@ -106,6 +88,29 @@ module Rucola
           @_registered_notifications[notification_name.to_s] = method_name
         end
         
+        # Registers the object for the given notification and executes the given block when the
+        # notification is posted to the OSX::NSNotificationCenter.defaultCenter.
+        #
+        #   class FooController < OSX::NSObject
+        #
+        #     once OSX::NSApplicationDidFinishLaunchingNotification do |notification|
+        #       puts "Application did finish launching."
+        #       p notification
+        #     end
+        #
+        #     # code
+        #
+        #   end
+        #
+        # You can also pass it a symbol as +notification+ in which case it will be exapnded.
+        # It will first check if the name + 'Notification' exists, if not it will prepend 'NS'.
+        # So :application_did_finish_launching becomes 'NSApplicationDidFinishLaunchingNotification'.
+        #
+        # You can even register shortcut prefixes. See +notification_prefix+.
+        #
+        # FIXME: Which is better +once+ or +notify_on+?
+        alias_method :once, :notify_on
+        
         # Register a callback when a notification is posted.
         #
         #     class FooController < OSX::NSObject
@@ -121,6 +126,41 @@ module Rucola
           @_registered_notifications[options[:when]] = method_to_notify
         end
         
+        protected
+
+        # Given a symbol, attempt to map it to an NSNoficication, otherwise 
+        # return the symbol if nothing is found.
+        #
+        #    :app_finished_launching => NSApplicationFinishLaunchingNotification
+        def resolve_notification_name(name)
+          return name if name.is_a?(String)
+          notification_name = name.to_s
+
+          # first check if this notification_name uses a shortcut prefix
+          split_notification_name = notification_name.split('_')
+          prefix = split_notification_name.first.to_sym
+          if @_notification_prefixes and @_notification_prefixes.has_key? prefix
+            notification_name = @_notification_prefixes[prefix].to_s << '_' << split_notification_name[1..-1].join('_')
+          end
+
+          begin
+            # try with only Notification appended
+            notification_name = notification_name.camel_case << 'Notification'
+            OSX.const_get(notification_name)
+            return notification_name
+          rescue NameError
+            # then try with NS prepended
+            begin
+              notification_name = 'NS' << notification_name
+              OSX.const_get(notification_name)
+              return notification_name
+            rescue 
+              
+            end
+          end
+          return name
+        end
+        
       end
       
       def self.included(base) # :nodoc

data/lib/rucola/rucola_support/rc_app.rb

@@ -1,3 +1,5 @@
+require 'rucola/info_plist'
+
 module Rucola
   module RCApp
     # Returns the path to the current source root of the application.
@@ -97,5 +99,12 @@ module Rucola
     end
     module_function :path_for_asset
 
+    # Returns the name of the application as specified in the Info.plist file.
+    #
+    #   Rucola::RCApp.app_name #=> 'MyApp'
+    def app_name
+      Rucola::InfoPlist.open((RUBYCOCOA_ROOT + 'config/Info.plist').to_s).app_name
+    end
+    module_function :app_name
   end
 end

data/lib/rucola/tasks/main.rake

@@ -6,8 +6,11 @@ require 'rucola/nib'
 require 'rucola/rucola_support'
 
 # set the env, default to debug if we are running a rake task.
-RUBYCOCOA_ENV = ENV['RUBYCOCOA_ENV'].nil? ? 'debug' : ENV['RUBYCOCOA_ENV']
-RUBYCOCOA_ROOT = ENV['RUBYCOCOA_ROOT'].nil? ? SOURCE_ROOT : ENV['RUBYCOCOA_ROOT']
+ENV['RUBYCOCOA_ENV']  ||= 'debug'
+ENV['RUBYCOCOA_ROOT'] ||= SOURCE_ROOT
+
+require 'rucola/initializer'
+
 puts "RUNNING IN MODE: #{RUBYCOCOA_ENV.upcase}\n\n"
 
 # FIXME: We also need to check if the user uses a frozen rc framework
@@ -16,8 +19,8 @@ RUBYCOCOA_FRAMEWORK = OSX::NSBundle.bundleWithIdentifier('com.apple.rubycocoa').
 # TASKS
 
 # Get all the tasks
-Dir["#{File.dirname(__FILE__)}/*.rake"].each {|file| load file unless File.basename(file) == 'main.rake' }
-
+Dir["#{File.dirname(__FILE__)}/*.rake"].each {|file| load file unless ['main.rake'].include? File.basename(file) }
+Dir[(ENV['RUBYCOCOA_ROOT'] + '/vendor/plugins/*/tasks/*.rake').to_s].each { |r| load r }
 task :default => 'xcode:build'
 
 desc 'Runs all the clean tasks'
@@ -25,5 +28,6 @@ task :clean => 'xcode:clean'
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/*/test_*.rb']
+  t.options = '-rr'
   t.verbose = true
 end

data/lib/rucola/tasks/xcode.rake

@@ -19,14 +19,18 @@ namespace :xcode do
   task :build do
     executable = "#{build_root}/Contents/MacOS/#{APPNAME}"
     
-    unless File.exists?(executable)
-      sh "xcodebuild -configuration #{config}"
-    else
-      puts "Build already exists, skipping. (Use clean if you really really want a new build.)\n\n"
-    end
+    # For now let's do xcodebuild everytime.
+    # Otherwise nibs that are updated will not be updated in the bundle...
+    sh "xcodebuild -configuration #{config}"
+    
+    # unless File.exists?(executable)
+    #   sh "xcodebuild -configuration #{config}"
+    # else
+    #   puts "Build already exists, skipping. (Use clean if you really really want a new build.)\n\n"
+    # end
     
     # Make sure the app is brought to the front once launched.
-    Thread.new do
+    Thread.new(executable) do |executable|
       sleep 0.025 until OSX::NSWorkspace.sharedWorkspace.launchedApplications.any? {|dict| dict['NSApplicationName'] == APPNAME }
       `osascript -e 'tell application "#{executable}" to activate'`
     end

data/lib/rucola/test_helper.rb

@@ -1,5 +1,14 @@
 require 'osx/cocoa'
 
+class Object
+  # A mocha helper to get at an instance variable without having to use instance_variable_get.
+  #
+  #   obj.ivar(:some_ivar).expects(:foo)
+  def ivar(name)
+    instance_variable_get("@#{name}".to_sym)
+  end
+end
+
 module OSX
   # Allows methods to be overriden with a different arity.
   #
@@ -9,6 +18,11 @@ module OSX
   def self._ignore_ns_override; true; end
 
   class NSObject
+    # A mocha helper to get at an outlet (ivar) without having to use instance_variable_get.
+    #
+    #   obj.ib_outlet(:some_text_view).expects(:string=).with('foo')
+    alias_method :ib_outlet, :ivar
+    
     # A Mocha helper method which allows to stub alloc.init and return a mock.
     #
     #   it "should init and return an instance" do

data/lib/rucola/version.rb

@@ -2,7 +2,7 @@ module Rucola #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/rucola/xcode.rb

@@ -13,7 +13,7 @@ module Rucola
       @project_path = Pathname.new(project_path)
       @project = @project_path.basename.to_s.sub(/\.xcodeproj$/, '')
       @project_path_data = @project_path + 'project.pbxproj'
-      @project_data = OSX::NSDictionary.dictionaryWithContentsOfFile(@project_path_data.to_s)
+      @project_data = OSX::NSMutableDictionary.dictionaryWithContentsOfFile(@project_path_data.to_s)
     end
     
     # Saves the project data atomically.
@@ -41,16 +41,20 @@ module Rucola
     end
     private :nil_if_empty
     
+    def objects
+      @project_data['objects'] = @project_data['objects'].to_ns
+    end
+    
     # Get's the id & values for a object which name is the one passed to this method.
     # Returns an array: [id, values]
     def object_for_name(name)
-      nil_if_empty @project_data['objects'].select { |object| object.last['name'] == name }.flatten
+      nil_if_empty objects.select { |object| object.last['name'] == name }.flatten
     end
     
     # Get's the id & values for a object which type and name is the one passed to this method.
     # Returns an array: [id, values]
     def object_for_type_and_name(type, name)
-      nil_if_empty @project_data['objects'].select { |object| object.last['isa'] == type and object.last['name'] == name }.flatten
+      nil_if_empty objects.select { |object| object.last['isa'] == type and object.last['name'] == name }.flatten
     end
     
     # Returns the object that represents this projects target.
@@ -62,18 +66,19 @@ module Rucola
     # Returns the object for a given name.
     # Returns an array: [id, values]
     def object_for_id(object_id)
-      @project_data['objects'][object_id].nil? ? nil : [object_id, @project_data['objects'][object_id]]
+      objects[object_id].nil? ? nil : [object_id, objects[object_id]]
     end
     
     # Adds an object to the objects.
     def add_object(object_id, object_values)
-      @project_data['objects'][object_id] = object_values
+      objects[object_id] = object_values
     end
     
     # Adds a build phase specified by +object_id+ to the build phases of the project target.
     def add_build_phase_to_project_target(object_id)
       # Add the new build phase to the main project target if it doesn't already exist
       build_target_id, build_target_values = object_for_project_target
+      build_target_values['buildPhases'] = build_target_values['buildPhases'].to_ns
       build_target_values['buildPhases'].push(object_id) unless build_target_values['buildPhases'].include?(object_id)
     end
     
@@ -89,7 +94,7 @@ module Rucola
       'dstPath' => '',
       'dstSubfolderSpec' => 10, # TODO: is 10 the number for the location popup choice: Frameworks
       'runOnlyForDeploymentPostprocessing' => 0,
-      'files' => []
+      'files' => [].to_ns
     }]
     # Creates a new framework copy build phase.
     # It does not add it to the objects nor the build phases,

data/rucola_generators/controller/controller_generator.rb

@@ -58,7 +58,7 @@ class ControllerGenerator < RubiGen::Base
   protected
     def banner
       <<-EOS
-Creates a ...
+Creates a controller that inherits from NSObject
 
 USAGE: #{$0} #{spec.name} name"
 EOS

data/rucola_generators/controller/templates/test_controller_template.rb.erb

@@ -1,10 +1,19 @@
 require File.expand_path('../../test_helper', __FILE__)
 
-class Test<%= name.camel_case %>Controller < Test::Unit::TestCase
-  
-  def test_<%= name.snake_case %>_controller_initialization
-    <%= name.snake_case %>_controller = <%= name.camel_case %>Controller.alloc.init
-    assert_instance_of(<%= name.camel_case %>Controller, <%= name.snake_case %>_controller)
+describe '<%= name.camel_case %>Controller' do
+  before do
+    @controller = <%= name.camel_case %>Controller.alloc.init
+  end
+
+  it "should initialize" do
+    @controller.should.be.an.instance_of <%= name.camel_case %>Controller
   end
   
+  it "should do stuff at awakeFromNib" do
+    # Some example code of testing your #awakeFromNib.
+    #
+    # @controller.ib_outlet(:some_text_view).expects(:string=).with('foo')
+    
+    @controller.awakeFromNib
+  end
 end

data/rucola_generators/document_model/document_model_generator.rb

@@ -9,7 +9,7 @@ class DocumentModelGenerator < RubiGen::Base
   
   def initialize(runtime_args, runtime_options = {})
     super
-    usage if args.empty?
+    usage if args.empty? || args.length == 1
     @name = args.shift
     @extension = args.shift
     extract_options
@@ -41,9 +41,9 @@ class DocumentModelGenerator < RubiGen::Base
   protected
     def banner
       <<-EOS
-Creates a ...
+Creates a model that inherits from NSDocument.
 
-USAGE: #{$0} #{spec.name} name"
+USAGE: #{$0} #{spec.name} name extension"
 EOS
     end