corefoundation 0.1.4 → 0.3.13

data/lib/corefoundation/register.rb

@@ -0,0 +1,24 @@
+require "singleton"
+
+module CF
+  module Register
+    def self.included base
+      base.extend self
+    end
+
+    def register_type(type_name)
+      CF.attach_function "#{type_name}GetTypeID", [], :cftypeid
+      type_map[CF.send("#{type_name}GetTypeID")] = self
+    end
+
+    private
+
+    def klass_from_cf_type(cftyperef)
+      klass = type_map[CF.CFGetTypeID(cftyperef)]
+      raise TypeError, "No class registered for cf type #{cftyperef.inspect}" unless klass
+
+      klass
+    end
+
+  end
+end

data/lib/corefoundation/string.rb

@@ -20,16 +20,15 @@ module CF
     # The cfstring encoding for UTF8
     UTF8 = 0x08000100 #From cfstring.h
 
-
     # 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')
+      s_utf = s.encode("UTF-8")
       raw = CF.CFStringCreateWithBytes(nil, s_utf, s_utf.bytesize, UTF8, 0)
-      raw.null? ? nil : new(raw).release_on_gc
+      raw.null? ? nil : new(raw)
     end
 
     # Returns the length, in unicode characters of the string
@@ -55,23 +54,15 @@ module CF
       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)
+      len = bytes_used_buffer.send(cfindex == CF.find_type(:long_long) ? :read_long_long : :read_long)
 
-      bytes_used = if cfindex == CF.find_type(:long_long)
-        bytes_used_buffer.read_long_long
-      else
-        bytes_used_buffer.read_long
-      end
-
-      buffer.read_string(bytes_used).force_encoding(Encoding::UTF_8)
+      buffer.read_string(len).force_encoding(Encoding::UTF_8)
     end
-
-    alias_method :to_ruby, :to_s
-
+    alias 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.3.13"
 end

data/lib/corefoundation.rb

@@ -1,11 +1,38 @@
-require 'ffi'
-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'
+require "ffi" unless defined?(FFI)
+
+module CF
+  extend FFI::Library
+  ffi_lib '/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation'
+
+  if FFI::Platform::ARCH == 'x86_64'
+    typedef :long_long, :cfindex
+    typedef :long_long, :cfcomparisonresult
+    typedef :ulong_long, :cfoptionflags
+    typedef :ulong_long, :cftypeid
+    typedef :ulong_long, :cfhashcode
+  else
+    typedef :long, :cfindex
+    typedef :long, :cfcomparisonresult
+    typedef :ulong, :cfoptionflags
+    typedef :ulong, :cftypeid
+    typedef :ulong, :cfhashcode
+  end
+
+  typedef :pointer, :cftyperef
+end
+
+require_relative 'corefoundation/refinements'
+require_relative 'corefoundation/memory'
+require_relative 'corefoundation/register'
+require_relative 'corefoundation/base'
+require_relative 'corefoundation/null'
+require_relative 'corefoundation/range'
+require_relative 'corefoundation/string'
+require_relative 'corefoundation/array'
+require_relative 'corefoundation/boolean'
+require_relative 'corefoundation/data'
+require_relative 'corefoundation/dictionary'
+require_relative 'corefoundation/number'
+require_relative 'corefoundation/date'
+require_relative 'corefoundation/exceptions'
+require_relative 'corefoundation/preferences'

metadata

@@ -1,150 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: corefoundation
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.3.13
 platform: ruby
 authors:
 - Frederick Cheung
+- Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: chefstyle
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'FFI based Ruby wrappers for Core Foundation '
-email: frederick.cheung@gmail.com
+description: Ruby wrapper for macOS Core Foundation framework
+email:
+- frederick.cheung@gmail.com
+- oss@chef.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- lib/corefoundation.rb
 - 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/exceptions.rb
+- lib/corefoundation/memory.rb
 - lib/corefoundation/null.rb
 - lib/corefoundation/number.rb
