hotcocoa 0.5.1 → 0.6.0pre

data/lib/hotcocoa.rb

@@ -1,26 +1,24 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 framework 'Cocoa'
 
-module Hotcocoa
-  VERSION = '0.0.1'
-  Views = {}
-end
+STDOUT.reopen(IO.for_fd(NSFileHandle.fileHandleWithStandardError.fileDescriptor.to_i, 'w'))
+
+##
+# HotCocoa is a Cocoa mapping library for MacRuby. It simplifies the use
+# of complex Cocoa classes using DSL techniques.
+module HotCocoa; end
 
-require 'hotcocoa/object_ext'
-require 'hotcocoa/kernel_ext'
+require 'hotcocoa/version'
+require 'hotcocoa/core_extensions'
 require 'hotcocoa/mappings'
+require 'hotcocoa/target_action_convenience'
 require 'hotcocoa/behaviors'
 require 'hotcocoa/mapping_methods'
 require 'hotcocoa/mapper'
 require 'hotcocoa/layout_view'
 require 'hotcocoa/delegate_builder'
 require 'hotcocoa/notification_listener'
-require 'hotcocoa/data_sources/table_data_source'
-require 'hotcocoa/data_sources/combo_box_data_source'
-require 'hotcocoa/plist'
+require 'hotcocoa/data_sources'
 require 'hotcocoa/kvo_accessors'
-require 'hotcocoa/attributed_string'
+require 'hotcocoa/attributed_string_helpers'
 
-HotCocoa::Mappings.reload
+HotCocoa::Mappings.reload

data/template/Rakefile

@@ -1,5 +1,33 @@
 require 'rubygems'
-require 'hotcocoa/application_builder'
-require 'hotcocoa/standard_rake_tasks'
+require 'hotcocoa/application/builder'
 
-task :default => [:run]
+builder = Application::Builder.new '__APPLICATION_NAME__.appspec'
+
+desc 'Build the application'
+task :build do
+  builder.build
+end
+
+desc 'Build a deployable version of the application'
+task :deploy do
+  builder.build deploy: true
+end
+
+desc 'Build and execute the application'
+task :run => [:build] do
+  builder.run
+end
+
+desc 'Cleanup build files'
+task :clean do
+  builder.remove_bundle_root
+end
+
+desc 'Create the dmg archive from the application bundle'
+task :dmg => :deploy do
+  app_name = builder.spec.name
+  rm_rf "#{app_name}.dmg"
+  sh "hdiutil create #{app_name}.dmg -quiet -srcdir #{app_name}.app -format UDZO -imagekey zlib-level=9"
+end
+
+task :default => [:run]

data/template/__APPLICATION_NAME__.appspec

@@ -0,0 +1,8 @@
+Application::Specification.new do |s|
+  s.name       = '__APPLICATION_NAME__'
+  s.identifier = 'com.__COMPANY_NAME__.__APPLICATION_NAME__'
+  s.version    = '1.0'
+  s.icon       = 'resources/HotCocoa.icns'
+  s.resources  = Dir.glob('resources/**/*.*')
+  s.sources    = Dir.glob('lib/**/*.rb')
+end

data/template/lib/application.rb

@@ -1,45 +1,42 @@
-require 'rubygems'
+require 'rubygems' # disable this for a deployed application
 require 'hotcocoa'
 
-# Replace the following code with your own hotcocoa code
-
-class Application
-
+class __APPLICATION_NAME__
   include HotCocoa
-  
+
   def start
-    application :name => "__APPLICATION_NAME__" do |app|
+    application name: '__APPLICATION_NAME__' do |app|
       app.delegate = self
-      window :frame => [100, 100, 500, 500], :title => "__APPLICATION_NAME__" do |win|
-        win << label(:text => "Hello from HotCocoa", :layout => {:start => false})
+      window frame: [100, 100, 500, 500], title: '__APPLICATION_NAME__' do |win|
+        win << label(text: 'Hello from HotCocoa', layout: {start: false})
         win.will_close { exit }
       end
     end
   end
-  
+
   # file/open
   def on_open(menu)
   end
-  
-  # file/new 
+
+  # file/new
   def on_new(menu)
   end
-  
+
   # help menu item
   def on_help(menu)
   end
-  
+
   # This is commented out, so the minimize menu item is disabled
   #def on_minimize(menu)
   #end
-  
+
   # window/zoom
   def on_zoom(menu)
   end
-  
+
   # window/bring_all_to_front
   def on_bring_all_to_front(menu)
   end
 end
 
-Application.new.start
+__APPLICATION_NAME__.new.start

data/template/lib/menu.rb

