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, **options) ⇒ 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:

  • gateways (Hash)
  • relation_classes (Array)

    a list of relation descendants


23
24
25
26
27
28
29
30
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 23

def initialize(gateways, relation_classes, **options)
  @gateways = gateways
  @relation_classes = relation_classes
  @inflector = options.fetch(:inflector, Inflector)
  @mappers = options.fetch(:mappers, nil)
  @plugins = options.fetch(:plugins, EMPTY_ARRAY)
  @notifications = options.fetch(:notifications)
end

Instance Attribute Details

#inflectorObject (readonly)

Returns the value of attribute inflector


13
14
15
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 13

def inflector
  @inflector
end

#notificationsObject (readonly)

Returns the value of attribute notifications


11
12
13
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 11

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:


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
110
111
112
113
114
115
116
117
118
119
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 75

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, registry: registry, 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
  )

  options = {
    __registry__: registry,
    mappers: mapper_registry(rel_key, klass),
    schema: schema,
    inflector: inflector,
    **plugin_options
  }

  klass.new(dataset, **options)
end

#mapper_registry(rel_key, rel_class) ⇒ 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.


122
123
124
125
126
127
128
129
130
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 122

def mapper_registry(rel_key, rel_class)
  registry = rel_class.mapper_registry(cache: @mappers.cache)

  if @mappers.key?(rel_key)
    registry.merge(@mappers[rel_key])
  else
    registry
  end
end

#plugin_optionsObject

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.


133
134
135
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 133

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

#relation_namesObject

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.


148
149
150
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 148

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

#relation_pluginsObject

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.


138
139
140
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 138

def relation_plugins
  @plugins.select { |p| p.type == :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:

  • (Hash)

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
65
66
67
68
69
70
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 35

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, relations: relation_names)

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

      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_pluginsObject

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.


143
144
145
# File 'lib/rom/setup/finalize/finalize_relations.rb', line 143

def schema_plugins
  @plugins.select { |p| p.type == :schema }
end