cocoa 0.1.1 → 0.1.2

data/README.md

@@ -2,3 +2,23 @@ cocoa
 =====
 
 Ruby FFI bindings for the OSX Cocoa API
+
+### Installation
+
+```
+gem install cocoa
+```
+
+### Usage
+
+```ruby
+require 'cocoa'
+array = Cocoa::NSMutableArray.array
+array.addObject "head"
+array.addObject "tail"
+array.description
+=> (
+    head,
+    tail
+)
+```

data/Rakefile

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-PROJECT_SPECS = FileList['spec/**/*.rb']
+PROJECT_SPECS = FileList['spec/**/*_spec.rb']
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/cocoa.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cocoa"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Patrick Hanevold"]
-  s.date = "2014-03-25"
+  s.date = "2014-03-26"
   s.description = "Ruby FFI bindings for the OSX Cocoa API"
   s.email = "patrick.hanevold@gmail.com"
   s.extra_rdoc_files = [
@@ -411,9 +411,14 @@ Gem::Specification.new do |s|
     "lib/cocoa/bindings/NSXPCConnection.rb",
     "lib/cocoa/bindings/NSXPCInterface.rb",
     "lib/cocoa/bindings/NSXPCListener.rb",
+    "lib/cocoa/extensions.rb",
     "lib/cocoa/helpers.rb",
+    "lib/cocoa/objc.rb",
+    "lib/cocoa/structs/NSPoint.rb",
+    "lib/cocoa/structs/NSRect.rb",
+    "lib/cocoa/structs/NSSize.rb",
     "spec/cocoa/cocoa_spec.rb",
-    "spec/cocoa/spec_helper.rb",
+    "spec/spec_helper.rb",
     "tasks/bacon.rake",
     "tasks/generate.rake",
     "tasks/setup.rake"

data/lib/cocoa.rb

@@ -2,21 +2,7 @@
 require 'active_support'
 
 require 'cocoa/helpers'
-Dir[File.dirname(__FILE__) + '/cocoa/bindings/*'].each do |name|
-  require "cocoa/bindings/#{name.split('/').last}"
-end
-
-class String
-  def method_missing meth,*args
-    if Cocoa::NSString.method_defined?(meth)
-      str = Cocoa::NSString.new(true)
-      str.object = Cocoa::String_to_NSString(self)
-      str.send(meth,*args)
-    else
-      super
-    end
-  end
-end
+require "cocoa/bindings/NSString"
 
 module Cocoa
   extend FFI::Library
@@ -28,6 +14,15 @@ module Cocoa
   attach_function :NSApplicationLoad, [], :bool
   NSApplicationLoad()
 
+  def const_missing name
+    if File.exists?(File.dirname(__FILE__) + "/cocoa/bindings/#{name}.rb")
+      require "cocoa/bindings/#{name}"
+      "Cocoa::#{name}".constantize
+    else
+      super
+    end
+  end
+
   CA_WARN_DEPRECATED = 1
   CFByteOrderBigEndian = 2
   CFByteOrderLittleEndian = 1
@@ -6720,3 +6715,4 @@ module Cocoa
   attach_method :NSZoneRealloc, :args=>3, :names=>[], :types=>["^{_NSZone=}", "^v", "Q"], :retval=>"^v"
   attach_method :NXReadNSObjectFromCoder, :args=>1, :names=>[], :types=>["@"], :retval=>"@"
 end
+require "cocoa/extensions"

data/lib/cocoa/extensions.rb

@@ -0,0 +1,23 @@
+class Cocoa::NSObject
+  def self.const_missing name
+    Cocoa.const_get name
+  end
+end
+
+class Cocoa::NSString < Cocoa::NSObject
+  def to_s
+    Cocoa::NSString_to_String(object)
+  end
+end
+
+class String
+  def method_missing meth,*args
+    if Cocoa::NSString.method_defined?(meth)
+      str = Cocoa::NSString.new(true)
+      str.object = Cocoa::String_to_NSString(self)
+      str.send(meth,*args)
+    else
+      super
+    end
+  end
+end

data/lib/cocoa/helpers.rb

@@ -1,94 +1,13 @@
 require 'active_support/inflector'
 require 'ffi'
-
-module ObjC
-  extend FFI::Library
- 
-  # Load the 'libobjc' library.
-  ffi_lib 'objc'
- 
-  # Bind the 'sel_registerName' function, which accepts a String and
-  # returns an equivalent Objective-C selector (i.e. message name).
-  attach_function :sel_registerName, [:string], :pointer
- 
-  # Bind the 'objc_msgSend' function, which sends a message to an
-  # Objective-C object. It accepts a pointer to the object being sent
-  # the message, a pointer to a selector, and a varargs array of
-  # arguments to be sent with the message. It returns a pointer to the
-  # result of sending the message.
-  attach_function :objc_msgSend, [:pointer, :pointer, :varargs], :pointer
-  #attach_function :objc_msgSend_stret, [:pointer, :pointer, :varargs], CGRect.by_value
- 
-  # A convenience method using objc_msgSend and sel_registerName to easily
-  # send Objective-C messages from Ruby.
-  def self.msgSend( id, selector, *args )
-    selector = sel_registerName(selector) if selector.is_a? String
-    objc_msgSend( id, selector, *args )
-  end
-
-  def self.msgSend_stret( return_type, id, selector, *args )
-    selector = sel_registerName(selector) if selector.is_a? String
-    method = "objc_msgSend_stret_for_#{return_type.name.underscore}".to_sym
-    unless respond_to? method
-      attach_function method, :objc_msgSend_stret, [:pointer, :pointer, :varargs], return_type.by_value
-    end
-    send(method, id, selector, *args )
-  end
- 
-  # Bind the 'objc_getClass' function, which accepts the name of an
-  # Objective-C class, and returns a pointer to that class.
-  attach_function :objc_getClass, [:string], :pointer
-
-  attach_function :objc_allocateClassPair, [:pointer, :string, :int], :pointer
-  attach_function :objc_registerClassPair, [:pointer], :void
-end
-
-class CGPoint < FFI::Struct
-  def initialize *args
-    options = args.first
-    if options.is_a? Hash
-      self[:x] = options[:x]
-      self[:y] = options[:y]
-    else
-      super *args
-    end
-  end
-  layout :x, :double,
-         :y, :double
-end
-
-class CGSize < FFI::Struct
-  def initialize *args
-    options = args.first
-    if options.is_a? Hash
-      self[:width] = options[:width]
-      self[:height] = options[:height]
-    else
-      super *args
-    end
-  end
-  layout :width, :double,
-         :height, :double
-end
-
-class CGRect < FFI::Struct
-  def initialize *args
-    options = args.first
-    if options.is_a? Hash
-      self[:origin][:x] = options[:x]
-      self[:origin][:y] = options[:y]
-      self[:size][:width] = options[:width]
-      self[:size][:height] = options[:height]
-    else
-      super *args
-    end
-  end
-  layout :origin, CGPoint,
-         :size, CGSize
-end
+require 'cocoa/objc'
 
 module Cocoa; end
 
+require 'cocoa/structs/NSPoint'
+require 'cocoa/structs/NSSize'
+require 'cocoa/structs/NSRect'
+
 class Cocoa::CFRange < FFI::Struct
   def initialize *args
     options = args.first
@@ -105,10 +24,6 @@ class Cocoa::CFRange < FFI::Struct
   layout :location, :long_long, :length, :long_long
 end
 
-NSRect = CGRect
-NSSize = CGSize
-NSPoint = CGPoint
-
 module Cocoa
 
   def instances
@@ -138,16 +53,12 @@ module Cocoa
     CFRange.new(location: loc, length: len)
   end
 
-  # Accepts a Ruby String and creates an equivalent NSString instance
-  # and returns a pointer to it.
   def self.String_to_NSString( string )
     nsstring_class = ObjC.objc_getClass("NSString")
     ObjC.msgSend( nsstring_class, "stringWithUTF8String:",
                   :string, string )
   end
  
-  # Accepts a pointer to an NSString object, and returns the string
-  # contents as a Ruby String.
   def self.NSString_to_String( nsstring_pointer )
     c_string_pointer = ObjC.msgSend( nsstring_pointer, "UTF8String" )
     if c_string_pointer.null?
@@ -196,7 +107,7 @@ module Cocoa
 
   def self.attach_singular_method method,*params
     params = params.extract_options!
-params.freeze
+    params.freeze
     if params[:args] == 0
       define_singleton_method method do
         instance = new(true)
@@ -300,7 +211,13 @@ params.freeze
       instance = begin
         ("Cocoa::"+klass_name).constantize.new(true)
       rescue
-        klass_name = "FIX_#{klass_name}" if klass_name[0]=='_'
+        klass_name = if klass_name =~ /^__NSCF/
+          "NS#{klass_name[6..-1]}" 
+        elsif klass_name[0]=='_'
+          "FIX_#{klass_name}" 
+        else
+          klass_name
+        end
         klass = begin
           Cocoa.const_get(klass_name)
         rescue => e
@@ -354,7 +271,7 @@ params.freeze
     end
 
     params = params.extract_options!
-params.freeze
+    params.freeze
     if params[:args] == 0
       begin
         attach_function "call_#{method}".to_sym, method, [], apple_type_to_ffi(params[:retval])
@@ -451,7 +368,6 @@ params.freeze
 
     def self.inherited(parent)
       if parent.name
-puts "INHERITED #{parent.name}" if parent.name =~ /Timer/
         klass = ObjC.objc_allocateClassPair(ObjC.objc_getClass(name.split('::').last),parent.name,0)
         ObjC.objc_registerClassPair(klass)
       end
@@ -553,7 +469,7 @@ puts "INHERITED #{parent.name}" if parent.name =~ /Timer/
     end
 
     def self.attach_singular_method method,*__params
-__params.freeze
+      __params.freeze
       return if method==:class
       return if method==:new
       if __params.first.is_a?(Hash) && __params.first[:args] == 0
@@ -564,11 +480,8 @@ __params.freeze
         end
       else
         _params = [__params.dup].flatten
-_params.freeze
+        _params.freeze
         define_singleton_method method do |*args|
-# puts method
-# puts args.inspect
-# puts _params.inspect
           par = if _params.size == 1 && _params.first[:variadic]
             _params
           else
@@ -613,7 +526,7 @@ _params.freeze
       @@method_specs ||= {}
       if _params.first.is_a? Array
         _params = [_params].flatten
-_params.freeze
+        _params.freeze
         define_method method do |*args|
           if args.last.is_a? Hash
             params = _params.select{ |par| par[:args] == args.last.size+1 && par[:names].map(&:to_sym).sort == args.last.keys.sort }
@@ -641,7 +554,7 @@ _params.freeze
         params = _params.extract_options!
         @@method_specs[method] = params
         if params[:args] == 0
-params.freeze
+          params.freeze
           define_method method do
             case params[:retval]
             when '@'
@@ -669,7 +582,6 @@ params.freeze
                 ("Cocoa::"+klass_name).constantize.new(true)
               rescue
                 klass_name = "FIX_#{klass_name}" if klass_name[0]=='_'
-# puts "TRYING #{klass_name}"
                 klass = begin
                   Cocoa.const_get(klass_name)
                 rescue => e
@@ -720,7 +632,7 @@ params.freeze
         when '@'
           :pointer
         when /^{([^=]*)=.*}$/
-          $1.constantize.by_value
+          Cocoa::const_get($1).by_value
         else
           raise type
         end
@@ -763,8 +675,8 @@ params.freeze
     def self.method_added(name)
       return if caller.first.split('`').last[0..-2] == 'define_method'  # MRI
       return if caller.first.split('`').last[0..-2] == 'attach_method'  # Rubinius
-      method_definition = "#{self.name.underscore}_#{name.to_s.underscore}".to_sym
-      add_method = "add_#{self.name.underscore}_#{name.to_s.underscore}".to_sym
+      method_definition = "#{self.name.gsub('::','__')}_#{name}".to_sym
+      add_method = "add_#{method_definition}".to_sym
 
       @method_callers ||= {}
       raise "allready added" if @method_callers[method_definition]

data/lib/cocoa/objc.rb

@@ -0,0 +1,25 @@
+module ObjC
+  extend FFI::Library
+ 
+  ffi_lib 'objc'
+ 
+  attach_function :sel_registerName, [:string], :pointer
+  attach_function :objc_msgSend, [:pointer, :pointer, :varargs], :pointer
+  attach_function :objc_getClass, [:string], :pointer
+  attach_function :objc_allocateClassPair, [:pointer, :string, :int], :pointer
+  attach_function :objc_registerClassPair, [:pointer], :void
+
+  def self.msgSend( id, selector, *args )
+    selector = sel_registerName(selector) if selector.is_a? String
+    objc_msgSend( id, selector, *args )
+  end
+
+  def self.msgSend_stret( return_type, id, selector, *args )
+    selector = sel_registerName(selector) if selector.is_a? String
+    method = "objc_msgSend_stret_for_#{return_type.name.underscore}".to_sym
+    unless respond_to? method
+      attach_function method, :objc_msgSend_stret, [:pointer, :pointer, :varargs], return_type.by_value
+    end
+    send(method, id, selector, *args )
+  end
+end

data/lib/cocoa/structs/NSPoint.rb

@@ -0,0 +1,17 @@
+module Cocoa
+  class CGPoint < FFI::Struct
+    def initialize *args
+      options = args.first
+      if options.is_a? Hash
+        self[:x] = options[:x]
+        self[:y] = options[:y]
+      else
+        super *args
+      end
+    end
+    layout :x, :double,
+           :y, :double
+  end
+
+  NSPoint = CGPoint
+end

data/lib/cocoa/structs/NSRect.rb

@@ -0,0 +1,19 @@
+module Cocoa
+  class CGRect < FFI::Struct
+    def initialize *args
+      options = args.first
+      if options.is_a? Hash
+        self[:origin][:x] = options[:x]
+        self[:origin][:y] = options[:y]
+        self[:size][:width] = options[:width]
+        self[:size][:height] = options[:height]
+      else
+        super *args
+      end
+    end
+    layout :origin, CGPoint,
+           :size, CGSize
+  end
+
+  NSRect = Cocoa::CGRect
+end

data/lib/cocoa/structs/NSSize.rb

@@ -0,0 +1,17 @@
+module Cocoa
+  class CGSize < FFI::Struct
+    def initialize *args
+      options = args.first
+      if options.is_a? Hash
+        self[:width] = options[:width]
+        self[:height] = options[:height]
+      else
+        super *args
+      end
+    end
+    layout :width, :double,
+           :height, :double
+  end
+
+  NSSize = CGSize
+end

data/spec/cocoa/cocoa_spec.rb

@@ -1,17 +1,32 @@
-require_relative 'spec_helper'
+require_relative '../spec_helper'
 require 'cocoa'
 
 describe 'Cocoa' do
+  it 'should lazy load cocoa classes in cocoa derived classes' do
+    class Derived < Cocoa::NSObject
+      def get_lazy
+        NSMenu.new
+      end
+    end
+    Derived.new.get_lazy.class.name.should == 'Cocoa::NSMenu'
+  end
+  it 'should provide correct return types for class methods' do
+    Cocoa::NSMutableArray.array.class.name.should == 'Cocoa::NSMutableArray'
+  end
+  it 'should provide correct return types for instance methods' do
+    array = Cocoa::NSMutableArray.array
+    Cocoa::NSMutableArray.array.description.class.name.should == 'Cocoa::NSString'
+  end
   it 'should convert NSString to ruby strings' do
     array = Cocoa::NSMutableArray.array
     array.addObject "head"
     array.addObject "tail"
     Cocoa::NSString_to_String(array.description.object).should == "(\n    head,\n    tail\n)"
   end
-  it 'should return strings' do
+  it 'should return stringifyable strings' do
     array = Cocoa::NSMutableArray.array
     array.addObject "head"
     array.addObject "tail"
-    array.description.should == "(\n    head,\n    tail\n)"
+    array.description.to_s.should == "(\n    head,\n    tail\n)"
   end
 end

data/spec/{cocoa/spec_helper.rb → spec_helper.rb}

@@ -1,4 +1,4 @@
-$: << File.expand_path(File.join(File.dirname(__FILE__), '/../../lib'))
+$: << File.expand_path(File.join(File.dirname(__FILE__), '/../lib'))
 
 # require 'simplecov'
 

data/tasks/generate.rake

@@ -120,21 +120,7 @@ task :generate do
 require 'active_support'
 
 require 'cocoa/helpers'
-Dir['lib/cocoa/bindings/*'].each do |name|
-  require "cocoa/bindings/\#{name.split('/').last}"
-end
-
-class String
-  def method_missing meth,*args
-    if Cocoa::NSString.method_defined?(meth)
-      str = Cocoa::NSString.new(true)
-      str.object = Cocoa::String_to_NSString(self)
-      str.send(meth,*args)
-    else
-      super
-    end
-  end
-end
+require "cocoa/bindings/NSString"
 
 module Cocoa
   extend FFI::Library
@@ -146,6 +132,15 @@ module Cocoa
   attach_function :NSApplicationLoad, [], :bool
   NSApplicationLoad()
 
+  def const_missing name
+    if File.exists?(File.dirname(__FILE__) + "/cocoa/bindings/\#{name}.rb")
+      require "cocoa/bindings/\#{name}"
+      "Cocoa::\#{name}".constantize
+    else
+      super
+    end
+  end
+
 }
   enums.each do |name,value|
     mod.puts "  #{name} = #{value}"
@@ -184,5 +179,6 @@ module Cocoa
     end
   end
   mod.puts "end"
+  mod.puts 'require "cocoa/extensions"'
   mod.close
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoa
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -525,9 +525,14 @@ files:
 - lib/cocoa/bindings/NSXPCConnection.rb
 - lib/cocoa/bindings/NSXPCInterface.rb
 - lib/cocoa/bindings/NSXPCListener.rb
+- lib/cocoa/extensions.rb
 - lib/cocoa/helpers.rb
+- lib/cocoa/objc.rb
+- lib/cocoa/structs/NSPoint.rb
+- lib/cocoa/structs/NSRect.rb
+- lib/cocoa/structs/NSSize.rb
 - spec/cocoa/cocoa_spec.rb
-- spec/cocoa/spec_helper.rb
+- spec/spec_helper.rb
 - tasks/bacon.rake
 - tasks/generate.rake
 - tasks/setup.rake