rucola 0.0.1

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/fixtures/Info.plist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>MyApp</string>
+	<key>CFBundleIconFile</key>
+	<string></string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>NSMainNibFile</key>
+	<string>MainMenu</string>
+	<key>NSPrincipalClass</key>
+	<string>NSApplication</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.apple.rubycocoa.MyAppApp</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+</dict>
+</plist>

data/test/fixtures/MainMenu.nib/classes.nib

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IBClasses</key>
+	<array>
+		<dict>
+			<key>CLASS</key>
+			<string>FirstResponder</string>
+			<key>LANGUAGE</key>
+			<string>ObjC</string>
+			<key>SUPERCLASS</key>
+			<string>NSObject</string>
+		</dict>
+		<dict>
+			<key>CLASS</key>
+			<string>ApplicationController</string>
+			<key>LANGUAGE</key>
+			<string>ObjC</string>
+			<key>OUTLETS</key>
+			<dict>
+				<key>main_window</key>
+				<string>id</string>
+			</dict>
+			<key>SUPERCLASS</key>
+			<string>NSObject</string>
+		</dict>
+	</array>
+	<key>IBVersion</key>
+	<string>1</string>
+</dict>
+</plist>

data/test/fixtures/MainMenu.nib/info.nib

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IBFramework Version</key>
+	<string>629</string>
+	<key>IBOldestOS</key>
+	<integer>5</integer>
+	<key>IBOpenObjects</key>
+	<array>
+		<integer>21</integer>
+	</array>
+	<key>IBSystem Version</key>
+	<string>9A581</string>
+	<key>targetFramework</key>
+	<string>IBCocoaFramework</string>
+</dict>
+</plist>

data/test/test_controller_generator.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+require 'rucola/nib'
+
+class TestControllerGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    # say yes to the question if we want to add the controller to the classes in MainMenu.nib
+    Kernel.expects(:gets).returns("Y\n")
+    
+    nib_path = File.expand_path('../tmp/myproject/misc/English.lproj/MainMenu.nib/classes.nib', __FILE__)
+    nib_mock = mock_nib(nib_path)
+    
+    name = "Articles"
+    run_generator('controller', [name], sources)
+    
+    assert_generated_file     'app/controllers/articles_controller.rb'
+    assert_generated_file     'test/controllers/test_articles_controller.rb'
+  end
+  
+  def test_generator_with_options_nibs_to_update
+    main_nib_path = File.expand_path('../tmp/myproject/misc/English.lproj/MainMenu.nib/classes.nib', __FILE__)
+    main_nib_mock = mock_nib(main_nib_path)
+    
+    foo_nib_path = File.expand_path('../tmp/myproject/app/views/Foo.nib/classes.nib', __FILE__)
+    foo_nib_mock = mock_nib(foo_nib_path)
+    
+    name = "Articles"
+    run_generator('controller', [name, 'MainMenu', 'Foo'], sources)
+    
+    assert_generated_file     'app/controllers/articles_controller.rb'
+    assert_generated_file     'test/controllers/test_articles_controller.rb'
+  end
+  
+  def mock_nib(nib_path)
+    nib_mock = mock('Classes Nib')
+    Rucola::Nib::Classes.expects(:open).with(nib_path).returns(nib_mock)
+    nib_mock.expects(:add_class).with('ArticlesController')
+    nib_mock.expects(:save)
+    nib_mock
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rucola_generators"
+  end
+end

data/test/test_core_ext.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+describe 'String#camel_case' do
+  it "should return foo_bar as FooBar" do
+    "foo_bar".camel_case.should == 'FooBar'
+  end
+  
+  it "should return FooBar as FooBar" do
+    "FooBar".camel_case.should == 'FooBar'
+  end
+  
+  it "should return foo as Foo" do
+    'foo'.camel_case.should == 'Foo'
+  end
+end

