rubyfox-sfsobject 0.0.1-universal-java-1.6 → 0.1.0-universal-java-1.6

data/README.md

@@ -1,4 +1,4 @@
-# Rubyfox::SFSObject
+# Rubyfox::SFSObject [![Build Status](https://secure.travis-ci.org/neopoly/rubyfox-sfsobject.png)](http://travis-ci.org/neopoly/rubyfox-sfsobject)
 
 Converts between SmartFox's SFSObjects and Ruby Hashes.
 
@@ -18,16 +18,30 @@ Or install it yourself as:
 
 ## Usage
 
+### Bulk mode
+
     require 'rubyfox/sfsobject/bulk'
     sfs_object = Rubyfox::SFSObject::Bulk.to_sfs({ :hello => "world" })
     # => SFSObject ready to use in SmartFox
-    hash = Rubyfox::SFSObject::Bulk.to.hash(sfs_object)
+    hash = Rubyfox::SFSObject::Bulk.to_hash(sfs_object)
     # => { :hello => "world" }
 
 
+### Schema mode
+
+    require 'rubyfox/sfsobject/schema'
+    schema = { :hello => String }
+    sfs_object = Rubyfox::SFSObject::Schema.to_sfs(schema, { :hello => "world" })
+    # => SFSObject ready to use in SmartFox
+    hash = Rubyfox::SFSObject::Schema.to_hash(schema, sfs_object)
+    # => { :hello => "world" }
+
+
+### Core extension
+
 You can extend Hash and SFSObject with method shortcuts:
 
-    require 'rubyfox/sfsobject/extend'
+    require 'rubyfox/sfsobject/core_ext'
     sfs_object = { :hello => "world" }.to_sfs
     # => SFSObject
     sfs_object.to_hash
@@ -37,6 +51,10 @@ You can extend Hash and SFSObject with method shortcuts:
 
 *Note* that all hash keys will be converted to symbols.
 
+## TODO
+
+* More docs, please!
+
 ## Contributing
 
 1. Fork it

data/lib/rubyfox/sfsobject/bulk.rb

@@ -12,7 +12,7 @@ module Rubyfox
         FalseClass    =>  :putBool,
         Fixnum        =>  :putInt,
         Float         =>  :putDouble,
-        Hash          =>  proc { |o, k, v| o.putSFSObject(k, Rubyfox::SFSObject::Bulk.to_sfs(v)) },
+        Hash          =>  proc { |o, k, v| o.putSFSObject(k, to_sfs(v)) },
         [String]      =>  :putUtfStringArray,
         [TrueClass]   =>  :putBoolArray,
         [FalseClass]  =>  :putBoolArray,
@@ -24,7 +24,7 @@ module Rubyfox
         [Float]       =>  :putDoubleArray,
         [Hash]        =>  proc do |o, k, v|
           ary = Java::SFSArray.new
-          v.each { |e| ary.addSFSObject(Rubyfox::SFSObject::Bulk.to_sfs(e)) }
+          v.each { |e| ary.addSFSObject(to_sfs(e)) }
           o.putSFSArray(k, ary)
         end
       }
@@ -41,9 +41,9 @@ module Rubyfox
         "INT_ARRAY"         =>  proc { |h, k, v| h[k.to_sym] = v.object.to_a },
         "LONG_ARRAY"        =>  :getLongArray,
         "DOUBLE_ARRAY"      =>  :getDoubleArray,
-        "SFS_OBJECT"        =>  proc { |h, k, v| h[k.to_sym] = Rubyfox::SFSObject::Bulk.to_hash(v.object) },
+        "SFS_OBJECT"        =>  proc { |h, k, v| h[k.to_sym] = to_hash(v.object) },
         "SFS_ARRAY"         =>  proc do |h, k, v|
-          h[k.to_sym] = v.object.iterator.map { |e| Rubyfox::SFSObject::Bulk.to_hash(e.object) }
+          h[k.to_sym] = v.object.iterator.map { |e| to_hash(e.object) }
         end
       }
 

data/lib/rubyfox/sfsobject/core_ext.rb

