Giter Club home page Giter Club logo

vinaigrette's Introduction

vinaigrette

vinaigrette is a gem providing a custom ActiveModel object that can be used as a serialized attribute of an ActiveRecord object.

Features

  • Serializable ActiveModel objects.
  • Custom accessors with casting support default values.
  • Support for Rails validations.
  • Support for Rails belongs_to associations.
  • Casting of ruby booleans from strings.

Installation

Add this line to your application's Gemfile:

gem 'vinaigrette'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vinaigrette

Usage

Create a custom Vinaigrette::Base subclass:

class AnethSauce < Vinaigrette::Base
end

Add your attributes using vinaigrette_accessor:

# Simple string attribute
vinaigrette_accessor :name, String

# With a default value
vinaigrette_accessor :description, String, "Nothing here!"

# A Boolean
vinaigrette_accessor :spicy?, "Boolean", false

# With support for callables
vinaigrette_accessor :secret, String, lambda { something_secret }

# You can also create belongs_to associations
vinaigrette_accessor :sauce_id, Integer
belongs_to :sauce

Use vinaigrette_serialize method to include it in your ActiveRecord object:

class SalmonDish < ActiveRecord::Base
    include Vinaigrette::Serialize

    ...

    vinaigrette_serialize :sauce, AnethSauce
end

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

vinaigrette's People

Watchers

Yvan BARTHÉLEMY avatar James Cloos 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.