<%= class_name.gsub(/(?<=1)([A-Z])/, ' 1') %>¶ ↑
[ repo %>.svg?style=shield)](circleci.com/gh/<%= repo %>) [
repo %>/branch/master/graph/badge.svg)](codecov.io/gh/<%= repo %>)
Installation¶ ↑
Add <%= file_name %> to your Gemfile:
gem '<%= file_name %>'
Bundle your dependencies and run the installation generator:
bin/rails generate <%= file_name %>:install
Usage¶ ↑
Development¶ ↑
Testing the extension¶ ↑
First bundle your dependencies, then run bin/rake
. bin/rake
will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using bin/rake extension:test_app
.
bin/rake
To run Rubocop static code analysis run
bundle exec rubocop
When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec/spec_helper.rb
:
require '<%= file_name %>/testing_support/factories'
Or, if you are using FactoryBot.definition_file_paths
, you can load Solidus core factories along with this extension's factories using this statement:
SolidusDevSupport::TestingSupport::Factories.load_for(<%= class_name %>::Engine)
Running the sandbox¶ ↑
To run this extension in a sandboxed Solidus application, you can run bin/sandbox
. The path for the sandbox app is ./sandbox
and bin/rails
will forward any Rails commands to sandbox/bin/rails
.
Here's an example:
$ bin/rails server => Booting Puma => Rails 6.0.2.1 application starting in development * Listening on tcp://127.0.0.1:3000 Use Ctrl-C to stop
Updating the changelog¶ ↑
Before and after releases the changelog should be updated to reflect the up-to-date status of the project:
bin/rake changelog git add CHANGELOG.md git commit -m "Update the changelog"
Releasing new versions¶ ↑
Please refer to the dedicated page on Solidus wiki.
License¶ ↑
Copyright © <%= Time.now.year %> [name of extension author], released under the New BSD License.