Module: AACMetrics::Loader

Defined in:
lib/aac-metrics/loader.rb

Class Method Summary collapse

Class Method Details

.base_words(locale) ⇒ Object 



360
361
362
363
364
365
366
367
 
# File 'lib/aac-metrics/loader.rb', line 360

def self.base_words(locale)
  @@base_words ||= {}
  return @@base_words[locale] if @@base_words[locale]
  locale = locale.split(/-|_/)[0]
  path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "base_words.#{locale}.json"))
  res = JSON.parse(File.read(path))
  @@base_words[locale] = res
end

.common_words(locale) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/aac-metrics/loader.rb', line 289

def self.common_words(locale)
  locale = locale.split(/-|_/)[0]
  common_paths = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "*.common.#{locale}.obfset")))
  files = common_paths.map{|p| File.basename(p) }.sort
  common_analysis_paths = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "*.common.#{locale}.analysis")))
  files += common_analysis_paths.map{|p| File.basename(p) }.sort
  path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "common_words.#{locale}.json"))    
  res = JSON.parse(File.read(path)) rescue nil
  if !res || res['version'] != AACMetrics::VERSION || res['files'] != files
    efforts = {}
    common_words = nil
    common_paths.each do |path|
      obfset = AACMetrics::Loader.retrieve(path)
      common = AACMetrics::Metrics.analyze(obfset, false)
      common[:buttons].each{|b| 
        efforts[b[:label]] ||= []
        efforts[b[:label]] << b[:effort] 
      }
      words = common[:buttons].map{|b| b[:label] }.map{|w| w.gsub(/’/, '') }
      common_words ||= words
      common_words &= words
    end
    common_words -= ['']
    efforts.each do |word, vals|
      if vals.length == common_paths.length
        efforts[word] = vals.sum.to_f / vals.length
      else
        efforts.delete(word)
      end
    end
    sorted_efforts = {}
    efforts.to_a.sort_by(&:last).each do |str, val|
      sorted_efforts[str] = val
    end
    res = {
      'version' => AACMetrics::VERSION,
      'files' => files,
      'words' => sorted_efforts.keys,
      'efforts' => sorted_efforts
    }
    f = File.open(path, 'w')
    f.puts JSON.pretty_generate(res)
    f.close
  end
  res
end

.core_lists(locale) ⇒ Object 



280
281
282
283
284
285
286
287
 
# File 'lib/aac-metrics/loader.rb', line 280

def self.core_lists(locale)
  locale = locale.split(/-|_/)[0]
  @@core_lists ||= {}
  return @@core_lists[locale] if @@core_lists[locale]
  path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "core_lists.#{locale}.json"))    
  res = JSON.parse(File.read(path))
  @@core_lists[locale] = res
end

.ingest(fn, token = nil) ⇒ Object

TODO: Qualitative assessments of common vocabularies, gather perspectives on what makes a “good” vocabulary and collect reviews from field experts, also free response sections. Some criteria:

  • works well for age group X, Y, Z

  • works well for a beginning communicator

  • allows long-term growth as-is

  • comprehensive core

-



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/aac-metrics/loader.rb', line 246

def self.ingest(fn, token=nil)
  output = nil
  boards = nil
  if fn.match(/\.obfset$/)
    boards = retrieve(fn, false)
    output = fn
  else
    content = process(fn, token, true)
    boards = content[:boards]
    words = content[:words]
    words_path = content[:words_path]
    output_fn = Digest::MD5.hexdigest(Time.now.to_i.to_s + rand(9999).to_s)[0, 10] + ".obfset"
    output = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', output_fn))
    f = File.open(output, 'w')
    f.write(JSON.pretty_generate(boards))
    f.close
    if words
      new_words = {}
      words.to_a.sort_by{|h, w| w }.each{|h, w| new_words[h] = w }
      f = File.open(words_path, 'w')
      f.write(JSON.pretty_generate(new_words))
      f.close
    end
  end
  if boards
    analysis = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', fn.sub(/\.obfset$/, '.analysis')))
    res = AACMetrics::Metrics.analyze(boards)
    f = File.open(analysis, 'w')
    f.write(JSON.pretty_generate(res))
    f.close
  end
  output
end

.process(fn, token = nil, add_words = false) ⇒ Object 



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
228
229
230
231
232
233
 
# File 'lib/aac-metrics/loader.rb', line 72

