Class: Array

Inherits:
Object show all
Defined in:
lib/lite/ruby/array.rb,
lib/lite/ruby/safe/array.rb

Instance Method Summary collapse

Instance Method Details

#after(value) ⇒ Object 



56
57
58
59
60
 
# File 'lib/lite/ruby/array.rb', line 56

def after(value)
  return unless include?(value)

  self[(index(value) + 1) % size]
end

#all_after(value) ⇒ Object 



62
63
64
65
66
67
68
69
 
# File 'lib/lite/ruby/array.rb', line 62

def all_after(value)
  return unless include?(value)

  i = index(value)
  return if i == (size - 1)

  self[(i + 1)..-1]
end

#all_before(value) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/lite/ruby/array.rb', line 71

def all_before(value)
  return unless include?(value)

  i = index(value)
  return if i.zero?

  self[0..(i - 1)]
end

#assert_all_min_values!(*valid_values) ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
23
24
 
# File 'lib/lite/ruby/array.rb', line 20

def assert_all_min_values!(*valid_values)
  return assert_min_values!(*valid_values) unless empty?

  raise ArgumentError, 'An empty array is not allowed'
end

#assert_all_valid_values!(*valid_values) ⇒ Object

Raises:

  • (ArgumentError) 


36
37
38
39
40
 
# File 'lib/lite/ruby/array.rb', line 36

def assert_all_valid_values!(*valid_values)
  return assert_valid_values!(*valid_values) unless empty?

  raise ArgumentError, 'An empty array is not allowed'
end

#assert_all_value_presence! ⇒ Object

Raises:

  • (ArgumentError) 


50
51
52
53
54
 
# File 'lib/lite/ruby/array.rb', line 50

def assert_all_value_presence!
  return assert_value_presence! unless empty?

  raise ArgumentError, 'An empty array is not allowed'
end

#assert_min_values!(*valid_values) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/lite/ruby/array.rb', line 6

def assert_min_values!(*valid_values)
  return self if empty?

  valid_values.each do |value|
    next if include?(value)

    raise ArgumentError,
          "Missing value: #{value.inspect}. " \
          "Minimum values are: #{valid_values.map(&:inspect).join(', ')}"
  end

  self
end

#assert_valid_values!(*valid_values) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/lite/ruby/array.rb', line 26

def assert_valid_values!(*valid_values)
  each do |value|
    next if valid_values.include?(value)

    raise ArgumentError,
          "Invalid value: #{value.inspect}. " \
          "Allowed values are: #{valid_values.map(&:inspect).join(', ')}"
  end
end

#assert_value_presence! ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/lite/ruby/array.rb', line 42

def assert_value_presence!
  each do |value|
    next if value.respond_to?(:present?) ? value.present? : value

    raise ArgumentError, "A #{value.inspect} value is not allowed"
  end
end

#before(value) ⇒ Object 



80
81
82
83
84
 
# File 'lib/lite/ruby/array.rb', line 80

def before(value)
  return unless include?(value)

  self[(index(value) - 1) % size]
end

#bury(*args) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/MethodLength rubocop:disable Metrics/PerceivedComplexity, Style/GuardClause, Style/IfInsideElse



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/lite/ruby/array.rb', line 88

def bury(*args)
  if args.count < 2
    raise ArgumentError, '2 or more arguments required'
  elsif args.count == 2
    if args[0].is_a?(Integer)
      self[args[0]] = args[1]
    else
      self << { args[0] => args[1] }
    end
  else
    if args[0].is_a?(Integer)
      arg = args.shift
      self[arg] = [] unless self[arg]
      self[arg].bury(*args)
    else
      self << {}.bury(*args)
    end
  end

  self
end

#contains_all?(other) ⇒ Boolean

rubocop:enable Metrics/PerceivedComplexity, Style/GuardClause, Style/IfInsideElse rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/MethodLength

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/lite/ruby/array.rb', line 112

def contains_all?(other)
  (other & self) == self
end

#contains_any?(other) ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/lite/ruby/array.rb', line 116

def contains_any?(other)
  !contains_none?(other)
end

#contains_none?(other) ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/lite/ruby/array.rb', line 120

def contains_none?(other)
  (other & self).empty?
end

#deep_dup ⇒ Object 



5
6
7
 
# File 'lib/lite/ruby/safe/array.rb', line 5

def deep_dup
  map(&:deep_dup)
end

#delete_first ⇒ Object 



124
125
126
 
# File 'lib/lite/ruby/array.rb', line 124

def delete_first
  self[1..-1]
end

#delete_first! ⇒ Object 



128
129
130
 
# File 'lib/lite/ruby/array.rb', line 128

def delete_first!
  replace(delete_first)
end

#delete_last ⇒ Object 



132
133
134
 
# File 'lib/lite/ruby/array.rb', line 132

