Module: Dry::Core::Deprecations::Interface

Defined in:
lib/dry/core/deprecations.rb

Instance Method Summary collapse

Instance Method Details

#deprecate(old_name, new_name = nil, message: nil) ⇒ Object

Mark instance method as deprecated

Parameters:

  • old_name (Symbol) —

    deprecated method

  • new_name (Symbol) (defaults to: nil) —

    replacement (not required)

  • [String] (Hash) —

    a customizable set of options



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/dry/core/deprecations.rb', line 144

def deprecate(old_name, new_name = nil, message: nil)
  full_msg = Deprecations.deprecated_method_message(
    "#{self.name}##{old_name}",
    new_name ? "#{self.name}##{new_name}" : nil,
    message
  )
  mod = self

  if new_name
    undef_method old_name if method_defined?(old_name)

    define_method(old_name) do |*args, &block|
      mod.warn("#{ full_msg }\n#{ STACK.() }")
      __send__(new_name, *args, &block)
    end
  else
    aliased_name = :"#{old_name}_without_deprecation"
    alias_method aliased_name, old_name
    private aliased_name
    undef_method old_name

    define_method(old_name) do |*args, &block|
      mod.warn("#{ full_msg }\n#{ STACK.() }")
      __send__(aliased_name, *args, &block)
    end
  end
end

#deprecate_class_method(old_name, new_name = nil, message: nil) ⇒ Object

Mark class-level method as deprecated

Parameters:

  • old_name (Symbol) —

    deprecated method

  • new_name (Symbol) (defaults to: nil) —

    replacement (not required)

  • [String] (Hash) —

    a customizable set of options



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/dry/core/deprecations.rb', line 177

def deprecate_class_method(old_name, new_name = nil, message: nil)
  full_msg = Deprecations.deprecated_method_message(
    "#{self.name}.#{old_name}",
    new_name ? "#{self.name}.#{new_name}" : nil,
    message
  )

  meth = new_name ? method(new_name) : method(old_name)

  singleton_class.instance_exec do
    undef_method old_name if method_defined?(old_name)

    define_method(old_name) do |*args, &block|
      warn("#{ full_msg }\n#{ STACK.() }")
      meth.call(*args, &block)
    end
  end
end

#deprecation_tag(tag = nil) ⇒ Object

Sets/gets deprecation tag

Parameters:

  • [String,Symbol] (Hash) —

    a customizable set of options



124
125
126
127
128
129
130
 
# File 'lib/dry/core/deprecations.rb', line 124

def deprecation_tag(tag = nil)
  if defined?(@deprecation_tag)
    @deprecation_tag
  else
    @deprecation_tag = tag
  end
end

#warn(msg) ⇒ Object

Issue a tagged warning message

Parameters:

  • msg (String) —

    warning message



135
136
137
 
# File 'lib/dry/core/deprecations.rb', line 135

def warn(msg)
  Deprecations.warn(msg, tag: deprecation_tag)
end