persistent-dmnd 1.0.0

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/UPSTREAM_TODO.adoc

@@ -0,0 +1,132 @@
+= Upstream ToDo
+
+Notes for pushing things upstream.
+
+== Hamster
+
+=== Wishlist
+
+* Insertion order for Hamster::Hash similarly to Ruby hashes
+* Insertion order for Hamster::Set? Or alternatively if Hash supports
+  it, we can trivially implement a Set using a Hash, if it provides that option.
+
+=== Push Set </+++<=+++/>=/> upstream, and drop +++<=>+++ from Set
+
+This makes Sets behave like regular Ruby Sets.
+
+=== Fix warnings
+
+Several warnings when executing specs:
+
+----
+/home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb:470: warning: shadowing outer local variable - trie
+/home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/trie.rb:220: warning: shadowing outer local variable - entry
+/home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/set.rb:4: warning: loading in progress, circular require considered harmful - /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/ruby_executable_hooks:15:in  `<main>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/ruby_executable_hooks:15:in  `eval'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/rspec:23:in  `<main>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/rspec:23:in  `load'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/exe/rspec:4:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:45:in  `invoke'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:71:in  `run'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:86:in  `run'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:100:in  `setup'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1494:in  `load_spec_files'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1494:in  `each'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1496:in  `block in load_spec_files'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1924:in  `load_spec_file_handling_errors'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1924:in  `load'
+        from /home/knuckles/ruby/persistent-dmnd/spec/unit/array_spec.rb:1:in  `<top (required)>'
+        from /home/knuckles/ruby/persistent-dmnd/spec/unit/array_spec.rb:1:in  `require'
+        from /home/knuckles/ruby/persistent-dmnd/lib/persistent-💎.rb:3:in  `<top (required)>'
+        from /home/knuckles/ruby/persistent-dmnd/lib/persistent-💎.rb:3:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext/enumerable.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext/enumerable.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/list.rb:7:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/list.rb:7:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb:5:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb:5:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/set.rb:4:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/set.rb:4:in  `require'
+/home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/vector.rb:3: warning: loading in progress, circular require considered harmful - /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/ruby_executable_hooks:15:in  `<main>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/ruby_executable_hooks:15:in  `eval'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/rspec:23:in  `<main>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/bin/rspec:23:in  `load'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/exe/rspec:4:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:45:in  `invoke'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:71:in  `run'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:86:in  `run'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/runner.rb:100:in  `setup'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1494:in  `load_spec_files'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1494:in  `each'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1496:in  `block in load_spec_files'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1924:in  `load_spec_file_handling_errors'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/rspec-core-3.7.0/lib/rspec/core/configuration.rb:1924:in  `load'
+        from /home/knuckles/ruby/persistent-dmnd/spec/unit/array_spec.rb:1:in  `<top (required)>'
+        from /home/knuckles/ruby/persistent-dmnd/spec/unit/array_spec.rb:1:in  `require'
+        from /home/knuckles/ruby/persistent-dmnd/lib/persistent-💎.rb:3:in  `<top (required)>'
+        from /home/knuckles/ruby/persistent-dmnd/lib/persistent-💎.rb:3:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext/enumerable.rb:1:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/core_ext/enumerable.rb:1:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/list.rb:7:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/list.rb:7:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb:6:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/hash.rb:6:in  `require'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/vector.rb:3:in  `<top (required)>'
+        from /home/knuckles/.rvm/gems/ruby-2.4.2/gems/hamster-3.0.0/lib/hamster/vector.rb:3:in  `require'
+
+----
+
+=== Maybe make `Vector` and `SortedSet` reuse empty instances?
+
+See commit 4fe1035ff9771a1bc7394ea7aa7bb3fb443794b0 for details.
+
+=== Maybe make `SortedSet#to_set` return a regular Ruby set?
+
+This matches with the `#to_ary` and `#to_hash` behavior on `Vector`/`Hash`.
+
+See commit 6152f5389f61ab9d029b8dfd45d319044ab26062 for details.
+
+=== Make `Vector` and `Hash` `#to_set` return a regular Ruby set
+
+As with the above case, this matches with the `#to_a`/`#to_ary`/`#to_h`/
+`to_hash` behavior that returns regular ruby data structures.
+
+=== Allow `Set` to be compared with custom types
+
+It does not make a lot of sense for Hamster to enforce that a `Set` can only
+be `==` to other `Set` instances.
+
+=== `Hash` should not implement `#to_ary`
+
+`#to_ary` should only be implemented by objects which really can be seen as
+arrays, not for those which can be converted into arrays, so this is a big and
+clear mistake.
+
+=== `Set` should use the `Kernel.+++<=>+++` behavior, not just undef it
+
+[source,ruby]
+----
+def <=>(other)
+  self == other ? 0 : nil
+end
+----
+
+=== Fix `Hash` comparison with Ruby hashes using `<`/`+++<=+++` breaks on Ruby 2.2 or older
+
+Because the default implementation of this methods is `other > self` or `other >= self`, this breaks on older rubies as Hash does not implement these methods.
+
+By relying supplying our own comparison code (similar to `>`/`>=`) we can workaround this.
+
+=== Fix unneeded complex comparison in `Hash#>`
+
+Instead of implementing it as `self != other && self >= other` and thus requiring twice the iterations/comparisons, this can just be `self.size > other.size`.

