https://github.com/estepnv/property-accessor

Ruby syntax sugar for C# style property accessor definition
https://github.com/estepnv/property-accessor

accessor attributes getters properties property rails ruby setters

Last synced: about 1 month ago
JSON representation

Ruby syntax sugar for C# style property accessor definition

• Host: GitHub
• URL: https://github.com/estepnv/property-accessor
• Owner: estepnv
• License: mit
• Created: 2020-03-10T17:06:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-11T20:08:27.000Z (almost 5 years ago)
• Last Synced: 2024-12-13T21:55:10.601Z (about 2 months ago)
• Topics: accessor, attributes, getters, properties, property, rails, ruby, setters
• Language: Ruby
• Homepage:
• Size: 16.6 KB
• Stars: 20
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# property_accessor

Ruby syntax sugar for C# style property accessor definition

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'property-accessor'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install property-accessor

## Usage

There are two ways of using property accessor.

You can inject `property` singleton method directly to `Class` object during your app initialization.

```ruby

PropertyAccessor::Mixin.inject!

```

Or you can manually extend your class with `PropertyAccessor` module

```ruby

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

# => {}

```

## 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](https://rubygems.org).

## Contributing

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](https://github.com/estepnv/property-accessor/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the property_accessor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/estepnv/property-accessor/blob/master/CODE_OF_CONDUCT.md).