https://github.com/duksis/private_struct

Struct that does not violate encapsulation by default.
https://github.com/duksis/private_struct

Last synced: 18 days ago
JSON representation

Struct that does not violate encapsulation by default.

• Host: GitHub
• URL: https://github.com/duksis/private_struct
• Owner: duksis
• License: mit
• Created: 2016-06-03T21:50:38.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-03T21:52:54.000Z (over 8 years ago)
• Last Synced: 2024-10-07T13:18:08.205Z (about 1 month ago)
• Language: Ruby
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# PrivateStruct

PrivateStruct is a Struct that does not violate encapsulation by default.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'private_struct'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install private_struct

## Usage

```ruby

require 'private_struct'

Customer = PrivateStruct.new(:name, :address) do

  def greeting

    "Hello #{name}!"

  end

end

dave = Customer.new("Dave", "123 Main")

dave.greeting  # => "Hello Dave!"

dave.address  # => NoMethodError: private method `address' called for #

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/duksis/private_struct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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