@@ -2,30 +2,30 @@ module HotCocoa
   def application_menu
     menu do |main|
       main.submenu :apple do |apple|
-        apple.item :about, :title => "About #{NSApp.name}"
+        apple.item :about, title: "About #{NSApp.name}"
         apple.separator
-        apple.item :preferences, :key => ","
+        apple.item :preferences, key: ','
         apple.separator
         apple.submenu :services
         apple.separator
-        apple.item :hide, :title => "Hide #{NSApp.name}", :key => "h"
-        apple.item :hide_others, :title => "Hide Others", :key => "h", :modifiers => [:command, :alt]
-        apple.item :show_all, :title => "Show All"
+        apple.item :hide, title: "Hide #{NSApp.name}", key: 'h'
+        apple.item :hide_others, title: 'Hide Others', key: 'h', modifiers: [:command, :alt]
+        apple.item :show_all, title: 'Show All'
         apple.separator
-        apple.item :quit, :title => "Quit #{NSApp.name}", :key => "q"
+        apple.item :quit, title: "Quit #{NSApp.name}", key: 'q'
       end
       main.submenu :file do |file|
-        file.item :new, :key => "n"
-        file.item :open, :key => "o"
+        file.item :new, key: 'n'
+        file.item :open, key: 'o'
       end
       main.submenu :window do |win|
-        win.item :minimize, :key => "m"
+        win.item :minimize, key: 'm'
         win.item :zoom
         win.separator
-        win.item :bring_all_to_front, :title => "Bring All to Front", :key => "o"
+        win.item :bring_all_to_front, title: 'Bring All to Front', key: 'o'
       end
       main.submenu :help do |help|
-        help.item :help, :title => "#{NSApp.name} Help"
+        help.item :help, title: "#{NSApp.name} Help"
       end
     end
   end

data/test/application/test_builder.rb

@@ -0,0 +1,28 @@
+require 'hotcocoa/application/builder'
+
+class TestApplicationBuilder < MiniTest::Unit::TestCase
+  include Application
+
+  TEST_DIR = File.join(ENV['TMPDIR'], 'test_app_specification')
+
+  # Some HotCocoa appspec files, converted from build.yml files borrowed from projects on Github
+  HOTCONSOLE = 'test/fixtures/hotconsole.appspec'
+  STOPWATCH  = 'test/fixtures/stopwatch.appspec'
+
+  def setup;    FileUtils.mkdir TEST_DIR; end
+  def teardown; FileUtils.rm_rf TEST_DIR; end
+
+  def test_caches_spec
+    spec = Specification.load STOPWATCH
+    builder = Builder.new spec
+    assert_equal spec, builder.spec
+  end
+
+  def test_deploy_options
+    spec = Specification.load STOPWATCH
+    builder = Builder.new spec
+    options = builder.send :deploy_options
+    assert options.include? "--gem rest-client"
+  end
+
+end

data/test/application/test_specification.rb

