kotovalexarian-likes-github
/
rails--rails
mirror of https://github.com/rails/rails.git
1
0
Fork 0
Code Releases Activity

Merge pull request #37574 from Sean0628/mod-doc-for-including-and-excluding 

Add document for including and excluding methods[ci skip]
This commit is contained in:
Vipul A M 2019-11-19 19:16:25 -06:00 committed by GitHub
parent 3f78b592bf c5dab95d22
commit ab9e022461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
guides/source/active_support_core_extensions.md
View File

@ -2093,15 +2093,28 @@ to_visit << node if visited.exclude?(node)
NOTE: Defined in `active_support/core_ext/enumerable.rb`.
### `without`
### `including`
The method `without` returns a copy of an enumerable with the specified elements
The method `including` returns a new enumerable that includes the passed elements:
```ruby
[ 1, 2, 3 ].including(4, 5) # => [ 1, 2, 3, 4, 5 ]
["David", "Rafael"].including %w[ Aaron Todd ] # => ["David", "Rafael", "Aaron", "Todd"]
```
NOTE: Defined in `active_support/core_ext/enumerable.rb`.
### `excluding`
The method `excluding` returns a copy of an enumerable with the specified elements
removed:
```ruby
["David", "Rafael", "Aaron", "Todd"].without("Aaron", "Todd") # => ["David", "Rafael"]
["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"]
```
`excluding` is aliased to `without`.
NOTE: Defined in `active_support/core_ext/enumerable.rb`.
### `pluck`
@ -2134,6 +2147,22 @@ Similarly, `from` returns the tail from the element at the passed index to the e
[].from(0) # => []
```
The method `including` returns a new array that includes the passed elements:
```ruby
[ 1, 2, 3 ].including(4, 5) # => [ 1, 2, 3, 4, 5 ]
[ [ 0, 1 ] ].including([ [ 1, 0 ] ]) # => [ [ 0, 1 ], [ 1, 0 ] ]
```
The method `excluding` returns a copy of the Array excluding the specified elements.
This is an optimization of `Enumerable#excluding` that uses `Array#-`
instead of `Array#reject` for performance reasons.
```ruby
["David", "Rafael", "Aaron", "Todd"].excluding("Aaron", "Todd") # => ["David", "Rafael"]
[ [ 0, 1 ], [ 1, 0 ] ].excluding([ [ 1, 0 ] ]) # => [ [ 0, 1 ] ]
```
The methods `second`, `third`, `fourth`, and `fifth` return the corresponding element, as do `second_to_last` and `third_to_last` (`first` and `last` are built-in). Thanks to social wisdom and positive constructiveness all around, `forty_two` is also available.
```ruby