persistent-dmnd 1.0.0

data/lib/persistent_dmnd/dmndifier.rb

@@ -0,0 +1,74 @@
+# 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/ruby_1_9_and_2_0_support'
+
+require 'hamster'
+
+module Persistent💎
+  class Dmndifier
+    extend Persistent💎
+
+    DEFAULT_OPTIONS = {
+      on_unknown: proc { |arg|
+        raise ArgumentError, "Could not 💎ify an object of class #{arg.class}. Maybe you need to implement :to_💎?"
+      }
+    }.freeze
+
+    private_constant :DEFAULT_OPTIONS
+
+    def self.[](arg, options = DEFAULT_OPTIONS)
+      options = DEFAULT_OPTIONS.merge(options)
+      case
+      when arg.respond_to?(:to_💎)
+        arg.to_💎
+      when arg.respond_to?(:to_dmnd)
+        arg.to_dmnd
+      when arg.respond_to?(:to_hash)
+        h💎[arg.to_hash]
+      when arg.is_a?(Hamster::Set) || arg.is_a?(Hamster::SortedSet)
+        s💎[*arg.to_a]
+      when arg.respond_to?(:to_ary)
+        a💎[*arg.to_ary]
+      when defined?(Concurrent::Tuple) && arg.is_a?(Concurrent::Tuple)
+        a💎[*arg.to_a]
+      when arg.respond_to?(:to_set)
+        s💎[*arg.to_set.to_a]
+      when defined?(Concurrent::Map) && arg.is_a?(Concurrent::Map)
+        h💎[Persistent💎::Ruby19And20Support.enumerable_to_h(arg.enum_for(:each_pair))]
+      when arg.respond_to?(:each_pair)
+        h💎[Persistent💎::Ruby19And20Support.enumerable_to_h(arg.each_pair)]
+      else
+        options.fetch(:on_unknown).call(arg)
+      end
+    end
+  end
+end

data/lib/persistent_dmnd/everywhere.rb

@@ -0,0 +1,35 @@
+# 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-💎'
+
+# Add our module to the main object, allowing our syntax to be used everywhere
+include Persistent💎

data/lib/persistent_dmnd/hash.rb

@@ -0,0 +1,125 @@
+# 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 Hash < Hamster::Hash
+    include SelfConversion
+    include IsPersistent
+    include JRubyWorkaround
+    include Persistent💎
+
+    # Hashes are not arrays and thus should not implement :to_ary
+    undef_method :to_ary
+
+    # Return Concurrent::Hash with contents of Persistent💎::Hash
+    #
+    # @example
+    #   my_hash = h💎[hello: :world]
+    #   my_concurrent_hash = my_hash.to_concurrent_hash
+    #
+    def to_concurrent_hash
+      ConcurrentRubySupport::ensure_concurrent_ruby_loaded
+      Concurrent::Hash[self]
+    end
+    alias :to_concurrent :to_concurrent_hash
+
+    # Return Concurrent::Map with contents of Persistent💎::Hash
+    #
+    # @example
+    #   my_hash = h💎[hello: :world]
+    #   my_concurrent_map = my_hash.to_concurrent_map
+    #   # => #<Concurrent::Map:0x0055ad9b283ea0 entries=1 default_proc=nil>
+    #
+    def to_concurrent_map
+      ConcurrentRubySupport::ensure_concurrent_ruby_loaded
+      each_with_object(Concurrent::Map.new(initial_capacity: size)) do |(key, value), result|
+        result[key] = value
+      end
+    end
+
+    def to_set
+      ::Set.new(self)
+    end
+
+    def <(other)
+      if size >= other.size
+        false
+      else
+        self <= other
+      end
+    end
+
+    def <=(other)
+      if size > other.size
+        false
+      else
+        each do |key, value|
+          return false if other[key] != value
+        end
+
+        true
+      end
+    end
+
+    # Return each entry as a key, value pair inside an immutable array
+    def each💎
+      if block_given?
+        each { |pair| yield a💎[*pair] }
+      else
+        enum_for(:each💎)
+      end
+    end
+    alias_method :eachDmnd, :each💎
+
+    def to_a💎
+      a💎[*each💎]
+    end
+    alias_method :to_aDmnd, :to_a💎
+
+    def to_h💎
+      self
+    end
+    alias_method :to_hDmnd, :to_h💎
+
+    def to_s💎
+      s💎[*each💎]
+    end
+    alias_method :to_sDmnd, :to_s💎
+  end
+end

data/lib/persistent_dmnd/is_persistent.rb

@@ -0,0 +1,39 @@
+# 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
+
+module Persistent💎
+  # Marks instances as being persistent
+  module IsPersistent
+    def persistent?
+      true
+    end
+  end
+end

