File Coverage

blib/lib/RapidApp/Module/DbicPropPage.pm

Criterion	Covered	Total	%
statement	27	135	20.0
branch	3	44	6.8
condition	2	29	6.9
subroutine	7	14	50.0
pod	0	9	0.0
total	39	231	16.8

package RapidApp::Module::DbicPropPage;

use strict;
use warnings;

use Moose;
extends 'RapidApp::Module::StorCmp';
with 'RapidApp::Module::StorCmp::Role::DbicLnk';
with 'RapidApp::Module::StorCmp::Role::DbicLnk::RowPg';

use RapidApp::DBIC::Component::TableSpec;

use RapidApp::Util qw(:all);

has 'ResultSource' => ( is => 'ro', required => 1 );

# -- these aren't working... why ?
has '+single_record_fetch', default => 1;
has '+max_pagesize', default => 1;
# --

has 'exclude_grids_relationships', is => 'ro', isa => 'ArrayRef', default => sub {[]};
has 'exclude_grids_relationships_map', is => 'ro', lazy => 1, isa => 'HashRef', default => sub {
	my $self = shift;
	return { map {$_=>1} @{$self->exclude_grids_relationships} };
};

has 'setup_multi_grids', is => 'ro', isa => 'Bool', default => 1;

has '+allow_restful_queries', default => 1;

#has '+DataStore_build_params' => ( default => sub {{
#	store_autoLoad => 1,
#	reload_on_save => 0,
#}});


our $ONLY_MULTI_GRIDS = 0;

sub BUILD {
	my $self = shift;

	$self->apply_extconfig(
		xtype => 'panel',
		layout => 'anchor',
		autoScroll => \1,
		frame => \1,
	);

	$self->set_default_tab_icon;

	$self->init_multi_rel_modules;

	$self->add_ONCONTENT_calls('apply_items_config');
}




sub set_default_tab_icon {
	my $self = shift;
	my $class = $self->ResultClass or return;
	my $iconCls = $class->TableSpec_get_conf('iconCls') or return;
	$self->apply_extconfig( tabIconCls => $iconCls );
}


# Adds sub Modules for each included multi relationship. These are then used later on
# each request/when the page is rendered
sub init_multi_rel_modules {
	my $self = shift;
	my $TableSpec = shift || $self->TableSpec;

	#print STDERR RED . 'init_multi_rel_modules: ' . $TableSpec->relspec_prefix . CLEAR . "\n\n";

	foreach my $rel (@{$TableSpec->related_TableSpec_order}) {

		my $RelTS = $TableSpec->related_TableSpec->{$rel};

		# Recursive:
		$self->init_multi_rel_modules($RelTS);

		my $info = $TableSpec->ResultSource->relationship_info($rel);
		next unless ($info->{attrs}->{accessor} eq 'multi');

		my $cond_data = RapidApp::DBIC::Component::TableSpec->parse_relationship_cond($info->{cond});

		my $Source = $TableSpec->ResultSource->related_source($rel);

		my $mod_name = 'rel_' . $RelTS->column_prefix . $rel;

		my $mod_params = {
			include_colspec => $RelTS->include_colspec->init_colspecs,
			updatable_colspec => $RelTS->updatable_colspec->init_colspecs
		};

		my $colname = $TableSpec->column_prefix . $rel;


		# If this rel/colname is updatable in the top TableSpec, then that translates
		# into these multi rel rows being addable/deletable
		if ($self->TableSpec->colspec_matches_columns($self->TableSpec->updatable_colspec->colspecs,$colname)){
			$mod_params->{creatable_colspec} = [ @{$RelTS->updatable_colspec->colspecs} ];
			$mod_params->{destroyable_relspec} = ['*'];
			delete $mod_params->{creatable_colspec} unless (@{$mod_params->{creatable_colspec}} > 0);

			# We *must* be able to create on the forein col name to be able to create the link/relationship:
			if($mod_params->{creatable_colspec}) {
				push @{$mod_params->{creatable_colspec}}, $cond_data->{foreign};
				push @{$mod_params->{include_colspec}}, $cond_data->{foreign};

				# We can't change the key/link field:
				push @{$mod_params->{updatable_colspec}}, '!' . $cond_data->{foreign};
			}
		}

		$mod_params->{ResultSource} = $Source;

		$self->apply_init_modules( $mod_name => {
			class 	=> 'RapidApp::Module::DbicGrid',
			params	=> $mod_params
		});
	}
}



