og-corefoundation 0.2.1

data/lib/corefoundation/extensions.rb

@@ -0,0 +1,158 @@
+# Rubyinteger
+class Integer
+  # Converts the Integer to a {CF::Number} using {CF::Number.from_i}
+  # @return [CF::Number]
+  def to_cf
+    CF::Number.from_i(self)
+  end
+end
+
+# Ruby float class
+class Float
+  # Converts the Float to a {CF::Number} using {CF::Number.from_f}
+  # @return [CF::Number]
+  def to_cf
+    CF::Number.from_f(self)
+  end
+end
+
+# Ruby array class
+class Array
+  # Converts the Array to an immutable {CF::Array} by calling `to_cf` on each element it contains
+  # @return [CF::Number]
+  def to_cf
+    CF::Array.immutable(collect(&:to_cf))
+  end
+end
+
+# Ruby true class
+class TrueClass
+  # Returns a CF::Boolean object representing true
+  # @return [CF::Boolean]
+  def to_cf
+    CF::Boolean::TRUE
+  end
+end
+
+# Ruby false class
+class FalseClass
+  # Returns a CF::Boolean object representing false
+  # @return [CF::Boolean]
+  def to_cf
+    CF::Boolean::FALSE
+  end
+end
+
+# Ruby String class
+class String
+  # Returns a {CF::String} or {CF::Data} representing the string.
+  # If {#binary?} returns true a {CF::Data} is returned, if not a {CF::String} is returned
+  # 
+  # If you want a {CF::Data} with the contents of a non binary string, use {#to_cf_data}
+  #
+  # @return [CF::String, CF::Data]
+  def to_cf
+    self.binary? ? self.to_cf_data : self.to_cf_string
+  end
+
+  # @!method binary?
+  #
+  # used to determine whether {#to_cf} should return a {CF::String} or a {CF::Data}. On ruby 1.9 and above this simply 
+  # checks whether the encoding is ascii-8bit or not.
+  # 
+  # On ruby 1.8.7
+  #
+  # - A string is binary if you call {#binary!} with the default argument of true
+  # - A string is not binary if you call {#binary!} with the argument false
+  # 
+  # If you have never called {#binary!} then a string is binary if Iconv does not think it is valid utf-8
+  # @return whether the string is handled as binary data or not
+  #
+  if '<3'.respond_to? :encoding
+    def binary?
+      encoding == Encoding::ASCII_8BIT
+    end
+  else
+    def binary?
+      unless defined? @cf_is_binary
+        begin
+          ::Iconv.conv('UTF-8', 'UTF-8', self)
+          return false if self.frozen?
+          @cf_is_binary = false
+        rescue Iconv::IllegalSequence
+          return true if self.frozen?
+          @cf_is_binary = true
+        end
+      end
+      @cf_is_binary
+    end
+  end
+
+  if '<3'.respond_to? :encoding
+  # On ruby 1.8.7 sets or clears the flag used by {#binary?}. On ruby 1.9 the string's encoding is forced. 
+  # @see #binary?
+  # 
+  # @note There is no advantage to using this over the standard encoding methods unless you wish to retain 1.8.7 compatibility
+  #
+  # @param [optional, Boolean, Encoding] bin On ruby 1.8.7 only boolean values are admissible. On ruby 1.9 you can pass a specific encoding to force. 
+  #   If you pass `true` then `Encoding::ASCII_BIT` is used, if you pass `false` then `Encoding::UTF_8`
+  #
+    def binary!(bin=true)
+      if bin == true
+        self.force_encoding Encoding::ASCII_8BIT
+      else
+        # default to utf-8
+        self.force_encoding( (bin == false) ? "UTF-8" : bin)
+      end
+      self
+    end
+  else
+  # On ruby 1.8.7 sets or clears the flag used by {#binary?}. On ruby 1.9 the string's encoding is forced. 
+  # @see #binary?
+  # 
+  # @note There is no advantage to using this over the standard encoding methods unless you wish to retain 1.8.7 compatibility
+  #
+  # @param [optional, Boolean, Encoding] bin On ruby 1.8.7 only boolean values are admissible. On ruby 1.9 you can pass a specific encoding to force. 
+  #   If you pass `true` then `Encoding::ASCII_BIT` is used, if you pass `false` then `Encoding::UTF_8`
+  #
+    def binary!(bin=true)
+      @cf_is_binary = !! bin
+      self
+    end
+  end
+  
+  # Returns a {CF::String} representing the string
+  # @return [CF::String]
+  def to_cf_string
+    CF::String.from_string self
+  end
+  
+  # Returns a {CF::Data} representing the string
+  # @return [CF::Data]
+  def to_cf_data
+    CF::Data.from_string self
+  end
+  
+end
+
+# Ruby Time class
+class Time
+  # Returns a {CF::Date} representing the time.
+  # @return [CF::Date]
+  def to_cf
+    CF::Date.from_time(self)
+  end
+end
+
+# Ruby Hash class
+class Hash
+  # Converts the Hash to an mutable {CF::Dictionary} by calling `to_cf` on each key and value it contains
+  # @return [CF::Dictionary]
+  def to_cf
+    CF::Dictionary.mutable.tap do |r|
+      each do |k,v|
+        r[k.to_cf] = v.to_cf
+      end
+    end
+  end
+end

data/lib/corefoundation/null.rb

@@ -0,0 +1,11 @@
+module CF
+  attach_variable 'kCFNull', :pointer
+
+  # Wrapper class for the cf null class
+  class Null < Base
+    register_type 'CFNull'
+  end
+
+  #The singleton CFNull instance
+  NULL = Null.new(CF.kCFNull)
+end

data/lib/corefoundation/number.rb

@@ -0,0 +1,98 @@
+module CF
+  typedef :pointer, :cfnumberref
+  enum :cf_number_type, [
+    :kCFNumberSInt8Type,1,
+    :kCFNumberSInt16Type,2,
+    :kCFNumberSInt32Type,3,
+    :kCFNumberSInt64Type,4,
+    :kCFNumberFloat32Type,5,
+    :kCFNumberFloat64Type,6,
+    :kCFNumberCharType,7,
+    :kCFNumberShortType,8,
+    :kCFNumberIntType,9,
+    :kCFNumberLongType,10,
+    :kCFNumberLongLongType,11,
+    :kCFNumberFloatType,12,
+    :kCFNumberDoubleType,13,
+    :kCFNumberCFIndexType,14,
+    :kCFNumberNSIntegerType,15,
+    :kCFNumberCGFloatType,16,
+    :kCFNumberMaxType,16
+  ]
+
+  attach_function 'CFNumberGetValue', [:cfnumberref, :cf_number_type, :pointer], :uchar
+  attach_function 'CFNumberCreate', [:pointer, :cf_number_type, :pointer], :cfnumberref
+  attach_function 'CFNumberIsFloatType', [:pointer], :uchar
+  attach_function 'CFNumberCompare', [:cfnumberref, :cfnumberref, :pointer], :cfcomparisonresult
+
+  # Wrapper for CFNumberRef
+  #
+  #
+  class Number < Base
+    register_type 'CFNumber'
+    include Comparable
+
+
+    # Constructs a CF::Number from a float
+    # @param [Float] float
+    # @return [CF::Number]
+    def self.from_f(float)
+      p = FFI::MemoryPointer.new(:double)
+      p.write_double(float.to_f)
+      new(CF.CFNumberCreate(nil, :kCFNumberDoubleType, p)).release_on_gc
+    end
+
+    # Constructs a CF::Number from an integer
+    # @param [Integer] int
+    # @return [CF::Number]
+    def self.from_i(int)
+      p = FFI::MemoryPointer.new(:int64)
+      p.put_int64(0,int.to_i)
+      new(CF.CFNumberCreate(nil, :kCFNumberSInt64Type, p)).release_on_gc
+    end
+
+    # Compares the receiver with the argument
+    # @param [CF::Number] other
+    # @return [Integer]
+    def <=>(other)
+      raise TypeError, "argument should be CF::Number" unless other.is_a?(CF::Number)
+      CF.CFNumberCompare(self,other,nil)
+    end
+
+
+    # Converts the CF::Number to either an Integer or a Float, depending on the result of CFNumberIsFloatType
+    #
+    # @return [Integer, Float]
+    def to_ruby
+      if CF.CFNumberIsFloatType(self) == 0
+        to_i
+      else
+        to_f
+      end
+    end
+
+    # Converts the CF::Number to an integer
+    # May raise if the conversion cannot be done without loss of precision
+    # @return [Integer]
+    def to_i
+      p = FFI::MemoryPointer.new(:int64)
+      if CF.CFNumberGetValue(self, :kCFNumberSInt64Type, p) != 0
+        p.get_int64 0
+      else
+        raise "CF.CFNumberGetValue failed to convert #{self.inspect} to kCFNumberSInt64Type"
+      end
+    end
+
+    # Converts the CF::Number to a float
+    # May raise if the conversion cannot be done without loss of precision
+    # @return [Float]
+    def to_f
+      p = FFI::MemoryPointer.new(:double)
+      if CF.CFNumberGetValue(self, :kCFNumberDoubleType, p) != 0
+        p.read_double
+      else
+        raise "CF.CFNumberGetValue failed to convert #{self.inspect} to kCFNumberDoubleType"
+      end
+    end
+  end
+end

