Class: J2119::Assigner

Inherits:
Object
  • Object
show all
Defined in:
lib/j2119/assigner.rb

Overview

Looks at the parsed form of the J2119 lines and figures out,

by looking at which part of the regexes match, 
the assignments of roles to nodes and constraints to roles

Instance Method Summary collapse

Constructor Details

#initialize(role_constraints, role_finder, matcher, allowed_fields) ⇒ Assigner

Returns a new instance of Assigner.



21
22
23
24
25
26
 
# File 'lib/j2119/assigner.rb', line 21

def initialize(role_constraints, role_finder, matcher, allowed_fields)
  @constraints = role_constraints
  @roles = role_finder
  @matcher = matcher
  @allowed_fields = allowed_fields
end

Instance Method Details

#add_constraint(role, constraint, condition) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/j2119/assigner.rb', line 131

def add_constraint(role, constraint, condition)
  if condition
    constraint.add_condition condition
  end
  @constraints.add(role, constraint)
end

#add_relation_constraint(role, field, relation, target, condition) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/j2119/assigner.rb', line 138

def add_relation_constraint(role, field, relation, target, condition)
  target = Deduce.value target
  case relation
  when 'equal to'
    params = { :equal => target }
  when 'greater than'
    params = { :floor => target }
  when 'less than'
    params = { :ceiling => target }
  when 'greater than or equal to'
    params = { :min => target }
  when 'less than or equal to'
    params = { :max => target }
  end
  add_constraint(role, FieldValueConstraint.new(field, params), condition)
end

#add_type_constraints(role, field, type, condition) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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
 
# File 'lib/j2119/assigner.rb', line 155

def add_type_constraints(role, field, type, condition)

  is_array = (type =~ /-array/)
  is_nullable = (type =~ /nullable-/)
  type.split('-').each do |part|
    case part
    when 'object'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :object,
                                             is_array, is_nullable),
                     condition)
    when 'string'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :string,
                                             is_array, is_nullable),
                     condition)
    when 'URI'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :URI,
                                             is_array, is_nullable),
                     condition)
    when 'boolean'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :boolean,
                                             is_array, is_nullable),
                     condition)
    when 'numeric'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :numeric,
                                             is_array, is_nullable),
                     condition)
    when 'integer'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :integer,
                                             is_array, is_nullable),
                     condition)
    when 'float'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :float,
                                             is_array, is_nullable),
                     condition)
    when 'timestamp'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :timestamp,
                                             is_array, is_nullable),
                     condition)
    when 'JSONPath'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :json_path,
                                             is_array, is_nullable),
                     condition)
    when 'referencePath'
      add_constraint(role,
                     FieldTypeConstraint.new(field, :reference_path,
                                             is_array, is_nullable),
                     condition)
    when 'positive'
      add_constraint(role,
                     FieldValueConstraint.new(field, :floor => 0),
                     condition)
    when 'nonnegative'
      add_constraint(role,
                     FieldValueConstraint.new(field, :min => 0),
                     condition)
    when 'negative'
      add_constraint(role,
                     FieldValueConstraint.new(field, :ceiling => 0),
                     is_array, condition)
    when 'nonempty'
      add_constraint(role, NonEmptyConstraint.new(field), condition)
    end
  end
end

#assign_constraints(assertion) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
122
123
124
125
126
127
128
129
 
# File 'lib/j2119/assigner.rb', line 52

def assign_constraints(assertion)
  role = assertion['role']
  modal = assertion['modal']
  type = assertion['type']
  field_name = assertion['field_name']
  field_list_string = assertion['field_list']
  relation = assertion['relation']
  target = assertion['target']
  strings = assertion['strings']
  child_type = assertion['child_type']
  vals = assertion['vals']

  # watch out for conditionals
  condition = nil
  if assertion['excluded']
    excluded_roles =
      Oxford.break_role_list(@matcher, assertion['excluded'])
    condition = RoleNotPresentCondition.new(excluded_roles)
  end
    
  if relation
    add_relation_constraint(role, field_name, relation, target,
                            condition)
  end
  
  if strings
    # of the form MUST have a <type> field named <field_name> whose value
    #  MUST be one of "a", "b", or "c"
    fields = Oxford.break_string_list strings
    add_constraint(role,
                   FieldValueConstraint.new(field_name, :enum => fields),
                   condition)
  end
  
  if type
    add_type_constraints(role, field_name, type, condition)
  end

  if field_list_string
    field_list = Oxford.break_string_list field_list_string
  end

  # register allowed fields
  if field_list_string
    field_list.each { |field| @allowed_fields.set_allowed(role, field) }
  elsif field_name
    @allowed_fields.set_allowed(role, field_name)
  end
  
  if modal == 'MUST'
    if field_list_string
      # Of the form MUST have a <type>? field named one of "a", "b", or "c".
      add_constraint(role, HasFieldConstraint.new(field_list), condition)
    else
      add_constraint(role, HasFieldConstraint.new(field_name), condition)
    end
  elsif modal == 'MUST NOT'
    add_constraint(role,
                   DoesNotHaveFieldConstraint.new(field_name), condition)
  end
  
  # there can be role defs there too
  if child_type
    @matcher.add_role assertion['child_role']
    if child_type == 'value'
      @roles.add_child_role(role, field_name, assertion['child_role'])
    elsif child_type == 'element' || child_type == 'field'
      @roles.add_grandchild_role(role, field_name, assertion['child_role'])
    end
  else
    anyOrObjectOrArray = (!type) || (type == 'object') || (type == 'array')
    # untyped field without a defined child role
    if field_name && anyOrObjectOrArray && (modal != 'MUST NOT')
      @roles.add_grandchild_role(role, field_name, field_name)
      @allowed_fields.set_any(field_name)
    end
  end
end

#assign_only_one_of(assertion) ⇒ Object 



46
47
48
49
50
 
# File 'lib/j2119/assigner.rb', line 46

def assign_only_one_of(assertion)
  role = assertion['role']
  values = Oxford.break_string_list assertion['field_list']
  add_constraint(role, OnlyOneOfConstraint.new(values), nil)
end

#assign_roles(assertion) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/j2119/assigner.rb', line 28

def assign_roles(assertion)
  if assertion['val_match_present']
    @roles.add_field_value_role(assertion['role'],
                                assertion['fieldtomatch'],
                                assertion['valtomatch'],
                                assertion['newrole'])
    @matcher.add_role(assertion['newrole'])
  elsif assertion['with_a_field']
    @roles.add_field_presence_role(assertion['role'],
                                   assertion['with_a_field'],
                                   assertion['newrole'])
    @matcher.add_role(assertion['newrole'])
  else
    @roles.add_is_a_role(assertion['role'], assertion['newrole'])
    @matcher.add_role(assertion['newrole'])
  end
end