/* $Id: LocationTrackerTestCase.java 1125368 2011-05-20 13:06:27Z simonetripodi $
    *
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.commons.digester3;
  
  import static org.apache.commons.digester3.binder.DigesterLoader.newLoader;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  
  import java.io.StringReader;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.digester3.Digester;
  import org.apache.commons.digester3.StackAction;
  import org.apache.commons.digester3.binder.AbstractRulesModule;
  import org.junit.Test;
  import org.xml.sax.Locator;
  
  /**
   * Tests that StackAction can be used to track the source location of objects created from input xml stream.
   */
  
  public class LocationTrackerTestCase
  {
  
      private static class LocationTracker
          implements StackAction
      {
          public Map<Object, String> locations = new HashMap<Object, String>();
  
          public <T> T onPush( Digester d, String stackName, T o )
          {
              if ( stackName == null )
              {
                  // we only care about the real object stack
  
                  // note that a Locator object can also provide
                  // publicId and systemId info.
                  Locator l = d.getDocumentLocator();
                  StringBuilder locn = new StringBuilder();
                  locn.append( "line=" );
                  locn.append( l.getLineNumber() );
                  locations.put( o, locn.toString() );
              }
              return o;
          }
  
          public <T> T onPop( Digester d, String stackName, T o )
          {
              return o;
          }
      }
  
      @Test
      public void testAll()
          throws Exception
      {
          final String TEST_XML =
              "<?xml version='1.0'?>\n" + "<box id='root'>\n" + "  <subBox id='box1'/>\n" + "  <ignoreme/>\n"
                  + "  <subBox id='box2'/> <subBox id='box3'/>\n" + "</box>";
  
          LocationTracker locnTracker = new LocationTracker();
  
          Digester digester = newLoader( new AbstractRulesModule()
          {
  
              @Override
              protected void configure()
              {
                  forPattern( "box" ).createObject().ofType( Box.class )
                      .then()
                      .setProperties();
                  forPattern( "box/subBox" ).createObject().ofType( Box.class )
                      .then()
                      .setProperties()
                      .then()
                      .setNext( "addChild" );
              }
  
          })
          .setStackAction( locnTracker )
         .newDigester();
 
         Box root = digester.parse( new StringReader( TEST_XML ) );
         assertNotNull( root );
         List<Box> children = root.getChildren();
         assertEquals( 3, children.size() );
         Box box1 = children.get( 0 );
         Box box2 = children.get( 1 );
         Box box3 = children.get( 2 );
 
         assertEquals( "line=2", locnTracker.locations.get( root ) );
         assertEquals( "line=3", locnTracker.locations.get( box1 ) );
         assertEquals( "line=5", locnTracker.locations.get( box2 ) );
         assertEquals( "line=5", locnTracker.locations.get( box3 ) );
     }
 }