Nido (ported to Crystal lang)

Original Nido Ruby project from @soveran

Structured keys helper.

Description

If you are familiar with databases like Redis and libraries like Ohm you already know how important it is to craft the keys that will hold the data.

>> redis = Redis.new
>> redis.sadd("event:3:attendees", "Albert")
>> redis.smembers("event:3:attendees")
=> ["Albert"]

It is a design pattern in key-value databases to use the key to simulate structure, and you can read more about this in the case study for a Twitter clone.

Nido helps you generate those keys by providing chainable namespaces:

>> r = Redis.new
>> event = Nido.new("event")
>> r.sadd(event[3][:attendees], "Albert")
>> r.smembers(event[3][:attendees])
=> ["Albert"]

Usage

To create a new namespace:

>> require "nido"

>> ns = Nido.new("foo")
=> "foo"

>> ns["bar"]
=> "foo:bar"

>> ns["bar"]["baz"]["qux"]
=> "foo:bar:baz:qux"

And you can use any object as a key, not only strings:

>> ns[:bar][42]
=> "foo:bar:42"

In a more realistic tone, lets assume you are working with Redis and dealing with events:

>> events = Nido.new("events")
=> "events"

>> id = r.incr(events[:id])
=> 1

>> r.sadd(events[id][:attendees], "Albert")
=> "OK"

>> meetup = events[id]
=> "events:1"

>> r.smembers(meetup[:attendees])
=> ["Albert"]

Installation

Add this to your application's shard.yml:

dependencies:
  nido:
    github: microspino/nido-crystal
    version: ~> 0.1.2

Thanks

to soveran for inventing it and inspiring me to write minimal code in Ruby and now Crystal.

Contributing

1. Fork it ( https://github.com/microspino/nido-crystal/fork )
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 a new Pull Request

Contributors

• [microspino] Microspino - creator, maintainer