array_include_methods 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5603fedac664220b84ce316fe3e737e15379c84a94c924d4f257b73c89964823
-  data.tar.gz: 5fa5f34ae91a0a3a3c12d475a28a857b02975aa69224bd710ae9887cf1108df5
+  metadata.gz: f893cf42569d8afb770fc426df2ad336d81f32af27a9c3793960288ffba9da90
+  data.tar.gz: 2f68fec3b44267052eca66fdecf5b9507e8c80774210a6e93a1754ef9e44ff05
 SHA512:
-  metadata.gz: 6205f364915b17f92e06dc3d78f76a3c829355f18ee2620879ceb2315c2e611082ada3ffaedd0ebc877781c3b37991d61addc078ce9ea419d2ed219169c5fb23
-  data.tar.gz: a66add1a0b81a5bce966c7b1cf3fde24dde7a93f08f1152d1bccae3ff48d3b012a9eb91421ebe446f1609d4d094922d4aa62d14c0cdcbd02575772cb513207ca
+  metadata.gz: 84634ac0899e45f2d48f28de1c3ee849b4c78c1691bcbf748e955595ee95c3dd4d54e12b2c7c07d01815f23cda0cfcc18e8959beb716559366c584b5542b6568
+  data.tar.gz: 93928af74b96981a77b1163b92cd4f2106b98cfcf96e0b9d3aeb8b463f426c2cf3fee6caa8e6d95e2be6052837bc785c6a73f886975b057bac9b52424c57e186

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## 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])`)
+
 ## 1.0.3
 
 - Opal compatibility through monkey-patching and providing a `using` method shim so that existing gems that used the refinement in Ruby work

data/README.md

@@ -1,4 +1,4 @@
-# ArrayIncludeMethods 1.0.3 - Ruby Refinement
+# ArrayIncludeMethods 1.3.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.3'
+gem 'array_include_methods', '~> 1.3.0'
 ```
 
 Run:
@@ -26,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.0.3
+gem install array_include_methods -v1.3.0
 ```
 
 ## Usage
@@ -47,27 +47,58 @@ 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_all?([2, 4, 5]) # returns false
-[1, 2, 3, 4].include_all?([]) # 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?(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?(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?([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
 ```
 
 ## 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.3
+1.3.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.3 ruby lib
+# stub: array_include_methods 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "array_include_methods".freeze
-  s.version = "1.0.3"
+  s.version = "1.3.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-09-29"
+  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,34 +8,63 @@ 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)
+    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)
+    def include_any?(*array)
       !array.nil? && (array.empty? || !(self & array).empty?)
-    end  
+    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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_include_methods
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-29 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