binary_plist 0.0.1 → 0.0.3

data/Changelog.markdown

@@ -1,3 +1,13 @@
-0.0.1 (Jul 23, 2010)
+### 0.0.3 (Jul 26, 2010)
+
+* Fixed ASCII string encoding - closes #1
+
+### 0.0.2 (Jul 25, 2010)
+
+* Cleaned up converter
+* Changed to more standard `.plist` extension
+* Added basic specs
+
+### 0.0.1 (Jul 23, 2010)
 
 * Initial release

data/Rakefile

@@ -0,0 +1,13 @@
+require "rubygems"
+require "rake"
+require "spec/rake/spectask"
+
+spec_files = Rake::FileList["spec/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ['--color', '--format=specdoc']
+end
+
+task :default => :spec

data/Readme.markdown

@@ -2,6 +2,8 @@
 
 Rails plugin for easily adding a binary plist format. The binary plist format is ideal for transferring data to an Objective-C based application.
 
+**Note:** This is still a work in progress. It should be ready to use for most applications. The most noticeable issue is the lack of support for large integers.
+
 ## Installation
 
 Add the following line to your bundle and run `bundle install`.
@@ -10,13 +12,13 @@ Add the following line to your bundle and run `bundle install`.
 
 ## Usage
 
-All you have to do is add the `bplist` format to your `respond_to` block:
+All you have to do is add the `plist` format to your `respond_to` block:
 
     def index
       @posts = Post.all
       respond_to do |format|
         format.html
-        format.bplist { render :bplist => @posts }
+        format.plist { render :plist => @posts }
       end
     end
 
@@ -26,7 +28,7 @@ You can do the combined style if you're support multiple formats like `json` or
       @posts = Post.all
       respond_to do |format|
         format.html
-        format.any(:json, :bplist) { render request.format.to_sym => @posts }
+        format.any(:json, :plist) { render request.format.to_sym => @posts }
       end
     end
 
@@ -34,12 +36,12 @@ You can do the combined style if you're support multiple formats like `json` or
 
 On the Objective-C side, it's ridiculously easy to consume the plist data.
 
-    NSURL *url = [NSURL URLWithString:@"http://localhost:3000/posts.bplist"];
+    NSURL *url = [NSURL URLWithString:@"http://localhost:3000/posts.plist"];
     NSArray *posts = [NSArray arrayWithContentsOfURL:url];
 
 You can also use the more flexible syntax:
 
-    NSURL *url = [NSURL URLWithString:@"http://localhost:3000/posts.bplist"];
+    NSURL *url = [NSURL URLWithString:@"http://localhost:3000/posts.plist"];
     NSDate *date = [NSData dataWithContentsOfURL:url];
     id result = [NSPropertyListSerialization propertyListFromData:data
 			     mutabilityOption:NSPropertyListImmutable format:NULL errorDescription:nil];

data/Todo.markdown

@@ -0,0 +1,8 @@
+# Binary Plist To Do List
+
+* Fix trailer
+* Support large integers
+* Support `Date`
+* Support `DateTime`
+* Use `NSNull` instead of `@""` for nil
+* Finish specing all parts of the encoder

data/init.rb

@@ -7,5 +7,5 @@ ActionController::Renderers.add :bplist do |data, options|
   data = ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data, options))
   
   self.content_type ||= Mime::BPLIST
-  self.response_body = BinaryPlist::Converter.convert(data)
+  self.response_body = BinaryPlist.encode(data)
 end

data/lib/binary_plist.rb

@@ -6,122 +6,117 @@ module BinaryPlist
   # Very generic type for now
   MIME_TYPE = 'application/octet-stream'
   
-  module Converter
+  # Difference between Apple and UNIX timestamps
+  DATE_EPOCH_OFFSET_APPLE_UNIX = 978307200
 
-    # Difference between Apple and UNIX timestamps
-    DATE_EPOCH_OFFSET_APPLE_UNIX = 978307200
+  # Text encoding
+  INPUT_TEXT_ENCODING = 'UTF-8'
+  PLIST_TEXT_ENCODING = 'UTF-16BE'
 
-    # Text encoding
-    INPUT_TEXT_ENCODING = 'UTF-8'
-    PLIST_TEXT_ENCODING = 'UTF-16BE'
+  # For marking strings as binary data which will be decoded as a CFData object
+  CFData = Struct.new(:data)
+
+  # Convert a Ruby data structure into a binary property list file.
+  # Works as you'd expect. Integers are limited to 4 bytes, even though the format implies longer values can be written.
+  # Strings are assumed to be in UTF-8 format. Symbols are written as strings.
+  def self.encode object
+    write "", object
+  end
+
+  # Alternative interface which writes data to the out object using <<
+  def self.write out, object
+    # Find out how many objects there are, so we know how big the references are
+    count = count_objects(object)
+    ref_format, ref_size = int_format_and_size(count)
   