+- lib/corefoundation/preferences.rb
+- lib/corefoundation/range.rb
+- lib/corefoundation/refinements.rb
+- lib/corefoundation/register.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
-- README.md
-- LICENSE
-homepage: http://github.com/fcheung/corefoundation
+homepage: http://github.com/chef/corefoundation
 licenses:
 - MIT
+metadata: {}
 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
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
-summary: Ruby wrapper for  OS X's corefoundation
+specification_version: 4
+summary: Ruby wrapper for macOS Core Foundation framework
 test_files: []
-has_rdoc: 

data/README.md

@@ -1,39 +0,0 @@
-
-CoreFoundation
-==============
-
-FFI based wrappers for a subset of core foundation: various bits of CFString, CFData, CFArray, CFDictionary are available. Not that useful on its own but a useful building block for writing ffi wrappers of other OS X libraries.
-
-Although the CF collection classes can store arbitrary pointer sized values this wrapper only supports storing CFTypes.
-
-The CF namespace has the raw FFI generated method calls but it's usually easier to use the wrapper classes: `CF::String`, `CF::Date`, `CF::Array`, `CF::Dictionary`, `CF::Boolean` which try to present a rubyish view of the world (for example `CF::Array` implements `Enumerable`)
-
-These implement methods for creating new instances from ruby objects (eg `CF::String.from_string("hello world")`) but you can also pass build them from an `FFI::Pointer`).
-
-Converting
-===========
-
-`CF::Base` objects has a `to_ruby` that creates a ruby object of the most approprite type (`String` for `CF::String`, `Time` for `CF::Date`, `Integer` or `Float` for `CF::Number` etc). The collection classes call `to_ruby` on their contents too.
-
-In addition to the methods on the wrapper classes themselves, the ruby classes are extended with a `to_cf` method. Because CoreFoundation strings aren't arbitrary collections of bytes, `String#to_cf` will return a `CF::Data` if the string has the ASCII-8BIT encoding and a `CF::String` if not.
-
-If you have an `FFI::Pointer` or a raw address then you can create a wrapper by passing it to `new`, for example `CF::String.new(some_pointer)`. This does *not* check that the pointer is actually a `CFString`. You can use `CF::Base.typecast` to construct an instance of the appropriate subclass, for example `CF::Base.typecast(some_pointer)` would return a `CF::String` if `some_pointer` was in fact a `CFStringRef`.
-
-Memory Management
-=================
-
-The convenience methods for creating CF objects will release the cf object when they are garbage collected. Methods on the convenience classes will usually retain the result and mark it for releasing when they are garbage collected (for example `CF::Dictionary#[]` retains the returned value). You don't need to do any extra memory management on these.
-
-If you pass an `FFI::Pointer` to `new` or `typecast` no assumptions are made for you. You should call `retain` or `release` to manage it manually. As an alternative to calling `release` manually,  the `release_on_gc` method adds a finalizer to the wrapper that will call `CFRelease` on the Core Foundation object when the wrapper is garbage collected. You will almost certainly crash your ruby interpreter if you overrelease an object and you will leak memory if you overretain one.
-
-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.
-
-License
-=======
-
-Released under the MIT license. See LICENSE

data/lib/corefoundation/extensions.rb

@@ -1,81 +0,0 @@
-# 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 the string has the encoding ASCII_8BIt a {CF::Data} is returned, if not a {CF::String} is returned
-  # 
-  # @return [CF::String, CF::Data]
-  def to_cf
-    if encoding == Encoding::ASCII_8BIT
-      CF::Data.from_string self
-    else
-      CF::String.from_string self
-    end
-  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/spec/array_spec.rb

@@ -1,92 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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'
-      ruby_string.encoding.should == Encoding::ASCII_8BIT
-    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'
-      subject.to_ruby.encoding.should == Encoding::ASCII_8BIT
-    end
-  end
-end

data/spec/date_spec.rb

@@ -1,25 +0,0 @@
-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
-