cbor 0.5.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95c5af13f98f6a6442e2a2b9c27ed4bdef1c5813
+  data.tar.gz: 220ff8d73a25a32486e70a3ae863516193771661
+SHA512:
+  metadata.gz: e9ff567a84e861e9dea28e28465b14f5ce0bea61ebd5a964c57abb53dea6e7841d26e2396a98a8e97c0250336465b221f8b0f44709254b97d776859e904cb471
+  data.tar.gz: 43bbd8691a9120b91385b1f0089fb3ee92d282b8ec2e63c617be1063e588849e2f84c57ad9425352c2263bf7d7cbe4fee4461b38957078784b2f0995b874cbd7

data/.gitignore

@@ -0,0 +1,22 @@
+*.o
+*.so
+*.gem
+*.class
+.bundle
+Gemfile*
+pkg
+test/debug.log
+*~
+/rdoc
+tmp
+.classpath
+.project
+.settings
+/nbproject/private/
+ext/java/build
+ext/java/msgpack.jar
+spec/bench*
+lib/cbor/cbor.bundle
+TAGS
+.yardoc
+doc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: "bundle exec rake spec"

data/ChangeLog

@@ -0,0 +1,87 @@
+2013-08-17  Carsten Bormann  <cabo@tzi.org>
+
+	* First version of CBOR variant of this code.
+
+2013-09-23 version 0.5.6:
+
+* Fixed "can't modify frozen String" exception in Unpacker with ruby 2.1.0-dev
+* Getting work with Ruby v2.0 on Windows (Thank you @thegreendroid)
+* Fixed EOFError handling in Unpacker
+
+
+2013-05-12 version 0.5.5:
+
+* Fixed SEGV problem in to_msgpack
+* Fixed a possible race condition in MessagePack.load when it loads data from IO
+* mingw32 package includes binary for ruby-2.0.0
+
+
+2013-03-15 version 0.5.4:
+
+* Added missing MessagePack::Unpacker#reset method
+
+
+2013-02-14 version 0.5.3:
+
+* Fixed segfault problem on Buffer#clear (reuse rmem internal fragment optimization)
+* Fixed segfault problem on Buffer (rmem free code)
+
+
+2013-02-07 version 0.5.2:
+
+* Fixed invalid pack/unpack on 32bit architecture such as Win32
+* Disable rmem on Rubinius because rmem is not thread safe
+
+
+2012-12-23 version 0.5.1:
+
+* Fixed compile error with Rubinius 2.0.0-dev
+* Optimized msgpack_packer_write_hash for Rubinius
+
+
+2012-12-20 version 0.5.0:
+
+* Rewrote all code and improved performance significantly
+* Added MessagePack::Buffer class
+* Added MessagePack::Packer class
+* Added Packer#buffer and Unpacker#buffer accessors which return MessagePack::Buffer
+* Added Packer#write_{array,map}_header and Unpacker#read_{array,map}_header methods
+* Added Packer#write_nil and Unpacker#skip_nil methods
+* Added Packer#write -> #pack alias and Unpacker#read method
+* Added exception classes - UnpackError, MalformedFormatError, StackError and TypeError
+* Added MessagePack.dup -> .pack and MessagePack.load -> .unpack aliases
+* Added Packer#empty?, #size and #clear methods
+* Added Packer#write_to(io) method to flush serialized data to IO efficiently
+* Added Unpacker#skip method to skip an object efficiently
+* Removed obsoleted Unpacker#fill, #execute, #execute_limit, #finished? and #data methods
+* Removed obsoleted Unapcker#stream and #stream= methods. Use unpacker.buffer.io instead
+
+
+2012-05-05 version 0.4.7:
+
+* Fixed serialization of double values on ARM OABI architectures
+* Fixed byteorder problem on big-endian platforms
+* Don't use MRI internals in the Ruby extension for Rubinius
+* Detect whether st.h is present and don't use RUBY_VM as the condition for
+  Rubinius
+
+2011-08-08 version 0.4.6:
+
+* Fixed compile error problem on Mac OS X Lion
+
+2011-05-09 version 0.4.5:
+
+* Improves compatibility with JRuby
+
+2010-11-28 version 0.4.4:
+
+* Adds Unpacker#feed_each method
+* Improves compatibility with Rubinius
+* Improves compatibility with ruby-1.8.5
+* Encodings of String instances to UTF-8 on Ruby 1.9
+
+2010-06-29 version 0.4.3:
+
+* Adds MessagePack::VERSION constant
+* Fixes SEGV problem caused by GC bug at MessagePack_Unpacker_mark
+

