array_include_methods 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f887c53772d4bcdbd1b1d8ba7c6bfc288e0d2a240c4964d14f623ff0e06151
-  data.tar.gz: 755c0b44e13e6630f2692ac28ad64edaee7ac36586c6b68a6cedf4a5841dae3c
+  metadata.gz: 8de965f1a7a26091cfd9b1f2bdbb7191b92148afa5acf2b15b623c7950bc93b9
+  data.tar.gz: e8e4892cb0cbdd33d0cbf53dbf41d2e5927cbd364ac002e4983d948a0b418760
 SHA512:
-  metadata.gz: 1ddb16dbc31b74e3c5f367a164658326f2f1049cf0d4c50005ea2857f02e06264589ffe0ada88a34af0edab50131cd897776e4b880d9b8e057b23c067fefc4ec
-  data.tar.gz: 801e45a2e0780f17a248063d4093828a36301d1f78a9ef3875698c8ccfbda6f7fc49a99645131208669de42164ab2428fbd201b755f6f034826baa138ece7904
+  metadata.gz: 42a8e991852c1539669847b94b214d11ad7c47011670d432634fff64516ec2ffb8d749df18b165bc18b676539540eb5d7836dac215152909f5e12b27ad8e4f2a
+  data.tar.gz: 42be75002418adf80e9c7177f6d420dabaa0db20950cbc2d54ef4558773e75697269f0ed9f0849bacc40084c0e7296c55ca163d5f07215592a495f03c3479b54

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## 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.1 - Ruby Refinement
+# ArrayIncludeMethods 1.1.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.1'
+gem 'array_include_methods', '~> 1.1.0'
 ```
 
 Run:
@@ -24,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.0.1
+gem install array_include_methods -v1.1.0
 ```
 
 ## Usage
@@ -48,7 +50,15 @@ Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
 ### `Array#include_all?(other_array)`
 
 ```ruby
-[1, 2, 3, 4].include_all?([2, 4]) # returns true
+[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
@@ -57,21 +67,25 @@ Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
 ### `Array#include_any?(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
 ```
 
-## Change Log
+## 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
 
-### 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.1.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.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "array_include_methods".freeze
+  s.version = "1.1.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,13 +1,38 @@
 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|
-        (a1 & a2).uniq.sort == a2.uniq.sort
+        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)
@@ -24,8 +49,15 @@ 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
   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.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andy Maleh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-01 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