@@ -0,0 +1,24 @@
+# Extends core object with some conversion methods.
+
+require 'rubyfox/sfsobject/bulk'
+require 'rubyfox/sfsobject/schema'
+
+class Hash
+  def to_sfs(schema=:none)
+    if schema == :none
+      Rubyfox::SFSObject::Bulk.to_sfs(self)
+    else
+      Rubyfox::SFSObject::Schema.to_sfs(schema, self)
+    end
+  end
+end
+
+class Rubyfox::SFSObject::Java::SFSObject
+  def to_hash(schema=:none)
+    if schema == :none
+      Rubyfox::SFSObject::Bulk.to_hash(self)
+    else
+      Rubyfox::SFSObject::Schema.to_hash(schema, self)
+    end
+  end
+end

data/lib/rubyfox/sfsobject/schema.rb

@@ -0,0 +1,110 @@
+module Boolean
+end
+
+class TrueClass
+  include Boolean
+end
+
+class FalseClass
+  include Boolean
+end
+
+require 'rubyfox/sfsobject/java'
+
+module Rubyfox
+  module SFSObject
+    class Schema
+      TO_SFS = {
+        String    => proc { |o, s, k, v| o.put_utf_string(k, v) },
+        Boolean   => proc { |o, s, k, v| o.put_bool(k, v) },
+        Fixnum    => proc { |o, s, k, v| o.put_int(k, v) },
+        Float     => proc { |o, s, k, v| o.put_double(k, v) },
+        Hash      => proc { |o, s, k, v| o.put_sfs_object(k, to_sfs(s, v)) },
+        [String]  => proc { |o, s, k, v| o.put_utf_string_array(k, v) },
+        [Boolean] => proc { |o, s, k, v| o.put_bool_array(k, v) },
+        [Fixnum]  =>  proc do |o, s, k, v|
+          collection = Java::ArrayList.new(v.size)
+          v.each { |e| collection.add(e.to_java(:int)) }
+          o.put_int_array(k, collection)
+        end,
+        [Float]  => proc { |o, s, k, v| o.put_double_array(k, v) },
+        [Hash]    => proc { |o, s, k, v|
+          ary = Java::SFSArray.new
+          schema = s[0]
+          v.each { |e| ary.add_sfs_object(to_sfs(schema, e)) }
+          o.put_sfs_array(k, ary)
+        }
+      }
+
+      TO_HASH = {
+        String    => proc { |o, s, k| o.get_utf_string(k) },
+        Boolean   => proc { |o, s, k| o.get_bool(k) },
+        Fixnum    => proc { |o, s, k| o.get_int(k) },
+        Float     => proc { |o, s, k| o.get_double(k) },
+        Hash      => proc { |o, s, k| to_hash(s, o.get_sfs_object(k)) },
+        [String]  => proc { |o, s, k| o.get_utf_string_array(k).to_a },
+        [Boolean] => proc { |o, s, k| o.get_bool_array(k).to_a },
+        [Fixnum]  => proc { |o, s, k| o.get_int_array(k).to_a },
+        [Float]   => proc { |o, s, k| o.get_double_array(k).to_a },
+        [Hash]    => proc { |o, s, k|
+          sfs_ary = o.get_sfs_array(k)
+          ary = []
+          schema = s[0]
+          sfs_ary.size.times do |i|
+            ary << to_hash(schema, sfs_ary.get_sfs_object(i))
+          end
+          ary
+        }
+      }
+
+      def initialize(schema={})
+        @schema = schema
+      end
+
+      def to_sfs(hash)
+        self.class.to_sfs(@schema, hash)
+      end
+
+      def self.to_sfs(schemas, hash)
+        object = Java::SFSObject.new_instance
+        schemas.each do |key, schema|
+          next unless hash && hash.key?(key)
+          value = hash[key]
+          if method = wrap_method(TO_SFS, schema)
+            method.call(object, schema, key, value)
+          else
+            raise ArgumentError, "wrapper for #{key}=#{value} (#{schema}) not found"
+          end
+        end
+        object
+      end
+
+      def to_hash(object)
+        self.class.to_hash(@schema, object)
+      end
+
+      def self.to_hash(schemas, object)
+        hash = {}
+        schemas.each do |key, schema|
+          next unless object.contains_key(key.to_s)
+          if method = wrap_method(TO_HASH, schema)
+            hash[key] = method.call(object, schema, key)
+          else
+            raise ArgumentError, "unwrapper for #{key}=#{value} (#{schema}) not found"
+          end
+        end
+        hash
+      end
+
+      def self.wrap_method(map, schema)
+        if Hash === schema
+          map[Hash]
+        elsif Array === schema && Hash === schema.first
+          map[[Hash]]
+        else
+          map[schema]
+        end
+      end
+    end
+  end
+end

