corefoundation 0.1.4 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,12 @@
+# Changelog
+
+
+
+
+## 0.2.0 - 2012-12-06
+Add support for ruby 1.8.7 [tmaher]
+
+
+## 0.1.4 - 2012-10-16
+
+Initial version

data/README.md

@@ -31,7 +31,8 @@ If you use the raw api (eg `CF.CFArrayCreate`) then you're on your own.
 
 Compatibility
 =============
-Requires ruby 1.9 due to use of encoding related methods. Should work in MRI and jruby. Not compatible with rubinius due to rubinius' ffi implemenation not supporting certain features.
+
+Should work in MRI 1.8.7 and above and jruby. Not compatible with rubinius due to rubinius' ffi implementation not supporting certain features. On 1.8.7 the `binary?` and `binary!` methods tag a string's binary-ness with a flag, on 1.9 these methods are just shortcuts for testing whether the encoding is Encoding::ASCII_8BIT
 
 License
 =======

data/lib/corefoundation.rb

@@ -1,4 +1,6 @@
 require 'ffi'
+require 'iconv' if RUBY_VERSION < "1.9"
+
 require 'corefoundation/base'
 require 'corefoundation/null'
 require 'corefoundation/string'
@@ -8,4 +10,4 @@ require 'corefoundation/data'
 require 'corefoundation/dictionary'
 require 'corefoundation/number'
 require 'corefoundation/date'
-require 'corefoundation/extensions'
+require 'corefoundation/extensions'

data/lib/corefoundation/data.rb

@@ -23,7 +23,11 @@ module CF
     # @return [String]
     def to_s
       ptr = CF.CFDataGetBytePtr(self)
-      ptr.read_string(CF.CFDataGetLength(self)).force_encoding(Encoding::ASCII_8BIT)
+      if CF::String::HAS_ENCODING
+        ptr.read_string(CF.CFDataGetLength(self)).force_encoding(Encoding::ASCII_8BIT)
+      else
+        ptr.read_string(CF.CFDataGetLength(self))
+      end
     end
 
     # The size in bytes of the CFData

data/lib/corefoundation/extensions.rb

@@ -46,16 +46,93 @@ end
 # Ruby String class
 class String
   # Returns a {CF::String} or {CF::Data} representing the string.
-  # If the string has the encoding ASCII_8BIt a {CF::Data} is returned, if not a {CF::String} is returned
+  # 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
-    if encoding == Encoding::ASCII_8BIT
-      CF::Data.from_string self
-    else
-      CF::String.from_string self
+    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
@@ -78,4 +155,4 @@ class Hash
       end
     end
   end
-end
+end

data/lib/corefoundation/string.rb

@@ -20,14 +20,24 @@ module CF
     # 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)
-      s_utf = s.encode('UTF-8')
+    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
@@ -67,11 +77,15 @@ module CF
         bytes_used_buffer.read_long
       end
 
-      buffer.read_string(bytes_used).force_encoding(Encoding::UTF_8)
+      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
+end

data/lib/corefoundation/version.rb

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

data/spec/data_spec.rb

@@ -7,7 +7,9 @@ describe CF::Data do
     it 'should return a binary ruby string' do
       ruby_string = subject.to_s
       ruby_string.should == 'A CF string'
-      ruby_string.encoding.should == Encoding::ASCII_8BIT
+      if CF::String::HAS_ENCODING
+        ruby_string.encoding.should == Encoding::ASCII_8BIT
+      end
     end
   end
 
@@ -20,7 +22,9 @@ describe CF::Data do
   describe 'to_ruby' do
     it 'should behave like to_s' do
       subject.to_ruby.should == 'A CF string'
-      subject.to_ruby.encoding.should == Encoding::ASCII_8BIT
+      if 'A CF string'.respond_to? "encoding"
+        subject.to_ruby.encoding.should == Encoding::ASCII_8BIT
+      end
     end
   end
 end

data/spec/extensions_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'spec_helper'
 
 describe 'extensions' do
@@ -13,16 +14,79 @@ describe 'extensions' do
     end
   end
 
-  context 'with a 8bit string' do
-    it 'should return a cf data' do
-      '123'.encode(Encoding::ASCII_8BIT).to_cf.should be_a(CF::Data)
+  describe String do
+    uber = [195, 188, 98, 101, 114]
+    
+    describe 'to_cf' do
+
+      unless defined? RUBY_ENGINE and RUBY_ENGINE == 'jruby'
+        context 'with data incorrectly marked as non binary' do
+          it 'returns nil' do
+            [0xff, 0xff, 0xff].pack("C*").binary!(false).to_cf.should be_nil
+          end
+        end
+      end
+
+      context 'with a non binary string' do
+        it 'should return a cf string' do
+          '123'.to_cf.should be_a(CF::String)
+        end
+      end
+
+      context 'with a string marked as binary' do
+        it 'should return a cf data' do
+          '123'.binary!.to_cf.should be_a(CF::Data)
+        end
+      end
+
+      context 'with a binary string' do    
+        it 'should return a cf data' do
+          [0xff, 0xff, 0xff].pack("C*").to_cf.should be_a(CF::Data)
+        end
+      end
+
+      context 'with a utf-8 string' do
+        it 'should return a cfstring' do
+          uber.pack("C*").should_not be_a(CF::String)
+        end
+      end
     end
-  end
 
