Spec-Zone.ru › Ruby 2.7

class ENV

Parent:
Object

ENV — это подобный хешу аксессор для переменных окружения.

Взаимодействие с операционной системой

Объект ENV взаимодействует с переменными окружения операционной системы:

  • При получении значения для имени в ENV, значение извлекается из текущих переменных окружения.

  • При создании или установке пары имя-значение в ENV, имя и значение немедленно устанавливаются в переменные окружения.

  • При удалении пары имя-значение в ENV, она немедленно удаляется из переменных окружения.

Имена и значения

Как правило, имя или значение является String.

Допустимые имена и значения

Каждое имя или значение должно быть одним из следующих:

  • A String.

  • Объект, который отвечает на #to_str, возвращая String, в этом случае этот String будет использован как имя или значение.

Недопустимые имена и значения

Новое имя:

  • Не может быть пустой строкой:

    ENV[''] = '0'
    # Raises Errno::EINVAL (Invalid argument - ruby_setenv())
    
  • Не может содержать символ "=":

    ENV['='] = '0'
    # Raises Errno::EINVAL (Invalid argument - ruby_setenv(=))
    

Новое имя или значение:

  • Не может быть не-строкой, которая не отвечает на #to_str:

    ENV['foo'] = Object.new
    # Raises TypeError (no implicit conversion of Object into String)
    ENV[Object.new] = '0'
    # Raises TypeError (no implicit conversion of Object into String)
    
  • Не может содержать нулевой символ "\0":

    ENV['foo'] = "\0"
    # Raises ArgumentError (bad environment variable value: contains null byte)
    ENV["\0"] == '0'
    # Raises ArgumentError (bad environment variable name: contains null byte)
    
  • Не может иметь кодировку, несовместимую с ASCII, такую как UTF-16LE или ISO-2022-JP:

    ENV['foo'] = '0'.force_encoding(Encoding::ISO_2022_JP)
    # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP)
    ENV["foo".force_encoding(Encoding::ISO_2022_JP)] = '0'
    # Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: ISO-2022-JP)
    

О порядке

ENV перечисляет пары имя/значение в порядке, найденном в переменных окружения операционной системы. Следовательно, порядок содержимого ENV зависит от ОС и может быть неопределенным.

Это будет видно в:

  • Хеше Hash, возвращаемом методом ENV.

  • Итераторе Enumerator, возвращаемом методом ENV.

  • Массиве Array, возвращаемом методами ENV.keys, ENV.values или ENV.to_a.

  • Строке String, возвращаемой методом ENV.inspect.

  • Массиве Array, возвращаемом методом ENV.shift.

  • Имени, возвращаемом методом ENV.key.

О примерах

Некоторые методы в ENV возвращают сам ENV. Обычно переменных окружения много. Выводить большой ENV в примерах не имеет смысла, поэтому большинство примеров начинают с сброса содержимого ENV:

  • Метод ENV.replace заменяет ENV новой коллекцией записей.

  • Метод ENV.clear очищает ENV.

Публичные методы класса

ENV[name] → value Show source
static VALUE
rb_f_getenv(VALUE obj, VALUE name)
{
    const char *nam, *env;

    nam = env_name(name);
    env = getenv(nam);
    if (env) {
        return env_name_new(nam, env);
    }
    return Qnil;
}

Возвращает значение для переменной окружения name если она существует:

ENV['foo'] = '0'
ENV['foo'] # => "0"

Возвращает nil, если указанная переменная не существует:

ENV.clear
ENV['foo'] # => nil

Вызывает исключение, если name неверно. Смотрите Недопустимые имена и значения.

ENV[name] = value → value Show source
static VALUE
env_aset_m(VALUE obj, VALUE nm, VALUE val)
{
    return env_aset(nm, val);
}

ENV.store является псевдонимом для ENV.[]=.

Создает, обновляет или удаляет именованную переменную окружения, возвращая значение. И name и value могут быть экземплярами String. Смотрите Допустимые имена и значения.

  • Если именованная переменная окружения не существует:

    • Если value nil, ничего не делает.

      ENV.clear
      ENV['foo'] = nil # => nil
      ENV.include?('foo') # => false
      ENV.store('bar', nil) # => nil
      ENV.include?('bar') # => false
      
    • Если value не nil, создает переменную окружения с name и value:

      # Create 'foo' using ENV.[]=.
      ENV['foo'] = '0' # => '0'
      ENV['foo'] # => '0'
      # Create 'bar' using ENV.store.
      ENV.store('bar', '1') # => '1'
      ENV['bar'] # => '1'
      
  • Если именованная переменная окружения существует:

    • Если value не nil, обновляет переменную окружения со значением value:

      # Update 'foo' using ENV.[]=.
      ENV['foo'] = '2' # => '2'
      ENV['foo'] # => '2'
      # Update 'bar' using ENV.store.
      ENV.store('bar', '3') # => '3'
      ENV['bar'] # => '3'
      
    • Если value nil, удаляет переменную окружения:

      # Delete 'foo' using ENV.[]=.
      ENV['foo'] = nil # => nil
      ENV.include?('foo') # => false
      # Delete 'bar' using ENV.store.
      ENV.store('bar', nil) # => nil
      ENV.include?('bar') # => false
      

