Class: Philosophal::Property

Inherits:
Object
  • Object
show all
Defined in:
lib/philosophal/property.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, default:, transform:, immutable:, description:, json:) ⇒ Property

Returns a new instance of Property.



5
6
7
8
9
10
11
12
13
 
# File 'lib/philosophal/property.rb', line 5

def initialize(name:, type:, default:, transform:, immutable:, description:, json:)
  @name = name
  @type = type
  @default = default
  @transform = transform
  @immutable = immutable
  @description = description
  @json = json
end

Instance Attribute Details

#default ⇒ Object (readonly)

Returns the value of attribute default.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def default
  @default
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def description
  @description
end

#immutable ⇒ Object (readonly)

Returns the value of attribute immutable.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def immutable
  @immutable
end

#json ⇒ Object (readonly)

Returns the value of attribute json.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def json
  @json
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def name
  @name
end

#transform ⇒ Object (readonly)

Returns the value of attribute transform.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def transform
  @transform
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



15
16
17
 
# File 'lib/philosophal/property.rb', line 15

def type
  @type
end

Instance Method Details

#check_conversion(value) ⇒ Object 



38
39
40
 
# File 'lib/philosophal/property.rb', line 38

def check_conversion(value)
  Philosophal.convert(self, value)
end

#default? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/philosophal/property.rb', line 23

def default?
  @default != nil
end

#default_value ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/philosophal/property.rb', line 27

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

#generate_boolean_method(buffer = +'')) ⇒ Object 



77
78
79
80
81
82
83
84
 
# File 'lib/philosophal/property.rb', line 77

def generate_boolean_method(buffer = +'')
  buffer <<
    ' def ' <<
    @name.name <<
    "?\n  " \
    '!!@' << @name.name <<
    "\nend\n"
end

#generate_description_method(buffer = +'')) ⇒ Object 



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

def generate_description_method(buffer = +'')
  buffer <<
    ' def ' <<
    @name.name <<
    "_description\n  " \
    '%(' << @description << ')' \
                            "\nend\n"
end

#generate_immutable_writer_method(buffer = +'')) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/philosophal/property.rb', line 53

def generate_immutable_writer_method(buffer = +'')
  buffer <<
    ' def ' << @name.name << "=(value)\n  " \
                             'raise FrozenError, "can\'t modify frozen variable @' <<
    @name.name << '" if defined?(@' << @name.name << ")\n" \
                                                     '@' << @name.name << ' = self.class.philosophal_properties[:' <<
    @name.name <<
    "].check_conversion(value).freeze\n" \
    "rescue Philosophal::TypeError => error\n" \
    "error.set_backtrace(caller(1))\n  raise\n" \
    "end\n"
end

#generate_reader_method(buffer = +'')) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/philosophal/property.rb', line 66

def generate_reader_method(buffer = +'')
  buffer <<
    ' def ' <<
    @name.name <<
    "\n  " \
    '@' << @name.name << ' || self.class.philosophal_properties[:' <<
    @name.name <<
    "].default_value\n" \
    "end\n"
end

#generate_writer_method(buffer = +'')) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/philosophal/property.rb', line 42

def generate_writer_method(buffer = +'')
  buffer <<
    ' def ' << @name.name << "=(value)\n  " \
                             '@' << @name.name << ' = self.class.philosophal_properties[:' <<
    @name.name <<
    "].check_conversion(value)\n" \
    "rescue Philosophal::TypeError => error\n" \
    "error.set_backtrace(caller(1))\n  raise\n" \
    "end\n"
end

#json_name ⇒ Object 



17
18
19
20
21
 
# File 'lib/philosophal/property.rb', line 17

def json_name
  return @json if @json.is_a?(Symbol)

  @name
end

#transform? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/philosophal/property.rb', line 34

def transform?
  @transform != nil
end