Class: ROM::Finalize::FinalizeRelations

Inherits:
Object
  • Object
show all
Defined in:
lib/rom/setup/finalize/finalize_relations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(gateways, relation_classes, notifications:, mappers: nil, plugins: EMPTY_ARRAY) ⇒ FinalizeRelations

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.

Build relation registry of specified descendant classes

This is used by the setup

Parameters:

  • a list of relation descendants

API:

  • private



18
19
20
21
22
23
24
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 18

def initialize(gateways, relation_classes, notifications:, mappers: nil, plugins: EMPTY_ARRAY)
  @gateways = gateways
  @relation_classes = relation_classes
  @mappers = mappers
  @plugins = plugins
  @notifications = notifications
end

Instance Attribute Details

#notifications ⇒ Object (readonly)

Returns the value of attribute notifications.



8
9
10
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 8

def notifications
  @notifications
end

Instance Method Details

#build_relation(klass, registry) ⇒ ROM::Relation

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:

API:

  • private



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 69

def build_relation(klass, registry)
  # TODO: raise a meaningful error here and add spec covering the case
  #       where klass' gateway points to non-existant repo
  gateway = @gateways.fetch(klass.gateway)

  plugins = schema_plugins

  schema = klass.schema_proc.call do
    plugins.each { |plugin| app_plugin(plugin) }
  end

  klass.set_schema!(schema) if klass.schema.nil?

  notifications.trigger(
    'configuration.relations.schema.allocated',
    schema: schema, gateway: gateway, registry: registry
  )

  relation_plugins.each do |plugin|
    plugin.apply_to(klass)
  end

  notifications.trigger(
    'configuration.relations.schema.set',
    schema: schema, relation: klass, adapter: klass.adapter
  )

  rel_key = schema.name.to_sym
  dataset = gateway.dataset(schema.name.dataset).instance_exec(klass, &klass.dataset)

  notifications.trigger(
    'configuration.relations.dataset.allocated',
    dataset: dataset, relation: klass, adapter: klass.adapter
  )

  mappers = @mappers.key?(rel_key) ? @mappers[rel_key] : MapperRegistry.new({}, cache: @mappers.cache)

  options = { __registry__: registry, mappers: mappers, schema: schema, **plugin_options }

  klass.new(dataset, options)
end

#plugin_options ⇒ Object

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.

API:

  • private



112
113
114
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 112

def plugin_options
  relation_plugins.map(&:config).map(&:to_hash).reduce(:merge) || EMPTY_HASH
end

#relation_names ⇒ Object

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.

API:

  • private



127
128
129
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 127

def relation_names
  @relation_classes.map(&:relation_name).map(&:relation).uniq
end

#relation_plugins ⇒ Object

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.

API:

  • private



117
118
119
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 117

def relation_plugins
  @plugins.select(&:relation?)
end

#run! ⇒ Hash

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:

API:

  • private



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 29

def run!
  relation_registry = RelationRegistry.new do |registry, relations|
    @relation_classes.each do |klass|
      unless klass.adapter
        raise MissingAdapterIdentifierError,
              "Relation class +#{klass}+ is missing the adapter identifier"
      end

      key = klass.relation_name.to_sym

      if registry.key?(key)
        raise RelationAlreadyDefinedError,
              "Relation with name #{key.inspect} registered more than once"
      end

      klass.use(:registry_reader, relation_names)

      notifications.trigger('configuration.relations.class.ready', relation: klass)

      relations[key] = build_relation(klass, registry)
    end

    registry.each do |_, relation|
      notifications.trigger(
        'configuration.relations.object.registered',
        relation: relation, registry: registry
      )
    end
  end

  notifications.trigger(
    'configuration.relations.registry.created', registry: relation_registry
  )

  relation_registry
end

#schema_plugins ⇒ Object

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.

API:

  • private



122
123
124
 
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 122

def schema_plugins
  @plugins.select(&:schema?)
end