data/test/test_document_model_generator.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestDocumentModelGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    name = "MyDocument"
+    extension = 'mydocext'
+    
+    plist_mock = mock('Info Plist')
+    OSX::NSDictionary.expects(:dictionaryWithContentsOfFile).returns(plist_mock)
+    doc_types = []
+    plist_mock.expects(:[]).with('CFBundleDocumentTypes').returns(doc_types)
+    plist_mock.expects(:writeToFile_atomically)
+    
+    run_generator('document_model', [name, extension], sources)
+
+    assert doc_types.length, 1
+    assert doc_types.first['NSDocumentClass'] == name
+
+    assert_generated_file     'app/controllers/my_document_controller.rb'
+    assert_generated_file     'test/controllers/test_my_document_controller.rb'
+
+    assert_generated_file     'app/models/my_document.rb'
+    assert_generated_file     'test/models/test_my_document.rb'
+    
+    assert_directory_exists   'app/views/MyDocument.nib'
+    assert_generated_file     'app/views/MyDocument.nib/classes.nib'
+    assert_generated_file     'app/views/MyDocument.nib/info.nib'
+    assert_generated_file     'app/views/MyDocument.nib/keyedobjects.nib'
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rucola_generators"
+  end
+end

data/test/test_generator_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "test/unit"
+require "test/spec"
+require "mocha"
+require 'osx/cocoa'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+FIXTURES = File.expand_path('../fixtures/', __FILE__)
+$TESTING = true
+
+require 'rucola/rucola_support'
+require 'rucola/test_helper'

data/test/test_info_plist.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../test_helper', __FILE__)
+require 'rucola/info_plist'
+
+describe "Info" do
+  before do
+    @path = FIXTURES + '/Info.plist'
+    @info_plist = Rucola::InfoPlist.open(@path)
+  end
+  
+  it "should be able to load an Info.plist file" do
+    @info_plist.data.should.be.an.instance_of OSX::NSCFDictionary
+  end
+  
+  it "should be able to add document types" do
+    before = @info_plist.document_types.length
+    @info_plist.add_document_type('MyDocument', 'mydocextension', 'Editor')
+    @info_plist.add_document_type('MyDocument2', 'mydocextension2', 'Editor')
+    
+    @info_plist.document_types.length.should.be before + 2
+    
+    @info_plist.document_types.to_ruby.should == [
+      {"CFBundleTypeOSTypes"=>["????"], "CFBundleTypeExtensions"=>["mydocextension"], "NSDocumentClass"=>"MyDocument", "CFBundleTypeName"=>"DocumentType", "CFBundleTypeIconFile"=>"????", "CFBundleTypeRole"=>"Editor"},
+      {"CFBundleTypeOSTypes"=>["????"], "CFBundleTypeExtensions"=>["mydocextension2"], "NSDocumentClass"=>"MyDocument2", "CFBundleTypeName"=>"DocumentType", "CFBundleTypeIconFile"=>"????", "CFBundleTypeRole"=>"Editor"}
+    ]
+  end
+  
+  it "should be able to save the plist" do
+    @info_plist.data.expects(:writeToFile_atomically).with(@path, true)
+    @info_plist.save
+  end
+end

data/test/test_nib.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../test_helper', __FILE__)
+require 'rucola/nib'
+
+include Rucola
+
+describe 'Nib' do
+  it "should be able to backup a nib" do
+    path = '/some/path/MainMenu.nib/classes.nib'
+    backup = "/tmp/MainMenu.nib.bak"
+    File.expects(:exists?).with(backup).returns(true)
+    FileUtils.expects(:rm_rf).with(backup)
+    FileUtils.expects(:cp_r).with(File.dirname(path), backup)
+    Rucola::Nib.backup(path)
+  end
+end
+
+describe 'Nib::Classes' do
+  before do
+    @path = FIXTURES + '/MainMenu.nib/classes.nib'
+    @nib = Nib::Classes.open(@path)
+  end
+  
+  it "should be able to load the classes.nib" do
+    @nib.data.should.be.an.instance_of OSX::NSCFDictionary
+    @nib.classes.should.be.an.instance_of OSX::NSCFArray
+    @nib.classes.last['CLASS'].should == 'ApplicationController'
+  end
+  
+  it "should be able to add a subclass of NSObject" do
+    before = @nib.classes.length
+    @nib.add_class('FooController')
+    @nib.classes.length.should.be before + 1
+    
+    @nib.classes.last.to_ruby.should == { 'CLASS' => 'FooController', "LANGUAGE"=>"ObjC", "SUPERCLASS"=>"NSObject" }
+  end
+  
+  it "should be able to save the classes.nib" do
+    Rucola::Nib.expects(:backup).with(@path)
+    @nib.data.expects(:writeToFile_atomically).with(@path, true)
+    @nib.save
+  end
+  
+  it "should be able to check if a class is defined" do
+    @nib.add_class('BarController')
+    @nib.has_class?('BarController').should.be true
+    @nib.has_class?('NotInThere').should.be false
+  end
+end
+
+describe 'Nib::KeyedObjects' do
+  before do
+    @path = FIXTURES + '/MainMenu.nib/keyedobjects.nib'
+    @nib = Nib::KeyedObjects.open(@path)
+  end
+  
+  it "should be able to load the keyedobjects.nib" do
+    @nib.data.should.be.an.instance_of OSX::NSCFDictionary
+  end
+  
+  it "should be able to change the custom class of the File's owner" do
+    @nib.change_files_owner_class('Japie')
+    @nib.files_owner_class.should == 'Japie'
+  end
+  
+  it "should be able to save the keyedobjects.nib" do
+    plist_mock = mock('Serialized Plist mock')
+    OSX::NSPropertyListSerialization.expects(:dataFromPropertyList_format_errorDescription).with(@nib.data, OSX::NSPropertyListBinaryFormat_v1_0).returns(plist_mock)
+    Rucola::Nib.expects(:backup).with(@path)
+    File.expects(:exists?).with(File.dirname(@path))
+    plist_mock.expects(:writeToFile_atomically).with(@path, true)
+    @nib.save
+  end
+end

