tracecontroller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 976c95bce34722503f83d0204f20af6bf9da43e4460e57a1e43661734e82392d
+  data.tar.gz: 8bb332d69f9ebfd511f1ca45069f774d2c9ef93328b109cd6f114829836f6112
+SHA512:
+  metadata.gz: 84130ddd4a11c11a9d19d7c1b16f6220a2cacc144b3d69c848428f0bf93a2c7adf7e807bbacc291e7330b81edcfc3ccca131da3f56a3eb8239efa01b3550a70c
+  data.tar.gz: 4f90262471650127dacbf3b3b2ad55fb7ea604f8d3c92e8a155f62ea2de999bdc6023a58fe7c3e13454888371580f15b4f9e1e89d3a5d2b20f2f74b8451ced40

data/.circleci/config.yml

@@ -0,0 +1,36 @@
+version: 2.1
+
+executors:
+  default:
+    working_directory: ~/app
+    docker:
+      - image: circleci/ruby:2.6
+
+commands:
+  setup_bundle:
+    steps:
+      - restore_cache:
+          key: bundle-{{ checksum "tracecontroller.gemspec" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          key: bundle-{{ checksum "tracecontroller.gemspec" }}
+          paths:
+          - vendor/bundle
+
+jobs:
+  test:
+    executor: default
+    steps:
+      - checkout
+      - setup_bundle
+      - run: bundle exec rspec ./spec
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Akira Kusumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# tracecontroller
+
+A Rake task that helps you find missing callbacks in your Rails app.
+
+## Install
+
+Put this line in your Gemfile:
+```
+gem 'tracecontroller'
+```
+
+Then bundle:
+```
+% bundle
+```
+
+## Usage
+
+Create a .tracecontroller.yaml or .tracecontroller.yml file in your root directory.
+
+```yaml
+- path: ^/api
+  superclass: API::BaseController
+  actions:
+    - before:
+        - require_login_for_api
+
+- path: ^/
+  actions:
+    - before:
+        - require_login
+  ignore_classes:
+    - ^ActionMailbox|^ActiveStorage|^Rails
+    - ^API
+```
+
+Just run the following command in your Rails app directory.
+
+```
+% rake tracecontroller
+```
+
+If you want the rake task to fail when errors are found.
+
+```
+% FAIL_ON_ERROR=1 rake tracecontroller
+```
+
+## Copyright
+
+Copyright (c) 2020 Akira Kusumoto. See MIT-LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tasks/tracecontroller.rake

@@ -0,0 +1,21 @@
+desc 'Prints out missing callbacks'
+task tracecontroller: :environment do
+  tracecontroller = Tracecontroller.new(Rails.application)
+  tracecontroller.valid?
+
+  tracecontroller.errors[:callback].each do |error|
+    puts "#{error[:controller_name]} Missing callbacks."
+
+    error[:callbacks].each do |callback|
+      puts "  #{callback[:kind]}_action: #{callback[:filter]}"
+    end
+  end
+
+  tracecontroller.errors[:superclass].each do |name|
+    puts "#{name} Missing superclass."
+  end
+
+  if ENV['FAIL_ON_ERROR'] && tracecontroller.valid?
+    raise 'Missing callbacks or superclass detected.'
+  end
+end

data/lib/tracecontroller.rb

@@ -0,0 +1,110 @@
+class Tracecontroller
+  VERSION = Gem.loaded_specs['tracecontroller'].version.to_s
+  attr_reader :errors
+
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "tasks/tracecontroller.rake")
+    end
+  end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def valid?
+    if @errors
+      return @errors[:callback].blank? && @errors[:superclass].blank?
+    end
+
+    @app.eager_load!
+    @app.reload_routes!
+
+    routes = collect_routes(Rails.application.routes.routes).reject {|r| r.requirements[:controller].to_s.blank? }
+
+    @errors = controllers(routes).each.with_object({callback: [], superclass: []}) do |row, errors|
+      rules.each do |rule|
+        if !rule[:path].match?(row[:path]) || rule[:ignore_classes].any? {|r| r.match? row[:controller_name] }
+          next
+        end
+
+        if rule[:superclass].present? && row[:superclass_name] != rule[:superclass]
+          errors[:superclass] << row[:controller_name]
+        end
+
+        callbacks = rule[:require_actions] - row[:callbacks]
+
+        if callbacks.present?
+          errors[:callback] << {controller_name: row[:controller_name], callbacks: callbacks}
+        end
+      end
+    end
+
+    @errors[:callback].blank? && @errors[:superclass].blank?
+  end
+
+  private
+
+  def config_filename
+    %w[.tracecontroller.yaml .tracecontroller.yml].detect { |f| File.exist?(f) }
+  end
+
+  def rules
+    @rules ||= (config_filename ? YAML.load_file(config_filename) : []).map do |rule|
+      require_actions = (rule["actions"] || []).each.with_object([]) do |h, array|
+        h.each do |key, filters|
+          filters.each do |filter|
+            array << { kind: key.to_sym, filter: filter.to_sym }
+          end
+        end
+      end
+
+      {
+        path:            Regexp.new(rule["path"]),
+        require_actions: require_actions,
+        superclass:      rule["superclass"],
+        ignore_classes:  (rule["ignore_classes"] || []).map {|c| Regexp.new(c) },
+      }
+    end
+  end
+
+  def controllers(routes)
+    routes.sort_by {|r| r.path.spec.to_s }.each.with_object([]) do |route, array|
+      controller_name = "#{route.requirements[:controller].camelize}Controller"
+
+      next if array.any? {|c| c[:controller_name] == controller_name }
+
+      begin
+        controller = ActiveSupport::Dependencies.constantize(controller_name)
+      rescue NameError => e
+        puts "#{e.message} path:#{route.path.spec}"
+        next
+      end
+
+      array << {
+        controller_name: controller.name,
+        superclass_name: controller.superclass.name,
+        callbacks:       controller.__callbacks[:process_action].map {|c| { kind: c.kind, filter: c.filter } },
+        path:            route.path.spec.to_s,
+      }
+    end
+  end
+
+  def collect_routes(routes)
+    routes = routes.each_with_object([]) do |r, tmp_routes|
+      next if r.app.is_a?(ActionDispatch::Routing::Mapper::Constraints) && %w[ActionDispatch::Routing::PathRedirect ActionDispatch::Routing::Redirect].include?(r.app.app.class.name)
+
+      if r.app.is_a?(ActionDispatch::Routing::Mapper::Constraints) && r.app.app.respond_to?(:routes)
+        engine_routes = r.app.app.routes
+        if engine_routes.is_a?(ActionDispatch::Routing::RouteSet)
+          tmp_routes.concat collect_routes(engine_routes.routes)
+        end
+      else
+        tmp_routes << r
+      end
+    end
+
+    routes.reject! {|r| r.app.is_a?(ActionDispatch::Routing::Redirect) }
+    routes
+  end
+end

data/spec/app.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/all'
+require 'action_controller/railtie'
+
+require 'tracecontroller'
+
+module DummyApp
+  class Application < Rails::Application
+    config.root = File.expand_path(__dir__)
+  end
+end
+
+class ApplicationController < ActionController::Base
+end
+
+module Api
+end
+
+class Api::BaseController < ApplicationController
+  before_action :require_login_for_api
+
+  def require_login_for_api
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'pry'
+require 'rails'
+require 'tracecontroller'
+require_relative 'app'
+
+# RSpec.configure do |config|
+# end

data/spec/tracecontroller_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Tracecontroller do
+  it 'has a version number' do
+    expect(Tracecontroller::VERSION).not_to be nil
+  end
+
+  after { File.delete '.tracecontroller.yml' if File.exists? '.tracecontroller.yml' }
+
+  describe '#valid?' do
+    it 'missing callback.' do
+      DummyApp::Application.routes.draw do
+        resources :users
+        resources :public_pages
+        resources :secrets
+      end
+
+      # OK
+      class UsersController < ApplicationController
+        before_action :require_login
+      end
+
+      class PublicPagesController < ApplicationController
+      end
+
+      # NG
+      class SecretsController < ApplicationController
+      end
+
+      File.open '.tracecontroller.yml', 'w' do |file|
+        file.puts '- path: ^/'
+        file.puts '  actions:'
+        file.puts '    - before:'
+        file.puts '      - require_login'
+        file.puts '  ignore_classes:'
+        file.puts '    - PublicPagesController'
+      end
+
+      trace = Tracecontroller.new(Rails.application)
+      expect(trace.valid?).to be_falsey
+      expect(trace.errors[:superclass]).to be_blank
+      callback_error = {controller_name: 'SecretsController', callbacks: [{kind: :before, filter: :require_login}]}
+      expect(trace.errors[:callback]).to eq([callback_error])
+    end
+
+    it 'missing superclass.' do
+      DummyApp::Application.routes.draw do
+        resources :books
+        namespace :api do
+          resources :books
+        end
+      end
+
+      class BooksController < ActionController::Base
+      end
+
+      class Api::BooksController < ActionController::Base
+      end
+
+      File.open '.tracecontroller.yml', 'w' do |file|
+        file.puts '- path: ^/'
+        file.puts '  superclass: ApplicationController'
+        file.puts '  ignore_classes:'
+        file.puts '    - Api::BooksController'
+        file.puts '- path: ^/api'
+        file.puts '  superclass: Api::BaseController'
+      end
+
+      trace = Tracecontroller.new(Rails.application)
+      expect(trace.valid?).to be_falsey
+      expect(trace.errors[:superclass]).to eq(["Api::BooksController", "BooksController"])
+      expect(trace.errors[:callback]).to be_blank
+    end
+  end
+end

data/tracecontroller.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'tracecontroller'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Akira Kusumoto']
+  s.email       = ['akirakusumo10@gmail.com']
+  s.homepage    = 'https://github.com/bluerabbit/tracecontroller'
+  s.summary     = 'A Rake task that helps you find the missing callbacks for your Rails app'
+  s.description = "This Rake task investigates the application's controller, then tells you missing callbacks"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 5.0.0']
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rspec', '~> 3.9'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tracecontroller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Kusumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: This Rake task investigates the application's controller, then tells
+  you missing callbacks
+email:
+- akirakusumo10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tasks/tracecontroller.rake
+- lib/tracecontroller.rb
+- spec/app.rb
+- spec/spec_helper.rb
+- spec/tracecontroller_spec.rb
+- tracecontroller.gemspec
+homepage: https://github.com/bluerabbit/tracecontroller
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rake task that helps you find the missing callbacks for your Rails app
+test_files:
+- spec/app.rb
+- spec/spec_helper.rb
+- spec/tracecontroller_spec.rb