Module: Workbench::NavigationHelper

Defined in:
app/helpers/workbench/navigation_helper.rb

Overview

Methods for 1) generating paths; or 2) generating links.

Constant Summary

NO_NEW_FORMS =
%w{ObservationMatrixRow ObservationMatrixColumn Note Tag Citation Identifier DataAttribute AlternateValue GeographicArea ContainerItem ProtocolRelationship}.freeze

Instance Method Summary (collapse)

Instance Method Details



250
251
252
253
254
255
256
257
258
# File 'app/helpers/workbench/navigation_helper.rb', line 250

def a_to_z_links(targets = [])
  letters = targets.empty? ? a_to_z_range : a_to_z_range.to_a & targets

  (:div, class: 'navigation-bar-left', id: 'alphabet_nav') do
    (:ul, class: 'left_justified_navbar context-menu') do
      letters.collect{|l| (:li, link_to("#{l}", "\##{l}")) }.join.html_safe
    end
  end
end

- (Object) a_to_z_range



246
247
248
# File 'app/helpers/workbench/navigation_helper.rb', line 246

def a_to_z_range
  ('A'..'Z')
end


191
192
193
194
195
196
197
# File 'app/helpers/workbench/navigation_helper.rb', line 191

def batch_load_link
  if self.controller.respond_to?(:batch_load)
    link_to('Batch load', {action: :batch_load, controller: self.controller_name}, 'data-icon' => 'batch')
  else
    (:span, 'Batch load', class: 'disabled', 'data-icon' => 'batch')
  end
end


183
184
185
186
187
188
189
# File 'app/helpers/workbench/navigation_helper.rb', line 183

def destroy_object_link(object)
  if (!sessions_current_user.is_administrator?) && (@is_shared_data_model)
    (:div, (:span, 'Destroy', 'data-icon' => 'trash', class: 'small-icon'), class: 'navigation-item disable')
  else
    link_to((:span, 'Destroy', 'data-icon' => 'trash', class: 'small-icon'), object.metamorphosize, method: :delete, data: {confirm: 'Are you sure?'}, class: 'navigation-item')
  end
end


114
115
116
117
118
119
120
# File 'app/helpers/workbench/navigation_helper.rb', line 114

def download_for_model_link(model)
  if self.controller.respond_to?(:download)
    link_to('Download', download_path_for_model(model), 'data-icon' => 'download')
  else
    (:em, 'Download not yet available.')
  end
end

- (Object) download_path_for_model(model)



122
123
124
# File 'app/helpers/workbench/navigation_helper.rb', line 122

def download_path_for_model(model)
  send("download_#{model.name.tableize}_path")
end

return [A tag, nil]

a link, or disabled link


175
176
177
178
179
180
181
# File 'app/helpers/workbench/navigation_helper.rb', line 175

def edit_object_link(object)
  if is_editable?(object) && user_can_edit?(object)
    link_to((:span, 'Edit', 'data-icon' => 'edit', class: 'small-icon'), edit_object_path(metamorphosize_if(object)), class: 'navigation-item')
  else
    (:div, (:span, 'Edit', 'data-icon' => 'edit', class: 'small-icon'), class: 'navigation-item disable')
  end
end

- (Object) edit_object_path(object)



141
142
143
# File 'app/helpers/workbench/navigation_helper.rb', line 141

def edit_object_path(object)
  send(edit_object_path_string(object), object)
end

- (Object) edit_object_path_string(object)



145
146
147
148
149
150
151
152
153
# File 'app/helpers/workbench/navigation_helper.rb', line 145

def edit_object_path_string(object)
  default  = "edit_#{metamorphosize_if(object).class.base_class.name.underscore}_path"
  specific = default + '_string'
  if self.respond_to?(specific)
    self.send(specific, object)
  else
    default
  end
end


38
39
40
# File 'app/helpers/workbench/navigation_helper.rb', line 38

def forward_back_links(instance)
  (:span, (previous_link(instance) + ' | ' + next_link(instance)).html_safe)
end

- (Boolean) is_editable?(object)

return [Boolean]

true if there is a route to edit for the object (some objects are not editable, like Tags)

Returns:

  • (Boolean)


157
158
159
# File 'app/helpers/workbench/navigation_helper.rb', line 157

