Class: SystemSettings::Configurator

Inherits:
Object
  • Object
show all
Defined in:
app/models/system_settings/configurator.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(kernel_class: Kernel, &block) ⇒ Configurator

Returns a new instance of Configurator.



25
26
27
28
29
30
31
32
33
34
 
# File 'app/models/system_settings/configurator.rb', line 25

def initialize(kernel_class: Kernel, &block)
  @items = []
  @kernel_class = kernel_class
  return unless block_given?
  if block.arity == 1
    yield self
  else
    instance_exec(&block)
  end
end

Instance Attribute Details

#items ⇒ Object (readonly)

Returns the value of attribute items.



23
24
25
 
# File 'app/models/system_settings/configurator.rb', line 23

def items
  @items
end

Class Method Details

.from_file(file_name, kernel_class: Kernel) ⇒ Object

Raises:



4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'app/models/system_settings/configurator.rb', line 4

def from_file(file_name, kernel_class: Kernel)
  file_name = file_name.to_path if file_name.respond_to?(:to_path)
  raise Errors::SettingsReadError, "The file name must either be a String or implement #to_path" unless file_name.is_a?(String)
  raise Errors::SettingsReadError, "#{file_name} file does not exist" unless File.exist?(file_name)
  raise Errors::SettingsReadError, "#{file_name} file not readable" unless File.readable?(file_name)
  SystemSettings.instrument("system_settings.from_file", path: file_name) do |payload|
    file_content = File.read(file_name)
    new(kernel_class: kernel_class).tap do |obj|
      obj.instance_eval(file_content, file_name, 1)
      payload[:items] = obj.items
    end
  end
end

.purge ⇒ Object 



18
19
20
 
# File 'app/models/system_settings/configurator.rb', line 18

def purge
  new.purge
end

Instance Method Details

#boolean(name, value: nil, description: nil, &blk) ⇒ Object 



52
53
54
 
# File 'app/models/system_settings/configurator.rb', line 52

def boolean(name, value: nil, description: nil, &blk)
  add(name, SystemSettings::BooleanSetting, value: value, description: description, &blk)
end

#integer(name, value: nil, description: nil, &blk) ⇒ Object 



44
45
46
 
# File 'app/models/system_settings/configurator.rb', line 44

def integer(name, value: nil, description: nil, &blk)
  add(name, SystemSettings::IntegerSetting, value: value, description: description, &blk)
end

#integer_list(name, value: nil, description: nil, &blk) ⇒ Object 



48
49
50
 
# File 'app/models/system_settings/configurator.rb', line 48

def integer_list(name, value: nil, description: nil, &blk)
  add(name, SystemSettings::IntegerListSetting, value: value || [], description: description, &blk)
end

#persist ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'app/models/system_settings/configurator.rb', line 56

def persist
  SystemSettings.instrument("system_settings.persist", items: @items) do |payload|
    if settings_table_exists?
      SystemSettings::Setting.transaction do
        @items.each do |entry|
          persisted_record = SystemSettings::Setting.find_by(name: entry[:name])
          if persisted_record
            if persisted_record.class == entry[:class]
              persisted_record.update!(description: entry[:description])
            else
              warn "SystemSettings: Type mismatch detected! Previously #{entry[:name]} had type #{persisted_record.class.name} but you are loading #{entry[:class].name}"
            end
          else
            entry[:class].create!(name: entry[:name], value: entry[:value], description: entry[:description])
          end
        end
      end
      payload[:success] = true
    else
      warn "SystemSettings: Settings table has not been created!"
      payload[:success] = false
    end
  end
end

#purge ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'app/models/system_settings/configurator.rb', line 81

def purge
  SystemSettings.instrument("system_settings.purge") do |payload|
    if settings_table_exists?
      SystemSettings::Setting.delete_all
      payload[:success] = true
    else
      payload[:success] = false
    end
  end
end

#string(name, value: nil, description: nil, &blk) ⇒ Object 



36
37
38
 
# File 'app/models/system_settings/configurator.rb', line 36

def string(name, value: nil, description: nil, &blk)
  add(name, SystemSettings::StringSetting, value: value, description: description, &blk)
end

#string_list(name, value: nil, description: nil, &blk) ⇒ Object 



40
41
42
 
# File 'app/models/system_settings/configurator.rb', line 40

def string_list(name, value: nil, description: nil, &blk)
  add(name, SystemSettings::StringListSetting, value: value || [], description: description, &blk)
end