rucola 0.0.3 → 0.5.0

data/History.txt

@@ -1,3 +1,28 @@
+== 0.5 2008-07-10
+
+=== Dependency resolver:
+* You can now specify your dependencies in environment.rb and they will resolved and vendored in release mode.
+  This applies to gems and any other ruby lib. Because of this agnostic system there might still be some edge cases, for this purpose
+  there's the possibility to specify exceptions.
+* In release mode RubyGems will NOT be loaded even if it's required at some point. This results in application startup time going from ~3 bounces in the dock to ~1.
+
+=== Deploying:
+* Added rake task for packaging a release build in a dmg
+* Added rake task for uploading via scp, adding others is easy.
+* Added rake task for creating a Sparkle appcast file.
+* Added rake task that looks for textile files in ReleaseNotes/AppName_Version and creates HTML for Sparkle.
+
+=== Others:
+* Added Rucola::FSEvents which is a rubyesque wrapper around FSEvents.
+* Added Rucola::Reloader, which uses Rucola::FSEvents to watch the app/controllers path for modifications and reloads the class.
+  In debug mode this will be enabled by default, you can override this setting on the `config` of Initializer.
+* Added the Rucola::Log class and an extension to Kernel to access it easily. (Manfred Stienstra)
+* Added Rucola::TestCase which is a test case mixin, like the one in Rails, which sets up a test case for a controller, defines helper methods and creates stubs for all ib_outlets that are defined in the controller.
+* Added support for ruby-debug. If a call is made to Kernel.debugger and the RUBYCOCOA_ENV is 'debug', then the ruby-debug library will be required and ran.
+* NSImage.imageNamed will also look in app/assets for a given image name.
+* Added a script/console script which will run a irb console with the application loaded. (Jelle Helsen)
+* Added a simple model generator, which is simply a subclass of NSObject.
+
 == 0.0.3 2007-12-08
 
 * Fixed some critical bugs in the xcode & nib manipulation code, which were introduced because the default is to return mutable objects in RubyCocoa again.

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Eloy Duran and Justin Palmer
+Copyright (c) 2007, 2008 Eloy Duran <e.duran@superalloy.nl>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -12,6 +12,7 @@ app_generators/rucola/templates/Rakefile.erb.old
 app_generators/rucola/templates/app/controllers/application_controller.rb
 app_generators/rucola/templates/config/Info.plist.erb
 app_generators/rucola/templates/config/boot.rb
+app_generators/rucola/templates/config/dependencies.rb
 app_generators/rucola/templates/config/environment.rb
 app_generators/rucola/templates/config/environments/debug.rb
 app_generators/rucola/templates/config/environments/release.rb
@@ -24,6 +25,7 @@ app_generators/rucola/templates/misc/English.lproj/MainMenu.nib/keyedobjects.nib
 app_generators/rucola/templates/misc/main.m.erb
 app_generators/rucola/templates/misc/rb_main.rb.erb
 app_generators/rucola/templates/project.pbxproj.erb
+app_generators/rucola/templates/script/console
 app_generators/rucola/templates/script/plugin
 app_generators/rucola/templates/test/controllers/test_application_controller.rb
 app_generators/rucola/templates/test/test_helper.rb
@@ -37,18 +39,30 @@ lib/autotest/pass.png
 lib/autotest/rucola.rb
 lib/autotest/sound.rb
 lib/rucola.rb
+lib/rucola/dependencies.rb
+lib/rucola/dependencies/exclusions.rb
+lib/rucola/dependencies/override_require_and_gem.rb
+lib/rucola/dependencies/resolver.rb
+lib/rucola/fsevents.rb
 lib/rucola/info_plist.rb
 lib/rucola/initializer.rb
+lib/rucola/log.rb
 lib/rucola/nib.rb
 lib/rucola/plugin.rb
