Implemnting theme system

This fixes issue #8

Author: cardil

src/main/java/pl/wavesoftware/utils/stringify/api/Configuration.java

@@ -18,6 +18,7 @@
 
 import pl.wavesoftware.utils.stringify.spi.BeanFactory;
 import pl.wavesoftware.utils.stringify.spi.Configurator;
+import pl.wavesoftware.utils.stringify.spi.theme.Theme;
 
 /**
  * A interface that represents a configuration options for this library
@@ -60,4 +61,12 @@ public interface Configuration {
    * @return a self reference
    */
   Configuration beanFactory(BeanFactory beanFactory);
+
+  /**
+   * Configures a user provided theme
+   *
+   * @param theme a theme provided by user
+   * @return a self reference
+   */
+  Configuration theme(Theme theme);
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/DefaultConfiguration.java

@@ -19,7 +19,9 @@
 import pl.wavesoftware.utils.stringify.api.Configuration;
 import pl.wavesoftware.utils.stringify.api.Mode;
 import pl.wavesoftware.utils.stringify.impl.beans.BeansModule;
+import pl.wavesoftware.utils.stringify.impl.theme.ThemeModule;
 import pl.wavesoftware.utils.stringify.spi.BeanFactory;
+import pl.wavesoftware.utils.stringify.spi.theme.Theme;
 
 /**
  * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
@@ -31,6 +33,7 @@ final class DefaultConfiguration implements Configuration {
 
   private Mode mode = Mode.DEFAULT_MODE;
   private BeanFactory beanFactory = DEFAULT_BEAN_FACTORY;
+  private Theme theme = ThemeModule.INSTANCE.defaultTheme();
 
   @Override
   public Configuration mode(Mode mode) {
@@ -44,6 +47,12 @@ public Configuration beanFactory(BeanFactory beanFactory) {
     return this;
   }
 
+  @Override
+  public Configuration theme(Theme theme) {
+    this.theme = theme;
+    return this;
+  }
+
   DefaultConfiguration dup() {
     DefaultConfiguration dup = new DefaultConfiguration();
     dup.beanFactory = beanFactory;
@@ -58,4 +67,8 @@ Mode getMode() {
   BeanFactory getBeanFactory() {
     return beanFactory;
   }
+
+  Theme getTheme() {
+    return theme;
+  }
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/DefaultInspectionContext.java

@@ -17,6 +17,8 @@
 package pl.wavesoftware.utils.stringify.impl;
 
 import pl.wavesoftware.utils.stringify.impl.inspector.InspectionContext;
+import pl.wavesoftware.utils.stringify.impl.inspector.RootInpector;
+import pl.wavesoftware.utils.stringify.spi.theme.Theme;
 
 import java.util.IdentityHashMap;
 import java.util.Map;
@@ -28,14 +30,13 @@
 final class DefaultInspectionContext implements InspectionContext {
   private static final Object CONTAIN = new Object();
 
-  private final Map<Object, Object> resolved;
+  private final Map<Object, Object> resolved = new IdentityHashMap<>();
+  private final Theme theme;
 
-  DefaultInspectionContext() {
-    this(new IdentityHashMap<>());
-  }
+  private RootInpector rootInpector;
 
-  private DefaultInspectionContext(Map<Object, Object> resolved) {
-    this.resolved = resolved;
+  DefaultInspectionContext(Theme theme) {
+    this.theme = theme;
   }
 
   @Override
@@ -44,7 +45,21 @@ public boolean wasInspected(Object object) {
   }
 
   @Override
-  public void markIsInspected(Object object) {
+  public void markAsInspected(Object object) {
     resolved.put(object, CONTAIN);
   }
+
+  @Override
+  public RootInpector rootInspector() {
+    return rootInpector;
+  }
+
+  @Override
+  public Theme theme() {
+    return theme;
+  }
+
+  public void rootInpector(RootInpector rootInpector) {
+    this.rootInpector = rootInpector;
+  }
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/DefaultStringify.java

@@ -17,9 +17,11 @@
 package pl.wavesoftware.utils.stringify.impl;
 
 import pl.wavesoftware.utils.stringify.Stringify;
+import pl.wavesoftware.utils.stringify.api.Configuration;
 import pl.wavesoftware.utils.stringify.api.Inspect;
 import pl.wavesoftware.utils.stringify.api.Mode;
 import pl.wavesoftware.utils.stringify.spi.BeanFactory;
+import pl.wavesoftware.utils.stringify.spi.theme.Theme;
 
 /**
  * A default implementation of {@link Stringify}.
@@ -84,4 +86,10 @@ public Stringify beanFactory(BeanFactory beanFactory) {
     resolver.beanFactory(beanFactory);
     return this;
   }
+
+  @Override
+  public Configuration theme(Theme theme) {
+    resolver.theme(theme);
+    return this;
+  }
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/InspectorBasedToStringResolver.java

@@ -21,11 +21,11 @@
 import pl.wavesoftware.utils.stringify.impl.inspector.InspectionContext;
 import pl.wavesoftware.utils.stringify.impl.inspector.InspectorModule;
 import pl.wavesoftware.utils.stringify.impl.inspector.ObjectInspector;
+import pl.wavesoftware.utils.stringify.spi.theme.ComplexObjectStyle;
 
 import java.lang.reflect.Field;
 import java.util.LinkedHashMap;
 import java.util.Map;
-import java.util.function.Function;
 
 import static pl.wavesoftware.eid.utils.EidExecutions.tryToExecute;
 
@@ -40,56 +40,56 @@ final class InspectorBasedToStringResolver implements ToStringResolver {
   private final DefaultConfiguration configuration;
   private final Object target;
   private final InspectionContext inspectionContext;
-  private final Function<Object, CharSequence> alternative;
   private final BeanFactoryCache beanFactoryCache;
   private final InspectingFieldFactory inspectingFieldFactory;
 
   InspectorBasedToStringResolver(
     DefaultConfiguration configuration,
     Object target,
     InspectionContext inspectionContext,
-    Function<Object, CharSequence> alternative,
     BeanFactoryCache beanFactoryCache,
     InspectingFieldFactory inspectingFieldFactory
   ) {
     this.configuration = configuration;
     this.target = target;
     this.inspectionContext = inspectionContext;
-    this.alternative = alternative;
     this.beanFactoryCache = beanFactoryCache;
     this.inspectingFieldFactory = inspectingFieldFactory;
   }
 
   @Override
   public CharSequence resolve() {
-    inspectionContext.markIsInspected(target);
+    inspectionContext.markAsInspected(target);
+    ComplexObjectStyle style = inspectionContext.theme().complexObject();
     StringBuilder sb = new StringBuilder();
-    sb.append('<');
-    sb.append(target.getClass().getSimpleName());
+    sb.append(style.begin());
+    sb.append(style.name(target::getClass, target::hashCode));
     CharSequence props = propertiesForToString();
     if (props.length() != 0) {
-      sb.append(' ');
+      sb.append(style.nameSeparator());
       sb.append(props);
     }
-    sb.append('>');
+    sb.append(style.end());
     return sb;
   }
 
   private CharSequence propertiesForToString() {
     Map<String, CharSequence> props;
     props = inspectTargetAsClass(target.getClass());
+    ComplexObjectStyle style = inspectionContext.theme().complexObject();
     StringBuilder sb = new StringBuilder();
     for (Map.Entry<String, CharSequence> entry : props.entrySet()) {
       String fieldName = entry.getKey();
       CharSequence fieldStringValue = entry.getValue();
       sb.append(fieldName);
-      sb.append("=");
+      sb.append(style.propertyEquals());
       sb.append(fieldStringValue);
-      sb.append(", ");
+      sb.append(style.propertySeparator());
     }
-    if (sb.length() > 0) {
-      sb.deleteCharAt(sb.length() - 1);
-      sb.deleteCharAt(sb.length() - 1);
+    if (!props.isEmpty()) {
+      for (int i = 0; i < style.propertySeparator().length(); i++) {
+        sb.deleteCharAt(sb.length() - 1);
+      }
     }
     return sb;
   }
@@ -106,11 +106,13 @@ private Map<String, CharSequence> inspectTargetAsClass(Class<?> type) {
     return props;
   }
 
-  private void inspectFields(Field[] fields,
-                             Map<String, CharSequence> properties) {
+  private void inspectFields(
+    Field[] fields, Map<String, CharSequence> properties
+  ) {
     for (Field field : fields) {
       InspectionPoint inspectionPoint = createInspectionPoint(field);
-      InspectingField inspectingField = inspectingFieldFactory.create(inspectionPoint, beanFactoryCache);
+      InspectingField inspectingField = inspectingFieldFactory
+        .create(inspectionPoint, beanFactoryCache);
       if (inspectingField.shouldInspect()) {
         inspectAnnotatedField(properties, field, inspectingField);
       }
@@ -121,9 +123,11 @@ private InspectionPoint createInspectionPoint(Field field) {
     return new InspectionPointImpl(field, target);
   }
 
-  private void inspectAnnotatedField(final Map<String, CharSequence> properties,
-                                     final Field field,
-                                     final InspectingField inspectingField) {
+  private void inspectAnnotatedField(
+    final Map<String, CharSequence> properties,
+    final Field field,
+    final InspectingField inspectingField
+  ) {
     tryToExecute(() -> {
       ensureAccessible(field);
       Object value = field.get(target);
@@ -146,7 +150,7 @@ private static void ensureAccessible(Field field) {
   CharSequence inspectObject(Object object) {
     for (ObjectInspector inspector : OBJECT_INSPECTORS) {
       if (inspector.consentTo(object, inspectionContext)) {
-        return inspector.inspect(object, alternative);
+        return inspector.inspect(object, inspectionContext);
       }
     }
     ToStringResolverImpl sub = new ToStringResolverImpl(

src/main/java/pl/wavesoftware/utils/stringify/impl/ToStringResolverImpl.java

@@ -22,8 +22,7 @@
 import pl.wavesoftware.utils.stringify.impl.beans.BeansModule;
 import pl.wavesoftware.utils.stringify.impl.inspector.InspectionContext;
 import pl.wavesoftware.utils.stringify.spi.BeanFactory;
-
-import java.util.function.Function;
+import pl.wavesoftware.utils.stringify.spi.theme.Theme;
 
 /**
  * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
@@ -44,7 +43,7 @@ final class ToStringResolverImpl implements ToStringResolver, Configuration {
     this(
       target,
       configuration,
-      new DefaultInspectionContext(),
+      new DefaultInspectionContext(configuration.getTheme()),
       BeansModule.INSTANCE.cachedBeanFactory(
         configuration::getBeanFactory, target
       ),
@@ -61,9 +60,23 @@ final class ToStringResolverImpl implements ToStringResolver, Configuration {
   ) {
     this.configuration = configuration;
     this.delegateResolver = new InspectorBasedToStringResolver(
-      configuration, target, inspectionContext, new ObjectInspectorImpl(),
+      configuration, target, inspectionContext,
+      beanFactoryCache, inspectingFieldFactory
+    );
+  }
+
+  private ToStringResolverImpl(
+    Object target,
+    DefaultConfiguration configuration,
+    DefaultInspectionContext inspectionContext,
+    BeanFactoryCache beanFactoryCache,
+    InspectingFieldFactory inspectingFieldFactory
+  ) {
+    this(
+      target, configuration, (InspectionContext) inspectionContext,
       beanFactoryCache, inspectingFieldFactory
     );
+    inspectionContext.rootInpector(delegateResolver::inspectObject);
   }
 
   @Override
@@ -83,13 +96,9 @@ public Configuration beanFactory(BeanFactory beanFactory) {
     return configuration.beanFactory(beanFactory);
   }
 
-  private final class ObjectInspectorImpl implements Function<Object, CharSequence> {
-
-    @Override
-    public CharSequence apply(Object object) {
-      return delegateResolver.inspectObject(object);
-    }
-
+  @Override
+  public Configuration theme(Theme theme) {
+    delegateResolver.clear();
+    return configuration.theme(theme);
   }
-
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/inspector/CharSequenceInspector.java

@@ -16,22 +16,21 @@
 
 package pl.wavesoftware.utils.stringify.impl.inspector;
 
-import java.util.function.Function;
-
 /**
  * @author <a href="mailto:krzysztof.suszynski@coi.gov.pl">Krzysztof Suszynski</a>
  * @since 1.0.0
  */
 final class CharSequenceInspector implements ObjectInspector {
   @Override
-  public boolean consentTo(Object candidate, InspectionContext inspectionContext) {
+  public boolean consentTo(Object candidate, InspectionContext context) {
     return candidate instanceof CharSequence;
   }
 
   @Override
-  public CharSequence inspect(Object object,
-                              Function<Object, CharSequence> alternative) {
-    return "\"" + object.toString() + "\"";
+  public CharSequence inspect(Object object, InspectionContext context) {
+    CharSequence quote = context.theme().charSequence().quote();
+    StringBuilder stringBuilder = new StringBuilder(quote);
+    return stringBuilder.append(object.toString()).append(quote);
   }
 
 }

src/main/java/pl/wavesoftware/utils/stringify/impl/inspector/CharacterInspector.java

@@ -16,21 +16,21 @@
 
 package pl.wavesoftware.utils.stringify.impl.inspector;
 
-import java.util.function.Function;
-
 /**
  * @author <a href="mailto:krzysztof.suszynski@coi.gov.pl">Krzysztof Suszynski</a>
  * @since 1.0.0
  */
 final class CharacterInspector implements ObjectInspector {
 
   @Override
-  public boolean consentTo(Object candidate, InspectionContext inspectionContext) {
+  public boolean consentTo(Object candidate, InspectionContext context) {
     return candidate instanceof Character;
   }
 
   @Override
-  public CharSequence inspect(Object object, Function<Object, CharSequence> alternative) {
-    return "'" + object.toString() + "'";
+  public CharSequence inspect(Object object, InspectionContext context) {
+    CharSequence quote = context.theme().character().quote();
+    StringBuilder stringBuilder = new StringBuilder(quote);
+    return stringBuilder.append(object.toString()).append(quote);
   }
 }