Remove Class::InsideOut from TaxDriver and child classes. The EU driver could be improved to use FormBuilder to make the configuration file.

This commit is contained in:
Colin Kuskie 2010-08-26 13:26:01 -07:00
parent d995ec19d1
commit 56e28acd50
3 changed files with 100 additions and 113 deletions

View file

@ -36,9 +36,53 @@ These subroutines are available from this package:
use strict;
use Class::InsideOut qw{ :std };
use Moose;
use WebGUI::Definition;
use Scalar::Util qw/blessed/;
has session => (
is => 'ro',
required => 1,
);
has messages => (
is => 'rw',
default => sub { [] },
);
use JSON qw{ from_json to_json };
#-------------------------------------------------------------------
=head2 new ( $session )
Constructor
=head3 session
Instanciated WebGUI::Session object.
=cut
around BUILDARGS => sub {
my $orig = shift;
my $class = shift;
my $session = shift;
if (! (blessed $session && $session->isa('WebGUI::Session'))) {
WebGUI::Error::InvalidObject->throw(expected=>"WebGUI::Session", got=>(ref $session), error=>"Need a session.");
}
my $optionsJSON = $session->db->quickScalar( 'select options from taxDriver where className=?', [
$class,
] );
my $options = $optionsJSON ? from_json( $optionsJSON ) : {};
$options->{session} = $session;
return $class->$orig($options);
};
=head1 NAME
Package WebGUI::Shop::TaxDriver
@ -59,11 +103,6 @@ These subroutines are available from this package:
=cut
readonly session => my %session;
readonly messages => my %messages;
private options => my %options;
=head2 appendCartItemVars ( var, cartItem )
Adds tax driver specific template variables for the given cart item to the supplied hashref.
@ -121,47 +160,20 @@ sub canManage {
=head2 className {
Returns the class name of your plugin. You must overload this method in you own plugin.
Returns the class name of your plugin.
=cut
sub className {
my $self = shift;
$self->session->log->fatal( "Tax plugin (".$self->className.") is required to overload the className method" );
my $className = ref $self;
$self->session->log->fatal( "Tax plugin (".$self->className.") is required to overload the className method" )
if $className eq 'WebGUI::Shop::TaxDriver';
return 'WebGUI::Shop::TaxDriver';
return $className;
}
#-----------------------------------------------------------
=head2 get ( [ property ] )
Returns the value of the requested configuration property. Returns a hash ref of all property/value pairs when no
specific property is passed.
=head3 property
The property whose value should be returned.
=cut
sub get {
my $self = shift;
my $key = shift;
my $options = $options{ id $self };
# Return safe copy of options hash if no key is passed.
return { %{ $options } } unless $key;
# Return option if key is passed.
return $options->{ $key } if exists $options->{ $key };
# Key does not exist.
$self->session->log->warn( "Non-existant option [$key] was queried by tax plugin $self" );
return undef;
}
#-----------------------------------------------------------
@ -252,42 +264,6 @@ sub skuFormDefinition {
#-------------------------------------------------------------------
=head2 new ( $session )
Constructor
=head3 session
Instanciated WebGUI::Session object.
=cut
sub new {
my $class = shift;
my $session = shift;
WebGUI::Error::InvalidObject->throw( expected => "WebGUI::Session", got => (ref $session), error => "Need a session." )
unless $session && $session->isa( 'WebGUI::Session' );
my $self = {};
bless $self, $class;
register $self;
my $id = id $self;
$session{ $id } = $session;
$messages{ $id } = [];
# Load plugin configuration
my $optionsJSON = $session->db->quickScalar( 'select options from taxDriver where className=?', [
$self->className,
] );
$options{ $id } = $optionsJSON ? from_json( $optionsJSON ) : {};
return $self;
}
#-------------------------------------------------------------------
=head2 processSkuFormPost ( )
Processes the form parameters defined in the skuFormDefinition method and returns a hash ref containing the result.
@ -312,28 +288,21 @@ sub processSkuFormPost {
#-----------------------------------------------------------
=head2 update ( properties )
=head2 write ( )
Updates the properties of the tax driver according to those passed.
=head3 properties
Hash ref containing the properties to set.
Store the properties of this object to the database, as a JSON blob.
=cut
sub update {
sub write {
my $self = shift;
my $update = shift;
my $db = $self->session->db;
# update local options hash
$options{ id $self } = { %{ $options{ id $self } }, %{ $update } };
my $options = $self->get();
# Persist to db
$db->write( 'replace into taxDriver (className, options) values (?,?)', [
$self->session->db->write( 'replace into taxDriver (className, options) values (?,?)', [
$self->className,
to_json( $options{ id $self } ),
to_json( $options ),
] );
}

View file

@ -26,6 +26,45 @@ use JSON qw{ to_json };
use Tie::IxHash;
use base qw{ WebGUI::Shop::TaxDriver };
use Moose;
use WebGUI::Definition;
extends 'WebGUI::Shop::TaxDriver';
property taxGroups => (
fieldType => 'text',
noFormPost => 1,
default => sub { [] },
);
property shopCountry => (
fieldType => 'text',
noFormPost => 1,
default => '',
);
property userTemplateId => (
fieldType => 'text',
noFormPost => 1,
default => '',
);
property automaticViesApproval => (
fieldType => 'text',
noFormPost => 1,
default => '',
);
property acceptOnViesUnavailable => (
fieldType => 'text',
noFormPost => 1,
default => '',
);
property defaultGroup => (
fieldType => 'text',
noFormPost => 1,
default => '',
);
=head1 NAME
@ -200,18 +239,6 @@ sub appendCartItemVars {
#-------------------------------------------------------------------
=head2 className
Returns the name of this class.
=cut
sub className {
return 'WebGUI::Shop::TaxDriver::EU';
}
#-------------------------------------------------------------------
=head2 deleteGroup ( groupId )
Deletes a tax group.

View file

@ -8,7 +8,9 @@ use WebGUI::Exception::Shop;
use List::Util qw{ sum };
use Tie::IxHash;
use base qw{ WebGUI::Shop::TaxDriver };
use Moose;
use WebGUI::Definition;
extends 'WebGUI::Shop::TaxDriver';
=head1 NAME
@ -142,18 +144,6 @@ sub getTaxRate {
#-------------------------------------------------------------------
=head2 className
Returns the name of this class.
=cut
sub className {
return 'WebGUI::Shop::TaxDriver::Generic';
}
#-------------------------------------------------------------------
=head2 delete ( [$params] )
Deletes data from the tax table by taxId.
@ -469,7 +459,8 @@ sub www_getTaxesAsJson {
my ($db, $form) = $session->quick(qw(db form));
my $startIndex = $form->get('startIndex') || 0;
my $numberOfResults = $form->get('results') || 25;
my %goodKeys = qw/country 1 state 1 city 1 code 1 'tax rate' 1/;
my %goodKeys = qw/country 1 state 1 city 1 code 1/;
$goodKeys{'tax rate'} = 1;
my $sortKey = $form->get('sortKey');
$sortKey = $goodKeys{$sortKey} == 1 ? $sortKey : 'country';
my $sortDir = $form->get('sortDir');