sorted_set 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e56f60064165312509fe6eba771c978f17b1ec0a9e7fa48ca9507e5e8859d8cf
+  data.tar.gz: 8d04402fb56428ea45bf43255112b7b4ddfab075a923efc9933c882cabc9812c
+SHA512:
+  metadata.gz: 815254e15bf0889c57f831795792761a1d14c8f8c6420b88c8c967fbf6e60dae9938f450ecb00d9daa201729eb173f3631b2fb8531d289d900dc91d9010850e0
+  data.tar.gz: 9a7e2c54b2c414d0bcffa55059304813af6da28f607fbabaad07967211af529df94d4f56036d5d4a60895acb51bfa1fcae8fa90810ae7dbb6ee49751899cdf38

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.7, head, jruby ]
+        os: [ ubuntu ]
+
+    name: >-
+      ${{matrix.os}}-ruby-${{matrix.ruby}}
+    runs-on: ${{matrix.os}}-latest
+    continue-on-error: ${{matrix.ruby == 'head'}}
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@master
+
+      - name: Set up ruby and bundle
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+
+      - name: Run test
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# SortedSet Changelog
+
+## 1.0.0 (2020-12-22)
+
+This is the first release of sorted_set as a gem.  Here lists the changes since the version bundled with Ruby 2.7.
+
+* Breaking Changes
+  * The pure-ruby fallback implementation has been removed.  It now requires an RBTree library (rbtree for CRuby, rbtree-jruby for JRuby) to install and run.

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sorted_set.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "test-unit"

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2002-2020 Akinori MUSHA
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,55 @@
+# SortedSet
+
+SortedSet implements a Set whose elements are sorted in ascending
+order (according to the return values of their `<=>` methods) when
+iterating over them.
+
+Every element in SortedSet must be *mutually comparable* to every
+other: comparison with `<=>` must not return nil for any pair of
+elements.  Otherwise ArgumentError will be raised.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorted_set'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sorted_set
+
+## Usage
+
+```ruby
+require "sorted_set"
+
+set = SortedSet.new([2, 1, 5, 6, 4, 5, 3, 3, 3])
+ary = []
+
+set.each do |obj|
+  ary << obj
+end
+
+p ary # => [1, 2, 3, 4, 5, 6]
+
+set2 = SortedSet.new([1, 2, "3"])
+set2.each { |obj| } # => raises ArgumentError: comparison of Fixnum with String failed
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/knu/sorted_set.
+
+## License
+
+The gem is available as open source under either the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sorted_set"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sorted_set.rb

@@ -0,0 +1,57 @@
+# :markup: markdown
+
+require 'set'
+require 'rbtree'
+
+##
+# SortedSet implements a Set whose elements are sorted in ascending
+# order (according to the return values of their `<=>` methods) when
+# iterating over them.
+#
+# Every element in SortedSet must be *mutually comparable* to every
+# other: comparison with `<=>` must not return nil for any pair of
+# elements.  Otherwise ArgumentError will be raised.
+#
+# ## Example
+#
+# ```ruby
+# require "sorted_set"
+#
+# set = SortedSet.new([2, 1, 5, 6, 4, 5, 3, 3, 3])
+# ary = []
+#
+# set.each do |obj|
+#   ary << obj
+# end
+#
+# p ary # => [1, 2, 3, 4, 5, 6]
+#
+# set2 = SortedSet.new([1, 2, "3"])
+# set2.each { |obj| } # => raises ArgumentError: comparison of Fixnum with String failed
+# ```
+
+class SortedSet < Set
+  # Remove the existing implementation in case Ruby 2.x loads this
+  # library after loading the standard set library which defines
+  # SortedSet.
+  if class_variable_defined?(:@@setup)
+    # a hack to shut up warning
+    alias_method :old_init, :initialize
+
+    instance_methods(false).each { |m| remove_method(m) }
+  end
+
+  # Creates a SortedSet.  See Set.new for details.
+  def initialize(*args)
+    @hash = RBTree.new
+    super
+  end
+
+  if class_variable_defined?(:@@setup)
+    remove_class_variable(:@@setup)
+    remove_class_variable(:@@mutex) if class_variable_defined?(:@@mutex)
+
+    # a hack to shut up warning
+    remove_method :old_init
+  end
+end

data/sorted_set.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name          = "sorted_set"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Akinori MUSHA"]
+  spec.email         = ["knu@idaemons.org"]
+
+  spec.summary       = %q{Implements a variant of Set whose elements are sorted in ascending order}
+  spec.description   = %q{Implements a variant of Set whose elements are sorted in ascending order}
+  spec.homepage      = "https://github.com/knu/sorted_set"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/knu/sorted_set/blob/v#{spec.version}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "set", "~> 1.0"
+  if defined?(JRUBY_VERSION)
+    spec.platform = 'java'
+    spec.add_runtime_dependency "rbtree-jruby"
+  else
+    spec.add_runtime_dependency "rbtree"
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: sorted_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Akinori MUSHA
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rbtree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements a variant of Set whose elements are sorted in ascending order
+email:
+- knu@idaemons.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sorted_set.rb
+- sorted_set.gemspec
+homepage: https://github.com/knu/sorted_set
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/knu/sorted_set
+  source_code_uri: https://github.com/knu/sorted_set
+  changelog_uri: https://github.com/knu/sorted_set/blob/v1.0.0/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.1
+signing_key:
+specification_version: 4
+summary: Implements a variant of Set whose elements are sorted in ascending order
+test_files: []