sub apply_items_config {
	my $self = shift;
	my $Row = $self->req_Row or return;
	$self->apply_extconfig( items => [ $self->full_property_grid ] );

	# 'tabPath' - unfinished feature
	#my $path = try{$Row->getRestPath} or return;
	#$self->apply_extconfig( tabPath => $path );
}

sub multi_grids {
	my $self = shift;
	return $self->full_property_grid(1);
}

sub full_property_grid {
	my $self = shift;
	my $multi_only = shift || 0;

	local $ONLY_MULTI_GRIDS = 1 if ($multi_only);

	my $real_columns = [];
	my @items = $self->TableSpec_property_grids($self->TableSpec,$self->req_Row,$real_columns);
	shift @items;

	# -- for performance, delete all the remaining columns that don't exist for
	# this row (such as relationships that don't exist for this row)
	#my %real_indx = map {$_=>1} @$real_columns;
	#my @delete_columns = grep { !$real_indx{$_} } keys %{$self->columns};
	#$self->delete_columns(@delete_columns);
	# --

	return @items;
}


sub TS_title {
	my $self = shift;
	my $TableSpec = shift;
	my $parm = shift || 'title';

	my $title = $TableSpec->relspec_prefix;
	$title = $self->TableSpec->name . '.' . $title unless ($title eq '');
	$title = $self->TableSpec->name if ($title eq '');

	my $cnftitle = $TableSpec->get_Cnf($parm);
	$title = $cnftitle . ' (' . $title . ')' unless ($TableSpec->name eq $cnftitle);

	return $title;
}


our $property_grid_nest_level = 0;

sub TableSpec_property_grids {
	my $self = shift;
	my $TableSpec = shift;
	my $Row = shift || $self->req_Row;
	my $real_columns = shift || [];

	local $property_grid_nest_level = $property_grid_nest_level + 1;

	return $self->not_found_content unless ($Row);

	my %cols = map { $_->{name} => $_ } @{ $self->column_list };

	my @colnames = $TableSpec->local_column_names;

  # New: attemp to honor the column order
  my %s = map {$_=>1} @colnames;
  @colnames = grep { $s{$_} } uniq(@{ $self->column_order }, @colnames);

	push @$real_columns, @colnames;


	## -- Filter out non-existant relationship columns:
	#@colnames = grep {
	#	exists $TableSpec->related_TableSpec->{$_} ?
	#		$Row->can($_) ? $Row->$_ ? 1 : 0
	#			: 0
	#				: 1;
	#} @colnames;
	## --



	my @columns = map { $cols{$_} } @colnames;
	my $fields = \@columns;


	my $icon = $TableSpec->get_Cnf('singleIconCls');

	my @items = ();
	my @multi_items = ();
	my $visible = scalar grep { ! jstrue $_->{no_column} } @$fields;

	push @items, { xtype => 'spacer', height => 5 }, $self->property_grid($TableSpec,$icon,$fields)
		if ($visible && ! $ONLY_MULTI_GRIDS);

	my @TableSpecs = ();

	foreach my $rel (@{$TableSpec->related_TableSpec_order}) {

		next if ($self->exclude_grids_relationships_map->{$rel});

		# This is fundamentally flawed if a related record doesn't exist initially, but then
		# gets created, it will never be available!!
		my $relRow = $Row->$rel;# or next;
		# New: consider 'update_create_rels' (note that update_create_rels API is subject to change)
		my %ucrls = map {$_=>1} @{$self->update_create_rels};
		my $setup_grid = (
			($relRow && $relRow->isa('DBIx::Class::Row')) or
			($property_grid_nest_level == 1 && $ucrls{$rel})
		) ? 1 : 0;
		if($setup_grid) {
			push @items, $self->TableSpec_property_grids(
				$TableSpec->related_TableSpec->{$rel},
				$relRow,
				$real_columns
			);
		}
		elsif(!$relRow) {
			next;
		}
		elsif($relRow->isa('DBIx::Class::ResultSet') and ($self->setup_multi_grids || $ONLY_MULTI_GRIDS)) {

			my $RelTS = $TableSpec->related_TableSpec->{$rel};

			my $info = $Row->result_source->relationship_info($rel);
			next unless ($info->{attrs}->{accessor} eq 'multi'); #<-- should be redundant
			my $cond_data = RapidApp::DBIC::Component::TableSpec->parse_relationship_cond($info->{cond});

			my $mod_name = 'rel_' . $RelTS->column_prefix . $rel;

			my $cur = $self->Module($mod_name)->content;
			push @{$cur->{plugins}}, 'grid-autoheight', 'titlecollapseplus';

			push @multi_items, { xtype => 'spacer', height => 5 };
			push @multi_items, {
				%$cur,
				autoWidth		=> \1,
				titleCountLocal => \1,
				collapsible => \1,
				collapseFirst => \1,
				titleCollapse => \1,
				title => $self->TS_title($RelTS,'title_multi'),
				#title => $RelTS->get_Cnf('title_multi') . ' (' . $rel . ')',
				iconCls => $RelTS->get_Cnf('multiIconCls'),
				gridsearch			=> undef,
				pageSize			=> undef,
				use_multifilters	=> \0,
				viewConfig => { emptyText => '<span style="color:darkgrey;">(No&nbsp;' . $RelTS->get_Cnf('title_multi') . ')</span>' },
				# Why do I have to set this manually?
				bodyStyle => 'border: 1px solid #D0D0D0;',
				baseParams => {
					resultset_condition => $self->json->encode({ 'me.' . $cond_data->{foreign} => $Row->get_column($cond_data->{self}) })
				},
				store_add_initData => {
					$cond_data->{foreign} => $Row->get_column($cond_data->{self})
				}
			};
		}
	}

	unshift @multi_items, { xtype => 'spacer', height => 5 } if (@multi_items > 0);

	return @items,@multi_items;
}



