array_include_methods 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925807376e5d7c387227dc33369fa80dcefd7abc7f4164f5ed939e8de9a0fa66
-  data.tar.gz: 5a316e7e928da5eb1028e626fbcdec588e21fc66d683afec48278da7bdcc5899
+  metadata.gz: 37098f6edb2efccc49b1957ed3a1fab4ba24de1513c418d6b354c55639f7c21e
+  data.tar.gz: 43017be01759fa4ad755f7c6eb137dc112579746c04925e7a2d27eacc068bc78
 SHA512:
-  metadata.gz: 8e50f5e30e11b7e2c19234fe207c436b87ee37ff690212af30eb9460eab789ba08dc06b545d55aa2d41d80ccaf2a97f37c6ee2dfeaac31f7d53be55b1ccb7b26
-  data.tar.gz: 9de14d6773e0f55527f6857fb72c75be710615cc02eb61fcf297ca00d3ee2db3d9b9a2e6fea05ebde468497d79a66a38996bd2f1877b0f9813b798b94b93d1dc
+  metadata.gz: 443405d84171e9e1bbbb50542d62f7648c4291adc2b35a698b48cc7a9f821e182af43fd43e2a858c42bef31c6e805e4f6d47dfa2b06b20c81b2c480e95ed3eee
+  data.tar.gz: 751bed4920602a17ac928f24d1d0f9b3ccc0f1f8c5c0d75dc29df580618198cb9b8985059a76d451effbfd1d62366d2e35f839f25e25908c5590fa6b93de505f

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 1.5.0
+
+- Add RubyMotion compatibility
+- Ensure Opal compatibility happens through RUBY_ENGINE instead of RUBY_PLATFORM
+
+## 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

data/README.md

@@ -1,9 +1,9 @@
-# ArrayIncludeMethods 1.2.0 - Ruby Refinement
+# ArrayIncludeMethods 1.5.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)
 
-`Array#include_all?` & `Array#include_any?` methods missing from basic Ruby `Array` API.
+`Array#include_all?`, `Array#include_any?`, `Array#include_array?`, `Array#array_index`, `Array#array_diff_indices`, and `Array#array_intersection_indices` methods missing from basic Ruby `Array` API.
 
 ## Setup
 
@@ -12,7 +12,7 @@
 Include the following in Gemfile:
 
 ```ruby
-gem 'array_include_methods', '~> 1.2.0'
+gem 'array_include_methods', '~> 1.5.0'
 ```
 
 Run:
@@ -26,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.2.0
+gem install array_include_methods -v1.5.0
 ```
 
 ## Usage
@@ -51,10 +51,8 @@ Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
 
 ```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?() # returns true
 [1, 2, 3, 4].include_any?(nil) # returns false
 ```
 
@@ -62,19 +60,27 @@ Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
 
 ```ruby
 [1, 2, 3, 4].include_all?(2, 3) # returns true
-[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]) # returns false (checks true array containment)
 [1, 2, 3, 4].include_all?(4, 2) # returns true
-[1, 2, 3, 4].include_all?([4, 2]) # returns false (checks true array containment)
+[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, 4]) # returns false (checks true array containment)
 [1, 2, 3, 4].include_all?(2, 4, 5) # returns false