data/bin/pry

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/gems.rb

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Specify ffi version to avoid dependency issues when switching between MRI
+# and JRuby with the same gems.lock
+# Only used in development
+gem 'ffi', '~> 1.9.18'

data/lib/persistent-dmnd.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+# Persistent-💎: Ruby gem for easily creating immutable data structures
+# Copyright (c) 2017 Ivo Anjo <ivo.anjo@ist.utl.pt>
+#
+# This file is part of Persistent-💎.
+#
+# MIT License
+#
+# Copyright (c) 2017 Ivo Anjo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'persistent-💎'

data/lib/persistent-/360/237/222/216.rb

@@ -0,0 +1,110 @@
+# encoding: UTF-8
+
+# Persistent-💎: Ruby gem for easily creating immutable data structures
+# Copyright (c) 2017 Ivo Anjo <ivo.anjo@ist.utl.pt>
+#
+# This file is part of Persistent-💎.
+#
+# MIT License
+#
+# Copyright (c) 2017 Ivo Anjo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'persistent_dmnd/version'
+require 'persistent_dmnd/array'
+require 'persistent_dmnd/hash'
+require 'persistent_dmnd/set'
+require 'persistent_dmnd/dmndifier'
+require 'persistent_dmnd/jruby_workaround'
+
+module Persistent💎
+  include JRubyWorkaround
+
+  def self.included(klass)
+    # Make methods on this module also available inside classes (e.g. not just in instances)
+    klass.extend(self)
+  end
+
+  # Not very useful, but more of a "why not?" thing
+  def self.prepended(klass)
+    included(klass)
+  end
+
+  # Pretty syntax for creating the persistent structures
+
+  # Create a new persistent array
+  #
+  # @example
+  #   my_array = a💎[1, 2, 3]
+  #   my_array = a💎.new([1, 2, 3])
+  #   # => Persistent💎::Array[1, 2, 3]
+  #
+  def a💎
+    Persistent💎::Array
+  end
+  alias_method :aDmnd, :a💎
+
+  # Create a new persistent hash
+  #
+  # @example
+  #   my_hash = h💎[hello: 'world']
+  #   my_hash = h💎.new(hello: 'world')
+  #   # => Persistent💎::Hash[:hello => "world"]
+  #
+  def h💎
+    Persistent💎::Hash
+  end
+  alias_method :hDmnd, :h💎
+
+  # Create a new persistent set
+  #
+  # @example
+  #   my_set = s💎[:hello, :world]
+  #   my_set = s💎.new([:hello, :world])
+  #   # => Persistent💎::Set[:hello, :world]
+  #
+  def s💎
+    Persistent💎::Set
+  end
+  alias_method :sDmnd, :s💎
+
+  # Pretty syntax to making something persistent
+
+  # Make argument persistent, if possible
+  #
+  # * Already-persistent arguments are left the same
+  # * Calls #to_💎 or #to_dmnd for objects that already know how to convert themselves into persistent structures
+  # * Converts objects that answer to #to_ary into persistent arrays
+  # * Converts objects that answer to #to_hash into persistent hashes
+  # * Converts objects that answer to #each_pair into persistent hashes
+  # * Converts strings into immutable Strings (without modifying the original String)
+  # * Converts objects that answer to #to_str into frozen Strings
+  # * Converts sets (e.g. something that #is_a?(::Set) or answers to #to_set) into persistent sets
+  # * Converts Hamster and Concurrent (from concurrent-ruby) data structures to their persistent counterparts
+  #
+  def 💎ify
+    Persistent💎::Dmndifier
+  end
+  alias_method :dmndify, :💎ify
+end
+
+PersistentDmnd = Persistent💎

