CFPropertyList 2.3.5 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 74e0407ecce8171dfa845b93f5f55e1cd7d386a3
-  data.tar.gz: d3d8e956ad24476ee83293c9f4d25fa23b7f2947
+SHA256:
+  metadata.gz: b3293e20bb67a67db1ace3430acbd0d0662770ea7a80a65440f35ac5cfd57b1c
+  data.tar.gz: 8713fd11f1a07dd2e4df46fef316dd5b14ec8080ce88540135079367c23d6c34
 SHA512:
-  metadata.gz: 96bc102584b4a4745bcfaa403667644fff60e8be9b2ad9224c454f6b977b236f16156863cc48d20b8aa4cffc0f9f0e4bbea5c05fc7f06450afb49cb37f4aaede
-  data.tar.gz: 9f36e44475f5b7a48d957e54b35ed99a821c3df6ead60598c4fd8a7637bbbb1b9bfa8d5a7a438456ae814696ed52a438dbf94151cf2b29974995716c78a7189a
+  metadata.gz: bdc8bbf4e1207a1c540d4583e05c715e6b881aa0ae60f3d97a6485280ce5f3d20aba63894b178e03203acbf8dbd09a93ff336c12ef1840857b12b291009c29f5
+  data.tar.gz: 5d9c710d512e6a7b3d177042f2ebd717b46dab16c1f37fc3dc539ce588d8d12b1438e71e9dac4408555c9ec1eb9903ea482565d8f846774e935615b913a89dea

data/README.md

@@ -0,0 +1,79 @@
+CFPropertyList implementation
+class to read, manipulate and write both XML and binary property list
+files (plist(5)) as defined by Apple. Have a look at CFPropertyList::List
+for more documentation.
+
+# Caution!
+
+In version 3.0.0 we dropped Ruby 1.8 compatibility. If you are using
+Ruby 1.8 consider to update Ruby; if you can't upgrade, don't upgrade
+CFPropertyList.
+
+# Installation
+
+You could either use ruby gems and install it via
+    
+```bash
+gem install CFPropertyList
+```
+
+or you could clone this repository and place it somewhere in your load path.
+
+Example:
+```ruby
+require 'cfpropertylist'
+```
+
+If you're using Rails, you can add it into your Gemfile
+
+```ruby
+gem 'CFPropertyList'
+```
+
+# Usage
+
+  ## create a arbitrary data structure of basic data types
+  
+```ruby
+data = {
+  'name' => 'John Doe',
+  'missing' => true,
+  'last_seen' => Time.now,
+  'friends' => ['Jane Doe','Julian Doe'],
+  'likes' => {
+    'me' => false
+  }
+}
+```
+
+## create CFPropertyList::List object
+  
+```ruby
+plist = CFPropertyList::List.new
+```
+
+## call CFPropertyList.guess() to create corresponding CFType values
+
+```ruby  
+plist.value = CFPropertyList.guess(data)
+```
+
+## write plist to file
+```ruby
+plist.save("example.plist", CFPropertyList::List::FORMAT_BINARY)
+```
+
+## … later, read it again
+```ruby  
+plist = CFPropertyList::List.new(:file => "example.plist")
+data = CFPropertyList.native_types(plist.value)
+```
+
+# Author and license
+
+**Author:**    Christian Kruse (mailto:cjk@wwwtech.de)
+
+**Copyright:** Copyright (c) 2010
+
+**License:**   MIT License
+

data/{README → README.rdoc}

@@ -41,4 +41,3 @@ or you could clone this repository and place it somewhere in your load path.
 Author::    Christian Kruse (mailto:cjk@wwwtech.de)
 Copyright:: Copyright (c) 2010
 License::   MIT License
-

data/lib/cfpropertylist/rbBinaryCFPropertyList.rb

@@ -123,8 +123,8 @@ module CFPropertyList
 
     # read a binary int value
     def read_binary_int(fname,fd,length)
-      if length > 3
-        raise CFFormatError.new("Integer greater than 8 bytes: #{length}")
+      if length > 4
+        raise CFFormatError.new("Integer greater than 16 bytes: #{length}")
       end
 
       nbytes = 1 << length
@@ -136,17 +136,12 @@ module CFPropertyList
         when 0 then buff.unpack("C")[0]
         when 1 then buff.unpack("n")[0]
         when 2 then buff.unpack("N")[0]
-        when 3
-          hiword,loword = buff.unpack("NN")
-          if (hiword & 0x80000000) != 0
-            # 8 byte integers are always signed, and are negative when bit 63 is
-            # set. Decoding into either a Fixnum or Bignum is tricky, however,
-            # because the size of a Fixnum varies among systems, and Ruby
-            # doesn't consider the number to be negative, and won't sign extend.
-            -(2**63 - ((hiword & 0x7fffffff) << 32 | loword))
-          else
-            hiword << 32 | loword
-          end
+        # 8 byte integers are always signed
+        when 3 then buff.unpack("q>")[0]
+        # 16 byte integers are used to represent unsigned 8 byte integers
+        # where the unsigned value is stored in the lower 8 bytes and the
+        # upper 8 bytes are unused.
+        when 4 then buff.unpack("Q>Q>")[1]
         end
       )
     end
@@ -474,25 +469,19 @@ module CFPropertyList
 
     # Codes an integer to binary format
     def int_to_binary(value)
+      # Note: nbytes is actually an exponent.  number of bytes = 2**nbytes.
       nbytes = 0