data/lib/corefoundation/string.rb

@@ -0,0 +1,91 @@
+module CF
+  typedef :pointer, :cfstringref
+
+  attach_function 'CFStringCreateWithBytes', [:pointer, :buffer_in, :cfindex, :uint, :char], :cfstringref  
+  attach_function 'CFStringGetBytes', [:cfstringref, :uint], :pointer
+  attach_function 'CFStringGetMaximumSizeForEncoding', [:cfindex, :uint], :cfindex
+  attach_function 'CFStringGetLength', [:cfstringref], :cfindex
+
+  attach_function 'CFStringGetBytes', [:cfstringref, CF::Range.by_value, :uint, :uchar, :char, :buffer_out, :cfindex, :buffer_out], :cfindex
+
+  attach_function 'CFStringCompare', [:cfstringref, :cfstringref, :cfoptionflags], :cfcomparisonresult
+
+  # Wrapper class for CFString
+  #
+  # Unlike ruby, CFString is not an arbitrary bag of bytes - the data will be converted to a collection of unicode characters
+  class String < Base
+    include Comparable
+    register_type("CFString")
+
+    # The cfstring encoding for UTF8
+    UTF8 = 0x08000100 #From cfstring.h
+
+    # workaround for ruby 1.8.7 compat
+    HAS_ENCODING = "foo".respond_to? "encode"
+
+    # Creates a string from a ruby string
+    # The string must be convertable to UTF-8
+    #
+    # @param [String] s 
+    # @return [CF::String]
+    def self.from_string(s, src_encoding='UTF-8')
+      if HAS_ENCODING
+        s_utf = s.encode('UTF-8')
+      else
+        begin
+          s_utf = Iconv.conv('UTF-8', src_encoding, s.to_s)
+        rescue Iconv::IllegalSequence => e
+          return nil
+        end
+      end
+      raw = CF.CFStringCreateWithBytes(nil, s_utf, s_utf.bytesize, UTF8, 0)
+      raw.null? ? nil : new(raw).release_on_gc
+    end
+
+    # Returns the length, in unicode characters of the string
+    # @return [Integer]
+    def length
+      CF.CFStringGetLength(self)
+    end
+
+    # Compares the receiver with the argument
+    # @param [CF::String] other
+    # @return [Integer]
+    def <=>(other)
+      Base.check_cftype(other)
+      CF.CFStringCompare(self,other,0)
+    end
+
+    # Converts the CF::String to a UTF-8 ruby string 
+    #
+    # @return [String]
+    def to_s
+      max_size = CF.CFStringGetMaximumSizeForEncoding(length, UTF8)
+      range = CF::Range.new
+      range[:location] = 0
+      range[:length] = length
+      buffer = FFI::MemoryPointer.new(:char, max_size)
+
+      cfindex = CF.find_type(:cfindex)
+      bytes_used_buffer = FFI::MemoryPointer.new(cfindex)
+
+      CF.CFStringGetBytes(self, range, UTF8, 0, 0, buffer, max_size, bytes_used_buffer)
+
+      bytes_used = if cfindex == CF.find_type(:long_long)
+        bytes_used_buffer.read_long_long
+      else
+        bytes_used_buffer.read_long
+      end
+
+      if HAS_ENCODING
+        buffer.read_string(bytes_used).force_encoding(Encoding::UTF_8)
+      else
+        buffer.read_string(bytes_used)
+      end
+    end
+
+    alias_method :to_ruby, :to_s
+
+  end
+
+end

