persistent-dmnd 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29dbca88c51d0e49932b3f38fe2e210d39e00f3b976adb1876aa33e086d02576
-  data.tar.gz: cabea99e2afa0b0539b1a18c90569ab76252c9d05cd20fd36c8e9f92bfa1cf9f
+  metadata.gz: 71b6af1818f39a80e94958c1595c705796e42a070b051e68c1ae5c3adc86d841
+  data.tar.gz: cfc5b79d10788173955d652dc12f5f23b39a7abc130bfe09f845befed9325559
 SHA512:
-  metadata.gz: 0b11b0d5702ce13aa8ff10fd9181f1211bab465ab02292a2ddb3850d52c407b3d1296c9941d0628dd9e99eb7e2e6533927a8747faf7231bd435c62feed8db227
-  data.tar.gz: d33ffce384b3a2b3814d5ea3ce48ed017d48b0664b0c17bb9f7566ef220ec3769187807c8dd6681e9a2262001eb401ec1636dd4539c0b5b87175ef82f61b0a9d
+  metadata.gz: 84f09d670a7364d469c9c12479b2d43288a1e18e8274cc51beeffd48d8e771aa0e492920034c03ba8b005ace03716009e4419bf92c63bf3ad6bb7c6d06d570cb
+  data.tar.gz: cbcebc6c5a323250d53e20a46417af6aa1d51c6ef5e1c4b8a04b6e2678c4845b4609b2cc3dfa0d5ef3682038d245ea0723f95fedb012ef266c2d47b7adde5df0

data/.gitlab-ci.yml

@@ -0,0 +1,414 @@
+# MRI Ruby version list:
+# https://hub.docker.com/r/library/ruby/tags/
+
+testruby_1_9_3:
+  image: "ruby:1.9.3"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler -v '< 2'              # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_0:
+  image: "ruby:2.0"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_1:
+  image: "ruby:2.1"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_2:
+  image: "ruby:2.2"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_3:
+  image: "ruby:2.3"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_4:
+  image: "ruby:2.4"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_5:
+  image: "ruby:2.5"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_6:
+  image: "ruby:2.6"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_2_7:
+  image: "ruby:2.7"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testruby_3_0:
+  image: "ruby:3.0.0"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - ruby -v                                   # Print out ruby version for debugging
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testjruby_1_7:
+  image: "jruby:1.7"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testjruby_9_0:
+  image: "jruby:9.0"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - rm /etc/apt/sources.list.d/jessie-backports.list
+    - apt-get update                            # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - wget https://rubygems.org/downloads/jruby-openssl-0.9.21-java.gem # Needed to support newer ciphers when connecting to rubygems.org (otherwise gem downloads fail)
+    - gem install jruby-openssl-0.9.21-java.gem                         # Install the newer gem
+    - gem uninstall -x -i /opt/jruby/lib/ruby/gems/shared bundler # Remove any pre-existing bundler
+    - gem install bundler:'< 2'                 # Install latest bundler 1.x
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testjruby_9_1:
+  image: "jruby:9.1"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem uninstall -x -i /opt/jruby/lib/ruby/gems/shared bundler # Remove any pre-existing bundler
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testjruby_9_1:
+  image: "jruby:9.1"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem uninstall -x -i /opt/jruby/lib/ruby/gems/shared bundler # Remove any pre-existing bundler
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+# This is not repeated from the 9.2 below! 9.2.0.0 is a very specific version with a bug in the Set interoperability so
+# we'll want to check that our workaround is working with this one even after the 9.2 branch moves on.
+testjruby9_2_0_0:
+  image: "jruby:9.2.0.0"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testjruby_9_2:
+  image: "jruby:9.2"
+
+  # Cache gems in between builds
+  cache:
+    paths:
+      - vendor/ruby
+
+  before_script:
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git >/dev/null         # Add git binary
+    - export JRUBY_OPTS=--dev                   # Faster test runs
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem uninstall -a -x -i /opt/jruby/lib/ruby/gems/shared bundler # Remove any pre-existing bundler
+    - gem install bundler:'< 2'                 # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+  script:
+    - bin/rspec
+
+testtruffleruby:
+  image: "danny02/graalvm"
+
+  before_script:
+    - gu install -c org.graalvm.ruby            # Install TruffleRuby
+    - apt-get update >/dev/null                 # Add UTF-8 support
+    - apt-get install -y locales >/dev/null     # |
+    - echo "en_US UTF-8" > /etc/locale.gen      # |
+    - locale-gen en_US.UTF-8                    # |
+    - export LANG=en_US.UTF-8                   # |
+    - export LANGUAGE=en_US:en                  # |
+    - export LC_ALL=en_US.UTF-8                 # v
+    - apt-get install -y git libssl-dev libssl1.1 clang llvm make >/dev/null # Add git binary + truffleruby dependencies
+    - /graalvm*/jre/languages/ruby/lib/truffle/post_install_hook.sh # Rebuild openssl extension, as suggested by install
+                                                                    # notes
+    - ruby -v                                   # Print out ruby version for debugging
+    - bundle install -j $(nproc)                # Install dependencies
+
+  script:
+    - bin/rspec

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.1
+ruby-3.0.0

