Class: Permify::Expr

Inherits:
Object
  • Object
show all
Defined in:
lib/permify/models/expr.rb

Overview

An abstract representation of a common expression. Expressions are abstractly represented as a collection of identifiers, select statements, function calls, literals, and comprehensions. All operators with the exception of the ‘.’ operator are modelled as function calls. This makes it easy to represent new operators into the existing AST. All references within expressions must resolve to a [Decl] provided at type-check for an expression to be valid. A reference may either be a bare identifier name or a qualified identifier google.api.name. References may either refer to a value or a function declaration. For example, the expression ‘google.api.name.startsWith(’expr’)‘ references the declaration google.api.name within a [Expr.Select] expression, and the function declaration startsWith.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Expr

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/permify/models/expr.rb', line 77

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Permify::Expr` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Permify::Expr`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'const_expr')
    self.const_expr = attributes[:'const_expr']
  end

  if attributes.key?(:'ident_expr')
    self.ident_expr = attributes[:'ident_expr']
  end

  if attributes.key?(:'select_expr')
    self.select_expr = attributes[:'select_expr']
  end

  if attributes.key?(:'call_expr')
    self.call_expr = attributes[:'call_expr']
  end

  if attributes.key?(:'list_expr')
    self.list_expr = attributes[:'list_expr']
  end

  if attributes.key?(:'struct_expr')
    self.struct_expr = attributes[:'struct_expr']
  end

  if attributes.key?(:'comprehension_expr')
    self.comprehension_expr = attributes[:'comprehension_expr']
  end
end

Instance Attribute Details

#call_expr ⇒ Object

Returns the value of attribute call_expr.



28
29
30
 
# File 'lib/permify/models/expr.rb', line 28

def call_expr
  @call_expr
end

#comprehension_expr ⇒ Object

Returns the value of attribute comprehension_expr.



34
35
36
 
# File 'lib/permify/models/expr.rb', line 34

def comprehension_expr
  @comprehension_expr
end

#const_expr ⇒ Object

Returns the value of attribute const_expr.



22
23
24
 
# File 'lib/permify/models/expr.rb', line 22

def const_expr
  @const_expr
end

#id ⇒ Object

Required. An id assigned to this node by the parser which is unique in a given expression tree. This is used to associate type information and other attributes to a node in the parse tree.



20
21
22
 
# File 'lib/permify/models/expr.rb', line 20

def id
  @id
end

#ident_expr ⇒ Object

Returns the value of attribute ident_expr.



24
25
26
 
# File 'lib/permify/models/expr.rb', line 24

def ident_expr
  @ident_expr
end

#list_expr ⇒ Object

Returns the value of attribute list_expr.



30
31
32
 
# File 'lib/permify/models/expr.rb', line 30

def list_expr
  @list_expr
end

#select_expr ⇒ Object

Returns the value of attribute select_expr.



26
27
28
 
# File 'lib/permify/models/expr.rb', line 26

def select_expr
  @select_expr
end

#struct_expr ⇒ Object

Returns the value of attribute struct_expr.



32
33
34
 
# File 'lib/permify/models/expr.rb', line 32

def struct_expr
  @struct_expr
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/permify/models/expr.rb', line 192

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Permify.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/permify/models/expr.rb', line 51

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/permify/models/expr.rb', line 37

def self.attribute_map
  {
    :'id' => :'id',
    :'const_expr' => :'constExpr',
    :'ident_expr' => :'identExpr',
    :'select_expr' => :'selectExpr',
    :'call_expr' => :'callExpr',
    :'list_expr' => :'listExpr',
    :'struct_expr' => :'structExpr',
    :'comprehension_expr' => :'comprehensionExpr'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/permify/models/expr.rb', line 168

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/permify/models/expr.rb', line 70

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/permify/models/expr.rb', line 56

def self.openapi_types
  {
    :'id' => :'String',
    :'const_expr' => :'Constant',
    :'ident_expr' => :'Ident',
    :'select_expr' => :'Select',
    :'call_expr' => :'ExprCall',
    :'list_expr' => :'CreateList',
    :'struct_expr' => :'CreateStruct',
    :'comprehension_expr' => :'Comprehension'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/permify/models/expr.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      const_expr == o.const_expr &&
      ident_expr == o.ident_expr &&
      select_expr == o.select_expr &&
      call_expr == o.call_expr &&
      list_expr == o.list_expr &&
      struct_expr == o.struct_expr &&
      comprehension_expr == o.comprehension_expr
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/permify/models/expr.rb', line 263

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/permify/models/expr.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/permify/models/expr.rb', line 161

def hash
  [id, const_expr, ident_expr, select_expr, call_expr, list_expr, struct_expr, comprehension_expr].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



125
126
127
128
129
 
# File 'lib/permify/models/expr.rb', line 125

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
 
# File 'lib/permify/models/expr.rb', line 239

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/permify/models/expr.rb', line 245

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



233
234
235
 
# File 'lib/permify/models/expr.rb', line 233

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



133
134
135
136
 
# File 'lib/permify/models/expr.rb', line 133

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end