Liner

Lay a liner for your basic Ruby classes. Basically, it's a solid foundation for a PORO (Plain Old Ruby Object). A Liner is something like a more flexible Struct or a less magical OpenStruct, with enhanced inheritability.

Usage

You can setup a Liner based class in any of these equivalent ways:

Engine = Liner.new(:layout, :fuel)

class Engine < Liner.new(:layout, :fuel)
end

class Engine
  liner :layout, :fuel
end

It comes with a hash based initializer and a nice inspector.

e = Engine.new(layout: 'V8', fuel: "gasoline") # => #<Engine layout="V8", fuel="gasoline">

Attribute getters and setters are built in.

e.fuel # => "gasoline"
e.fuel = "diesel" # => "diesel"

Attributes are accessible via hash-style lookup too.

e[:layout] # => "V8"
e[:layout] = "V6" # => "V6"
e[:foo] = "Bar" # => ArgumentError: Invalid liner attribute: 'foo'

Equality methods are also availble.

e.eql? Engine.new(layout: 'I4') # => false
e == Engine.new(layout: 'V6', fuel: 'diesel') # => true

Installation

Add this line to your application's Gemfile:

gem 'liner'

And then execute:

$ bundle

Or install it yourself as:

$ gem install liner

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