def delete_last
  self[0...-1]
end

#delete_last! ⇒ Object 



136
137
138
 
# File 'lib/lite/ruby/array.rb', line 136

def delete_last!
  replace(delete_last)
end

#delete_values(*args) ⇒ Object 



140
141
142
 
# File 'lib/lite/ruby/array.rb', line 140

def delete_values(*args)
  args.each_with_object([]) { |val, array| array << delete(val) }
end

#demote(value) ⇒ Object 



144
145
146
 
# File 'lib/lite/ruby/array.rb', line 144

def demote(value)
  sort_by { |val| val == value ? 0 : -1 }
end

#demote!(value) ⇒ Object 



148
149
150
 
# File 'lib/lite/ruby/array.rb', line 148

def demote!(value)
  replace(demote(value))
end

#denillify(identity = 0) ⇒ Object 



152
153
154
 
# File 'lib/lite/ruby/array.rb', line 152

def denillify(identity = 0)
  map { |val| val || identity }
end

#denillify!(identity = 0) ⇒ Object 



156
157
158
 
# File 'lib/lite/ruby/array.rb', line 156

def denillify!(identity = 0)
  replace(denillify(identity))
end

#divergence(other) ⇒ Object 



160
161
162
 
# File 'lib/lite/ruby/array.rb', line 160

def divergence(other)
  (self - other) | (other - self)
end

#duplicates(minimum = 2) ⇒ Object 



164
165
166
167
168
 
# File 'lib/lite/ruby/array.rb', line 164

def duplicates(minimum = 2)
  hash = Hash.new(0)
  each { |val| hash[val] += 1 }
  hash.delete_if { |_, val| val < minimum }.keys
end

#except(*values) ⇒ Object Also known as: reject_values 



170
171
172
 
# File 'lib/lite/ruby/array.rb', line 170

def except(*values)
  reject { |val| values.include?(val) }
end

#except!(*values) ⇒ Object Also known as: reject_values! 



174
175
176
177
 
# File 'lib/lite/ruby/array.rb', line 174

def except!(*values)
  reject! { |val| values.include?(val) }
  self
end

#extract! ⇒ Object 



9
10
11
12
13
14
15
 
# File 'lib/lite/ruby/safe/array.rb', line 9

def extract!
  return to_enum(:extract!) { size } unless block_given?

  extracted_elements = []
  reject! { |element| extracted_elements << element if yield(element) }
  extracted_elements
end

#from(position) ⇒ Object 



17
18
19
 
# File 'lib/lite/ruby/safe/array.rb', line 17

def from(position)
  self[position, size] || []
end

#fulfill(value, amount) ⇒ Object 



179
180
181
182
183
 
# File 'lib/lite/ruby/array.rb', line 179

def fulfill(value, amount)
  return self if amount <= size

  fill(value, size..(amount - 1))
end

#groups(number) ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/lite/ruby/array.rb', line 185

def groups(number)
  return [] if number <= 0

  num, rem = size.divmod(number)
  collection = (0..(num - 1)).collect { |val| self[(val * number), number] }
  return collection unless rem.positive?

  collection << self[-rem, rem]
end

#in_groups(number, fill_with = nil, &block) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/lite/ruby/safe/array.rb', line 22

def in_groups(number, fill_with = nil, &block)
  collection_size = size
  division = collection_size.div(number)
  modulo = collection_size % number
  collection = []
  start = 0

  number.times do |int|
    mod_gt_zero = modulo.positive?
    grouping = division + (mod_gt_zero && modulo > int ? 1 : 0)
    collection << last_group = slice(start, grouping)
    last_group << fill_with if (fill_with != false) && mod_gt_zero && (grouping == division)
    start += grouping
  end

  return collection unless defined?(yield)

  collection.each(&block)
end

#in_groups_of(number, fill_with = nil, &block) ⇒ Object

rubocop:disable Metrics/MethodLength, Style/GuardClause



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/lite/ruby/safe/array.rb', line 44

def in_groups_of(number, fill_with = nil, &block)
  if number.to_i <= 0
    raise ArgumentError, "Group size must be a positive integer, was #{number.inspect}"
  elsif fill_with == false
    collection = self
  else
    padding = (number - size % number) % number
    collection = dup.concat(Array.new(padding, fill_with))
  end

  sliced_collection = collection.each_slice(number)
  return sliced_collection.to_a unless defined?(yield)

  sliced_collection(&block)
end

#indexes(value) ⇒ Object Also known as: indices 



195
196
197
198
199
 
# File 'lib/lite/ruby/array.rb', line 195

def indexes(value)
  array = []
  each_with_index { |val, i| array << i if value == val }
  array
end

#match(value) ⇒ Object 



201
202
203
 
# File 'lib/lite/ruby/array.rb', line 201

def match(value)
  find { |val| value == val }
end

