Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2.04 KB

README.md

File metadata and controls

52 lines (30 loc) · 2.04 KB

RubocopActionPolicy

Automatic ApplicationPolicy code style checking tool.

test_workflow

A RuboCop extension that checks that policies are subclasses of ApplicationPolicy

# good
class MyPolicy < ApplicationPolicy
  # ...
end

# bad
class MyPolicy < ActionPolicy::Base
  # ...
end

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add rubocop-action_policy

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install rubocop-action_policy

Usage

Add the following to your .rubocop.yml:

require:
  - rubocop-action_policy

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 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/Nordplaner/rubocop-action_policy. 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 RubocopActionPolicy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.