+lib/rucola/reloader.rb
+lib/rucola/ruby_debug.rb
 lib/rucola/rucola_support.rb
 lib/rucola/rucola_support/controllers.rb
 lib/rucola/rucola_support/controllers/rc_controller.rb
 lib/rucola/rucola_support/controllers/rc_window_controller.rb
 lib/rucola/rucola_support/core_ext.rb
 lib/rucola/rucola_support/core_ext/objc.rb
+lib/rucola/rucola_support/core_ext/objc/nsimage.rb
 lib/rucola/rucola_support/core_ext/objc/nsobject.rb
 lib/rucola/rucola_support/core_ext/ruby.rb
+lib/rucola/rucola_support/core_ext/ruby/file.rb
+lib/rucola/rucola_support/core_ext/ruby/kernel.rb
+lib/rucola/rucola_support/core_ext/ruby/object.rb
 lib/rucola/rucola_support/core_ext/ruby/string.rb
 lib/rucola/rucola_support/initialize_hooks.rb
 lib/rucola/rucola_support/models.rb
@@ -56,10 +70,13 @@ lib/rucola/rucola_support/models/rc_document.rb
 lib/rucola/rucola_support/notifications.rb
 lib/rucola/rucola_support/notifications/notifications.rb
 lib/rucola/rucola_support/rc_app.rb
+lib/rucola/tasks/dependencies.rake
+lib/rucola/tasks/deploy.rake
 lib/rucola/tasks/freeze.rake
 lib/rucola/tasks/interface_builder.rake
 lib/rucola/tasks/main.rake
 lib/rucola/tasks/xcode.rake
+lib/rucola/test_case.rb
 lib/rucola/test_helper.rb
 lib/rucola/version.rb
 lib/rucola/xcode.rb
@@ -75,6 +92,10 @@ rucola_generators/document_model/templates/test_document_model_template.rb.erb
 rucola_generators/rucola_plugin/USAGE
 rucola_generators/rucola_plugin/rucola_plugin_generator.rb
 rucola_generators/rucola_plugin/templates/init.rb.erb
+rucola_generators/simple_model/USAGE
+rucola_generators/simple_model/simple_model_generator.rb
+rucola_generators/simple_model/templates/simple_model.rb.erb
+rucola_generators/simple_model/templates/test_simple_model.rb.erb
 rucola_generators/window_controller/USAGE
 rucola_generators/window_controller/templates/Window.nib/classes.nib.erb
 rucola_generators/window_controller/templates/Window.nib/info.nib
@@ -93,12 +114,21 @@ test/fixtures/Info.plist
 test/fixtures/MainMenu.nib/classes.nib
 test/fixtures/MainMenu.nib/info.nib
 test/fixtures/MainMenu.nib/keyedobjects.nib
+test/fixtures/dependencies/foo.rb
+test/fixtures/dependencies/foo/bar.rb
+test/fixtures/dependencies/foo/baz.rb
+test/fixtures/dependencies/requires_fileutils.rb
+test/fixtures/some_reloadable_class.rb
 test/test_controller_generator.rb
 test/test_core_ext.rb
+test/test_dependencies.rb
 test/test_document_model_generator.rb
+test/test_fsevents.rb
 test/test_generator_helper.rb
 test/test_helper.rb
 test/test_info_plist.rb
+test/test_initializer.rb
+test/test_log.rb
 test/test_nib.rb
 test/test_notifications.rb
 test/test_objc_core_ext.rb
@@ -106,9 +136,11 @@ test/test_plugin.rb
 test/test_rc_app.rb
 test/test_rc_document.rb
 test/test_rc_window_controller.rb
+test/test_reloader.rb
 test/test_rucola.rb
 test/test_rucola_generator.rb
 test/test_rucola_plugin_generator.rb
+test/test_simple_model_generator.rb
 test/test_window_controller_generator.rb
 test/test_xcode.rb
 website/index.html

data/README.txt

