accessibility_core 0.3.5 → 0.4.0

data/History.markdown

@@ -1,3 +1,17 @@
+# 0.4.0 - Fill in the gaps and other dubious requirements
+
+  * Add `Object#load_plist` to match MacRuby's `Object#load_plist`
+  * Add `URI::Generic#lastPathComponent` to match `NSURL#lastPathComponent`
+  * Add `URI::Generic#pathExtension` to match `NSURL#pathExtension`
+  * Add a 50% drop-in replacement for `NSData`
+  * Add a 50% drop-in replacement for `NSAttributedString`
+  * Add `Object#description` as a freedom patch on MRI
+    `NSObject#description` is the Objective-C equivalent to `Object#inspect` in Ruby.
+    While the intention is the same, the exact behaviour cannot be mimicked.
+
+  * Fixed some bugs related to converting arrays from Cocoa to Ruby
+
+
 # 0.3.5 - Add some missing bits for MRI
 
   * Add `Range#relative_to` to convert ranges to positive indicies

data/ext/accessibility/bridge/bridge.c

@@ -13,6 +13,8 @@ spin(double seconds)
 
 #ifdef NOT_MACRUBY
 
+VALUE rb_cData;
+VALUE rb_cAttributedString;
 VALUE rb_mAccessibility;
 VALUE rb_cElement;
 VALUE rb_cCGPoint;
@@ -255,20 +257,34 @@ VALUE wrap_array_refs(CFArrayRef array) { WRAP_ARRAY(wrap_ref) }
 VALUE
 wrap_string(CFStringRef string)
 {
-  return wrap_nsstring((NSString*)string);
+  VALUE   rb_str = Qnil;
+  CFDataRef data = CFStringCreateExternalRepresentation(
+							NULL,
+							string,
+							kCFStringEncodingUTF8,
+							0
+							);
+  if (data) {
+    rb_str = rb_enc_str_new(
+			    (char*)CFDataGetBytePtr(data),
+			    CFDataGetLength(data),
+			    rb_utf8_encoding()
+			    );
+    CFRelease(data);
+  }
+  else {
+    CFRelease(data);
+    CFShow(string);
+    rb_raise(rb_eRuntimeError, "Could not convert a string to a Ruby string");
+  }
+
+  return rb_str;
 }
 
 VALUE
 wrap_nsstring(NSString* string)
 {
-  // TODO: find a larger scope to apply this autoreleasepool
-  @autoreleasepool{
-    return rb_enc_str_new(
-        [string UTF8String],
-        [string lengthOfBytesUsingEncoding:NSUTF8StringEncoding],
-        rb_utf8_encoding()
-        );
-  }
+  return wrap_string((CFStringRef)string);
 }
 
 CFStringRef
@@ -297,6 +313,89 @@ VALUE wrap_array_nsstrings(NSArray* ary)
 }
 
 
+VALUE
+wrap_attributed_string(CFAttributedStringRef string)
+{
+  return wrap_nsattributed_string((NSAttributedString*)string);
+}
+
+VALUE
+wrap_nsattributed_string(NSAttributedString* obj)
+{
+  WRAP_OBJC(rb_cAttributedString, objc_finalizer);
+}
+
+CFAttributedStringRef
+unwrap_attributed_string(VALUE string)
+{
+  return (CFAttributedStringRef)unwrap_nsattributed_string(string);
+}
+
+NSAttributedString*
+unwrap_nsattributed_string(VALUE obj)
+{
+  UNWRAP_OBJC(NSAttributedString);
+}
+
+VALUE
+wrap_array_attributed_strings(CFArrayRef array)
+{
+  WRAP_ARRAY(wrap_attributed_string);
+}
+
+VALUE wrap_array_nsattributed_strings(NSArray* ary)
+{
+  CFArrayRef array = (CFArrayRef)ary;
+  WRAP_ARRAY(wrap_nsattributed_string);
+}
+
+static
+VALUE
+rb_astring_alloc(VALUE self)
+{
+  return wrap_nsattributed_string([NSAttributedString alloc]);
+}
+
+static
+VALUE
+rb_astring_init_with_string(int argc, VALUE* argv, VALUE self)
+{
+  if (!argc)
+    rb_raise(rb_eArgError, "wrong number of arguments (0 for 1+)");
+
+  NSString*              nsstring = unwrap_nsstring(argv[0]);
+  NSAttributedString* old_astring = unwrap_nsattributed_string(self);
+  NSAttributedString* new_astring = [old_astring initWithString:nsstring];
+  [nsstring release];
+  if (old_astring == new_astring)
+    return self;
+  return wrap_nsattributed_string(new_astring);
+}
+
+static
+VALUE
+rb_astring_string(VALUE self)
+{
+  NSString* string = [unwrap_nsattributed_string(self) string];
+  VALUE     rb_str = wrap_nsstring(string);
+  return rb_str;
+}
+
+static
+VALUE
+rb_astring_length(VALUE self)
+{
+  return ULONG2NUM([unwrap_nsattributed_string(self) length]);
+}
+
+static
+VALUE
+rb_astring_equality(VALUE self, VALUE other)
+{
+  OBJC_EQUALITY(rb_cAttributedString, unwrap_nsattributed_string);
+}
+
+
 #define WRAP_NUM(type, cookie, macro) do {		        \
     type value;							\
     if (CFNumberGetValue(num, cookie, &value))			\
