summaryrefslogtreecommitdiff
path: root/lib/mixlib/config/configurable.rb
blob: 02081df9bb07e284bd7fc58ef14fea6aabfddc86 (plain)
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
82
83
84
#
# Author:: John Keiser (<jkeiser@opscode.com>)
# Copyright:: Copyright (c) 2013 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

module Mixlib
  module Config
    class Configurable
      def initialize(symbol)
        @symbol = symbol
        @default = nil
        @has_default = false
        @default_value = nil
        @writes_value = nil
      end

      def defaults_to(default_value = nil, &block)
        @has_default = true
        @default = block
        @default_value = default_value
        self
      end

      def writes_value(&block)
        @writes_value = block
        self
      end

      def get(config)
        if config.has_key?(@symbol)
          config[@symbol]
        elsif @default
          @default.call
        elsif @default_value.is_a?(::Mixlib::Config)
          # Don't dup config_contexts
          @default_value
        else
          begin
            # Some things cannot be dup'd, and you won't know this till after the fact
            # because all values implement dup
            config[@symbol] = @default_value.dup
          rescue TypeError
            @default_value
          end
        end
      end

      def set(config, value)
        config[@symbol] = @writes_value ? @writes_value.call(value) : value
      end

      # Sets the saved value into the result hash.  Don't bother stashing defaults away or duping them.
      def save(config, result, include_defaults)
        if config.has_key?(@symbol)
          result[@symbol] = config[@symbol]
        elsif @default_value.is_a?(::Mixlib::Config)
          saved_context = @default_value.save(include_defaults)
          if saved_context != {} || include_defaults
            result[@symbol] = saved_context
          end
        elsif include_defaults && @has_default
          if @default
            result[@symbol] = @default.call
          else
            result[@symbol] = @default_value
          end
        end
      end
    end
  end
end