data/lib/rubyfox/sfsobject/version.rb

@@ -1,5 +1,5 @@
 module Rubyfox
   module SFSObject
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/test/rubyfox/sfsobject/bulk_test.rb

@@ -4,8 +4,6 @@ require 'helper'
 require 'rubyfox/sfsobject/bulk'
 
 class RubyfoxSFSObjectBulkTest < RubyfoxCase
-  let(:bulk) { Rubyfox::SFSObject::Bulk }
-
   test "empty" do
     assert_conversion Hash.new
   end
@@ -20,8 +18,8 @@ class RubyfoxSFSObjectBulkTest < RubyfoxCase
     end
 
     test "string" do
-      assert_conversion :key => "value"
-      assert_conversion :key => "üöäÜÖÄß"
+      assert_conversion :string => "value"
+      assert_conversion :string => "üöäÜÖÄß"
     end
 
     test "boolean" do
@@ -66,7 +64,7 @@ class RubyfoxSFSObjectBulkTest < RubyfoxCase
     end
 
     test "boolean" do
-      assert_conversion :bool => [ true, true, false ]
+      assert_conversion :bool => [ true, false ]
     end
 
     test "fixnum" do
@@ -86,7 +84,7 @@ class RubyfoxSFSObjectBulkTest < RubyfoxCase
   private
 
   def assert_conversion(input, output=input)
-    object = bulk.to_sfs(input)
-    assert_equal output, bulk.to_hash(object)
+    object = Rubyfox::SFSObject::Bulk.to_sfs(input)
+    assert_equal output, Rubyfox::SFSObject::Bulk.to_hash(object)
   end
 end

data/test/rubyfox/sfsobject/core_ext.rb

@@ -0,0 +1,27 @@
+require 'helper'
+require 'rubyfox/sfsobject/core_xt'
+
+class RubyfoxSFSObjectCoreExtTest < RubyfoxCase
+  context "bulk" do
+    test "methods" do
+      hash = { :key => "value"}
+      assert_equal hash, hash.to_sfs.to_hash
+    end
+  end
+
+  context "schema" do
+    test "methods" do
+      schema = { :key => String }
+      hash = { :key => "value" }
+      assert_equal hash, hash.to_sfs(schema).to_hash(schema)
+    end
+
+    test "fail w/o valid schema" do
+      schema = nil
+      hash = { :key => "value" }
+      assert_raises NoMethodError, :message => /each/ do
+        assert_equal hash, hash.to_sfs(schema).to_hash(schema)
+      end
+    end
+  end
+end