data/lib/corefoundation/version.rb

@@ -0,0 +1,4 @@
+module CF
+  # The current version string
+  VERSION = "0.2.1"
+end

data/lib/corefoundation.rb

@@ -0,0 +1,13 @@
+require 'ffi'
+require 'iconv' if RUBY_VERSION < "1.9"
+
+require 'corefoundation/base'
+require 'corefoundation/null'
+require 'corefoundation/string'
+require 'corefoundation/array'
+require 'corefoundation/boolean'
+require 'corefoundation/data'
+require 'corefoundation/dictionary'
+require 'corefoundation/number'
+require 'corefoundation/date'
+require 'corefoundation/extensions'

data/spec/array_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe CF::Array do
+  describe 'mutable' do
+    subject { CF::Array.mutable}
+    
+    it { should be_a(CF::Array)}
+    it { should be_mutable}
+
+    describe '[]=' do
+      it 'should raise when trying to store a non cf value' do
+        expect {subject[0] = 123}.to raise_error(TypeError)
+      end
+    end
+
+    describe '<<' do
+      it 'should raise when trying to store a non cf value' do
+        expect {subject << 123}.to raise_error(TypeError)
+      end
+    end
+
+  end
+
+  describe 'immutable' do
+    it 'should raise if all of the array elements are not cf values' do
+      expect {CF::Array.immutable([CF::Boolean::TRUE, 1])}.to raise_error(TypeError)
+    end
+
+    it 'should return an immutable cfarray' do
+      CF::Array.immutable([CF::Boolean::TRUE]).should be_a(CF::Array)
+    end
+    
+    context 'with an immutable array' do
+      subject { CF::Array.immutable([CF::Boolean::TRUE, CF::String.from_string('123')])}
+
+      describe '[]=' do
+        it 'should raise TypeError' do
+          expect {subject[0] = CF::Boolean::TRUE}.to raise_error(TypeError)
+        end
+      end
+
+      describe '<<' do
+        it 'should raise TypeError' do
+          expect {subject << CF::Boolean::TRUE}.to raise_error(TypeError)
+        end
+      end
+    end
+  end
+
+  context "with an array" do
+    subject { CF::Array.immutable([CF::Boolean::TRUE, CF::String.from_string('123')])}
+
+    describe '[]' do
+      it 'should return the typecast value at the index' do
+        subject[1].should be_a(CF::String)
+        subject[1].should == CF::String.from_string('123')
+      end
+    end
+
+
+    describe 'length' do
+      it 'should return the count of items in the dictionary' do
+        subject.length.should == 2
+      end
+    end
+
+    describe 'to_ruby' do
+      it 'should return the result of calling to ruby on its contents' do
+        subject.to_ruby.should == [true, '123']
+      end
+    end
+
+    describe 'each' do 
+      it 'should iterate over each value' do
+        values = []
+        subject.each do |v|
+          values << v
+        end
+        values[0].should == CF::Boolean::TRUE
+        values[1].should == CF::String.from_string('123')
+      end
+    end
+
+    it 'should be enumerable' do
+      values = {}
+      subject.each_with_index do |value, index|
+        values[index] = value
+      end
+      values.should == {0 => CF::Boolean::TRUE, 1 => CF::String.from_string('123')}
+    end
+  end
+end

data/spec/boolean_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe CF do
+
+
+  describe CF::Boolean do
+    describe 'value' do
+      it 'should return true for CF::Boolean::TRUE' do
+        CF::Boolean::TRUE.value.should == true
+      end
+      it 'should return false for CF::Boolean::FALSE' do
+        CF::Boolean::FALSE.value.should == false
+      end
+    end
+
+    describe 'to_ruby' do
+      it 'should behave like value' do
+        CF::Boolean::FALSE.to_ruby.should == false
+      end
+    end
+
+  end
+
+end

