array_include_methods 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c2ea9883b39246baae032b965a82ae5d6cec5f15393ffa3e8c68e698a0cb6d3
-  data.tar.gz: a8e2cfeef8241433ad043c358d285d349ee4ba8ea2b40b73dcb4863e30f0fd7c
+  metadata.gz: 925807376e5d7c387227dc33369fa80dcefd7abc7f4164f5ed939e8de9a0fa66
+  data.tar.gz: 5a316e7e928da5eb1028e626fbcdec588e21fc66d683afec48278da7bdcc5899
 SHA512:
-  metadata.gz: 2ad14e48a3d730fef05fad287cd3232b052462961ec91a4094713b2dc80803806e99bc3b52e1e80ce0638b6f8e833fb757132c2646037d791a8faefb78c2802a
-  data.tar.gz: 15f9bac604634a862cf1d582c26523ef375659371fb3151a8b69c2158b4e75c58b17d202753b85b1c4060016274813d4e2f1b68a75fbc805b616efbd211b9f4a
+  metadata.gz: 8e50f5e30e11b7e2c19234fe207c436b87ee37ff690212af30eb9460eab789ba08dc06b545d55aa2d41d80ccaf2a97f37c6ee2dfeaac31f7d53be55b1ccb7b26
+  data.tar.gz: 9de14d6773e0f55527f6857fb72c75be710615cc02eb61fcf297ca00d3ee2db3d9b9a2e6fea05ebde468497d79a66a38996bd2f1877b0f9813b798b94b93d1dc

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+## 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
+
+## 1.0.2
+
+- Handled case of two arrays with elements of unsortable object types (e.g. Hash)
+
+## 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?

data/README.md

@@ -1,5 +1,7 @@
-# ArrayIncludeMethods 1.0.2 - Ruby Refinement
+# ArrayIncludeMethods 1.2.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.
 
@@ -10,7 +12,7 @@
 Include the following in Gemfile:
 
 ```ruby
-gem 'array_include_methods', '~> 1.0.2'
+gem 'array_include_methods', '~> 1.2.0'
 ```
 
 Run:
@@ -24,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.0.2
+gem install array_include_methods -v1.2.0
 ```
 
 ## Usage
@@ -45,37 +47,60 @@ 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?([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
+```
+
+### `Array#include_all?(*other_array)`
+
+```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?(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?(nil) # returns false
 ```
 
-### `Array#include_any?(other_array)`
+### `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].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].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
 ```
 
-## Change Log
-
-### 1.0.2
+## Opal Compatibility
 
-- Handled case of two arrays with elements of unsortable object types (e.g. Hash)
+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
 
-### 1.0.1
+## TODO
 
-- Handled case of two arrays with different ordering of common elements
+[TODO.md](TODO.md)
 
-### 1.0.0
+## Change Log
 
-- Initial implementation of Array#include_all? & Array#include_any?
+[CHANGELOG.md](CHANGELOG.md)
 
 ## Contributing to array_include_methods
  

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/array_include_methods.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "array_include_methods".freeze
+  s.version = "1.2.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.email = "andy.am@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md",
+    "VERSION",
+    "array_include_methods.gemspec",
+    "lib/array_include_methods.rb"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/array_include_methods".freeze
+  s.licenses = ["MIT".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
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    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<rake-tui>.freeze, ["> 0"])
+  else
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    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<rake-tui>.freeze, ["> 0"])
+  end
+end
+

data/lib/array_include_methods.rb

@@ -1,16 +1,37 @@
 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)
+    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
-          (a1 & a2).uniq.sort == a2.uniq.sort
+          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.reduce(true) { |result, element| result && a1.include?(element) }
+          a2.uniq.all? { |element| a1.include?(element) }
         end
       end
       self_grouped_by = self.group_by(&:class)
@@ -28,8 +49,30 @@ module ArrayIncludeMethods
     # 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 = 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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_include_methods
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andy Maleh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2021-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,18 +52,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.9
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.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
@@ -72,17 +114,21 @@ email: andy.am@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
+- VERSION
+- array_include_methods.gemspec
 - lib/array_include_methods.rb
 homepage: http://github.com/AndyObtiva/array_include_methods
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Array#include_all? & Array#include_any? methods missing from basic Ruby Array
   API