@@ -1,59 +1,21 @@
-## Rucola: Framework for writing Cocoa applications in Ruby
-
-SUPER DUPER PRE ALPHA VERSION (expect things to break kinda alpha...)
+= Rucola: A Framework for rapidly building RubyCocoa applications
 
 Rucola is a light weight framework that helps you write RubyCocoa apps.
 It allows you to build, test, and deploy applications using rake commands, 
-eliminating the need to use XCode, however you can use XCode if you wish.
+eliminating the need to use XCode for the most common tasks.
 
 Rucola provides a set of generators to help you generate controllers, window controllers, 
 and document-based applications.  It also provides APIs for simplifying some of Objective-C's 
 ways of doing things.
 
-### Generating an application skeleton
+== Generating an application skeleton
 
     rucola MyApp -a "Your Name"
 
 Running this command will give you a complete, working application with a single window already 
 bound to your application controller.
 
-
-### Using Notifications
-
-    //Rucola
-    class Foo < Rucola::RCController
-      notify :some_method, :when => :something_happens
-  
-      def some_method(notification)
-        puts "w00t!"
-      end
-    end
-
-    //Objective C (Excluding header file)
-    @implementation Foo
-    -(id)init {
-      if(self = [super init]) {
-        NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
-        [center addObserver:self selector:(some_method:) name:@"SomethingHappensNotification" object:nil];
-      }
-      return self;
-    }
-    
-    -(void)some_method:(NSNotification *) notification {
-      NSLog("w00t!");
-    }
-    @end
-
-### Alternative Way Of Using Notifications
-
-    //Rucola
-    class Foo < Rucola::RCController
-      notify_on :something_happens do |notification|
-        puts "w0t0!"
-      end
-    end
-
-### Working with Interface Builder
+== Working with Interface Builder
 
 A Cocoa application contains `outlets`.  Outlets allow you to bind variable names to objects.
 An object can be a user interface element or an instance of a class.
@@ -62,22 +24,10 @@ An object can be a user interface element or an instance of a class.
       ib_outlet :main_window
 
       def awakeFromNib
-        # All the application delegate methods will be called on this object.
-        OSX::NSApp.delegate = self
-
         puts "ApplicationController awoke."
         puts "Edit: app/controllers/application_controller.rb"
         puts  "\nIt's window is: #{@main_window.inspect}"
       end
-
-      # NSApplication delegate methods
-      def applicationDidFinishLaunching(notification)
-        puts "\nApplication finished launching."
-      end
-
-      def applicationWillTerminate(notification)
-        puts "\nApplication will terminate."
-      end
     end
 
 The `@main_window` variable now points to the user interface window.  You can invoke any methods of NSWindow.
@@ -87,14 +37,7 @@ For example, if we wanted to add a button to the application controller above, w
 After you've added this, you can run `rake ib:update` and your outlet will be available in interface builder that 
 you can now hook up to your UI button.
 
-### Configuring your application
-If you plan on using additional objective-c frameworks (WebKit, etc.) or ruby gems, you'll need to add these 
-in your environment.rb file.
-
-config.objc_frameworks = %w(WebKit IOKit)
-config.use_active_record = true
-
-### Building your application
+== Building your application
 
 To build your application, Rucola provides a simple rake command.  (You can also build your application in XCode)
 