data/spec/data_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+
+describe CF::Data do
+  subject {CF::Data.from_string('A CF string')}
+  describe '#to_s' do
+    it 'should return a binary ruby string' do
+      ruby_string = subject.to_s
+      ruby_string.should == 'A CF string'
+      if CF::String::HAS_ENCODING
+        ruby_string.encoding.should == Encoding::ASCII_8BIT
+      end
+    end
+  end
+
+  describe '#size' do
+    it 'should return the size in bytes of the cfdata' do
+      subject.size.should == 11
+    end
+  end
+
+  describe 'to_ruby' do
+    it 'should behave like to_s' do
+      subject.to_ruby.should == 'A CF string'
+      if 'A CF string'.respond_to? "encoding"
+        subject.to_ruby.encoding.should == Encoding::ASCII_8BIT
+      end
+    end
+  end
+end

data/spec/date_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe CF::Date do
+  describe('from_time') do
+    it 'should create a cf date from a time' do
+      CF::Date.from_time(Time.now).should be_a(CF::Date)
+    end
+  end
+
+  describe('to_time') do
+    it 'should return a time' do
+      t = CF::Date.from_time(Time.now).to_time
+      t.should be_a(Time)
+      t.should be_within(0.01).of(Time.now)
+    end
+  end
+
+  describe 'to_ruby' do
+    it 'should behave like to_time' do
+      t = CF::Date.from_time(Time.now).to_ruby
+      t.should be_a(Time)
+    end
+  end
+end
+

data/spec/dictionary_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+
+describe CF::Dictionary do
+  describe 'mutable' do
+    it 'should return  a cf dictionary' do
+      CF::Dictionary.mutable.should be_a(CF::Dictionary)
+    end
+  end
+
+  describe 'hash access' do
+    subject {CF::Dictionary.mutable}
+
+    it 'should return nil when the key does not exist' do
+      subject['doesnotexist'].should be_nil
+    end
+
+    it 'should raise when trying to store a non cf value' do
+      expect {subject[CF::String.from_string('key')]=1}.to raise_error(TypeError)
+    end
+
+    it 'should raise when trying to store a non cf key' do
+      expect {subject[1]=CF::String.from_string('value')}.to raise_error(TypeError)
+    end
+
+    it 'should allow storing and retrieving a cf key pair' do
+      subject[CF::String.from_string('key')] = CF::String.from_string('value')
+    end
+
+    it 'should instantiate the correct type on retrieval' do
+      subject[CF::String.from_string('key')] = CF::String.from_string('value')
+      subject[CF::String.from_string('key')].should be_a(CF::String)
+    end
+
+    it 'should coerce string keys' do
+      subject['key'] = CF::String.from_string('value')
+      subject['key'].to_s.should == 'value'
+    end
+  end
+
+  describe 'merge!' do
+    subject { CF::Dictionary.mutable.tap {|dict| dict['1'] = CF::Boolean::TRUE; dict['2'] = CF::Boolean::FALSE}}
+    it 'should merge the argument into the receiver' do
+      argument = {'1' => false, 'foo' => 'bar'}.to_cf
+      subject.merge! argument
+      subject.to_ruby.should == {'1' => false, '2' => false, 'foo' => 'bar'}
+    end
+  end
+
+  describe 'length' do
+    it 'should return the count of items in the dictionary' do
+      dict = CF::Dictionary.mutable
+      dict['one'] = CF::Boolean::TRUE
+      dict['two'] = CF::Boolean::TRUE
+
+      dict.length.should == 2
+    end
+  end
+
+  describe 'enumeration' do
+    subject { CF::Dictionary.mutable.tap {|dict| dict['1'] = CF::Boolean::TRUE; dict['2'] = CF::Boolean::FALSE}}
+
+    it 'should yield each key value pair in the dictionary' do
+      hash = {}
+      subject.each do |k,v|
+        hash[k] = v
+      end
+      hash.should == {CF::String.from_string('1') => CF::Boolean::TRUE, 
+                      CF::String.from_string('2') => CF::Boolean::FALSE}
+    end
+  end
+
+  describe 'to_ruby' do
+    subject { CF::Dictionary.mutable.tap {|dict| dict['1'] = CF::Boolean::TRUE; dict['2'] = CF::Array.immutable([CF::Boolean::FALSE])}}
+
+    it 'should return a ruby hash where keys and values have been converted to ruby types' do
+      subject.to_ruby.should == {'1' => true, '2' => [false]}
+    end
+  end
+
+end