-    # For marking strings as binary data which will be decoded as a CFData object
-    CFData = Struct.new(:data)
+    # Now serialize all the objects
+    values = Array.new
+    append_values(object, values, ref_format)
   
-    # Convert a Ruby data structure into an OS X binary property list file. (.plist)
-    # Works as you'd expect. Integers are limited to 4 bytes, even though the format implies longer values can be written.
-    # Strings are assumed to be in UTF-8 format. Symbols are written as strings.
-    def self.convert(data)
-      write("", data)
+    # Write header, then the values, calculating offsets as they're written
+    out << 'bplist00'
+    offset = 8
+    offsets = Array.new
+    values.each do |v|
+      offsets << offset
+      out << v
+      offset += v.length
     end
-  
-    # Alternative interface which writes data to the out object using <<
-    def self.write(out, data)
-      # Find out how many objects there are, so we know how big the references are
-      count = count_objects(data)
-      ref_format, ref_size = int_format_and_size(count)
-    
-      # Now serialize all the objects
-      values = Array.new
-      append_values(data, values, ref_format)
-    
-      # Write header, then the values, calculating offsets as they're written
-      out << 'bplist00'
-      offset = 8
-      offsets = Array.new
-      values.each do |v|
-        offsets << offset
-        out << v
-        offset += v.length
-      end
 
-      # How big should the offset ints be?
-      # Decoder gets upset if the size can't fit the entire file, even if it's not strictly needed, so add the length of the last value.
-      offset_format, offset_size = int_format_and_size(offsets.last + values.last.length)
-    
-      # Write the offsets
-      out << offsets.pack(offset_format)
-    
-      # Write trailer
-      out << [0,0,offset_size,ref_size, 0,values.length, 0,0, 0,offset].pack("NnCCNNNNNN")
-    
-      out
-    end
+    # How big should the offset ints be?
+    # Decoder gets upset if the size can't fit the entire file, even if it's not strictly needed, so add the length of the last value.
+    offset_format, offset_size = int_format_and_size(offsets.last + values.last.length)
   
-    private
+    # Write the offsets
+    out << offsets.pack(offset_format)
   
-      def self.count_objects(data)
-        case data
+    # Write trailer
+    out << [0, 0, offset_size, ref_size, 0, values.length, 0, 0, 0, offset].pack("NnCCNNNNNN")
+  end
+
+  private
+
+    def self.count_objects object
+      case object
         when Array
-          data.inject(1) { |sum,x| sum + count_objects(x) }
+          object.inject(1) { |sum, x| sum + count_objects(x) }
+        
         when Hash
           # Note: Assumes that the keys aren't a Hash or Array
-          data.length + count_objects(data.values)
+          object.length + count_objects(object.values)
         else
           1
-        end
       end
-  
-      def self.append_values(data, values, ref_format)
-        case data
+    end
 
-        # Constant values
+    def self.append_values object, values, ref_format
+      case object
         when nil
-          # values << "\x00"
-          # raise "Can't store a nil in a binary plist. While the format supports it, decoders don't like it."
-          append_values("", values, ref_format)
+        # raise "Can't store a nil in a binary plist. While the format supports it, decoders don't like it." # values << "\x00"
+        # Instead of storing actual nil, store an empty string
+        append_values("", values, ref_format)
+        
         when false
           values << "\x08"
+        
         when true
           values << "\x09"
 
         when Integer
-          raise "Integer out of range to write in binary plist" if data < -2147483648 || data > 0x7FFFFFFF
-          values << packed_int(data)
+          raise "Integer out of range to write in binary plist: #{objet}" if object < -2147483648 || object > 0x7FFFFFFF
+          values << packed_int(object)
 
         when Float
-          values << "\x23#{[data].pack("d").reverse}"
+          values << "\x23#{[object].pack("d").reverse}"
 
         when Symbol
-          append_values(data.to_s, values, ref_format)
+          append_values(object.to_s, values, ref_format)
 
         when String
-          if data =~ /[\x80-\xff]/
+          if object =~ /[\x80-\xff]/
             # Has high bits set, so is UTF-8 and must be reencoded for the plist file
