hotcocoa 0.6.0pre2 → 0.6.0

data/History.txt

@@ -1,19 +1,23 @@
-=== 0.6.0 2011-10-xx
+=== 0.6.0 2011-10-14
 
-* 8 enhancements:
+* 10 enhancements:
   * New application builder to work with MacRuby 0.11
-  * Application templates now use an appspec, similar to a gemspec
-  * Truer lazy loading for mappings (may break custom mappings!)
-  * API documention (67% coverage so far)
+  * Old application builder is deprecated
+  * New application templates now use an appspec, similar to a gemspec
+  * config.yml is now deprecated
+  * Lazier loading for mappings (may break custom mappings!)
+  * API documention (~67% coverage so far)
   * Regression tests (< 67% coverage so far)
   * Updating and porting of the tutorial documentation (~40% complete)
-  * HotCocoa now works when compiled
-  * HotCocoa is now leaner and meaner
+  * HotCocoa now works when compiled (HotCocoa will boot ~2.5 faster)
+  * HotCocoa is now leaner
+  * Various bug fixes
 
-* 3 new mappings:
-  * NSNetService          => bonjour_service
-  * NSNetServiceBrowser   => bonjour_browser
-  * NSBezierPath          => line
+* 4 new mappings:
+  * bonjour_service => NSNetService
+  * bonjour_browser => NSNetServiceBrowser
+  * line           => NSBezierPath
+  * tracking_area  => NSTrackingArea
 
 * 2 graphics improvements:
   * Image class works with more image types

data/lib/hotcocoa/application/builder.rb

@@ -186,6 +186,7 @@ module Application
         LSMinimumSystemVersion:        '10.6.7', # @todo should match MacRuby
       }
       info[:CFBundleIconFile] = File.basename(spec.icon) if spec.icon_exists?
+      info[:CFBundleDocumentTypes] = spec.doc_types.map(&:info_plist_representation) unless spec.doc_types.empty?
       info.merge! spec.plist # should always be done last
       info.to_plist
     end

data/lib/hotcocoa/application/document_type_specification.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+
+##
+# Application is a namespace for the classes that are used to specify
+# and build application bundles.
+module Application
+
+  ##
+  # This class represents the configuration for a document type, used by document-based applications.
+  # It is used to generate the Info.plist file
+  #
+  # See http://developer.apple.com/library/mac/#documentation/Carbon/Conceptual/LaunchServicesConcepts/LSCConcepts/LSCConcepts.html for details.
+  #
+  class DocumentTypeSpecification
+    VALID_ROLES = {:editor => "Editor", :viewer => "Viewer", :none => "None"}
+
+    attr_writer :extensions
+    attr_writer :icon
+    attr_writer :name
+    attr_writer :role
+    attr_writer :class
+
+    def initialize
+      unless block_given?
+        msg = 'You must pass a block at initialization to declare the new document type'
+        raise ArgumentError, msg
+      end
+      yield self
+      
+      verify!
+    end
+    
+    # @todo CFBundleTypeMIMETypes
+    # @todo LSTypeIsPackage
+    # @todo CFBundleTypeOSTypes
+    def info_plist_representation
+      {
+        CFBundleTypeExtensions: @extensions,
+        CFBundleTypeIconFile:   @icon,
+        CFBundleTypeName:       @name,
+        CFBundleTypeRole:       VALID_ROLES[@role], 
+        NSDocumentClass:        @class
+      }
+    end
+    
+    protected
+    def verify!
+      verify_name
+      verify_extensions
+      verify_role
+    end
+    
+    def verify_name
+      raise ArgumentError, "doc type name must not be empty" if @name.nil? or @name.empty?
+    end
+    
+    def verify_extensions
+      raise ArgumentError, "doc type extensions must be an array" unless @extensions.is_a?(Array)
+    end
+    
+    def verify_role
+      raise ArgumentError, "#{@role} is not a valid role. A doc type role must be one of [:editor, :viewer, :none]" unless VALID_ROLES.keys.include?(@role)
+    end
+  end
+end

data/lib/hotcocoa/application/specification.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 require 'rubygems'
+require 'hotcocoa/application/document_type_specification'
 
 ##
 # Application is a namespace for the classes that are used to specify
@@ -114,9 +115,11 @@ module Application
     # @return [Boolean]
     attr_accessor :agent
 
-    # @todo CFBundleDocumentTypes
+    ##
+    # The list of document types supported by the application (for document-based applications only). Optional
+    #
     # @return [Array<Hash>]
-    # attr_accessor :doc_types
+    attr_accessor :doc_types
 
     ##
     # Any additional plist values that an application could have.
@@ -232,6 +235,23 @@ module Application
     end
     alias_method :add_dependency, :add_runtime_dependency
 