def is_editable?(object)
  self.respond_to?(edit_object_path_string(object))
end


106
107
108
109
110
111
112
# File 'app/helpers/workbench/navigation_helper.rb', line 106

def list_for_model_link(model)
  if model.any?
    link_to('List', list_path_for_model(model), 'data-icon' => 'list')
  else
    (:span, 'List', class: :disabled, 'data-icon' => 'list')
  end
end

- (Object) list_path_for_model(model)



92
93
94
# File 'app/helpers/workbench/navigation_helper.rb', line 92

def list_path_for_model(model)
  url_for(controller: model.name.tableize.pluralize.downcase, action: :list)
end


96
97
98
99
100
101
102
103
104
# File 'app/helpers/workbench/navigation_helper.rb', line 96

def new_for_model_link(model)
  if NO_NEW_FORMS.include?(model.name)
    nil
  elsif model.name == 'ProjectSource'
    link_to('New', new_source_path, 'class' => 'small-icon', 'data-icon' => 'new')
  else
    link_to((:span, 'New', 'class' => 'small-icon', data: { icon: :new }), new_path_for_model(model), 'class' => 'navigation-item')
  end
end

- (Object) new_path_for_model(model)



88
89
90
# File 'app/helpers/workbench/navigation_helper.rb', line 88

def new_path_for_model(model)
  send("new_#{model.name.tableize.singularize}_path")
end

A next record link.



56
57
58
59
60
61
62
63
64
65
66
# File 'app/helpers/workbench/navigation_helper.rb', line 56

def next_link(instance, text: 'Next', target: nil)
  link_text = (:span, text, 'class' => 'small-icon icon-right', 'data-icon' => 'arrow-right')
  link_object = next_object(instance)
  return (:div, link_text, 'class' => 'navigation-item disable') if link_object.nil?
  if target.nil?
    target ||= link_object.metamorphosize
  else
    target = send(target, id: link_object.id)
  end
  link_to(link_text, target, 'data-arrow' => 'next', 'class' => 'navigation-item')
end

- (Object) next_object(object)

Next ordered by ID, no wrapping



69
70
71
72
73
74
75
76
# File 'app/helpers/workbench/navigation_helper.rb', line 69

def next_object(object)
  base = object.class.base_class.order(id: :asc).where(['id > ?', object.id]).limit(1)
  if object.respond_to?(:project_id)
    base.with_project_id(object.project_id).first
  else
    base.first
  end
end


126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'app/helpers/workbench/navigation_helper.rb', line 126

def object_link(object)
  return nil if object.nil?
  klass_name = object.class.base_class.name.underscore
  link_method = klass_name + '_link'

  # If a customized link to method is available use that, otherwise use a generic
  if self.respond_to?(link_method)
    send(link_method, object)
  else
    t = object_tag(object)
    return "Unable to link to data #{object.class.name} id:#{object.id}." if t.blank?
    link_to(t.html_safe, metamorphosize_if(object))
  end
end

A previous record link.



43
44
45
46
47
48
49
50
51
52
53
# File 'app/helpers/workbench/navigation_helper.rb', line 43

def previous_link(instance, text: 'Previous', target: nil)
  link_text = (:span, text,  'data-icon' => 'arrow-left', 'class' => 'small-icon')
  link_object = previous_object(instance)
  return (:div, link_text, 'class' => 'navigation-item disable') if link_object.nil?
  if target.nil?
    target ||= link_object.metamorphosize
  else
    target = send(target, id: link_object.id)
  end
  link_to(link_text, target, 'data-arrow' => 'back', 'class' => 'navigation-item')
end

- (Object) previous_object(object)

Previous ordered by ID, no wrapping



79
80
81
82
83
84
85
86
# File 'app/helpers/workbench/navigation_helper.rb', line 79

def previous_object(object)
  base = object.class.base_class.order(id: :desc).where(['id < ?', object.id]).limit(1)
  if object.respond_to?(:project_id)
    base.with_project_id(object.project_id).first
  else
    base.first
  end
end

- (Object) quick_bar



24
25
26
# File 'app/helpers/workbench/navigation_helper.rb', line 24

def quick_bar
  render(partial: '/workbench/navigation/quick_bar')  if sessions_signed_in?
