Converts between SmartFox's SFSObject and Ruby Hashes
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/rubyfox
test
.gitignore
.ruby-env
.ruby-version
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
rubyfox-sfsobject.gemspec

README.md

Rubyfox::SFSObject

Travis Gem Version Code Climate Test Coverage 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'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubyfox-sfsobject

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

Note that all hash keys will be converted to symbols.

TODO

  • More docs, please!

Release

  1. Bump VERSION in lib/rubyfox/sfsobject/version.rb
  2. Commit version bump via git commit -am "Release X.Y.Z"
  3. 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