Merge pull request #1154 from doorkeeper-gem/refactor_stale_records_c…

…leaner

Refactor StaleRecordsCleaner to be ORM agnostic

.travis.yml

@@ -23,6 +23,11 @@ gemfile:
 
 matrix:
   fast_finish: true
+  # Run Danger only once
+  include:
+    - rvm: 2.5
+      gemfile: gemfiles/rails_5_2.gemfile
+      script: bundle exec danger
   exclude:
     - gemfile: gemfiles/rails_5_0.gemfile
       rvm: 2.1

Dangerfile

@@ -0,0 +1,57 @@
+CHANGELOG_FILE = 'NEWS.md'
+GITHUB_REPO = 'https://github.com/doorkeeper-gem/doorkeeper'
+
+def changelog_changed?
+  git.modified_files.include?(CHANGELOG_FILE) || git.added_files.include?(CHANGELOG_FILE)
+end
+
+def changelog_entry_example
+  pr_number = github.pr_json['number']
+  pr_url = github.pr_json['html_url']
+  pr_title = github.pr_title
+                   .sub(/[?.!,;]?$/, '')
+                   .capitalize
+
+  "- [##{pr_number}](#{pr_url}): #{pr_title}."
+end
+
+# --------------------------------------------------------------------------------------------------------------------
+# Has any changes happened inside the actual library code?
+# --------------------------------------------------------------------------------------------------------------------
+has_app_changes = !git.modified_files.grep(/lib/).empty?
+has_spec_changes = !git.modified_files.grep(/spec/).empty?
+
+# --------------------------------------------------------------------------------------------------------------------
+# You've made changes to lib, but didn't write any tests?
+# --------------------------------------------------------------------------------------------------------------------
+if has_app_changes && !has_spec_changes
+  warn("There're library changes, but not tests. That's OK as long as you're refactoring existing code.", sticky: false)
+end
+
+# --------------------------------------------------------------------------------------------------------------------
+# You've made changes to specs, but no library code has changed?
+# --------------------------------------------------------------------------------------------------------------------
+if !has_app_changes && has_spec_changes
+  message('We really appreciate pull requests that demonstrate issues, even without a fix. That said, the next step is to try and fix the failing tests!', sticky: false)
+end
+
+# Mainly to encourage writing up some reasoning about the PR, rather than
+# just leaving a title
+if github.pr_body.length < 10
+  fail "Please provide a summary in the Pull Request description"
+end
+
+# --------------------------------------------------------------------------------------------------------------------
+# Have you updated CHANGELOG.md?
+# --------------------------------------------------------------------------------------------------------------------
+# Add a CHANGELOG entry for app changes
+if has_app_changes && !changelog_changed?
+  markdown <<-MARKDOWN
+Here's an example of a #{CHANGELOG_FILE} entry:
+```markdown
+#{changelog_entry_example}
+```
+  MARKDOWN
+
+  fail("Please include a changelog entry. \nYou can find it at [#{CHANGELOG_FILE}](#{GITHUB_REPO}/blob/master/#{CHANGELOG_FILE}).")
+end

NEWS.md