end


28
29
30
31
32
# File 'app/helpers/workbench/navigation_helper.rb', line 28

def quick_bar_link(related_model)
  model = Hub::Data::BY_NAME[ related_model.kind_of?(Hash) ? related_model.keys.first : related_model ]
  return nil if model.nil?
  (:li, data_link(model))
end


225
226
227
228
229
230
231
232
233
234
235
236
# File 'app/helpers/workbench/navigation_helper.rb', line 225

def recent_route_link(hsh)
  route = hsh.keys.first
  o = safe_object_from_attributes(hsh[route])
  if o.nil?
    link_to(route.parameterize(separator: ' - ').humanize.capitalize, route)
  elsif o
    o = o.metamorphosize if o.respond_to?(:metamorphosize)
    link_to(object_tag(o) + " [#{hsh[route]['object_type']}]", route)
  else
    (:em, 'Data no longer available.', class: :warning)
  end
end

Returns a link to the related data page

Returns:

  • (<a> tag, nil)

    a link to the related data page



240
241
242
243
244
# File 'app/helpers/workbench/navigation_helper.rb', line 240

def related_data_link_tag(object)
  return nil if object.nil?
  p = "related_#{member_base_path(metamorphosize_if(object))}_path"
  (:li, link_to('Related data', send(p, object))) if controller.respond_to?(p)
end

- (Object) safe_object_from_attributes(hsh)

DEPRECATED FOR RADIAL

def annotate_links(object: nil)
  [(:li, add_alternate_value_link(object: object)),
   (:li, add_citation_link(object: object)),
   (:li, add_data_attribute_link(object: object)),
   (:li, add_identifier_link(object: object)),
   (:li, add_note_link(object: object)),
   (:li, add_tag_link(object: object)),
   (:li, add_confidence_link(object: object)),
   (:li, add_protocol_link(object: object))
  ].compact.join.html_safe
end


214
215
216
217
218
219
220
221
222
223
# File 'app/helpers/workbench/navigation_helper.rb', line 214

def safe_object_from_attributes(hsh)
  if hsh['object_type'] && hsh['object_type']
    begin
      return hsh['object_type'].constantize.find(hsh['object_id'])
    rescue ActiveRecord::RecordNotFound
      return false
    end
  end
  nil
end

- (Object) slideout_clipboard

Slideout panels



8
9
10
# File 'app/helpers/workbench/navigation_helper.rb', line 8

def slideout_clipboard
  render(partial: '/shared/data/slideout/clipboard')  if sessions_current_project && sessions_signed_in?
end

- (Object) slideout_pdf_viewer



20
21
22
# File 'app/helpers/workbench/navigation_helper.rb', line 20

def slideout_pdf_viewer
  render(partial: '/shared/data/slideout/document')  if sessions_current_project && sessions_signed_in?
end

- (Object) slideout_pinboard



12
13
14
# File 'app/helpers/workbench/navigation_helper.rb', line 12

def slideout_pinboard
  render(partial: '/shared/data/slideout/pinboard')  if sessions_current_project && sessions_signed_in?
end

- (Object) slideout_recent



16
17
18
# File 'app/helpers/workbench/navigation_helper.rb', line 16

def slideout_recent
  render(partial: '/shared/data/slideout/recent')  if sessions_current_project && sessions_signed_in?
end

- (Object) task_bar



34
35
36
# File 'app/helpers/workbench/navigation_helper.rb', line 34

def task_bar
  render(partial: '/workbench/navigation/task_bar') if is_task_controller?
end

- (Boolean) user_can_edit?(object)

return [Boolean]

true if the current user has permissions to edit the object in question (does not test whether it is actually editable)

Returns:

  • (Boolean)


163
164
165
# File 'app/helpers/workbench/navigation_helper.rb', line 163

def user_can_edit?(object)
  sessions_current_user.is_administrator? || user_is_creator?(object)
end

- (Boolean) user_is_creator?(object)

return [Boolean]

true if the current user created this object

Returns:

  • (Boolean)


169
170
171
# File 'app/helpers/workbench/navigation_helper.rb', line 169

def user_is_creator?(object)
  object.created_by_id == sessions_current_user_id
end