dry-core 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455db6bceb946acab5dbe431c4ba7edf9a7344f09c2b2af9e38c0b8788e3d600
-  data.tar.gz: c460402f0b99fbe8ad488463cebd828a6a814d0a45f5200fbf1c90302fa66649
+  metadata.gz: cb330574bba6050e9a3d0fd466fdbd276ce76749b2661b8091ebf6178a2ef6c9
+  data.tar.gz: c1319b83600515df992a91556000989aa092d4229f69669b8f544368d93d21a8
 SHA512:
-  metadata.gz: c07482895edfb498acc414cc6672c2fa271cbd892f59393b4baa6b3b7ec4e115b29474be85fe42e40660fe06f926442608d693816594bdfcd910411185acad9c
-  data.tar.gz: c3d0966d660f09a26007e226b57e1cc2c124a420606b4de5d104730c6f5d9c54492a89788fb601722eab10f42dac4cda5d6689c79fe6c53a3df9c6510569fa7e
+  metadata.gz: 2b1967bb0c991637ea01da5d267df78daa12e4801288932372eca2ecf8aff0c5933ef2cb9cdc06d978d6223da963a31dc5e362f1ad1052490e10ebbc2b39fae6
+  data.tar.gz: 22662f066d46742cfd12d79eddcfb1e76811ab00b0080be8bac8fef53a1229fa91f5501b9f0b34f09182f5843c7bf995332fc16d1fe192daeadff186cd543cb7

data/CHANGELOG.md

@@ -1,6 +1,49 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## unreleased 
+## 0.7.1 2021-07-10
+
+
+### Fixed
+
+- [memoizable] memoizable correctly handles cases where a method
+has unnamed params (e.g. happens when the new `...` syntax is used) (@flash-gordon)
+
+
+
+[Compare v0.7.0...v0.7.1](https://github.com/dry-rb/dry-core/compare/v0.7.0...v0.7.1)
+
+## 0.7.0 2021-07-08
+
+
+### Fixed
+
+- [memoizable] warnings when using keyword arguments (@flash-gordon)
+- [deprecations] warnings show more relevant information about caller by default (@timriley)
+
+### Changed
+
+- Minimal Ruby version is 2.6
+- [memoizable] memoization of block-accepting methods is deprecated (@flash-gordon)
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-core/compare/v0.6.0...v0.7.0)
+
+## 0.6.0 2021-06-03
+
+
+### Added
+
+- [memoizable] support for `BasicObject` (@oleander)
+- [memoizable] support for methods that accept blocks (@oleander)
+- [deprecations] allow printing frame info on warn when setting up Deprecation module (via #52) (@waiting-for-dev)
+
+### Fixed
+
+- [memoizable] works with MRI 2.7+ keyword arguments now (@oleander)
+
+
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-core/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2012-12-12
 
 
 ### Added
@@ -8,7 +51,7 @@
 - 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)