data/test/rubyfox/sfsobject/schema_test.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8 
+
+require 'helper'
+require 'rubyfox/sfsobject/schema'
+
+class RubyfoxSFSObjectSchemaTest < RubyfoxCase
+  test "empty" do
+    assert_schema({}, {})
+    assert_schema({}, {:key => "value"}, {})
+  end
+
+  context "plain" do
+    test "nil is unknown" do
+      assert_raises ArgumentError, :message => /wrapper for null.*not found/ do
+        assert_schema({ :null => nil }, { :null => "foo" })
+      end
+    end
+
+    test "string" do
+      assert_schema({ :string => String }, { :string => "value" })
+      assert_schema({ :string => String }, { :string => "üöäÜÖÄß" })
+    end
+
+    test "bool" do
+      assert_schema({ :bool => Boolean }, { :bool => true })
+      assert_schema({ :bool => Boolean }, { :bool => false })
+    end
+
+    test "fixnum" do
+      assert_schema({ :fixnum => Fixnum }, { :fixnum => 1 })
+      assert_schema({ :fixnum => Fixnum }, { :fixnum => (2 ** 31 - 1) })
+      assert_schema({ :fixnum => Fixnum }, { :fixnum => -(2 ** 31) })
+    end
+
+    test "fixnum too big for int" do
+      assert_raises RangeError, :message => /too big for int/ do
+        assert_schema({ :fixnum => Fixnum }, { :fixnum => (2 ** 31) })
+      end
+    end
+
+    test "float" do
+      assert_schema({ :float => Float }, { :float => 1.0 })
+      assert_schema({ :float => Float }, { :float => 1.0 / 3 })
+    end
+
+    test "nested hash" do
+      assert_schema(
+        { :sub => { :key => String } },
+        { :sub => { :key => "value" } }
+      )
+    end
+  end
+
+  context "array" do
+    test "nil is unknown" do
+      assert_raises ArgumentError, :message => /wrapper for null.*not found/ do
+        assert_schema({ :null => [nil] }, { :null => "foo" })
+      end
+    end
+
+    test "string" do
+      assert_schema({ :string => [String] }, { :string => ["foo", "bar"] })
+      assert_schema({ :string => [String] }, { :string => ["foo", "üöäÜÖÄß"] })
+      assert_schema({ :string => [String] }, { :string => ["foo", 23] }) # strange?!
+    end
+
+    test "bool" do
+      assert_schema({ :bool => [Boolean] }, { :bool => [true, false] })
+      assert_schema({ :bool => [Boolean] }, { :bool => [true, 23] }) # strange?
+    end
+
+    test "fixnum" do
+      assert_schema({ :fixnum => [Fixnum] }, { :fixnum => [1, 2] })
+      assert_schema({ :fixnum => [Fixnum] }, { :fixnum => [(2 ** 31 - 1), -(2 ** 31)] })
+    end
+
+    test "float" do
+      assert_schema({ :float => [Float] }, { :float => [1.0, 1.0 / 3] })
+    end
+
+    test "nested hash" do
+      assert_schema(
+        { :sub => [ { :key => String } ] },
+        { :sub => [ { :key => "foo" }, { :key => "bar" }] }
+      )
+    end
+  end
+
+  private
+
+  def assert_schema(schema, input, output=input)
+    object = Rubyfox::SFSObject::Schema.to_sfs(schema, input)
+    hash = Rubyfox::SFSObject::Schema.to_hash(schema, object)
+    assert_equal output, hash
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: rubyfox-sfsobject
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.1
+  version: 0.1.0
 platform: universal-java-1.6
 authors:
 - Peter Suschlik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -63,13 +63,15 @@ files:
 - Rakefile
 - lib/rubyfox/sfsobject.rb
 - lib/rubyfox/sfsobject/bulk.rb
-- lib/rubyfox/sfsobject/extend.rb
+- lib/rubyfox/sfsobject/core_ext.rb
 - lib/rubyfox/sfsobject/java.rb
+- lib/rubyfox/sfsobject/schema.rb
 - lib/rubyfox/sfsobject/version.rb
 - rubyfox-sfsobject.gemspec
 - test/helper.rb
 - test/rubyfox/sfsobject/bulk_test.rb
-- test/rubyfox/sfsobject/extend_test.rb
+- test/rubyfox/sfsobject/core_ext.rb
+- test/rubyfox/sfsobject/schema_test.rb
 homepage: https://github.com/neopoly/rubyfox-sfsobject
 licenses: []
 post_install_message:
@@ -105,4 +107,5 @@ summary: ''
 test_files:
 - test/helper.rb
 - test/rubyfox/sfsobject/bulk_test.rb
-- test/rubyfox/sfsobject/extend_test.rb
+- test/rubyfox/sfsobject/core_ext.rb
+- test/rubyfox/sfsobject/schema_test.rb

data/lib/rubyfox/sfsobject/extend.rb

@@ -1,15 +0,0 @@
-# Extends core object with some conversion methods.
-
-require 'rubyfox/sfsobject/bulk'
-
-class Hash
-  def to_sfs
-    Rubyfox::SFSObject::Bulk.to_sfs(self)
-  end
-end
-
-class Rubyfox::SFSObject::Java::SFSObject
-  def to_hash
-    Rubyfox::SFSObject::Bulk.to_hash(self)
-  end
-end

data/test/rubyfox/sfsobject/extend_test.rb

@@ -1,9 +0,0 @@
-require 'helper'
-require 'rubyfox/sfsobject/extend'
-
-class RubyfoxSFSObjectExtendTest < RubyfoxCase
-  test "bulk methods" do
-    hash = { :key => "string"}
-    assert_equal hash, hash.to_sfs.to_hash
-  end
-end