michaelmior / NoSE

lib/nose/timing.rb

# frozen_string_literal: true

module NoSE
  # Tracks the runtime of various functions and outputs a measurement
  class Timer
    # Start tracking function runtime
    # @return [void]
    def self.enable

This method is 46 lines long. Your coding style permits a maximum length of 20.

The Assignment, Branch, Condition size for enable is considered too high. [<14, 19, 3> 23.79/20]. The ABC size is based on assignments, branches (method calls), and conditions.

      traced = {
        IndexEnumerator => [

Use %i or %I for an array of symbols.

          :indexes_for_workload,
          :support_indexes,
          :combine_indexes
        ],
        Search::Search => [

Use %i or %I for an array of symbols.

          :query_costs,
          :update_costs,
          :search_overlap,
          :solve_mipper
        ],
        Search::Problem => [

Use %i or %I for an array of symbols.

          :setup_model,
          :add_variables,
          :add_constraints,
          :define_objective,
          :total_cost,
          :add_update_costs,
          :total_size,
          :total_indexes,
          :solve
        ],
        MIPPeR::CbcModel => [

Use %i or %I for an array of symbols.

          :add_constraints,
          :add_variables,
          :update,
          :optimize
        ]
      }
      @old_methods = Hash.new { |h, k| h[k] = {} }

      # Redefine each method to capture timing information on each call
      traced.each do |cls, methods|
        methods.each do |method|
          old_method = cls.instance_method(method)
          cls.send(:define_method, method) do |*args|
            $stderr.puts "#{cls}##{method}\tSTART"

Use warn instead of $stderr.puts to allow such output to be disabled.

            start = Time.now.utc
            result = old_method.bind(self).call(*args)
            elapsed = Time.now.utc - start

            # Allow a block to be called with the timing results
            yield cls, method, elapsed if block_given?

            $stderr.puts "#{cls}##{method}\tEND\t#{elapsed}"

Use warn instead of $stderr.puts to allow such output to be disabled.

            result
          end

          # Save a copy of the old method for later
          @old_methods[cls][method] = old_method
        end
      end
    end

    # Stop tracking function runtime
    # @return [void]
    def self.disable
      @old_methods.each do |cls, methods|
        methods.each do |method, old_method|
          cls.send(:define_method, method, old_method)
        end
      end

      # Remove the saved method definitions
      @old_methods.clear
    end
  end
end