Вызывает исключение, если name или value неверно. Смотрите Недопустимые имена и значения.

assoc(name) → Array or nil Show source
static VALUE
env_assoc(VALUE env, VALUE key)
{
    const char *s, *e;

    s = env_name(key);
    e = getenv(s);
    if (e) return rb_assoc_new(key, env_str_new2(e));
    return Qnil;
}

Возвращает 2-элементный Array, содержащий имя и значение переменной окружения для name если она существует:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.assoc('foo') # => ['foo' '0']

Возвращает nil, если name является допустимой String и такой переменной окружения нет:

ENV.assoc('baz') # => false

Возвращает nil, если name является пустой String или String, содержащей символ '=':

ENV.assoc('') # => false
ENV.assoc('=') # => false

Вызывает исключение, если name является String, содержащей символ NUL "\0":

ENV.assoc("\0") # Raises ArgumentError (bad environment variable name: contains null byte)

Вызывает исключение, если name имеет кодировку, несовместимую с ASCII:

ENV.assoc("\xa1\xa1".force_encoding(Encoding::UTF_16LE))
# Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: UTF-16LE)

Вызывает исключение, если name не является строкой:

ENV.assoc(Object.new) # TypeError (no implicit conversion of Object into String)
clear → ENV Show source
static VALUE
env_clear(VALUE _)
{
    return rb_env_clear();
}

Удаляет все переменные окружения; возвращает ENV:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.size # => 2
ENV.clear # => ENV
ENV.size # => 0
delete(name) → value Show source
delete(name) { |name| block } → value
static VALUE
env_delete_m(VALUE obj, VALUE name)
{
    VALUE val;

    val = env_delete(name);
    if (NIL_P(val) && rb_block_given_p()) rb_yield(name);
    return val;
}

Удаляет переменную окружения с name, если она существует, и возвращает её значение:

ENV['foo'] = '0'
ENV.delete('foo') # => '0'

Возвращает nil, если именованной переменной окружения не существует:

ENV.delete('foo') # => nil

Если блок задан, а переменной окружения не существует, передает name в блок и возвращает nil:

ENV.delete('foo') { |name| puts name } # => nil
foo

Если блок задан, а переменная окружения существует, удаляет переменную окружения и возвращает её значение (игнорируя блок):

ENV['foo'] = '0'
ENV.delete('foo') { |name| fail 'ignored' } # => "0"

Вызывает исключение, если name неверно. Смотрите Недопустимые имена и значения.

delete_if { |name, value| block } → ENV Show source
delete_if → Enumerator
static VALUE
env_delete_if(VALUE ehash)
{
    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    env_reject_bang(ehash);
    return envtbl;
}

Удаляет все переменные окружения, для которых блок возвращает true.

Если блок не задан, вместо этого возвращается перечислитель.

each { |name, value| block } → ENV Show source
each → Enumerator
each_pair { |name, value| block } → ENV
each_pair → Enumerator
static VALUE
env_each_pair(VALUE ehash)
{
    char **env;
    VALUE ary;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);

    ary = rb_ary_new();
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s) {
            rb_ary_push(ary, env_str_new(*env, s-*env));
            rb_ary_push(ary, env_str_new2(s+1));
        }
        env++;
    }
    FREE_ENVIRON(environ);

    if (rb_block_arity() > 1) {
        for (i=0; i<RARRAY_LEN(ary); i+=2) {
            rb_yield_values(2, RARRAY_AREF(ary, i), RARRAY_AREF(ary, i+1));
        }
    }
    else {
        for (i=0; i<RARRAY_LEN(ary); i+=2) {
            rb_yield(rb_assoc_new(RARRAY_AREF(ary, i), RARRAY_AREF(ary, i+1)));
        }
    }
    return ehash;
}

Передает каждое имя переменной окружения и её значение как 2-элементный массив:

h = {}
ENV.each_pair { |name, value| h[name] = value } # => ENV
h # => {"bar"=>"1", "foo"=>"0"}

Возвращает Enumerator, если блок не задан:

h = {}
e = ENV.each_pair # => #<Enumerator: {"bar"=>"1", "foo"=>"0"}:each_pair>
e.each { |name, value| h[name] = value } # => ENV
h # => {"bar"=>"1", "foo"=>"0"}
each_key { |name| block } → ENV Show source
each_key → Enumerator
static VALUE
env_each_key(VALUE ehash)
{
    VALUE keys;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    keys = env_keys();
    for (i=0; i<RARRAY_LEN(keys); i++) {
        rb_yield(RARRAY_AREF(keys, i));
    }
    return ehash;
}

Передает каждое имя переменной окружения:

ENV.replace('foo' => '0', 'bar' => '1') # => ENV
names = []
ENV.each_key { |name| names.push(name) } # => ENV
names # => ["bar", "foo"]

Возвращает Enumerator, если блок не задан:

e = ENV.each_key # => #<Enumerator: {"bar"=>"1", "foo"=>"0"}:each_key>
names = []
e.each { |name| names.push(name) } # => ENV
names # => ["bar", "foo"]
each_pair { |name, value| block } → ENV Show source
each_pair → Enumerator
static VALUE
env_each_pair(VALUE ehash)
{
    char **env;
    VALUE ary;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);

    ary = rb_ary_new();
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s) {
            rb_ary_push(ary, env_str_new(*env, s-*env));
            rb_ary_push(ary, env_str_new2(s+1));
        }
        env++;
    }
    FREE_ENVIRON(environ);

    if (rb_block_arity() > 1) {
        for (i=0; i<RARRAY_LEN(ary); i+=2) {
            rb_yield_values(2, RARRAY_AREF(ary, i), RARRAY_AREF(ary, i+1));
        }
    }
    else {
        for (i=0; i<RARRAY_LEN(ary); i+=2) {
            rb_yield(rb_assoc_new(RARRAY_AREF(ary, i), RARRAY_AREF(ary, i+1)));
        }
    }
    return ehash;
}

Передает каждое имя переменной окружения и её значение как 2-элементный массив:

h = {}
ENV.each_pair { |name, value| h[name] = value } # => ENV
h # => {"bar"=>"1", "foo"=>"0"}

Возвращает Enumerator, если блок не задан:

h = {}
e = ENV.each_pair # => #<Enumerator: {"bar"=>"1", "foo"=>"0"}:each_pair>
e.each { |name, value| h[name] = value } # => ENV
h # => {"bar"=>"1", "foo"=>"0"}
each_value { |value| block } → ENV Show source
each_value → Enumerator
static VALUE
env_each_value(VALUE ehash)
{
    VALUE values;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    values = env_values();
    for (i=0; i<RARRAY_LEN(values); i++) {
        rb_yield(RARRAY_AREF(values, i));
    }
    return ehash;
}

Передает каждое значение переменной окружения:

ENV.replace('foo' => '0', 'bar' => '1') # => ENV
values = []
ENV.each_value { |value| values.push(value) } # => ENV
values # => ["1", "0"]

Возвращает Enumerator, если блок не задан:

e = ENV.each_value # => #<Enumerator: {"bar"=>"1", "foo"=>"0"}:each_value>
values = []
e.each { |value| values.push(value) } # => ENV
values # => ["1", "0"]
empty? → true or false Show source
static VALUE
env_empty_p(VALUE _)
{
    char **env;

    env = GET_ENVIRON(environ);
    if (env[0] == 0) {
        FREE_ENVIRON(environ);
        return Qtrue;
    }
    FREE_ENVIRON(environ);
    return Qfalse;
}

Возвращает true, когда нет переменных окружения

fetch(name) → value Show source
fetch(name, default) → value
fetch(name) { |name| block } → value
static VALUE
env_fetch(int argc, VALUE *argv, VALUE _)
{
    VALUE key;
    long block_given;
    const char *nam, *env;

    rb_check_arity(argc, 1, 2);
    key = argv[0];
    block_given = rb_block_given_p();
    if (block_given && argc == 2) {
        rb_warn("block supersedes default value argument");
    }
    nam = env_name(key);
    env = getenv(nam);
    if (!env) {
        if (block_given) return rb_yield(key);
        if (argc == 1) {
            rb_key_err_raise(rb_sprintf("key not found: \"%"PRIsVALUE"\"", key), envtbl, key);
        }
        return argv[1];
    }
    return env_name_new(nam, env);
}

Если name является именем переменной окружения, возвращает её значение:

ENV['foo'] = '0'
ENV.fetch('foo') # => '0'

Иначе, если блок задан (но не значение по умолчанию), передает name в блок и возвращает значение, возвращаемое блоком:

ENV.fetch('foo') { |name| :need_not_return_a_string } # => :need_not_return_a_string

Иначе, если задано значение по умолчанию (но не блок), возвращает значение по умолчанию:

ENV.delete('foo')
ENV.fetch('foo', :default_need_not_be_a_string) # => :default_need_not_be_a_string

Если переменной окружения не существует, и заданы и значение по умолчанию, и блок, выдает предупреждение («warning: block supersedes default value argument»), передает name в блок и возвращает значение, возвращаемое блоком:

