accessibility_core 0.3.1 → 0.3.2

data/History.markdown

@@ -1,8 +1,21 @@
+# 0.3.2 - Adjustments for AXElements
+
+  * Fix `Element#children` raising when AXAPI returns failure error code
+  * Conditionally defined `CGPoint`/`CGSize`/`CGRect` on MRI
+  * Tweak various bits of documentation related to Cocoa mappings
+  * Calculate `NSString` length properly when wrapping in the C extension
+  * Add a 10% drop-in replacement for `NSBundle` for AXElements
+  * Add `wrap_dictionary` to wrap `NSDictionary` objects
+  * Force `CGPoint`/`CGSize` attrs to be `Float` type at initialize time
+  * Add `Object#to_ruby` and `Array#to_ruby` when running on MRI
+
+
 # 0.3.1 - Fix it up
 
   * Fix C extensions being installed to the wrong location
   * Fix Accessibility module not always being defined at the appropriate time
 
+
 # 0.3.0 - Merge accessibility\_bridge
 
   * Merge in `accessibility_bridge` v0.2.0

data/README.markdown

@@ -20,17 +20,6 @@ runtimes.
     window.set 'AXPosition', CGPoint.new(100, 100)
 
 
-## Note
-
-At this point, `rake-compiler` does not run on MacRuby
-'out-of-the-box'. Actually, it does, but it declares a dependency on
-rake which causes rake to be installed from rubygems. Rake from
-rubygems does not work with MacRuby. So you need to either fix the
-probem with MacRuby or just hack the `rake-compiler.gemspec` file
-after you install `rake-compiler` so it does not think it depends on
-rake anymore.
-
-
 ## TODO
 
   * bridging for `NSAttributedString`

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 desc 'Startup an IRb console with everything loaded'
 task :console_complete => :compile do
-  sh 'irb -Ilib -raccessibility/core -raccessibility/bridge -raccessibility/extras -raccessibility/highlighter'
+  sh 'irb -Ilib -raccessibility/bridge -raccessibility/core -raccessibility/extras -raccessibility/highlighter'
 end
 
 # Gem stuff

data/ext/accessibility/bridge/bridge.c

