README.md in array_include_methods-1.0.0 vs README.md in array_include_methods-1.0.1
- old
+ new
@@ -1,6 +1,6 @@
-# ArrayIncludeMethods - Ruby Refinement
+# ArrayIncludeMethods 1.0.1 - Ruby Refinement
[](http://badge.fury.io/rb/array_include_methods)
`Array#include_all?` & `Array#include_any?` methods missing from basic Ruby `Array` API.
## Setup
@@ -8,11 +8,11 @@
### With Bundler:
Include the following in Gemfile:
```ruby
-gem 'array_include_methods', '~> 1.0.0'
+gem 'array_include_methods', '~> 1.0.1'
```
Run:
```
@@ -22,11 +22,11 @@
### Without Bundler:
Run:
```
-gem install array_include_methods -v1.0.0
+gem install array_include_methods -v1.0.1
```
## Usage
Add the following line to your application if you are not requiring all gems via Bundler (e.g. `Bundler.require(:default)`):
@@ -38,9 +38,41 @@
To activate the `ArrayIncludeMethods` Ruby Refinement for the `Array` class, add the following line to every Ruby file that needs it:
```ruby
using ArrayIncludeMethods
```
+
+Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
+
+## Examples
+
+### `Array#include_all?(other_array)`
+
+```ruby
+[1, 2, 3, 4].include_all?([2, 4]) # returns true
+[1, 2, 3, 4].include_all?([2, 4, 5]) # returns false
+[1, 2, 3, 4].include_all?([]) # returns true
+[1, 2, 3, 4].include_all?(nil) # returns false
+```
+
+### `Array#include_any?(other_array)`
+
+```ruby
+[1, 2, 3, 4].include_any?([2, 4, 5]) # returns true
+[1, 2, 3, 4].include_any?([6, 7]) # returns false
+[1, 2, 3, 4].include_any?([]) # returns true
+[1, 2, 3, 4].include_any?(nil) # returns false
+```
+
+## Change Log
+
+### 1.0.1
+
+- Handled case of two arrays with different ordering of common elements
+
+### 1.0.0
+
+- Initial implementation of Array#include_all? & Array#include_any?
## Contributing to array_include_methods
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.