1 package SL::Controller::RequirementSpecItem;
5 use parent qw(SL::Controller::Base);
8 use List::MoreUtils qw(apply);
9 use List::Util qw(first);
12 use SL::DB::RequirementSpec;
13 use SL::DB::RequirementSpecComplexity;
14 use SL::DB::RequirementSpecItem;
15 use SL::DB::RequirementSpecRisk;
16 use SL::Helper::Flash;
18 use SL::Locale::String;
20 use Rose::Object::MakeMethods::Generic
22 scalar => [ qw(item visible_item visible_section) ],
23 'scalar --get_set_init' => [ qw(complexities risks) ],
26 __PACKAGE__->run_before('load_requirement_spec_item', only => [ qw(dragged_and_dropped ajax_update ajax_edit ajax_delete ajax_flag) ]);
27 __PACKAGE__->run_before('init_visible_section');
33 sub action_ajax_list {
36 my $js = SL::ClientJS->new;
38 if (!$::form->{clicked_id}) {
39 # Clicked on "sections" in the tree. Do nothing.
40 return $self->render($js);
43 my $clicked_item = SL::DB::RequirementSpecItem->new(id => $::form->{clicked_id})->load;
44 $self->item($clicked_item->get_section);
46 if (!$self->visible_section || ($self->visible_section->id != $self->item->id)) {
47 $self->render_list($js, $self->item, $clicked_item);
49 $self->select_node($js, $clicked_item);
55 sub action_dragged_and_dropped {
58 my $position = $::form->{position} =~ m/^ (?: before | after | last ) $/x ? $::form->{position} : die "Unknown 'position' parameter";
59 my $dropped_item = $::form->{dropped_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{dropped_id})->load : undef;
61 my $old_visible_section = $self->visible_section ? $self->visible_section : undef;
62 my $old_parent_id = $self->item->parent_id;
63 my $old_type = $self->item->get_type;
65 $self->item->db->do_transaction(sub {
66 $self->item->remove_from_list;
67 $self->item->parent_id($position =~ m/before|after/ ? $dropped_item->parent_id : $dropped_item->id);
68 $self->item->add_to_list(position => $position, reference => $::form->{dropped_id} || undef);
71 my $js = SL::ClientJS->new;
73 $self->item(SL::DB::RequirementSpecItem->new(id => $self->item->id)->load);
74 my $new_section = $self->item->get_section;
75 my $new_type = $self->item->get_type;
76 my $new_visible_section = SL::DB::RequirementSpecItem->new(id => $self->visible_item->id)->load->get_section;
78 return $self->render($js) if !$old_visible_section || ($new_type eq 'section');
80 # From here on $old_visible_section is definitely set.
82 my $old_parent = SL::DB::RequirementSpecItem->new(id => $old_parent_id)->load;
83 my $old_section = $old_parent->get_section;
85 # $::lxdebug->message(0, "old sec ID " . $old_section->id . " new " . $new_section->id . " old visible " . $old_visible_section->id . " new visible " . $new_visible_section->id
86 # . " PARENT: old " . $old_parent->id . " new " . $self->item->parent_id . '/' . $self->item->parent->id);
88 if ($old_visible_section->id != $new_visible_section->id) {
89 # The currently visible item has been dragged to a different section.
90 return $self->render_list($js, $new_section, $self->item)
94 if ($old_visible_section->id == $old_section->id) {
95 my $id_prefix = $old_type eq 'sub-function-block' ? 'sub-' : '';
96 $js->remove('#' . $id_prefix . 'function-block-' . $self->item->id);
98 if ($old_type eq 'sub-function-block') {
99 $self->replace_bottom($js, $old_parent) ;
100 $js->hide('#sub-function-block-container-' . $old_parent->id) if 0 == scalar(@{ $old_parent->children });
102 } elsif (0 == scalar(@{ $old_section->children })) {
103 $js->show('#section-list-empty');
107 if ($old_visible_section->id == $new_section->id) {
108 $js->hide('#section-list-empty');
110 my $id_prefix = $new_type eq 'sub-function-block' ? 'sub-' : '';
111 my $template = 'requirement_spec_item/_' . (apply { s/-/_/g; $_ } $new_type);
112 my $html = "" . $self->render($template, { output => 0 }, requirement_spec_item => $self->item);
113 my $next_item = $self->item->get_next_in_list;
116 $js->insertBefore($html, '#' . $id_prefix . 'function-block-' . $next_item->id);
118 my $parent_is_section = $self->item->parent->get_type eq 'section';
119 $js->appendTo($html, $parent_is_section ? '#section-list' : '#sub-function-block-container-' . $self->item->parent_id);
120 $js->show('#sub-function-block-container-' . $self->item->parent_id) if !$parent_is_section;
123 $self->replace_bottom($js, $self->item->parent) if $new_type eq 'sub-function-block';
126 # $::lxdebug->dump(0, "js", $js->to_array);
131 sub action_ajax_add_section {
132 my ($self, %params) = @_;
134 die "Missing parameter 'requirement_spec_id'" if !$::form->{requirement_spec_id};
136 $self->item(SL::DB::RequirementSpecItem->new(requirement_spec_id => $::form->{requirement_spec_id}));
138 my $insert_after = $::form->{id} ? SL::DB::RequirementSpecItem->new(id => $::form->{id})->load->get_section->id : undef;
139 my $html = $self->render('requirement_spec_item/_section_form', { output => 0 }, id_base => 'new_section', insert_after => $insert_after);
142 ->remove('#new_section_form')
143 ->hide('#column-content > *')
144 ->appendTo($html, '#column-content')
145 ->focus('#new_section_title')
149 sub action_ajax_add_function_block {
150 my ($self, %params) = @_;
152 return $self->add_function_block('function-block');
155 sub action_ajax_add_sub_function_block {
156 my ($self, %params) = @_;
158 return $self->add_function_block('sub-function-block');
161 sub action_ajax_create {
162 my ($self, %params) = @_;
164 my $js = SL::ClientJS->new;
165 my $prefix = $::form->{form_prefix} || die "Missing parameter 'form_prefix'";
166 my $attributes = $::form->{$prefix} || die "Missing parameter group '${prefix}'";
167 my $insert_after = delete $attributes->{insert_after};
169 my @errors = $self->item(SL::DB::RequirementSpecItem->new(%{ $attributes }))->validate;
170 return $js->error(@errors)->render($self) if @errors;
173 $self->item->add_to_list(position => 'after', reference => $insert_after) if $insert_after;
175 my $type = $self->item->get_type;
177 if ($type eq 'section') {
178 my $node = $self->presenter->requirement_spec_item_jstree_data($self->item);
179 return $self->render_list($js, $self->item)
180 ->jstree->create_node('#tree', $insert_after ? ('#fb-' . $insert_after, 'after') : ('#sections', 'last'), $node)
181 ->jstree->select_node('#tree', '#fb-' . $self->item->id)
185 my $template = 'requirement_spec_item/_' . (apply { s/-/_/g; $_ } $type);
186 my $html = $self->render($template, { output => 0 }, requirement_spec_item => $self->item, id_prefix => $type eq 'function-block' ? '' : 'sub-');
187 my $node = $self->presenter->requirement_spec_item_jstree_data($self->item);
189 $js->replaceWith('#' . $prefix . '_form', $html)
190 ->hide('#section-list-empty')
191 ->jstree->create_node('#tree', $insert_after ? ('#fb-' . $insert_after, 'after') : ('#fb-' . $self->item->parent_id, 'last'), $node)
192 ->jstree->select_node('#tree', '#fb-' . $self->item->id);
194 $self->replace_bottom($js, $self->item->parent) if $type eq 'sub-function-block';
199 sub action_ajax_edit {
200 my ($self, %params) = @_;
202 $self->item(SL::DB::RequirementSpecItem->new(id => $::form->{id})->load);
204 my $js = SL::ClientJS->new;
206 if (!$self->visible_section || ($self->visible_section->id != $self->item->get_section->id)) {
207 # Show section/item to edit if it is not visible.
209 my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->item);
210 $js->html('#column-content', $html);
213 if ($self->item->get_type =~ m/section/) {
214 # Edit the section header, not an item.
215 my $html = $self->render('requirement_spec_item/_section_form', { output => 0 });
217 $js->hide('#section-header-' . $self->item->id)
218 ->remove("#edit_section_form")
219 ->insertAfter($html, '#section-header-' . $self->item->id)
220 ->jstree->select_node('#tree', '#fb-' . $self->item->id)
221 ->focus("#edit_section_title")
222 ->val('#current_content_type', 'section')
223 ->val('#current_content_id', $self->item->id)
228 # Edit a function block or a sub function block
229 my @dependencies = $self->create_dependencies;
230 my @selected_dependencies = map { $_->id } @{ $self->item->dependencies };
232 my $html = $self->render('requirement_spec_item/_function_block_form', { output => 0 }, DEPENDENCIES => \@dependencies, SELECTED_DEPENDENCIES => \@selected_dependencies);
233 my $id_base = 'edit_function_block_' . $self->item->id;
234 my $content_top_id = '#' . $self->item->get_type . '-content-top-' . $self->item->id;
236 $js->hide($content_top_id)
237 ->remove("#${id_base}_form")
238 ->insertAfter($html, $content_top_id)
239 ->jstree->select_node('#tree', '#fb-' . $self->item->id)
240 ->focus("#${id_base}_description")
241 ->val('#current_content_type', $self->item->get_type)
242 ->val('#current_content_id', $self->item->id)
246 sub action_ajax_update {
247 my ($self, %params) = @_;
249 my $js = SL::ClientJS->new;
250 my $prefix = $::form->{form_prefix} || die "Missing parameter 'form_prefix'";
251 my $attributes = $::form->{$prefix} || {};
253 foreach (qw(requirement_spec_id parent_id position)) {
254 delete $attributes->{$_} if !defined $attributes->{$_};
257 my @errors = $self->item->assign_attributes(%{ $attributes })->validate;
258 return $js->error(@errors)->render($self) if @errors;
262 my $type = $self->item->get_type;
264 if ($type eq 'section') {
265 # Updated section, now update section header.
267 my $html = $self->render('requirement_spec_item/_section_header', { output => 0 }, requirement_spec_item => $self->item);
269 return SL::ClientJS->new
270 ->remove('#edit_section_form')
271 ->html('#section-header-' . $self->item->id, $html)
272 ->show('#section-header-' . $self->item->id)
273 ->jstree->rename_node('#tree', '#fb-' . $self->item->id, $::request->presenter->requirement_spec_item_tree_node_title($self->item))
277 # Updated function block or sub function block. Update (sub)
278 # function block and potentially the bottom of the parent function
281 my $id_prefix = $type eq 'function-block' ? '' : 'sub-';
282 my $html_top = $self->render('requirement_spec_item/_function_block_content_top', { output => 0 }, requirement_spec_item => $self->item, id_prefix => $id_prefix);
283 $id_prefix .= 'function-block-content-';
285 my $js = SL::ClientJS->new
286 ->remove('#' . $prefix . '_form')
287 ->replaceWith('#' . $id_prefix . 'top-' . $self->item->id, $html_top)
288 ->jstree->rename_node('#tree', '#fb-' . $self->item->id, $::request->presenter->requirement_spec_item_tree_node_title($self->item));
290 $self->replace_bottom($js, $self->item, id_prefix => $id_prefix);
291 $self->replace_bottom($js, $self->item->parent) if $type eq 'sub-function-block';
296 sub action_ajax_delete {
299 my $js = SL::ClientJS->new;
300 my $full_list = $self->item->get_full_list;
304 if ($self->visible_section && ($self->visible_section->id == $self->item->id)) {
305 # Currently visible section is deleted.
307 my $new_section = first { $_->id != $self->item->id } @{ $self->item->requirement_spec->sections };
309 $self->render_list($js, $new_section);
312 my $html = $self->render('requirement_spec_item/_no_section', { output => 0 });
313 $js->html('#column-content', $html)
314 ->val('#current_content_type', '')
315 ->val('#current_content_id', '')
318 } elsif ($self->visible_section && ($self->visible_section->id == $self->item->get_section->id)) {
319 # Item in currently visible section is deleted.
321 my $type = $self->item->get_type;
322 $js->remove('#edit_function_block_' . $self->item->id . '_form')
323 ->remove('#' . $type . '-' . $self->item->id);
325 $self->replace_bottom($js, $self->item->parent_id) if $type eq 'sub-function-block';
327 if (1 == scalar @{ $full_list }) {
328 if ($type eq 'function-block') {
329 $js->show('#section-list-empty');
330 } elsif ($type eq 'sub-function-block') {
331 $js->hide('#sub-function-block-container-' . $self->item->parent_id);
336 $js->jstree->delete_node('#tree', '#fb-' . $self->item->id)
340 sub action_ajax_flag {
343 $self->item->update_attributes(is_flagged => !$self->item->is_flagged);
345 my $is_visible = $self->visible_section && ($self->visible_section->id == $self->item->get_section->id);
348 ->action_if($is_visible, 'toggleClass', '#' . $self->item->get_type . '-' . $self->item->id, 'flagged')
349 ->toggleClass('#fb-' . $self->item->id, 'flagged')
357 sub load_requirement_spec {
359 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{requirement_spec_id})->load || die "No such requirement spec");
362 sub load_requirement_spec_item {
364 $self->item(SL::DB::RequirementSpecItem->new(id => $::form->{id})->load || die "No such requirement spec item");
371 sub create_random_id {
372 return join '-', Time::HiRes::gettimeofday();
375 sub format_exception {
376 return join "\n", (split m/\n/, $@)[0..4];
379 sub init_visible_section {
382 my $content_id = $::form->{current_content_id};
383 my $content_type = $::form->{current_content_type};
385 return undef unless $content_id;
386 return undef unless $content_type =~ m/section|function-block/;
388 $self->visible_item(SL::DB::Manager::RequirementSpecItem->find_by(id => $content_id));
389 return undef unless $self->visible_item;
391 return $self->visible_section($self->visible_item->get_section);
394 sub init_complexities {
397 return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
403 return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
407 my ($self, $js, $item_or_id) = @_;
409 my $item = (ref($item_or_id) ? $item_or_id : SL::DB::RequirementSpecItem->new(id => $item_or_id))->load;
410 my $id_prefix = $item->get_type eq 'function-block' ? '' : 'sub-';
411 my $html = $self->render('requirement_spec_item/_function_block_content_bottom', { output => 0 }, requirement_spec_item => $item, id_prefix => $id_prefix);
412 return $js->replaceWith('#' . $id_prefix . 'function-block-content-bottom-' . $item->id, $html);
416 my ($self, $js, $item, $item_to_select) = @_;
418 my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $item);
419 $self->select_node($js->html('#column-content', $html), $item_to_select || $item);
423 my ($self, $js, $item) = @_;
425 $js->val( '#current_content_type', $item->get_type)
426 ->val( '#current_content_id', $item->id)
427 ->jstree->select_node('#tree', '#fb-' . $item->id);
430 sub create_dependency_item {
432 [ $_[0]->id, $self->presenter->truncate(join(' ', grep { $_ } ($_[1], $_[0]->fb_number, $_[0]->description))) ];
435 sub create_dependencies {
438 return map { [ $_->fb_number . ' ' . $_->title,
439 [ map { ( $self->create_dependency_item($_),
440 map { $self->create_dependency_item($_, '->') } @{ $_->sorted_children })
441 } @{ $_->sorted_children } ] ]
442 } @{ $self->item->requirement_spec->sections };
445 sub add_function_block {
446 my ($self, $new_type) = @_;
448 my $clicked_id = $::form->{id} || ($self->visible_item ? $self->visible_item->id : undef);
450 die "Invalid new_type '$new_type'" if $new_type !~ m/^(?:sub-)?function-block$/;
451 die "Missing parameter 'id' and no visible item" if !$clicked_id;
452 die "Missing parameter 'requirement_spec_id'" if !$::form->{requirement_spec_id};
454 my $clicked_item = SL::DB::RequirementSpecItem->new(id => $clicked_id)->load;
455 my $clicked_type = $clicked_item->get_type;
457 die "Invalid clicked_type '$clicked_type'" if $clicked_type !~ m/^(?: section | (?:sub-)? function-block )$/x;
459 my $case = "${clicked_type}:${new_type}";
461 my ($insert_position, $insert_reference, $parent_id, $display_reference)
462 = $case eq 'section:function-block' ? ( 'appendTo', $clicked_item->id, $clicked_item->id, '#section-list' )
463 : $case eq 'function-block:function-block' ? ( 'insertAfter', $clicked_item->id, $clicked_item->parent_id, '#function-block-' )
464 : $case eq 'function-block:sub-function-block' ? ( 'appendTo' , $clicked_item->id, $clicked_item->id, '#sub-function-block-container-' )
465 : $case eq 'sub-function-block:function-block' ? ( 'insertAfter', $clicked_item->parent_id, $clicked_item->parent->parent_id, '#function-block-' )
466 : $case eq 'sub-function-block:sub-function-block' ? ( 'insertAfter', $clicked_item->id, $clicked_item->parent_id, '#sub-function-block-' )
467 : die "Invalid combination of 'clicked_type (section)/new_type ($new_type)'";
469 $self->item(SL::DB::RequirementSpecItem->new(requirement_spec_id => $::form->{requirement_spec_id}, parent_id => $parent_id));
471 $display_reference .= $insert_reference if $display_reference =~ m/-$/;
472 my $id_base = join('_', 'new_function_block', Time::HiRes::gettimeofday(), int rand 1000000000000);
473 my $html = $self->render(
474 'requirement_spec_item/_function_block_form',
476 DEPENDENCIES => [ $self->create_dependencies ],
477 SELECTED_DEPENDENCIES => [],
478 requirement_spec_item => $self->item,
480 insert_after => $insert_position eq 'insertAfter' ? $insert_reference : undef,
483 my $js = SL::ClientJS->new;
485 my $new_section = $self->item->get_section;
486 if (!$self->visible_section || ($self->visible_section->id != $new_section->id)) {
487 # Show section/item to edit if it is not visible.
489 $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $new_section);
490 $js->html('#column-content', $html)
491 ->val('#current_content_type', 'section')
492 ->val('#current_content_id', $new_section->id)
493 ->jstree->select_node('#tree', '#fb-' . $new_section->id);
496 # $::lxdebug->message(0, "alright! clicked ID " . $::form->{id} . " type $clicked_type new_type $new_type insert_pos $insert_position ref " . ($insert_reference // '<undef>') . " parent $parent_id display_ref $display_reference");
498 $js->action($insert_position, $html, $display_reference)
499 ->focus("#${id_base}_description");
501 $js->show('#sub-function-block-container-' . $parent_id) if $new_type eq 'sub-function-block';