File: task.rb

package info (click to toggle)
ruby-benchmark-memory 0.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 300 kB
  • sloc: ruby: 1,121; makefile: 7; sh: 4
file content (52 lines) | stat: -rw-r--r-- 1,373 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# frozen_string_literal: true

require 'memory_profiler'
require 'benchmark/memory/measurement'

module Benchmark
  module Memory
    class Job
      # Hold a labelled job for later measurement.
      class Task
        # Instantiate a job task for later measurement.
        #
        # @param label [#to_s] The label for the benchmark.
        # @param action [#call] The code to be measured.
        #
        # @raise [ArgumentError] if the action does not respond to `#call`.
        def initialize(label, action)
          unless action.respond_to?(:call)
            raise(
              ArgumentError,
              "Invalid action (#{@action.inspect} does not respond to call)"
            )
          end

          @label = label
          @action = action
        end

        # @return [#call] The code to be measured.
        attr_reader :action

        # @return [#to_s] The label for the benchmark.
        attr_reader :label

        # Call the action and report on its memory usage.
        #
        # @return [Measurement] the memory usage measurement of the code.
        def call
          result = while_measuring_memory_usage { action.call }

          Measurement.from_result(result)
        end

        private

        def while_measuring_memory_usage(&block)
          MemoryProfiler.report({}, &block)
        end
      end
    end
  end
end