@@ -0,0 +1,280 @@
+require 'hotcocoa/application/specification'
+
+class TestApplicationSpecification < MiniTest::Unit::TestCase
+  include Application
+
+  # Some HotCocoa appspec files, converted from build.yml files borrowed from projects on Github
+  HOTCONSOLE = 'test/fixtures/hotconsole.appspec'
+  STOPWATCH  = 'test/fixtures/stopwatch.appspec'
+
+  def rescue_spec_error_for &block
+    begin
+      Specification.new &block
+    rescue Specification::Error => e
+      return e
+    end
+  end
+
+  def minimal_spec
+    Specification.new do |s|
+      s.name       = 'test'
+      s.identifier = 'com.test.test'
+      yield s if block_given?
+    end
+  end
+
+  def test_spec_requires_a_block
+    error = rescue_spec_error_for # no block given
+    assert_match /must pass a block/, error.message
+  end
+
+  def test_name_is_string_of_given_name
+    ['Test', [1,2,3]].each do |name|
+      spec = Specification.new do |s|
+        s.name       = name
+        s.identifier = 'com.test.test'
+      end
+      assert_equal name.to_s, spec.name
+    end
+  end
+
+  def test_name_is_verified
+    exception = rescue_spec_error_for { |_| }
+    assert_match /name is required/, exception.message
+
+    exception = rescue_spec_error_for { |s| s.name = '' }
+    assert_match /cannot be an empty string/, exception.message
+  end
+
+  def test_name_warns_if_too_long
+    output = capture_io do
+      rescue_spec_error_for { |s| s.name = 'Really long app name' }
+    end
+    assert_match /should be less than 16 characters/, output.last
+  end
+
+  def test_identifier_is_verified
+    exception = rescue_spec_error_for { |s| s.name = 'test' }
+    assert_match /identifier is required/, exception.message
+
+    exception = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = ''
+    end
+    assert_match /cannot be an empty string/, exception.message
+  end
+
+  def test_identifier_limits_character_set
+    exception = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = ','
+    end
+    assert_match /bundle identifier may only/, exception.message
+    assert_match /You had ","/, exception.message
+  end
+
+  def test_version_defaults_to_1_if_not_set
+    assert_equal '1.0', minimal_spec.version
+  end
+
+  def test_version_is_forced_to_a_string
+    spec = minimal_spec do |s|
+      s.version    = 3.1415
+    end
+    assert_equal '3.1415', spec.version
+  end
+
+  def test_short_version_is_empty_by_default
+    assert_nil minimal_spec.short_version
+  end
+
+  def test_short_version_is_forced_to_a_string_if_defined
+    spec = minimal_spec do |s|
+      s.short_version = 3.1415
+    end
+    assert_equal '3.1415', spec.short_version
+  end
+
+  def test_copyright_is_verified
+    assert_nil minimal_spec.copyright
+
+    spec = minimal_spec do |s|
+      s.copyright = Math::PI
+    end
+    assert_equal Math::PI.to_s, spec.copyright
+  end
+
+  def test_type_has_a_default
+    assert_equal 'APPL', minimal_spec.type
+
+    spec = minimal_spec { |s| s.type = 'BNDL' }
+    assert_equal 'BNDL', spec.type
+  end
+
+  def test_type_is_verified
+    error = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = 'com.test.test'
+      s.type       = 'TOO LONG'
+    end
+    assert_match /bundle type must be exactly 4 characters/, error.message
+
+    error = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = 'com.test.test'
+      s.type       = 'TOO'
+    end
+    assert_match /bundle type must be exactly 4 characters/, error.message
+  end
+
+  def test_signature_has_a_default
+    assert_equal '????', minimal_spec.signature
+
+    spec = minimal_spec { |s| s.signature = 'girb' }
+    assert_equal 'girb', spec.signature
+  end
+
+  def test_signature_is_verified
+    error = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = 'com.test.test'
+      s.signature  = 'thingy'
+    end
+    assert_match /bundle signature must be exactly 4 characters/, error.message
+
+    error = rescue_spec_error_for do |s|
+      s.name       = 'test'
+      s.identifier = 'com.test.test'
+      s.signature  = 'two'
+    end
+    assert_match /bundle signature must be exactly 4 characters/, error.message
+  end
+
+  def test_agent_has_a_default
+    assert_equal false, minimal_spec.agent
+
+    spec = minimal_spec { |s| s.agent = true }
+    assert_equal true, spec.agent
+  end
+
+  def test_agent_is_verified
+    spec = minimal_spec { |s| s.agent = 'cake' }
+    assert_equal true, spec.agent
+
+    spec = minimal_spec { |s| s.agent = nil }
+    assert_equal false, spec.agent
+  end
+
+  def test_sources_resources_and_data_models_are_initialized_to_an_empty_array_if_not_provided
+    spec = minimal_spec
+    assert_empty spec.sources
+    assert_empty spec.resources
+    assert_empty spec.data_models
+  end
+
+  def test_stdlib_attribute_true_by_default
+    spec = minimal_spec
+    assert_equal true, spec.stdlib
+
+    spec = minimal_spec { |s| s.stdlib = false }
+    assert_equal false, spec.stdlib
+
+    libs = ['base64', 'matrix']
+    spec = minimal_spec { |s| s.stdlib = libs }
+    assert_equal libs, spec.stdlib
+  end
+
+  def test_compile_is_true_by_default
+    spec = minimal_spec
+    assert spec.compile?
+    assert spec.compile
+
+    spec = minimal_spec { |s| s.compile = false }
+    refute spec.compile?
+    refute spec.compile
+  end
+
+  # test is kind of annoying since it tests code that does
+  # not belong to us
+  def test_add_dependency_adds_dependency_to_list
+    spec = minimal_spec do |s|
+      s.add_runtime_dependency 'jiraSOAP'
+      s.add_dependency         'nokogiri'
+      s.add_dependency         'mail',           '2.3.0'
+      s.add_dependency         'activesupport',  ['3.0.10']
+      s.add_dependency         'meme_generator', '~> 1.9.0'
+      s.add_dependency         'Salut',          '>= 0', '< 2.0.0'
+    end
+
+    assert spec.gems.all? { |s| s.kind_of? Gem::Dependency }
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('jiraSOAP', Gem::Requirement.default, :runtime)
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('nokogiri', Gem::Requirement.default, :runtime)
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('mail', '2.3.0', :runtime)
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('activesupport', '3.0.10', :runtime)
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('meme_generator', '~> 1.9.0', :runtime)
+
+    assert_includes spec.gems,
+      Gem::Dependency.new('Salut', '>= 0', '< 2.0.0', :runtime)
+  end
+
+  def test_embed_bs_has_a_default
+    spec = minimal_spec
+    assert_equal false, spec.embed_bs?
+    assert_equal false, spec.embed_bs
+
+    spec = minimal_spec { |s| s.embed_bs = true }
+    assert_equal true, spec.embed_bs?
+    assert_equal true, spec.embed_bs
+  end
+
+  def test_overwirte_attribute_is_false_by_default
+    spec = minimal_spec
+    refute spec.overwrite?
+
+    spec = minimal_spec { |s| s.overwrite = true }
+    assert spec.overwrite?
+  end
+
+  def test_icon_exists?
+    refute minimal_spec.icon_exists?
+
+    spec = minimal_spec { |s| s.icon = '/thing.png' }
+    refute spec.icon_exists?
+
+    spec = minimal_spec do |s|
+      s.icon = '/Applications/Calculator.app/Contents/Resources/Calculator.icns'
+    end
+    assert spec.icon_exists?
+  end
+
+  # doubles as an integration test
+  def test_load_evaluates_files_properly
+    spec = Application::Specification.load HOTCONSOLE
+    assert_equal 'HotConsole',                     spec.name
+    assert_equal 'com.vincentisambart.HotConsole', spec.identifier
+    assert_equal '1.0',                            spec.version
+    assert_equal Dir.glob('lib/**/*.rb'),          spec.sources
+    assert_equal [],                               spec.resources
+    assert_equal 'girb',                           spec.signature
+
+    spec = Application::Specification.load STOPWATCH
+    assert_equal 'Stopwatch',                         spec.name
+    assert_equal 'nz.co.kearse.stopwatch',            spec.identifier
+    assert_equal Dir.glob('{lib,hotcocoa}*/**/*.rb'), spec.sources
+    assert_equal [],                                  spec.resources
+    assert_equal true,                                spec.agent
+    assert_equal true,                                spec.overwrite
+    assert_equal false,                               spec.stdlib
+  end
+
+end