data/README.adoc

@@ -4,7 +4,7 @@
 :toclevels: 4
 :toc-title:
 
-// image:https://travis-ci.org/ivoanjo/persistent-dmnd.svg?branch=master["Build Status", link="https://travis-ci.org/ivoanjo/persistent-dmnd"]
+image:https://badge.fury.io/rb/persistent-dmnd.svg["Gem Version", link="https://badge.fury.io/rb/persistent-dmnd"]
 
 Are you tired of calling `.freeze` on your data structures (or your colleagues forgetting to do so)? +
 Do you wish Ruby had a literal for creating immutable arrays?
@@ -97,7 +97,9 @@ It also (_optionally!_) interoperates with the https://github.com/ruby-concurren
 Underneath the covers, persistent-💎 mostly builds atop the awesome https://github.com/hamstergem/hamster[hamster gem].
 Big thanks to its equally-awesome authors!
 
-Persistent-💎 is fully supported and tested on Ruby versions 1.9.3 to 2.6.0-preview1, and JRuby 1.7 to to 9.1. If we don't support your Ruby, it's probably a Python binary. Keep calm and 💎 away!
+Persistent-💎 is fully supported and tested on Ruby versions 1.9.3 to 3.0.0, JRuby 1.7 to 9.2, and TruffleRuby 1.0+ 🎉.
+If we don't support your Ruby, it's probably a Python binary instead (or a potato?).
+Keep calm and 💎 away!
 
 [discrete]
 == Contents
@@ -372,6 +374,8 @@ When you need to go from thread-safe immutable data structures to thread-safe mu
 
 You'll need to install concurrent-ruby first, see https://github.com/ruby-concurrency/concurrent-ruby#installation for instructions.
 
+NOTE: If you're using TruffleRuby, you'll need to use concurrent-ruby >= 1.1.0, as older versions did not work correctly on TruffleRuby.
+
 After that, you'll be able to:
 
 ==== Array
@@ -443,9 +447,9 @@ Every printable ascii character is already in use by Ruby, but I didn't want per
 
 Thus, I kept my Ruby beautiful. With two very clear characters you can create an immutable data structure. No more awkward typing of namespaces. No more `.freeze` everywhere. No-one will ever mistake the use of  `💎` for another operation.
 
-Now you can avoid having `💎` on your codebase altogether: just use `dmnd`, as <<usage,suggested above>>.
+Alas, you may not agree with me! The good news is that you can avoid having `💎` on your codebase altogether: just use `dmnd` as a replacement, as <<usage,documented above>>.
 
-If you're having a hard time typing the emoji, I recommend just adding a quick snippet to your editor or a quick command to search-and-replace `aDmnd`/`hDmnd`/`sDmnd`/`dmndify` for `a💎`/`h💎`/`s💎`/`💎ify`. That way you get best of both worlds: easy to type, and easy to read!
+If you're having a hard time typing the emoji, I recommend just adding a quick snippet to your editor or a quick command to search-and-replace `aDmnd`/`hDmnd`/`sDmnd`/`dmndify` for `a💎`/`h💎`/`s💎`/`💎ify`. That way you get best of both worlds: easy to type, and beautiful to read!
 
 == Usage on Ruby 1.9