0.0
No commit activity in last 3 years
No release in over 3 years
SmartOptions allows to define options classes which have default and required options
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 10.0
~> 3
 Project Readme

SmartOptions

CircleCI

SmartOptions allows to define options classes which have default and required options

Installation

Add this line to your application's Gemfile:

gem "smart_options"

And then execute:

$ bundle

Or install it yourself as:

$ gem install smart_options

Usage

Inherit from SmartOptions::Options class to get all functionality:

class UserOptions < SmartOptions::Options
  option :first_name, required: true
  option :last_name, required: true
  option :admin, defaut: false
end

User created options class:

options = UserOptions.new(first_name: "Foo", last_name: "Bar")

options.first_name # => "Foo"
options.last_name # => "Bar"
options.admin # => false

options = UserOptions.new(last_name: "Bar") # => raises exception listing required options

options = UserOptions.new(
  first_name: "Foo",
  last_name: "Bar",
  middle_name: "Baz"
) # => raises exception listing wrong options

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yukas/smart_options.

License

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