#merge(*values) ⇒ Object 



205
206
207
 
# File 'lib/lite/ruby/array.rb', line 205

def merge(*values)
  dup.merge!(*values)
end

#merge!(*values) ⇒ Object 



209
210
211
 
# File 'lib/lite/ruby/array.rb', line 209

def merge!(*values)
  values.each_with_object(self) { |val, arr| arr.concat(val) }
end

#nillify ⇒ Object 



213
214
215
 
# File 'lib/lite/ruby/array.rb', line 213

def nillify
  map { |val| !val.nil? && (val.try(:blank?) || val.try(:to_s).blank?) ? nil : val }
end

#nillify! ⇒ Object 



217
218
219
 
# File 'lib/lite/ruby/array.rb', line 217

def nillify!
  replace(nillify)
end

#only(*values) ⇒ Object Also known as: select_values 



221
222
223
 
# File 'lib/lite/ruby/array.rb', line 221

def only(*values)
  select { |val| values.include?(val) }
end

#only!(*values) ⇒ Object Also known as: select_values! 



225
226
227
228
 
# File 'lib/lite/ruby/array.rb', line 225

def only!(*values)
  select! { |val| values.include?(val) }
  self
end

#position(value) ⇒ Object 



230
231
232
233
234
235
 
# File 'lib/lite/ruby/array.rb', line 230

def position(value)
  idx = index(value)
  return idx if idx.nil?

  idx + 1
end

#positions(value) ⇒ Object 



237
238
239
 
# File 'lib/lite/ruby/array.rb', line 237

def positions(value)
  indexes(value).map { |val| val + 1 }
end

#probability ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/lite/ruby/array.rb', line 241

def probability
  hash = Hash.new(0.0)
  differ = 0.0

  each do |val|
    hash[val] += 1.0
    differ += 1.0
  end

  hash.each_key { |val| hash[val] /= differ }
  hash
end

#promote(value) ⇒ Object 



254
255
256
 
# File 'lib/lite/ruby/array.rb', line 254

def promote(value)
  sort_by { |val| val == value ? -1 : 0 }
end

#promote!(value) ⇒ Object 



258
259
260
 
# File 'lib/lite/ruby/array.rb', line 258

def promote!(value)
  sort_by! { |val| val == value ? -1 : 0 }
end

#rand_sample(max = nil) ⇒ Object 



262
263
264
265
 
# File 'lib/lite/ruby/array.rb', line 262

def rand_sample(max = nil)
  amount = rand(1..(max || size))
  sample(amount)
end

#rposition(value) ⇒ Object 



267
268
269
270
271
272
 
# File 'lib/lite/ruby/array.rb', line 267

def rposition(value)
  idx = rindex(value)
  return idx if idx.nil?

  idx + 1
end

#sample! ⇒ Object 



274
275
276
 
# File 'lib/lite/ruby/array.rb', line 274

def sample!
  delete_at(Random.rand(size - 1))
end

#split(value = nil) ⇒ Object

rubocop:disable Metrics/MethodLength, Style/ExplicitBlockArgument



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/lite/ruby/safe/array.rb', line 62

def split(value = nil)
  arr = dup
  result = []

  if block_given?
    while (idx = arr.index { |i| yield(i) })
      result << arr.shift(idx)
      arr.shift
    end
  else
    while (idx = arr.index(value))
      result << arr.shift(idx)
      arr.shift
    end
  end

  result << arr
end

#strip ⇒ Object Also known as: compact_blank 



278
279
280
 
# File 'lib/lite/ruby/array.rb', line 278

def strip
  reject(&:blank?)
end

#strip! ⇒ Object Also known as: compact_blank! 



282
283
284
285
 
# File 'lib/lite/ruby/array.rb', line 282

def strip!
  reject!(&:blank?)
  self
end

#swap(from, to) ⇒ Object 



287
288
289
290
 
# File 'lib/lite/ruby/array.rb', line 287

def swap(from, to)
  self[from], self[to] = self[to], self[from]
  self
end

#to(position) ⇒ Object

rubocop:enable Metrics/MethodLength, Style/ExplicitBlockArgument



82
83
84
85
86
 
# File 'lib/lite/ruby/safe/array.rb', line 82

def to(position)
  return first(position + 1) if position >= 0

  self[0..position]
end

#to_sentence(options = {}) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/lite/ruby/safe/array.rb', line 88

def to_sentence(options = {})
  words_connector = options[:words_connector] || ', '
  two_words_connector = options[:two_words_connector] || ' and '
  last_word_connector = options[:last_word_connector] || ', and '

  case size
  when 0 then ''
  when 1 then self[0].to_s
  when 2 then "#{self[0]}#{two_words_connector}#{self[1]}"
  else "#{self[0...-1].join(words_connector)}#{last_word_connector}#{self[-1]}"
  end
end