Ticket #18: ticket_18.patch

trunk/templates/display_metadata.tt

@@ -2 +2 @@
 <!-- METADATA STARTS -->
 
 <div id="metadata">
+[% FOREACH field = address_fields %]
+  [% IF address.$field %] 
+    [% address_populated = 1 %]
+  [% END %]
+[% END %]
 [% IF phone OR fax OR address OR postcode OR formatted_website_text
       OR hours_text OR map_link %] 
   <ul id="general_metadata">
@@ -16 +21 @@
         <span class="metadata_label">Fax:</span> [% CGI.escapeHTML(fax) %]
       </li>
     [% END %]
-    [% IF address %]
+    [% IF address_populated %]
       <li class="address">
         <span class="metadata_label">Address:</span>
-        [% CGI.escapeHTML(address) %]<!--, [% default_city %] --> [%# uncomment at left to show city %]
-        [% IF map_link %]
+      [% FOREACH field = address_fields %]
+        [% IF address.$field %] 
+          [% CGI.escapeHTML(address.$field) -%][% IF loop.last %].[% ELSE %],[% END %]
+        [% END %]
+      [% END %]
+      [% IF map_link %]
           <a href="[% map_link %]">(map of this place)</a>
-        [% END %]
+      [% END %]
       </li>
     [% ELSIF map_link %]
       <li class="map">
         <span class="metadata_label"><a href="[% map_link %]">Map of this place</a></span>
       </li>
     [% END %]
-    [% IF postcode %]
-      <li class="postcode">
-        <span class="metadata_label">Postcode:</span>
-        [% CGI.escapeHTML(postcode) %]
-      </li>
-    [% END %]
     [% IF formatted_website_text %]
       <li class="website_link">
         <span class="metadata_label">Website:</span> [% formatted_website_text %]

trunk/templates/edit_conflict.tt

@@ -66 +66 @@
         <td><input type="text" size="50" id="hours" name="hours_text" value="[% stored_hours_text %]"></td>
         <td>[% CGI.escapeHTML(new_hours_text) %]</td>
       </tr>
+        [% FOREACH field = address_fields %]
+          [% USE String ( field ) %]
             <tr>
-        <td class="label"><label for="address">Address:</label></td>
-        <td><input type="text" size="50" id="address" name="address" value="[% stored_address %]"></td>
-        <td>[% CGI.escapeHTML(new_address) %]</td>
-      </tr>
-            <tr>
-        <td class="label"><label for="postcode">Postcode:</label></td>
-        <td><input type="text" size="50" id="postcode" name="postcode" value="[% stored_postcode %]"></td>
-        <td>[% CGI.escapeHTML(new_postcode) %]</td>
-      </tr> 
-            <tr>
+              <td class="label"><label for="[% field %]">[% String.capital %]:</label></td>
+              <td><input type="text" size="50" id="[% field %]" name="[% field %]" value="[% stored_address.$field %]"></td>
+              <td>[% CGI.escapeHTML(new_address.$field) %]</td>
+            </tr>
+          [% END %]
+        [% END %]
+      <tr>
         <td class="label"><label for="os_x">OS X coordinate:</label></td>
         <td><input type="text" size="50" id="os_x" name="os_x" value="[% stored_os_x %]">
         <td>[% CGI.escapeHTML(new_os_x) %]</td>

trunk/templates/edit_form.tt

@@ +1 @@
+[% USE CGI %]
 [% INCLUDE header.tt page_title = "Edit $node_name - $site_name" %]
 <div id="content">
 
@@ -74 +75 @@
               <td class="label"><label for="hours">Opening hours:</label></td>
               <td><input type="text" size="50" id="hours" name="hours_text" value="[% hours_text %]" /></td>
             </tr>
+        [% FOREACH field = address_fields %]
+          [% USE String( field ) %]
+              <tr>
+                <td class="label"><label for="[% field %]">[% String.capital %]:</label></td>
+              [% IF preset.$field %]
+                  <td><input type="checkbox" name="[% field %]" value="[% preset.$field %]"
+            [% IF address.$field != '' %]
+              checked
+            [% END %]
+            />
+                    [% CGI.escapeHTML(preset.$field) %]</td>
+          [% ELSE %]
+                  <td><input type="text" size="50" name="[% field %]" value="[% address.$field %]" /></td>
+          [% END %]
+              </tr>
+            [% END %]
             <tr>
-              <td class="label"><label for="address">Address:</label></td>
-              <td><input type="text" size="50" id="address" name="address" value="[% address %]" /></td>
-            </tr>
-            <tr>
-              <td class="label"><label for="postcode">Postcode:</label></td>
-              <td><input type="text" size="50" id="postcode" name="postcode" value="[% postcode %]" /></td>
-            </tr>
-            <tr>
               <td class="label"><label for="[% coord_field_1 %]">[% coord_field_1_name %]:</label></td>
               <td><input type="text" size="50" id="[% coord_field_1 %]" name="[% coord_field_1 %]" value="[% coord_field_1_value %]" /></td>
             </tr>

trunk/t/21_rdf.t

@@ -23 +23 @@
                     script_url         => "http://wiki.example.com/",
                     script_name        => "mywiki.cgi",
                     site_name          => "CGI::Wiki Test Site",
-                    default_city       => "London",
-                    default_country    => "United Kingdom",
+                    preset_city       => "London",
+                    preset_country    => "United Kingdom",
                 }
     );
     eval { require CGI::Wiki::Search::Plucene; };
