array_include_methods 1.0.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ddeb62919efd84e6bfe45c278769d00ffc9d824a662d59c6f66a2d07af634ff
-  data.tar.gz: bb74486e281c925702761a5a83ae47804f326ebbb05b09b6275ad0dee6999634
+  metadata.gz: 201b9e696a4644180df82e669767d5a83cd626dc9863ba7451d22707c53b20ba
+  data.tar.gz: b3920beaa33a19dedf9430eca869400cf763d0ddc0a28005550a7ea569c953e6
 SHA512:
-  metadata.gz: ead0318fcb6aff83e48151fb1925c708af07430198c23366ce1415d7b4e1e58266484f4e76352c36480d1a59e6cc2469f255e0c3419e5a1ca485bf22aa45276d
-  data.tar.gz: fa6628a52ceb617d01cf40b5a88f6ce8c45f88ce117e605ade63f077d08df49501938fb92c234d2156babada06e76af79183d7260cfc838b3386ec2e210d7848
+  metadata.gz: '00929ce43674a96779a5a08c43357fcd0e4708782586a732f9040f6981c70858a80971f101a61a22b1d6de3e0e7a36d8d585d318f66370f040535443ea3ac04a'
+  data.tar.gz: d71713c34a7adad5d900342273666c99388b0c5e2b8cff0f3a45071c07809664bc904fd0d68576d322361b0e29dd118ae22076d7272fc7cb57379b72a43ae270

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## 1.4.0
+
+- `array_diff_indexes(other_array)` (alias: `array_diff_indices`)
+- `array_intersection_indexes(other_array)` (alias: `array_intersection_indices`)
+
+## 1.3.0
+
+- [API Breaking] Separate between operations `include_any?(*array)` and `include_any?(array)` to avoid confusion (remove support for the latter as it is not necessary)
+- [API Breaking] Separate between operations `include_all?(*array)` and `include_all?(array)` to avoid confusion (rename the latter to `include_array?(array)`)
+- `Array#include_all?(*other_array, same_sort: true)` accepts `same_sort` option (default: `false`)
+
+## 1.2.0
+
+- Add `Array#array_index(array)` method to determine start array index of other array
+
+## 1.1.0
+
+- Perform contiguous-element `include_all?([...])` check against an array argument (not splatted)
+- Perform sorted `include_all?([...])` check against an array argument (not splatted)
+- Perform non-repetition `include_all?([...])` check against an array argument (not splatted)
+
 ## 1.0.4
 
 - Support splat args (e.g. `include_any?(1, 2, 3)` instead of `include_any?([1, 2, 3])`)

data/README.md

