Ruby syntax sugar for C# style property accessor definition
Add this line to your application's Gemfile:
gem 'property-accessor'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install property-accessor
There are two ways of using property accessor.
You can inject property
singleton method directly to Class
object during your app initialization.
PropertyAccessor::Mixin.inject!
Or you can manually extend your class with PropertyAccessor
module
require 'date'
class Person
extend PropertyAccessor
property(:first_name) { get { @name.upcase }; set(:family_name) { |val| @name = val } }
property(:last_name) { get; set }
property(:full_name) { get { "#{first_name} #{last_name}" } }
property(:birth_date) { get; set { |val| @birth_date = Date.parse(val.to_s) } }
property(:age) { get { (Time.now - birth_date.to_time).to_i / 60 / 60 / 24 / 365 } }
property(:confidential) { private get; public set; }
property(:middle_name) { get(:get_middle_name); set(:set_middle_name); }
property(:meta) { default { {} }; get }
end
p = Person.new
p.first_name = 'john'
p.last_name = 'doe'
p.full_name
# => 'JOHN doe'
p.birth_date = "1992-04-12"
p.age
# => 27
p.meta
# => {}
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/estepnv/property-accessor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the property_accessor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.