-            c = Iconv.iconv(PLIST_TEXT_ENCODING, INPUT_TEXT_ENCODING, data).join
-            values << "#{objhdr_with_length(0x60, c.length / 2)}#{c}"
+            c = Iconv.iconv(PLIST_TEXT_ENCODING, INPUT_TEXT_ENCODING, object).join
+            values << objhdr_with_length(0x60, c.length / 2) + c
           else
             # Just ASCII
-            o = objhdr_with_length(0x50, data.length)
-            o << data
-            values << o
+            values << objhdr_with_length(0x50, object.length) + object
           end
 
         when CFData
-          o = objhdr_with_length(0x40, data.data.length)
-          o << data.data
+          o = objhdr_with_length(0x40, object.data.length)
+          o << object.data
           values << o
 
         when Time
-          v = data.getutc.to_f - DATE_EPOCH_OFFSET_APPLE_UNIX
+          v = object.getutc.to_f - DATE_EPOCH_OFFSET_APPLE_UNIX
           values << "\x33#{[v].pack("d").reverse}"
 
         when Hash
-          o = objhdr_with_length(0xd0, data.length)
+          o = objhdr_with_length(0xd0, object.length)
           values << o # now, so we get the refs of other objects right
           ks = Array.new
           vs = Array.new
-          data.each do |k,v|
+          object.each do |k,v|
             ks << values.length
             append_values(k, values, ref_format)
             vs << values.length
@@ -129,12 +124,13 @@ module BinaryPlist
           end
           o << ks.pack(ref_format)
           o << vs.pack(ref_format)
+    
 
         when Array
-          o = objhdr_with_length(0xa0, data.length)
+          o = objhdr_with_length(0xa0, object.length)
           values << o # now, so we get the refs of other objects right
           refs = Array.new
-          data.each do |e|
+          object.each do |e|
             refs << values.length # index in array of object we're about to write
             append_values(e, values, ref_format)
           end
@@ -142,38 +138,37 @@ module BinaryPlist
 
         else
           raise "Couldn't serialize value of class #{data.class.name}"
-        end
       end
-  
-      def self.int_format_and_size(i)
-        if i > 0xffff
-          ['N*',4]
-        elsif i > 0xff
-          ['n*',2]
-        else
-          ['C*',1]
-        end
+    end
+
+    def self.int_format_and_size(i)
+      if i > 0xffff
+        ['N*', 4]
+      elsif i > 0xff
+        ['n*', 2]
+      else
+        ['C*', 1]
       end
+    end
 
-      def self.packed_int(data)
-        if data < 0
-          # Need to use 64 bits for negative numbers.
-          [0x13,0xffffffff,data].pack("CNN")
-        elsif data > 0xffff
-          [0x12,data].pack("CN")
-        elsif data > 0xff
-          [0x11,data].pack("Cn")
-        else
-          [0x10,data].pack("CC")
-        end
+    def self.packed_int integer
+      if integer < 0
+        # Need to use 64 bits for negative numbers.
+        [0x13, 0xffffffff, integer].pack("CNN")
+      elsif integer > 0xffff
+        [0x12, integer].pack("CN")
+      elsif integer > 0xff
+        [0x11, integer].pack("Cn")
+      else
+        [0x10, integer].pack("CC")
       end
-    
-      def self.objhdr_with_length(id, length)
-        if length < 0xf
-          (id + length).chr
-        else
-          (id + 0xf).chr + packed_int(length)
-        end
+    end
+  
+    def self.objhdr_with_length id, length
+      if length < 0xf
+        (id + length).chr
+      else
+        (id + 0xf).chr + packed_int(length)
       end
-  end
+    end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: binary_plist
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Sam Soffes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-23 00:00:00 -05:00
+date: 2010-07-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,14 +26,30 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 3
+        - 2
         - 0
-        version: "3.0"
+        version: "2.0"
   type: :runtime
   version_requirements: *id001
-description: Easily add the Apple Binary Plist format to your controllers for transferring data to Objective-C applications.
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: Easily convert Ruby objects to the Apple Binary Plist format for transferring data to Objective-C applications.
 email: sam@samsoff.es
 executables: []
 
@@ -45,7 +61,9 @@ files:
 - lib/binary_plist.rb
 - Changelog.markdown
 - LICENSE
+- Rakefile
 - Readme.markdown
+- Todo.markdown
 - init.rb
 has_rdoc: true
 homepage: http://github.com/samsoffes/binary_plist
@@ -80,6 +98,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Easily add the Apple Binary Plist format to your controllers.
+summary: Easily convert Ruby objects to the Apple Binary Plist format.
 test_files: []