Bp3::String
bp3-string adapts the String
class for BP3, the persuavis/black_phoebe_3
multi-site multi-tenant rails application. In particular, it adds the following methods:
-
#modelize
- Converts a string to its matching model name, taking into account that a model may be namespaced -
#controllerize
- Converts a string to its matching controller name, taking into account that a controller may be namespaced
To take namespacing into account, it uses a list of table names and models obtained from the db.
For this to work correctly, the app must be eager loaded.
Installation
Add this line to your application's Gemfile:
gem 'bp3-string'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install bp3-string
Usage
Just add the gem to your BP3 app.
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 rake install
. To release a
new version, update the version number in version.rb
, and then run
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.
Testing
Run rake
to run rspec tests and rubocop linting.
Documentation
A .yardopts
file is provided to support yard documentation.
License
The gem is available as open source under the terms of the MIT License.