Common helpers for Solidus Extensions
Clone or download
kennyadsl Merge pull request #14 from solidusio/remove-rubocop-autorun
Remove running rubocop on rake task
Latest commit b7db1bd Dec 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Migrate from Poltergeist to Headless Chrome Dec 11, 2018
spec Rubocop -a Oct 9, 2018
.gitignore Add test setup Dec 8, 2017
.rspec Add test setup Dec 8, 2017
.rubocop.yml Rubocop -a Oct 9, 2018
.travis.yml Update travis configuration Oct 9, 2018
Gemfile Alphabetize Gemfile dependencies Oct 9, 2018
README.md Update README with testing helper section Oct 27, 2017
Rakefile Remove running rubocop on rake task Oct 9, 2018
solidus_support.gemspec Rubocop -a Oct 9, 2018

README.md

SolidusSupport

This gem holds some common functionality for Solidus Extensions.

It has some utilities to make it easier to support multiple versions of Solidus.

Usage

SolidusSupport::Migration

Rails >= 5 introduced the concept of specifying what rails version your migration was written for, like ActiveRecord::Migration[5.0]. Not specifying a version is deprecated in Rails 5.0 and removed in rails 5.1. This wasn't backported to Rails 4.2, but Rails 4.2 is Rails 4.2. So we provide this helper.

# On Rails 4.2
SolidusSupport::Migration[4.2] # returns `ActiveRecord::Migration`
SolidusSupport::Migration[5.0] # errors

# On Rails 5.0
SolidusSupport::Migration[4.2] # same as `ActiveRecord::Migration[4.2]`
SolidusSupport::Migration[5.0] # same as `ActiveRecord::Migration[5.0]`

There's no reason to use SolidusSupport::Migration[5.0] over ActiveRecord::Migration[5.0], but it is provided.

Testing Helpers

This gem provides some useful helpers for RSpec to setup an extension's test environment easily.

Into your extension's spec/spec_helper.rb:

require "solidus_support/extension/feature_helper"

This helper loads configuration needed to run extensions feature specs correctly, setting up Capybara and configuring Rails test application to precompile assets before the first feature spec.

This helper requires the rails_helper, also provided by this gem and requireable as a stand-alone helper.

By doing:

require "solidus_support/extension/rails_helper"

extension's test suite will have all Rails related tests configuration, like authorization helpers, Solidus core factories, url helpers, and other helpers to easily work with Solidus Config.

This rails_helper in turn requires the basic spec_helper, which is responsible to load a basic RSpec configuration, which could be needed in all extensions. It is also requireable as a stand-alone helper with:

require "solidus_support/extension/spec_helper"

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 tags, and push the .gem file to rubygems.org.

Contributing

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