class Asetus

@example common use case

CFGS = Asetus.new :name=>'my_sweet_program' :load=>false   # do not load config from filesystem
CFGS.default.ssh.port      = 22
CFGS.default.ssh.hosts     = %w(host1.example.com host2.example.com)
CFGS.default.auth.user     = lana
CFGS.default.auth.password = dangerzone
CFGS.load  # load system config and user config from filesystem and merge with defaults to #cfg
raise StandardError, 'edit ~/.config/my_sweet_program/config' if CFGS.create  # create user config from default config if no system or user config exists
# use the damn thing
CFG = CFGS.cfg
user      = CFG.auth.user
password  = CFG.auth.password
ssh_port  = CFG.ssh.port
ssh_hosts = CFG.ssh.hosts

Constants

CONFIG_FILE

Attributes

cfg[R]

default[R]

file[R]

system[RW]

user[RW]

Public Class Methods

cfg(*args) click to toggle source

# File lib/asetus.rb, line 31
def cfg *args
  new(*args).cfg
end

new(opts = {}) click to toggle source

@param [Hash] opts options for Asetus.new @option opts [String] :name name to use for asetus (/etc/name/, ~/.config/name/) - autodetected if not defined @option opts [String] :adapter adapter to use ‘yaml’, ‘json’ or ‘toml’ for now @option opts [String] :usrdir directory for storing user config ~/.config/name/ by default @option opts [String] :sysdir directory for storing system config /etc/name/ by default @option opts [String] :cfgfile configuration filename, by default CONFIG_FILE @option opts [Hash] :default default settings to use @option opts [boolean] :load automatically load+merge system+user config with defaults in cfg @option opts [boolean] :key_to_s convert keys to string by calling to_s for keys

# File lib/asetus.rb, line 98
def initialize(opts = {})
  @name     = (opts.delete(:name)    or metaname)
  @adapter  = (opts.delete(:adapter) or 'yaml')
  @usrdir   = (opts.delete(:usrdir)  or File.join(Dir.home, '.config', @name))
  @sysdir   = (opts.delete(:sysdir)  or File.join('/etc', @name))
  @cfgfile  = (opts.delete(:cfgfile) or CONFIG_FILE)
  @default  = ConfigStruct.new opts.delete(:default)
  @system   = ConfigStruct.new
  @user     = ConfigStruct.new
  @cfg      = ConfigStruct.new
  @load     = true
  @load     = opts.delete(:load) if opts.has_key?(:load)
  @key_to_s = opts.delete(:key_to_s)
  raise UnknownOption, "option '#{opts}' not recognized" unless opts.empty?

  load :all if @load
end

Public Instance Methods

create(opts = {}) click to toggle source

@example create user config from default config and raise error, if no config was found

raise StandardError, 'edit ~/.config/name/config' if asetus.create

@param [Hash] opts options for Asetus @option opts [Symbol] :source source to use for settings to save, by default :default @option opts [Symbol] :destination destination to use for settings to save, by default :user @option opts [boolean] :load load config once saved, by default false @return [boolean] true if config didn’t exist and was created, false if config already exists

# File lib/asetus.rb, line 71
def create(opts = {})
  src   = opts.delete :source
  src ||= :default
  dst   = opts.delete :destination
  dst ||= :user
  no_config = false
  no_config = true if @system.empty? && @user.empty?
  if no_config
    src = instance_variable_get '@' + src.to_s
    instance_variable_set('@' + dst.to_s, src.dup)
    save dst
    load if opts.delete :load
  end
  no_config
end

from_json(json) click to toggle source

# File lib/asetus/adapter/json.rb, line 6
def from_json(json)
  Adapter::JSON.from json
end

from_toml(toml) click to toggle source

# File lib/asetus/adapter/toml.rb, line 6
def from_toml(toml)
  Adapter::TOML.from toml
end

from_yaml(yaml) click to toggle source

# File lib/asetus/adapter/yaml.rb, line 6
def from_yaml(yaml)
  Adapter::YAML.from yaml
end

load(level = :all) click to toggle source

When this is called, by default :system and :user are loaded from filesystem and merged with default, so that user overrides system which overrides default

@param [Symbol] level which configuration level to load, by default :all @return [void]

# File lib/asetus.rb, line 42
def load(level = :all)
  @cfg = merge @cfg, @default if %i[default all].include?(level)
  if %i[system all].include?(level)
    @system = load_cfg @sysdir
    @cfg = merge @cfg, @system
  end
  return unless %i[user all].include?(level)

  @user = load_cfg @usrdir
  @cfg = merge @cfg, @user
end

save(level = :user) click to toggle source

@param [Symbol] level which configuration level to save, by default :user @return [void]

# File lib/asetus.rb, line 56
def save(level = :user)
  if level == :user
    save_cfg @usrdir, @user
  elsif level == :system
    save_cfg @sysdir, @system
  end
end

to_json(config) click to toggle source

# File lib/asetus/adapter/json.rb, line 2
def to_json(config)
  Adapter::JSON.to config._asetus_to_hash
end

to_toml(config) click to toggle source

# File lib/asetus/adapter/toml.rb, line 2
def to_toml(config)
  Adapter::TOML.to config._asetus_to_hash
end

to_yaml(config) click to toggle source

# File lib/asetus/adapter/yaml.rb, line 2
def to_yaml(config)
  Adapter::YAML.to config._asetus_to_hash
end

Private Instance Methods

from(adapter, string) click to toggle source

# File lib/asetus.rb, line 139
def from(adapter, string)
  name = 'from_' + adapter
  send name, string
end

load_cfg(dir) click to toggle source

# File lib/asetus.rb, line 116
def load_cfg(dir)
  @file = File.join dir, @cfgfile
  file = File.read @file
  ConfigStruct.new(from(@adapter, file), key_to_s: @key_to_s)
rescue Errno::ENOENT
  ConfigStruct.new
end

merge(*configs) click to toggle source

# File lib/asetus.rb, line 131
def merge *configs
  hash = {}
  configs.each do |config|
    hash = hash._asetus_deep_merge config._asetus_to_hash
  end
  ConfigStruct.new hash
end

metaname() click to toggle source

# File lib/asetus.rb, line 149
def metaname
  path = caller_locations[-1].path
  File.basename path, File.extname(path)
rescue StandardError
  raise NoName, "can't figure out name, specify explicitly"
end

save_cfg(dir, config) click to toggle source

# File lib/asetus.rb, line 124
def save_cfg(dir, config)
  config = to(@adapter, config)
  file   = File.join dir, @cfgfile
  FileUtils.mkdir_p dir
  File.write file, config
end

to(adapter, config) click to toggle source

# File lib/asetus.rb, line 144
def to(adapter, config)
  name = 'to_' + adapter
  send name, config
end