Module: Tasks::Gis::ReportHelper

Defined in:
app/helpers/tasks/gis/report_helper.rb

Constant Summary

ALLHEADERS =
['Collecting Event', 'Collection Object', 'Bio classification']

Instance Method Summary (collapse)

Instance Method Details

- (String) all_sub_headers(filtered = false)

post- (true) selection

Parameters:

  • filtered (Boolean) (defaults to: false)

    to indicate whether the existing hash of @selected_column_names are pre- (false) or

Returns:

  • (String)

    of headers to be applied to table



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
# File 'app/helpers/tasks/gis/report_helper.rb', line 106

def all_sub_headers(filtered = false)
  unless filtered
    ce_headers # generate the header structure (see CollectionObject.selected_column_names)
    co_headers
    bc_headers
  end
  all_columns = []
  %w(ce co bc).each { |column_type|
    # stuff the column_type, just to make it easier to visualize the data organization in the debugger
    items = [column_type]
    # stuff the headers for the internal predicates
    unless @selected_column_names[column_type.to_sym][:in].nil?
      items.push(@selected_column_names[column_type.to_sym][:in].keys)
    end
    # check for import predicates (may not be present on ce and co, WILL NOT be present on bc)
    unless @selected_column_names[column_type.to_sym][:im].nil?
      unless @selected_column_names[column_type.to_sym][:im].keys.empty?
        items.push('--Import') # stuff the seperator
        items.push(@selected_column_names[column_type.to_sym][:im].keys) # stuff the headers for the import
        # predicates
      end
    end
    all_columns.push(items.flatten) # flatten is required because the internal and import headers are pushed
    # as arrays
  }
  outer     = 1 # Skip the first row; these are reflected in the word list used to iterate the columns
  retstring = ''; ce_type = 'in'; co_type = 'in' # ; sub_type = 'in'
  until all_columns[0][outer].nil? && all_columns[1][outer].nil? && all_columns[2][outer].nil?
    retstring += '<tr>' # open the row
    # across the three headers
    %w(ce co bc).each_with_index { |col_type, inner|
      item = all_columns[inner][outer].to_s
      if item.start_with?('--Imp')
        item      = item[2, item.length]
        retstring += "<th>#{item}</th>"
        case col_type
          when 'ce'
            ce_type = 'im' # switch the ce list to import
          when 'co'
            co_type = 'im' # switch the co list to import
          else
            # this will never happen...
            # sub_type = 'in'
        end
      else
        case col_type
          when 'ce'
            sub_type = ce_type
          when 'co'
            sub_type = co_type
          else
            sub_type = 'in'
        end
        if item.empty?
          retstring += '<td></td>'
        else
          stage       = @selected_column_names[col_type.to_sym][sub_type.to_sym][item]
          item_id     = stage[:id]
          item_chk    = stage[:checked]
          item_string = "hd[#{col_type}[#{sub_type}[#{item}]]]"
          retstring   += "<td>#{check_box(item_string, :checked, {checked: item_chk})} #{item}</td>"
        end
      end
    }
    retstring += '</tr>' # close the row
    outer     += 1
  end

  retstring
end

- (Array) bc_attributes(collection_object)

Returns of attributes

Parameters:

Returns:

  • (Array)

    of attributes



99
100
101
# File 'app/helpers/tasks/gis/report_helper.rb', line 99

def bc_attributes(collection_object)
  CollectionObject.bc_attributes(collection_object, @selected_column_names)
end

- (Hash) bc_headers

can't use data_attribute.predicate_name here; it will lose the sense of source (internal or import)

Returns:

  • (Hash)

    with collection object data attribute names, both internal and import



93
94
95
# File 'app/helpers/tasks/gis/report_helper.rb', line 93

def bc_headers
  @selected_column_names = CollectionObject.bc_headers(sessions_current_project_id)
end

- (Array) build_row(c_o)

Returns row of data

Parameters:

Returns:

  • (Array)

    row of data



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'app/helpers/tasks/gis/report_helper.rb', line 236

def build_row(c_o)
  retval = []

  retval[0]  = c_o.otu_id
  retval[1]  = c_o.otu_name
  retval[2]  = c_o.name_at_rank_string(:family)
  retval[3]  = c_o.name_at_rank_string(:genus)
  retval[4]  = c_o.name_at_rank_string(:species)
  retval[5]  = c_o.dwc_country # c_o.collecting_event.country
  retval[6]  = c_o.dwc_state_province # c_o.collecting_event.state
  retval[7]  = c_o.dwc_county # c_o.collecting_event.county
  retval[8]  = c_o.collecting_event.verbatim_locality
  retval[9]  = c_o.collecting_event.georeference_latitude
  retval[10] = c_o.collecting_event.georeference_longitude

  ce_attributes(c_o).each { |item|
    retval.push(item)
  }
  co_attributes(c_o).each { |item|
    retval.push(item)
  }
  bc_attributes(c_o).each { |item|
    retval.push(item)
  }
  retval.flatten!
  @c_o_table_data[c_o.id.to_s] = retval
  retval
end

- (String) c_o_attributes(attribute_list = [])

Returns collection of all of the attributes selected

Parameters:

  • attribute_list (Array) (defaults to: [])

Returns:

  • (String)

    collection of all of the attributes selected



41
42
43
44
45
46
47
# File 'app/helpers/tasks/gis/report_helper.rb', line 41

def c_o_attributes(attribute_list = [])
  retval = ''
  attribute_list.each { |attribute|
    retval += "<td>#{attribute}</td>"
  }
  retval
end

- (String) c_o_headers(header_list = [])

