radagaisus/orpheus

A Small Object Model for Redis in CoffeeScript

orpheus's Issues

Allow regular Redis commands on the models

User.command('zrem', 'key', arguments...)
User.zrem('key', arguments...)

Dynamic keys: create a set behind-the-scenes with all the dynamic keys names

Great for iterating over dynamic keys.

Assuming:

@zset 'books', key: (author) -> "books:#{author}"

Allow developers to query a books_keys for all the dynamic keys that were generated. Or, .dynamic_keys_for('books'), or .keys_for('books'), or .keys('books'), or other options.

The end-developers will manually need to remove items from these lists, as there's no easy (or necessary) way to automatically do this for them.

Update node-redis package

Currently using 0.12.1 of redis package, which is a very old and obsolete version.
Furthermore: it poses a challenge as it cause bugs and instability with node version 4.0 and greater.

As the node-redis project came back to life, and is highly maintained, we can keep using it as the base driver and drop issue #21 to move to ioredis.

add the 'del' command globally

need support for the 'del' command across all types

Migrate the docs from Coffeescript to Javascript

Migrate the docs from CoffeeScript to Javascript

Ability to set commands on the model's main hash

• Ability to set commands on the model's main hash e.g. expire, ttl, etc.
• The main hash stores the @str and @num attributes of the model.
• We'll need a way to reference it. Options:
  • User(id).some_string_attribute.expire() - will expire the entire hash
  • User(id).main.expire() - use mainor another name to access the hash
  • User(id).expire() - add it directly to the model, though expire() here will only expire the hash and not all the model keys. It's possible for us to expire most of the model keys, but not dynamic keys.
  • User(id).command() - a slightly nicer @_commands.push []

Move base driver to ioredis

https://github.com/luin/ioredis

Allow separate callbacks for specific commands

Since Redis .multi() allows it, so should we.

User('id').name.set('new-name', update_index).exec (err, res) ->

Use node.inflection as the inflector

https://github.com/dreamerslab/node.inflection

Update with new Redis commands

Add type definition

Support in Typescript could be useful, therefore Orpheus must have type definition.

Accept and discard empty arrays in lpush

An lpush (or any other list insertion) should simply be discarded on empty arrays as arguments. This saves annoying checks like activities.lpush(activities) if activities.length throughout the code.

Better dynamic keys syntax

Give an overhaul improvement to the dynamic key syntax to make it easier to understand and more intuitive.
e.g: when changing a dynamic key value, it should be possible to send the key in a string rather than be forced to send it as an array,

Add support in async `.when` callback

.when(callback) used for conditional operations, it could be beneficial to have support in async operations

Test against multiple versions of Redis

Per-query default value

User(user_id).get('name').default('anonymous').exec()