Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.86 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.86 KB
Raw

Wardrobe

Build Status Code Climate Test Coverage Gem Version

Wardrobe is a gem that simplifies creating Ruby objects with attributes. Wardrobe bundles a multitude of plugins. See list below.

Requirements

Wardrobe requires Ruby 2.4.0 or later. Read more about why here. JRuby should be supported once 9.2.0.0 is released

Documentation

Documentation for Wardrobe

Installation

gem install wardrobe

Getting started

require 'wardrobe'

class User
  include Wardrobe
  attribute :name, String
end

User.new(name: 'Wardrobe User')

Read more here

Goals

Wardrobe should:

  • be faster than Virtus
  • have no dependencies (plugins may)
  • not pollute the instance level with any methods other than ones prefixed with _
  • should be immutable in the config layer allowing subclasses or singleton classes to modify the config
  • be easy to extend with plugins
  • simplify coercions through refinements

Ruby 2.4

When working on the first "Proof of Concept" for Wardrobe I wanted to use refinements for coercion. This was right before Ruby 2.4 was released that added support for using Kernel#send to call a method defined in a refined class. This was needed to get my first POC working and is why Wardrobe requires ruby 2.4 or above.