ownership 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e0f9794b246e9f4d788f460db5aeb663f6f45e
+  data.tar.gz: a7d3477d27cbd3aa0cddd55269246922d198a919
+SHA512:
+  metadata.gz: c57c183a32991967c30aba4a926d4c1ef2076b8100d4ae7aa09e32e3ea395214fe3d833209263fd399547105c3ab9484676eeba0f9ee5577889f1b60524b6146
+  data.tar.gz: d3df7b1a97faacd87fb05248001358244466c656a2fc9fa2fb2638a670729f9cd60ac42468d207afe1f0c68f6ff9471bec0bb992559056bb1ee787ac9999218d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ownership.gemspec
+gemspec

data/README.md

@@ -0,0 +1,139 @@
+# Ownership
+
+Code ownership for your Rails app
+
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+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
+
+```ruby
+class OrdersController < ApplicationController
+  owner :logistics
+end
+```
+
+You can use any options that `before_action` supports.
+
+```ruby
+class OrdersController < ApplicationController
+  owner :logistics, only: [:index]
+  owner :customers, except: [:index]
+end
+```
+
+### Jobs
+
+```ruby
+class SomeJob < ApplicationJob
+  owner :logistics
+end
+```
+
+### Anywhere
+
+```ruby
+owner :logistics do
+  # code
+end
+```
+
+### Default
+
+You can set a default owner with:
+
+```ruby
+Ownership.default_owner = :logistics
+```
+
+## Integrations
+
+There are a few built-in integrations with other gems.
+
+### Marginalia
+
+[Marginalia](https://github.com/basecamp/marginalia) adds comments to ActiveRecord queries. If installed, the owner is added.
+
+```sql
+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](https://github.com/rollbar/rollbar-gem) 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.
+
+```ruby
+Ownership::Rollbar.access_token = {
+  logistics: "token1",
+  customers: "token2"
+}
+```
+
+Also works with a proc
+
+```ruby
+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:
+
+```ruby
+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](https://github.com/ankane/ownership/pulls) 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.
+
+```ruby
+begin
+  owner :logistics do
+    raise "error"
+  end
+rescue => e
+  puts e.owner # :logistics
+end
+```
+
+## Other Useful Tools
+
+- [GitHub Code Owners](https://github.com/blog/2392-introducing-code-owners) for code reviews
+
+## Thanks
+
+Thanks to [Nick Elser](https://github.com/nickelser) for creating this pattern.
+
+## History
+
+View the [changelog](https://github.com/ankane/ownership/blob/master/CHANGELOG.md).
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/ownership/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/ownership/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/lib/ownership.rb

@@ -0,0 +1,38 @@
+require "ownership/global_methods"
+require "ownership/rollbar"
+require "ownership/version"
+
+module Ownership
+  class << self
+    attr_accessor :default_owner
+    attr_accessor :around_change
+
+    def owner
+      Thread.current[:ownership_owner] || default_owner
+    end
+  end
+end
+
+Object.send :include, Ownership::GlobalMethods
+
+if defined?(ActiveSupport)
+  ActiveSupport.on_load(:action_controller) do
+    require "ownership/controller_methods"
+    include Ownership::ControllerMethods
+  end
+
+  ActiveSupport.on_load(:active_record) do
+    require "ownership/marginalia" if defined?(Marginalia)
+  end
+
+  ActiveSupport.on_load(:active_job) do
+    require "ownership/job_methods"
+    include Ownership::JobMethods
+  end
+else
+  require "ownership/marginalia" if defined?(Marginalia)
+end
+
+class Exception
+  attr_accessor :owner
+end

data/lib/ownership/controller_methods.rb

@@ -0,0 +1,15 @@
+require "active_support/concern"
+
+module Ownership
+  module ControllerMethods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def owner(owner, options = {})
+        around_action options do |_, block|
+          owner(owner) { block.call }
+        end
+      end
+    end
+  end
+end

data/lib/ownership/global_methods.rb

@@ -0,0 +1,26 @@
+module Ownership
+  module GlobalMethods
+    def owner(owner, &block)
+      raise ArgumentError, "Missing block" unless block_given?
+
+      previous_value = Thread.current[:ownership_owner]
+      begin
+        Thread.current[:ownership_owner] = owner
+
+        begin
+          # callbacks
+          if Ownership.around_change
+            Ownership.around_change.call(owner, block)
+          else
+            block.call
+          end
+        rescue Exception => e
+          e.owner = owner
+          raise
+        end
+      ensure
+        Thread.current[:ownership_owner] = previous_value
+      end
+    end
+  end
+end

data/lib/ownership/job_methods.rb

@@ -0,0 +1,15 @@
+require "active_support/concern"
+
+module Ownership
+  module JobMethods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def owner(*args)
+        around_perform do |_, block|
+          owner(*args) { block.call }
+        end
+      end
+    end
+  end
+end

data/lib/ownership/marginalia.rb

@@ -0,0 +1,9 @@
+module Marginalia
+  module Comment
+    def self.owner
+      Ownership.owner
+    end
+  end
+end
+
+Marginalia::Comment.components << :owner

data/lib/ownership/rollbar.rb

@@ -0,0 +1,48 @@
+module Ownership
+  module Rollbar
+    class << self
+      attr_reader :access_token
+
+      def access_token=(access_token)
+        @access_token = access_token
+        @configure ||= configure # just once
+        access_token
+      end
+
+      private
+
+      def owner_access_token(owner)
+        access_token.respond_to?(:call) ? access_token.call(owner) : access_token[owner]
+      end
+
+      def configure
+        ::Rollbar.configure do |config|
+          config.before_process << proc do |options|
+            options[:scope][:ownership_owner] = Ownership.owner if Ownership.owner
+          end
+
+          config.transform << proc do |options|
+            # clean up payload
+            options[:payload]["data"].delete(:ownership_owner)
+
+            owner = options[:exception].owner if options[:exception].respond_to?(:owner)
+            unless owner
+              owner = options[:scope][:ownership_owner] if options[:scope].is_a?(Hash)
+              owner ||= Ownership.default_owner
+            end
+
+            if owner
+              access_token = owner_access_token(owner)
+              if access_token
+                options[:payload]["access_token"] = access_token
+              else
+                warn "[ownership] Missing Rollbar access token for owner: #{owner}"
+              end
+            end
+          end
+        end
+        true
+      end
+    end
+  end
+end

data/lib/ownership/version.rb

@@ -0,0 +1,3 @@
+module Ownership
+  VERSION = "0.1.0"
+end

data/ownership.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ownership/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ownership"
+  spec.version       = Ownership::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Code ownership for your Rails app"
+  spec.homepage      = "https://github.com/ankane/ownership"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "activejob"
+  spec.add_development_dependency "marginalia"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: ownership
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: marginalia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/ownership.rb
+- lib/ownership/controller_methods.rb
+- lib/ownership/global_methods.rb
+- lib/ownership/job_methods.rb
+- lib/ownership/marginalia.rb
+- lib/ownership/rollbar.rb
+- lib/ownership/version.rb
+- ownership.gemspec
+homepage: https://github.com/ankane/ownership
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Code ownership for your Rails app
+test_files: []