Module: PhiAttrs

Defined in:
lib/phi_attrs/phi_record.rb,
lib/phi_attrs.rb,
lib/phi_attrs/logger.rb,
lib/phi_attrs/railtie.rb,
lib/phi_attrs/version.rb,
lib/phi_attrs/configure.rb,
lib/phi_attrs/formatter.rb,
lib/phi_attrs/exceptions.rb

Overview

Namespace for classes and modules that handle PHI Attribute Access Logging

Defined Under Namespace

Modules: Controller, Exceptions, Model, PhiRecord Classes: Formatter, Logger, Railtie

Constant Summary collapse

PHI_ACCESS_LOG_TAG =
'PHI Access Log'
VERSION =
'0.3.1'
FORMAT =
"%s %5s: %s\n"
@@log_path =
nil
@@log_shift_age =

Default to disabled

0
@@log_shift_size =

1MB - Default from logger class

1_048_576
@@current_user_method =
nil
@@translation_prefix =
'phi'

Class Method Summary collapse

Class Method Details

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (PhiAttrs)

    the object that the method was called on



10
11
12
# File 'lib/phi_attrs/configure.rb', line 10

def self.configure
  yield self if block_given?
end

.current_user_methodObject



46
47
48
# File 'lib/phi_attrs/configure.rb', line 46

def self.current_user_method
  @@current_user_method
end

.current_user_method=(value) ⇒ Object



50
51
52
# File 'lib/phi_attrs/configure.rb', line 50

def self.current_user_method=(value)
  @@current_user_method = value
end

.log_pathObject



14
15
16
# File 'lib/phi_attrs/configure.rb', line 14

def self.log_path
  @@log_path
end

.log_path=(value) ⇒ Object



18
19
20
# File 'lib/phi_attrs/configure.rb', line 18

def self.log_path=(value)
  @@log_path = value
end

.log_phi_access(user, message) ⇒ Object



16
17
18
19
20
# File 'lib/phi_attrs.rb', line 16

def self.log_phi_access(user, message)
  PhiAttrs::Logger.tagged(PHI_ACCESS_LOG_TAG, user) do
    PhiAttrs::Logger.info(message)
  end
end

.log_shift_ageObject



22
23
24
# File 'lib/phi_attrs/configure.rb', line 22

def self.log_shift_age
  @@log_shift_age
end

.log_shift_age=(value) ⇒ Object



26
27
28
# File 'lib/phi_attrs/configure.rb', line 26

def self.log_shift_age=(value)
  @@log_shift_age = value
end

.log_shift_sizeObject



30
31
32
# File 'lib/phi_attrs/configure.rb', line 30

def self.log_shift_size
  @@log_shift_size
end

.log_shift_size=(value) ⇒ Object



34
35
36
# File 'lib/phi_attrs/configure.rb', line 34

def self.log_shift_size=(value)
  @@log_shift_size = value
end

.translation_prefixObject



38
39
40
# File 'lib/phi_attrs/configure.rb', line 38

def self.translation_prefix
  @@translation_prefix
end

.translation_prefix=(value) ⇒ Object



42
43
44
# File 'lib/phi_attrs/configure.rb', line 42

def self.translation_prefix=(value)
  @@translation_prefix = value
end