array_include_methods 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201b9e696a4644180df82e669767d5a83cd626dc9863ba7451d22707c53b20ba
-  data.tar.gz: b3920beaa33a19dedf9430eca869400cf763d0ddc0a28005550a7ea569c953e6
+  metadata.gz: cdce8ec8eb451f28c665c7dd6833190699abc55358dd2f488cfe594565ea2d54
+  data.tar.gz: bdd5b90776e4a606a161ec8b62fc5e9f1b6d7c3f03c12e77b8e7235907a5a7fb
 SHA512:
-  metadata.gz: '00929ce43674a96779a5a08c43357fcd0e4708782586a732f9040f6981c70858a80971f101a61a22b1d6de3e0e7a36d8d585d318f66370f040535443ea3ac04a'
-  data.tar.gz: d71713c34a7adad5d900342273666c99388b0c5e2b8cff0f3a45071c07809664bc904fd0d68576d322361b0e29dd118ae22076d7272fc7cb57379b72a43ae270
+  metadata.gz: 96e1cd8df937ded36f613d0fb97d1b1afc98ce44cc13900dfa7599ba0e6289b2119d4df51143145e6d177178fe40e4e72daa0395fad7dfa93e101518fb6740d6
+  data.tar.gz: 6d5b550e3acc6c8f2bea70553960a5e1bdf720d87b1603ad58c70bf8d5da53f383b07d10bdc68fd80d51fcdfbf2ae652426b1b3454b0101540c1499309e88e50

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 1.5.1
+
+- `counts` returns a hash of counts of every element in the array, performed in linear time (running time of O(n)).
+- `duplicates` returns a single occurrence of all elements that repeated in an array
+- `array_difference_indices`/`array_difference_indexes` aliases for `array_diff_indices`/`array_diff_indexes`
+- `array_diff`/`array_difference` (return elements of `array_diff_indexes`)
+- `array_intersection` (returns elements of `array_intersection_indexes`)
+
+## 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`)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Andy Maleh
+Copyright (c) 2020-2022 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,9 @@
-# ArrayIncludeMethods 1.4.0 - Ruby Refinement
+# ArrayIncludeMethods 1.5.1 - [Ruby Refinement](https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html)
 [![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#counts`, and `Array#duplicates` methods missing from basic Ruby `Array` API.
 
 ## Setup
 
@@ -12,7 +12,7 @@
 Include the following in Gemfile:
 
 ```ruby
-gem 'array_include_methods', '~> 1.4.0'
+gem 'array_include_methods', '~> 1.5.1'
 ```
 
 Run:
@@ -26,7 +26,7 @@ bundle
 Run:
 
 ```
-gem install array_include_methods -v1.4.0
+gem install array_include_methods -v1.5.1
 ```
 
 ## Usage
@@ -37,13 +37,13 @@ Add the following line to your application if you are not requiring all gems via
 require 'array_include_methods'
 ```
 
-To activate the `ArrayIncludeMethods` Ruby Refinement for the `Array` class, add the following line to every Ruby file that needs it:
+To activate the `ArrayIncludeMethods` [Ruby Refinement](https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html) for the `Array` class, add the following line to every Ruby file that needs it:
 
 ```ruby
 using ArrayIncludeMethods
 ```
 
-Now, you have `#include_all?` and `#include_any?` methods on `Array` objects.
+Now, you have `#include_all?`, `#include_any?`, `#include_array?`, `#array_index`, `#array_diff_indices`, and `#array_intersection_indices` methods on `Array` objects.
 
 ## Examples
 
@@ -128,9 +128,43 @@ Returns indexes from `self` array for which elements do not match elements in `o
 [1, 2, 3, 4].array_diff_indexes(nil) # returns [0, 1, 2, 3]
 ```
 
+### `Array#counts`
+
+Returns a hash of counts of every element in the array,
+performed in linear time (running time of O(n)).
+
+```ruby
+[1, 2, 3, 4].counts # returns {1=>1, 2=>1, 3=>1, 4=>1}
+[1, :a, :a, :b, 'bee', 'see', true, true, nil, nil].counts # returns {1=>1, :a=>2, :b=>1, "bee"=>1, "see"=>1, true=>2, nil=>2}
+[1, :a, :a, :b, 'bee', 'see', true, true, nil].counts # {1=>1, :a=>2, :b=>1, "bee"=>1, "see"=>1, true=>2, nil=>1}
+[1, {a: 1}, :a, :a, :b, 'bee', 'see', true, true, {a: 1}, {a: 1}].counts # {1=>1, {:a=>1}=>3, :a=>2, :b=>1, "bee"=>1, "see"=>1, true=>2}
+[].counts # returns {}
+```
+
+### `Array#duplicates`
+
+Returns a single occurrence of all elements that repeated in an array,
+performed in linear time (running time of O(n)).
+
+```ruby
+[1, 2, 3, 4].duplicates # returns []
+[1, :a, :a, :b, 'bee', 'see', true, true, nil, nil].duplicates # returns [:a, true, nil]
+[1, :a, :a, :b, 'bee', 'see', true, true, nil].duplicates # returns [:a, true]
+[1, {a: 1}, :a, :a, :b, 'bee', 'see', true, true, {a: 1}, {a: 1}].duplicates # returns [:a, true, {a: 1}]
+[].duplicates # returns []
+```
+
+## 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](https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html).
+
+## 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](https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html).
 
 ## TODO
 
@@ -152,5 +186,6 @@ This gem degrades gracefully to monkey-patching in [Opal Ruby](https://opalrb.co
 
 ## Copyright
 
-Copyright (c) 2020 Andy Maleh. See LICENSE.txt for
-further details.
+[MIT](LICENSE.txt)
+
+Copyright (c) 2020-2022 Andy Maleh. See [LICENSE.txt](LICENSE.txt) for further details.

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.1

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.4.0 ruby lib
+# stub: array_include_methods 1.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "array_include_methods".freeze
-  s.version = "1.4.0"
+  s.version = "1.5.1"
 
   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-26"
-  s.description = "Array#include_all? & Array#include_any? methods missing from basic Ruby Array API".freeze
+  s.date = "2023-02-17"
+  s.description = "Array#include_all?, Array#include_any?, Array#include_array?, Array#array_index, Array#counts, and Array#duplicates 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,12 +25,13 @@ 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.summary = "Array#include_all? & Array#include_any? methods missing from basic Ruby Array API".freeze
+  s.rubygems_version = "3.3.3".freeze
+  s.summary = "Array#include_all?, Array#include_any?, and other methods missing from basic Ruby Array API".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/array_include_methods/array.rb

@@ -0,0 +1,138 @@
+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_intersection(array)
+      array_intersection_indexes(array).map { |index| self[index] }
+    end
+    
+    def array_diff_indexes(array)
+      array_intersection_and_diff_indexes(array)[:diff_indexes]
+    end
+    alias array_diff_indices array_diff_indexes
+    alias array_difference_indexes array_diff_indexes
+    alias array_difference_indices array_diff_indexes
+    
+    def array_diff(array)
+      array_diff_indexes(array).map { |index| self[index] }
+    end
+    alias array_difference array_diff
+    
+    # Returns a hash of counts of every element in the array,
+    # performed in linear time (running time of O(n))
+    def counts
+      inject({}) do |count_hash, element|
+        count_hash[element] ||= 0
+        count_hash[element] += 1
+        count_hash
+      end
+    end
+    
+    # Returns a single occurrence of all elements that repeated in an array,
+    # performed in linear time (running time of O(n)).
+    def duplicates
+      counts.select { |element, count| count > 1 }.keys
+    end
+    
+    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,106 +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
-    # `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_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
-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.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,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#counts, and Array#duplicates methods missing from basic Ruby Array API. Compatible
+  with Ruby, JRuby, Opal, and RubyMotion.
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -138,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
@@ -157,9 +159,9 @@ 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
-  API
+summary: Array#include_all?, Array#include_any?, and other methods missing from basic
+  Ruby Array API
 test_files: []