hotcocoa 0.5.1 → 0.6.0pre

data/lib/hotcocoa/attributed_string_helpers.rb

@@ -0,0 +1,128 @@
+##
+# Similar to a Ruby Hash, except specialized for dealing with a hash
+# of attributes for NSAttributedString objects.
+class HotCocoa::NSRangedProxyAttributeHash
+
+  # @return [Hash{Symbol=>StandardAttributedStringAttributes}]
+  ATTRIBUTE_KEYS = {
+    font:                  NSFontAttributeName,
+    paragraph_style:       NSParagraphStyleAttributeName,
+    color:                 NSForegroundColorAttributeName,
+    colour:                NSForegroundColorAttributeName,
+    underline_style:       NSUnderlineStyleAttributeName,
+    superscript:           NSSuperscriptAttributeName,
+    background_color:      NSBackgroundColorAttributeName,
+    background_colour:     NSBackgroundColorAttributeName,
+    attachment:            NSAttachmentAttributeName,
+    ligature:              NSLigatureAttributeName,
+    baseline_offset:       NSBaselineOffsetAttributeName,
+    kerning:               NSKernAttributeName,
+    link:                  NSLinkAttributeName,
+    stroke_width:          NSStrokeWidthAttributeName,
+    stroke_color:          NSStrokeColorAttributeName,
+    underline_color:       NSUnderlineColorAttributeName,
+    strikethrough_style:   NSStrikethroughStyleAttributeName,
+    strikethrough_color:   NSStrikethroughColorAttributeName,
+    strikethrough_colour:  NSStrikethroughColorAttributeName,
+    shadow:                NSShadowAttributeName,
+    obliqueness:           NSObliquenessAttributeName,
+    expansion_factor:      NSExpansionAttributeName,
+    cursor:                NSCursorAttributeName,
+    tool_tip:              NSToolTipAttributeName,
+    character_shape:       NSCharacterShapeAttributeName,
+    glyph_info:            NSGlyphInfoAttributeName,
+    marked_clause_segment: NSMarkedClauseSegmentAttributeName,
+    spelling_state:        NSSpellingStateAttributeName
+  }
+
+  # @param [HotCocoa::NSRangedProxyAttributedString]
+  def initialize proxy
+    @proxy = proxy
+  end
+
+  def [] k
+    k = attribute_for_key k
+    @proxy.string.attribute k, atIndex: @proxy.range.first, effectiveRange: nil
+  end
+
+  def []= k, v
+    k = attribute_for_key k
+    @proxy.string.removeAttribute k,
+                           range: @proxy.range.to_NSRange(@proxy.string.length)
+    @proxy.string.addAttribute k,
+                        value: v,
+                        range: @proxy.range.to_NSRange(@proxy.string.length)
+  end
+
+  ##
+  # Append new attributes to the string
+  #
+  # @param [Hash] attributes
+  def << attributes
+    attributes.each_pair { |k, v| self[k] = v }
+    self
+  end
+  alias_method :merge!, :<<
+
+  ##
+  # Return a hash of the attributes, but without transforming constant
+  # names.
+  #
+  # @return [NSMutableDictionary]
+  def to_hash
+    dict = @proxy.string.attributesAtIndex @proxy.range.first,
+                           effectiveRange: nil
+    NSMutableDictionary.dictionaryWithDictionary dict
+  end
+
+  # @return [String]
+  def inspect
+    to_hash.inspect
+  end
+
+
+  private
+
+  def key_for_attribute attribute
+    ATTRIBUTE_KEYS.key(attribute) || attribute
+  end
+
+  def attribute_for_key key
+    ATTRIBUTE_KEYS[key] || key
+  end
+end
+
+
+##
+# Proxies the range of an attributed string.
+class HotCocoa::NSRangedProxyAttributedString
+
+  ##
+  # The string this proxy belongs to.
+  #
+  # @return [NSMutableAttributedString]
+  attr_reader :string
+
+  ##
+  # Range in the string this proxy represents.
+  #
+  # @return [Range]
+  attr_reader :range
+
+  # @param [NSMutableAttributedString] string
+  # @param [Range] range
+  def initialize string, range
+    @string = string
+    @range  = range
+  end
+
+  ##
+  # This method is useful because it allows an attributed string to
+  # return a hash of attributes that use Rubyish names instead of
+  # Objective-C ones.
+  #
+  # @return [HotCooca::NSRangedProxyAttributeHash]
+  def attributes
+    HotCocoa::NSRangedProxyAttributeHash.new self
+  end
+end

