@@ -1,3 +1,24 @@ +2008-7-11 Eloy Duran <e.duran@superalloy.nl> + + * History.txt, + License.txt, + README.txt, + TODO, + bin/rucola, + lib/rucola/dependencies/override_require_and_gem.rb, + lib/rucola/dependencies/resolver.rb, + lib/rucola/nib.rb, + lib/rucola/ruby_debug.rb, + lib/rucola/rucola_support/notifications/notifications.rb, + lib/rucola/test_helper.rb, + lib/rucola/version.rb, + lib/rucola/xcode.rb, + website/index.html, + website/index.txt, + website/template.rhtml: + + Prepared for release 0.5. This will be the final ChangeLog entry, after this we'll rely on the nice git logs. Yay! :) + 2008-5-1 Eloy Duran <e.duran@superalloy.nl> * lib/rucola/tasks/xcode.rake: ChangeLog @@ -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. History.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 License.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. - \ No newline at end of file README.txt @@ -1,6 +1,6 @@ -* From script/console the configuration isn't ran. +* Clean up dependencies code which is used to disable rubygems in release mode. -* The activesupport gem messes up the require stuff in dependencies.rb. +* From script/console the configuration isn't ran. * Move MainMenu.nib to app/views @@ -10,13 +10,7 @@ * Choose between Notifications #notify_on and #once. -* add caching to notification name lookup - -* 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...? - -* 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. @@ -24,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 TODO @@ -4,8 +4,8 @@ require 'rubygems' require 'rubigen' if %w(-v --version).include? ARGV.first - require 'newgem/version' - puts "#{File.basename($0)} #{Newgem::VERSION::STRING}" + require 'rucola/version' + puts "#{File.basename($0)} #{Rucola::VERSION::STRING}" exit(0) end bin/rucola @@ -2,8 +2,9 @@ # make Gem work unless defined? Gem - module Gem - class LoadError < StandardError; end + module Gem #:nodoc: + class LoadError < StandardError #:nodoc: + end end end lib/rucola/dependencies/override_require_and_gem.rb @@ -3,8 +3,9 @@ require 'osx/cocoa' require File.expand_path('../exclusions', __FILE__) -class DependencyResolver - class UnableToResolveError < StandardError; end +class DependencyResolver #:nodoc: + class UnableToResolveError < StandardError #:nodoc: + end def initialize(name, version) @name, @version = name, version lib/rucola/dependencies/resolver.rb @@ -2,7 +2,7 @@ require 'osx/cocoa' require 'fileutils' module Rucola - module Nib + module Nib #:nodoc: def self.backup(path) nib = File.dirname(path) @@ -18,7 +18,7 @@ module Rucola FileUtils.cp_r(nib, backup) end - class Classes + class Classes #:nodoc: attr_reader :data def self.open(classes_nib_path) @@ -53,7 +53,7 @@ module Rucola end - class KeyedObjects + class KeyedObjects #:nodoc: attr_reader :data def self.open(path) lib/rucola/nib.rb @@ -4,9 +4,9 @@ end module Rucola module Debugger - def self.use! + def self.use! #:nodoc: Kernel.module_eval do - # When in `debug` mode, calling #debugger will try to load the ruby-debug gem. + # If enabled in the Configuration (default in `debug` environment is on), calling #debugger will try to load the ruby-debug gem. # In other modes however any call to #debugger will be ignored. # However, for performance reasons you still might want to take out any calls in a release build. def debugger(steps = 1) @@ -15,7 +15,7 @@ module Rucola private - def rucola_load_ruby_debug(steps) + def rucola_load_ruby_debug(steps) #:nodoc: require 'ruby-debug' debugger(steps) rescue LoadError lib/rucola/ruby_debug.rb @@ -1,34 +1,32 @@ require 'osx/cocoa' module Rucola - module Notifications - # This Notifications module will add a class method called +notify_on+, which registers - # your object for the given notification and executes the given block when the - # notification is posted to the OSX::NSNotificationCenter.defaultCenter. - # - # class FooController < OSX::NSObject - # - # notify_on OSX::NSApplicationDidFinishLaunchingNotification do |notification| - # puts "Application did finish launching." - # p notification - # end - # - # # code - # - # end - # - # In addition to notify_on, you also get a method called notify which allows you to specify methods - # to be invoked when a notification is posted. - # - # class FooController < OSX::NSObject - # notify :some_method, :when => :application_did_finish_launching - # - # def some_method(notification) - # puts "Application finished launching" - # end - # end - - + module Notifications #:nodoc: + # This Notifications module will add a class method called +notify_on+, which registers + # your object for the given notification and executes the given block when the + # notification is posted to the OSX::NSNotificationCenter.defaultCenter. + # + # class FooController < OSX::NSObject + # + # notify_on OSX::NSApplicationDidFinishLaunchingNotification do |notification| + # puts "Application did finish launching." + # p notification + # end + # + # # code + # + # end + # + # In addition to notify_on, you also get a method called notify which allows you to specify methods + # to be invoked when a notification is posted. + # + # class FooController < OSX::NSObject + # notify :some_method, :when => :application_did_finish_launching + # + # def some_method(notification) + # puts "Application finished launching" + # end + # end module ClassMethods # Add prefix shortcuts as a hash. # lib/rucola/rucola_support/notifications/notifications.rb @@ -9,13 +9,11 @@ class Object end end -module OSX +module OSX #:nodoc: # Allows methods to be overriden with a different arity. # - # TODO: Check with Laurent if this is bad? - # Otherwise we should maybe override the stub method to set this to true - # when the object is a subclass of OSX::NSObject and set it to false again after the stubbing. - def self._ignore_ns_override; true; end # FIXME: This seems to destroy the #super_init etc from working + # FIXME: This seems to destroy the #super_init etc from working + 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. lib/rucola/test_helper.rb @@ -1,8 +1,8 @@ module Rucola #:nodoc: module VERSION #:nodoc: MAJOR = 0 - MINOR = 0 - TINY = 3 + MINOR = 5 + TINY = 0 STRING = [MAJOR, MINOR, TINY].join('.') end lib/rucola/version.rb @@ -2,9 +2,7 @@ require 'osx/cocoa' require 'pathname' module Rucola - class Xcode - # FIXME: We should probably generate random id keys! - + class Xcode #:nodoc: attr_reader :project attr_reader :project_path attr_reader :project_data lib/rucola/xcode.rb @@ -33,7 +33,7 @@ <h1>rucola</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rucola"; return false'> Get Version - <a href="http://rubyforge.org/projects/rucola" class="numbers">0.0.3</a> + <a href="http://rubyforge.org/projects/rucola" class="numbers">0.5.0</a> </div> <h1>→ ‘rucola’</h1> @@ -41,12 +41,12 @@ <h2>What</h2> - A Framework for building Cocoa applications in Ruby + 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, @@ -58,7 +58,7 @@ ways of doing things. <ul> - <li><a href="http://sourceforge.net/project/showfiles.php?group_id=44114&package_id=36578">RubyCocoa 0.13</a> That’s NOT the one included with Leopard, which is 0.12</li> + <li><a href="http://sourceforge.net/project/showfiles.php?group_id=44114&package_id=36578">RubyCocoa 0.13.2</a> That’s NOT the one currently included with Leopard</li> <li>For testing it’s adviced to install the following gems: test-spec, mocha, zentest (autotest)</li> </ul> @@ -66,7 +66,7 @@ ways of doing things. <h2>Installing</h2> - <pre class='syntax'>sudo gem install rucola</pre> + <pre class='syntax'>$ sudo gem install rucola</pre> <h2>Demonstration of usage</h2> @@ -75,100 +75,21 @@ ways of doing things. <h3>Generating an application skeleton</h3> - <pre><code>rucola MyApp -a "Your Name"</code></pre> - +<code>$ rucola MyApp -a "Your Name"</code> Running this command will give you a complete, working application with a single window already bound to your application controller. - <h3>Using Notifications</h3> - - - <h4>Rucola -<pre class='syntax'> - class Foo < Rucola::RCController - notify :some_method, :when => :something_happens - - def some_method(notification) - puts "w00t!" - end - end - </pre></h4> - - - <h4>Objective C (Excluding header file) -<pre class='syntax'> - @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 - </pre></h4> - - - <h3>Alternative Way Of Using Notifications</h3> - - - <pre class='syntax'> - class Foo < Rucola::RCController - notify_on :something_happens do |notification| - puts "w0t0!" - end - end - </pre> - - - <h3>Working with Interface Builder</h3> + <h3>Running an application</h3> - 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. +<code>$ rake</code> - - <pre class='syntax'> - class ApplicationController < Rucola::RCController - 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 - </pre> - - - The `@main_window` variable now points to the user interface window. You can invoke any methods of NSWindow. - - - There is also a `rake ib:update` that will update your nib files with the outlets you specify in your code. -For example, if we wanted to add a button to the application controller above, we could add `ib_outlet :my_button`. -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. + <h2>Extras</h2> - <h2>Extras</h2> + Documentation can be found <a href="http://rucola.rubyforge.org/rdoc/">here.</a> Sample apps can be found at: @@ -216,8 +137,13 @@ script/plugin install SACrashReporter Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people’s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above. - The trunk repository is <code>svn://rubyforge.org/var/svn/rucola/trunk</code> for anonymous access. + Browse the git repo online at: <code>http://github.com/alloy/rucola/tree/master</code> + + + The latest version can be checked out with: + +<code>$ git clone git://github.com/alloy/rucola.git</code> <h2>License</h2> @@ -230,7 +156,7 @@ script/plugin install SACrashReporter Comments are welcome. Send an email via the <a href="http://groups.google.com/group/rucola">forum</a> - <a href="http://groups.google.com/group/rucola">Eloy Duran, Justin Palmer</a>, 26th November 2007 + <a href="http://groups.google.com/group/rucola">Eloy Duran</a>, 11th July 2008 Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </div> website/index.html @@ -4,11 +4,11 @@ h1. → 'rucola' h2. What -A Framework for building Cocoa applications in Ruby +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 @@ -16,101 +16,30 @@ ways of doing things. h2. Requirements -* "RubyCocoa 0.13":http://sourceforge.net/project/showfiles.php?group_id=44114&package_id=36578 That's NOT the one included with Leopard, which is 0.12 +* "RubyCocoa 0.13.2":http://sourceforge.net/project/showfiles.php?group_id=44114&package_id=36578 That's NOT the one currently included with Leopard * For testing it's adviced to install the following gems: test-spec, mocha, zentest (autotest) h2. Installing -<pre syntax="sh">sudo gem install rucola</pre> +<pre syntax="sh">$ sudo gem install rucola</pre> h2. Demonstration of usage h3. Generating an application skeleton - rucola MyApp -a "Your Name" + <code>$ rucola MyApp -a "Your Name"</code> Running this command will give you a complete, working application with a single window already bound to your application controller. +h3. Running an application -h3. Using Notifications - - h4. Rucola - <pre syntax="ruby"> - class Foo < Rucola::RCController - notify :some_method, :when => :something_happens - - def some_method(notification) - puts "w00t!" - end - end - </pre> - - h4. Objective C (Excluding header file) - <pre syntax="c"> - @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 - </pre> - -h3. Alternative Way Of Using Notifications - - <pre syntax="ruby"> - class Foo < Rucola::RCController - notify_on :something_happens do |notification| - puts "w0t0!" - end - end - </pre> - -h3. 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. - - <pre syntax="ruby"> - class ApplicationController < Rucola::RCController - 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 - </pre> - -The `@main_window` variable now points to the user interface window. You can invoke any methods of NSWindow. - -There is also a `rake ib:update` that will update your nib files with the outlets you specify in your code. -For example, if we wanted to add a button to the application controller above, we could add `ib_outlet :my_button`. -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. + <code>$ rake</code> h2. Extras +Documentation can be found "here.":http://rucola.rubyforge.org/rdoc/ + Sample apps can be found at: <pre syntax="sh"> svn co svn://rubyforge.org/var/svn/rucola/extras/examples/</pre> @@ -144,7 +73,11 @@ h2. How to submit patches Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above. -The trunk repository is <code>svn://rubyforge.org/var/svn/rucola/trunk</code> for anonymous access. +Browse the git repo online at: <code>http://github.com/alloy/rucola/tree/master</code> + +The latest version can be checked out with: + + <code>$ git clone git://github.com/alloy/rucola.git</code> h2. License website/index.txt @@ -37,7 +37,7 @@ </div> <%= body %> - <a href="http://groups.google.com/group/rucola">Eloy Duran, Justin Palmer</a>, <%= modified.pretty %> + <a href="http://groups.google.com/group/rucola">Eloy Duran</a>, <%= modified.pretty %> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </div> website/template.rhtml cce3b071a25ce5c47b217cc0d0f67f446ed7d1d4 Eloy Duran eloy.de.enige@gmail.com http://github.com/alloy/rucola/commit/16dccbe32f29c119ecd03ece29f89c846e378bdb 16dccbe32f29c119ecd03ece29f89c846e378bdb

2008-07-11T02:42:38-07:00

Prepared for release 0.5. 92e9e26a4236f40b516bb1d0a0d9b8e30f5042c2 Eloy Duran eloy.de.enige@gmail.com