corefoundation 0.2.0 → 0.3.4

data/lib/corefoundation/refinements.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module CF
+  module Refinements
+    # Patches for ruby Integer
+    refine Integer do
+      # 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
+
+    # Patches for ruby Float
+    refine Float do
+      # 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
+
+    # Patches for ruby Array
+    refine Array do
+      # 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
+
+    # Patches for ruby TrueClass
+    refine TrueClass do
+      # Returns a CF::Boolean object representing true
+      # @return [CF::Boolean]
+      def to_cf
+        CF::Boolean::TRUE
+      end
+    end
+
+    # Patches for ruby FalseClass
+    refine FalseClass do
+      # Returns a CF::Boolean object representing false
+      # @return [CF::Boolean]
+      def to_cf
+        CF::Boolean::FALSE
+      end
+    end
+
+    # Patches for ruby String
+    refine String do
+      # 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
+        binary? ? to_cf_data : to_cf_string
+      end
+
+      # @!method binary?
+      #
+      # used to determine whether {#to_cf} should return a {CF::String} or a {CF::Data}.
+      # This simply checks whether the encoding is ascii-8bit or not.
+      #
+      # @return whether the string is handled as binary data or not
+      #
+      def binary?
+        encoding == Encoding::ASCII_8BIT
+      end
+
+      # @param [optional, Boolean, Encoding] bin
+      # 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
+          force_encoding Encoding::ASCII_8BIT
+        else
+          # default to utf-8
+          force_encoding(bin == false ? "UTF-8" : bin)
+        end
+        self
+      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
+
+    # Patches for ruby Time
+    refine Time do
+      # Returns a {CF::Date} representing the time.
+      # @return [CF::Date]
+      def to_cf
+        CF::Date.from_time(self)
+      end
+    end
+
+    # Patches for ruby Hash
+    refine Hash do
+      # 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
+        transform_keys! &:to_s # Convert all keys to strings
+        CF::Dictionary.mutable.tap do |r|
+          each do |k, v|
+            r[k.to_cf] = v.to_cf
+          end
+        end
+      end
+    end
+  end
+end

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,26 +20,15 @@ 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, 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
+    def self.from_string(s)
+      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
@@ -65,27 +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
-
-      if HAS_ENCODING
-        buffer.read_string(bytes_used).force_encoding(Encoding::UTF_8)
-      else
-        buffer.read_string(bytes_used)
-      end
+      buffer.read_string(len).force_encoding(Encoding::UTF_8)
     end
-
-    alias_method :to_ruby, :to_s
-
+    alias to_ruby to_s
   end
 
 end

data/lib/corefoundation/version.rb

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

data/lib/corefoundation.rb

@@ -1,13 +1,38 @@
-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'
+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,182 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: corefoundation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease:
+  version: 0.3.4
 platform: ruby
 authors:
 - Frederick Cheung
-autorequire:
+- Chef Software, Inc.
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
+        version: 1.15.0
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
-    none: false
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
-    none: false
-  prerelease: false
+        version: '3.0'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: yard
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chefstyle
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
+        version: 2.0.9
   type: :development
-- !ruby/object:Gem::Dependency
-  name: redcarpet
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 2.0.9
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
+        version: '0'
   type: :development
-description: ! 'FFI based Ruby wrappers for Core Foundation '
-email: frederick.cheung@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for macOS Core Foundation framework
+email:
+- frederick.cheung@gmail.com
+- oss@chef.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !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
+- 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/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
+homepage: http://github.com/chef/corefoundation
 licenses:
 - MIT
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
-  none: false
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
-summary: Ruby wrapper for OS X corefoundation
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for macOS Core Foundation framework
 test_files: []
-has_rdoc:

data/CHANGELOG

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

@@ -1,40 +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
-=============
-
-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
-=======
-
-Released under the MIT license. See LICENSE