Returns collection of all of the headers selected

Parameters:

  • header_list (Hash) (defaults to: [])

    construct

Returns:

  • (String)

    collection of all of the headers selected



31
32
33
34
35
36
37
# File 'app/helpers/tasks/gis/report_helper.rb', line 31

def c_o_headers(header_list = [])
  retval = ''
  header_list.each { |header|
    retval += "<th>#{header}</th>\n"
  }
  retval
end

- (Array) ce_attributes(collection_object)

Returns of attributes

Parameters:

Returns:

  • (Array)

    of attributes



73
74
75
# File 'app/helpers/tasks/gis/report_helper.rb', line 73

def ce_attributes(collection_object)
  CollectionObject.ce_attributes(collection_object, @selected_column_names)
end

- (Hash) ce_headers

can't use data_attribute.predicate_name here; it will lose the sense of source (internal or import)

Returns:

  • (Hash)

    with collecting event data attribute names, both internal and import



67
68
69
# File 'app/helpers/tasks/gis/report_helper.rb', line 67

def ce_headers
  @selected_column_names = CollectionObject.ce_headers(sessions_current_project_id)
end

- (Array) co_attributes(collection_object)

Returns of attributes

Parameters:

Returns:

  • (Array)

    of attributes



86
87
88
# File 'app/helpers/tasks/gis/report_helper.rb', line 86

def co_attributes(collection_object)
  CollectionObject.co_attributes(collection_object, @selected_column_names)
end

- (Hash) co_headers

can't use data_attribute.predicate_name here; it will lose the sense of source (internal or import)

Returns:

  • (Hash)

    with collection object data attribute names, both internal and import



80
81
82
# File 'app/helpers/tasks/gis/report_helper.rb', line 80

def co_headers
  @selected_column_names = CollectionObject.co_headers(sessions_current_project_id)
end

- (Object) count_info(count)



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'app/helpers/tasks/gis/report_helper.rb', line 191

def count_info(count)
  term = 'Collection object'
  if count < 25
    if count == 0
      retval = "No #{term}s"
    else
      if count == 1
        retval = "1 #{term}"
      else
        retval = "#{count} #{term}s"
      end
    end
  else
    retval = "First 25 of #{count} Collection objects"
  end
  retval + ':'
end

- (String) helper_download_button

Returns for download button and hidden field for geographic area id

Returns:

  • (String)

    for download button and hidden field for geographic area id



6
7
8
9
# File 'app/helpers/tasks/gis/report_helper.rb', line 6

def helper_download_button
  submit_tag('download', {disabled: params[:geographic_area_id].nil?}) +
    hidden_field_tag(:download_geo_area_id, params[:geographic_area_id])
end

- (String) otu_headers

Returns common headers otu through longitude

Returns:

  • (String)

    common headers otu through longitude



21
22
23
24
25
26
27
# File 'app/helpers/tasks/gis/report_helper.rb', line 21

def otu_headers
  retval = ''
  CollectionObject::CO_OTU_HEADERS.each { |header|
    retval += "<th>#{header}</th>\n"
  }
  retval
end

- (Array) report_georeferences(collection_objects, geographic_area)

Returns TODO: of array of Georeferences OR geographic areas? -> why

Returns:

  • (Array)

    TODO: of array of Georeferences OR geographic areas? -> why



179
180
181
182
183
184
185
186
187
188
189
# File 'app/helpers/tasks/gis/report_helper.rb', line 179

def report_georeferences(collection_objects, geographic_area)

  # all georeferences for a set of collection objects
  #  retval = collection_objects.map(&:collecting_event).uniq.map(&:georeferences).flatten
  retval = Georeference.joins(collecting_event: [:collection_objects]).where(collection_objects: {id: collection_objects})

  if retval.empty?
    retval.push(geographic_area)
  end
  retval
end

- (Array) selected_headers

Returns of the selected headers

Returns:

  • (Array)

    of the selected headers



50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'app/helpers/tasks/gis/report_helper.rb', line 50

def selected_headers
  retval = []
  %w(ce co bc).each { |column|
    group = @selected_column_names[column.to_sym]
    group.keys.each { |type|
      retval.push(group[type].keys)
    } unless group.nil?
  } unless @selected_column_names.nil?
  retval ||= {ce: {in: {}, im: {}}, # make sure all columns and types are present,
              co: {in: {}, im: {}}, # even if empty
              bc: {in: {}, im: {}}}
  retval.flatten
end

- (Object) table_complete



226
227
228
229
230
231
232
# File 'app/helpers/tasks/gis/report_helper.rb', line 226

def table_complete
  unless @c_o_table_store.nil?
    table_string = @sessions_current_user.email + '-c_o_table_data'
    @c_o_table_store.set(table_string, @c_o_table_data.to_json)
  end
  @c_o_table_data.count
end

- (Object) table_start



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'app/helpers/tasks/gis/report_helper.rb', line 209

def table_start
  @c_o_table_data  = {}
  @c_o_table_store = Redis.new

  begin
    @c_o_table_store.ping
  rescue Exception => e
    @c_o_table_store = nil
    e.inspect
    e.message
    # puts "#{e.inspect}"
    # e.inspect
  end
  @c_o_table_store

end

- (String) tag_headers

Returns strings for predicate selection table

Returns:

  • (String)

    strings for predicate selection table



12
13
14
15
16
17
18
# File 'app/helpers/tasks/gis/report_helper.rb', line 12

def tag_headers
  retval = ''
  ALLHEADERS.each { |header|
    retval += "<th>#{header}</th>"
  }
  retval
end