msgpack_rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c6eaa9d8b98123a292747cbc66404b247220f28
-  data.tar.gz: ec4579fd1e49c004dab3b5e58c3958b2cecbb5ae
+  metadata.gz: 9e573e9ead86a6c6edc4e4ef6dc435d021695165
+  data.tar.gz: b718ccf23b3a33571a7e7212d1bb7ee7e5a07342
 SHA512:
-  metadata.gz: 83276939225377e02cb0d7d0829fcddadca35138c830f0f6c3244da214d550d3a20a210790110c062f54c8d1900fd91e8ce0064f0b55efde29bb18c83c4a3768
-  data.tar.gz: 715965446491d1b3ec94b1ec4d7d96cb141b384d003a67dde4b1533b3a247fca07d6c50a9d1daff7c4f1ca27786f7d670abf81fa1ac814ce9d973aa25bd76635
+  metadata.gz: aac10592d912856d86ab31d9e7a9367054b27ff4533d0af16800e34eb747d76d21d7430bb03922850b8e302ddf519ba4d3b061210b6a691bd960092ed3598caf
+  data.tar.gz: 286ba642e3fbf050682e18fab75a416b1522b8bb90c2c02f47e095c47838f108c9a05f09b61b294e1c9212ebb9d69478f6018dbf85ec1dc7a66d506f29ecb0e4

data/README.md

@@ -1,6 +1,7 @@
-# MsgpackRails
+# msgpack_rails
 
