ffi-msgpack 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+doc
+pkg
+.bundle
+.yardoc

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'FFI MsgPack Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,8 @@
+### 0.1.0 / 2010-05-21
+
+* Initial release.
+  * Can pack and unpack `nil`, `true`, `false`, Integers, Floats, Strings,
+    Arrays and Hashes.
+  * Provides a buffered / callback driven packer.
+  * Provides a buffered / streaming unpacker.
+

data/Gemfile

@@ -0,0 +1,24 @@
+source 'http://rubygems.org'
+
+group :runtime do
+  gem 'ffi',		'~> 0.6.0'
+end
+
+group :development do
+  gem 'bundler',	'~> 0.9.25'
+  gem 'rake',		'~> 0.8.7'
+  gem 'jeweler',	'~> 1.4.0', :git => 'git://github.com/technicalpickles/jeweler.git'
+end
+
+group :doc do
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku',	'~> 0.6.0'
+  else
+    gem 'rdiscount',	'~> 1.6.3'
+  end
+
+  gem 'yard',			'~> 0.5.3'
+end
+
+gem 'rspec',	'~> 1.3.0', :group => [:development, :test]

data/LICENSE.txt

@@ -0,0 +1,23 @@
+
+The MIT License
+
+Copyright (c) 2010 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# ffi-msgpack
+
+* [github.com/postmodern/ffi-msgpack](http://github.com/postmodern/ffi-msgpack/)
+* [github.com/postmodern/ffi-msgpack/issues](http://github.com/postmodern/ffi-msgpack/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+Ruby FFI bindings for the [msgpack](http://msgpack.sourceforge.net/) library.
+
+## Features
+
+* Can pack and unpack `nil`, `true`, `false`, Integers, Floats, Strings,
+  Arrays and Hashes.
+* Provides a buffered / callback driven packer.
+* Provides a buffered / streaming unpacker.
+
+## Examples
+
+Pack an Object:
+
+    require 'ffi/msgpack'
+
+    FFI::MsgPack.pack([1,'x',true])
+    # => "\x93\x01\xA1x\xC3"
+
+Pack one or more Objects into a Buffer:
+
+    packer = FFI::MsgPack::Packer.create
+    packer << 1
+    packer << 'x'
+    packer << true
+
+    packer.buffer
+    # => "\x01\xA1x\xC3"
+    packer.total
+    # => 3
+
+Pack one or more Objects with a custom write callback:
+
+    require 'socket'
+
+    socket = TCPSocket.new('example.com',9786)
+    packer = FFI::MsgPack::Packer.create do |packed,length|
+      socket.write(packed)
+    end
+
+    packer << 1
+    packer << 'x'
+    packer << true
+    socket.close
+
+    packer.total
+    # => 3
+
+Unpack a String:
+
+    FFI::MsgPack.unpack("\x93\x01\xA1x\xC3")
+    # => [1, "x", true]
+
+Enumerate over each unpacked Object:
+
+    unpacker = FFI::MsgPack::Unpacker.create
+    unpacker << "\x01\xA1x\xC3"
+
+    unpacker.each do |obj|
+      puts obj.inspect
+    end
+
+Enumerates over each unpacked Object from a stream:
+
+    unpacker = FFI::MsgPack::Unpacker.create
+    unpacker.stream = socket
+
+    unpacker.each do |obj|
+      puts obj.inspect
+    end
+
+## Requirements
+
+* [libmsgpack](http://msgpack.sourceforge.net/) >= 0.4.2
+* [ffi](http://github.com/ffi/ffi) >= 0.6.0
+
+## Install
+
+    $ sudo gem install ffi-msgpack
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:development, :doc)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/clean'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'ffi-msgpack'
+  gem.licenses = ['MIT']
+  gem.summary = %Q{FFI bindings for msgpack}
+  gem.email = 'postmodern.mod3@gmail.com'
+  gem.homepage = %Q{http://github.com/postmodern/ffi-msgpack}
+  gem.description = %Q{Ruby FFI bindings for the msgpack library.}
+  gem.authors = ['Postmodern']
+  gem.requirements = ['libmsgpack, 0.4.2 or greater']
+  gem.has_rdoc = 'yard'
+end
+
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs += ['lib', 'spec']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', '.specopts']
+end
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ffi-msgpack.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ffi-msgpack}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-05-21}
+  s.description = %q{Ruby FFI bindings for the msgpack library.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+    ".specopts",
+    ".yardopts",
+    "ChangeLog.md",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "ffi-msgpack.gemspec",
+    "lib/ffi/msgpack.rb",
+    "lib/ffi/msgpack/exceptions/parse_error.rb",
+    "lib/ffi/msgpack/extensions.rb",
+    "lib/ffi/msgpack/extensions/array.rb",
+    "lib/ffi/msgpack/extensions/false_class.rb",
+    "lib/ffi/msgpack/extensions/float.rb",
+    "lib/ffi/msgpack/extensions/hash.rb",
+    "lib/ffi/msgpack/extensions/integer.rb",
+    "lib/ffi/msgpack/extensions/nil_class.rb",
+    "lib/ffi/msgpack/extensions/string.rb",
+    "lib/ffi/msgpack/extensions/true_class.rb",
+    "lib/ffi/msgpack/msg_array.rb",
+    "lib/ffi/msgpack/msg_key_value.rb",
+    "lib/ffi/msgpack/msg_map.rb",
+    "lib/ffi/msgpack/msg_object.rb",
+    "lib/ffi/msgpack/msg_object_union.rb",
+    "lib/ffi/msgpack/msg_raw.rb",
+    "lib/ffi/msgpack/msgpack.rb",
+    "lib/ffi/msgpack/packable.rb",
+    "lib/ffi/msgpack/packer.rb",
+    "lib/ffi/msgpack/types.rb",
+    "lib/ffi/msgpack/unpacker.rb",
+    "lib/ffi/msgpack/zone.rb",
+    "lib/ffi/msgpack/zone_chunk_list.rb",
+    "lib/ffi/msgpack/zone_finalizer.rb",
+    "lib/ffi/msgpack/zone_finalizer_array.rb",
+    "spec/msg_object_spec.rb",
+    "spec/packer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/unpacker_spec.rb"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/ffi-msgpack}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.requirements = ["libmsgpack, 0.4.2 or greater"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{FFI bindings for msgpack}
+  s.test_files = [
+    "spec/msg_object_spec.rb",
+    "spec/packer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/unpacker_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 0.9.25"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+    else
+      s.add_dependency(%q<ffi>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 0.9.25"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 0.9.25"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+  end
+end
+

data/lib/ffi/msgpack.rb

@@ -0,0 +1,3 @@
+require 'ffi/msgpack/msgpack'
+require 'ffi/msgpack/packer'
+require 'ffi/msgpack/unpacker'

data/lib/ffi/msgpack/exceptions/parse_error.rb

@@ -0,0 +1,6 @@
+module FFI
+  module MsgPack
+    class ParseError < StandardError
+    end
+  end
+end

data/lib/ffi/msgpack/extensions.rb

@@ -0,0 +1,8 @@
+require 'ffi/msgpack/extensions/nil_class'
+require 'ffi/msgpack/extensions/true_class'
+require 'ffi/msgpack/extensions/false_class'
+require 'ffi/msgpack/extensions/integer'
+require 'ffi/msgpack/extensions/float'
+require 'ffi/msgpack/extensions/string'
+require 'ffi/msgpack/extensions/array'
+require 'ffi/msgpack/extensions/hash'

data/lib/ffi/msgpack/extensions/array.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class Array
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/false_class.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class FalseClass
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/float.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class Float
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/hash.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class Hash
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/integer.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class Integer
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/nil_class.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class NilClass
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/string.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class String
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/extensions/true_class.rb

@@ -0,0 +1,7 @@
+require 'ffi/msgpack/packable'
+
+class TrueClass
+
+  include FFI::MsgPack::Packable
+
+end

data/lib/ffi/msgpack/msg_array.rb

@@ -0,0 +1,35 @@
+require 'ffi/msgpack/types'
+require 'ffi/msgpack/msg_object'
+
+module FFI
+  module MsgPack
+    class MsgArray < FFI::Struct
+
+      layout :size, :uint32,
+             :ptr, :pointer
+
+      #
+      # The length of the MsgPack Array.
+      #
+      # @return [Integer]
+      #   The length of the Array.
+      #
+      def length
+        self[:size]
+      end
+
+      #
+      # The Array of values.
+      #
+      # @return [Array<Object>]
+      #   The values contained within the Array.
+      #
+      def to_a
+        (0...self.length).map do |index|
+          MsgObject.new(self[:ptr][index * MsgObject.size]).to_ruby
+        end
+      end
+
+    end
+  end
+end