https://github.com/atomicobject/constructor

Declarative named-argument object initialization
https://github.com/atomicobject/constructor

Last synced: 10 months ago
JSON representation

Declarative named-argument object initialization

• Host: GitHub
• URL: https://github.com/atomicobject/constructor
• Owner: atomicobject
• Created: 2009-12-01T06:12:45.000Z (over 16 years ago)
• Default Branch: master
• Last Pushed: 2013-11-21T05:03:37.000Z (over 12 years ago)
• Last Synced: 2025-06-08T22:08:04.294Z (11 months ago)
• Language: Ruby
• Homepage: http://atomicobject.github.com/constructor
• Size: 695 KB
• Stars: 12
• Watchers: 27
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: History.rdoc

Awesome Lists containing this project

README

          
== Constructor

* http://atomicobject.github.com/constructor

== Description

  

Declarative means to define object properties by passing a hash 

to the constructor, which will set the corresponding ivars.

== Synopsis

  require 'constructor'

  class Horse

    constructor :name, :breed, :weight

  end

  Horse.new :name => 'Ed', :breed => 'Mustang', :weight => 342

By default the ivars do not get accessors defined.

But you can get them auto-made if you want:

  class Horse

    constructor :name, :breed, :weight, :accessors => true

  end

  ...

  puts my_horse.weight

 

Arguments specified are required by default.  You can disable 

strict argument checking with :strict option.  This means that 

the constructor will not raise an error if you pass more or 

fewer arguments than declared.

  class Donkey

    constructor :age, :odor, :strict => false

  end

... this allows you to pass either an age or odor key (or neither)

to the Donkey constructor.

== Requirements

* rubygems

== Install

* gem install constructor

== Authors

* David Crosby (crosby@atomicobject.com)

* Patrick Bacon (bacon@atomicobject.com)

* © 2007-2011 {Atomic Object}[http://www.atomicobject.com]

* More Atomic Object {open source}[http://www.atomicobject.com/pages/Software+Commons] projects

== License

(The MIT License)

Copyright (c) 2007-2011 Atomic Object

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.