data/test/core_extensions/test_kernel.rb

@@ -0,0 +1,66 @@
+class TestKernelFramework < MiniTest::Unit::TestCase
+
+  def test_original_framework_loading_semantics_are_preserved
+    assert framework 'ApplicationServices'
+    refute framework 'Cocoa'
+
+    assert_raises RuntimeError do framework 'MadeUpFrameworkName' end
+  end
+
+  def test_loaded_frameworks
+    refute $LOADED_FRAMEWORKS.find { |x| x.match /.framework/ }
+    assert_empty $LOADED_FRAMEWORKS - $LOADED_FRAMEWORKS
+    assert_includes $LOADED_FRAMEWORKS, 'Cocoa'
+    assert_includes $LOADED_FRAMEWORKS, 'AppKit'
+    assert_includes $LOADED_FRAMEWORKS, 'Foundation'
+
+    refute_includes $LOADED_FRAMEWORKS, 'CoreWLAN'
+    framework 'CoreWLAN'
+    assert_includes $LOADED_FRAMEWORKS, 'CoreWLAN'
+  end
+
+end
+
+
+class TestKernelToPlist < MiniTest::Unit::TestCase
+  include HotCocoa
+
+  def test_normal_cases_in_xml
+    @format = :xml
+    normal_cases
+    @format = nil
+    normal_cases
+  end
+
+  def test_normal_cases_in_binary
+    @format = :binary
+    normal_cases
+  end
+
+  def normal_cases
+    assert_plist 123
+    assert_plist true
+    assert_plist false
+    assert_plist 'foo'
+    assert_plist 'aiueo'.transform('latin-hiragana')
+    assert_plist :foo, 'foo'
+    assert_plist [1,2,3]
+    assert_plist 'un' => 1, 'deux' => 2
+  end
+
+  def test_raises_error_for_invalid_objects
+    assert_raises Exception do nil.to_plist end
+    assert_raises Exception do Object.new.to_plist end
+    assert_raises Exception do /foo/.to_plist end
+    assert_raises Exception do nil.to_plist(:binary) end
+  end
+
+
+  private
+
+  def assert_plist val, expected = val
+    ret = @format ? load_plist(val.to_plist(@format)) : load_plist(val.to_plist)
+    assert_equal expected, ret
+  end
+
+end