@@ -1,4 +1,4 @@
-# ArrayIncludeMethods 1.0.4 - Ruby Refinement
+# ArrayIncludeMethods 1.4.0 - Ruby Refinement
 [![Gem Version](https://badge.fury.io/rb/array_include_methods.svg)](http://badge.fury.io/rb/array_include_methods)
 [![Build Status](https://travis-ci.com/AndyObtiva/array_include_methods.svg?branch=master)](https://travis-ci.com/AndyObtiva/array_include_methods)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/array_include_methods/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/array_include_methods?branch=master)
@@ -12,7 +12,7 @@
 Include the following in Gemfile:
 
 ```ruby
-gem 'array_include_methods', '~> 1.0.4'
+gem 'array_include_methods', '~> 1.4.0'
 ```
 
 Run:
@@ -26,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.0.4
+gem install array_include_methods -v1.4.0
 ```
 
 ## Usage
@@ -47,31 +47,90 @@ Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
 
 ## Examples
 
-### `Array#include_all?(other_array)`
+### `Array#include_any?(*other_array)`
 
 ```ruby
-[1, 2, 3, 4].include_all?([2, 4]) # returns true
+[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
+```
+
+### `Array#include_all?(*other_array)`
+
+```ruby
+[1, 2, 3, 4].include_all?(2, 3) # returns true
 [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?(4, 2) # returns true
+[1, 2, 3, 4].include_all?(4, 2, same_sort: true) # returns false
+[1, 2, 3, 4].include_all?(2, 4, 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?() # returns true
 [1, 2, 3, 4].include_all?(nil) # returns false
 ```
 
-### `Array#include_any?(other_array)`
+### `Array#include_array?(other_array)`
 
 ```ruby
-[1, 2, 3, 4].include_any?([2, 4, 5]) # returns true
-[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?(6, 7) # returns false
-[1, 2, 3, 4].include_any?([]) # returns true
-[1, 2, 3, 4].include_any?(nil) # returns false
+[1, 2, 3, 4].include_array?([2, 3]) # returns true
+[1, 2, 3, 4].include_array?([2, 4]) # returns false
+[1, 2, 3, 4].include_array?([4, 2]) # returns false
+[1, 2, 3, 4].include_array?([2, 4, 4]) # returns false
+[1, 2, 3, 4].include_array?([2, 4, 5]) # returns false
+[1, 2, 3, 4].include_array?([]) # returns true
+[1, 2, 3, 4].include_array?([nil]) # returns false
+```
+
+### `Array#array_index(other_array)`
+
+Returns first array index of `other_array` in `first_array` assuming `first_array.include_all?(other_array)` returns true
+
+```ruby
+[1, 2, 3, 4].array_index([2, 3, 4]) # returns 1
+[1, 2, 3, 4].array_index([2, 3]) # returns 1
+[1, 2, 3, 4].array_index([3, 4]) # returns 2
+[1, 2, 3, 4].array_index([2, 4]) # returns -1
+[1, 2, 3, 4].array_index([4, 2]) # returns -1
+[1, 2, 3, 4].array_index([2, 4, 5]) # returns -1
+[1, 2, 3, 4].array_index([]) # returns -1
+[1, 2, 3, 4].array_index(nil) # returns -1
+```
+
+### `Array#array_intersection_indexes(other_array)`
+(alias: `Array#array_intersection_indices(other_array)`)
+
+Returns indexes from `self` array for which elements match elements in `other_array` assuming same sort
+
+```ruby
+[1, 2, 3, 4].array_intersection_indexes([2, 3, 4]) # returns [1, 2, 3]
+[1, 2, 3, 4].array_intersection_indexes([2, 3]) # returns [1, 2]
+[1, 2, 3, 4].array_intersection_indexes([3, 4]) # returns [2, 3]
+[1, 2, 3, 4].array_intersection_indexes([2, 4]) # returns [1, 3]
+[1, 2, 3, 4].array_intersection_indexes([4, 2]) # returns [3]
+[1, 2, 3, 4].array_intersection_indexes([2, 4, 5]) # returns [1, 3]
+[1, 2, 3, 4].array_intersection_indexes([]) # returns []
+[1, 2, 3, 4].array_intersection_indexes(nil) # returns []
+```
+
+### `Array#array_diff_indexes(other_array)`
+(alias: `Array#array_diff_indices(other_array)`)
+
+Returns indexes from `self` array for which elements do not match elements in `other_array` assuming same sort
+
+```ruby
+[1, 2, 3, 4].array_diff_indexes([2, 3, 4]) # returns [0]
+[1, 2, 3, 4].array_diff_indexes([2, 3]) # returns [0, 3]
+[1, 2, 3, 4].array_diff_indexes([3, 4]) # returns [0, 1]
+[1, 2, 3, 4].array_diff_indexes([2, 4]) # returns [0, 2]
+[1, 2, 3, 4].array_diff_indexes([4, 2]) # returns [0, 1, 2]
+[1, 2, 3, 4].array_diff_indexes([2, 4, 5]) # returns [0, 2]
+[1, 2, 3, 4].array_diff_indexes([]) # returns [0, 1, 2, 3]
+[1, 2, 3, 4].array_diff_indexes(nil) # returns [0, 1, 2, 3]
 ```
 
 ## Opal Compatibility
 
-This gem degrades gracefully to monkey-patching in Opal Ruby and provides a `using` method shim so consumer code does not have to change if it used gems that rely on the Ruby refinement
+This gem degrades gracefully to monkey-patching in [Opal Ruby](https://opalrb.com) and provides a `using` method shim so consumer code does not have to change if it used gems that rely on the Ruby refinement
 
 ## TODO
 

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.4.0

data/array_include_methods.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: array_include_methods 1.0.4 ruby lib
+# stub: array_include_methods 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "array_include_methods".freeze
-  s.version = "1.0.4"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2020-11-15"
+  s.date = "2021-09-26"
   s.description = "Array#include_all? & Array#include_any? methods missing from basic Ruby Array API".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/AndyObtiva/array_include_methods".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.1.4".freeze
+  s.rubygems_version = "3.2.22".freeze
   s.summary = "Array#include_all? & Array#include_any? methods missing from basic Ruby Array API".freeze
 
   if s.respond_to? :specification_version then
@@ -43,6 +43,8 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<coveralls>.freeze, ["= 0.8.23"])
     s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
     s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
+    s.add_development_dependency(%q<puts_debuggerer>.freeze, ["> 0"])
+    s.add_development_dependency(%q<rake-tui>.freeze, ["> 0"])
   else
     s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
@@ -50,6 +52,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<coveralls>.freeze, ["= 0.8.23"])
     s.add_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
     s.add_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
+    s.add_dependency(%q<puts_debuggerer>.freeze, ["> 0"])
+    s.add_dependency(%q<rake-tui>.freeze, ["> 0"])
   end
 end
 

data/lib/array_include_methods.rb

@@ -8,36 +8,94 @@ module ArrayIncludeMethods
     # Returns `true` if all of the given `array` elements are present in `self`,
     # otherwise returns `false`
     # Always returns `true` if the given `array` is empty
+    # `same_sort` option indicates that array must have the same sort as `self`. By default, it is `false`
+    def include_all?(*array, same_sort: false)
+      return false if array.size > self.size
+      self_copy = self.dup
+      array_copy = array.dup
+      book_keeping_array_copy = array.dup
+      self_element_index = last_element_index = -1
+      array_copy.each do |element|
+        if self_copy.include?(element)
+          last_element_index = self_element_index
+          self_element_index = self_copy.index(element)
+          return false if same_sort && self_element_index < last_element_index
+          self_copy.delete_at(self_element_index)
+          book_keeping_array_copy.delete(element)
+        else
+          return false
+        end
+      end
+      book_keeping_array_copy.empty?
+    end
+
+    # Returns `true` if the given `array` is present in `self` (in the same element order without repetition)
+    # Always returns `true` if the given `array` is empty
     # Always returns `false` if the given `array` is nil
-    def include_all?(*array)
-      array = array[0] if array.size == 1 && array[0].is_a?(Array)
+    def include_array?(array)
       return false if array.nil?
-      array_include_other_array_same_class_elements = lambda do |a1, a2|
-        begin
-          (a1 & a2).uniq.sort == a2.uniq.sort
-        rescue ArgumentError => e
-          a2.uniq.reduce(true) { |result, element| result && a1.include?(element) }
+      if array.size > self.size
+        false
+      else
+        size_diff = self.size - array.size
+        (size_diff + 1).times.any? do |start_index|
+          self[start_index, array.size] == array
         end
       end
-      self_grouped_by = self.group_by(&:class)
-      array_grouped_by = array.group_by(&:class)
-      return false unless array_include_other_array_same_class_elements.call(self_grouped_by.keys.map(&:to_s), array_grouped_by.keys.map(&:to_s))
-      array_grouped_by.reduce(true) do |result, pair|
-        array_class = pair.first
-        array_elements = pair.last
-        self_grouped_by[array_class]
-        result && array_include_other_array_same_class_elements.call(self_grouped_by[array_class], array_elements)
-      end
     end
 
     # Returns `true` if any of the given `array` elements are present in `self`,
     # otherwise returns `false`
     # Always returns `true` if the given `array` is empty
-    # Always returns `false` if the given `array` is nil
     def include_any?(*array)
-      array = array[0] if array.size == 1 && array[0].is_a?(Array)
       !array.nil? && (array.empty? || !(self & array).empty?)
     end
+    
+    def array_index(array)
+      result_array_index = -1
+      return result_array_index if array.nil?
+      if array.size <= self.size
+        size_diff = self.size - array.size
+        current_array_index = nil
+        result = (size_diff + 1).times.any? do |start_index|
+          current_array_index = start_index
+          self[start_index, array.size] == array
+        end
+        result_array_index = current_array_index if result
+      end
+      result_array_index
+    end
+    
+    def array_intersection_indexes(array)
+      array_intersection_and_diff_indexes(array)[:intersection_indexes]
+    end
+    alias array_intersection_indices array_intersection_indexes
+    
+    def array_diff_indexes(array)
+      array_intersection_and_diff_indexes(array)[:diff_indexes]
+    end
+    alias array_diff_indices array_diff_indexes
+    
+    private
+    
+    def array_intersection_and_diff_indexes(array)
+      return {intersection_indexes: [], diff_indexes: self.size.times.to_a} if array.nil?
+      intersection_indexes = []
+      diff_indexes = []
+      array_current_index = 0
+      each_with_index do |element, index|
+        if element == array[array_current_index]
+          intersection_indexes << index
+          array_current_index += 1
+        else
+          diff_indexes << index
+        end
+      end
+      {
+        intersection_indexes: intersection_indexes,
+        diff_indexes: diff_indexes
+      }
+    end
   end
 end
 if RUBY_PLATFORM == 'opal'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_include_methods
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: puts_debuggerer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-tui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Array#include_all? & Array#include_any? methods missing from basic Ruby
   Array API
 email: andy.am@gmail.com
@@ -129,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Array#include_all? & Array#include_any? methods missing from basic Ruby Array