Class: ROM::ConfigurationDSL::CommandDSL

Inherits:
Object
  • Object
show all
Defined in:
core/lib/rom/configuration_dsl/command_dsl.rb

Overview

Command define DSL used by Setup#commands

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(relation, adapter = nil, &block) ⇒ CommandDSL

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 CommandDSL.



14
15
16
17
18
19
 
# File 'core/lib/rom/configuration_dsl/command_dsl.rb', line 14

def initialize(relation, adapter = nil, &block)
  @relation = relation
  @adapter = adapter
  @command_classes = []
  instance_exec(&block)
end

Instance Attribute Details

#adapter ⇒ Object (readonly) 



11
12
13
 
# File 'core/lib/rom/configuration_dsl/command_dsl.rb', line 11

def adapter
  @adapter
end

#command_classes ⇒ Object (readonly) 



11
12
13
 
# File 'core/lib/rom/configuration_dsl/command_dsl.rb', line 11

def command_classes
  @command_classes
end

#relation ⇒ Object (readonly) 



11
12
13
 
# File 'core/lib/rom/configuration_dsl/command_dsl.rb', line 11

def relation
  @relation
end

Instance Method Details

#define(name, options = EMPTY_HASH, &block) ⇒ Class

Define a command class

Parameters:

  • name (Symbol) —

    of the command

  • options (Hash) (defaults to: EMPTY_HASH)

Options Hash (options):

  • :type (Symbol) —

    The type of the command

Returns:

  • (Class) —

    generated class



30
31
32
33
34
 
# File 'core/lib/rom/configuration_dsl/command_dsl.rb', line 30

def define(name, options = EMPTY_HASH, &block)
  @command_classes << Command.build_class(
    name, relation, { adapter: adapter }.merge(options), &block
  )
end