Orthoses::ActiveDecorator
Orthoses extension for ActiveDecorator. Orthoses::ActiveDecorator automatically generates RBS for modules Decorator
# app/decorators/user_decorator.rb
module UserDecorator
def decorated_name
# `name` expects a String type.
name + "!"
end
end
Generate RBS with module self type by AR model. This allows the UserDecorator module to treat types within the same context as the User class.
# sig/app/decorators/user_decorator.rbs
module UserDecorator : User
end
Installation
Install the gem and add to the application's Gemfile by executing:
bundle add orthoses-active_decorator
If bundler is not being used to manage dependencies, install the gem by executing:
gem install orthoses-active_decorator
Usage
active_decorator depends on rails. orthoses-active_decorator is strongly recommended to use with orthoses-rails.
use Orthoses::ActiveDecorator
use Orthoses::Rails::Application
Development
After checking out the repo, run bin/setup
to install dependencies. 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 the created tag, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/orthoses-active_decorator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Orthoses::ActiveDecorator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.