data/lib/hotcocoa/behaviors.rb

@@ -1,7 +1,40 @@
-module HotCocoa
-  module Behaviors
-    def Behaviors.included(klass)
-      Mappings::Mapper.map_class(klass)
-    end 
+##
+# A mixin module for classes that subclass Cocoa classes and want to also
+# inherit HotCocoa customizations (custom methods, constants, etc.)
+module HotCocoa::Behaviors
+
+  ##
+  # Implements the callback `Module#included`; this method declares that
+  # when `HotCocoa::Behaviors` is mixed in to a class that the class mixing
+  # in `HotCocoa::Behaviors` will gain all the HotCocoa customizations made
+  # to its superclasses.
+  #
+  # @example
+  #
+  #   # Without including, you cannot call HotCocoa custom methods
+  #   class CustomView < NSView
+  #     def begin
+  #       enter_full_screen # => NoMethodError
+  #     end
+  #   end
+  #
+  #   # HotCocoa custom methods work when you inculde HotCocoa::Behaviors
+  #   class OtherCustomView < NSView
+  #     include HotCocoa::Behaviors
+  #
+  #     def begin
+  #       enter_full_screen # => goes full screen
+  #     end
+  #   end
+  #
+  def self.included klass
+    HotCocoa::Mappings::Mapper.map_class klass
   end
-end
+
+end
+
+##
+# Alias for HotCocoa::Behaviors
+#
+# @return [Module]
+HotCocoa::Behaviours = HotCocoa::Behaviors

data/lib/hotcocoa/core_extensions/kernel.rb

@@ -0,0 +1,67 @@
+##
+# HotCocoa extensions for the Kernel module
+module Kernel
+
+  ##
+  # Like $LOADED_FEATURES, but for frameworks.
+  #
+  # @return [Array<String>]
+  $LOADED_FRAMEWORKS = []
+
+  alias_method :default_framework, :framework
+  ##
+  # Override MacRuby's built-in #framework method in order to support lazy
+  # loading frameworks inside of HotCocoa.
+  def framework name
+    if default_framework name
+      $LOADED_FRAMEWORKS << name
+      HotCocoa::Mappings.load name
+      true
+    else
+      false
+    end
+  end
+
+  # Populate the list with everything that has already been loaded
+  $LOADED_FRAMEWORKS.concat NSBundle.allFrameworks.map { |bundle|
+    bundle.bundlePath.split('/').last
+  }.select { |framework|
+    framework.split('.')[1] == 'framework'
+  }.map! { |framework|
+    framework.split('.')[0]
+  }
+  $LOADED_FRAMEWORKS.uniq!
+
+  ##
+  # A mapping, lol
+  #
+  # @return [Hash]
+  PLIST_FORMATS = {
+    xml:    NSPropertyListXMLFormat_v1_0,
+    binary: NSPropertyListBinaryFormat_v1_0
+  }
+
+  ##
+  # @todo encoding format can be pushed upstream?
+  #
+  # Override MacRuby's built-in {Kernel#to_plist} method to support
+  # specifying an output format. See {PLIST_FORMATS} for the available
+  # formats.
+  #
+  # @example Encoding a plist in the binary format
+  #   { key: 'value' }.to_plist(:binary)
+  #
+  # @return [String] returns a string with the caller's contents
+  #   serialized as a plist and encoded using `format`
+  def to_plist format = :xml
+    format_const = PLIST_FORMATS[format]
+    raise ArgumentError, "invalid format `#{format}'" unless format_const
+
+    error = Pointer.new :id
+    data  = NSPropertyListSerialization.dataFromPropertyList self,
+                                                     format: format_const,
+                                           errorDescription: error
+    error[0] ? raise(Exception, error[0]) : data.to_str
+  end
+
+end