def self.process(fn, token=nil, add_words=false)
  paths = [fn]
  boards = []
  visited_paths = {}
  queued_paths = {}
  idx = 1
  words_path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "base_words"))
  words = nil
  do_ingest = true
  relations_hash = {}
  
  while paths.length > 0
    path = paths.shift
    visited_paths[path] = idx
    new_json = {
      "id" => "brd#{idx}",
      "buttons" => [],
      "grid" => {},
    }
    idx += 1
    json = nil
    if path.match(/^http/)
      if token
        path += "?access_token=#{token}"
      end
      req = Typhoeus.get(path, timeout: 10)
      json = JSON.parse(req.body)
      # puts path
    else
      if !File.exist?(path)
        orig_path = path
        path = File.expand_path(File.join(fn, "..", orig_path))
        if !File.exist?(path)
          path = File.expand_path(File.join(fn, "..", "..", orig_path))
        end
      end
      # puts "#{path}"
      json = JSON.parse(File.read(path))
    end
    if json && json['grid']
  #    puts JSON.pretty_generate(json)
      new_json['locale'] = json['locale'] || 'en'
      if !words
        words_path = words_path + "." + new_json['locale'].split(/-|_/)[0] + ".json"
        words = JSON.parse(File.read(words_path))
      end
      btn_idx = 1
      new_json['grid']['rows'] = json['grid']['rows']
      new_json['grid']['columns'] = json['grid']['columns']
      new_json['grid']['order'] = []
      new_json['grid']['rows'].times do |row_idx|
        row = json['grid']['order'][row_idx] || []
        new_row = []
        new_json['grid']['columns'].times do |col_idx|
          btn_id = row[col_idx]
          btn = json['buttons'].detect{|b| btn_id && b['id'] == btn_id }
          new_btn = nil
          if btn
            new_btn = {
              "id" => "btn#{btn_idx}",
              "label" => (btn['vocalization'] || '').length > 0 ? btn['vocalization'] : btn['label']
            }
            # record load_board reference
            btn_idx += 1
            if btn['load_board']
              if btn['load_board']['path']
                if visited_paths[btn['load_board']['path']]
                  new_btn['load_board'] = {'id' => "brd#{visited_paths[btn['load_board']['path']]}"}
                else
                  paths.push(btn['load_board']['path']) unless queued_paths[btn['load_board']['path']]
                  queued_paths[btn['load_board']['path']] = true
                  new_btn['load_board'] = {'tmp_path' => btn['load_board']['path']}
                end
              elsif btn['load_board']['data_url']
                if visited_paths[btn['load_board']['data_url']]
                  new_btn['load_board'] = {'id' => "brd#{visited_paths[btn['load_board']['data_url']]}"}
                else
                  paths.push(btn['load_board']['data_url']) unless queued_paths[btn['load_board']['data_url']]
                  queued_paths[btn['load_board']['data_url']] = true
                  new_btn['load_board'] = {'tmp_path' => btn['load_board']['data_url']}
                end
              else
                puts "Link found with no access #{btn['load_board'].to_json}"
              end
            elsif btn['action']
              # TODO: track keyboard actions and don't
              # treat action buttons for metrics
              new_btn = nil
            end
            # temporarily save semantic_id and possible clone_id for later use
            # 1. Buttons in the same location with the same
            # semantic_id should be marked in the obfset as having
            # the same semantic_id
            # 2. Buttons in the same location with the same label & voc
            # and same load_board setting
            # should be marked in the obfset as having the same clone_id
            ref = "#{new_json['grid']['rows']}x#{new_json['grid']['columns']}-#{row_ids}.#{col_id}"
            if btn['semantic_id']
              relations_hash["s#{ref}-#{btn['semantic_id']}"] ||= []
              relations_hash["s#{ref}-#{btn['semantic_id']}"] << [new_json['id'], new_btn['id']]
            end
            if new_btn['label']
              # TODO: currently doesn't enforce same-location on links, just whether it's a linked button or not
              pre = new_btn['load_board'] ? 'cl' : 'c'
              relations_hash["#{pre}#{ref}-#{new_btn['label']}"] ||= []
              relations_hash["#{pre}#{ref}-#{new_btn['label']}"] ||= [new_json['id'], new_btn['id']]
            end
            if do_ingest && new_btn['label']
              str = new_btn['label'].downcase.sub(/^\s+/, '').sub(/\s+$/, '')
              if str.scan(/\s+/).length < 2
                word_hash = Digest::MD5.hexdigest(str)[0, 10]
                raise "collision!" if words[word_hash] && words[word_hash] != str
                if add_words || words[word_hash]
                  words[word_hash] = str
                  new_btn['label'] = "$#{word_hash}"
                end
              end
            end

          end
          new_row.push(new_btn ? new_btn['id'] : nil)
          new_json['buttons'].push(new_btn) if new_btn
        end
        new_json['grid']['order'].push(new_row)
      end
      boards << new_json
    end
  end
  # any semantic_id or clone_id repeats must be recorded
  relations_hash.each do |id, btns|
    if btns && btns.length > 0
      btns.each do |brd_id, btn_id|
        brd = boards.detect{|b| b['id'] == brd_id }
        if brd && brd['buttons']
          btn = brd['buttons'].detect{|b| b['id'] == btn_id }
          if btn
            if id.match(/^s/)
              btn['semantic_id'] = id
              brd['semantic_ids'] ||= []
              brd['semantic_ids'] << id
            elsif id.match(/^c/)
              btn['clone_id'] = id
              brd['clone_ids'] ||= []
              brd['clone_ids'] << id
            end
          end
        end
      end
      # 
    end
  end
  boards.each do |brd|
    brd['buttons'].each do |btn|
      if btn['load_board'] && btn['load_board']['tmp_path']
        btn['load_board']['id'] = "brd#{visited_paths[btn['load_board']['tmp_path']]}" if visited_paths[btn['load_board']['tmp_path']]
        btn['load_board'].delete('tmp_path')
      end
    end
  end
  # TODO: record whether the board set is expected to have auto-home
  {boards: boards, words: words, words_path: words_path}