sub property_grid {
	my $self = shift;
	my $TableSpec = shift;
	my $icon = shift;
	my $fields = shift;
	my $opt = shift || {};

	my $title = $self->TS_title($TableSpec);

	# -- Programatically remove the automatically appened relspec from the header
	# (Search for 'column_property_transforms' in RapidApp::TableSpec::Role::DBIC for details)
	# We are just doing this so the column headers are shorter/cleaner and it is redundant in
	# this context (same info is in the title of the property grid).
	my $pre = $TableSpec->relspec_prefix;
	foreach my $column (@$fields) {
		$column->{header} or next;
		$column->{header} =~ s/\s+\(${pre}\)$//;
	}
	# --

	my $conf = {

		autoWidth		=> \1,
		#bodyCssClass => 'sbl-panel-body-noborder',
		bodyStyle => 'border: 1px solid #D0D0D0;',
		collapsible => \1,
		collapseFirst => \0,
		titleCollapse => \1,
		autoHeight => \1,
		title => $title,
		iconCls => $icon,
		xtype => 'apppropertygrid',
		hideHeaders => \1,
		autoHeight => \1,
		editable => \1,
		fields => $fields,
		store => $self->getStore_func,
		nameWidth => 250,

		sm => RapidApp::JSONFunc->new( func => 'new Ext.grid.RowSelectionModel', parm => {
			listeners => {
				# Disable row selection (note that disableSelection doesn't work in propertygrid with 'source')
				beforerowselect => RapidApp::JSONFunc->new( raw => 1, func => 'function() { return false; }' )
			}
		}),
		plugins => [ 'titlecollapseplus' ]
	};

  $self->has_extconfig_param($_) and $conf->{$_} =
    $self->get_extconfig_param($_) for qw/loadMask store_autoLoad/;

	return merge($conf,$opt);
}

sub not_found_content {
	my $self = shift;

	my $msg = 'Record not found';
	my $id = $self->supplied_id;
	$msg = "Record ($id) not found" if ($id);

	return { html => '<pre>' . $msg . '</pre>' };
}


1;