@@ -104,15 +47,15 @@ To build your application, Rucola provides a simple rake command.  (You can also
 This will compile and run your application.  At the moment we don't bundle Ruby or the gems that you are using 
 in your application, we have plans to support this in order to make it really easy to distribute your application.
 
-### Extras
+== Extras
 
-Browse the svn repo online at: http://rucola.rubyforge.org/svn/
+Browse the git repo online at: http://github.com/alloy/rucola/tree/master
 
 The latest version can be checked out with:
 
-    $ svn co svn://rubyforge.org/var/svn/rucola/trunk rucola
+    $ git clone git://github.com/alloy/rucola.git
 
-Sample apps can be found at:
+Sample apps can be found at (old svn repo):
 
     $ svn co svn://rubyforge.org/var/svn/rucola/extras/examples/
 
@@ -122,4 +65,3 @@ There's a basic TextMate bundle which contains only 4 commands which are the equ
     $ svn co svn://rubyforge.org/var/svn/rucola/extras/Rucola.tmbundle
 
 There's a crash reporter plugin and a ActiveRecord plugin available, which you can install with script/plugin install. Use script/plugin list to see the ones available.
-    

data/Rakefile

@@ -1,32 +1,40 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-require 'rake/testtask'
-
-Rake::TaskManager.class_eval do
-  def remove_task(task_name)
-    @tasks.delete(task_name.to_s)
-  end
-end
- 
-def remove_task(task_name)
-  Rake.application.remove_task(task_name)
-end
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
-
-remove_task :test
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/test_*.rb']
-  t.options = '-rr'
-end
-
-# desc 'First uninstalls the currently installed Rucola gem and then installs the new one.'
-# task :install_gem_test do
-#   if `rake check_manifest`.split("\n").length == 1
-#     sh 'gem uninstall rucola'
-#     Rake::Task['install_gem_no_doc'].invoke
-#   else
-#     puts "You first might need to update the manifest!"
-#   end
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+ 
+def remove_task(task_name)
+  Rake.application.remove_task(task_name)
+end
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+remove_task :test
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+  #t.options = '-rr'
+end
+
+Rake::RDocTask.new do |t|
+  t.main = 'README.txt'
+  t.rdoc_files.include('README.txt', 'License.txt', 'lib/**/*.rb')
+  t.options << '--charset' << 'utf-8' << '--inline-source'
+end
+
+# desc 'First uninstalls the currently installed Rucola gem and then installs the new one.'
+# task :install_gem_test do
+#   if `rake check_manifest`.split("\n").length == 1
+#     sh 'gem uninstall rucola'
+#     Rake::Task['install_gem_no_doc'].invoke
+#   else
+#     puts "You first might need to update the manifest!"
+#   end
 # end

data/TODO

@@ -1,12 +1,16 @@
-* Choose between Notifications #notify_on and #once.
+* Clean up dependencies code which is used to disable rubygems in release mode.
+
+* From script/console the configuration isn't ran.
+
+* Move MainMenu.nib to app/views
 
-* add caching to notification name lookup
+* The fsevents test "should run the user specified block when one of the paths that was specified is modified", sometimes randomly fails.
 
-* rake ib:update doesn't yet update from model files. The question is, should we allow that,
-  or should people handle interaction with the view in the controller anyways...?
+* Need to refactor the rc freeze tasks with the xcode:frameworks tasks.
+
+* Choose between Notifications #notify_on and #once.
 
-* Did some restructuring of the dir layout with regards to controllers and initialize_hooks (rev 42).
-  Should probably look if the require structure is still ok... Justin knows about this.
+* Add caching to notification name lookup
 
 * Create tests for initializer.rb.
 
@@ -14,20 +18,8 @@
   I don't use rSpec anymore atm, so I (Eloy) will first focus on TestUnit & TestSpec.
   Actually I will just move it to test/spec.
 
-* No need to continuously rebuild your application when just changing a few lines of Ruby.
-  Still does xcodebuild for the build task, so add a check if the xcode project was updated,
-  if not then simply run the existing build.
-
-* Allow transparent packaging.  Developers need only worry about creating their application 
-  and basic configuration not the innards of packaging and releasing. 
-
-  config.objc_frameworks << ['Webkit', 'Quartz']
-  config.include_dirs << %w(models controllers lib)
-
 * Create rspec testing plugin
 
 * Create test/spec testing plugin
 
 * Create test/unit testing plugin
-
-* Allow plugins to be installed as gems with a config/dependencies.rb like merb

data/app_generators/rucola/rucola_generator.rb

@@ -37,7 +37,7 @@ class RucolaGenerator < RubiGen::Base
       m.template            "Rakefile.erb",  "Rakefile"
       
       m.file                "app/controllers/application_controller.rb", "app/controllers/application_controller.rb"
-      m.file_copy_each      %w[boot.rb environment.rb ib_external_class_defs.yml], "config"
+      m.file_copy_each      %w[boot.rb dependencies.rb environment.rb ib_external_class_defs.yml], "config"
       m.template            "config/Info.plist.erb", "config/Info.plist"
       m.symlink             "config/Info.plist", "Info.plist"
       
@@ -58,18 +58,22 @@ class RucolaGenerator < RubiGen::Base
       # test
       m.file                "test/test_helper.rb", "test/test_helper.rb"
       m.file                "test/controllers/test_application_controller.rb", "test/controllers/test_application_controller.rb"
-
-      plugin = 'script/plugin'
-      logger.create plugin
-      FileUtils.mkdir_p File.dirname(destination_path(plugin))
-      FileUtils.copy(source_path(plugin), destination_path(plugin))
-      File.chmod(0755, destination_path(plugin))
-
+      
+      copy_and_make_executable('script/plugin')
+      copy_and_make_executable('script/console')
+      
       m.dependency "install_rubigen_scripts", [destination_root, "rucola"], 
         :shebang => options[:shebang], :collision => :force
     end
   end
 
+  def copy_and_make_executable(file)
+    logger.create file
+    FileUtils.mkdir_p File.dirname(destination_path(file))
+    FileUtils.copy(source_path(file), destination_path(file))
+    File.chmod(0755, destination_path(file))
+  end
+  
   protected
     def banner
       <<-EOS
@@ -103,9 +107,12 @@ EOS
       app/controllers
       app/models
       app/views
+      app/assets
       config/environments
+      lib
       script
       test/controllers
+      test/lib
       test/models
       vendor
     )