ENV.fetch('foo', :default) { |name| :block_return } # => :block_return

Вызывает KeyError, если name допустимо, но не найдено, и не задано ни значение по умолчанию, ни блок:

ENV.fetch('foo') # Raises KeyError (key not found: "foo")

Вызывает исключение, если name неверно. Смотрите Недопустимые имена и значения.

filter { |name, value| block } → Hash Show source
filter → Enumerator
static VALUE
env_select(VALUE ehash)
{
    VALUE result;
    VALUE keys;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    result = rb_hash_new();
    keys = env_keys();
    for (i = 0; i < RARRAY_LEN(keys); ++i) {
        VALUE key = RARRAY_AREF(keys, i);
        VALUE val = rb_f_getenv(Qnil, key);
        if (!NIL_P(val)) {
            if (RTEST(rb_yield_values(2, key, val))) {
                rb_hash_aset(result, key, val);
            }
        }
    }
    RB_GC_GUARD(keys);

    return result;
}

Возвращает копию окружения для записей, где блок возвращает true.

Возвращает Enumerator, если блок не был задан.

ENV.filter является псевдонимом для ENV.select.

filter! { |name, value| block } → ENV or nil Показать исходный код
filter! → Enumerator
static VALUE
env_select_bang(VALUE ehash)
{
    VALUE keys;
    long i;
    int del = 0;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    keys = env_keys();
    RBASIC_CLEAR_CLASS(keys);
    for (i=0; i<RARRAY_LEN(keys); i++) {
        VALUE val = rb_f_getenv(Qnil, RARRAY_AREF(keys, i));
        if (!NIL_P(val)) {
            if (!RTEST(rb_yield_values(2, RARRAY_AREF(keys, i), val))) {
                env_delete(RARRAY_AREF(keys, i));
                del++;
            }
        }
    }
    RB_GC_GUARD(keys);
    if (del == 0) return Qnil;
    return envtbl;
}

Эквивалентно ENV.keep_if, но возвращает nil , если изменений не было.

ENV.filter! является псевдонимом для ENV.select!.

freeze → вызывает TypeError Показать исходный код
static VALUE
env_freeze(VALUE self)
{
    rb_raise(rb_eTypeError, "cannot freeze ENV");
    return self; /* Not reached */
}

Ruby не позволяет замораживать ENV, поэтому вызов ENV.freeze вызывает исключение TypeError.

has_key?(name) → true или false Показать исходный код
static VALUE
env_has_key(VALUE env, VALUE key)
{
    const char *s;

    s = env_name(key);
    if (getenv(s)) return Qtrue;
    return Qfalse;
}

ENV.has_key?, ENV.member? и ENV.key? являются псевдонимами для ENV.include?.

Возвращает true , если переменная окружения с заданным name существует:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.include?('foo') # => true

Возвращает false , если name является допустимой String и такой переменной окружения нет:

ENV.include?('baz') # => false

Возвращает false , если name пустая String или является String, содержащей символ '=':

ENV.include?('') # => false
ENV.include?('=') # => false

Вызывает исключение, если name является String, содержащей символ NULL "\0":

ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)

Вызывает исключение, если name имеет кодировку, несовместимую с ASCII:

ENV.include?("\xa1\xa1".force_encoding(Encoding::UTF_16LE))
# Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: UTF-16LE)

Вызывает исключение, если name не является строкой:

ENV.include?(Object.new) # TypeError (no implicit conversion of Object into String)
has_value?(value) → true или false Показать исходный код
static VALUE
env_has_value(VALUE dmy, VALUE obj)
{
    char **env;

    obj = rb_check_string_type(obj);
    if (NIL_P(obj)) return Qnil;
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s++) {
            long len = strlen(s);
            if (RSTRING_LEN(obj) == len && strncmp(s, RSTRING_PTR(obj), len) == 0) {
                FREE_ENVIRON(environ);
                return Qtrue;
            }
        }
        env++;
    }
    FREE_ENVIRON(environ);
    return Qfalse;
}

Возвращает true , если переменная окружения с заданным value существует.

include?(name) → true или false Показать исходный код
static VALUE
env_has_key(VALUE env, VALUE key)
{
    const char *s;

    s = env_name(key);
    if (getenv(s)) return Qtrue;
    return Qfalse;
}

ENV.has_key?, ENV.member? и ENV.key? являются псевдонимами для ENV.include?.

Возвращает true , если переменная окружения с заданным name существует:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.include?('foo') # => true

Возвращает false , если name является допустимой String и такой переменной окружения нет:

ENV.include?('baz') # => false

Возвращает false , если name является пустой String или String, содержащей символ '=':

ENV.include?('') # => false
ENV.include?('=') # => false

Вызывает исключение, если name является String, содержащей символ NULL "\0":

ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)