data/lib/persistent_dmnd/jruby_workaround.rb

@@ -0,0 +1,107 @@
+# 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
+
+module Persistent💎
+  module JRubyWorkaround
+    if RUBY_PLATFORM == 'java' # Only supposed to do something on JRuby
+
+      BROKEN_ENCODING = "\x00"
+      private_constant :BROKEN_ENCODING
+
+      BROKEN_ENCODING_JRUBY_1_7 = [239, 146, 142].pack('c*').force_encoding('UTF-8')
+      private_constant :BROKEN_ENCODING_JRUBY_1_7
+
+      def self.included(klass)
+        # Make methods on this module also available inside classes (e.g. not just in instances)
+        klass.extend(self)
+      end
+
+      def method_added(name)
+        super
+        maybe_fix_broken_encoding(name)
+      end
+
+      def singleton_method_added(name)
+        super
+        maybe_fix_broken_encoding(name, self.singleton_class)
+      end
+
+      private
+
+      # Workaround JRuby encoding bug
+      # See https://github.com/jruby/jruby/issues/4878
+      # and https://github.com/ivoanjo/persistent-dmnd/issues/5
+      #
+      # The trick here is that on JRuby, methods with emojis in the name are defined, but the resulting name is mangled
+      # so instead of for instance #to_💎 the result is #to_?\x00. (Or #💎ify will become #?ify\x00.) This behavior is
+      # consistent between def and calling a method, so def will register a method #to_?\x00, and a normal method call
+      # will do the same mangling and thus look for a method **WITH** the mangled name.
+      #
+      # But there are still other places in the code that rely on the correct name, such as alias and public_send/send,
+      # so we additionally use this module to define the correct name as an alias for the broken name.
+      #
+      # Thus, it all works on JRuby, albeit in a very roundabout way!
+      #
+      # FOR JRUBY 1.7:
+      # On JRuby 1.7 it seems that the mangling is different, and the emoji just gets replaced with ?, so for
+      # instance #to_💎 becomes #to_?. But then, to make things interesting, on symbols created without quotes, it
+      # gets mangled with the BROKEN_ENCODING_JRUBY_1_7, e.g :to_💎 becomes :to_BROKEN_ENCODING_JRUBY_1_7 (but
+      # :"to_💎" is still correct).
+      # To support both of these, we add an extra alias on JRuby, so that everything else seems to work even if it is
+      # actually using the name with the mangled encoding.
+      #
+      def maybe_fix_broken_encoding(name, target = nil)
+        name_string = name.to_s
+
+        if JRUBY_VERSION.start_with?('1.7.')
+          unless name_string.match(/\?.+/) ||
+            ['a?', 'h?', 's?', 'each?'].include?(name_string) ||
+            ['_?', '_a?', '_h?', '_s?'].any? { |suffix| name_string.end_with?(suffix) }
+            return
+          end
+        else
+          return unless name_string.end_with?(BROKEN_ENCODING)
+        end
+
+        fixed_name = name_string.sub('?', '💎').delete(BROKEN_ENCODING).to_sym
+        fixed_name_jruby_1_7 = name_string.sub('?', BROKEN_ENCODING_JRUBY_1_7).to_sym
+
+        if target
+          target.instance_eval { alias_method(fixed_name, name) }
+          target.instance_eval { alias_method(fixed_name_jruby_1_7, name) } if JRUBY_VERSION.start_with?('1.7.')
+        else
+          alias_method(fixed_name, name)
+          alias_method(fixed_name_jruby_1_7, name) if JRUBY_VERSION.start_with?('1.7.')
+        end
+      end
+    end
+  end
+end

data/lib/persistent_dmnd/ruby_1_9_and_2_0_support.rb

@@ -0,0 +1,47 @@
+# 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
+
+module Persistent💎
+  module Ruby19And20Support
+    # Enumerable#to_h was only introduced in Ruby 2.1 so we have to do it by hand on 2.0/1.9
+    if RUBY_VERSION.start_with?('2.0.') || RUBY_VERSION.start_with?('1.9.')
+      def self.enumerable_to_h(enumerable)
+        enumerable.each_with_object({}) do |(key, value), result|
+          result[key] = value
+        end
+      end
+    else
+      def self.enumerable_to_h(enumerable)
+        enumerable.to_h
+      end
+    end
+  end
+end

data/lib/persistent_dmnd/self_conversion.rb

@@ -0,0 +1,44 @@
+# 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/jruby_workaround'
+
+module Persistent💎
+  # Implements trivial conversion to persistent data structures for our own classes
+  module SelfConversion
+    include JRubyWorkaround
+
+    def to_💎
+      self
+    end
+    alias_method :to_dmnd, :to_💎
+  end
+end