+    ##
+    # Declares a document type for your document-driven application.
+    # (see http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/Documents/Tasks/ImplementingDocApp.html)
+    #
+    # @example
+    #
+    #  spec.declare_doc_type do |doc_type|
+    #    doc_type.extensions = ["ext"]
+    #    doc_type.icon       = "MyIcon.icns"
+    #    doc_type.name       = "MyProjectDocument"
+    #    doc_type.role       = :editor
+    #    doc_type.class      = "MyDocument"
+    #  end
+    def declare_doc_type(&block)
+      @doc_types << DocumentTypeSpecification.new(&block)
+    end
+
     ##
     # Whether or not to embed BridgeSupport files when embedding the
     # MacRuby framework during deployment.
@@ -254,24 +274,8 @@ module Application
 
     # @endgroup
 
-    DEFAULT_ATTRIBUTES = {
-      plist:       {},
-      sources:     [],
-      resources:   [],
-      data_models: [],
-      gems:        [],
-      type:        'APPL',
-      signature:   '????',
-      version:     '1.0',
-      stdlib:      true,
-      agent:       false,
-      compile:     true,
-      overwrite:   false,
-      embed_bs:    false
-    }
-
     def initialize
-      DEFAULT_ATTRIBUTES.each { |key, value| send "#{key}=", value }
+      default_attributes.each { |key, value| send "#{key}=", value }
 
       unless block_given?
         msg = 'You must pass a block at initialization to setup the specification'
@@ -305,6 +309,24 @@ module Application
 
 
     private
+    def default_attributes
+      {
+        plist:       {},
+        sources:     [],
+        resources:   [],
+        data_models: [],
+        gems:        [],
+        doc_types:   [],
+        type:        'APPL',
+        signature:   '????',
+        version:     '1.0',
+        stdlib:      true,
+        agent:       false,
+        compile:     true,
+        overwrite:   false,
+        embed_bs:    false
+      }
+    end
 
     def verify_name
       raise Error, 'a name is required for an appspec' unless @name

data/lib/hotcocoa/standard_rake_tasks.rb

@@ -1,12 +1,12 @@
 $stderr.puts <<EOM
-The old build system, which uses standard_rake_tasks.rb is deprecated in favour
+The old build system, which uses standard_rake_tasks.rb, is deprecated in favour
 of a more easily configurable build system as of HotCocoa 0.6. The old build
 system will be removed in HotCocoa 0.7.
 
 You can update your existing project by looking at the new project template, which
 can be found on Github:
 
-https://github.com/ferrous26/hotcocoa/blob/master/template
+     https://github.com/ferrous26/hotcocoa/blob/master/template
 
 EOM
 

data/lib/hotcocoa/version.rb

@@ -1,3 +1,3 @@
 module HotCocoa
-  VERSION = '0.6.0pre2'
+  VERSION = '0.6.0'
 end

data/template/__APPLICATION_NAME__.appspec

@@ -38,5 +38,15 @@ Application::Specification.new do |s|
   # You can use this flag to hide the dock icon for the app; the
   # default value is false so that apps will have a dock icon
   # s.agent    = true
+
+  # uncomment the block below to declare document types for your document-based application
+  # you can declare multiple document types by specifying several declare_doc_type blocks
+  # s.declare_doc_type do |doc_type|
+  #   doc_type.extensions = ["ext"]
+  #   doc_type.icon       = "MyIcon.icns"
+  #   doc_type.name       = "MyProjectDocument"
+  #   doc_type.role       = :viewer # one of [:editor, :viewer, :none]
+  #   doc_type.class      = "MyDocument"
+  # end
 end
 

data/test/application/test_builder.rb

@@ -68,4 +68,17 @@ class TestApplicationBuilder < TestApplicationModule
     assert_equal spec.identifier, plist[:CFBundleIdentifier]
   end
 
+  def test_plist_doctype_generated_if_present
+    spec = minimal_spec do |s|
+      s.declare_doc_type do |doc_type|
+        doc_type.extensions = ["ext"]
+        doc_type.icon       = "MyIcon.icns"
+        doc_type.name       = "MyProjectDocument"
+        doc_type.role       = :viewer
+        doc_type.class      = "MyDocument"
+      end
+    end
+    plist = load_plist(Builder.new(spec).send(:info_plist))
+    assert_equal 1, plist[:CFBundleDocumentTypes].size
+  end
 end

data/test/application/test_document_type_specification.rb

