Project

rubyfox-sfsobject

0.0
No release in over 3 years
Low commit activity in last 3 years
rubyfox-sfsobjectneopoly/rubyfox-sfsobjectHomepageDocumentationSource CodeBug TrackerWiki
Map SFSObject into Ruby Hash
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
41,100
Stars
5
Forks
0
Watchers
21
 Releases
Current version
0.7.0
Total releases
14
First release
2012-11-02
Latest release
2018-05-29
 Issues
Open Issues
0
Closed Issues
2
Total Issues
2
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
5
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Average date of last 50 commits
2016-04-21
Reverse Dependencies
1

 Dependencies

Development

minitest
~> 5.8.0
rake
>= 0
rdoc
>= 0
 Project Readme

Rubyfox::SFSObject

Build Status Gem Version Inline docs

Gem | Source | Documentation

Converts between SmartFox's SFSObjects and Ruby Hashes.

Installation

Add this line to your application's Gemfile:

gem 'rubyfox-sfsobject', '~> 0.8.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubyfox-sfsobject -v 0.8.0

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)
# => { :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/core_ext'
sfs_object = { :hello => "world" }.to_sfs
# => SFSObject
sfs_object.to_hash
# { :hello => "world" }

JSON

require 'rubyfox/sfsobject/core_ext'
json = sfs_object.to_json
Rubyfox::SFSObject.from_json(json)

Hash-like access

require 'rubyfox/sfsobject/core_ext'
sfs_object = Rubyfox::SFSObject[:meaning_of_life => 42]
sfs_object[:meaning_of_life] # => 42
sfs_object[:string] = "value"
sfs_object[:string] # => "value"

Caveats

  • All hash keys will be converted to symbols
  • In "bulk mode"
    • all Ruby's Float values will be converted Java's double (via putDouble or putDoubleArray)
    • all Java's double values will be converted to Ruby's float (via getFloat or getFloatArray)

TODO

  • More docs, please!

Release

  1. Bump VERSION in lib/rubyfox/sfsobject/version.rb
  2. Tweak versions in README.md
  3. Commit version bump via git commit -am "Release X.Y.Z"
  4. Run rake release

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request