Code ownership for your Rails app
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
ownership.gemspec

README.md

Ownership

Code ownership for your Rails app

🍊 Battle-tested at Instacart

Installation

Add this line to your application’s Gemfile:

gem 'ownership'

Getting Started

Ownership provides the ability to specify owners for different parts of the codebase. We highly recommend owners are teams rather than individuals. You can then use this information however you’d like, like routing errors to the correct team.

Specifying Ownership

Controllers

class OrdersController < ApplicationController
  owner :logistics
end

You can use any options that before_action supports.

class OrdersController < ApplicationController
  owner :logistics, only: [:index]
  owner :customers, except: [:index]
end

Jobs

class SomeJob < ApplicationJob
  owner :logistics
end

Anywhere

owner :logistics do
  # code
end

Default

You can set a default owner with:

Ownership.default_owner = :logistics

Integrations

There are a few built-in integrations with other gems.

Marginalia

Marginalia adds comments to ActiveRecord queries. If installed, the owner is added.

SELECT ...
/*application:MyApp,controller:posts,action:index,owner:logistics*/

This can be useful when looking at the most time-consuming queries on your database.

Rollbar

Rollbar tracks exceptions. This integration makes it easy to send exceptions to different projects based on the owner. We recommend having a project for each team.

Ownership::Rollbar.access_token = {
  logistics: "token1",
  customers: "token2"
}

Also works with a proc

Ownership::Rollbar.access_token = -> (owner) { ENV["#{owner.to_s.upcase}_ROLLBAR_ACCESS_TOKEN"] }

Custom Integrations

You can define a custom block of code to run with:

Ownership.around_change = proc do |owner, block|
  puts "New owner: #{owner}"
  block.call
  puts "Done"
end

Please don’t hesitate to submit a pull request if you create an integration that others can use.

Exceptions that bubble up from an owner block have the owner, which your exception reporting library can use.

begin
  owner :logistics do
    raise "error"
  end
rescue => e
  puts e.owner # :logistics
end

Other Useful Tools

Thanks

Thanks to Nick Elser for creating this pattern.

History

View the changelog.

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help: