module Remexify

Constants

ERROR
FATAL
INFO
VERSION
WARNING

Attributes

already_initialized[R]

Public Class Methods

delete_all_logs() click to toggle source
# File lib/remexify/remexify_retriever.rb, line 84
def delete_all_logs
  Remexify.config.model.delete_all
end
error(message_object, options = {}) click to toggle source
# File lib/remexify/remexify_writer.rb, line 236
def error(message_object, options = {})
  write ERROR, message_object, options
end
fatal(message_object, options = {}) click to toggle source
# File lib/remexify/remexify_writer.rb, line 240
def fatal(message_object, options = {})
  write FATAL, message_object, options
end
info(message_object, options = {}) click to toggle source
# File lib/remexify/remexify_writer.rb, line 228
def info(message_object, options = {})
  write INFO, message_object, options
end
parse_model_fields(model) click to toggle source
# File lib/remexify/remexify_writer.rb, line 54
def parse_model_fields model
  attributes = {}
  if model.respond_to?(:attribute_names) && model.respond_to?(:read_attribute)
    ar_attributes = model.attribute_names
    ar_attributes.each do |attr|
      attributes[attr.to_s] = model.read_attribute attr.to_sym
    end
    options[:parameters] = attributes
  end
  attributes
end
setup() { |config| ... } click to toggle source
# File lib/remexify.rb, line 15
def setup
  raise "Remexify: do not call setup the second time, use Remexify.config to modify changes if that cannot be made during setup phase" if @already_initialized

  # initialisation
  config.model = nil
  config.model_owner = nil

  config.censor_strings = []

  # do not log exception of which class is listed.
  config.discarded_exceptions = []

  # log only exceptions of which class is listed inside.
  config.accepted_exceptions = []

  yield config
  @already_initialized = true

  # warning if accepted_exceptions is defined but String is not included
  if config.accepted_exceptions.any? && !config.accepted_exceptions.include?(String)
    puts "REMEXIFY: You won't be able to log a String, because it is left out while you defined the `accepted_exceptions'"
  end

  # model must exists as ActiveRecord model. model_owner is not necessary to exists at all
  if defined?(ActiveRecord::Base) && defined?(Mongoid::Document)
    if (config.model < ActiveRecord::Base) || (config.model < Mongoid::Document)
      # good!
    else
      raise "Remexify.config.model is neither an ActiveRecord model or Mongoid::Document"
    end
  elsif defined?(ActiveRecord::Base)
    raise "Remexify.config.model is not an ActiveRecord model" unless config.model < ActiveRecord::Base
  elsif defined?(Mongoid::Document)
    raise "Remexify.config.model is not a Mongoid::Document" unless config.model < Mongoid::Document
  else
    raise "Remexify.config.model is neither an ActiveRecord model or Mongoid::Document"
  end
end
warning(message_object, options = {}) click to toggle source
# File lib/remexify/remexify_writer.rb, line 232
def warning(message_object, options = {})
  write WARNING, message_object, options
end
write(level, message_object, options = {}) click to toggle source

options = class, method, line, file, params/param/parameters, desc/description extract_params_from, object, owned_by, owned_param1, owned_param2, owned_param3

# File lib/remexify/remexify_writer.rb, line 7
    def write(level, message_object, options = {})
      if (message_object.is_a?(StandardError) || message_object.is_a?(RuntimeError)) && message_object.already_logged
        # do not log exception that has been logged
        return
      end

      if Remexify.config.discarded_exceptions.include? message_object.class
        # do not log exception that is explicitly discarded
        return
      end

      if Remexify.config.accepted_exceptions.any? && !Remexify.config.accepted_exceptions.include?(message_object.class)
        # do not log exception when accepted_exceptions has member and that, the class of the message_object
        # is not one of the member of the accepted exceptions
        return
      end

      message = "message is nil"
      backtrace = "backtrace is nil"

      if message_object.class <= Exception
        message = message_object.message
        # censor some text
        backtrace = message_object.backtrace.clone
        if Remexify.config.censor_strings.is_a?(Array)
          Remexify.config.censor_strings.each do |str|
            backtrace.reject! { |b| !((b =~ /#{str}/i).nil?) }
          end
        end
        backtrace = backtrace.join("\n")
      elsif message_object.class <= String
        message = message_object
        backtrace = ""
      end

      backtrace = "null" if backtrace.blank?

      # standardize into options[:parameters]
      options[:parameters] = options[:param] if options[:param]
      options[:parameters] = options[:params] if options[:params]
      options[:parameters] = options[:parameter] if options[:parameter]
      options[:parameters] ||= ""

      # will override the options[:parameters] if this block execute successfully
      if options[:extract_params_from]
        ar_message_objectect = options[:extract_params_from]

        def parse_model_fields model
          attributes = {}
          if model.respond_to?(:attribute_names) && model.respond_to?(:read_attribute)
            ar_attributes = model.attribute_names
            ar_attributes.each do |attr|
              attributes[attr.to_s] = model.read_attribute attr.to_sym
            end
            options[:parameters] = attributes
          end
          attributes
        end

        if defined?(ActiveRecord::Base)
          options[:parameters] = parse_model_fields(ar_message_objectect) if ar_message_objectect.class < ActiveRecord::Base
        end

        if defined?(Mongoid::Document)
          options[:parameters] = parse_model_fields(ar_message_objectect) if ar_message_objectect.class < Mongoid::Document
        end
      end

      # if object is given
      if options[:object]
        parse_error_messages = false
        # and is an active record/mongoid document
        if defined?(ActiveRecord::Base)
          parse_error_messages = true if options[:object].class < ActiveRecord::Base
        end

        if defined?(Mongoid::Document)
          parse_error_messages = true if options[:object].class < Mongoid::Document
        end

        if parse_error_messages
          # append to message
          message << "\n\nerror messages:\n" << options[:object].errors.full_messages.join("\n")
        end
      end

      # standardize into options[:description]
      options[:description] = options[:desc] if options[:desc]
      options[:description] ||= ""

      # class name cannot be blank
      class_name = options[:class]
      class_name = Time.now.strftime("%Y%m%d") if class_name.blank?

      # generate hash
      # strip hex from class in order to increase accuracy of logged error, if any;
      # so: #<#<Class:0x007f9492c00430>:0x007f9434ccab> will just be #<#<Class>>
      message = message.gsub(/:0x[0-9a-fA-F]+/i, "")
      hashed = "#{message}#{class_name}"
      # do not quote md5 directly, it is used to query .where
      md5 = Digest::MD5.hexdigest hashed
      # the quoted version of md5, do not replace the original value
      qmd5 = md5

      # assure md5 is not yet exist, if exist, don't save
      log = config.model.where(md5: md5).first
      if log
        log.frequency += 1
        log.save
      else


        method = line = file = "null"
        if Kernel.respond_to? :caller_locations
          # 2, 1 is the original caller, 2 is the method write() that is called in this very class.
          _caller = Kernel.caller_locations(2, 1)[0]
          method = options[:method].blank? ? _caller.base_label : options.fetch(:method)
          line = options[:line].blank? ? _caller.lineno : options.fetch(:line)
          file = options[:file].blank? ? _caller.absolute_path : options.fetch(:file)
        else
          method = options[:method] unless options[:method].blank?
          line = options[:line] unless options[:line].blank?
          file = options[:file] unless options[:file].blank?
        end

        parameters = options[:parameters].blank? ? "null" : options[:parameters].inspect
        descriptions = options[:description].blank? ? "null" : options[:description]
        time_now = Time.now.strftime("%Y-%m-%d %H:%M:%S")

        if defined?(ActiveRecord::Base)
          if config.model < ActiveRecord::Base
            if config.model.connection.transaction_open?
              config.model.connection.rollback_transaction
            end

            qmd5 = config.model.connection.quote md5
            message = config.model.connection.quote message
            backtrace = config.model.connection.quote backtrace
            class_name = config.model.connection.quote class_name
            method = config.model.connection.quote method
            line = config.model.connection.quote line
            file = config.model.connection.quote file
            parameters = config.model.connection.quote parameters
            descriptions = config.model.connection.quote parameters
            time_now = config.model.connection.quote time_now

            ActiveRecord::Base.transaction do
              config.model.connection.execute <<-SQL
              INSERT INTO #{config.model.table_name} (
               md5, level, message, backtrace,
               class_name, method_name, line, file_name,
               parameters, description, created_at, updated_at)
              VALUES (#{qmd5}, #{Integer level}, #{message}, #{backtrace}, #{class_name},
               #{method}, #{line}, #{file}, #{parameters}, #{descriptions},
               #{time_now}, #{time_now});
              SQL
            end
          end
        elsif defined?(Mongoid::Document)
          if config.model < Mongoid::Document
            new_log = config.model.new
            new_log.md5 = qmd5
            new_log.level = Integer(level)
            new_log.message = message
            new_log.backtrace = backtrace
            new_log.class_name = class_name
            new_log.method_name = method
            new_log.line = line
            new_log.file_name = file
            new_log.parameters = parameters
            new_log.description = descriptions
            new_log.created_at = time_now
            new_log.updated_at = time_now
            new_log.save
          end
        end
      end

      # mark already logged if DisplayableError
      if message_object.is_a?(StandardError) || message_object.is_a?(DisplayableError)
        message_object.already_logged = true
      end

      # if owner_by is given, associate this log to the owned_by user
      unless options[:owned_by].blank?
        owned_by = options[:owned_by]
        owned_param1 = options[:owned_param1]
        owned_param2 = options[:owned_param2]
        owned_param3 = options[:owned_param3]

        if defined?(ActiveRecord::Base)
          if config.model_owner < ActiveRecord::Base
            owned_by = config.model.connection.quote(owned_by)
            owned_param1 = config.model.connection.quote(owned_param1)
            owned_param2 = config.model.connection.quote(owned_param2)
            owned_param3 = config.model.connection.quote(owned_param3)

            # config.model.connection.begin_transaction
            ActiveRecord::Base.transaction do
              config.model.connection.execute <<-SQL
                INSERT INTO #{config.model_owner.table_name} (
                  log_md5, identifier_id, param1, param2, param3)
                VALUES (#{qmd5}, #{owned_by}, #{owned_param1}, #{owned_param2}, #{owned_param3})
              SQL
            end
            # config.model.connection.commit_transaction
          end
        elsif defined?(Mongoid::Document)
          if config.model_owner < Mongoid::Document
            log_owner = config.model_owner.new
            log_owner.owned_by = owned_by
            log_owner.owned_param1 = owned_param1
            log_owner.owned_param2 = owned_param2
            log_owner.owned_param3 = owned_param3
          end
        end
      end

      nil # don't return anything for logging!
    end