data/README.rdoc

@@ -0,0 +1,180 @@
+= CBOR for Ruby
+
+This is an initial Ruby implementation of the CBOR encoding, based on
+the (polished) high-performance msgpack-ruby code.
+
+Documentation will follow, but generally, if you replace MessagePack
+and msgpack with CBOR and cbor in the below, you will be on the right
+track.
+
+CBOR is an object representation format defined by the IETF[http://ietf.org].
+The specification[http://tools.ietf.org/html/draft-bormann-cbor]
+has recently been approved as an IETF Standards-Track specification
+and will be an RFC in a couple of months, after the RFC editor has done their work.
+
+This is all based on wonderful work by frsyuki, and I have no idea how
+to acknowledge him appropriately.  This gem is not intended to fork or
+supersede MessagePack[http://msgpack.org], which has a vibrant
+ecosystem.  It is just making use of the high-quality code that is
+available in this community.  If MessagePack works for you, go for it.
+If you need CBOR, you need this.
+
+Todos:
+
+* This code has not yet been fully optimized, so it is still a few
+  percent slower than msgpack-ruby.
+
+* Properly document things, in particular the classes CBOR::Simple and
+  CBOR::Tagged.  If you check out the source, you can +rake doc+ to
+  get some documentation in the directory +doc+ (see +index.html+ there).
+
+* So far, this has been tested on MRI (1.9.3 and 2.0.0).  To do:
+  * Check this code out with Rubinius.
+  * Publish the pure-ruby version and make it work the same way on JRuby.
+
+* Find and implement good ways to offer CBOR's indefinite length
+  ("streaming") capability at the Ruby API level.
+
+* Rename some of the internals from msgpack to cbor.  Right now, much
+  of the code still uses the name msgpack in its identifiers, to
+  facilitate merging upstream fixes.  (The msgpack and cbor gems
+  coexist nicely in one MRI instance due to the magic in +renamer.h+.)
+
+Same Apache 2.0 License applies to the changes as to the original.
+For the changes:
+
+Author::    Carsten Bormann <cabo@tzi.org>
+Copyright:: Copyright (c) 2013 Carsten Bormann
+License::   Apache License, Version 2.0
+
+{<img src="https://travis-ci.org/cabo/cbor-ruby.png?branch=master" />}[https://travis-ci.org/cabo/cbor-ruby]
+
+For the original, see below.
+
+= MessagePack
+
+MessagePack[http://msgpack.org] is an efficient binary serialization format.
+It lets you exchange data among multiple languages like JSON but it's faster and smaller.
+For example, small integers (like flags or error code) are encoded into a single byte,
+and typical short strings only require an extra byte in addition to the strings themselves.
+
+If you ever wished to use JSON for convenience (storing an image with metadata) but could
+not for technical reasons (binary data, size, speed...), MessagePack is a perfect replacement.
+
+    require 'msgpack'
+    msg = [1,2,3].to_msgpack  #=> "\x93\x01\x02\x03"
+    MessagePack.unpack(msg)   #=> [1,2,3]
+
+Use RubyGems to install:
+
+    gem install msgpack
+
+or build msgpack-ruby and install:
+
+    bundle
+    rake
+    gem install --local pkg/msgpack
+
+
+= Use cases
+
+* Store objects efficiently serialized by msgpack on memcached or Redis
+  * In fact Redis supports msgpack in EVAL-scripts[http://redis.io/commands/eval]
+* Upload data in efficient format from mobile devices such as smartphones
+  * MessagePack works on iPhone/iPad and Android. See also Objective-C[https://github.com/msgpack/msgpack-objectivec] and Java[https://github.com/msgpack/msgpack-java] implementations
+* Design a portable protocol to communicate with embedded devices
+  * Check also Fluentd[http://fluentd.org/] which is a log collector which uses msgpack for the log format (they say it uses JSON but actually it's msgpack, which is compatible with JSON)
+* Exchange objects between software components written in different languages
+  * You'll need a flexible but efficient format so that components exchange objects while keeping compatibility
+
+
+= Portability
+
+MessagePack for Ruby should run on x86, ARM, PowerPC, SPARC and other CPU architectures.
+
+And it works with MRI (CRuby) and Rubinius.
+Patches to improve portability is highly welcomed.
+
+
+= Serializing objects
+
+Use *MessagePack.pack* or *to_msgpack*:
+
+    require 'msgpack'
+    msg = MessagePack.pack(obj)  # or
+    msg = obj.to_msgpack
+
+== Streaming serialization
+
+Packer provides advanced API to serialize objects in streaming style:
+
+    # serialize a 2-element array [e1, e2]
+    pk = MessagePack::Packer.new(io)
+    pk.write_array_header(2).write(e1).write(e2).flush
+
+See {API reference}[http://ruby.msgpack.org/MessagePack/Packer.html] for details.
+
+= Deserializing objects
+
+Use *MessagePack.unpack*:
+
+    require 'msgpack'
+    obj = MessagePack.unpack(msg)
+
+== Streaming deserialization
+
+Unpacker provides advanced API to deserialize objects in streaming style:
+
+    # deserialize objects from an IO
+    u = MessagePack::Unpacker.new(io)
+    u.each do |obj|
+      # ...
+    end
+
+or event-driven style which works well with EventMachine:
+
+    # event-driven deserialization
+    def on_read(data)
+      @u ||= MessagePack::Unpacker.new
+      @u.feed_each(data) {|obj|
+         # ...
+      }
+    end
+
+See {API reference}[http://ruby.msgpack.org/MessagePack/Unpacker.html] for details.
+
+
+= Buffer API
+
+MessagePack for Ruby provides a buffer API so that you can read or write data by hand, not via Packer or Unpacker API.
+
+This {MessagePack::Buffer}[http://ruby.msgpack.org/MessagePack/Buffer.html] is backed with a fixed-length shared memory pool which is very fast for small data (<= 4KB),
+and has zero-copy capability which significantly affects performance to handle large binary data.
+
+= How to build and run tests
+
+Before building msgpack, you need to install bundler and dependencies.
+
+    gem install bundler
+    bundle install
+
+Then, you can run the tasks as follows:
+
+* Build
+
+    bundle exec rake build
+
+* Run tests
+
+    bundle exec rake spec
+
+* Generating docs
+
+    bundle exec rake doc
+
+= Copyright
+
+Author::    Sadayuki Furuhashi <frsyuki@gmail.com>
+Copyright:: Copyright (c) 2008-2013 Sadayuki Furuhashi
+License::   Apache License, Version 2.0
+

data/Rakefile

@@ -0,0 +1,94 @@
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'fileutils'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-f documentation"]
+  t.rspec_opts << "-Ilib"
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :spec => :compile
+
+desc 'Run RSpec code examples and measure coverage'
+task :coverage do |t|
+  ENV['SIMPLE_COV'] = '1'
+  Rake::Task["spec"].invoke
+end
+
+desc 'Generate YARD document'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files   = ['lib/cbor/version.rb','doclib/**/*.rb']
+  t.options = []
+  t.options << '--debug' << '--verbose' if $trace
+end
+
+spec = eval File.read("cbor.gemspec")
+
+if RUBY_PLATFORM =~ /java/
+  require 'rake/javaextensiontask'
+
+  Rake::JavaExtensionTask.new('cbor', spec) do |ext|
+    ext.ext_dir = 'ext/java'
+    #jruby_home = RbConfig::CONFIG['prefix']
+    #jars = ["#{jruby_home}/lib/jruby.jar"] + FileList['lib/*.jar']
+    #ext.classpath = jars.map { |x| File.expand_path x }.join ':'
+  end
+
+else
+  require 'rake/extensiontask'
+
+  Rake::ExtensionTask.new('cbor', spec) do |ext|
+    ext.cross_compile = true
+    ext.lib_dir = File.join(*['lib', 'cbor', ENV['FAT_DIR']].compact)
+    #ext.cross_platform = 'i386-mswin32'
+  end
+end
+
+task :default => :build
+
+
+###
+## Cross compile memo
+##
+## Ubuntu Ubuntu 10.04.1 LTS
+##
+#
+### install mingw32 cross compiler with w64 support
+# sudo apt-get install gcc-mingw32
+# sudo apt-get install mingw-w64
+#
+### install rbenv
+# git clone git://github.com/sstephenson/rbenv.git ~/.rbenv
+# echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
+# echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
+# exec $SHELL -l
+#
+### install cross-compiled ruby 2.0.0
+# rbenv install 2.0.0-p0
+# gem install rake-compiler
+# rake-compiler cross-ruby VERSION=2.0.0-p0
+#
+### install cross-compiled ruby 1.9.3
+# rbenv install 1.9.3-p327
+# gem install rake-compiler
+# rake-compiler cross-ruby VERSION=1.9.3-p327
+#
+### install cross-compiled ruby 1.8.7
+# rbenv install 1.8.7-p371
+# gem install rake-compiler
+# rake-compiler cross-ruby VERSION=1.8.7-p371
+#
+### build gem
+# rbenv shell 1.8.7-p371
+# gem install bundler && bundle
+# rake cross native gem RUBY_CC_VERSION=1.8.7:1.9.3:2.0.0
+#
+

data/cbor.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'cbor/version'
+
+Gem::Specification.new do |s|
+  s.name = "cbor"
+  s.version = CBOR::VERSION
+  s.summary = "CBOR, Concise Binary Object Representation."
+  s.description = %q{CBOR is a library for the CBOR binary object representation format, based on Sadayuki Furuhashi's MessagePack library.}
+  s.author = "Carsten Bormann, standing on the tall shoulders of Sadayuki Furuhashi"
+  s.email = "cabo@tzi.org"
+  s.license = "Apache 2.0"
+#  s.homepage = "http://msgpack.org/"
+#  s.rubyforge_project = "msgpack"
+  s.has_rdoc = false
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.extensions = ["ext/cbor/extconf.rb"]
+
+  s.add_development_dependency 'bundler', ['~> 1.0']
+  s.add_development_dependency 'rake', ['~> 0.9.2']
+  s.add_development_dependency 'rake-compiler', ['~> 0.8.3']
+  s.add_development_dependency 'rspec', ['~> 2.11']
+  s.add_development_dependency 'json', ['~> 1.7']
+  s.add_development_dependency 'yard', ['~> 0.8.2']
+end

data/doclib/cbor.rb

@@ -0,0 +1,80 @@
+module CBOR
+  #
+  # Serializes an object into an IO or String.
+  #
+  # @overload encode(obj)
+  #   @return [String] serialized data
+  #
+  # @overload encode(obj, io)
+  #   @return [IO]
+  #
+  def self.encode(arg)
+  end
+
+  #
+  # Serializes an object into an IO or String. Alias of encode.
+  #
+  # @overload dump(obj)
+  #   @return [String] serialized data
+  #
+  # @overload dump(obj, io)
+  #   @return [IO]
+  #
+  def self.dump(arg)
+  end
+
+  #
+  # Serializes an object into an IO or String. Alias of encode.
+  #
+  # @overload dump(obj)
+  #   @return [String] serialized data
+  #
+  # @overload dump(obj, io)
+  #   @return [IO]
+  #
+  def self.pack(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String.
+  #
+  # @overload decode(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload decode(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.decode(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String. Alias of decode.
+  #
+  # @overload load(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload load(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.load(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String. Alias of decode.
+  #
+  # @overload unpack(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload unpack(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.unpack(arg)
+  end
+end
+