dry-core 0.4.10 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538785d6f230fed2829eb31c2eed7b4f878db06f3d69703329e571327abea700
-  data.tar.gz: 6df94708151283cf120d590581171931141f999d8bdace6a825d80f61ac220e4
+  metadata.gz: 455db6bceb946acab5dbe431c4ba7edf9a7344f09c2b2af9e38c0b8788e3d600
+  data.tar.gz: c460402f0b99fbe8ad488463cebd828a6a814d0a45f5200fbf1c90302fa66649
 SHA512:
-  metadata.gz: 4ab27069408443161d3bed839e061e35ff0c683d3d9023d6834b1d45e48d44eb13eba350b3c7760312ace4eac3d83b8c008eada7878338fa017c96b195c02acc
-  data.tar.gz: 73c828d5271872b6b5a2b0cbf1d53075b3845ad36e82a90c7d12e35f7154a807c1320de5233eb9c26eeba35cf4078ed0b3fa5deb2b9bc7306adb26c10174d13a
+  metadata.gz: c07482895edfb498acc414cc6672c2fa271cbd892f59393b4baa6b3b7ec4e115b29474be85fe42e40660fe06f926442608d693816594bdfcd910411185acad9c
+  data.tar.gz: c3d0966d660f09a26007e226b57e1cc2c124a420606b4de5d104730c6f5d9c54492a89788fb601722eab10f42dac4cda5d6689c79fe6c53a3df9c6510569fa7e

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## unreleased 
+
+
+### Added
+
+- dry-equalizer has been imported into dry-core as `Dry::Core::Equalizer` but the interface remains the same, which is `include Dry.Equalizer(...)` - we'll be porting all other gems that depend on dry-equalizer to the latest dry-core with equalizer included *gradually*. Eventually dry-equalizer usage will be gone completely in rom-rb/dry-rb/hanami projects (@solnic)
+
+
+[Compare v0.4.10...master](https://github.com/dry-rb/dry-core/compare/v0.4.10...master)
+
 ## 0.4.10 2020-11-19
 
 

data/lib/dry-core.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/core'
+require "dry/core"

data/lib/dry/core.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/core/version'
+require "dry/core/version"
 
 # :nodoc:
 module Dry

data/lib/dry/core/cache.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
+require "concurrent/map"
 
 module Dry
   module Core

data/lib/dry/core/class_attributes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
-require 'dry/core/errors'
+require "dry/core/constants"
+require "dry/core/errors"
 
 module Dry
   module Core

data/lib/dry/core/constants.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
+require "set"
 
 module Dry
   module Core
@@ -25,7 +25,7 @@ module Dry
       # An empty set
       EMPTY_SET = ::Set.new.freeze
       # An empty string
-      EMPTY_STRING = ''.freeze
+      EMPTY_STRING = "".freeze
       # Identity function
       IDENTITY = (-> x { x }).freeze
 
@@ -46,12 +46,12 @@ module Dry
 
         # @api public
         def undefined.to_s
-          'Undefined'
+          "Undefined"
         end
 
         # @api public
         def undefined.inspect
-          'Undefined'
+          "Undefined"
         end
 
         # Pick a value, if the first argument is not Undefined, return it back,

data/lib/dry/core/deprecations.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module Dry
   module Core

data/lib/dry/core/descendants_tracker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'concurrent/array'
+require "concurrent/array"
 
 module Dry
   module Core

data/lib/dry/core/equalizer.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Dry
+  # Build an equalizer module for the inclusion in other class
+  #
+  # ## Credits
+  #
+  # Equalizer has been originally imported from the equalizer gem created by Dan Kubb
+  #
+  # @api public
+  def self.Equalizer(*keys, **options)
+    Dry::Core::Equalizer.new(*keys, **options)
+  end
+
+  module Core
+    # Define equality, equivalence and inspection methods
+    class Equalizer < Module
+      # Initialize an Equalizer with the given keys
+      #
+      # Will use the keys with which it is initialized to define #cmp?,
+      # #hash, and #inspect
+      #
+      # @param [Array<Symbol>] keys
+      # @param [Hash] options
+      # @option options [Boolean] :inspect whether to define #inspect method
+      # @option options [Boolean] :immutable whether to memoize #hash method
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(*keys, **options)
+        @keys = keys.uniq
+        define_methods(**options)
+        freeze
+      end
+
+      private
+
+      # Hook called when module is included
+      #
+      # @param [Module] descendant
+      #   the module or class including Equalizer
+      #
+      # @return [self]
+      #
+      # @api private
+      def included(descendant)
+        super
+        descendant.include Methods
+      end
+
+      # Define the equalizer methods based on #keys
+      #
+      # @param [Boolean] inspect whether to define #inspect method
+      # @param [Boolean] immutable whether to memoize #hash method
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def define_methods(inspect: true, immutable: false)
+        define_cmp_method
+        define_hash_method(immutable: immutable)
+        define_inspect_method if inspect
+      end
+
+      # Define an #cmp? method based on the instance's values identified by #keys
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def define_cmp_method
+        keys = @keys
+        define_method(:cmp?) do |comparator, other|
+          keys.all? do |key|
+            __send__(key).public_send(comparator, other.__send__(key))
+          end
+        end
+        private :cmp?
+      end
+
+      # Define a #hash method based on the instance's values identified by #keys
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def define_hash_method(immutable:)
+        calculate_hash = ->(obj) { @keys.map { |key| obj.__send__(key) }.push(obj.class).hash }
+        if immutable
+          define_method(:hash) do
+            @__hash__ ||= calculate_hash.call(self)
+          end
+          define_method(:freeze) do
+            hash
+            super()
+          end
+        else
+          define_method(:hash) do
+            calculate_hash.call(self)
+          end
+        end
+      end
+
+      # Define an inspect method that reports the values of the instance's keys
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def define_inspect_method
+        keys = @keys
+        define_method(:inspect) do
+          klass = self.class
+          name  = klass.name || klass.inspect
+          "#<#{name}#{keys.map { |key| " #{key}=#{__send__(key).inspect}" }.join}>"
+        end
+      end
+
+      # The comparison methods
+      module Methods
+        # Compare the object with other object for equality
+        #
+        # @example
+        #   object.eql?(other)  # => true or false
+        #
+        # @param [Object] other
+        #   the other object to compare with
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        def eql?(other)
+          instance_of?(other.class) && cmp?(__method__, other)
+        end
+
+        # Compare the object with other object for equivalency
+        #
+        # @example
+        #   object == other  # => true or false
+        #
+        # @param [Object] other
+        #   the other object to compare with
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        def ==(other)
+          other.is_a?(self.class) && cmp?(__method__, other)
+        end
+      end
+    end
+  end
+end

data/lib/dry/core/extensions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
+require "set"
 
 module Dry
   module Core

data/lib/dry/core/inflector.rb

@@ -7,15 +7,15 @@ module Dry
       # List of supported backends
       BACKENDS = {
         activesupport: [
-          'active_support/inflector',
+          "active_support/inflector",
           proc { ::ActiveSupport::Inflector }
         ],
         dry_inflector: [
-          'dry/inflector',
+          "dry/inflector",
           proc { Dry::Inflector.new }
         ],
         inflecto: [
-          'inflecto',
+          "inflecto",
           proc { ::Inflecto }
         ]
       }.freeze
@@ -38,8 +38,8 @@ module Dry
         BACKENDS.inject(nil) do |backend, (_, (path, factory))|
           backend || realize_backend(path, factory)
         end || raise(LoadError,
-                     'No inflector library could be found: '\
-                     'please install either the `inflecto` or `activesupport` gem.')
+                     "No inflector library could be found: "\
+                     "please install either the `inflecto` or `activesupport` gem.")
       end
 
       # Set preferred backend

data/lib/dry/core/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Core
-    VERSION = '0.4.10'.freeze
+    VERSION = "0.5.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-core
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.5.0
 platform: ruby
 authors:
 - Nikita Shilnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -85,6 +85,7 @@ files:
 - lib/dry/core/constants.rb
 - lib/dry/core/deprecations.rb
 - lib/dry/core/descendants_tracker.rb
+- lib/dry/core/equalizer.rb
 - lib/dry/core/errors.rb
 - lib/dry/core/extensions.rb
 - lib/dry/core/inflector.rb