Project

dao-entity

0.0
No commit activity in last 3 years
No release in over 3 years
Base entity
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Dao::Entity

Gem Version Build Status Code Climate Test Coverage

Installation

Add this line to your application's Gemfile:

gem 'dao-entity'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dao-entity

Usage

require 'dao/entity'

class CommentEntity < Dao::Entity::Base
  attribute :body, String
end

class PostEntity < Dao::Entity::Base
  attribute :id,       Integer
  attribute :body,     String

  attribute :comments, Array[CommentEntity]
end

post = PostEntity.new(id: 1, body: 'Post body', comments: [{ id: 1, body: 'Comment body' }])

post.id # => 1
post.body # => "Post body"
post.comments # => [#<CommentEntity:0x007ffdcb923a30>]

post.body = 'New body'
post.entity_state.body_changed? # => true
post.entity_state.body_was # => "Post body"

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/dao-rb/dao-entity.

License

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