@@ -103 +103 @@
     like( $rdfxml, qr|<dc:date>|, "date element included" );
     unlike( $rdfxml, qr|<dc:date>1970|, "hasn't defaulted to the epoch" );
 
-    # Check that default city and country can be set to blank.
+    # Check that preset city and country can be set to blank.
     $config = OpenGuides::Test->make_basic_config;
-    $config->default_city( "" );
-    $config->default_country( "" );
+    $config->preset_city( "" );
+    $config->preset_country( "" );
     my $guide = OpenGuides->new( config => $config );
     OpenGuides::Test->write_data(
                                     guide => $guide,

trunk/t/15_template.t

@@ -5 +5 @@
 use OpenGuides::Config;
 use OpenGuides::Template;
 use Test::MockObject;
-use Test::More tests => 28;
+use Test::More tests => 30;
 
 my $config = OpenGuides::Config->new(
        vars => {
@@ -13 +13 @@
                  site_name             => 'CGI::Wiki Test Site',
                  script_url            => 'http://wiki.example.com/',
                  script_name           => 'mywiki.cgi',
-                 default_country       => 'United Kingdom',
-                 default_city          => 'London',
+                 preset_country        => 'United Kingdom',
+                 preset_city           => 'London',
                  contact_email         => 'wiki@example.com',
                  stylesheet_url        => 'http://wiki.example.com/styles.css',
                  home_name             => 'Home Page',
                  formatting_rules_node => 'Rules',
                  formatting_rules_link => '',
+                 address_format        => 'street,town,city,country,postcode',
                }
 );
 
@@ -91 +92 @@
 like( $output, qr/OPENGUIDES VERSION: 0\.\d\d/,
       "openguides_version set" );
 
+# Test address fields list
+like( $output, qr/ADDRESS FIELDS: Street,Town,City,Country,Postcode/,
+      "address fields" );
+
+TODO: {
+    local $TODO = "Address data test not ready in this module";
+    
+# Test address layout
+like( $output, qr/ADDRESS: 1 High Street,London,United Kingdom,AZ1 1XY./,
+      "address data" );
+}
+
 # Test TT variables auto-set from node name.
 $output = OpenGuides::Template->output(
     wiki     => $fake_wiki,

trunk/t/templates/15_test.tt

@@ -17 +17 @@
 OMIT FORMATTING LINK: [% omit_formatting_link %]
 
 ENABLE PAGE DELETION: [% enable_page_deletion %]
+
+ADDRESS FIELDS: 
+[%- FOREACH field = address_fields %]
+[%- USE String( field ) %]
+[%- String.capital %],
+[%- END %]
+
+ADDRESS: 
+[%- FOREACH field = address_fields %]
+  [%- IF address.$field %]
+    [%- address.$field %]
+    [%- IF field.last %].[% ELSE %],[% END %]
+  [%- END %]
+[%- END %]
+
+

trunk/lib/OpenGuides/Config.pm

@@ -8 +8 @@
    dbtype dbname dbuser dbpass dbhost script_name install_directory script_url
    custom_lib_path use_plucene indexing_directory enable_page_deletion
    admin_pass stylesheet_url site_name navbar_on_home_page home_name
-   site_desc default_city default_country contact_email default_language
-   formatting_rules_node formatting_rules_link backlinks_in_title template_path
-   custom_template_path geo_handler ellipsoid gmaps_api_key centre_long
-   centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
+   site_desc address_format contact_email default_language 
+   formatting_rules_node formatting_rules_link 
+   backlinks_in_title template_path custom_template_path geo_handler ellipsoid
+   gmaps_api_key centre_long centre_lat default_gmaps_zoom 
+   default_gmaps_search_zoom force_wgs84
 );
 my @questions = map { $_ . "__qu" } @variables;
 OpenGuides::Config->mk_accessors( @variables );
@@ -70 +71 @@
                      navbar_on_home_page => 1,
                      home_name => "Home",
                      site_desc => "A default configuration of OpenGuides",
-                     default_city => "",
-                     default_country => "",
+                     address_format => 'street,town,city,county,country,postcode',
                      default_language => "en",
                      formatting_rules_node => "Text Formatting Examples",
                      formatting_rules_link => "http://openguides.org/page/text_formatting",
@@ -101 +101 @@
     foreach my $var ( keys %defaults ) {
         $self->$var( $defaults{$var} );
     }
+    my $adf = $stored{address_format} || $defaults{address_format};
+    my @adf = map {
+                /code/i ? () : "preset_".$_ } 
+                split ',',$adf;
+    my @adf_qu = map {$_."__qu"} @adf;
+
+# Note: this is considering OpenGuides::Config a singleton, and is
+# adding accessors for questions dependent on address_format
+
+    OpenGuides::Config->mk_accessors( @adf );
+    OpenGuides::Config->mk_accessors( @adf_qu );
+        
     foreach my $var ( keys %stored ) {
         if ( $self->can( $var ) ) { # handle any garbage in file gracefully
             $self->$var( $stored{$var} );
@@ -132 +144 @@
         navbar_on_home_page => "Do you want the navigation bar included on the home page?",
         home_name => "What should the home page of the wiki be called?",
         site_desc => "How would you describe the site?",
-        default_city => "What city is the site based in?",
-        default_country => "What country is the site based in?",
+        address_format => "How would you like to present addresses? ",
         contact_email => "Contact email address for the site administrator?",
         default_language => "What language will the site be in? (Please give an ISO language code.)",
         formatting_rules_node => "What's the name of the node or page to use for the text formatting rules link (this is by default an external document, but if you make formatting_rules_link empty, it will be a wiki node instead",
@@ -151 +162 @@
     foreach my $var ( keys %questions ) {
         my $method = $var . "__qu";
         $self->$method( $questions{$var} );
+        if ($var eq 'address_format') {
+            my @address_fields = map {
+                /code/i ? () : "preset_".$_ } 
+                split ',',$self->$var;
+            my @address_fields_qu = map {$_."__qu"} @address_fields;
+
+# Note: this is considering OpenGuides::Config a singleton, and is
+# adding accessors for questions dependent on address_format
+
+            OpenGuides::Config->mk_accessors( @address_fields );
+            OpenGuides::Config->mk_accessors( @address_fields_qu );
+            for (@address_fields) {
+                my $meth = $_ . "__qu";
+                $self->$meth( ucfirst($_)." which this guide is for? " );
+            }
+        }
     }
 
     return $self;

trunk/lib/OpenGuides/Template.pm

@@ -115 +115 @@
 
     my $script_name  = $config->script_name;
     my $script_url   = $config->script_url;
-    my $default_city = $config->default_city;
+    my $address_format = $config->address_format;
+    my @address_fields = split /,/,$address_format;
+    my %preset;
+    for (@address_fields) {
+        next if /code/i;   # Post code, zip code
+        my $meth = "preset_$_";
+        $preset{$_} = $config->$meth;
+    }
     
     # Check cookie to see if we need to set the formatting_rules_link.
     my ($formatting_rules_link, $omit_help_links);
@@ -154 +161 @@
         openguides_version    => $OpenGuides::VERSION,
         enable_page_deletion  => $enable_page_deletion,
         language              => $config->default_language,
-        default_city          => $default_city,
+        address_fields        => \@address_fields,
+        preset                => \%preset,
         gmaps_api_key         => $config->gmaps_api_key
     };
 
@@ -250 +258 @@
     my $formatter = $args{wiki}->formatter;
     my $config = $args{config};
     my $script_name = $config->script_name;
+    my @address_fields = split /,/,$config->address_format;
 
     # Categories and locales are displayed as links in the page footer.
     # We return these twice, as eg 'category' being a simple array of
@@ -305 +314 @@
     );
 
     if ( $args{metadata} ) {
-        foreach my $var ( qw( phone fax address postcode os_x os_y osie_x
+        foreach my $var ( qw( phone fax os_x os_y osie_x
                               osie_y latitude longitude map_link website
                               summary) ) {
             $vars{$var} = $metadata{$var}[0];
         }
+
+        $vars{address} = { map {$_, $metadata{$_}[0]} @address_fields };
+
         # Data for the distance search forms on the node display.
         my $geo_handler = $config->geo_handler;
         if ( $geo_handler == 1 ) {
@@ -347 +359 @@
                     );
         }
     } else {
-        foreach my $var ( qw( phone fax address postcode map_link website summary) ) {
+        foreach my $var ( qw( phone fax map_link website summary) ) {
             $vars{$var} = $q->param($var);
         }
 
+        $vars{address} = { map {$q->param($_) ? ($_, $q->param($_)) : ()} 
+                @address_fields };
+
         my $geo_handler = $config->geo_handler;
         if ( $geo_handler == 1 ) {
             require Geography::NationalGrid::GB;

trunk/lib/OpenGuides/RDF.pm

@@ -3 +3 @@
 use strict;
 
 use vars qw( $VERSION );
-$VERSION = '0.08';
+$VERSION = '0.09';
 
 use CGI::Wiki::Plugin::RSS::ModWiki;
 use Time::Piece;
@@ -47 +47 @@
         $node_url;
       };  
     $self->{site_name}        = $config->site_name;
-    $self->{default_city}     = $config->default_city     || "";
-    $self->{default_country}  = $config->default_country  || "";
+    my @adf  = split /,/,$config->address_format;
+    $self->{address_fields}  = \@adf;
+    for (@adf) {
+        next if /code/i;
+        $self->{"preset_$_"} = $config->{"preset_$_"};
+    }
     $self->{site_description} = $config->site_desc        || "";
     $self->{og_version}       = $args{og_version};
 
@@ -68 +72 @@
     my $opening_hours_text = $node_data{metadata}{opening_hours_text}[0] || '';
     my $address            = $node_data{metadata}{address}[0]            || '';
     my $postcode           = $node_data{metadata}{postcode}[0]           || '';
-    my $city               = $node_data{metadata}{city}[0]               || $self->{default_city};
-    my $country            = $node_data{metadata}{country}[0]            || $self->{default_country};
+    my $town               = $node_data{metadata}{town}[0]               || $self->{preset_town};
+    my $city               = $node_data{metadata}{city}[0]               || $self->{preset_city};
+    my $county             = $node_data{metadata}{county}[0]             || $self->{preset_county};
+    my $state              = $node_data{metadata}{state}[0]              || $self->{preset_state};
+    my $country            = $node_data{metadata}{country}[0]            || $self->{preset_country};
     my $latitude           = $node_data{metadata}{latitude}[0]           || '';
     my $longitude          = $node_data{metadata}{longitude}[0]          || '';
     my $version            = $node_data{version};
@@ -82 +89 @@
 
     # replace any errant characters in data to prevent illegal XML
     foreach ($phone, $fax, $website, $opening_hours_text, $address, $postcode, 
-             $city, $country, $latitude, $longitude, $version, $os_x, $os_y, 
-             @categories, @locales, $summary)
+             $town, $city, $county, $state, $country, $latitude, $longitude, 
+             $version, $os_x, $os_y, @categories, @locales, $summary)
     {
       if ($_)
       {
@@ -150 +157 @@
     {
       $rdf .= "\n    <!-- address and geospatial data -->\n\n";
       $rdf .= "    <address>$address</address>\n"        if $address;
+      $rdf .= "    <town>$town</town>\n"                 if $town;
       $rdf .= "    <city>$city</city>\n"                 if $city;
+      $rdf .= "    <county>$county</county>\n"           if $county;
+      $rdf .= "    <state>$state</state>\n"              if $state;
       $rdf .= "    <postalCode>$postcode</postalCode>\n" if $postcode;
       $rdf .= "    <country>$country</country>\n"        if $country;
 

trunk/lib/OpenGuides.pm

@@ -758 +758 @@
     $metadata{longitude} = delete $metadata{longitude_unmunged}
         if $metadata{longitude_unmunged};
 
+    # Unravel address data
+    delete $metadata{address};
+
+    for (split ',',$config->address_format) {
+        if ($metadata{preset}{$_}) {
+            $metadata{$_} = "" unless $q->param($_);
+        }
+        else {
+            $metadata{$_} = $q->param($_) if $q->param($_);
+        }
+    }
+
+    delete $metadata{preset};
+
     # Check to make sure all the indexable nodes are created
     foreach my $type (qw(Category Locale)) {
         my $lctype = lc($type);

trunk/INSTALL

@@ -159 +159 @@
 
 Self-explanatory.
 
+  "How would you like to present addresses?"
+  
+Enter a comma separated list of metadata field names for an address.
+The default of street,town,city,county,country,postalCode works for a UK
+guide, but you are probably going to want to change this for other countries.
 
-  "What city is the wiki based in?"
-  "What country is the wiki based in?"
+See http://www.columbia.edu/kermit/postal.html for some extreme cases, and
+discussion as to why we can't standardise the whole thing easily.
 
-If the wiki will not be city or country specific you can leave either or
-both of these blank.
+   "xxx which this guide is for? "
 
+xxx is each of the fields in the address. This is how you preset a value for
+all pages. For example, specify city as London and country as UK, leaving all 
+others blank.
 
   "Contact email address for the wiki admin?"
 

trunk/Build.PL

@@ -75 +75 @@
    install_directory template_path custom_template_path script_url
    custom_lib_path use_plucene indexing_directory enable_page_deletion
    admin_pass stylesheet_url site_name navbar_on_home_page home_name
-   site_desc default_city default_country contact_email default_language
+   site_desc address_format contact_email default_language
    formatting_rules_node backlinks_in_title gmaps_api_key centre_long
    centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
   ) ) {
@@ -141 +141 @@
     push @answers, { question => $qu,
                      variable => $var,
                      value    => $val };
+    if ( $var eq "address_format" and !$skip_config ) {
+        for (split ',',$val) {
+            next if /code/i; # Post code, zip code
+            my $advar = "preset_".$_;
+            my $ucf = ucfirst $_;
+            my $adqu = "$ucf which this guide is for? "; 
+            my $adval = Module::Build->prompt($adqu, $existing_config->$advar );
+            push @answers, { question => $adqu,
+                             variable => $advar,
+                             value    => $adval } ;
+        }
+    }
 }
 
 # Now deal with the geo stuff.