@@ -456,16 +555,21 @@ VALUE wrap_array_booleans(CFArrayRef array) { WRAP_ARRAY(wrap_boolean) }
 VALUE
 wrap_array(CFArrayRef array)
 {
-  CFTypeRef obj = CFArrayGetValueAtIndex(array, 0);
-  CFTypeID   di = CFGetTypeID(obj);
-  if      (di == AXUIElementGetTypeID()) return wrap_array_refs(array);
-  else if (di == AXValueGetTypeID())     return wrap_array_values(array);
-  else if (di == CFStringGetTypeID())    return wrap_array_strings(array);
-  else if (di == CFNumberGetTypeID())    return wrap_array_numbers(array);
-  else if (di == CFBooleanGetTypeID())   return wrap_array_booleans(array);
-  else if (di == CFURLGetTypeID())       return wrap_array_urls(array);
-  else if (di == CFDateGetTypeID())      return wrap_array_dates(array);
-  else                                   return wrap_unknown(obj);
+  CFIndex length = CFArrayGetCount(array);
+  if (length) {
+    CFTypeRef obj = CFArrayGetValueAtIndex(array, 0);
+    CFTypeID   di = CFGetTypeID(obj);
+    if      (di == AXUIElementGetTypeID())  return wrap_array_refs(array);
+    else if (di == AXValueGetTypeID())      return wrap_array_values(array);
+    else if (di == CFStringGetTypeID())     return wrap_array_strings(array);
+    else if (di == CFNumberGetTypeID())     return wrap_array_numbers(array);
+    else if (di == CFBooleanGetTypeID())    return wrap_array_booleans(array);
+    else if (di == CFURLGetTypeID())        return wrap_array_urls(array);
+    else if (di == CFDateGetTypeID())       return wrap_array_dates(array);
+    else if (di == CFDictionaryGetTypeID()) return wrap_array_dictionaries(array);
+    else                                    return wrap_unknown(obj);
+  }
+  return rb_ary_new();
 }
 
 
@@ -481,22 +585,25 @@ wrap_dictionary(NSDictionary* dict)
   return hash;
 }
 
+VALUE wrap_array_dictionaries(CFArrayRef array) { WRAP_ARRAY(wrap_dictionary); }
 
 
 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 if (di == CFDictionaryGetTypeID())  return wrap_dictionary(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 == CFDataGetTypeID())             return wrap_data(obj);
+  else if (di == CFAttributedStringGetTypeID()) return wrap_attributed_string(obj);
+  else if (di == CFDictionaryGetTypeID())       return wrap_dictionary(obj);
+  else                                          return wrap_unknown(obj);
 }
 
 CFTypeRef
@@ -513,8 +620,9 @@ to_ax(VALUE obj)
     case T_FLOAT:
       return unwrap_number(obj);
     case T_TRUE:
+      return kCFBooleanTrue;
     case T_FALSE:
-      return unwrap_boolean(obj);
+      return kCFBooleanFalse;
     }
 
   VALUE type = CLASS_OF(obj);
@@ -522,6 +630,10 @@ to_ax(VALUE obj)
     return unwrap_date(obj);
   else if (type == rb_cRange)
     return unwrap_value_range(obj);
