Module: Micro::Struct

Defined in:

lib/micro/struct.rb,
lib/micro/struct/factory.rb,
lib/micro/struct/version.rb,
lib/micro/struct/features.rb,
lib/micro/struct/factory/members.rb,
lib/micro/struct/normalize_names.rb

Overview

Like in a regular Struct, you can define one or many attributes. But all of them will be required by default.

Micro::Struct.new(:first_name, :last_name, ...)

Use the ‘optional:` arg if you want some optional attributes.

Micro::Struct.new(:first_name, :last_name, optional: :gender)

Using ‘optional:` to define all attributes are optional.

Micro::Struct.new(optional: [:first_name, :last_name])

Use the ‘required:` arg to define required attributes.

Micro::Struct.new(
  required: [:first_name, :last_name],
  optional: [:gender, :age]
)

You can also pass a block to define custom methods.

Micro::Struct.new(:name) {}

Available features (use one, many, or all) to create Structs with a special behavior: .with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy)

Micro::Struct.with(:to_ary).new(:name)
Micro::Struct.with(:to_ary, :to_hash).new(:name)
Micro::Struct.with(:to_ary, :to_hash, :to_proc).new(:name)
Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly).new(:name)
Micro::Struct.with(:to_ary, :to_hash, :to_proc, :readonly, :instance_copy).new(:name)

All of the possible combinations to create a Ruby Struct. ;)

Micro::Struct.new(optional: *)
Micro::Struct.new(optional: *) {}

Micro::Struct.new(required: *)
Micro::Struct.new(required: *) {}

Micro::Struct.new(*required, optional: *)
Micro::Struct.new(*required, optional: *) {}

Micro::Struct.new(required: *, optional: *)
Micro::Struct.new(required: *, optional: *) {}

Any options above can be used by the ‘.new()` method of the struct creator returned by the `.with()` method.

Micro::Struct.with(*features).new(...) {}

Constant Summary

VERSION =

'0.11.0'

Class Method Summary

• .new(*members, required: nil, optional: nil, &block) ⇒ Object
• .with(*features) ⇒ Object

Class Method Details

.new(*members, required: nil, optional: nil, &block) ⇒ Object

# File 'lib/micro/struct.rb', line 60

def self.new(*members, required: nil, optional: nil, &block)
  with.new(*members, required: required, optional: optional, &block)
end

.with(*features) ⇒ Object

# File 'lib/micro/struct.rb', line 64

def self.with(*features)
  Factory.new(features)
end