rucola 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-10-18
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Eloy Duran and Justin Palmer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,106 @@
+ChangeLog
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO
+app_generators/rucola/USAGE
+app_generators/rucola/rucola_generator.rb
+app_generators/rucola/templates/Rakefile.erb
+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/environment.rb
+app_generators/rucola/templates/config/environments/debug.rb
+app_generators/rucola/templates/config/environments/release.rb
+app_generators/rucola/templates/config/environments/test.rb
+app_generators/rucola/templates/config/ib_external_class_defs.yml
+app_generators/rucola/templates/misc/English.lproj/InfoPlist.strings.erb
+app_generators/rucola/templates/misc/English.lproj/MainMenu.nib/classes.nib
+app_generators/rucola/templates/misc/English.lproj/MainMenu.nib/info.nib
+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/plugin
+app_generators/rucola/templates/test/controllers/test_application_controller.rb
+app_generators/rucola/templates/test/test_helper.rb
+bin/rucola
+config/hoe.rb
+config/requirements.rb
+lib/rucola.rb
+lib/rucola/info_plist.rb
+lib/rucola/initializer.rb
+lib/rucola/nib.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/nsobject.rb
+lib/rucola/rucola_support/core_ext/ruby.rb
+lib/rucola/rucola_support/core_ext/ruby/string.rb
+lib/rucola/rucola_support/initialize_hooks.rb
+lib/rucola/rucola_support/models.rb
+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/freeze.rake
+lib/rucola/tasks/interface_builder.rake
+lib/rucola/tasks/main.rake
+lib/rucola/tasks/xcode.rake
+lib/rucola/test_helper.rb
+lib/rucola/version.rb
+lib/rucola/xcode.rb
+log/debug.log
+rucola_generators/controller/USAGE
+rucola_generators/controller/controller_generator.rb
+rucola_generators/controller/templates/controller_template.rb.erb
+rucola_generators/controller/templates/test_controller_template.rb.erb
+rucola_generators/document_model/USAGE
+rucola_generators/document_model/document_model_generator.rb
+rucola_generators/document_model/templates/document_model_template.rb.erb
+rucola_generators/document_model/templates/test_document_model_template.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
+rucola_generators/window_controller/templates/Window.nib/keyedobjects.nib
+rucola_generators/window_controller/templates/test_window_controller_template.rb.erb
+rucola_generators/window_controller/templates/window_controller_template.rb.erb
+rucola_generators/window_controller/window_controller_generator.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/fixtures/Info.plist
+test/fixtures/MainMenu.nib/classes.nib
+test/fixtures/MainMenu.nib/info.nib
+test/fixtures/MainMenu.nib/keyedobjects.nib
+test/test_controller_generator.rb
+test/test_core_ext.rb
+test/test_document_model_generator.rb
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_info_plist.rb
+test/test_nib.rb
+test/test_notifications.rb
+test/test_objc_core_ext.rb
+test/test_rc_app.rb
+test/test_rc_document.rb
+test/test_rc_window_controller.rb
+test/test_rucola.rb
+test/test_rucola_generator.rb
+test/test_window_controller_generator.rb
+test/test_xcode.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,126 @@
+## Rucola: Framework for writing Cocoa applications in Ruby
+
+SUPER DUPER PRE ALPHA VERSION (expect things to break kinda alpha...)
+
+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.
+
+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
+
+    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
+
+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.
+
+    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
+
+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.
+
+### 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
+
+To build your application, Rucola provides a simple rake command.  (You can also build your application in XCode)
+
+    rake xcode:build
+    
+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
+
+Browse the svn repo online at: http://rucola.rubyforge.org/svn/
+
+The latest version can be checked out with:
+
+    $ svn co svn://rubyforge.org/var/svn/rucola/trunk rucola
+
+A simpe sample app called Gembo can be found at:
+
+    $ svn co svn://rubyforge.org/var/svn/rucola/extras/examples/Gembo
+
+There's a basic TextMate bundle which contains only 4 commands which are the equivalent of the "go to file" commands in the rails bundle. With these going from a controller to it's test/model/view file is only a shortcut away. To get it:
+
+    $ cd ~/Library/Application\ Support/TextMate/Bundles/
+    $ svn co svn://rubyforge.org/var/svn/rucola/extras/Rucola.tmbundle
+
+There's a crash reporter plugin available, which you can install with script/plugin:
+
+    $ cd MyApp
+    $ script/plugin install SACrashReporter

data/Rakefile

@@ -0,0 +1,32 @@
+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
+# end

data/TODO

@@ -0,0 +1,28 @@
+* 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.
+
+* Create tests for initializer.rb.
+
+* Make sure autotest works with the application generated directory structure.
+
+* Create templates for testing in either TestUnit, TestSpec or rSpec.
+  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.
+
+* Create README & simple website and release first version!
+
+* 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.active_record = true
+  config.include_dirs << %w(models controllers lib)
+
+* When in debug mode and using ActiveRecord, allow database to reside in your working 
+  directory for easy access instead of buried in your users Application Support path.
+
+* Load database config from config/database.yml

data/app_generators/rucola/USAGE

@@ -0,0 +1,6 @@
+Description:
+  Running this command will give you a complete, working application with a single window already 
+  bound to your application controller.
+  
+Usage:
+  rucola MyApp -a "Your Name"

data/app_generators/rucola/rucola_generator.rb

@@ -0,0 +1,112 @@
+class RubiGen::Commands::Create
+  def symlink(relative_source, relative_destination)
+    return logger.identical(relative_destination) if File.exists?(destination_path(relative_destination))
+    # We don't want the symlink to point to a full path,
+    # so change to the destination_root and create the symlink.
+    Dir.chdir(destination_root) { File.symlink relative_source, relative_destination }
+  end
+end
+
+class RucolaGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :author => 'YOUR NAME'
+  
+  attr_reader :name, :project, :author
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    @project = name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      m.directory           'misc/English.lproj/MainMenu.nib' # TODO - allow alternate default languages
+
+      # Create stubs
+      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.template            "config/Info.plist.erb", "config/Info.plist"
+      m.symlink             "config/Info.plist", "Info.plist"
+      
+      m.file_copy_each      %w[debug.rb release.rb test.rb], "config/environments"
+
+      #m.template_copy_each  %w[main.m.erb rb_main.rb.erb], "misc"
+      m.template            "misc/main.m.erb", "misc/main.m"
+      m.template            "misc/rb_main.rb.erb", "misc/rb_main.rb"
+
+      # TODO - allow alternate default languages
+      m.template            "misc/English.lproj/InfoPlist.strings.erb", "misc/English.lproj/InfoPlist.strings"
+      m.file_copy_each      %w[classes.nib info.nib keyedobjects.nib], "misc/English.lproj/MainMenu.nib"
+
+      # xocde project
+      m.directory           "#{@project}.xcodeproj"
+      m.template            "project.pbxproj.erb", "#{@project}.xcodeproj/project.pbxproj"
+
+      # 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))
+
+      m.dependency "install_rubigen_scripts", [destination_root, "rucola"], 
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      opts.on("-a", "--author=\"Your Name\"", String,
+              "Places your name within some copyright headers.",
+              "Default: YOUR NAME") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      app/controllers
+      app/models
+      app/views
+      config/environments
+      script
+      test/controllers
+      test/models
+      vendor
+    )
+end

data/app_generators/rucola/templates/Rakefile.erb

@@ -0,0 +1,12 @@
+# 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'