-      nbytes = 1  if value > 0xFF # 1 byte integer
-      nbytes += 1 if value > 0xFFFF # 4 byte integer
-      nbytes += 1 if value > 0xFFFFFFFF # 8 byte integer
-      nbytes = 3  if value < 0 # 8 byte integer, since signed
+      nbytes = 1  if value > 0xFF # 1 byte unsigned integer
+      nbytes += 1 if value > 0xFFFF # 4 byte unsigned integer
+      nbytes += 1 if value > 0xFFFFFFFF # 8 byte unsigned integer
+      nbytes += 1 if value > 0x7FFFFFFFFFFFFFFF # 8 byte unsigned integer, stored in lower half of 16 bytes
+      nbytes = 3  if value < 0 # signed integers always stored in 8 bytes
 
       Binary.type_bytes(0b0001, nbytes) <<
-        if nbytes < 3
-          [value].pack(
-            if nbytes == 0    then "C"
-            elsif nbytes == 1 then "n"
-            else "N"
-            end
-          )
-        else
-          # 64 bit signed integer; we need the higher and the lower 32 bit of the value
-          high_word = value >> 32
-          low_word = value & 0xFFFFFFFF
-          [high_word,low_word].pack("NN")
+        if nbytes < 4
+          [value].pack(["C", "n", "N", "q>"][nbytes])
+        else # nbytes == 4
+          [0,value].pack("Q>Q>")
         end
     end
 

data/lib/cfpropertylist/rbCFPropertyList.rb

@@ -72,28 +72,12 @@ module CFPropertyList
   end
 end
 
-class String
-  unless("".respond_to?(:bytesize)) then
-    def bytesize
-      self.length
-    end
-  end
-end
-
 dirname = File.dirname(__FILE__)
 require dirname + '/rbCFPlistError.rb'
 require dirname + '/rbCFTypes.rb'
 require dirname + '/rbBinaryCFPropertyList.rb'
 require dirname + '/rbPlainCFPropertyList.rb'
 
-require 'iconv' unless "".respond_to?("encode")
-
-# ensure that the module and class exist
-module Enumerable
-  class Enumerator
-  end
-end
-
 begin
   require dirname + '/rbLibXMLParser.rb'
   temp = LibXML::XML::Parser::Options::NOBLANKS # check if we have a version with parser options
@@ -144,7 +128,7 @@ module CFPropertyList
     when Time, DateTime, Date
       CFDate.new(object)
 
-    when Array, Enumerator, Enumerable::Enumerator
+    when Array, Enumerator
       ary = Array.new
       object.each do |o|
         ary.push CFPropertyList.guess(o, options)
@@ -213,7 +197,7 @@ module CFPropertyList
 
   module_function :guess, :native_types
 
-  # Class representing a CFPropertyList. Instanciate with #new
+  # Class representing a CFPropertyList. Instantiate with #new
   class List
     # Format constant for binary format
     FORMAT_BINARY = 1

data/lib/cfpropertylist/rbLibXMLParser.rb

@@ -5,6 +5,7 @@ require 'libxml'
 module CFPropertyList
   # XML parser
   class LibXMLParser < XMLParserInterface
+    PARSER_OPTIONS = LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NONET
     # read a XML file
     # opts::
     # * :file - The filename of the file to load
@@ -13,9 +14,9 @@ module CFPropertyList
       doc = nil
 
       if(opts.has_key?(:file)) then
-        doc = LibXML::XML::Document.file(opts[:file],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
+        doc = LibXML::XML::Document.file(opts[:file],:options => PARSER_OPTIONS)
       else
-        doc = LibXML::XML::Document.string(opts[:data],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
+        doc = LibXML::XML::Document.string(opts[:data],:options => PARSER_OPTIONS)
       end
 
       if doc

data/lib/cfpropertylist/rbNokogiriParser.rb

@@ -5,6 +5,7 @@ require 'nokogiri'
 module CFPropertyList
   # XML parser
   class NokogiriXMLParser < ParserInterface
+    PARSER_OPTIONS = Nokogiri::XML::ParseOptions::NOBLANKS|Nokogiri::XML::ParseOptions::NONET
     # read a XML file
     # opts::
     # * :file - The filename of the file to load
@@ -12,9 +13,9 @@ module CFPropertyList
     def load(opts)
       doc = nil
       if(opts.has_key?(:file)) then
-        File.open(opts[:file], "rb") { |fd| doc = Nokogiri::XML::Document.parse(fd, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS|Nokogiri::XML::ParseOptions::NOENT) }
+        File.open(opts[:file], "rb") { |fd| doc = Nokogiri::XML::Document.parse(fd, nil, nil, PARSER_OPTIONS) }
       else
-        doc = Nokogiri::XML::Document.parse(opts[:data], nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS|Nokogiri::XML::ParseOptions::NOENT)
+        doc = Nokogiri::XML::Document.parse(opts[:data], nil, nil, PARSER_OPTIONS)
       end
 
       if doc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: CFPropertyList
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 3.0.3
 platform: ruby
 authors:
 - Christian Kruse
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,10 +30,11 @@ email: cjk@defunct.ch
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.rdoc
 files:
 - LICENSE
-- README
+- README.md
+- README.rdoc
 - THANKS
 - lib/cfpropertylist.rb
 - lib/cfpropertylist/rbBinaryCFPropertyList.rb
@@ -44,11 +45,11 @@ files:
 - lib/cfpropertylist/rbNokogiriParser.rb
 - lib/cfpropertylist/rbPlainCFPropertyList.rb
 - lib/cfpropertylist/rbREXMLParser.rb
-homepage: http://github.com/ckruse/CFPropertyList
+homepage: https://github.com/ckruse/CFPropertyList
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,9 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Read, write and manipulate both binary and XML property lists as defined
   by apple