-  context 'with an asciistring' do
-    it 'should return a cf string' do
-      '123'.to_cf.should be_a(CF::String)
+    describe 'binary?' do
+
+      it 'should return false on a plain ascii string' do
+        '123'.should_not be_binary
+      end
+
+      if CF::String::HAS_ENCODING
+        it 'should return false on valid utf data' do
+          "\xc3\xc9".should_not be_binary
+        end
+      else
+        it 'should return false on valid utf data' do
+          uber.pack("C*").should_not be_binary
+        end
+      end
+
+      it 'should return false on string forced to non binary' do
+        "\xc3\xc9".binary!(false).should_not be_binary
+      end
+
+      it 'should return true if binary! has been called' do
+        '123'.binary!.should be_binary
+      end
+
+      if CF::String::HAS_ENCODING
+        it 'should return true for ascii 8bit strings' do
+          '123'.encode(Encoding::ASCII_8BIT).should be_binary
+        end
+      else
+        it 'should return true for data that cannot be converted to utf8' do
+          "\xff\xff\xff".should be_binary
+        end
+      end
     end
+
   end
 
   context 'with true' do
@@ -60,4 +124,4 @@ describe 'extensions' do
       cf_hash['key_2'].should == CF::Boolean::FALSE
     end
   end
-end
+end

data/spec/string_spec.rb

@@ -9,10 +9,14 @@ describe CF::String do
 
     # The intent is to force feed CF::String with an invalid utf-8 string
     # but jruby doesn't seem to allow this to be constructed
-    unless RUBY_ENGINE == 'jruby'
+    unless defined? RUBY_ENGINE and RUBY_ENGINE == 'jruby'
       context 'with invalid data' do
         it 'returns nil' do
-          CF::String.from_string("\xff\xff\xff".force_encoding('UTF-8')).should be_nil
+          if CF::String::HAS_ENCODING
+            CF::String.from_string("\xff\xff\xff".force_encoding('UTF-8')).should be_nil
+          else
+            CF::String.from_string("\xff\xff\xff").should be_nil
+          end
         end
       end
     end
@@ -22,14 +26,19 @@ describe CF::String do
     it 'should return a utf ruby string' do
       ruby_string = CF::String.from_string('A CF string').to_s
       ruby_string.should == 'A CF string'
-      ruby_string.encoding.should == Encoding::UTF_8
+      if CF::String::HAS_ENCODING
+        ruby_string.encoding.should == Encoding::UTF_8
+      else
+      end
     end
   end
 
   describe 'to_ruby' do
     it 'should behave like to_s' do
       CF::String.from_string('A CF string').to_ruby.should == 'A CF string'
-      CF::String.from_string('A CF string').to_ruby.encoding.should == Encoding::UTF_8
+      if CF::String::HAS_ENCODING
+        CF::String.from_string('A CF string').to_ruby.encoding.should == Encoding::UTF_8
+      end
     end
   end
 

metadata

@@ -1,150 +1,182 @@
 --- !ruby/object:Gem::Specification
 name: corefoundation
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.2.0
+  prerelease:
 platform: ruby
 authors:
 - Frederick Cheung
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2012-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 description: ! 'FFI based Ruby wrappers for Core Foundation '
 email: frederick.cheung@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/corefoundation/array.rb
-- lib/corefoundation/base.rb
-- lib/corefoundation/boolean.rb
-- lib/corefoundation/data.rb
-- lib/corefoundation/date.rb
-- lib/corefoundation/dictionary.rb
-- lib/corefoundation/extensions.rb
-- lib/corefoundation/null.rb
-- lib/corefoundation/number.rb
-- lib/corefoundation/string.rb
-- lib/corefoundation/version.rb
-- lib/corefoundation.rb
-- spec/array_spec.rb
-- spec/boolean_spec.rb
-- spec/data_spec.rb
-- spec/date_spec.rb
-- spec/dictionary_spec.rb
-- spec/extensions_spec.rb
-- spec/null_spec.rb
-- spec/number_spec.rb
-- spec/spec_helper.rb
-- spec/string_spec.rb
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uLnJi
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2FycmF5LnJi
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2Jhc2UucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2Jvb2xlYW4ucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2RhdGEucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2RhdGUucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2RpY3Rpb25hcnkucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL2V4dGVuc2lvbnMucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL251bGwucmI=
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL251bWJlci5yYg==
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL3N0cmluZy5yYg==
+- !binary |-
+  bGliL2NvcmVmb3VuZGF0aW9uL3ZlcnNpb24ucmI=
+- !binary |-
+  c3BlYy9hcnJheV9zcGVjLnJi
+- !binary |-
+  c3BlYy9ib29sZWFuX3NwZWMucmI=
+- !binary |-
+  c3BlYy9kYXRhX3NwZWMucmI=
+- !binary |-
+  c3BlYy9kYXRlX3NwZWMucmI=
+- !binary |-
+  c3BlYy9kaWN0aW9uYXJ5X3NwZWMucmI=
+- !binary |-
+  c3BlYy9leHRlbnNpb25zX3NwZWMucmI=
+- !binary |-
+  c3BlYy9udWxsX3NwZWMucmI=
+- !binary |-
+  c3BlYy9udW1iZXJfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- !binary |-
+  c3BlYy9zdHJpbmdfc3BlYy5yYg==
 - README.md
 - LICENSE
+- CHANGELOG
 homepage: http://github.com/fcheung/corefoundation
 licenses:
 - MIT
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: 1.8.7
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
-summary: Ruby wrapper for  OS X's corefoundation
+summary: Ruby wrapper for OS X corefoundation
 test_files: []
-has_rdoc: 
+has_rdoc: