Class: Array Private

Inherits:
Object show all
Defined in:
extend/array.rb,
extend/blank.rb,
extend/object/deep_dup.rb,
extend/array.rbi

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Direct Known Subclasses

Homebrew::CLI::NamedArgs

Instance Method Summary collapse

Instance Method Details

#deep_dup ⇒ T.self_type

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a deep copy of array.

array = [1, [2, 3]] dup = array.deep_dup dup[1][2] = 4

array[1][2] # => nil dup[1][2] # => 4

Returns:

  • (T.self_type) 


32
33
34
 
# File 'extend/object/deep_dup.rb', line 32

def deep_dup
  T.unsafe(self).map(&:deep_dup)
end

#fifth ⇒ Elem?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Equal to self[4].

%w( a b c d e ).fifth # => “e”

Returns:

  • (Elem, nil) 


23
 
# File 'extend/array.rb', line 23

def fifth = self[4]

#fourth ⇒ Elem?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Equal to self[3].

%w( a b c d e ).fourth # => “d”

Returns:

  • (Elem, nil) 


18
 
# File 'extend/array.rb', line 18

def fourth = self[3]

#present? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


87
 
# File 'extend/blank.rb', line 87

def present? = !empty? # :nodoc:

#second ⇒ Elem?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Equal to self[1].

%w( a b c d e ).second # => “b”

Returns:

  • (Elem, nil) 


8
 
# File 'extend/array.rb', line 8

def second = self[1]

#third ⇒ Elem?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Equal to self[2].

%w( a b c d e ).third # => “c”

Returns:

  • (Elem, nil) 


13
 
# File 'extend/array.rb', line 13

def third = self[2]

#to_sentence(words_connector: ", ", two_words_connector: " and ", last_word_connector: " and ") ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Converts the array to a comma-separated sentence where the last element is joined by the connector word.

You can pass the following kwargs to change the default behavior:

  • :words_connector - The sign or word used to join all but the last element in arrays with three or more elements (default: “, “).
  • :last_word_connector - The sign or word used to join the last element in arrays with three or more elements (default: “, and “).
  • :two_words_connector - The sign or word used to join the elements in arrays with two elements (default: “ and “).

==== Examples

[].to_sentence # => “” [‘one’].to_sentence # => “one” [‘one’, ‘two’].to_sentence # => “one and two” [‘one’, ‘two’, ‘three’].to_sentence # => “one, two, and three” [‘one’, ‘two’].to_sentence(two_words_connector: ‘-‘) # => “one-two”

[‘one’, ‘two’, ‘three’].to_sentence(words_connector: ‘ or ‘, last_word_connector: ‘ or at least ‘) # => “one or two or at least three” Copyright (c) David Heinemeier Hansson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Parameters:

  • words_connector (String) (defaults to: ", ")
  • two_words_connector (String) (defaults to: " and ")
  • last_word_connector (String) (defaults to: " and ")

Returns:

See Also:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'extend/array.rb', line 72

def to_sentence(words_connector: ", ", two_words_connector: " and ", last_word_connector: " and ")
  case length
  when 0
    +""
  when 1
    # This is not typesafe, if the array contains a BasicObject
    +T.unsafe(self[0]).to_s
  when 2
    +"#{self[0]}#{two_words_connector}#{self[1]}"
  else
    +"#{T.must(self[0...-1]).join(words_connector)}#{last_word_connector}#{self[-1]}"
  end
end