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(&block) ⇒ Configurator

Returns a new instance of Configurator.



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

def initialize(&block)
  @items = []
  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) ⇒ 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)
  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.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 



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

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 



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

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 



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

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

#persist ⇒ Object 



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

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 = entry[:class].find_by(name: entry[:name])
          if persisted_record
            persisted_record.update!(description: entry[:description])
          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 



76
77
78
79
80
81
82
83
84
85
 
# File 'app/models/system_settings/configurator.rb', line 76

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 



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

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 



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

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