module DataPaths::Methods

Public Instance Methods

data_paths() click to toggle source

The directories registered within a specific module or class.

@return [Array<String>]

The directories registered so far.
# File lib/data_paths/methods.rb, line 9
def data_paths
  @data_paths ||= []
end
register_data_dir(path) click to toggle source

@deprecated

Will be removed 1.0.0, please use {#register_data_path} instead.
# File lib/data_paths/methods.rb, line 43
def register_data_dir(path)
  STDERR.puts "DEPRECATED: Please use register_data_path instead."

  register_data_path(path)
end
register_data_path(path) click to toggle source

Registers a path as a data directory.

@param [String] path

The path to add to {DataPaths.paths}.

@return [String]

The fully qualified form of the specified path.

@example

register_data_dir File.join(File.dirname(__FILE__),'..','..','..','data')

@raise [RuntimeError]

The specified path is not a directory.

@since 0.3.0

# File lib/data_paths/methods.rb, line 30
def register_data_path(path)
  path = File.expand_path(path)

  DataPaths.register(path)

  data_paths << path unless data_paths.include?(path)
  return path
end
unregister_data_dir!(path) click to toggle source

@deprecated

Will be removed 1.0.0, please use {#unregister_data_path} instead.
# File lib/data_paths/methods.rb, line 71
def unregister_data_dir!(path)
  STDERR.puts "DEPRECATED: Please use unregister_data_path instead."

  unregister_data_path(path)
end
unregister_data_dirs!() click to toggle source

@deprecated

Will be removed 1.0.0, please use {#unregister_data_paths} instead.
# File lib/data_paths/methods.rb, line 95
def unregister_data_dirs!
  STDERR.puts "DEPRECATED: Please use unregister_data_paths instead."

  unregister_data_paths
end
unregister_data_path(path) click to toggle source

Unregisters any matching data directories.

@param [String] path

The path to unregister.

@return [String]

The unregistered data path.

@since 0.3.0

# File lib/data_paths/methods.rb, line 60
def unregister_data_path(path)
  path = File.expand_path(path)

  self.data_paths.delete(path)
  return DataPaths.unregister!(path)
end
unregister_data_paths() click to toggle source

Unregisters all previously registered data directories.

@return [true]

Specifies all data paths were successfully unregistered.

@since 0.3.0

# File lib/data_paths/methods.rb, line 85
def unregister_data_paths
  data_paths.each { |path| DataPaths.unregister!(path) }
  data_paths.clear
  return true
end