-TODO: Write a gem description
+The Rails way to serialize/deserialize with [Message Pack](http://msgpack.org).
+It implements an [ActiveSupport](http://rubygems.org/gems/activesupport) adapter and an [ActiveModel](http://rubygems.org/gems/activemodel) adapter for Message Pack.
 
 ## Installation
 
@@ -18,7 +19,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`msgpack_rails` converts data type using `as_json` before feeding it into [msgpack](http://rubygems.org/gems/msgpack).
+Here are a few examples:
+
+    $ ActiveSupport::MessagePack.encode(:a => :b)
+    => "\x81\xA1a\xA1b"
+
+    $ ActiveSupport::MessagePack.encode(Time.now)
+    => "\xB92013-09-11T10:40:39-07:00"
+
+    $ Time.now.as_msgpack
+    => "2013-09-11T10:48:13-07:00"
+
+    $ Time.now.to_msgpack
+    => "\xB92013-09-11T10:40:39-07:00"
+
+    $ ActiveSupport::MessagePack.decode Time.now.to_msgpack
+    => "2013-09-11T11:23:07-07:00"
+
+    # After setting ActiveSupport.parse_msgpack_times to true
+    $ ActiveSupport::MessagePack.decode Time.now.to_msgpack
+    => Wed, 11 Sep 2013 11:25:18 -0700
+
+You can also use it as part of `ActiveModel`:
+
+```ruby
+class Contact
+  include ActiveModel::Serializers::MessagePack
+
+  ...
+end
+
+@contact = Contact.new
+@contact.name = 'Konata Izumi'
+@contact.age = 16
+@contact.created_at = Time.utc(2006, 8, 1)
+@contact.awesome = true
+@contact.preferences = { 'shows' => 'anime' }
+
+@contact.to_msgpack                # => msgpack output
+@contact.to_msgpack(:root => true) # => include root in msgpack output
+```
+
 
 ## Contributing
 

data/lib/msgpack_rails/activemodel/serializers/message_pack.rb

@@ -0,0 +1,39 @@
+require "msgpack_rails/activesupport/message_pack"
+
+module ActiveModel
+  module Serializers
+    module MessagePack
+      extend ActiveSupport::Concern
+      include ActiveModel::Serialization
+
+      included do
+        extend ActiveModel::Naming
+
+        class_attribute :include_root_in_msgpack
+        self.include_root_in_msgpack = false
+      end
+
+      def as_msgpack(options = {})
+        root = if options && options.key?(:root)
+                 options[:root]
+               else
+                 include_root_in_msgpack
+               end
+
+        if root
+          root = self.class.model_name.element if root == true
+          { root => serializable_hash(options) }
+        else
+          serializable_hash(options)
+        end
+      end
+
+      def from_msgpack(msgpack, include_root=include_root_in_msgpack)
+        hash = ActiveSupport::MessagePack.decode(msgpack)
+        hash = hash.values.first if include_root
+        self.attributes = hash
+        self
+      end
+    end
+  end
+end

data/lib/msgpack_rails/activesupport/core_ext/object/to_msgpack.rb

@@ -10,8 +10,9 @@ end
 # otherwise they will always use to_msgpack gem implementation.
 [Object, NilClass, TrueClass, FalseClass, Fixnum, Bignum, Float, String, Array, Hash, Symbol].each do |klass|
   klass.class_eval do
-    # Dumps object in msgpack. See http://msgpack.org for more info.
-    def to_msgpack(options = {})
+    alias_method :msgpack_to_msgpack, :to_msgpack if respond_to?(:to_msgpack)
+    # Dumps object in msgpack. See http://msgpack.org for more infoa
+    def to_msgpack(options = nil)
       ActiveSupport::MessagePack.encode(self, options)
     end
   end

data/lib/msgpack_rails/activesupport/message_pack/decoding.rb

@@ -0,0 +1,14 @@
+module ActiveSupport
+  mattr_accessor :parse_msgpack_times
+
+  module MessagePack
+    def self.decode(data)
+      data = ::MessagePack.unpack(data)
+      if ActiveSupport.parse_msgpack_times
+        ActiveSupport::JSON.send(:convert_dates_from, data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/msgpack_rails/activesupport/message_pack/encoding.rb

@@ -3,15 +3,19 @@ require "msgpack_rails/activesupport/core_ext/object/to_msgpack"
 
 module ActiveSupport
   module MessagePack
-    def self.encode(value, options = {})
-      out = options.fetch(:out, nil)
-      ::MessagePack.pack(value.as_msgpack(options), out)
+    def self.encode(value, options = nil)
+      as_msgpack_opts, out = if options.is_a?(Hash)
+                               [options, nil]
+                             else
+                               [nil, options]
+                             end
+      value.as_msgpack(as_msgpack_opts).msgpack_to_msgpack(out)
     end
   end
 end
 
 class Object
-  def as_msgpack(options = {})
+  def as_msgpack(options = nil)
     as_json(options)
   end
 end

data/lib/msgpack_rails/activesupport/message_pack.rb

@@ -1 +1,2 @@
 require "msgpack_rails/activesupport/message_pack/encoding"
+require "msgpack_rails/activesupport/message_pack/decoding"

data/lib/msgpack_rails/version.rb

@@ -1,3 +1,3 @@
 module MsgpackRails
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/msgpack_rails.rb

@@ -1,9 +1,19 @@
 require "active_support"
+require "active_model"
 require "msgpack_rails/version"
 require "msgpack_rails/activesupport/message_pack"
+require "msgpack_rails/activemodel/serializers/message_pack"
 
 module ActiveSupport
   eager_autoload do
     autoload :MessagePack
   end
 end
+
+module ActiveModel
+  module Serializers
+    eager_autoload do
+      autoload :MessagePack
+    end
+  end
+end

data/msgpack_rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jingwen Owen Ou"]
   spec.email         = ["jingweno@gmail.com"]
   spec.description   = %q{Message Pack for Rails.}
-  spec.summary       = %q{Run Message Pack with Rails.}
-  spec.homepage      = ""
+  spec.summary       = %q{The Rails way to serialize/deserialize with Message Pack.}
+  spec.homepage      = "https://github.com/jingweno/msgpack_rails"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,5 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "activesupport", ">= 3.0"
+  spec.add_runtime_dependency "activemodel", ">= 3.0"
   spec.add_runtime_dependency "msgpack"
 end

data/test/msgpack_rails/decoding_test.rb

@@ -0,0 +1,22 @@
+require_relative "../test_helper"
+
+class TestMessagePackEncoding < Test::Unit::TestCase
+  def test_decoding
+    [Time.now, [Date.new], {:foo => DateTime.new}].each do |data|
+      assert_equal data.as_json, ActiveSupport::MessagePack.decode(ActiveSupport::MessagePack.encode(data))
+    end
+
+    ActiveSupport.parse_msgpack_times = true
+
+    date = DateTime.parse(DateTime.now.as_json)
+
+    test_data = date
+    assert_equal test_data, ActiveSupport::MessagePack.decode(ActiveSupport::MessagePack.encode(test_data))
+
+    test_data = [date]
+    assert_equal test_data, ActiveSupport::MessagePack.decode(ActiveSupport::MessagePack.encode(test_data))
+
+    test_data = { "foo" => date }
+    assert_equal test_data, ActiveSupport::MessagePack.decode(ActiveSupport::MessagePack.encode(test_data))
+  end
+end

data/test/msgpack_rails/models/contact.rb

@@ -0,0 +1,26 @@
+class Contact
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+
+  attr_accessor :id, :name, :age, :created_at, :awesome, :preferences
+
+  def social
+    %w(twitter github)
+  end
+
+  def network
+    { git: :github }
+  end
+
+  def initialize(options = {})
+    options.each { |name, value| send("#{name}=", value) }
+  end
+
+  def pseudonyms
+    nil
+  end
+
+  def persisted?
+    id
+  end
+end

data/test/msgpack_rails/serializer_test.rb

@@ -0,0 +1,70 @@
+require_relative "../test_helper"
+require_relative "models/contact"
+
+class Contact
+  include ActiveModel::Serializers::MessagePack
+  include ActiveModel::Validations
+
+  def attributes=(hash)
+    hash.each do |k, v|
+      instance_variable_set("@#{k}", v)
+    end
+  end
+
+  remove_method :attributes if method_defined?(:attributes)
+
+  def attributes
+    instance_values
+  end
+end
+
+class TestMessagePackSerializer < Test::Unit::TestCase
+  def setup
+    ActiveSupport.parse_msgpack_times = true
+
+    @contact = Contact.new
+    @contact.name = 'Konata Izumi'
+    @contact.age = 16
+    @contact.created_at = Time.utc(2006, 8, 1)
+    @contact.awesome = true
+    @contact.preferences = { 'shows' => 'anime' }
+  end
+
+  def teardown
+    # set to the default value
+    ActiveSupport.parse_msgpack_times = false
+    Contact.include_root_in_msgpack = false
+  end
+
+  def test_not_include_root_in_msgpack
+    contact = ActiveSupport::MessagePack.decode(@contact.to_msgpack)
+    assert_equal @contact.attributes.size, contact.size
+
+    @contact.attributes.each do |k, v|
+      assert_equal v, contact[k]
+    end
+  end
+
+  def test_include_root_in_msgpack
+    result = ActiveSupport::MessagePack.decode(@contact.to_msgpack(:root => true))
+    assert_equal 1, result.size
+
+    contact = result["contact"]
+    @contact.attributes.each do |k, v|
+      assert_equal v, contact[k]
+    end
+  end
+
+  def test_from_msgpack
+    ActiveSupport.parse_msgpack_times = false
+
+    msgpack = @contact.to_msgpack(:root => true)
+    result = Contact.new.from_msgpack(msgpack, true)
+
+    assert_equal result.name, @contact.name
+    assert_equal result.age, @contact.age
+    assert_equal Time.parse(result.created_at), @contact.created_at
+    assert_equal result.awesome, @contact.awesome
+    assert_equal result.preferences, @contact.preferences
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msgpack_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jingwen Owen Ou
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -51,15 +65,20 @@ files:
 - README.md
 - Rakefile
 - lib/msgpack_rails.rb
+- lib/msgpack_rails/activemodel/serializers/message_pack.rb
 - lib/msgpack_rails/activesupport/core_ext/object/to_msgpack.rb
 - lib/msgpack_rails/activesupport/message_pack.rb
+- lib/msgpack_rails/activesupport/message_pack/decoding.rb
 - lib/msgpack_rails/activesupport/message_pack/encoding.rb
 - lib/msgpack_rails/version.rb
 - msgpack_rails.gemspec
-- test/msgpack/core_ext_test.rb
-- test/msgpack/encoding_test.rb
+- test/msgpack_rails/core_ext_test.rb
+- test/msgpack_rails/decoding_test.rb
+- test/msgpack_rails/encoding_test.rb
+- test/msgpack_rails/models/contact.rb
+- test/msgpack_rails/serializer_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/jingweno/msgpack_rails
 licenses:
 - MIT
 metadata: {}
@@ -82,8 +101,11 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Run Message Pack with Rails.
+summary: The Rails way to serialize/deserialize with Message Pack.
 test_files:
-- test/msgpack/core_ext_test.rb
-- test/msgpack/encoding_test.rb
+- test/msgpack_rails/core_ext_test.rb
+- test/msgpack_rails/decoding_test.rb
+- test/msgpack_rails/encoding_test.rb
+- test/msgpack_rails/models/contact.rb
+- test/msgpack_rails/serializer_test.rb
 - test/test_helper.rb