set 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f64668b1687c9f23c7f608baba3bd5b2455d2d56e435840a547742640f5ced35
-  data.tar.gz: 72306f090587dd7a667445e7adaa443c07dae10a067e851d5dcb045d49fa9165
+  metadata.gz: cef560e603f6d6413751c31bb94fddf3838a66af8e71cff73c74760ff479ff6a
+  data.tar.gz: 448e22e93eebe57b26200fc1c8be476d60494193136aabb09a50c68e878e96cf
 SHA512:
-  metadata.gz: 831b03fe1e1ec4c74188fa91f224411d645aab6cd64d99cb499d1e62a4c0f2c3f660bfc6709c4ace1fdec336b5aae3b32691f70262bc9023cbd427a6a1934b8b
-  data.tar.gz: 28da11f61439186d2dc7cc091101884fbd1346489720505bcd1dc507c9933893b477696d04c0a832ac26a103cdad9f634b328c3280504fe4ecf7e44e35a75c52
+  metadata.gz: 91fa3052d7f25eaf6c0066013a5bd2d0c58961fe330c8923853634bac908ae83323d01b26ec8f85c4ab1ae309a83cc8e30e0918802ebb6f96fc3fcb7b7bdd433
+  data.tar.gz: 07b57081279057d476e1fe7c07587db1de0243cb78d36bc04b5b3ed303643b54320f08e98ed3672e610df84c42f0d503c7fae7eba040d2cf260c84319e7f9745

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @knu

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/test.yml

