method

in_groups

Ruby on Rails latest stable (v7.1.3.2) - 0 notes - Class: ActiveSupport::CoreExtensions::Array::Grouping

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1 (0)
2.3.8 (0)
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2.3.8) is shown here.

These similar methods exist in v7.1.3.2:

Array#in_groups

in_groups(number, fill_with = nil) public

Splits or iterates over the array in number of groups, padding any remaining slots with fill_with unless it is false.

  %w(1 2 3 4 5 6 7 8 9 10).in_groups(3) {|group| p group}
  ["1", "2", "3", "4"]
  ["5", "6", "7", nil]
  ["8", "9", "10", nil]

  %w(1 2 3 4 5 6 7).in_groups(3, '&nbsp;') {|group| p group}
  ["1", "2", "3"]
  ["4", "5", "&nbsp;"]
  ["6", "7", "&nbsp;"]

  %w(1 2 3 4 5 6 7).in_groups(3, false) {|group| p group}
  ["1", "2", "3"]
  ["4", "5"]
  ["6", "7"]

Show source

# File activesupport/lib/active_support/core_ext/array/grouping.rb, line 59
        def in_groups(number, fill_with = nil)
          # size / number gives minor group size;
          # size % number gives how many objects need extra accomodation;
          # each group hold either division or division + 1 items.
          division = size / number
          modulo = size % number

          # create a new array avoiding dup
          groups = []
          start = 0

          number.times do |index|
            length = division + (modulo > 0 && modulo > index ? 1 : 0)
            padding = fill_with != false &&
              modulo > 0 && length == division ? 1 : 0
            groups << slice(start, length).concat([fill_with] * padding)
            start += length
          end

          if block_given?
            groups.each{|g| yield(g) }
          else
            groups
          end
        end

in_groups

Related methods

Method deprecated or moved