All Files
(
100.0%
covered at
12.86
hits/line
)
12 files in total.
176 relevant lines,
176 lines covered and
0 lines missed.
(
100.0%
)
12 total branches,
12 branches covered and
0 branches missed.
(
100.0%
)
-
# frozen_string_literal: true
-
-
1
require "xdg/cache"
-
1
require "xdg/config"
-
1
require "xdg/data"
-
1
require "xdg/environment"
-
1
require "xdg/pair"
-
1
require "xdg/paths/any"
-
1
require "xdg/paths/combined"
-
1
require "xdg/paths/directory"
-
1
require "xdg/paths/home"
-
1
require "xdg/runtime"
-
1
require "xdg/state"
-
-
# Main namespace.
-
1
module XDG
-
1
DELIMITER = "="
-
-
1
def self.new = Environment.new
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
1
require "xdg/pair"
-
-
1
module XDG
-
# Provides cache support.
-
1
class Cache
-
1
extend Forwardable
-
-
1
HOME_PAIR = Pair["XDG_CACHE_HOME", ".cache"].freeze
-
-
1
delegate %i[home directories all to_s to_str] => :combined
-
-
1
def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
-
19
@combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-
directories.new(Pair.new, environment)
-
19
freeze
-
end
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :combined
-
end
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
1
require "xdg/pair"
-
-
1
module XDG
-
# Provides configuration support.
-
1
class Config
-
1
extend Forwardable
-
-
1
HOME_PAIR = Pair["XDG_CONFIG_HOME", ".config"].freeze
-
1
DIRS_PAIR = Pair["XDG_CONFIG_DIRS", "/etc/xdg"].freeze
-
-
1
delegate %i[home directories all to_s to_str] => :combined
-
-
1
def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
-
19
@combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-
directories.new(DIRS_PAIR, environment)
-
19
freeze
-
end
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :combined
-
end
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
1
require "xdg/pair"
-
-
1
module XDG
-
# Provides data support.
-
1
class Data
-
1
extend Forwardable
-
-
1
HOME_PAIR = Pair["XDG_DATA_HOME", ".local/share"].freeze
-
1
DIRS_PAIR = Pair["XDG_DATA_DIRS", "/usr/local/share:/usr/share"].freeze
-
-
1
delegate %i[home directories all to_s to_str] => :combined
-
-
1
def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
-
19
@combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-
directories.new(DIRS_PAIR, environment)
-
19
freeze
-
end
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :combined
-
end
-
end
-
# frozen_string_literal: true
-
-
1
module XDG
-
# A convenience wrapper to all XDG functionality.
-
1
class Environment
-
1
def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
-
12
@cache = Cache.new(home:, directories:, environment:)
-
12
@config = Config.new(home:, directories:, environment:)
-
12
@data = Data.new(home:, directories:, environment:)
-
12
@runtime = Runtime.new(environment:)
-
12
@state = State.new(home:, directories:, environment:)
-
12
freeze
-
end
-
-
1
def cache_home = cache.home
-
-
1
def config_home = config.home
-
-
1
def config_dirs = config.directories
-
-
1
def data_home = data.home
-
-
1
def data_dirs = data.directories
-
-
1
def runtime_dir = runtime.home
-
-
1
def state_home = state.home
-
-
1
def to_s = "#{cache} #{config} #{data} #{runtime} #{state}"
-
-
1
alias to_str to_s
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :cache, :config, :data, :runtime, :state
-
end
-
end
-
# frozen_string_literal: true
-
-
1
module XDG
-
# A generic key-value pair (KVP).
-
1
Pair = Data.define :key, :value do
-
1
def initialize key: nil, value: nil
-
187
super
-
end
-
-
1
def key? = key.to_s.size.positive?
-
-
1
def value? = value.to_s.size.positive?
-
-
5
def empty? = !(key? && value?)
-
-
1
def to_env = {key => value}
-
-
9
then: 6
else: 2
def to_s = key? || value? ? "#{key}#{DELIMITER}#{value}" : ""
-
-
1
alias_method :to_str, :to_s
-
-
1
def inspect
-
4
type = self.class
-
4
then: 3
else: 1
key? || value? ? "#<data #{type} #{key}#{DELIMITER}#{value}>" : "#<data #{type}>"
-
end
-
end
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
-
1
module XDG
-
1
module Paths
-
# A XDG any path.
-
1
class Any
-
1
extend Forwardable
-
-
1
delegate %i[key value] => :pair
-
-
1
def initialize pair, environment = ENV
-
258
@pair = pair
-
258
@environment = environment
-
258
freeze
-
end
-
-
1
def default = expand String(value)
-
-
72
then: 42
else: 29
def dynamic = String(environment[key]).then { |path| path.empty? ? default : expand(path) }
-
-
1
def to_s = [pair.key, dynamic].compact.join XDG::DELIMITER
-
-
1
alias to_str to_s
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
protected
-
-
1
attr_reader :pair, :environment
-
-
85
then: 10
else: 74
def expand(path) = Pathname(path).then { path.empty? ? it : it.expand_path }
-
end
-
end
-
end
-
# frozen_string_literal: true
-
-
1
module XDG
-
1
module Paths
-
# The combined home and directory paths.
-
1
class Combined
-
1
def initialize initial_home, initial_directories
-
106
@initial_home = initial_home
-
106
@initial_directories = initial_directories
-
106
freeze
-
end
-
-
1
def home = initial_home.dynamic
-
-
1
def directories = initial_directories.dynamic
-
-
1
def all = directories.prepend(*home)
-
-
1
def to_s = [initial_home.to_s, initial_directories.to_s].reject(&:empty?).join " "
-
-
1
alias to_str to_s
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :initial_home, :initial_directories
-
end
-
end
-
end
-
# frozen_string_literal: true
-
-
1
module XDG
-
1
module Paths
-
# A collection of XDG directories.
-
1
class Directory < Any
-
1
DELIMITER = ":"
-
-
6
def default = value.split(DELIMITER).map { |path| expand path }
-
-
1
def dynamic
-
130
then: 53
else: 12
String(environment[key]).then { |env_value| env_value.empty? ? value : env_value }
-
.split(DELIMITER)
-
.uniq
-
58
.map { |path| expand path }
-
end
-
-
1
def to_s = [key, dynamic.join(DELIMITER)].reject(&:empty?).join XDG::DELIMITER
-
-
1
alias to_str to_s
-
-
1
def inspect
-
2
pairs = to_s
-
2
type = self.class
-
-
2
then: 1
else: 1
pairs.empty? ? "#<#{type}:#{object_id}>" : "#<#{type}:#{object_id} #{self}>"
-
end
-
-
1
def key = String pair.key
-
-
1
def value = String pair.value
-
end
-
end
-
end
-
# frozen_string_literal: true
-
-
1
module XDG
-
1
module Paths
-
# A XDG home path.
-
1
class Home < Any
-
1
KEY = "HOME"
-
-
1
def initialize pair, environment = ENV, default_key: KEY
-
102
@default_key = default_key
-
102
super(pair, environment)
-
end
-
-
1
protected
-
-
1
def expand(path) = home.join(path).expand_path
-
-
1
def home = Pathname environment.fetch(default_key)
-
-
1
private
-
-
1
attr_reader :default_key
-
end
-
end
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
1
require "xdg/pair"
-
-
1
module XDG
-
# Provides runtime support.
-
1
class Runtime
-
1
extend Forwardable
-
-
1
HOME_PAIR = Pair["XDG_RUNTIME_DIR", nil].freeze
-
-
1
delegate %i[home directories all to_s to_str] => :combined
-
-
1
def initialize home: Paths::Any, directories: Paths::Directory, environment: ENV
-
19
@combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-
directories.new(Pair.new, environment)
-
19
freeze
-
end
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :combined
-
end
-
end
-
# frozen_string_literal: true
-
-
1
require "forwardable"
-
1
require "xdg/pair"
-
-
1
module XDG
-
# Provides state support.
-
1
class State
-
1
extend Forwardable
-
-
1
HOME_PAIR = Pair["XDG_STATE_HOME", ".local/state"].freeze
-
-
1
delegate %i[home directories all to_s to_str] => :combined
-
-
1
def initialize home: Paths::Home, directories: Paths::Directory, environment: ENV
-
19
@combined = Paths::Combined.new home.new(HOME_PAIR, environment),
-
directories.new(Pair.new, environment)
-
19
freeze
-
end
-
-
1
def inspect = "#<#{self.class}:#{object_id} #{self}>"
-
-
1
private
-
-
1
attr_reader :combined
-
end
-
end
