File: options.rb

package info (click to toggle)
ruby-train 3.2.28-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,116 kB
  • sloc: ruby: 9,246; sh: 17; makefile: 8
file content (81 lines) | stat: -rw-r--r-- 2,246 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# encoding: utf-8
#
# Author:: Dominik Richter (<dominik.richter@gmail.com>)
# Author:: Christoph Hartmann (<chris@lollyrock.com>)

module Train
  module Options
    def self.attach(target)
      target.class.method(:include).call(ClassOptions)
      target.method(:include).call(InstanceOptions)
    end

    module ClassOptions
      def option(name, conf = nil, &block)
        d = conf || {}
        unless d.is_a? Hash
          raise Train::ClientError,
            "The transport plugin #{self} declared an option #{name} "\
            "and didn't provide a valid configuration hash."
        end

        if !conf.nil? && !conf[:default].nil? && block_given?
          raise Train::ClientError,
            "The transport plugin #{self} declared an option #{name} "\
            "with both a default value and block. Only use one of these."
        end

        d[:default] = block if block_given?

        default_options[name] = d
      end

      def default_options
        @default_options = {} unless defined? @default_options
        @default_options
      end

      def include_options(other)
        unless other.respond_to?(:default_options)
          raise "Trying to include options from module #{other.inspect}, "\
               "which doesn't seem to support options."
        end
        default_options.merge!(other.default_options)
      end
    end

    module InstanceOptions
      # @return [Hash] options, which created this Transport
      attr_reader :options

      def default_options
        self.class.default_options
      end

      def merge_options(base, opts)
        res = base.merge(opts || {})
        default_options.each do |field, hm|
          next unless res[field].nil? && hm.key?(:default)

          default = hm[:default]
          if default.is_a? Proc
            res[field] = default.call(res)
          else
            res[field] = default
          end
        end
        res
      end

      def validate_options(opts)
        default_options.each do |field, hm|
          if opts[field].nil? && hm[:required]
            raise Train::ClientError,
              "You must provide a value for #{field.to_s.inspect}."
          end
        end
        opts
      end
    end
  end
end