data/lib/hotcocoa/core_extensions/nsarray.rb

@@ -0,0 +1,15 @@
+##
+# HotCocoa extensions for the NSArray class
+class NSArray
+  ##
+  # Equivalent to `#[1]`, borrowed from Active Support.
+  def second
+    at(1)
+  end
+
+  ##
+  # Equivalent to `#[2]`, borrowed from Active Support.
+  def third
+    at(2)
+  end
+end

data/lib/hotcocoa/core_extensions/nsmutable_attributed_string.rb

@@ -0,0 +1,74 @@
+##
+# HotCocoa extensions to the NSMutableAttributeString class.
+class NSMutableAttributedString
+
+  ##
+  # @todo Should this be declared on NSAttributedString instead
+  #
+  # Make a new attributed string with the string of the receiver and
+  # the attributes passed as arguments.
+  #
+  # @param [Hash]
+  # @return [NSMutableAttributedString]
+  def with_attributes attributes = {}
+    string.with_attributes attributes
+  end
+
+  ##
+  # Just like `String#<<`
+  def << s
+    case s
+    when String
+      mutableString.appendString s
+    else
+      appendAttributedString s
+    end
+  end
+
+  ##
+  # @todo Should this be declared on NSAttributedString instead
+  #
+  # Just like `String#+`
+  def + s
+    attributed_string = mutableCopy
+    attributed_string << s
+    attributed_string
+  end
+
+  ##
+  # @todo Should this be declared on NSAttributedString instead
+  #
+  # Hash of attributes used in the attributed string.
+  #
+  # @return [HotCocoa::NSRangedProxyAttributeHash]
+  def attributes
+    HotCocoa::NSRangedProxyAttributedString.new(self, 0..-1).attributes
+  end
+
+  ##
+  # @deprecated Who uses this? Removing this in HotCocoa 0.7 unless
+  #   there are reasonable objections
+  #
+  # Create a range proxy for an arbitrary portion of the receiver.
+  #
+  # @param [Range] r
+  # @return [HotCocoa::NSRangedProxyAttributedString]
+  def [] r
+    HotCocoa::NSRangedProxyAttributedString.new self, r
+  end
+
+  ##
+  # Replace an arbitrary range of an attributed string with another string.
+  #
+  # @param [Range] r
+  # @param [NSAttributedString,String] s
+  def []= r, s
+    case s
+    when String
+      replaceCharactersInRange r.to_NSRange(length), withString: s
+    else
+      replaceCharactersInRange r.to_NSRange(length), withAttributedString: s
+    end
+  end
+
+end

data/lib/hotcocoa/core_extensions/nsstring.rb

@@ -0,0 +1,36 @@
+##
+# HotCocoa extensions for the NSString class.
+class NSString
+
+  ##
+  # Borrowed from Active Support.
+  def underscore
+    new_string = gsub /::/, '/'
+    new_string.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+    new_string.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+    new_string.tr! '-', '_'
+    new_string.downcase!
+    new_string
+  end
+
+  ##
+  # Borrowed from Active Support.
+  def camel_case
+    to_s.gsub /(?:^|_)(.)/ do $1.upcase end
+  end
+
+  ##
+  # Create an attributed string with the given attributes. The list of
+  # applicable attributes can be found in the Apple documentation for
+  # NSAttributedString class, as well as the ATTRIBUTE_KEYS hash in the
+  # {HotCocoa::NSRangedProxyAttributeHash} class.
+  #
+  # @param [Hash] attributes
+  # @return [NSMutableAttributedString]
+  def with_attributes attributes = {}
+    attributed_string = NSMutableAttributedString.alloc.initWithString self
+    attributed_string.attributes << attributes
+    attributed_string
+  end
+
+end