Вызывает исключение, если name имеет кодировку, несовместимую с ASCII:

ENV.include?("\xa1\xa1".force_encoding(Encoding::UTF_16LE))
# Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: UTF-16LE)

Вызывает исключение, если name не является строкой:

ENV.include?(Object.new) # TypeError (no implicit conversion of Object into String)
index(value) → ключ Показать исходный код
static VALUE
env_index(VALUE dmy, VALUE value)
{
    rb_warn_deprecated("ENV.index", "ENV.key");
    return env_key(dmy, value);
}

Устаревший метод, эквивалентный ENV.key

inspect → строка Показать исходный код
static VALUE
env_inspect(VALUE _)
{
    char **env;
    VALUE str, i;

    str = rb_str_buf_new2("{");
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');

        if (env != environ) {
            rb_str_buf_cat2(str, ", ");
        }
        if (s) {
            rb_str_buf_cat2(str, "\"");
            rb_str_buf_cat(str, *env, s-*env);
            rb_str_buf_cat2(str, "\"=>");
            i = rb_inspect(rb_str_new2(s+1));
            rb_str_buf_append(str, i);
        }
        env++;
    }
    FREE_ENVIRON(environ);
    rb_str_buf_cat2(str, "}");

    return str;
}

Возвращает содержимое окружения в виде String.

invert → Хэш Показать исходный код
static VALUE
env_invert(VALUE _)
{
    return rb_hash_invert(env_to_hash());
}

Возвращает новый хэш, созданный с использованием имён переменных окружения в качестве значений, а значений — в качестве имён.

keep_if { |name, value| block } → ENV
keep_if → Enumerator
static VALUE
env_keep_if(VALUE ehash)
{
    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    env_select_bang(ehash);
    return envtbl;
}

Удаляет каждую переменную окружения, где блок возвращает false.

Возвращает перечислитель, если блок не был задан.

key(value) → имя или nil Показать исходный код
static VALUE
env_key(VALUE dmy, VALUE value)
{
    char **env;
    VALUE str;

    SafeStringValue(value);
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s++) {
            long len = strlen(s);
            if (RSTRING_LEN(value) == len && strncmp(s, RSTRING_PTR(value), len) == 0) {
                str = env_str_new(*env, s-*env-1);
                FREE_ENVIRON(environ);
                return str;
            }
        }
        env++;
    }
    FREE_ENVIRON(environ);
    return Qnil;
}

Возвращает имя первой переменной окружения со значением value , если она существует:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.key('0') # =>'foo'

Порядок, в котором проверяются переменные окружения, зависит от операционной системы. См. О порядке.

Возвращает nil , если такого значения нет:

ENV.key('2') # => nil

Вызывает исключение, если value не является строкой:

ENV.key(Object.new) # raises TypeError (no implicit conversion of Object into String)
key?(name) → true или false Показать исходный код
static VALUE
env_has_key(VALUE env, VALUE key)
{
    const char *s;

    s = env_name(key);
    if (getenv(s)) return Qtrue;
    return Qfalse;
}

ENV.has_key?, ENV.member? и ENV.key? являются псевдонимами для ENV.include?.

Возвращает true , если переменная окружения с заданным name существует:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.include?('foo') # => true

Возвращает false , если name является допустимой String и такой переменной окружения нет:

ENV.include?('baz') # => false

Возвращает false , если name является пустой String или String, содержащей символ '=':

ENV.include?('') # => false
ENV.include?('=') # => false

Вызывает исключение, если name является String, содержащей символ NULL "\0":

ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)

Вызывает исключение, если name имеет кодировку, несовместимую с ASCII:

ENV.include?("\xa1\xa1".force_encoding(Encoding::UTF_16LE))
# Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: UTF-16LE)

Вызывает исключение, если name не является строкой:

ENV.include?(Object.new) # TypeError (no implicit conversion of Object into String)
keys → Массив Показать исходный код
static VALUE
env_f_keys(VALUE _)
{
    return env_keys();
}

Возвращает все имена переменных в виде массива:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.keys # => ['bar', 'foo']

Порядок имён зависит от операционной системы. См. О порядке.

Возвращает пустой Array, если ENV пустой:

ENV.clear
ENV.keys # => []
length Показать исходный код
static VALUE
env_size(VALUE _)
{
    int i;
    char **env;

    env = GET_ENVIRON(environ);
    for (i=0; env[i]; i++)
        ;
    FREE_ENVIRON(environ);
    return INT2FIX(i);
}

Возвращает количество переменных окружения.

END_OF_DOCUMENT_MARKER
member?(name) → true or false Показать исходный код
static VALUE
env_has_key(VALUE env, VALUE key)
{
    const char *s;

    s = env_name(key);
    if (getenv(s)) return Qtrue;
    return Qfalse;
}

