This gem enhances and uses Rails' built-in ParameterFilter to add "Surrogate Key" logging.

• Add gem :rails_surrogate_key_logging to your Gemfile.
• Run bin/bundle install
• Add include SurrogateKeyLogging::ActionController::Params to your ApplicationController
• Add include SurrogateKeyLogging::ActiveRecord::Attributes to your ApplicationRecord

In a new application initializer (config/initializers/surrogate_key_logging.rb) or in your config/environments/*.rb, use the following block:

SurrogateKeyLogging.configure do |config|
  config.key = value
end

This will use a SurrogateKeyLogging::Surrogate model to manage surrogates. This will require adding surrogate_key_logging_#{Rails.env} to your application's config/database.yml See Example. After configuring your config/database.yml you will need to run bin/rails skl:key_store:active_record:db:create and bin/rails skl:key_store:active_record:db:migrate.

default: &default
  adapter: mysql2
  username: <%= Rails.application.credentials.database[:username] %>
  password: <%= Rails.application.credentials.database[:password] %>
  host: 127.0.0.1
  port: 3306
  database: myapp_<%= Rails.env %>
  prepared_statements: true

surrogate_key_logging_default: &surrogate_key_logging_default
  <<: *default
  database: surrogate_keys_<%= Rails.env %>



development:
  <<: *default

test:
  <<: *default

production:
  <<: *default



surrogate_key_logging_development:
  <<: *surrogate_key_logging_default

surrogate_key_logging_test:
  <<: *surrogate_key_logging_default

surrogate_key_logging_production:
  <<: *surrogate_key_logging_default

In any controller including SurrogateKeyLogging::ActionController::Params you may use the surrogate_params(*params, action: '*') method. This method may be used multiple times. Pass the action argument to limit those params to only that action or omit it to apply those params to ALL actions in that controller.

class WidgetsController < ApplicationController
  surrogate_params :name
  surrogate_params :owner, action: :search

  def name
    ...
  end

  def search
    ...
  end
end

In this example the name parameter will be surrogated in all requests to this controller, and the owner parameter will surrogated only in requests to the search action.

In any controller including SurrogateKeyLogging::ActiveRecord::Attributes you may use surrogate_parent_names(*names) and surrogate_attributes(*attrs). All permutations of parent names to attributes will be used to create filters. By default surrogate_parent_names is initialized with the singular and plural names of the model.

class Widget < ApplicationRecord
  surrogate_parent_names :things
  surrogate_attributes :name, :owner
end

In this example, the following filters will be used to look for attributes to be surrogated: widget.name, widget[name], [widget][name], widgets.name, widgets[name], [widgets][name], things.name, things[name], [things][name]