data/lib/hotcocoa/core_extensions/nsurl.rb

@@ -0,0 +1,6 @@
+##
+# HotCocoa extensions for the NSURL class
+class NSURL
+  alias_method :to_s, :absoluteString
+  alias_method :inspect, :absoluteString
+end

data/lib/hotcocoa/core_extensions/numeric.rb

@@ -0,0 +1,9 @@
+##
+# HotCocoa extensions for the Numeric class
+class Numeric
+  ##
+  # Whether or not a number is negative
+  def negative?
+    self < 0
+  end
+end

data/lib/hotcocoa/core_extensions/object.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+##
+# HotCocoa extensions for the Object class
+class Object
+
+  ##
+  # Object.full_const_get was taken from the ‘extlib’ project:
+  # http://github.com/sam/extlib which is released under a MIT License and
+  # copyrighted by Sam Smoot (2008).
+  #
+  # Given a string, return the fully qualified constant name found in the
+  # receiver's namespace.
+  #
+  # @example
+  #
+  #   Object.full_const_get('HotCocoa::Mappings') # => HotCocoa::Mappings
+  #   HotCocoa.full_const_get('Mappings') # => HotCocoa::Mappings
+  #
+  # @param [String] name the constant to get
+  # @return the constant corresponding to the name, if it exists
+  def full_const_get name
+    list = name.split('::')
+    list.shift if list.first.empty?
+    obj = self
+
+    list.each do |x|
+      # This is required because const_get tries to look for constants in the
+      # ancestor chain, but we only want constants that are HERE
+      obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
+    end
+
+    obj
+  end
+
+end

data/lib/hotcocoa/core_extensions/range.rb

@@ -0,0 +1,30 @@
+##
+# HotCocoa extensions to the Range class
+class Range
+  ##
+  # Create a Cocoa NSRange from a Ruby Range.
+  #
+  # Since NSRange does not support negative indexing, you _MUST_ include
+  # an argument to this method to indicate the length of the object which
+  # the range refers to.
+  #
+  # @example
+  #
+  #   (0..10).to_NSRange       # => #<NSRange location=0 length=11>
+  #   (1..10).to_NSRange       # => #<NSRange location=1 length=10>
+  #   (2..-1).to_NSRange(11)   # => #<NSRange location=2 length=9>
+  #   (3..-2).to_NSRange(11)   # => #<NSRange location=3 length=7>
+  #   (4...-1).to_NSRange(11)  # => #<NSRange location=4 length=6>
+  #   (-3...-1).to_NSRange(11) # => #<NSRange location=8 length=2>
+  #   (-5..-1).to_NSRange(11)  # => #<NSRange location=6 length=5>
+  #
+  # @param [Number] length the length of the object which the range represents
+  def to_NSRange length = nil
+    if (first.negative? or last.negative?) and !length
+      raise ArgumentError, 'arg required if range has negative indicies'
+    end
+    start = (first.negative? ? length + first : first)
+    run   = (last.negative?  ? length + last  : last ) - start + (exclude_end? ? 0 : 1)
+    NSRange.new start, run
+  end
+end

data/lib/hotcocoa/core_extensions.rb

@@ -0,0 +1,8 @@
+require 'hotcocoa/core_extensions/object'
+require 'hotcocoa/core_extensions/kernel'
+require 'hotcocoa/core_extensions/nsurl'
+require 'hotcocoa/core_extensions/nsarray'
+require 'hotcocoa/core_extensions/numeric'
+require 'hotcocoa/core_extensions/range'
+require 'hotcocoa/core_extensions/nsstring'
+require 'hotcocoa/core_extensions/nsmutable_attributed_string'