+[Compare v0.4.10...v0.5.0](https://github.com/dry-rb/dry-core/compare/v0.4.10...v0.5.0)
 
 ## 0.4.10 2020-11-19
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 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

data/README.md

@@ -1,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-core
 [actions]: https://github.com/dry-rb/dry-core/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-core
@@ -14,15 +15,15 @@
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-core)
+* [User documentation](https://dry-rb.org/gems/dry-core)
 * [API documentation](http://rubydoc.info/gems/dry-core)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.5`
-* jruby >= `9.2`
+* MRI `>= 2.6.0`
+* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
 
 ## License
 

data/dry-core.gemspec

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/core/version'
+require "dry/core/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-core'
+  spec.name          = "dry-core"
   spec.authors       = ["Nikita Shilnikov"]
   spec.email         = ["fg@flashgordon.ru"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Core::VERSION.dup
 
   spec.summary       = "A toolset of small support modules used throughout the dry-rb ecosystem"
   spec.description   = spec.summary
-  spec.homepage      = 'https://dry-rb.org/gems/dry-core'
+  spec.homepage      = "https://dry-rb.org/gems/dry-core"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-core.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-core/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-core'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-core/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-core/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-core"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-core/issues"
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"

data/lib/dry/core/cache.rb

@@ -46,7 +46,8 @@ module Dry
       #       this means you shouldn't pass Procs in args unless you're sure
       #       they are always the same instances, otherwise you introduce a memory leak
       #
-      # @return [Object] block's return value (cached for subsequent calls with the same argument values)
+      # @return [Object] block's return value (cached for subsequent calls with
+      #   the same argument values)
       def fetch_or_store(*args, &block)
         cache.fetch_or_store(args.hash, &block)
       end

data/lib/dry/core/class_attributes.rb

@@ -67,7 +67,7 @@ module Dry
       #    defines :one, coerce: Dry::Types['coercible.string']
       #  end
       #
-      def defines(*args, type: ::Object, coerce: IDENTITY)
+      def defines(*args, type: ::Object, coerce: IDENTITY) # rubocop:disable Metrics/PerceivedComplexity
         unless coerce.respond_to?(:call)
           raise ::ArgumentError, "Non-callable coerce option: #{coerce.inspect}"
         end
@@ -80,10 +80,10 @@ module Dry
               if Undefined.equal?(value)
                 if instance_variable_defined?(ivar)
                   instance_variable_get(ivar)
-                else
+                else # rubocop:disable Style/EmptyElse
                   nil
                 end
-              elsif type === value
+              elsif type === value # rubocop:disable Style/CaseEquality
                 instance_variable_set(ivar, coerce.call(value))
               else
                 raise InvalidClassAttributeValue.new(name, value)

data/lib/dry/core/class_builder.rb

@@ -6,9 +6,7 @@ module Dry
     class ClassBuilder
       ParentClassMismatch = Class.new(TypeError)
 
-      attr_reader :name
-      attr_reader :parent
-      attr_reader :namespace
+      attr_reader :name, :parent, :namespace
 
       def initialize(name:, parent: nil, namespace: nil)
         @name = name
@@ -83,7 +81,7 @@ module Dry
       def create_base(namespace, name, parent)
         begin
           namespace.const_get(name)
-        rescue NameError
+        rescue NameError # rubocop:disable Lint/SuppressedException
         end
 
         if namespace.const_defined?(name, false)

data/lib/dry/core/constants.rb

@@ -25,7 +25,7 @@ module Dry
       # An empty set
       EMPTY_SET = ::Set.new.freeze
       # An empty string
-      EMPTY_STRING = "".freeze
+      EMPTY_STRING = ""
       # Identity function
       IDENTITY = (-> x { x }).freeze
 
@@ -42,7 +42,7 @@ module Dry
       #   end
       Undefined = Object.new.tap do |undefined|
         # @api private
-        Self = -> { Undefined }
+        Self = -> { Undefined } # rubocop:disable Lint/ConstantDefinitionInBlock
 
         # @api public
         def undefined.to_s
@@ -62,7 +62,7 @@ module Dry
         #     1 + Undefined.default(val, 2)
         #   end
         #
-        def undefined.default(x, y = self)
+        def undefined.default(x, y = self) # rubocop:disable Naming/MethodParameterName
           if equal?(x)
             if equal?(y)
               yield

data/lib/dry/core/deprecations.rb

@@ -33,17 +33,27 @@ module Dry
         # Prints a warning
         #
         # @param [String] msg Warning string
-        def warn(msg, tag: nil)
-          tagged = "[#{tag || 'deprecated'}] #{msg.gsub(/^\s+/, '')}"
-          logger.warn(tagged)
+        # @param [String] tag Tag to help identify the source of the warning.
+        #   Defaults to "deprecated"
+        # @param [Integer] Caller frame to add to the message
+        def warn(msg, tag: nil, uplevel: nil)
+          caller_info = uplevel.nil? ? nil : "#{caller_locations(uplevel + 2, 1)[0]} "
+          tag = "[#{tag || "deprecated"}] "
+          hint = msg.gsub(/^\s+/, "")
+
+          logger.warn("#{caller_info}#{tag}#{hint}")
         end
 
         # Wraps arguments with a standard message format and prints a warning
         #
         # @param [Object] name what is deprecated
         # @param [String] msg additional message usually containing upgrade instructions
-        def announce(name, msg, tag: nil)
-          warn(deprecation_message(name, msg), tag: tag)
+        def announce(name, msg, tag: nil, uplevel: nil)
+          # Bump the uplevel (if provided) by one to account for the uplevel calculation
+          # taking place one frame deeper in `.warn`
+          uplevel += 1 if uplevel
+
+          warn(deprecation_message(name, msg), tag: tag, uplevel: uplevel)
         end
 
         # @api private
@@ -92,7 +102,7 @@ module Dry
         #   @param [#warn] logger
         #
         # @api public
-        def set_logger!(output = $stderr)
+        def set_logger!(output = $stderr) # rubocop:disable Naming/AccessorMethodName
           if output.respond_to?(:warn)
             @logger = output
           else
@@ -108,8 +118,9 @@ module Dry
       end
 
       # @api private
-      class Tagged < Module
+      class Tagged < ::Module
         def initialize(tag)
+          super()
           @tag = tag
         end
 
@@ -145,8 +156,8 @@ module Dry
         # @option [String] message optional deprecation message
         def deprecate(old_name, new_name = nil, message: nil)
           full_msg = Deprecations.deprecated_name_message(
-            "#{self.name}##{old_name}",
-            new_name ? "#{self.name}##{new_name}" : nil,
+            "#{name}##{old_name}",
+            new_name ? "#{name}##{new_name}" : nil,
             message
           )
           mod = self
@@ -178,8 +189,8 @@ module Dry
         # @option [String] message optional deprecation message
         def deprecate_class_method(old_name, new_name = nil, message: nil)
           full_msg = Deprecations.deprecated_name_message(
-            "#{self.name}.#{old_name}",
-            new_name ? "#{self.name}.#{new_name}" : nil,
+            "#{name}.#{old_name}",
+            new_name ? "#{name}.#{new_name}" : nil,
             message
           )
 
@@ -203,7 +214,7 @@ module Dry
           remove_const(constant_name)
 
           full_msg = Deprecations.deprecated_name_message(
-            "#{self.name}::#{constant_name}",
+            "#{name}::#{constant_name}",
             message
           )
 

data/lib/dry/core/equalizer.rb

@@ -14,7 +14,7 @@ module Dry
 
   module Core
     # Define equality, equivalence and inspection methods
-    class Equalizer < Module
+    class Equalizer < ::Module
       # Initialize an Equalizer with the given keys
       #
       # Will use the keys with which it is initialized to define #cmp?,
@@ -29,6 +29,7 @@ module Dry
       #
       # @api private
       def initialize(*keys, **options)
+        super()
         @keys = keys.uniq
         define_methods(**options)
         freeze

data/lib/dry/core/memoizable.rb

@@ -1,67 +1,200 @@
 # frozen_string_literal: true
 
+require "dry/core/deprecations"
+
 module Dry
   module Core
     module Memoizable
       MEMOIZED_HASH = {}.freeze
+      PARAM_PLACEHOLDERS = %i[* ** &].freeze
 
       module ClassInterface
-        def memoize(*names)
-          prepend(Memoizer.new(self, names))
+        module Base
+          def memoize(*names)
+            prepend(Memoizer.new(self, names))
+          end
         end
 
-        def new(*)
-          obj = super
-          obj.instance_variable_set(:'@__memoized__', MEMOIZED_HASH.dup)
-          obj
+        module BasicObject
+          include Base
+
+          def new(*)
+            obj = super
+            obj.instance_eval { @__memoized__ = MEMOIZED_HASH.dup }
+            obj
+          end
+        end
+
+        module Object
+          include Base
+
+          def new(*)
+            obj = super
+            obj.instance_variable_set(:@__memoized__, MEMOIZED_HASH.dup)
+            obj
+          end
+
+          if respond_to?(:ruby2_keywords, true)
+            ruby2_keywords(:new)
+          end
         end
       end
 
       def self.included(klass)
         super
-        klass.extend(ClassInterface)
-      end
 
-      attr_reader :__memoized__
+        if klass <= Object
+          klass.extend(ClassInterface::Object)
+        else
+          klass.extend(ClassInterface::BasicObject)
+        end
+      end
 
       # @api private
-      class Memoizer < Module
-        attr_reader :klass
-        attr_reader :names
-
+      class Memoizer < ::Module
         # @api private
         def initialize(klass, names)
-          @names = names
-          @klass = klass
-          define_memoizable_names!
+          super()
+          names.each do |name|
+            define_memoizable(
+              method: klass.instance_method(name)
+            )
+          end
         end
 
         private
 
         # @api private
-        def define_memoizable_names!
-          names.each do |name|
-            meth = klass.instance_method(name)
-
-            if meth.parameters.size > 0
-              define_method(name) do |*args|
-                name_with_args = :"#{name}_#{args.hash}"
-
-                if __memoized__.key?(name_with_args)
-                  __memoized__[name_with_args]
-                else
-                  __memoized__[name_with_args] = super(*args)
-                end
-              end
+        def define_memoizable(method:) # rubocop:disable Metrics/AbcSize
+          parameters = method.parameters
+
+          if parameters.empty?
+            key = method.name.hash
+            module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+              def #{method.name}                    # def slow_fetch
+                if @__memoized__.key?(#{key})       #   if @__memoized__.key?(12345678)
+                  @__memoized__[#{key}]             #     @__memoized__[12345678]
+                else                                #   else
+                  @__memoized__[#{key}] = super     #     @__memoized__[12345678] = super
+                end                                 #   end
+              end                                   # end
+            RUBY
+          else
+            mapping = parameters.to_h { |k, v = nil| [k, v] }
+            params, binds = declaration(parameters, mapping)
+            last_param = parameters.last
+
+            if last_param[0].eql?(:block) && !last_param[1].eql?(:&)
+              Deprecations.warn(<<~WARN)
+                Memoization for block-accepting methods isn't safe.
+                Every call creates a new block instance bloating cached results.
+                In the future, blocks will still be allowed but won't participate in
+                cache key calculation.
+              WARN
+            end
+
+            m = module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+              def #{method.name}(#{params.join(", ")})                 # def slow_calc(arg1, arg2, arg3)
+                key = [:"#{method.name}", #{binds.join(", ")}].hash    #   [:slow_calc, arg1, arg2, arg3].hash
+                                                                       #
+                if @__memoized__.key?(key)                             #   if @__memoized__.key?(key)
+                  @__memoized__[key]                                   #     @__memoized__[key]
+                else                                                   #   else
+                  @__memoized__[key] = super                           #     @__memoized__[key] = super
+                end                                                    #   end
+              end                                                      # end
+            RUBY
+
+            if respond_to?(:ruby2_keywords, true) && mapping.key?(:reyrest)
+              ruby2_keywords(method.name)
+            end
+
+            m
+          end
+        end
+
+        # @api private
+        def declaration(definition, lookup)
+          params = []
+          binds = []
+          defined = {}
+
+          definition.each do |type, name|
+            mapped_type = map_bind_type(type, name, lookup, defined) do
+              raise ::NotImplementedError, "type: #{type}, name: #{name}"
+            end
+
+            if mapped_type
+              defined[mapped_type] = true
+              bind = name_from_param(name) || make_bind_name(binds.size)
+
+              binds << bind
+              params << param(bind, mapped_type)
+            end
+          end
+
+          [params, binds]
+        end
+
+        # @api private
+        def name_from_param(name)
+          if PARAM_PLACEHOLDERS.include?(name)
+            nil
+          else
+            name
+          end
+        end
+
+        # @api private
+        def make_bind_name(idx)
+          :"__lv_#{idx}__"
+        end
+
+        # @api private
+        def map_bind_type(type, name, original_params, defined_types) # rubocop:disable Metrics/PerceivedComplexity
+          case type
+          when :req
+            :reqular
+          when :rest, :keyreq, :keyrest
+            type
+          when :block
+            if name.eql?(:&)
+              # most likely this is a case of delegation
+              # rather than actual block
+              nil
+            else
+              type
+            end
+          when :opt
+            if original_params.key?(:rest) || defined_types[:rest]
+              nil
             else
-              define_method(name) do
-                if __memoized__.key?(name)
-                  __memoized__[name]
-                else
-                  __memoized__[name] = super()
-                end
-              end
+              :rest
             end
+          when :key
+            if original_params.key?(:keyrest) || defined_types[:keyrest]
+              nil
+            else
+              :keyrest
+            end
+          else
+            yield
+          end
+        end
+
+        # @api private
+        def param(name, type)
+          case type
+          when :reqular
+            name
+          when :rest
+            "*#{name}"
+          when :keyreq
+            "#{name}:"
+          when :keyrest
+            "**#{name}"
+          when :block
+            "&#{name}"
           end
         end
       end

data/lib/dry/core/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-core
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Nikita Shilnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -107,14 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A toolset of small support modules used throughout the dry-rb ecosystem