data/test/core_extensions/test_nsarray.rb

@@ -0,0 +1,9 @@
+class TestNSArrayExt < MiniTest::Unit::TestCase
+
+  def test_convenience_accessors
+    array = NSArray.arrayWithArray([Math::PI, 42, 0.5])
+    assert_equal 42, array.second
+    assert_equal 0.5, array.third
+  end
+
+end

data/test/core_extensions/test_nsmutable_attributed_string.rb

@@ -0,0 +1,86 @@
+class TestNSMutableAttributedStringExt < MiniTest::Unit::TestCase
+
+  def attrs
+    {
+      NSFontAttributeName => NSFont.toolTipsFontOfSize(10),
+      NSObliquenessAttributeName => 5.0
+    }
+  end
+
+  def attr_string value = 'test'
+    string = NSMutableAttributedString.alloc.initWithString value,
+                                                attributes: attrs
+  end
+
+  def test_with_attributes_makes_new_attributed_string
+    string = NSMutableAttributedString.alloc.initWithString 'test',
+                                                attributes: attrs
+    refute_same string, string.with_attributes(attrs)
+  end
+
+  def test_with_attributes_uses_given_attributes
+    string = NSMutableAttributedString.alloc.initWithString 'test'
+    new_string = string.with_attributes attrs
+    assert_equal attrs, new_string.fontAttributesInRange(NSRange.new 0, 4)
+  end
+
+  def test_append_another_attributed_string
+    string = attr_string
+    other_string = attr_string ' other'
+    string << other_string
+    assert_equal 'test other', string.string
+    assert_equal attrs, string.fontAttributesInRange(NSRange.new 0, 10)
+  end
+
+  def test_append_a_string
+    string = attr_string
+    string << ' string'
+    assert_equal 'test string', string.string
+  end
+
+  def test_addition_makes_new_string
+    string = attr_string
+    new_string = string + string
+    refute_same string, new_string
+  end
+
+  def test_addition_sends_work_to_append
+    string = attr_string
+    NSMutableAttributedString.send :alias_method, :__temp__, :<<
+    NSMutableAttributedString.send :define_method, :<< do |_|
+      @append_called = true
+    end
+    new_string = string + string
+    assert new_string.instance_variable_get(:@append_called), 'append not called'
+  ensure
+    NSMutableAttributedString.send :alias_method, :<<, :__temp__
+  end
+
+  def test_attributes_returns_a_hash_of_attributes_used_on_the_string
+    string = attr_string
+    assert_equal attrs.sort, string.attributes.to_hash.sort
+  end
+
+  def test_replace_range_with_string
+    string = attr_string 'my string'
+    string[0..-1] = 'bwa ha ha'
+    assert_equal 'bwa ha ha', string.string
+
+    string[0...1] = 'm'
+    assert_equal 'mwa ha ha', string.string
+
+    string[0..8] = 'my string'
+    assert_equal 'my string', string.string
+
+    string[0...9] = 'bwa ha ha'
+    assert_equal 'bwa ha ha', string.string
+  end
+
+  def test_replace_range_with_attributed_string
+    string = attr_string 'my string'
+    string[0..-1] = attr_string 'bwa ha ha'
+    assert_equal 'bwa ha ha', string.string
+    assert_equal attrs, string.fontAttributesInRange(NSRange.new 0, 9)
+  end
+
+end

data/test/core_extensions/test_nsstring.rb

@@ -0,0 +1,20 @@
+class TestNSStringExt < MiniTest::Unit::TestCase
+
+  def test_convert_from_camelcase_to_underscore
+    assert 'SampleCamelCasedWord'.underscore, 'sample_camel_cased_word'
+  end
+
+  def test_convert_from_underscore_to_camelcase
+    assert 'sample_camel_cased_word'.camel_case, 'SampleCamelCasedWord'
+  end
+
+  def test_convert_to_attributed_string
+    attrs = {
+      NSFontAttributeName => NSFont.toolTipsFontOfSize(10),
+      NSObliquenessAttributeName => 5.0
+    }
+    string = 'my test string'.with_attributes attrs
+    assert_equal attrs, string.fontAttributesInRange(NSRange.new 0, 10)
+  end
+
+end

data/test/core_extensions/test_nsurl.rb

@@ -0,0 +1,9 @@
+class TestNSURLExt < MiniTest::Unit::TestCase
+
+  def test_aliases
+    url = NSURL.URLWithString 'http://macruby.org/'
+    assert_equal url.inspect, url.absoluteString
+    assert_equal url.to_s, url.absoluteString
+  end
+
+end