ENV.has_key?, ENV.member?, и ENV.key? являются псевдонимами для ENV.include?.

Возвращает true если существует переменная окружения с заданным name:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.include?('foo') # => true

Возвращает false если name является допустимой String и такой переменной окружения не существует:

ENV.include?('baz') # => false

Возвращает false если name является пустой String или String содержащей символ '=':

ENV.include?('') # => false
ENV.include?('=') # => false

Вызывает исключение, если name является String содержащей символ NUL "\0":

ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)

Вызывает исключение, если name имеет кодировку, несовместимую с ASCII:

ENV.include?("\xa1\xa1".force_encoding(Encoding::UTF_16LE))
# Raises ArgumentError (bad environment variable name: ASCII incompatible encoding: UTF-16LE)

Вызывает исключение, если name не является строкой:

ENV.include?(Object.new) # TypeError (no implicit conversion of Object into String)
merge!(hash) → ENV Показать исходный код
merge!(hash) { |name, old_value, new_value| block } → ENV
static VALUE
env_update(VALUE env, VALUE hash)
{
    if (env == hash) return env;
    hash = to_hash(hash);
    rb_foreach_func *func = rb_block_given_p() ?
        env_update_block_i : env_update_i;
    rb_hash_foreach(hash, func, 0);
    return env;
}

Добавляет содержимое hash к переменным окружения. Если блок не указан, записи с дублирующимися ключами перезаписываются, в противном случае значение каждого дублирующегося имени определяется вызовом блока с ключом, его значением из окружения и его значением из хэша.

rassoc(value) Показать исходный код
static VALUE
env_rassoc(VALUE dmy, VALUE obj)
{
    char **env;

    obj = rb_check_string_type(obj);
    if (NIL_P(obj)) return Qnil;
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s++) {
            long len = strlen(s);
            if (RSTRING_LEN(obj) == len && strncmp(s, RSTRING_PTR(obj), len) == 0) {
                VALUE result = rb_assoc_new(rb_str_new(*env, s-*env-1), obj);
                FREE_ENVIRON(environ);
                return result;
            }
        }
        env++;
    }
    FREE_ENVIRON(environ);
    return Qnil;
}

Возвращает Array имени и значения переменной окружения с value или nil, если значение не найдено.

rehash Показать исходный код
static VALUE
env_none(VALUE _)
{
    return Qnil;
}

Перехеширование переменных окружения ничего не делает. Оно предоставляется для совместимости с Hash.

reject { |name, value| block } → Hash Показать исходный код
reject → Enumerator
static VALUE
env_reject(VALUE _)
{
    return rb_hash_delete_if(env_to_hash());
}

То же самое, что и ENV.delete_if, но работает с (и возвращает) копией окружения.

reject! { |name, value| block } → ENV or nil Показать исходный код
reject! → Enumerator
static VALUE
env_reject_bang(VALUE ehash)
{
    VALUE keys;
    long i;
    int del = 0;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    keys = env_keys();
    RBASIC_CLEAR_CLASS(keys);
    for (i=0; i<RARRAY_LEN(keys); i++) {
        VALUE val = rb_f_getenv(Qnil, RARRAY_AREF(keys, i));
        if (!NIL_P(val)) {
            if (RTEST(rb_yield_values(2, RARRAY_AREF(keys, i), val))) {
                env_delete(RARRAY_AREF(keys, i));
                del++;
            }
        }
    }
    RB_GC_GUARD(keys);
    if (del == 0) return Qnil;
    return envtbl;
}

Аналогично ENV.delete_if, но возвращает nil, если не было внесено изменений.

Удаляет каждую переменную окружения, для которой блок возвращает истинное значение, возвращая ENV (если были удаления) или nil (если нет):

ENV.replace('foo' => '0', 'bar' => '1', 'baz' => '2')
ENV.reject! { |name, value| name.start_with?('b') } # => ENV
ENV # => {"foo"=>"0"}
ENV.reject! { |name, value| name.start_with?('b') } # => nil

Возвращает Enumerator, если блок не задан:

ENV.replace('foo' => '0', 'bar' => '1', 'baz' => '2')
e = ENV.reject! # => #<Enumerator: {"bar"=>"1", "baz"=>"2", "foo"=>"0"}:reject!>
e.each { |name, value| name.start_with?('b') } # => ENV
ENV # => {"foo"=>"0"}
e.each { |name, value| name.start_with?('b') } # => nil
replace(hash) → ENV Показать исходный код
static VALUE
env_replace(VALUE env, VALUE hash)
{
    VALUE keys;
    long i;

    keys = env_keys();
    if (env == hash) return env;
    hash = to_hash(hash);
    rb_hash_foreach(hash, env_replace_i, keys);

    for (i=0; i<RARRAY_LEN(keys); i++) {
        env_delete(RARRAY_AREF(keys, i));
    }
    RB_GC_GUARD(keys);
    return env;
}

