EzAttributes

Easily define initializers with keyword args

Installation

Add this line to your application's Gemfile:

gem 'ez_attributes'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ez_attributes

Usage

The first step is to extend EzAttributes in your class.

class User
  extend EzAttributes
end

Then, add the required and optional fields

class User
  extend EzAttributes

  # Here, `name` and `age` are required, and `email` has a default value, so it is optional.
  attributes :name, :age, email: 'guest@user.com'
end

user = User.new(name: 'Matz', age: 22)
# => #<User:0x000055bac152f130 @name="Matz", @age=22, @email="guest@user.com">

# EzAttributes will add getters for all fields too.
user.name
# => "Matz"

Configuration

You can disable getters:

class User
  extend EzAttributes.configure(getters: false)

  attributes :name, :age, email: 'guest@user.com'
end

u = User.new(name: 'Matz', age: 22)
# => #<User:0x000055bac152f130 @name="Matz", @age=22, @email="guest@user.com">

u.name
# NoMethodError (undefined method `name' for #<User:0x000055bac152f130>)

You can enable setters:

class User
  extend EzAttributes.configure(setters: true)

  attributes :name, :age, email: 'guest@user.com'
end

user = User.new(name: 'Matz', age: 22)
user.name = 'Yukihiro Matsumoto'
user.name
# => "Yukihiro Matsumoto"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/MatheusRich/ez_attributes.

License

The gem is available as open source under the terms of the MIT License.