data/lib/hotcocoa/data_sources/combo_box_data_source.rb

@@ -1,44 +1,44 @@
-module HotCocoa
-  class ComboBoxDataSource
-    attr_reader :data
+class HotCocoa::ComboBoxDataSource
 
-    def initialize(data)
-      @data = data
-    end
-    
-    def comboBox(combo_box, completedString:string)
-      data.length.times do |index|
-        value = string_value_of_index(index)
-        return value if value.start_with?(string)
-      end
-      nil
-    end
-    
-    def comboBox(combo_box, indexOfItemWithStringValue:string)
-      data.length.times do |index|
-        return index if string_value_of_index(index) == string
-      end
-      NSNotFound
-    end
-    
-    def comboBox(combo_box, objectValueForItemAtIndex:index)
-      string_value_of_index(index)
+  attr_reader :data
+
+  def initialize data
+    @data = data
+  end
+
+  def comboBox combo_box, completedString: string
+    data.length.times do |index|
+      value = string_value_of_index index
+      return value if value.start_with? string
     end
-    
-    def numberOfItemsInComboBox(combo_box)
-      data.length
+
+    nil
+  end
+
+  def comboBox combo_box, indexOfItemWithStringValue: string
+    data.length.times do |index|
+      return index if string_value_of_index(index) == string
     end
-    
-    private
-    
-      def string_value_of_index(i)
-        item = data[i]
-        if item.kind_of?(Hash)
-          item.values.first
-        else
-          item.to_s
-        end
-      end
 
+    NSNotFound
+  end
+
+  def comboBox combo_box, objectValueForItemAtIndex: index
+    string_value_of_index index
+  end
+
+  def numberOfItemsInComboBox combo_box
+    data.length
+  end
+
+  private
+
+  def string_value_of_index i
+    item = data[i]
+    if item.kind_of? Hash
+      item.values.first
+    else
+      item.to_s
+    end
   end
 end

data/lib/hotcocoa/data_sources/outline_view_data_source.rb

@@ -0,0 +1,33 @@
+class HotCocoa::OutlineViewDataSource
+
+  attr_reader :data
+
+  def initialize data
+    @data = data
+  end
+
+  def outlineView view, numberOfChildrenOfItem: item
+    if item.nil?
+      data.length
+    else
+      item[:childRows].length
+    end
+  end
+
+  def outlineView view, isItemExpandable: item
+    item.has_key?(:childRows) && item[:childRows].length > 0
+  end
+
+  def outlineView view, child: child, ofItem: item
+    if item.nil?
+      data[child]
+    else
+      item[:childRows][child]
+    end
+  end
+
+  def outlineView view, objectValueForTableColumn: column, byItem: item
+    item[column.identifier.intern]
+  end
+
+end

data/lib/hotcocoa/data_sources/table_data_source.rb

@@ -1,18 +1,17 @@
-module HotCocoa
-  class TableDataSource
-    attr_reader :data
+class HotCocoa::TableDataSource
 
-    def initialize(data)
-      @data = data
-    end
+  attr_reader :data
 
-    def numberOfRowsInTableView(tableView)
-      data.length
-    end
+  def initialize data
+    @data = data
+  end
 
-    def tableView(view, objectValueForTableColumn:column, row:i)
-      data[i][column.identifier.intern]
-    end
+  def numberOfRowsInTableView tableView
+    data.length
+  end
 
+  def tableView view, objectValueForTableColumn: column, row: i
+    data[i][column.identifier.intern]
   end
-end
+
+end

data/lib/hotcocoa/data_sources.rb

@@ -0,0 +1,3 @@
+require 'hotcocoa/data_sources/table_data_source'
+require 'hotcocoa/data_sources/combo_box_data_source'
+require 'hotcocoa/data_sources/outline_view_data_source'