@@ -62,6 +62,7 @@ wrap_unknown(CFTypeRef obj)
 CFTypeRef
 unwrap_unknown(VALUE obj)
 {
+  // TODO: rb_check_convert_type instead?
   obj = rb_funcall(obj, sel_to_s, 0);
   rb_raise(
 	   rb_eRuntimeError,
@@ -235,11 +236,7 @@ unwrap_value(VALUE value)
 VALUE wrap_array_values(CFArrayRef array) { WRAP_ARRAY(wrap_value) }
 
 
-VALUE
-wrap_ref(AXUIElementRef ref)
-{
-  return Data_Wrap_Struct(rb_cElement, NULL, cf_finalizer, (void*)ref);
-}
+VALUE wrap_ref(AXUIElementRef obj) { WRAP_OBJC(rb_cElement, cf_finalizer); }
 
 AXUIElementRef
 unwrap_ref(VALUE obj)
@@ -287,7 +284,7 @@ wrap_nsstring(NSString* string)
 {
   return rb_enc_str_new(
 			[string UTF8String],
-			[string length],
+			[string lengthOfBytesUsingEncoding:NSUTF8StringEncoding],
 			rb_utf8_encoding()
 			);
 }
@@ -418,6 +415,7 @@ wrap_nsurl(NSURL* url)
 CFURLRef
 unwrap_url(VALUE url)
 {
+  // TODO: should also force encoding to UTF-8 first?
   url = rb_funcall(url, sel_to_s, 0);
   CFStringRef string = CFStringCreateWithCString(
 						 NULL,
@@ -429,8 +427,15 @@ unwrap_url(VALUE url)
   return url_ref;
 }
 
+NSURL*
+unwrap_nsurl(VALUE url)
+{
+  return (NSURL*)unwrap_url(url);
+}
+
 VALUE wrap_array_urls(CFArrayRef array) { WRAP_ARRAY(wrap_url) }
 
+
 VALUE
 wrap_date(CFDateRef date)
 {
@@ -485,19 +490,35 @@ wrap_array(CFArrayRef array)
   else                                   return wrap_unknown(obj);
 }
 
+
+VALUE
+wrap_dictionary(NSDictionary* dict)
+{
+  __block VALUE hash = rb_hash_new();
+
+  [dict enumerateKeysAndObjectsUsingBlock: ^(id key, id obj, BOOL* stop) {
+      rb_hash_aset(hash, to_ruby(key), to_ruby(obj));
+    }];
+
+  return hash;
+}
+
+
+
 VALUE
 to_ruby(CFTypeRef obj)
 {
   CFTypeID di = CFGetTypeID(obj);
-  if      (di == CFArrayGetTypeID())     return wrap_array(obj);
-  else if (di == AXUIElementGetTypeID()) return wrap_ref(obj);
-  else if (di == AXValueGetTypeID())     return wrap_value(obj);
-  else if (di == CFStringGetTypeID())    return wrap_string(obj);
-  else if (di == CFNumberGetTypeID())    return wrap_number(obj);
-  else if (di == CFBooleanGetTypeID())   return wrap_boolean(obj);
-  else if (di == CFURLGetTypeID())       return wrap_url(obj);
-  else if (di == CFDateGetTypeID())      return wrap_date(obj);
-  else                                   return wrap_unknown(obj);
+  if      (di == CFArrayGetTypeID())       return wrap_array(obj);
+  else if (di == AXUIElementGetTypeID())   return wrap_ref(obj);
+  else if (di == AXValueGetTypeID())       return wrap_value(obj);
+  else if (di == CFStringGetTypeID())      return wrap_string(obj);
+  else if (di == CFNumberGetTypeID())      return wrap_number(obj);
+  else if (di == CFBooleanGetTypeID())     return wrap_boolean(obj);
+  else if (di == CFURLGetTypeID())         return wrap_url(obj);
+  else if (di == CFDateGetTypeID())        return wrap_date(obj);
+  else if (di == CFDictionaryGetTypeID())  return wrap_dictionary(obj);
+  else                                     return wrap_unknown(obj);
 }
 
 CFTypeRef

data/ext/accessibility/bridge/bridge.h

@@ -33,6 +33,16 @@ extern ID sel_to_s;
 extern ID sel_parse;
 
 
+#define WRAP_OBJC(klass, finalizer) do {				\
+    return Data_Wrap_Struct(klass, NULL, finalizer, (void*)obj);	\
+  } while (false);
+
+#define UNWRAP_OBJC(klass) do {			\
+    klass* unwrapped;				\
+    Data_Get_Struct(obj, klass, unwrapped);	\
+    return unwrapped;				\
+  } while (false);
+
 #define WRAP_ARRAY(wrapper) do {				\
     CFIndex length = CFArrayGetCount(array);			\
     VALUE      ary = rb_ary_new2(length);			\
@@ -107,6 +117,7 @@ CFNumberRef unwrap_number(VALUE number);
 VALUE wrap_url(CFURLRef url);
 VALUE wrap_nsurl(NSURL* url);
 CFURLRef unwrap_url(VALUE url);
+NSURL* unwrap_nsurl(VALUE url);
 VALUE wrap_array_urls(CFArrayRef array);
 
 VALUE wrap_date(CFDateRef date);
@@ -122,6 +133,8 @@ CFBooleanRef unwrap_boolean(VALUE bool_val);
 // which is usually the case coming from the CF world
 VALUE wrap_array(CFArrayRef array);
 
+VALUE wrap_dictionary(NSDictionary* dict);
+
 VALUE to_ruby(CFTypeRef obj);
 CFTypeRef to_ax(VALUE obj);
 

data/ext/accessibility/core/core.c

@@ -1,11 +1,10 @@
 #include "ruby.h"
-
-#ifdef NOT_MACRUBY /* This entire extension is pointless when running on MacRuby */
-
-#import <Cocoa/Cocoa.h>
 #include "../bridge/bridge.h"
+#import <Cocoa/Cocoa.h>
 
 
+#ifdef NOT_MACRUBY /* This entire extension is pointless when running on MacRuby */
+
 static ID ivar_attrs;
 static ID ivar_param_attrs;
 static ID ivar_actions;
@@ -345,6 +344,7 @@ rb_acore_children(VALUE self)
     {
     case kAXErrorSuccess:
       return wrap_array_refs(value);
+    case kAXErrorFailure:
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
       return rb_ary_new();
@@ -636,6 +636,7 @@ Init_core()
   Init_bridge();
 
 #ifdef NOT_MACRUBY
+
   if (!AXAPIEnabled())
     rb_raise(
 	     rb_eRuntimeError,

data/ext/accessibility/core/extconf.rb

@@ -24,5 +24,5 @@ create_makefile 'accessibility/core/core'
 # modify the bugger so we can depend on bridge.h properly
 makefile = File.read 'Makefile'
 makefile.gsub! '$(DLLIB): $(OBJS) Makefile', '$(DLLIB): $(OBJS) Makefile ../bridge/bridge.o'
-makefile.gsub! '$(Q) $(LDSHARED) -o $@', '$(Q) $(LDSHARED) -o $@ ../bridge/bridge.o'
+makefile.gsub! '$(LDSHARED) -o $@', ' $(LDSHARED) -o $@ ../bridge/bridge.o'
 File.open('Makefile', 'w') { |f| f.write makefile }

data/ext/accessibility/extras/extconf.rb

@@ -24,5 +24,5 @@ create_makefile 'accessibility/extras/extras'
 # modify the bugger so we can depend on bridge.h properly
 makefile = File.read 'Makefile'
 makefile.gsub! '$(DLLIB): $(OBJS) Makefile', '$(DLLIB): $(OBJS) Makefile ../bridge/bridge.o'
-makefile.gsub! '$(Q) $(LDSHARED) -o $@', '$(Q) $(LDSHARED) -o $@ ../bridge/bridge.o'
+makefile.gsub! '$(LDSHARED) -o $@', ' $(LDSHARED) -o $@ ../bridge/bridge.o'
 File.open('Makefile', 'w') { |f| f.write makefile }

data/ext/accessibility/extras/extras.c

@@ -29,6 +29,7 @@ static VALUE rb_cRunningApp;
 static VALUE rb_cWorkspace;
 static VALUE rb_cProcInfo;
 static VALUE rb_cHost;
+static VALUE rb_cBundle;
 
 static VALUE key_opts;
 //static VALUE key_event_params;
@@ -403,22 +404,50 @@ rb_host_localized_name(VALUE self)
 }
 
 
+VALUE wrap_bundle(NSBundle* obj) { WRAP_OBJC(rb_cBundle, objc_finalizer); }
+NSBundle* unwrap_bundle(VALUE obj) { UNWRAP_OBJC(NSBundle); }
+
+static
 VALUE
-wrap_screen(NSScreen* screen)
+rb_bundle_with_url(VALUE self, VALUE url)
 {
-  return Data_Wrap_Struct(rb_cScreen, NULL, NULL, (void*)screen);
+  NSURL*     nsurl = unwrap_nsurl(url);
+  NSBundle* bundle = [NSBundle bundleWithURL:nsurl];
+  VALUE  rb_bundle = Qnil;
+
+  if (bundle)
+    rb_bundle = wrap_bundle(bundle);
+
+  return rb_bundle;
 }
 
-VALUE wrap_array_screens(CFArrayRef array) { WRAP_ARRAY(wrap_screen); }
+static
+VALUE
+rb_bundle_info_dict(VALUE self)
+{
+  NSDictionary* dict = [unwrap_bundle(self) infoDictionary];
+  VALUE         hash = Qnil;
+  if (dict)
+    hash = wrap_dictionary(dict);
+  return hash;
+}
 
-NSScreen*
-unwrap_screen(VALUE screen)
+static
+VALUE
+rb_bundle_object_for_info_dict_key(VALUE self, VALUE key)
 {
-  NSScreen* ns_screen;
-  Data_Get_Struct(screen, NSScreen, ns_screen);
-  return ns_screen;
+  NSString* nskey = unwrap_nsstring(key);
+  id obj = [unwrap_bundle(self) objectForInfoDictionaryKey:nskey];
+  if (obj)
+    return to_ruby(obj);
+  return Qnil;
 }
 
+
+VALUE wrap_screen(NSScreen* obj) { WRAP_OBJC(rb_cScreen, NULL); }
+VALUE wrap_array_screens(CFArrayRef array) { WRAP_ARRAY(wrap_screen); }
+NSScreen* unwrap_screen(VALUE obj) { UNWRAP_OBJC(NSScreen); }
+
 static
 VALUE
 rb_screen_main(VALUE self)
@@ -793,6 +822,21 @@ Init_extras()
   rb_define_singleton_method(rb_cHost, "names",         rb_host_names,          0);
   rb_define_singleton_method(rb_cHost, "addresses",     rb_host_addresses,      0);
   rb_define_singleton_method(rb_cHost, "localizedName", rb_host_localized_name, 0);
+
+
+  /*
+   * Document-class: NSBundle
+   *
+   * A tiny subset of Cocoa's `NSBundle` class. Methods that might be
+   * useful to have have been bridged.
+   *
+   * See [Apple's Developer Reference](https://developer.apple.com/library/mac/#documentation/Cocoa/Reference/Foundation/Classes/NSBundle_Class/Reference/Reference.html)
+   * for documentation on the methods available in this class.
+   */
+  rb_cBundle = rb_define_class("NSBundle", rb_cObject);
+  rb_define_singleton_method(rb_cBundle, "bundleWithURL", rb_bundle_with_url, 1);
+  rb_define_method(rb_cBundle, "infoDictionary",             rb_bundle_info_dict,                0);
+  rb_define_method(rb_cBundle, "objectForInfoDictionaryKey", rb_bundle_object_for_info_dict_key, 1);
 #endif
 
 

data/ext/accessibility/highlighter/extconf.rb

@@ -25,5 +25,5 @@ create_makefile 'accessibility/highlighter/highlighter'
 # modify the bugger so we can depend on bridge.h properly
 makefile = File.read 'Makefile'
 makefile.gsub! '$(DLLIB): $(OBJS) Makefile', '$(DLLIB): $(OBJS) Makefile ../bridge/bridge.o ../extras/extras.o'
-makefile.gsub! '$(Q) $(LDSHARED) -o $@', '$(Q) $(LDSHARED) -o $@ ../bridge/bridge.o ../extras/extras.o'
+makefile.gsub! '$(LDSHARED) -o $@', '$(LDSHARED) -o $@ ../bridge/bridge.o ../extras/extras.o'
 File.open('Makefile', 'w') { |f| f.write makefile }

data/lib/accessibility/bridge/macruby.rb

@@ -43,6 +43,10 @@ class NSObject
 
   ##
   # Return a usable object from an AXAPI pointer
+  #
+  # Given an arbitrary return value from an AXAPI function
+  # this method is called to delegate the work of actually
+  # wrapping the returned value in the correct way.
   def to_ruby
     self
   end

data/lib/accessibility/bridge/mri.rb

@@ -1,12 +1,12 @@
 ##
 # A structure that contains a point in a two-dimensional coordinate system
-CGPoint = Struct.new(:x, :y)
+CGPoint = Struct.new(:x, :y) unless defined? CGPoint
 class CGPoint
 
   # @param x [Number]
   # @param y [Number]
   def initialize x = 0.0, y = 0.0
-    super
+    super x.to_f, y.to_f
   end
 
   # @!attribute [rw] x
@@ -32,13 +32,13 @@ end
 
 ##
 # A structure that contains the size of a rectangle in a 2D co-ordinate system
-CGSize = Struct.new(:width, :height)
+CGSize = Struct.new(:width, :height) unless defined? CGSize
 class CGSize
 
   # @param width [Number]
   # @param height [Number]
   def initialize width = 0.0, height = 0.0
-    super
+    super width.to_f, height.to_f
   end
 
   # @!attribute [rw] width
@@ -64,7 +64,7 @@ end
 
 ##
 # Complete definition of a rectangle in a 2D coordinate system
-CGRect = Struct.new(:origin, :size)
+CGRect = Struct.new(:origin, :size) unless defined? CGRect
 class CGRect
 
   # @param origin [CGPoint,#to_point]
@@ -120,5 +120,22 @@ class String
   end
 end
 
+##
+# `accessibility-core` extensions to the `Object` class
+class Object
+  # (see NSObject#to_ruby)
+  def to_ruby
+    self
+  end
+end
+
+##
+# `accessibility-core` extensions to the `Array` class
+class Array
+  # (see NSArray#to_ruby)
+  def to_ruby
+    map do |obj| obj.to_ruby end
+  end
+end
 
 require 'accessibility/bridge/common'

data/lib/accessibility/core/version.rb

@@ -6,6 +6,6 @@ module Accessibility
   # Namespace for `accessibility_core` specific classes
   module Core
     # return [String]
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

data/test/test_core.rb

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+
+  def assert_error args, should_raise: klass, with_fragments: msgs
+    e = assert_raises(klass) { (@derp || app).handle_error *args }
+    assert_match /test_core.rb:272/, e.backtrace.first unless RUNNING_COMPILED
+    msgs.each { |msg| assert_match msg, e.message }
+  end
+
+  def test_handle_errors
+    app_inspect = Regexp.new(Regexp.escape(app.inspect))
+
+       assert_error [KAXErrorFailure],
+      should_raise: RuntimeError,
+    with_fragments: [/system failure/, app_inspect]
+
+       assert_error [KAXErrorIllegalArgument],
+      should_raise: ArgumentError,
+    with_fragments: [/is not an AXUIElementRef/, app_inspect]
+
+       assert_error [KAXErrorIllegalArgument, :cake],
+      should_raise: ArgumentError,
+    with_fragments: [/is not a legal argument/, /the element/, app_inspect, /cake/]
+
+       assert_error [KAXErrorIllegalArgument, 'cake', 'chocolate'],
+      should_raise: ArgumentError,
+    with_fragments: [/can't get\/set "cake" with\/to "chocolate"/, app_inspect]
+
+    p = CGPoint.new(1,3)
+       assert_error [KAXErrorIllegalArgument, p, nil, nil],
+      should_raise: ArgumentError,
+    with_fragments: [/The point #{p.inspect}/, app_inspect]
+
+       assert_error [KAXErrorInvalidUIElement],
+      should_raise: ArgumentError,
+    with_fragments: [/no longer a valid reference/, app_inspect]
+
+       assert_error [KAXErrorInvalidUIElementObserver, :pie, :cake],
+      should_raise: ArgumentError,
+    with_fragments: [/no longer support/]
+
+       assert_error [KAXErrorCannotComplete],
+      should_raise: RuntimeError,
+    with_fragments: [/An unspecified error/, app_inspect, /:\(/]
+
+    @derp = Accessibility::Element.application_for pid_for 'com.apple.finder'
+    def @derp.pid; false end
+       assert_error [KAXErrorCannotComplete],
+      should_raise: RuntimeError,
+    with_fragments: [/Application for pid/, /Maybe it crashed\?/]
+    @derp = nil
+
+       assert_error [KAXErrorAttributeUnsupported, :cake],
+      should_raise: ArgumentError,
+    with_fragments: [/does not have/, /:cake attribute/, app_inspect]
+
+       assert_error [KAXErrorActionUnsupported, :pie],
+      should_raise: ArgumentError,
+    with_fragments: [/does not have/, /:pie action/, app_inspect]
+
+       assert_error [KAXErrorNotificationUnsupported, :cheese],
+      should_raise: ArgumentError,
+    with_fragments: [/no longer support/]
+
+       assert_error [KAXErrorNotImplemented],
+      should_raise: NotImplementedError,
+    with_fragments: [/does not work with AXAPI/, app_inspect]
+
+       assert_error [KAXErrorNotificationAlreadyRegistered, :lamp],
+      should_raise: ArgumentError,
+    with_fragments: [/no longer support/]
+
+       assert_error [KAXErrorNotificationNotRegistered, :peas],
+      should_raise: RuntimeError,
+    with_fragments: [/no longer support/]
+
+       assert_error [KAXErrorAPIDisabled],
+      should_raise: RuntimeError,
+    with_fragments: [/AXAPI has been disabled/]
+
+       assert_error [KAXErrorNoValue],
+      should_raise: RuntimeError,
+    with_fragments: [/internal error/]
+
+      assert_error [KAXErrorParameterizedAttributeUnsupported, :oscar],
+      should_raise: ArgumentError,
+    with_fragments: [/does not have/, /:oscar parameterized attribute/, app_inspect]
+
+       assert_error [KAXErrorNotEnoughPrecision],
+      should_raise: RuntimeError,
+    with_fragments: [/not enough precision/, '¯\(°_o)/¯']
+
+    exception = assert_raises(RuntimeError) { app.send(:handle_error, 0) }
+    assert_match /assertion failed/, exception.message
+
+       assert_error [99],
+      should_raise: RuntimeError,
+    with_fragments: [/unknown error code/, /99/, app_inspect]
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accessibility_core
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-25 00:00:00.000000000 Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -90,6 +90,7 @@ files:
 - README.markdown
 - History.markdown
 - .yardopts
+- test/test_core.rb
 - test/helper.rb
 homepage: http://github.com/AXElements/accessibility_core
 licenses:
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1612632312201987392
+      hash: 4511147993527335350
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1612632312201987392
+      hash: 4511147993527335350
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -123,4 +124,5 @@ signing_key:
 specification_version: 3
 summary: A library for building automation tools on OS X
 test_files:
+- test/test_core.rb
 - test/helper.rb