Заменяет всё содержимое переменных окружения парами имя/значение в заданном hash; возвращает ENV.

Заменяет содержимое ENV заданными парами:

ENV.replace('foo' => '0', 'bar' => '1') # => ENV
ENV.to_hash # => {"bar"=>"1", "foo"=>"0"}

Вызывает исключение, если имя или значение недействительны. Смотрите Недействительные имена и значения.

select { |name, value| block } → Hash Показать исходный код
select → Enumerator
static VALUE
env_select(VALUE ehash)
{
    VALUE result;
    VALUE keys;
    long i;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    result = rb_hash_new();
    keys = env_keys();
    for (i = 0; i < RARRAY_LEN(keys); ++i) {
        VALUE key = RARRAY_AREF(keys, i);
        VALUE val = rb_f_getenv(Qnil, key);
        if (!NIL_P(val)) {
            if (RTEST(rb_yield_values(2, key, val))) {
                rb_hash_aset(result, key, val);
            }
        }
    }
    RB_GC_GUARD(keys);

    return result;
}

Возвращает копию окружения для записей, где блок возвращает true.

Возвращает Enumerator, если блок не был задан.

ENV.filter является псевдонимом для ENV.select.

select! { |name, value| block } → ENV or nil Показать исходный код
select! → Enumerator
static VALUE
env_select_bang(VALUE ehash)
{
    VALUE keys;
    long i;
    int del = 0;

    RETURN_SIZED_ENUMERATOR(ehash, 0, 0, rb_env_size);
    keys = env_keys();
    RBASIC_CLEAR_CLASS(keys);
    for (i=0; i<RARRAY_LEN(keys); i++) {
        VALUE val = rb_f_getenv(Qnil, RARRAY_AREF(keys, i));
        if (!NIL_P(val)) {
            if (!RTEST(rb_yield_values(2, RARRAY_AREF(keys, i), val))) {
                env_delete(RARRAY_AREF(keys, i));
                del++;
            }
        }
    }
    RB_GC_GUARD(keys);
    if (del == 0) return Qnil;
    return envtbl;
}

Эквивалентно ENV.keep_if, но возвращает nil, если не было внесено изменений.

ENV.filter! является псевдонимом для ENV.select!.

shift → [name, value] or nil Показать исходный код
static VALUE
env_shift(VALUE _)
{
    char **env;
    VALUE result = Qnil;

    env = GET_ENVIRON(environ);
    if (*env) {
        char *s = strchr(*env, '=');
        if (s) {
            VALUE key = env_str_new(*env, s-*env);
            VALUE val = env_str_new2(getenv(RSTRING_PTR(key)));
            env_delete(key);
            result = rb_assoc_new(key, val);
        }
    }
    FREE_ENVIRON(environ);
    return result;
}

Удаляет первую переменную окружения из ENV и возвращает 2-элементный Array, содержащий её имя и значение:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.to_hash # => {'bar' => '1', 'foo' => '0'}
ENV.shift # => ['bar', '1']
ENV.to_hash # => {'foo' => '0'}

То, какая именно переменная окружения является «первой», зависит от ОС. Смотрите О порядке.

Возвращает nil, если окружение пустое:

ENV.clear
ENV.shift # => nil
size Показать исходный код
static VALUE
env_size(VALUE _)
{
    int i;
    char **env;

    env = GET_ENVIRON(environ);
    for (i=0; env[i]; i++)
        ;
    FREE_ENVIRON(environ);
    return INT2FIX(i);
}

Возвращает количество переменных окружения.

slice(*keys) → a_hash Показать исходный код
static VALUE
env_slice(int argc, VALUE *argv, VALUE _)
{
    int i;
    VALUE key, value, result;

    if (argc == 0) {
        return rb_hash_new();
    }
    result = rb_hash_new_with_size(argc);

    for (i = 0; i < argc; i++) {
        key = argv[i];
        value = rb_f_getenv(Qnil, key);
        if (value != Qnil)
            rb_hash_aset(result, key, value);
    }

    return result;
}

Возвращает хэш, содержащий только заданные ключи из ENV и их значения.

ENV.slice("TERM","HOME")  #=> {"TERM"=>"xterm-256color", "HOME"=>"/Users/rhc"}
store(name, value) → value Показать исходный код
static VALUE
env_aset_m(VALUE obj, VALUE nm, VALUE val)
{
    return env_aset(nm, val);
}

ENV.store является псевдонимом для ENV.[]=.

