FieldStruct
provides a lightweight approach to having Ruby classes with metadata available about the attributes it holds..
The most basic usage is for a simple ruby class:
class BasicFriend < FieldedStruct::Basic
attribute :name
attribute :age
end
# Minimal
john = BasicFriend.new name: "John"
# => #<BasicFriend name="John">
john.name = "Steven"
# => #<BasicFriend name="Steven">
john.age = 35
# => #<BasicFriend name="Steven" age=35>
Add this line to your application's Gemfile:
gem 'fielded_struct'
And then execute:
$ bundle
Or install it yourself as:
$ gem install fielded_struct
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/acima-credit/fielded_struct.
The gem is available as open source under the terms of the MIT License.