@@ -7,11 +7,11 @@ jobs:
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
+        ruby: [ 3.2, 3.1, "3.0", head ]
         os: [ ubuntu-latest, macos-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Set Changelog
 
+# 1.1.0 (2023-12-23)
+
+* Optimize for and require Ruby >=3
+
+# 1.0.4 (2023-12-08)
+
+* Enhancements
+  * Avoid the `block or return` pattern to save Proc allocations [#29][] ([@casperisfine][])
+  * Set#merge takes many enumerable objects [#30][]
+
+# 1.0.3 (2022-09-06)
+
+* Enhancements
+  * Make Set a builtin feature \[[Feature #16989][]]
+
 # 1.0.2 (2021-10-25)
 
 * Enhancements
@@ -31,9 +46,13 @@ This is the first release of set as a gem.  Here lists the changes since the ver
 [#17]: https://github.com/ruby/set/pull/17
 [#18]: https://github.com/ruby/set/pull/18
 [#20]: https://github.com/ruby/set/pull/20
+[#29]: https://github.com/ruby/set/pull/29
+[#30]: https://github.com/ruby/set/pull/30
 [Feature #17838]: https://bugs.ruby-lang.org/issues/17838
+[Feature #16989]: https://bugs.ruby-lang.org/issues/16989
 
 [@BurdetteLamar]: https://github.com/BurdetteLamar
+[@casperisfine]: https://github.com/casperisfine
 [@jeremyevans]: https://github.com/jeremyevans
 [@k-tsj]: https://github.com/k-tsj
 [@knu]: https://github.com/knu

data/lib/set.rb

@@ -3,7 +3,7 @@
 #
 # set.rb - defines the Set class
 #
-# Copyright (c) 2002-2020 Akinori MUSHA <knu@iDaemons.org>
+# Copyright (c) 2002-2023 Akinori MUSHA <knu@iDaemons.org>
 #
 # Documentation by Akinori MUSHA and Gavin Sinclair.
 #
@@ -12,16 +12,12 @@
 
 
 ##
-# This library provides the Set class, which deals with a collection
-# of unordered values with no duplicates.  It is a hybrid of Array's
+# This library provides the Set class, which implements a collection
+# of unordered values with no duplicates. It is a hybrid of Array's
 # intuitive inter-operation facilities and Hash's fast lookup.
 #
 # The method `to_set` is added to Enumerable for convenience.
 #
-# Set implements a collection of unordered values with no duplicates.
-# This is a hybrid of Array's intuitive inter-operation facilities and
-# Hash's fast lookup.
-#
 # Set is easy to use with Enumerable objects (implementing `each`).
 # Most of the initializer methods and binary operators accept generic
 # Enumerable objects besides sets and arrays.  An Enumerable object
@@ -88,138 +84,140 @@
 #
 # ### Methods for Creating a \Set
 #
-# - ::[] -
+# - ::[]:
 #   Returns a new set containing the given objects.
-# - ::new -
+# - ::new:
 #   Returns a new set containing either the given objects
 #   (if no block given) or the return values from the called block
 #   (if a block given).
 #
 # ### Methods for \Set Operations
 #
-# - [|](#method-i-7C) (aliased as #union and #+) -
+# - [|](#method-i-7C) (aliased as #union and #+):
 #   Returns a new set containing all elements from +self+
 #   and all elements from a given enumerable (no duplicates).
-# - [&](#method-i-26) (aliased as #intersection) -
+# - [&](#method-i-26) (aliased as #intersection):
 #   Returns a new set containing all elements common to +self+
 #   and a given enumerable.
-# - [-](#method-i-2D) (aliased as #difference) -
+# - [-](#method-i-2D) (aliased as #difference):
 #   Returns a copy of +self+ with all elements
 #   in a given enumerable removed.
-# - [\^](#method-i-5E) -
+# - [\^](#method-i-5E):
 #   Returns a new set containing all elements from +self+
 #   and a given enumerable except those common to both.
 #
 # ### Methods for Comparing
 #
-# - [<=>](#method-i-3C-3D-3E) -
+# - [<=>](#method-i-3C-3D-3E):
 #   Returns -1, 0, or 1 as +self+ is less than, equal to,
 #   or greater than a given object.
-# - [==](#method-i-3D-3D) -
+# - [==](#method-i-3D-3D):
 #   Returns whether +self+ and a given enumerable are equal,
 #   as determined by Object#eql?.
-# - \#compare_by_identity? -
+# - \#compare_by_identity?:
 #   Returns whether the set considers only identity
 #   when comparing elements.
 #
 # ### Methods for Querying
 #
-# - \#length (aliased as #size) -
+# - \#length (aliased as #size):
 #   Returns the count of elements.
-# - \#empty? -
+# - \#empty?:
 #   Returns whether the set has no elements.
-# - \#include? (aliased as #member? and #===) -
+# - \#include? (aliased as #member? and #===):
 #   Returns whether a given object is an element in the set.
-# - \#subset? (aliased as [<=](#method-i-3C-3D)) -
+# - \#subset? (aliased as [<=](#method-i-3C-3D)):
 #   Returns whether a given object is a subset of the set.
-# - \#proper_subset? (aliased as [<](#method-i-3C)) -
+# - \#proper_subset? (aliased as [<](#method-i-3C)):
 #   Returns whether a given enumerable is a proper subset of the set.
-# - \#superset? (aliased as [<=](#method-i-3E-3D])) -
+# - \#superset? (aliased as [>=](#method-i-3E-3D])):
 #   Returns whether a given enumerable is a superset of the set.
-# - \#proper_superset? (aliased as [>](#method-i-3E)) -
+# - \#proper_superset? (aliased as [>](#method-i-3E)):
 #   Returns whether a given enumerable is a proper superset of the set.
-# - \#disjoint? -
+# - \#disjoint?:
 #   Returns +true+ if the set and a given enumerable
 #   have no common elements, +false+ otherwise.
-# - \#intersect? -
-#   Returns +true+ if the set and a given enumerable -
+# - \#intersect?:
+#   Returns +true+ if the set and a given enumerable:
 #   have any common elements, +false+ otherwise.
-# - \#compare_by_identity? -
+# - \#compare_by_identity?:
 #   Returns whether the set considers only identity
 #   when comparing elements.
 #
 # ### Methods for Assigning
 #
-# - \#add (aliased as #<<) -
+# - \#add (aliased as #<<):
 #   Adds a given object to the set; returns +self+.
-# - \#add? -
+# - \#add?:
 #   If the given object is not an element in the set,
 #   adds it and returns +self+; otherwise, returns +nil+.
-# - \#merge -
-#   Adds each given object to the set; returns +self+.
-# - \#replace -
+# - \#merge:
+#   Merges the elements of each given enumerable object to the set; returns +self+.
+# - \#replace:
 #   Replaces the contents of the set with the contents
 #   of a given enumerable.
 #
 # ### Methods for Deleting
 #
-# - \#clear -
+# - \#clear:
 #   Removes all elements in the set; returns +self+.
-# - \#delete -
+# - \#delete:
 #   Removes a given object from the set; returns +self+.
-# - \#delete? -
+# - \#delete?:
 #   If the given object is an element in the set,
 #   removes it and returns +self+; otherwise, returns +nil+.
-# - \#subtract -
+# - \#subtract:
 #   Removes each given object from the set; returns +self+.
 # - \#delete_if - Removes elements specified by a given block.
-# - \#select! (aliased as #filter!) -
+# - \#select! (aliased as #filter!):
 #   Removes elements not specified by a given block.
-# - \#keep_if -
+# - \#keep_if:
 #   Removes elements not specified by a given block.
 # - \#reject!
 #   Removes elements specified by a given block.
 #
 # ### Methods for Converting
 #
-# - \#classify -
+# - \#classify:
 #   Returns a hash that classifies the elements,
 #   as determined by the given block.
-# - \#collect! (aliased as #map!) -
+# - \#collect! (aliased as #map!):
 #   Replaces each element with a block return-value.
-# - \#divide -
+# - \#divide:
 #   Returns a hash that classifies the elements,
 #   as determined by the given block;
 #   differs from #classify in that the block may accept
 #   either one or two arguments.
-# - \#flatten -
+# - \#flatten:
 #   Returns a new set that is a recursive flattening of +self+.
-#  \#flatten! -
+#  \#flatten!:
 #   Replaces each nested set in +self+ with the elements from that set.
-# - \#inspect (aliased as #to_s) -
+# - \#inspect (aliased as #to_s):
 #   Returns a string displaying the elements.
-# - \#join -
+# - \#join:
 #   Returns a string containing all elements, converted to strings
 #   as needed, and joined by the given record separator.
-# - \#to_a -
+# - \#to_a:
 #   Returns an array containing all set elements.
-# - \#to_set -
+# - \#to_set:
 #   Returns +self+ if given no arguments and no block;
 #   with a block given, returns a new set consisting of block
 #   return values.
 #
 # ### Methods for Iterating
 #
-# - \#each -
+# - \#each:
 #   Calls the block with each successive element; returns +self+.
 #
 # ### Other Methods
 #
-# - \#reset -
+# - \#reset:
 #   Resets the internal state; useful if an object
 #   has been modified while an element in the set.
 #
 class Set
+  VERSION = "1.1.0"
+
   include Enumerable
 
   # Creates a new set containing the given objects.
@@ -288,18 +286,10 @@ class Set
     @hash = orig.instance_variable_get(:@hash).dup
   end
 
-  if Kernel.instance_method(:initialize_clone).arity != 1
-    # Clone internal hash.
-    def initialize_clone(orig, **options)
-      super
-      @hash = orig.instance_variable_get(:@hash).clone(**options)
-    end
-  else
-    # Clone internal hash.
-    def initialize_clone(orig)
-      super
-      @hash = orig.instance_variable_get(:@hash).clone
-    end
+  # Clone internal hash.
+  def initialize_clone(orig, **options)
+    super
+    @hash = orig.instance_variable_get(:@hash).clone(**options)
   end
 
   def freeze    # :nodoc:
@@ -391,7 +381,7 @@ class Set
   # Equivalent to Set#flatten, but replaces the receiver with the
   # result in place.  Returns nil if no modifications were made.
   def flatten!
-    replace(flatten()) if any? { |e| e.is_a?(Set) }
+    replace(flatten()) if any?(Set)
   end
 
   # Returns true if the set contains the given object.
@@ -411,7 +401,7 @@ class Set
     when set.instance_of?(self.class) && @hash.respond_to?(:>=)
       @hash >= set.instance_variable_get(:@hash)
     when set.is_a?(Set)
-      size >= set.size && set.all? { |o| include?(o) }
+      size >= set.size && set.all?(self)
     else
       raise ArgumentError, "value must be a set"
     end
@@ -424,7 +414,7 @@ class Set
     when set.instance_of?(self.class) && @hash.respond_to?(:>)
       @hash > set.instance_variable_get(:@hash)
     when set.is_a?(Set)
-      size > set.size && set.all? { |o| include?(o) }
+      size > set.size && set.all?(self)
     else
       raise ArgumentError, "value must be a set"
     end
@@ -437,7 +427,7 @@ class Set
     when set.instance_of?(self.class) && @hash.respond_to?(:<=)
       @hash <= set.instance_variable_get(:@hash)
     when set.is_a?(Set)
-      size <= set.size && all? { |o| set.include?(o) }
+      size <= set.size && all?(set)
     else
       raise ArgumentError, "value must be a set"
     end
@@ -450,7 +440,7 @@ class Set
     when set.instance_of?(self.class) && @hash.respond_to?(:<)
       @hash < set.instance_variable_get(:@hash)
     when set.is_a?(Set)
-      size < set.size && all? { |o| set.include?(o) }
+      size < set.size && all?(set)
     else
       raise ArgumentError, "value must be a set"
     end
@@ -481,12 +471,12 @@ class Set
     case set
     when Set
       if size < set.size
-        any? { |o| set.include?(o) }
+        any?(set)
       else
-        set.any? { |o| include?(o) }
+        set.any?(self)
       end
     when Enumerable
-      set.any? { |o| include?(o) }
+      set.any?(self)
     else
       raise ArgumentError, "value must be enumerable"
     end
@@ -507,7 +497,7 @@ class Set
   # the element as parameter.  Returns an enumerator if no block is
   # given.
   def each(&block)
-    block or return enum_for(__method__) { size }
+    block_given? or return enum_for(__method__) { size }
     @hash.each_key(&block)
     self
   end
@@ -582,7 +572,7 @@ class Set
   # Equivalent to Set#delete_if, but returns nil if no changes were
   # made. Returns an enumerator if no block is given.
   def reject!(&block)
-    block or return enum_for(__method__) { size }
+    block_given? or return enum_for(__method__) { size }
     n = size
     delete_if(&block)
     self if size != n
@@ -591,7 +581,7 @@ class Set
   # Equivalent to Set#keep_if, but returns nil if no changes were
   # made. Returns an enumerator if no block is given.
   def select!(&block)
-    block or return enum_for(__method__) { size }
+    block_given? or return enum_for(__method__) { size }
     n = size
     keep_if(&block)
     self if size != n
@@ -600,13 +590,15 @@ class Set
   # Equivalent to Set#select!
   alias filter! select!
 
-  # Merges the elements of the given enumerable object to the set and
+  # Merges the elements of the given enumerable objects to the set and
   # returns self.
-  def merge(enum)
-    if enum.instance_of?(self.class)
-      @hash.update(enum.instance_variable_get(:@hash))
-    else
-      do_with_enum(enum) { |o| add(o) }
+  def merge(*enums, **nil)
+    enums.each do |enum|
+      if enum.instance_of?(self.class)
+        @hash.update(enum.instance_variable_get(:@hash))
+      else
+        do_with_enum(enum) { |o| add(o) }
+      end
     end
 
     self
@@ -854,7 +846,7 @@ module Enumerable
   # Needs to `require "set"` to use this method.
   def to_set(klass = Set, *args, &block)
     klass.new(self, *args, &block)
-  end
+  end unless method_defined?(:to_set)
 end
 
 autoload :SortedSet, "#{__dir__}/set/sorted_set"

data/set.gemspec

@@ -1,6 +1,13 @@
+name = File.basename(__FILE__, ".gemspec")
+version = ["lib", Array.new(name.count("-")+1, "..").join("/")].find do |dir|
+  break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb")) do |line|
+    /^\s*VERSION\s*=\s*"(.*)"/ =~ line and break $1
+  end rescue nil
+end
+
 Gem::Specification.new do |spec|
-  spec.name          = "set"
-  spec.version       = "1.0.2"
+  spec.name          = name
+  spec.version       = version
   spec.authors       = ["Akinori MUSHA"]
   spec.email         = ["knu@idaemons.org"]
 
@@ -8,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Provides a class to deal with collections of unordered, unique values}
   spec.homepage      = "https://github.com/ruby/set"
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: set
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Akinori MUSHA
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2023-12-23 00:00:00.000000000 Z
 dependencies: []
 description: Provides a class to deal with collections of unordered, unique values
 email:
@@ -17,6 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -36,8 +38,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/set
   source_code_uri: https://github.com/ruby/set
-  changelog_uri: https://github.com/ruby/set/blob/v1.0.2/CHANGELOG.md
-post_install_message:
+  changelog_uri: https://github.com/ruby/set/blob/v1.1.0/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -45,15 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Provides a class to deal with collections of unordered, unique values
 test_files: []