Создаёт, обновляет или удаляет именованную переменную окружения, возвращая значение. И name, и value могут быть экземплярами String. Смотрите Допустимые имена и значения.

  • Если именованная переменная окружения не существует:

    • Если value равно nil, ничего не делает.

      ENV.clear
      ENV['foo'] = nil # => nil
      ENV.include?('foo') # => false
      ENV.store('bar', nil) # => nil
      ENV.include?('bar') # => false
      
    • Если value не равно nil, создаёт переменную окружения со значениями name и value:

      # Create 'foo' using ENV.[]=.
      ENV['foo'] = '0' # => '0'
      ENV['foo'] # => '0'
      # Create 'bar' using ENV.store.
      ENV.store('bar', '1') # => '1'
      ENV['bar'] # => '1'
      
  • Если именованная переменная окружения существует:

    • Если value не равно nil, обновляет переменную окружения со значением value:

      # Update 'foo' using ENV.[]=.
      ENV['foo'] = '2' # => '2'
      ENV['foo'] # => '2'
      # Update 'bar' using ENV.store.
      ENV.store('bar', '3') # => '3'
      ENV['bar'] # => '3'
      
    • Если value равно nil, удаляет переменную окружения:

      # Delete 'foo' using ENV.[]=.
      ENV['foo'] = nil # => nil
      ENV.include?('foo') # => false
      # Delete 'bar' using ENV.store.
      ENV.store('bar', nil) # => nil
      ENV.include?('bar') # => false
      

Вызывает исключение, если name или value недействительны. Смотрите Недействительные имена и значения.

to_a → Array Показать исходный код
static VALUE
env_to_a(VALUE _)
{
    char **env;
    VALUE ary;

    ary = rb_ary_new();
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s) {
            rb_ary_push(ary, rb_assoc_new(env_str_new(*env, s-*env),
                                          env_str_new2(s+1)));
        }
        env++;
    }
    FREE_ENVIRON(environ);
    return ary;
}

Преобразует переменные окружения в массив имён и массивов значений.

ENV.to_a # => [["TERM", "xterm-color"], ["SHELL", "/bin/bash"], ...]
to_h → hash Показать исходный код
to_h {|name, value| block } → hash
static VALUE
env_to_h(VALUE _)
{
    VALUE hash = env_to_hash();
    if (rb_block_given_p()) {
        hash = rb_hash_to_h_block(hash);
    }
    return hash;
}

Создаёт хэш с копией переменных окружения.

to_hash → hash Показать исходный код
static VALUE
env_f_to_hash(VALUE _)
{
    return env_to_hash();
}

Создаёт хеш с копией переменных окружения.

to_s → "ENV" Показать исходный код
static VALUE
env_to_s(VALUE _)
{
    return rb_usascii_str_new2("ENV");
}

Возвращает “ENV”

update(hash) → ENV Показать исходный код
update(hash) { |name, old_value, new_value| block } → ENV
static VALUE
env_update(VALUE env, VALUE hash)
{
    if (env == hash) return env;
    hash = to_hash(hash);
    rb_foreach_func *func = rb_block_given_p() ?
        env_update_block_i : env_update_i;
    rb_hash_foreach(hash, func, 0);
    return env;
}

Добавляет содержимое hash в переменные окружения. Если блок не указан, записи с дублирующимися ключами перезаписываются; в противном случае значение каждого дублирующегося имени определяется вызовом блока с ключом, его значением из окружения и его значением из хеша.

value?(value) → true or false Показать исходный код
static VALUE
env_has_value(VALUE dmy, VALUE obj)
{
    char **env;

    obj = rb_check_string_type(obj);
    if (NIL_P(obj)) return Qnil;
    env = GET_ENVIRON(environ);
    while (*env) {
        char *s = strchr(*env, '=');
        if (s++) {
            long len = strlen(s);
            if (RSTRING_LEN(obj) == len && strncmp(s, RSTRING_PTR(obj), len) == 0) {
                FREE_ENVIRON(environ);
                return Qtrue;
            }
        }
        env++;
    }
    FREE_ENVIRON(environ);
    return Qfalse;
}

Возвращает true если переменная окружения с заданным value существует.

values → Array Показать исходный код
static VALUE
env_f_values(VALUE _)
{
    return env_values();
}

Возвращает все значения переменных окружения в массиве:

ENV.replace('foo' => '0', 'bar' => '1')
ENV.values # => ['1', '0']

Порядок значений зависит от операционной системы. См. Порядок.

Возвращает пустой Array, если ENV пуст:

ENV.clear
ENV.values # => []
values_at(name, ...) → Array Показать исходный код
static VALUE
env_values_at(int argc, VALUE *argv, VALUE _)
{
    VALUE result;
    long i;

    result = rb_ary_new();
    for (i=0; i<argc; i++) {
        rb_ary_push(result, rb_f_getenv(Qnil, argv[i]));
    }
    return result;
}

Возвращает массив, содержащий значения переменных окружения, соответствующие заданным именам. См. также ENV.select.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API