@@ -12,7 +12,8 @@ User-visible changes worth mentioning.
   triggers every time)
 - [#1149] Fix for `URIChecker#valid_for_authorization?` false negative when query is blank, but `?` present.
 - [#1151] Fix Refresh Token strategy: add proper validation of client credentials both for Public & Private clients.
-- [#1152] Fixmigration template: change resource owner data type from integer to references
+- [#1152] Fix migration template: change resource owner data type from integer to Rails generic `references`
+- [#1154] Refactor `StaleRecordsCleaner` to be ORM agnostic.
 
 ## 5.0.0
 

app/controllers/doorkeeper/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class ApplicationController <
     Doorkeeper.configuration.base_controller.constantize

app/controllers/doorkeeper/application_metal_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class ApplicationMetalController < ActionController::Metal
     MODULES = [

app/controllers/doorkeeper/applications_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class ApplicationsController < Doorkeeper::ApplicationController
     layout 'doorkeeper/admin' unless Doorkeeper.configuration.api_only

app/controllers/doorkeeper/authorizations_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class AuthorizationsController < Doorkeeper::ApplicationController
     before_action :authenticate_resource_owner!

app/controllers/doorkeeper/authorized_applications_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class AuthorizedApplicationsController < Doorkeeper::ApplicationController
     before_action :authenticate_resource_owner!

app/controllers/doorkeeper/token_info_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class TokenInfoController < Doorkeeper::ApplicationMetalController
     def show

app/controllers/doorkeeper/tokens_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class TokensController < Doorkeeper::ApplicationMetalController
     def create

app/helpers/doorkeeper/dashboard_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module DashboardHelper
     def doorkeeper_errors_for(object, method)

app/validators/redirect_uri_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 class RedirectUriValidator < ActiveModel::EachValidator

doorkeeper.gemspec

@@ -2,29 +2,30 @@ $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 require 'doorkeeper/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'doorkeeper'
-  s.version     = Doorkeeper.gem_version
-  s.authors     = ['Felipe Elias Philipp', 'Tute Costa', 'Jon Moss', 'Nikita Bulai']
-  s.email       = %w([email protected])
-  s.homepage    = 'https://github.com/doorkeeper-gem/doorkeeper'
-  s.summary     = 'OAuth 2 provider for Rails and Grape'
-  s.description = 'Doorkeeper is an OAuth 2 provider for Rails and Grape.'
-  s.license     = 'MIT'
+Gem::Specification.new do |gem|
+  gem.name        = 'doorkeeper'
+  gem.version     = Doorkeeper.gem_version
+  gem.authors     = ['Felipe Elias Philipp', 'Tute Costa', 'Jon Moss', 'Nikita Bulai']
+  gem.email       = %w([email protected])
+  gem.homepage    = 'https://github.com/doorkeeper-gem/doorkeeper'
+  gem.summary     = 'OAuth 2 provider for Rails and Grape'
+  gem.description = 'Doorkeeper is an OAuth 2 provider for Rails and Grape.'
+  gem.license     = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
-  s.require_paths = ['lib']
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.require_paths = ['lib']
 
-  s.add_dependency 'railties', '>= 4.2'
-  s.required_ruby_version = '>= 2.1'
+  gem.add_dependency 'railties', '>= 4.2'
+  gem.required_ruby_version = '>= 2.1'
 
-  s.add_development_dependency 'capybara', '~> 2.18'
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'grape'
-  s.add_development_dependency 'database_cleaner', '~> 1.6'
-  s.add_development_dependency 'factory_bot', '~> 4.8'
-  s.add_development_dependency 'generator_spec', '~> 0.9.3'
-  s.add_development_dependency 'rake', '>= 11.3.0'
-  s.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'capybara', '~> 2.18'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'danger', '~> 5.0'
+  gem.add_development_dependency 'grape'
+  gem.add_development_dependency 'database_cleaner', '~> 1.6'
+  gem.add_development_dependency 'factory_bot', '~> 4.8'
+  gem.add_development_dependency 'generator_spec', '~> 0.9.3'
+  gem.add_development_dependency 'rake', '>= 11.3.0'
+  gem.add_development_dependency 'rspec-rails'
 end

lib/doorkeeper.rb

@@ -67,6 +67,7 @@
 require 'doorkeeper/rails/helpers'
 
 require 'doorkeeper/rake'
+require 'doorkeeper/stale_records_cleaner'
 
 require 'doorkeeper/orm/active_record'
 

lib/doorkeeper/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   class Engine < Rails::Engine
     initializer "doorkeeper.params.filter" do |app|

lib/doorkeeper/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Errors
     class DoorkeeperError < StandardError
@@ -46,6 +48,7 @@ def initialize(response)
 
     UnableToGenerateToken = Class.new(DoorkeeperError)
     TokenGeneratorNotFound = Class.new(DoorkeeperError)
+    NoOrmCleaner = Class.new(DoorkeeperError)
 
     InvalidToken = Class.new BaseResponseError
     TokenExpired = Class.new InvalidToken

lib/doorkeeper/grape/authorization_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Grape
     class AuthorizationDecorator < SimpleDelegator

lib/doorkeeper/grape/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'doorkeeper/grape/authorization_decorator'
 
 module Doorkeeper

lib/doorkeeper/helpers/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Define methods that can be called in any controller that inherits from
 # Doorkeeper::ApplicationMetalController or Doorkeeper::ApplicationController
 module Doorkeeper

lib/doorkeeper/models/access_grant_mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module AccessGrantMixin
     extend ActiveSupport::Concern

lib/doorkeeper/models/access_token_mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module AccessTokenMixin
     extend ActiveSupport::Concern

lib/doorkeeper/models/application_mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module ApplicationMixin
     extend ActiveSupport::Concern

lib/doorkeeper/models/concerns/accessible.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Accessible

lib/doorkeeper/models/concerns/expirable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Expirable

lib/doorkeeper/models/concerns/orderable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Orderable

lib/doorkeeper/models/concerns/ownership.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Ownership

lib/doorkeeper/models/concerns/revocable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Revocable

lib/doorkeeper/models/concerns/scopes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module Models
     module Scopes

lib/doorkeeper/oauth/authorization/code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     module Authorization

lib/doorkeeper/oauth/authorization/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     module Authorization

lib/doorkeeper/oauth/authorization/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     module Authorization

lib/doorkeeper/oauth/authorization/uri_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/utils'
 
 module Doorkeeper

lib/doorkeeper/oauth/authorization_code_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class AuthorizationCodeRequest < BaseRequest

lib/doorkeeper/oauth/base_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class BaseRequest

lib/doorkeeper/oauth/base_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class BaseResponse

lib/doorkeeper/oauth/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class Client

lib/doorkeeper/oauth/client/credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class Client

lib/doorkeeper/oauth/client_credentials/creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ClientCredentialsRequest < BaseRequest

lib/doorkeeper/oauth/client_credentials/issuer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ClientCredentialsRequest < BaseRequest

lib/doorkeeper/oauth/client_credentials/validation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ClientCredentialsRequest < BaseRequest

lib/doorkeeper/oauth/client_credentials_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ClientCredentialsRequest < BaseRequest

lib/doorkeeper/oauth/code_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class CodeRequest

lib/doorkeeper/oauth/code_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class CodeResponse < BaseResponse

lib/doorkeeper/oauth/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     Error = Struct.new(:name, :state) do

lib/doorkeeper/oauth/error_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ErrorResponse < BaseResponse

lib/doorkeeper/oauth/forbidden_token_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class ForbiddenTokenResponse < ErrorResponse