Module: LazyLazer::ClassMethods

Defined in:
lib/lazy_lazer.rb

Overview

The methods to extend the class with.

Instance Method Summary collapse

Instance Method Details

#inherited(klass) ⇒ void

This method returns an undefined value.

Copies parent properties into subclasses.

Parameters:

  • klass (Class) —

    the subclass



31
32
33
 
# File 'lib/lazy_lazer.rb', line 31

def inherited(klass)
  klass.instance_variable_set(:@_lazer_metadata, @_lazer_metadata.dup)
end

#property(name, *bool_options, **options) ⇒ Symbol

Define a property.

Examples:

class MyModel
  include LazyLazer

  property :id, :required
  property :timestamp, with: ->(i) { Time.at(i) }
  property :created_at, default: ->() { Time.now }
  property :camel_case, from: :camelCase
end

Parameters:

  • name (Symbol) —

    the name of the property method

  • bool_options (Array<Symbol>) —

    options that are set to true

  • options (Hash) —

    the options to create the property with

Options Hash (**options):

  • :required (Boolean) — default: false —

    whether existence of this property should be checked on model creation

  • :nil (Boolean) — default: false —

    shortcut for default: nil

  • :default (Object, Proc) —

    the default value to return if not provided

  • :from (Symbol) — default: name —

    the key in the source object to get the property from

  • :with (Proc, Symbol, nil) —

    an optional transformation to apply to the value

Returns:

  • (Symbol) —

    the name of the created property



56
57
58
59
60
 
# File 'lib/lazy_lazer.rb', line 56

def property(name, *bool_options, **options)
  sym_name = name.to_sym
  @_lazer_metadata.add(sym_name, KeyMetadata.new(sym_name, *bool_options, **options))
  define_method(sym_name) { read_attribute(sym_name) }
end