https://github.com/petercamilleri/option_list
For reference only. Obsolete as of Ruby 2.1.
https://github.com/petercamilleri/option_list
parameters ruby
Last synced: 11 months ago
JSON representation
For reference only. Obsolete as of Ruby 2.1.
- Host: GitHub
- URL: https://github.com/petercamilleri/option_list
- Owner: PeterCamilleri
- License: other
- Created: 2013-12-25T15:24:59.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T20:06:34.000Z (about 5 years ago)
- Last Synced: 2025-03-19T03:55:53.784Z (over 1 year ago)
- Topics: parameters, ruby
- Language: Ruby
- Homepage:
- Size: 327 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: license.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OptionList
This gem addresses the fact that parameter validation is long and
tedious and something needs to be done about that. This gem implements
the idea that parameters be described separately and validated in a
single line of client method code.
Most of what this gem does has been subsumed by the Ruby Language itself,
starting with version 1.9 and further with versions 2.0 and beyond.
Finally, I'd like to add a personal note about this code. This was my first
attempt at creating a gem. As such there is very much a newbie vibe to the
code. I hope you can chalk this up to just a part of the learning process.
None the less, if there are improvements that you (the reader) could suggest,
I'd really appreciate hearing about them.
Thanks in advance, Peter.
## Installation
Add this line to your application's Gemfile:
gem 'option_list'
And then execute:
$ bundle
Or install it yourself as:
$ gem install option_list
The options_list gem is at: ( https://rubygems.org/gems/options_list )
## Usage
The use of option_list occurs in three phases: Describing the Parameters,
Passing in Parameters and Validating/Accessing the Parameters. This can be
seen in the following example:
```ruby
module ReadLine
#Create the parameter specification (simplified for brevity)
@spec = OptionList.new([:buffer, :history, :no_history], {:depth => 50}) do |options|
fail "Depth must be an integer" unless options.depth.is_a(Integer)
fail "Depth must be positive" if options.depth < 1
end
class << self
attr_reader :spec
end
def read_line(prompt, *options)
@options = ReadLine.spec.select(options)
#Further code deleted for brevity.
#Somewhere along the line it records the last line.
buffer_line(current_line)
current_line
end
def buffer_line(line)
@line_buffer << line if @options.history?
@line_buffer.delete_at(0) if @line_buffer.length > @options.depth
end
end
```
The option_list gem is described in the The option_list User's Guide
which covers version 1.1.1 which has no material change from 1.1.3
## Contributing
#### Plan A
1. Fork it ( https://github.com/PeterCamilleri/option_list/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
#### Plan B
Go to the GitHub repository and raise an issue calling attention to some
aspect that could use some TLC or a suggestion or an idea.
## License
The gem is available as open source under the terms of the
[MIT License](./LICENSE.txt).
## Code of Conduct
Everyone interacting in the fully_freeze project’s codebases, issue trackers,
chat rooms and mailing lists is expected to follow the
[code of conduct](./CODE_OF_CONDUCT.md).