Class: Sinclair::MethodDefinition Private

Inherits:
Object
  • Object
show all
Includes:
OptionsParser
Defined in:
lib/sinclair/method_definition.rb,
lib/sinclair/method_definition/block_definition.rb,
lib/sinclair/method_definition/string_definition.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Definition of the code or block to be aded as method

Author:

  • darthjee

Direct Known Subclasses

BlockDefinition, StringDefinition

Defined Under Namespace

Classes: BlockDefinition, StringDefinition

Constant Summary collapse

DEFAULT_OPTIONS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Default options of initialization

{
  cached: false
}.freeze

Instance Attribute Summary

Attributes included from OptionsParser

#options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#options_object

Constructor Details

#initialize(name, **options) ⇒ MethodDefinition

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of MethodDefinition.

Parameters:

  • name (String, Symbol) —

    name of the method

  • options (Hash) —

    Options of construction

Options Hash (**options):

  • cached (Boolean) —

    Flag telling to create a method with cache



36
37
38
39
 
# File 'lib/sinclair/method_definition.rb', line 36

def initialize(name, **options)
  @name =    name
  @options = DEFAULT_OPTIONS.merge(options)
end

Class Method Details

.from(name, code = nil, **options, &block) ⇒ MethodDefinition

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new instance based on arguments

Returns:



24
25
26
27
28
29
30
 
# File 'lib/sinclair/method_definition.rb', line 24

def self.from(name, code = nil, **options, &block)
  if block
    BlockDefinition.new(name, **options, &block)
  else
    StringDefinition.new(name, code, **options)
  end
end

Instance Method Details

#build(_klass) ⇒ Symbol

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Adds the method to given klass

This should be implemented on child classes

Examples:

Using block method with no options

class MyModel
end

instance = MyModel.new

method_definition = Sinclair::MethodDefinition.from(
  :sequence, '@x = @x.to_i ** 2 + 1'
)

method_definition.build(klass)  # adds instance_method :sequence to
                               # MyModel instances

instance.instance_variable_get(:@x)        # returns nil

instance.sequence               # returns 1
instance.sequence               # returns 2
instance.sequence               # returns 5

instance.instance_variable_get(:@x)        # returns 5

Using string method with no options

class MyModel
end

instance = MyModel.new

method_definition = Sinclair::MethodDefinition.from(:sequence) do
  @x = @x.to_i ** 2 + 1
end

method_definition.build(klass)  # adds instance_method :sequence to
                               # MyModel instances

instance.instance_variable_get(:@sequence) # returns nil
instance.instance_variable_get(:@x)        # returns nil

instance.sequence               # returns 1
instance.sequence               # returns 1 (cached value)

instance.instance_variable_get(:@sequence) # returns 1
instance.instance_variable_get(:@x)        # returns 1

Parameters:

  • _klass (Class) —

    class which will receive the new method

Returns:

  • (Symbol) —

    name of the created method



91
92
93
94
 
# File 'lib/sinclair/method_definition.rb', line 91

def build(_klass)
  raise 'Build is implemented in subclasses. ' \
    "Use #{self.class}.from to initialize a proper object"
end