Coverage Report

Coverage Report - com.jcabi.log.SecretDecor

Classes in this File

Line Coverage

Branch Coverage

Complexity

SecretDecor

0/29

0/26

3.333

 /**
  * Copyright (c) 2012-2015, jcabi.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met: 1) Redistributions of source code must retain the above
  * copyright notice, this list of conditions and the following
  * disclaimer. 2) Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following
  * disclaimer in the documentation and/or other materials provided
  * with the distribution. 3) Neither the name of the jcabi.com nor
  * the names of its contributors may be used to endorse or promote
  * products derived from this software without specific prior written
  * permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.jcabi.log;
 
 import java.util.Formattable;
 import java.util.FormattableFlags;
 import java.util.Formatter;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
 
 /**
  * Decorator of a secret text.
  * @author Marina Kosenko (marina.kosenko@gmail.com)
  * @author Yegor Bugayenko (yegor@teamed.io)
  * @version $Id: 98efd0fb4ede139c80e15babbc27d72990c7381b $
  * @since 0.1
  */
 @ToString
 @EqualsAndHashCode(of = "secret")
 final class SecretDecor implements Formattable {
 
     /**
      * The secret to work with.
      */
     private final transient String secret;
 
     /**
      * Public ctor.
      * @param scrt The secret
      */
     @SuppressWarnings("PMD.NullAssignment")
     SecretDecor(final Object scrt) {
         if (scrt == null) {
             this.secret = null;
         } else {
             this.secret = scrt.toString();
         }
     }
 
     // @checkstyle ParameterNumber (4 lines)
     @Override
     public void formatTo(final Formatter formatter, final int flags,
         final int width, final int precision) {
         if (this.secret == null) {
             formatter.format("NULL");
         } else {
             final StringBuilder fmt = new StringBuilder(10);
             fmt.append('%');
             if ((flags & FormattableFlags.LEFT_JUSTIFY) != 0) {
                 fmt.append('-');
             }
             if (width != 0) {
                 fmt.append(width);
             }
             if ((flags & FormattableFlags.UPPERCASE) == 0) {
                 fmt.append('s');
             } else {
                 fmt.append('S');
             }
             formatter.format(
                 fmt.toString(),
                 SecretDecor.scramble(this.secret)
             );
         }
     }
 
     /**
      * Scramble it and make unreadable.
      * @param text The text to scramble
      * @return The result
      */
     private static String scramble(final String text) {
         final StringBuilder out = new StringBuilder(10);
         if (text.isEmpty()) {
             out.append('?');
         } else {
             out.append(text.charAt(0));
         }
         out.append("***");
         if (text.isEmpty()) {
             out.append('?');
         } else {
             out.append(text.charAt(text.length() - 1));
         }
         return out.toString();
     }
 
 }

1		/**
2		* Copyright (c) 2012-2015, jcabi.com
3		* All rights reserved.
4		*
5		* Redistribution and use in source and binary forms, with or without
6		* modification, are permitted provided that the following conditions
7		* are met: 1) Redistributions of source code must retain the above
8		* copyright notice, this list of conditions and the following
9		* disclaimer. 2) Redistributions in binary form must reproduce the above
10		* copyright notice, this list of conditions and the following
11		* disclaimer in the documentation and/or other materials provided
12		* with the distribution. 3) Neither the name of the jcabi.com nor
13		* the names of its contributors may be used to endorse or promote
14		* products derived from this software without specific prior written
15		* permission.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19		* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20		* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21		* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22		* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23		* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24		* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26		* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27		* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28		* OF THE POSSIBILITY OF SUCH DAMAGE.
29		*/
30		package com.jcabi.log;
31
32		import java.util.Formattable;
33		import java.util.FormattableFlags;
34		import java.util.Formatter;
35		import lombok.EqualsAndHashCode;
36		import lombok.ToString;
37
38		/**
39		* Decorator of a secret text.
40		* @author Marina Kosenko (marina.kosenko@gmail.com)
41		* @author Yegor Bugayenko (yegor@teamed.io)
42		* @version $Id: 98efd0fb4ede139c80e15babbc27d72990c7381b $
43		* @since 0.1
44		*/
45	0	@ToString
46	0	@EqualsAndHashCode(of = "secret")
47		final class SecretDecor implements Formattable {
48
49		/**
50		* The secret to work with.
51		*/
52		private final transient String secret;
53
54		/**
55		* Public ctor.
56		* @param scrt The secret
57		*/
58		@SuppressWarnings("PMD.NullAssignment")
59	0	SecretDecor(final Object scrt) {
60	0	if (scrt == null) {
61	0	this.secret = null;
62		} else {
63	0	this.secret = scrt.toString();
64		}
65	0	}
66
67		// @checkstyle ParameterNumber (4 lines)
68		@Override
69		public void formatTo(final Formatter formatter, final int flags,
70		final int width, final int precision) {
71	0	if (this.secret == null) {
72	0	formatter.format("NULL");
73		} else {
74	0	final StringBuilder fmt = new StringBuilder(10);
75	0	fmt.append('%');
76	0	if ((flags & FormattableFlags.LEFT_JUSTIFY) != 0) {
77	0	fmt.append('-');
78		}
79	0	if (width != 0) {
80	0	fmt.append(width);
81		}
82	0	if ((flags & FormattableFlags.UPPERCASE) == 0) {
83	0	fmt.append('s');
84		} else {
85	0	fmt.append('S');
86		}
87	0	formatter.format(
88		fmt.toString(),
89		SecretDecor.scramble(this.secret)
90		);
91		}
92	0	}
93
94		/**
95		* Scramble it and make unreadable.
96		* @param text The text to scramble
97		* @return The result
98		*/
99		private static String scramble(final String text) {
100	0	final StringBuilder out = new StringBuilder(10);
101	0	if (text.isEmpty()) {
102	0	out.append('?');
103		} else {
104	0	out.append(text.charAt(0));
105		}
106	0	out.append("***");
107	0	if (text.isEmpty()) {
108	0	out.append('?');
109		} else {
110	0	out.append(text.charAt(text.length() - 1));
111		}
112	0	return out.toString();
113		}
114
115		}