Class: Permify::Comprehension

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

Overview

A comprehension expression applied to a list or map. Comprehensions are not part of the core syntax, but enabled with macros. A macro matches a specific call signature within a parsed AST and replaces the call with an alternate AST block. Macro expansion happens at parse time. The following macros are supported within CEL: Aggregate type macros may be applied to all elements in a list or all keys in a map: * all, exists, exists_one - test a predicate expression against the inputs and return true if the predicate is satisfied for all, any, or only one value ‘list.all(x, x < 10)`. * filter - test a predicate expression against the inputs and return the subset of elements which satisfy the predicate: `payments.filter(p, p > 1000)`. * map - apply an expression to all elements in the input and return the output aggregate type: `[1, 2, 3].map(i, i * i)`. The `has(m.x)` macro tests whether the property x is present in struct m. The semantics of this macro depend on the type of m. For proto2 messages `has(m.x)` is defined as ’defined, but not set`. For proto3, the macro tests whether the property is set to its default. For map and struct types, the macro tests whether the property x is defined on m. Comprehensions for the standard environment macros evaluation can be best visualized as the following pseudocode: “‘ let accu_var = accu_init for (let iter_var in iter_range) { if (!loop_condition) { break } accu_var = loop_step } return result “` Comprehensions for the optional V2 macros which support map-to-map translation differ slightly from the standard environment macros in that they expose both the key or index in addition to the value for each list or map entry: “` let accu_var = accu_init for (let iter_var, iter_var2 in iter_range) { if (!loop_condition) { break } accu_var = loop_step } return result “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Comprehension

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
 
# File 'lib/permify/models/comprehension.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Permify::Comprehension` 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::Comprehension`. 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?(:'iter_var')
    self.iter_var = attributes[:'iter_var']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#accu_init ⇒ Object

Returns the value of attribute accu_init.



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

def accu_init
  @accu_init
end

#accu_var ⇒ Object

The name of the variable used for accumulation of the result.



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

def accu_var
  @accu_var
end

#iter_range ⇒ Object

Returns the value of attribute iter_range.



25
26
27
 
# File 'lib/permify/models/comprehension.rb', line 25

def iter_range
  @iter_range
end

#iter_var ⇒ Object

The name of the first iteration variable. When the iter_range is a list, this variable is the list element. When the iter_range is a map, this variable is the map entry key.



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

def iter_var
  @iter_var
end

#iter_var2 ⇒ Object

The name of the second iteration variable, empty if not set. When the iter_range is a list, this variable is the integer index. When the iter_range is a map, this variable is the map entry value. This field is only set for comprehension v2 macros.



23
24
25
 
# File 'lib/permify/models/comprehension.rb', line 23

def iter_var2
  @iter_var2
end

#loop_condition ⇒ Object

Returns the value of attribute loop_condition.



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

def loop_condition
  @loop_condition
end

#loop_step ⇒ Object

Returns the value of attribute loop_step.



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

def loop_step
  @loop_step
end

#result ⇒ Object

Returns the value of attribute result.



36
37
38
 
# File 'lib/permify/models/comprehension.rb', line 36

def result
  @result
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



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
230
231
 
# File 'lib/permify/models/comprehension.rb', line 194

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



53
54
55
 
# File 'lib/permify/models/comprehension.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/permify/models/comprehension.rb', line 39

def self.attribute_map
  {
    :'iter_var' => :'iterVar',
    :'iter_var2' => :'iterVar2',
    :'iter_range' => :'iterRange',
    :'accu_var' => :'accuVar',
    :'accu_init' => :'accuInit',
    :'loop_condition' => :'loopCondition',
    :'loop_step' => :'loopStep',
    :'result' => :'result'
  }
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



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

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



72
73
74
75
 
# File 'lib/permify/models/comprehension.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/permify/models/comprehension.rb', line 58

def self.openapi_types
  {
    :'iter_var' => :'String',
    :'iter_var2' => :'String',
    :'iter_range' => :'Expr',
    :'accu_var' => :'String',
    :'accu_init' => :'Expr',
    :'loop_condition' => :'Expr',
    :'loop_step' => :'Expr',
    :'result' => :'Expr'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/permify/models/comprehension.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      iter_var == o.iter_var &&
      iter_var2 == o.iter_var2 &&
      iter_range == o.iter_range &&
      accu_var == o.accu_var &&
      accu_init == o.accu_init &&
      loop_condition == o.loop_condition &&
      loop_step == o.loop_step &&
      result == o.result
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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/permify/models/comprehension.rb', line 265

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


157
158
159
 
# File 'lib/permify/models/comprehension.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/permify/models/comprehension.rb', line 163

def hash
  [iter_var, iter_var2, iter_range, accu_var, accu_init, loop_condition, loop_step, result].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



127
128
129
130
131
 
# File 'lib/permify/models/comprehension.rb', line 127

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



241
242
243
 
# File 'lib/permify/models/comprehension.rb', line 241

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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/permify/models/comprehension.rb', line 247

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



235
236
237
 
# File 'lib/permify/models/comprehension.rb', line 235

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



135
136
137
138
 
# File 'lib/permify/models/comprehension.rb', line 135

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