Module: Annotation

Included in:
Association::Index, OffsiteStep, TSV, Task, Workflow
Defined in:
lib/scout/tsv/annotation.rb

Class Method Summary collapse

Class Method Details

.list_tsv_values(objs, fields) ⇒ Object 



41
42
43
 
# File 'lib/scout/tsv/annotation.rb', line 41

def self.list_tsv_values(objs, fields)
  obj_tsv_values(objs, fields)
end

.load_info(fields, values) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/scout/tsv/annotation.rb', line 108

def self.load_info(fields, values)
  info = {}
  fields.each_with_index do |field,i|
    next if field == "literal"

    case field
    when "JSON"
      JSON.parse(values[i]).each do |key, value|
        info[key.to_sym] = value
      end
    when nil
      next
    else
      info[field.to_sym] = resolve_tsv_array(values[i])
    end
  end
  info
end

.load_tsv(tsv) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/scout/tsv/annotation.rb', line 155

def self.load_tsv(tsv)
  tsv.with_unnamed do
    annotated_objects = tsv.collect do |id, values|
      Annotation.load_tsv_values(id, values, tsv.fields)
    end

    case tsv.key_field 
    when "List"
      annotated_objects.first
    else
      annotated_objects
    end
  end
end

.load_tsv_values(id, values, *fields) ⇒ Object 



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
 
# File 'lib/scout/tsv/annotation.rb', line 127

def self.load_tsv_values(id, values, *fields)
  fields = fields.flatten
  literal_pos = fields.index "literal"

  object = case
           when literal_pos
             values[literal_pos].tap{|o| o.force_encoding(Encoding.default_external)}
           else
             id.dup
           end

  object = resolve_tsv_array(object)

  if Array === values.first
    NamedArray.zip_fields(values).collect do |v|
      info = load_info(fields, v)
    end
  else
    info = load_info(fields, values)
  end

  self.setup(object, info[:annotation_types], info)

  object.extend AnnotatedArray if Array === object

  object
end

.obj_tsv_values(obj, fields) ⇒ Object 



4
5
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
 
# File 'lib/scout/tsv/annotation.rb', line 4

def self.obj_tsv_values(obj, fields)

  annotation_info = obj.annotation_info
  annotation_info[:annotated_array] = true if AnnotatedArray === obj

  fields.collect do |field|
    field = field.to_s if Symbol === field
    case field
    when Proc
      field.call(obj)

    when "JSON"
      annotation_info.to_json

    when "annotation_types"
      annotation_info[:annotation_types].collect{|t| t.to_s} * "|"

    when "annotated_array"
      AnnotatedArray === obj

    when "literal"
      (Array === obj ? "Array:" << obj * "|" : obj).gsub(/\n|\t/, ' ')

    else
      if annotation_info.include?(field.to_sym)
        res = annotation_info[field.to_sym]
        Array === res ? "Array:" << res * "|" : res
      elsif self.respond_to?(field)
        res = self.send(field)
        Array === res ? "Array:"<< res * "|" : res
      else
        raise
      end
    end
  end
end

.resolve_tsv_array(entry) ⇒ Object

Load TSV



100
101
102
103
104
105
106
 
# File 'lib/scout/tsv/annotation.rb', line 100

def self.resolve_tsv_array(entry)
  if String === entry && entry =~ /^Array:/
    entry["Array:".length..-1].split("|")
  else
    entry
  end
end

.tsv(objs, *fields) ⇒ Object 



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
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
 
# File 'lib/scout/tsv/annotation.rb', line 46

def self.tsv(objs, *fields)
  return nil if objs.nil?

  fields = fields.flatten.compact.uniq

  annotations = if Annotation.is_annotated?(objs) 
                  objs.annotations 
                elsif (Array === objs && objs.any?)
                  first = objs.compact.first
                  if Annotation.is_annotated?(first)
                    objs.compact.first.annotations
                  else
                    raise "Objects didn't have annotations"
                  end
                else
                  []
                end

  if fields.empty?
    fields = annotations + [:annotation_types]
  elsif fields == ["all"] || fields == [:all]
    fields = annotations + [:annotation_types, :literal]
  end

  fields = fields.collect{|f| Symbol === f ? f.to_s : f }

  tsv = TSV.setup({}, :key_field => nil, :fields => fields, :type => :list, :unnamed => true)

  case
  when Annotation.is_annotated?(objs)
    tsv.key_field = "List"

    tsv[objs.annotation_id] = self.list_tsv_values(objs, fields).dup
  when Array === objs 
    tsv.key_field = "ID"

    if Annotation.is_annotated?(objs.compact.first)
      objs.compact.each_with_index do |obj,i|
        tsv[obj.annotation_id + "#" << i.to_s] = self.obj_tsv_values(obj, fields).dup
      end
    elsif (objs.any? && Annotation.is_annotated?(objs.compact.first.compact.first))
      objs.flatten.compact.each_with_index do |obj,i|
        tsv[obj.annotation_id + "#" << i.to_s] = self.obj_tsv_values(obj, fields).dup
      end
    end
  else
    raise "Annotations need to be an Array to create TSV"
  end

  tsv
end