+  else if (type == rb_cAttributedString)
+    return unwrap_attributed_string(obj);
+  else if (type == rb_cData)
+    return unwrap_data(obj);
 
   if (rb_obj_is_kind_of(obj, rb_cURI))
     return unwrap_url(obj);
@@ -531,8 +643,114 @@ to_ax(VALUE obj)
 }
 
 
+VALUE
+wrap_data(CFDataRef data)
+{
+  return wrap_nsdata((NSData*)data);
+}
+
+VALUE
+wrap_nsdata(NSData* obj)
+{
+  WRAP_OBJC(rb_cData, objc_finalizer);
+}
+
+VALUE wrap_array_data(CFArrayRef array) { WRAP_ARRAY(wrap_data); }
+VALUE
+wrap_array_nsdata(NSArray* ary)
+{
+  CFArrayRef array = (CFArrayRef)ary;
+  WRAP_ARRAY(wrap_data);
+}
+
+CFDataRef
+unwrap_data(VALUE data)
+{
+  return (CFDataRef)unwrap_nsdata(data);
+}
+
+NSData*
+unwrap_nsdata(VALUE obj)
+{
+  UNWRAP_OBJC(NSData);
+}
+
+
+static
+VALUE
+rb_data_data(VALUE self)
+{
+  return wrap_nsdata([NSData data]);
+}
+
+static
+VALUE
+rb_data_with_contents_of_url(VALUE self, VALUE url)
+{
+  NSData* data = [NSData dataWithContentsOfURL:unwrap_nsurl(url)];
+  if (data)
+    return wrap_nsdata(data);
+  return Qnil;
+}
+
+static
+VALUE
+rb_data_length(VALUE self)
+{
+  return ULONG2NUM([unwrap_nsdata(self) length]);
+}
+
+static
+VALUE
+rb_data_equality(VALUE self, VALUE other)
+{
+  OBJC_EQUALITY(rb_cData, unwrap_nsdata);
+}
+
 static
 VALUE
