0.0
The project is in a healthy, maintained state
bp3-actiontext adapts actiontext for BP3 (persuavis/black_phoebe_3).
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 13.0
>= 3.0
>= 1.21

Runtime

>= 7.1.2
>= 0.1
>= 7.1.2
 Project Readme

Bp3::Actiontext

bp3-actiontext adapts actiontext for BP3, the persuavis/black_phoebe_3 multi-site multi-tenant rails application. In particular, it adapts ActionText::RichText.

Installation

Add this line to your application's Gemfile:

gem 'bp3-actiontext'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install bp3-actiontext

Usage

In your application's config/initializers/bp3-actiontext initializer, specify the names of the classes that store site, tenant and workspace records:

Bp3::Actiontext.site_class_name = 'Sites::Site'
Bp3::Actiontext.tenant_class_name = 'Tenant'
Bp3::Actiontext.workspace_class_name = 'Workspaces::Workspace'

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.