vandelay

Vandelay

This is one implementation of the Builder Pattern in the Ruby programming language. This is primarily used for composing objects to transport a set of data to a receiver with a specific payload. The advantage of using a builder over a plain Hash is using explicit methods to set required fields, and getting a common way to present your data to the receiver. By default, .build will transform your data into a hash, but you can override this method to create your preferred format.

Installation

Add this line to your application's Gemfile:

gem 'vandelay'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vandelay

Usage

require 'vandelay'

class ToDoBuilder
  include Vandelay::Buildable

  composed_of :text,
              :title,
              :completed_at

  composed_of :created_at, default: Time.now.iso8601
end

new_todo = ToDoBuilder.new

new_todo.set_title('Write a ruby package')
new_todo.set_text('Ruby is fun to write, so why not write a gem?')
new_todo.set_completed_at(Time.now.iso8601)

Development

After checking out the repo, run bin/setup to install dependencies. 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/djds23/vandelay.