Giter VIP home page Giter VIP logo

dude's Introduction

Dude

Dude is a dead simple Redis cache.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      dude:
        github: GrottoPress/dude
  2. Run shards update

  3. Require and configure Dude:

    # ->>> src/app/config.cr
    
    # ...
    
    require "dude"
    
    Dude.configure do |settings|
      settings.redis_url = "redis://localhost:6379/0?initial_pool_size=5&max_idle_pool_size=10"
      settings.redis_key_prefix = "dude"
    end
    
    # ...

Usage

  • Fetch raw value from cache

    # Sets and returns block if key not found in cache
    Dude.get("key", 1.minute) { "value" } # => `value`
  • Fetch JSON-serializable value from cache

    struct User
      include JSON::Serializable
    
      getter id : Int32
    
      def initialize(@id)
      end
    end
    
    # Sets and returns block if key not found in cache
    Dude.get(User, "key", 1.minute) { User.new(2) } # => `User(@id=2)`

Development

Create a .env.sh file:

#!/bin/bash

export REDIS_URL='redis://localhost:6379/0'

Update the file with your own details. Then run tests with source .env.sh && crystal spec.

Contributing

  1. Fork it
  2. Switch to the master branch: git checkout master
  3. Create your feature branch: git checkout -b my-new-feature
  4. Make your changes, updating changelog and documentation as appropriate.
  5. Commit your changes: git commit
  6. Push to the branch: git push origin my-new-feature
  7. Submit a new Pull Request against the GrottoPress:master branch.

dude's People

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.