-[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_array?(other_array)`
+
+```ruby
+[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
@@ -90,9 +96,49 @@ Returns first array index of `other_array` in `first_array` assuming `first_arra
 [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]
+```
+
+## JRuby Compatibility
+
+This gem is 100% compatible with JRuby.
+
 ## Opal Compatibility
 
-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
+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.
+
+## RubyMotion Compatibility
+
+This gem degrades gracefully to monkey-patching in [RubyMotion](http://www.rubymotion.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.2.0
+1.5.0

data/array_include_methods.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: array_include_methods 1.2.0 ruby lib
+# stub: array_include_methods 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "array_include_methods".freeze
-  s.version = "1.2.0"
+  s.version = "1.5.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 = "2021-09-25"
-  s.description = "Array#include_all? & Array#include_any? methods missing from basic Ruby Array API".freeze
+  s.date = "2022-06-11"
+  s.description = "Array#include_all?, Array#include_any?, Array#include_array?, Array#array_index, Array#array_diff_indices, and Array#array_intersection_indices methods missing from basic Ruby Array API. Compatible with Ruby, JRuby, Opal, and RubyMotion.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -25,11 +25,12 @@ Gem::Specification.new do |s|
     "README.md",
     "VERSION",
     "array_include_methods.gemspec",
-    "lib/array_include_methods.rb"
+    "lib/array_include_methods.rb",
+    "lib/array_include_methods/array.rb"
   ]
   s.homepage = "http://github.com/AndyObtiva/array_include_methods".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.2.22".freeze
+  s.rubygems_version = "3.3.3".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 +44,7 @@ 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"])
@@ -51,6 +53,7 @@ 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/array.rb

@@ -0,0 +1,111 @@
+if ['opal', 'rubymotion'].include?(RUBY_ENGINE)
+  # Create a shim using method that does nothing since we monkey-patch in Opal earlier in `refine` method
+  def self.using(refinement)
+    # NO OP
+  end
+
+  module ArrayIncludeMethods
+    def self.refine(class_or_module, &refinement)
+      class_or_module.class_eval(&refinement)
+    end
+  end
+end
+
+module ArrayIncludeMethods
+  refine Array do
+    # 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` kwarg indicates that array must have the same sort as `self`. By default, it is `false`
+    # e.g. [1,2,3].include_all?(2,3, same_sort: true) => true
+    def include_all?(*array)
+      options = array.last.is_a?(Hash) && array.last.has_key?(:same_sort) ? array.pop : {same_sort: false}
+      same_sort = options[:same_sort]
+      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_array?(array)
+      return false if array.nil?
+      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
+    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
+    def include_any?(*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

data/lib/array_include_methods.rb

@@ -1,78 +1,7 @@
-module ArrayIncludeMethods
-  if RUBY_PLATFORM == 'opal'
-    def self.refine(class_or_module, &refinement)
-      class_or_module.class_eval(&refinement)
-    end
-  end
-  refine Array do
-    # 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
-    # Always returns `false` if the given `array` is nil
-    def include_all?(*array)
-      array_argument = false
-      if array.size == 1 && array[0].is_a?(Array)
-        array_argument = true
-        array = array[0]
-      end
-      return false if array.nil?
-      array_include_other_array_same_class_elements = lambda do |a1, a2|
-        begin
-          if array_argument
-            if a2.size > a1.size
-              false
-            else
-              size_diff = a1.size - a2.size
-              (size_diff + 1).times.any? do |start_index|
-                a1[start_index, a2.size] == a2
-              end
-            end
-          else
-            (a1 & a2).uniq.sort == a2.uniq.sort
-          end
-        rescue ArgumentError => e
-          a2.uniq.all? { |element| a1.include?(element) }
-        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
-  end
-end
-if RUBY_PLATFORM == 'opal'
-  # Create a shim using method that does nothing since we monkey-patch in Opal earlier in `refine` method
-  def self.using(refinement)
-    # NO OP
+begin
+  Motion::Project::App.setup do |app|
+    app.files += [File.join(__dir__, 'array_include_methods', 'array.rb')]
   end
+rescue
+  require_relative 'array_include_methods/array'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_include_methods
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,6 +94,20 @@ 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
@@ -108,8 +122,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
-description: Array#include_all? & Array#include_any? methods missing from basic Ruby
-  Array API
+description: Array#include_all?, Array#include_any?, Array#include_array?, Array#array_index,
+  Array#array_diff_indices, and Array#array_intersection_indices methods missing from
+  basic Ruby Array API. Compatible with Ruby, JRuby, Opal, and RubyMotion.
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -124,6 +139,7 @@ files:
 - VERSION
 - array_include_methods.gemspec
 - lib/array_include_methods.rb
+- lib/array_include_methods/array.rb
 homepage: http://github.com/AndyObtiva/array_include_methods
 licenses:
 - MIT
@@ -143,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Array#include_all? & Array#include_any? methods missing from basic Ruby Array