+rb_data_write_to_file(int argc, VALUE* argv, VALUE self)
+{
+  if (argc < 2)
+    rb_raise(
+	     rb_eArgError,
+	     "wrong number of arguments, got %d, expected 2",
+	     argc
+	     );
+
+  NSString* path = unwrap_nsstring(argv[0]);
+  BOOL    result = [unwrap_nsdata(self) writeToFile:path
+		                         atomically:(argv[1] == Qtrue)];
+
+  [path release];
+
+  return (result ? Qtrue : Qfalse);
+}
+
+
+static
+VALUE
+rb_data_to_str(VALUE self)
+{
+  NSData*      data = unwrap_nsdata(self);
+  const void* bytes = [data bytes];
+  NSUInteger length = [data length];
+  return rb_enc_str_new(bytes, length, rb_utf8_encoding());
+}
+
+static
+VALUE
+rb_str_to_data(VALUE self)
+{
+  NSData* data = [NSData dataWithBytes:(void*)StringValuePtr(self)
+		                length:RSTRING_LEN(self)];
+  if (data)
+    return wrap_nsdata(data);
+  return Qnil; // I don't think this is possible except in case of ENOMEM
+}
+
+
+static VALUE
 rb_spin(int argc, VALUE* argv, VALUE self)
 {
   if (argc == 0)
@@ -570,6 +788,67 @@ Init_bridge()
   rb_mURI           = rb_const_get(rb_cObject, rb_intern("URI"));
   rb_cURI           = rb_const_get(rb_mURI, rb_intern("Generic"));
 
+
+  /*
+   * Document-class: NSAttributedString
+   *
+   * A 90% drop-in replacement for Cocoa's `NSAttributedString` class. The most likely
+   * to use methods have been bridged. Remaining methods can be bridged upon request.
+   *
+   * See [Apple's Developer Reference](https://developer.apple.com/library/mac/#documentation/Cocoa/Reference/Foundation/Classes/NSAttributedString_Class/Reference/Reference.html)
+   * for documentation on the methods available in this class.
+   */
+  rb_cAttributedString = rb_define_class("NSAttributedString", rb_cObject);
+
+  // LOL, but required to be a drop-in replacement
+  rb_define_singleton_method(rb_cAttributedString, "alloc", rb_astring_alloc, 0);
+
+  // TODO: all these methods :(
+  rb_define_method(rb_cAttributedString, "initWithString", rb_astring_init_with_string, -1);
+  /* rb_define_method(rb_cAttributedString, "initWithAttributedString", rb_astring_init_with_astring, 2); */
+  rb_define_method(rb_cAttributedString, "string", rb_astring_string, 0);
+  rb_define_method(rb_cAttributedString, "length", rb_astring_length, 0);
+  /* rb_define_method(rb_cAttributedString, "attributesAtIndex", rb_astring_attrs_at_index, -1); */
+  rb_define_method(rb_cAttributedString, "isEqualToAttributedString", rb_astring_equality, 1);
+  /* rb_define_method(rb_cAttributedString, "attributedSubstringFromRange", rb_astring_astring_from_range, 1); */
+
+  rb_define_alias(rb_cAttributedString, "to_s",   "string");
+  rb_define_alias(rb_cAttributedString, "to_str", "string");
+  rb_define_alias(rb_cAttributedString, "==",     "isEqualToAttributedString");
+
+
+  /*
+   * Document-class: NSData
+   *
+   * A 50% drop-in replacement for Cocoa's `NSData` class. Almost all
+   * non-deprecated methods have been bridged.
+   *
+   * See [Apple's Developer Reference](https://developer.apple.com/library/mac/#documentation/Cocoa/Reference/Foundation/Classes/NSData_Class/Reference/Reference.html)
+   * for documentation on the methods available in this class.
+   */
+  rb_cData = rb_define_class("NSData", rb_cObject);
+
+  // TODO: implement commented out methods
+  rb_define_singleton_method(rb_cData, "data", rb_data_data, 0);
+  //rb_define_singleton_method(rb_cData, "dataWithBytes", rb_data_with_bytes, 2);
+  //rb_define_singleton_method(rb_cData, "dataWithContentsOfFile", rb_data_with_contents_of_file, 1);
+  rb_define_singleton_method(rb_cData, "dataWithContentsOfURL", rb_data_with_contents_of_url, 1);
+  //rb_define_singleton_method(rb_cData, "dataWithData", rb_data_with_data, 1);
+
+  //rb_define_method(rb_cData, "bytes",            rb_data_bytes, 0);
+  //rb_define_method(rb_cData, "description",      rb_data_description, 0);
+  //rb_define_method(rb_cData, "subdataWithRange", rb_data_subrange, 1);
+  rb_define_method(rb_cData, "isEqualToData",    rb_data_equality, 1);
+  rb_define_method(rb_cData, "length",           rb_data_length, 0);
+  rb_define_method(rb_cData, "writeToFile",      rb_data_write_to_file, -1);
+  //rb_define_method(rb_cData, "writeToURL",       rb_data_write_to_url, -1);
+  rb_define_method(rb_cData, "to_str",           rb_data_to_str, 0);
+
+  rb_define_alias(rb_cData,  "==", "isEqualToData");
+
+
+  // misc freedom patches
+  rb_define_method(rb_cString, "to_data", rb_str_to_data, 0);
   rb_define_method(rb_cObject, "spin", rb_spin, -1); // semi-private method
 #endif
 }

data/ext/accessibility/bridge/bridge.h

@@ -11,6 +11,8 @@ void Init_bridge();
 
 #ifdef NOT_MACRUBY
 
+extern VALUE rb_cData;
+extern VALUE rb_cAttributedString;
 extern VALUE rb_mAccessibility;
 extern VALUE rb_cElement;
 extern VALUE rb_cCGPoint;
@@ -43,6 +45,13 @@ extern ID sel_parse;
     return unwrapped;				\
   } while (false);
 
+#define OBJC_EQUALITY(type, unwrapper) do {		\
+    if (CLASS_OF(other) == type)			\
+      if ([unwrapper(self) isEqual:unwrapper(other)])	\
+	return Qtrue;					\
+    return Qfalse;					\
+  } while (false);
+
 #define WRAP_ARRAY(wrapper) do {				\
     CFIndex length = CFArrayGetCount(array);			\
     VALUE      ary = rb_ary_new2(length);			\
@@ -129,11 +138,17 @@ VALUE wrap_boolean(CFBooleanRef bool_val);
 VALUE wrap_array_booleans(CFArrayRef array);
 CFBooleanRef unwrap_boolean(VALUE bool_val);
 