data/test/test_notifications.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class FooNotifiable < Rucola::RCController; end
+class BarNotifiable < Rucola::RCController; end
+class BazNotifiable < Rucola::RCController; end
+class BlaNotifiable < Rucola::RCController; end
+class FuNotifiable < Rucola::RCController; end
+class KungNotifiable < Rucola::RCController; end
+class Person < Rucola::RCController; end
+
+describe 'Rucola::Notifications' do
+  it "should handle notifications when included" do
+    FooNotifiable.instance_variable_get(:@_registered_notifications).should.be.nil
+    
+    FooNotifiable.notify_on 'FooNotification' do |notification|
+      some_instance_method
+    end
+    
+    FooNotifiable.instance_variable_get(:@_registered_notifications).length.should.be 1
+    
+    instance = FooNotifiable.alloc.init
+    instance.methods.should.include '_handle_foo_notification'
+    
+    instance.expects(:some_instance_method)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object('FooNotification', self)
+  end
+  
+  it "should be able to handle the original string representations of the notifications" do
+    BarNotifiable.notify_on 'NSApplicationDidFinishLaunchingNotification' do |notification|
+      app_finished_launching
+    end
+    
+    BarNotifiable.alloc.init.expects(:app_finished_launching)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object(OSX::NSApplicationDidFinishLaunchingNotification, self)
+  end
+  
+  it "should also be able to handle the abbreviated symbol representation of a notification" do
+    BazNotifiable.notify_on :application_did_become_active do |notification|
+      app_did_become_active
+    end
+    
+    BazNotifiable.alloc.init.expects(:app_did_become_active)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object(OSX::NSApplicationDidBecomeActiveNotification, self)
+  end
+  
+  it "should raise a NameError exception if the abbreviated notification wasn't found" do
+    lambda { BlaNotifiable.notify_on :does_not_exist do |notification|; end }.should.raise NameError
+  end
+  
+  it "should also allow the user to define shortcuts" do
+    FuNotifiable.notification_prefix :win => :window
+    
+    FuNotifiable.notify_on :win_did_become_key do |notification|
+      window_did_become_key
+    end
+  
+    FuNotifiable.alloc.init.expects(:window_did_become_key)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object(OSX::NSWindowDidBecomeKeyNotification, self)
+  end
+  
+  it "should by default have the shortcut app => application" do
+    KungNotifiable.notify_on :app_will_terminate do |notification|
+      app_will_terminate_called!
+    end
+    
+    KungNotifiable.alloc.init.expects(:app_will_terminate_called!)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object(OSX::NSApplicationWillTerminateNotification, self)
+  end
+  
+  it "should call a given method when a certain notification is called" do
+    Person.notify :method_to_notify, :when => 'MyNotification'
+    Person.alloc.init.expects(:method_to_notify)
+    OSX::NSNotificationCenter.defaultCenter.postNotificationName_object("MyNotification", nil)
+  end
+end