data/lib/persistent_dmnd/array.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+
+# Persistent-💎: Ruby gem for easily creating immutable data structures
+# Copyright (c) 2017 Ivo Anjo <ivo.anjo@ist.utl.pt>
+#
+# This file is part of Persistent-💎.
+#
+# MIT License
+#
+# Copyright (c) 2017 Ivo Anjo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'persistent_dmnd/self_conversion'
+require 'persistent_dmnd/is_persistent'
+require 'persistent_dmnd/concurrent_ruby_support'
+require 'persistent_dmnd/jruby_workaround'
+
+require 'hamster'
+require 'set'
+
+module Persistent💎
+  class Array < Hamster::Vector
+    include SelfConversion
+    include IsPersistent
+    include JRubyWorkaround
+    include Persistent💎
+
+    def self.[](*items)
+      if items.empty?
+        empty
+      else
+        super
+      end
+    end
+
+    # Return Concurrent::Array with contents of Persistent💎::Array
+    #
+    # @example
+    #   my_array = a💎[:hello, :world]
+    #   my_concurrent_array = my_array.to_concurrent_array
+    #
+    def to_concurrent_array
+      ConcurrentRubySupport::ensure_concurrent_ruby_loaded
+      Concurrent::Array.new(self)
+    end
+    alias :to_concurrent :to_concurrent_array
+
+    # Return Concurrent::Tuple with contents of Persistent💎::Array
+    #
+    # @example
+    #   my_array = a💎[:hello, :world]
+    #   my_concurrent_tuple = my_array.to_concurrent_tuple
+    #   # => #<Concurrent::Tuple @size=2, @tuple=[<#Concurrent::AtomicReference value:hello>, <#Concurrent::AtomicReference value:world>]>
+    #
+    def to_concurrent_tuple
+      ConcurrentRubySupport::ensure_concurrent_ruby_loaded
+      each.with_index.each_with_object(Concurrent::Tuple.new(size)) do |(item, index), result|
+        result.set(index, item)
+      end
+    end
+
+    def to_set
+      ::Set.new(self)
+    end
+
+    def to_a💎
+      self
+    end
+    alias_method :to_aDmnd, :to_a💎
+
+    def to_h💎
+      h💎[self]
+    end
+    alias_method :to_hDmnd, :to_h💎
+
+    def to_s💎
+      s💎[*self]
+    end
+    alias_method :to_sDmnd, :to_s💎
+  end
+end

data/lib/persistent_dmnd/concurrent_ruby_support.rb

@@ -0,0 +1,88 @@
+# encoding: UTF-8
+
+# Persistent-💎: Ruby gem for easily creating immutable data structures
+# Copyright (c) 2017 Ivo Anjo <ivo.anjo@ist.utl.pt>
+#
+# This file is part of Persistent-💎.
+#
+# MIT License
+#
+# Copyright (c) 2017 Ivo Anjo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'thread'
+
+module Persistent💎
+  # Simple module that attempts to load concurrent-ruby, and then stores the result for quick lookup
+  # This way we take care of loading concurrent-ruby ONLY when the library client asks us to, thus not bloating
+  # applications that don't need concurrent-ruby loaded but still having a great user experience
+  module ConcurrentRubySupport
+    REQUIRE_MUTEX = Mutex.new
+    private_constant :REQUIRE_MUTEX
+
+    class << self
+      def ensure_concurrent_ruby_loaded
+        loaded = @concurrent_loaded
+
+        if loaded == :success
+          return true
+        elsif loaded == :failure
+          raise_no_concurrent_ruby
+        end
+
+        begin
+          REQUIRE_MUTEX.synchronize do # Avoid require races
+            require 'concurrent'
+          end
+          mark_as_success
+          true
+        rescue LoadError
+          mark_as_failure
+          raise_no_concurrent_ruby
+        end
+      end
+
+      private
+
+      def raise_no_concurrent_ruby
+        raise(NotImplementedError,
+          'concurrent-ruby gem is not available, please install it in order to use #to_concurrent and #to_concurrent_* methods')
+      end
+
+      # The following methods are only for internal and test usage. Please do not use them :)
+
+      def mark_as_success
+        @concurrent_loaded = :success
+      end
+
+      def mark_as_failure
+        @concurrent_loaded = :failure
+      end
+
+      def reset_state
+        @concurrent_loaded = nil
+      end
+    end
+
+    reset_state
+  end
+end