+VALUE wrap_data(CFDataRef data);
+VALUE wrap_nsdata(NSData* data);
+CFDataRef unwrap_data(VALUE data);
+NSData* unwrap_nsdata(VALUE data);
+
 // this function assumes that arrays are homogeneous;
 // which is usually the case coming from the CF world
 VALUE wrap_array(CFArrayRef array);
 
 VALUE wrap_dictionary(NSDictionary* dict);
+VALUE wrap_array_dictionaries(CFArrayRef array);
 
 VALUE to_ruby(CFTypeRef obj);
 CFTypeRef to_ax(VALUE obj);
@@ -142,4 +157,18 @@ VALUE wrap_screen(NSScreen* screen);
 VALUE wrap_array_screens(CFArrayRef array);
 NSScreen* unwrap_screen(VALUE screen);
 
+VALUE wrap_attributed_string(CFAttributedStringRef string);
+VALUE wrap_nsattributed_string(NSAttributedString* string);
+VALUE wrap_array_attributed_strings(CFArrayRef array);
+VALUE wrap_array_nsattributed_strings(NSArray* ary);
+CFAttributedStringRef unwrap_attributed_string(VALUE string);
+NSAttributedString* unwrap_nsattributed_string(VALUE string);
+
+VALUE wrap_data(CFDataRef data);
+VALUE wrap_nsdata(NSData* data);
+VALUE wrap_array_data(CFArrayRef array);
+VALUE wrap_array_nsdata(NSArray* array);
+CFDataRef unwrap_data(VALUE data);
+NSData* unwrap_nsdata(VALUE data);
+
 #endif

data/ext/accessibility/extras/extras.c

@@ -444,6 +444,29 @@ rb_bundle_object_for_info_dict_key(VALUE self, VALUE key)
 }
 
 
+static
+VALUE
+rb_load_plist(VALUE self, VALUE plist_data)
+{
+  NSData* data = [NSData dataWithBytes:(void*)StringValueCStr(plist_data)
+		                length:RSTRING_LEN(plist_data)];
+  NSError* err = nil;
+  id     plist = [NSPropertyListSerialization propertyListWithData:data
+                     	                                   options:0
+		                                            format:nil
+       	                                                     error:&err];
+  [data release];
+  if (plist) {
+    VALUE list = to_ruby(plist);
+    [plist release];
+    return list;
+  }
+
+  rb_raise(rb_eArgError, "error loading property list: '%s'",
+	   [[err localizedDescription] UTF8String]);
+  return Qnil; // unreachable
+}
+
 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); }
@@ -837,6 +860,9 @@ Init_extras()
   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);
+
+
+  rb_define_method(rb_cObject, "load_plist", rb_load_plist, 1);
 #endif
 
 

data/lib/accessibility/bridge/mri.rb

@@ -106,6 +106,39 @@ class URI::Generic
   def to_url
     self
   end
+
+  ##
+  # Return the last component of the path of the URL
+  #
+  # This is intended to help make {URI::Generic} closer to being
+  # a drop-in replacement for {NSURL}.
+  #
+  # @example
+  #
+  #   url = "https://macruby.macosforge.org/files/nightlies/macruby_nightly-latest.pkg"
+  #   URI.parse(url).lastPathComponent # => "macruby_nightly-latest.pkg"
+  #
+  # @return [String]
+  def lastPathComponent
+    self.path.split(%r{/+}).last
+  end
+
+  ##
+  # Returns the path extension of a file URL
+  #
+  # This is intended to help make {URI::Generic} closer to being
+  # a drop-in replacement for {NSURL}.
+  #
+  # @example
+  #
+  #   url = "https://macruby.macosforge.org/files/nightlies/macruby_nightly-latest.pkg"
+  #   URI.parse(url).pathExtension # => "pkg"
+  #
+  # @return [String]
+  def pathExtension
+    split = self.path.split '.', -1
+    split.size > 1 ? split.last : ''
+  end
 end
 
 ##
@@ -137,6 +170,17 @@ class Object
   def NSContainsRect outer, inner
     outer.to_rect.contains? inner
   end
+
+  ##
+  # An alias for `Object#inspect`
+  #
+  # This exists to help make code more compatible between MacRuby
+  # and CRuby.
+  #
+  # @return [String]
+  def description
+    inspect
+  end
 end
 
 ##

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.5'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accessibility_core
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 865923332438012461
+      hash: -989078667386493475
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 865923332438012461
+      hash: -989078667386493475
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24