end

.retrieve(obfset, unsub = true) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/aac-metrics/loader.rb', line 6

def self.retrieve(obfset, unsub=true)
  if obfset.is_a?(Hash) && obfset['boards']
    json = []
    obfset['boards'].each do |board|
      new_board = {
        "id" => board['id'],
        "buttons" => [],
        "locale" => board['locale'] || 'en',
        "grid" => board['grid'],
      }
      board['buttons'].each do |button|
        new_button = {
          "label" => ((button['vocalization'] || '').length > 0 ? button['vocalization'] : button['label']).to_s.downcase.gsub(/’/, ''),
          "id" => button['id']
        }
        if button['load_board'] && button['load_board']['id']
          new_button['load_board'] = {'id' => button['load_board']['id']}
        end
        new_board['buttons'].push(new_button)
      end
      json << new_board
    end
  elsif obfset.match(/^http/)
    res = Typhoeus.get(obfset, timeout: 10)
    json = JSON.parse(res.body)
  elsif !obfset.match(/\.obfset/)
    fn = obfset
    obfset = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', fn + '*.obfset')))[0]
    analysis = nil
    if !obfset
      analysis = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', fn + '*.analysis')))[0]
    end
    if obfset
      json = JSON.parse(File.read(obfset))
    elsif analysis
      json = JSON.parse(File.read(analysis))
    end
  else
    json = JSON.parse(File.read(obfset))
  end
  if unsub
    locale = json.is_a?(Array) ? json[0]['locale'] : json['locale']
    base = self.base_words(locale)
    if json.is_a?(Array)
      json.each do |brd|
        brd['buttons'].each do |btn|
          if btn['label'].match(/^\$/)
            word = base[btn['label'].sub(/^\$/, '')]
            btn['label'] = word if word
          end
          btn['label'] = btn['label'].gsub(/’/, '')
        end
      end
    elsif json.is_a?(Hash)
      (json['buttons'] || []).each do |button|
        if button['label'].match(/^\$/)
          word = base[button['label'].sub(/^\$/, '')]
          button['label'] = word if word
        end
        button['label'] = button['label'].gsub(/’/, '')
      end
    end
  end
  json
end

.sentences(locale) ⇒ Object 



351
352
353
354
355
356
357
358
 
# File 'lib/aac-metrics/loader.rb', line 351

def self.sentences(locale)
  @@sentences ||= {}
  return @@sentences[locale] if @@sentences[locale]
  locale = locale.split(/-|_/)[0]
  path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "sentences.#{locale}.json"))
  res = JSON.parse(File.read(path))
  @@sentences[locale] = res
end

.synonyms(locale) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/aac-metrics/loader.rb', line 336

def self.synonyms(locale)
  @@synonyms ||= {}
  return @@synonyms[locale] if @@synonyms[locale]
  locale = locale.split(/-|_/)[0]
  path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'sets', "synonyms.#{locale}.json"))
  res = {}
  list = JSON.parse(File.read(path))
  list.each do |words|
    words.each do |word|
      res[word] = words - [word]
    end
  end
  @@synonyms[locale] = res
end