Class: ObjectForge::Forge

Inherits:
Object
  • Object
show all
Defined in:
lib/object_forge/forge.rb

Overview

Object building forge.

Usually created through Forge.define or ObjectForge::Forgeyard#define using ForgeDSL. Alternatively, can be directly initalized with Parameters if you prefer not using the DSL.

Then, #forge can be called to build instances of #forge_target.

Since:

  • 0.1.0

Defined Under Namespace

Classes: Parameters

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(forge_target, parameters, name: nil, yard: nil) ⇒ Forge

Returns a new instance of Forge.

Parameters:

  • forge_target (Class, Any) —

    class or object to forge, will be passed to mold as forge_target argument

  • parameters (Parameters, ForgeDSL) —

    forge parameters

  • name (Symbol, nil) (defaults to: nil) —

    forge name

  • yard (Forgeyard, nil) (defaults to: nil) —

    forgeyard this forge belongs to

Raises:

Since:

  • 0.1.0



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/object_forge/forge.rb', line 81

def initialize(forge_target, parameters, name: nil, yard: nil)
  @name = name
  @yard = yard
  @forge_target = forge_target
  @parameters = parameters

  options = @parameters.options
  @crucible = determine_crucible(options)
  @mold = determine_mold(forge_target, options)
  @after_forge_hook = determine_after_forge_hook(options)
  validate_other_options(options)
end

Instance Attribute Details

#forge_target ⇒ Class, Any (readonly) Also known as: target

Returns class or object to forge.

Returns:

  • (Class, Any) —

    class or object to forge

Since:

  • 0.4.0



67
68
69
 
# File 'lib/object_forge/forge.rb', line 67

def forge_target
  @forge_target
end

#name ⇒ Symbol? (readonly)

Returns forge name, only used for identification purposes.

Returns:

  • (Symbol, nil) —

    forge name, only used for identification purposes

Since:

  • 0.1.0



60
61
62
 
# File 'lib/object_forge/forge.rb', line 60

def name
  @name
end

#parameters ⇒ Parameters, ForgeDSL (readonly)

Returns forge parameters.

Returns:

Since:

  • 0.1.0



71
72
73
 
# File 'lib/object_forge/forge.rb', line 71

def parameters
  @parameters
end

#yard ⇒ Forgeyard? (readonly)

Returns forgeyard this forge belongs to.

Returns:

  • (Forgeyard, nil) —

    forgeyard this forge belongs to

Since:

  • 0.1.0



63
64
65
 
# File 'lib/object_forge/forge.rb', line 63

def yard
  @yard
end

Class Method Details

.define(forge_target, name: nil, yard: nil) {|dsl| ... } ⇒ Forge

Define (and initialize) a forge using DSL.

Parameters:

  • forge_target (Class, Any) —

    class or object to forge

  • name (Symbol, nil) (defaults to: nil) —

    forge name

  • yard (Forgeyard, nil) (defaults to: nil) —

    forgeyard this forge belongs to

Yield Parameters:

Yield Returns:

  • (void)

Returns:

See Also:

Since:

  • 0.1.0



55
56
57
 
# File 'lib/object_forge/forge.rb', line 55

def self.define(forge_target, name: nil, yard: nil, &)
  new(forge_target, ForgeDSL.new(&), name:, yard:)
end

Instance Method Details

#forge(*traits, **overrides) {|object| ... } ⇒ Any Also known as: build, call

Forge a new instance, applying attributes to forge target.

Positional arguments are taken as trait names, keyword arguments as attribute overrides. All traits and overrides are applied in argument order, with overrides always applied after traits.

If a block is given, forged instance is yielded to it after being built.

Parameters:

  • traits (Array<Symbol>) —

    traits to apply

  • overrides (Hash{Symbol => Proc, Any}) —

    attribute overrides

Yield Parameters:

  • object (Any) —

    forged instance

Yield Returns:

  • (void)

Returns:

  • (Any) —

    forged instance

Raises:

  • (ArgumentError) —

    if a trait name is unknown

Since:

  • 0.1.0



112
113
114
115
116
117
118
 
# File 'lib/object_forge/forge.rb', line 112

def forge(*traits, **overrides)
  attributes = build_attribute_hash(traits, overrides)
  instance = @mold.call(forge_target: @forge_target, attributes: attributes)
  @after_forge_hook&.call(instance)
  yield instance if block_given?
  instance
end