@@ -0,0 +1,66 @@
+require 'test/application/helper'
+
+class TestApplicationDocumentTypeSpecification < TestApplicationModule
+  def rescue_spec_error_for
+    begin
+      yield
+    rescue ArgumentError => e
+      return e
+    end
+    flunk "no error thrown!"
+  end
+  
+  def minimal_doc_type_spec
+    DocumentTypeSpecification.new do |s|
+      s.extensions = ["ext"]
+      s.name       = "MyProjectDocument"
+      s.role       = :editor
+      yield s if block_given?
+    end
+  end
+  
+  def test_definition_of_a_valid_specification
+    type = DocumentTypeSpecification.new do |doc_type|
+      doc_type.extensions = ["ext"]
+      doc_type.icon       = "MyIcon.icns"
+      doc_type.name       = "MyProjectDocument"
+      doc_type.role       = :editor
+      doc_type.class      = "MyDocument"
+    end
+    assert_equal ["ext"],             type.info_plist_representation[:CFBundleTypeExtensions]
+    assert_equal "MyIcon.icns",       type.info_plist_representation[:CFBundleTypeIconFile]
+    assert_equal "MyProjectDocument", type.info_plist_representation[:CFBundleTypeName]
+    assert_equal "Editor",            type.info_plist_representation[:CFBundleTypeRole]
+    assert_equal "MyDocument",        type.info_plist_representation[:NSDocumentClass]
+  end
+  
+  def test_extensions_are_an_array
+    exception = rescue_spec_error_for do
+      minimal_doc_type_spec {|s| s.extensions = 123}
+    end
+    assert_match /must be an array/, exception.message
+  end
+  
+  def test_role_is_valid
+    [:editor, :viewer, :none].each do |role|
+      minimal_doc_type_spec {|s| s.role = role}
+    end
+    
+    exception = rescue_spec_error_for do
+      minimal_doc_type_spec {|s| s.role = "xxx"}
+    end
+    assert_match /not a valid role/, exception.message
+  end
+  
+  def test_name_is_not_empty
+    exception = rescue_spec_error_for do
+      minimal_doc_type_spec {|s| s.name = ""}
+    end
+    assert_match /must not be empty/, exception.message
+    
+    exception = rescue_spec_error_for do
+      minimal_doc_type_spec {|s| s.name = nil}
+    end
+    assert_match /must not be empty/, exception.message
+  end
+end

data/test/application/test_specification.rb

@@ -8,6 +8,7 @@ class TestApplicationSpecification < TestApplicationModule
     rescue Specification::Error => e
       return e
     end
+    flunk "no error thrown!"
   end
 
   def test_spec_requires_a_block
@@ -224,7 +225,7 @@ class TestApplicationSpecification < TestApplicationModule
     assert_equal true, spec.embed_bs
   end
 
-  def test_overwirte_attribute_is_false_by_default
+  def test_overwrite_attribute_is_false_by_default
     spec = minimal_spec
     refute spec.overwrite?
 
@@ -232,6 +233,30 @@ class TestApplicationSpecification < TestApplicationModule
     assert spec.overwrite?
   end
 
+  def test_doc_types_is_empty_by_default
+    assert_equal [], minimal_spec.doc_types
+  end
+
+  def test_doc_types_can_be_added
+    spec = minimal_spec do |s|
+      s.declare_doc_type do |doc_type|
+        doc_type.extensions = ["ext"]
+        doc_type.icon       = "MyIcon.icns"
+        doc_type.name       = "MyProjectDocument"
+        doc_type.role       = :viewer
+        doc_type.class      = "MyDocument"
+      end
+    end
+    assert 1, spec.doc_types.size
+  end
+
+  def test_doc_type_declaration_requires_a_block
+    exception = assert_raises ArgumentError do
+      minimal_spec {|s| s.declare_doc_type}
+    end
+    assert_match /must pass a block/, exception.message
+  end
+
   def test_icon_exists?
     refute minimal_spec.icon_exists?
 
@@ -244,6 +269,13 @@ class TestApplicationSpecification < TestApplicationModule
     assert spec.icon_exists?
   end
 
+  def test_defaults_are_immutable
+    first_spec = minimal_spec {|s| s.sources << ["/path/to/source"]}
+    
+    second_spec = minimal_spec
+    assert_empty second_spec.sources
+  end
+
   # doubles as an integration test
   def test_load_evaluates_files_properly
     spec = hotconsole_spec
@@ -263,5 +295,4 @@ class TestApplicationSpecification < TestApplicationModule
     assert_equal true,                                spec.overwrite
     assert_equal false,                               spec.stdlib
   end
-
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: hotcocoa
 version: !ruby/object:Gem::Version
-  prerelease: 5
-  version: 0.6.0pre2
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Richard Kilmer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-08 00:00:00 -04:00
+date: 2011-10-14 00:00:00 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -83,6 +83,7 @@ files:
 - .yardopts
 - bin/hotcocoa
 - lib/hotcocoa/application/builder.rb
+- lib/hotcocoa/application/document_type_specification.rb
 - lib/hotcocoa/application/specification.rb
 - lib/hotcocoa/application_builder.rb
 - lib/hotcocoa/attributed_string_helpers.rb
@@ -181,6 +182,7 @@ files:
 - template/resources/HotCocoa.icns
 - test/application/helper.rb
 - test/application/test_builder.rb
+- test/application/test_document_type_specification.rb
 - test/application/test_specification.rb
 - test/core_extensions/test_kernel.rb
 - test/core_extensions/test_nsarray.rb
@@ -229,9 +231,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: "0"
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.4.2
@@ -241,6 +243,7 @@ summary: Cocoa mapping library for MacRuby
 test_files:
 - test/application/helper.rb
 - test/application/test_builder.rb
+- test/application/test_document_type_specification.rb
 - test/application/test_specification.rb
 - test/core_extensions/test_kernel.rb
 - test/core_extensions/test_nsarray.rb