Class: Literal::Property

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/literal/property.rb

Direct Known Subclasses

DataProperty

Constant Summary collapse

ORDER = 
{ :positional => 0, :* => 1, :keyword => 2, :** => 3, :& => 4 }.freeze
RUBY_KEYWORDS = 
%i[alias and begin break case class def do else elsif end ensure false for if in module next nil not or redo rescue retry return self super then true undef unless until when while yield].to_h { |k| [k, "__#{k}__"] }.freeze
VISIBILITY_OPTIONS = 
Set[false, :private, :protected, :public].freeze
KIND_OPTIONS = 
Set[:positional, :*, :keyword, :**, :&].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, kind:, reader:, writer:, default:, coercion:) ⇒ Property

Returns a new instance of Property.



12
13
14
15
16
17
18
19
20
 
# File 'lib/literal/property.rb', line 12

def initialize(name:, type:, kind:, reader:, writer:, default:, coercion:)
	@name = name
	@type = type
	@kind = kind
	@reader = reader
	@writer = writer
	@default = default
	@coercion = coercion
end

Instance Attribute Details

#coercion ⇒ Object (readonly)

Returns the value of attribute coercion.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def coercion
  @coercion
end

#default ⇒ Object (readonly)

Returns the value of attribute default.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def default
  @default
end

#kind ⇒ Object (readonly)

Returns the value of attribute kind.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def kind
  @kind
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def name
  @name
end

#reader ⇒ Object (readonly)

Returns the value of attribute reader.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def reader
  @reader
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def type
  @type
end

#writer ⇒ Object (readonly)

Returns the value of attribute writer.



22
23
24
 
# File 'lib/literal/property.rb', line 22

def writer
  @writer
end

Instance Method Details

#<=>(other) ⇒ Object 



24
25
26
 
# File 'lib/literal/property.rb', line 24

def <=>(other)
	ORDER[@kind] <=> ORDER[other.kind]
end

#check(value) ⇒ Object 



47
48
49
 
# File 'lib/literal/property.rb', line 47

def check(value)
	Literal.check(value, @type)
end

#coerce(value, context:) ⇒ Object 



28
29
30
 
# File 'lib/literal/property.rb', line 28

def coerce(value, context:)
	context.instance_exec(value, &@coercion)
end

#default_value ⇒ Object 



40
41
42
43
44
45
 
# File 'lib/literal/property.rb', line 40

def default_value
	case @default
		when Proc then @default.call
		else @default
	end
end

#escaped_name ⇒ Object Also known as: local_var_ref 



36
37
38
 
# File 'lib/literal/property.rb', line 36

def escaped_name
	RUBY_KEYWORDS[@name] || @name
end

#generate_initializer_assign_default ⇒ Object (private) 



107
108
109
110
111
112
113
 
# File 'lib/literal/property.rb', line 107

def generate_initializer_assign_default
	[
		"if #{(@kind == :&) ? 'nil' : 'Literal::Null'} == #{local_var_ref}",
		"#{local_var_ref} = @literal_properties[#{symbol_ref}].default_value",
		"end",
	].join("\n")
end

#generate_initializer_assign_value ⇒ Object (private) 



119
120
121
 
# File 'lib/literal/property.rb', line 119

def generate_initializer_assign_value
	"#{ivar_ref} = #{local_var_ref}"
end

#generate_initializer_check_type ⇒ Object (private) 



115
116
117
 
# File 'lib/literal/property.rb', line 115

def generate_initializer_check_type
	"@literal_properties[:#{name}].check(#{escaped_name})"
end

#generate_initializer_coerce_property ⇒ Object (private) 



103
104
105
 
# File 'lib/literal/property.rb', line 103

def generate_initializer_coerce_property
	"#{escaped_name} = @literal_properties[#{symbol_ref}].coerce(#{local_var_ref}, context: self)"
end

#generate_initializer_escape_keyword ⇒ Object (private) 



99
100
101
 
# File 'lib/literal/property.rb', line 99

def generate_initializer_escape_keyword
	"#{escaped_name} = binding.local_variable_get(#{symbol_ref})"
end

#generate_initializer_handle_property ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/literal/property.rb', line 86

def generate_initializer_handle_property
	[
		"# #{name}",
		(generate_initializer_escape_keyword if (@kind == :keyword) && ruby_keyword?),
		(generate_initializer_coerce_property if @coercion),
		(generate_initializer_assign_default if @default),
		(generate_initializer_check_type unless Literal::TYPE_CHECKS_DISABLED),
		(generate_initializer_assign_value),
	].join("\n")
end

#generate_reader_method ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/literal/property.rb', line 61

def generate_reader_method
	[
		"#{@reader || :public} ",
		[
			"def #{@name}",
			"value = #{ivar_ref}",
			("@literal_properties[#{symbol_ref}].check(value)" unless Literal::TYPE_CHECKS_DISABLED),
			"value",
			"end",
		].join("\n"),
	].join
end

#generate_writer_method ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/literal/property.rb', line 74

def generate_writer_method
	[
		"#{writer || :public} ",
		[
			"def #{name}=(value)",
			("@literal_properties[#{symbol_ref}].check(value)" unless Literal::TYPE_CHECKS_DISABLED),
			"@#{name} = value",
			"end",
		].join("\n"),
	].join
end

#ivar_ref ⇒ Object 



51
52
53
 
# File 'lib/literal/property.rb', line 51

def ivar_ref
	"@#{@name}"
end

#ruby_keyword? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/literal/property.rb', line 32

def ruby_keyword?
	!!RUBY_KEYWORDS[@name]
end

#symbol_ref ⇒ Object 



57
58
59
 
# File 'lib/literal/property.rb', line 57

def symbol_ref
	":#{@name}"
end