data/app_generators/rucola/templates/Rakefile.erb

@@ -1,12 +1,40 @@
-# Application configuration
-APPNAME               = "<%= name %>"
-TARGET                = "#{APPNAME}.app"
-#APPVERSION           = "rev#{`svn info`[/Revision: (\d+)/, 1]}"
-APPVERSION            = Time.now.strftime("%Y-%m-%d")
-PUBLISH               = 'yourname@yourhost:path'
-
 # Load Rucola tasks
 SOURCE_ROOT = File.dirname(__FILE__)
 require 'rubygems'
 require 'rucola/rucola_support'
 load 'rucola/tasks/main.rake'
+
+# Application configuration
+
+# You only need to specify this if for some reason the applications name
+# might be different than the one specified in the Info.plist file under key: CFBundleExecutable
+#
+# APPNAME = "<%= name %>"
+# TARGET  = "#{APPNAME}.app"
+
+# You only need to specify this if for some reason the applications version
+# might be different than the one specified in the Info.plist file under key: CFBundleVersion
+#
+# APPVERSION = INFO_PLIST['CFBundleShortVersionString']
+# APPVERSION = "rev#{`svn info`[/Revision: (\d+)/, 1]}"
+# APPVERSION = Time.now.strftime("%Y-%m-%d")
+
+# Use these constants to define the urls that should be used by the deploy:upload task.
+#
+# PUBLISH_URI = URI.parse('scp://yourname@yourhost:port/path')
+# APPCAST_URI = PUBLISH_URI
+
+# Tasks
+
+desc 'Deploy a release build.'
+task :deploy do
+  puts "\nDeploying...\n\n"
+  
+  # Rake::Task['release'].invoke
+  # Rake::Task['deploy:package'].invoke
+  # Rake::Task['deploy:sparkle_appcast'].invoke
+  # Rake::Task['deploy:release_notes'].invoke
+  # Rake::Task['deploy:upload'].invoke
+  # Rake::Task['xcode:clean'].invoke
+  # Rake::Task['dependencies:clean'].invoke
+end