1 /**
2 * Copyright (c) 2013-2023, 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.github;
31
32 import com.google.common.collect.ImmutableSet;
33 import com.google.common.collect.Iterables;
34 import java.lang.reflect.Modifier;
35 import java.util.Set;
36 import org.hamcrest.CustomTypeSafeMatcher;
37 import org.hamcrest.MatcherAssert;
38 import org.hamcrest.Matchers;
39 import org.junit.Rule;
40 import org.junit.Test;
41
42 /**
43 * Test for visibility.
44 * Checks that there are not public classes in package
45 * {@code com.jcabi.github}. Certain types including all Smart types are
46 * excluded.
47 *
48 * @author Carlos Crespo (carlos.a.crespo@gmail.com)
49 * @version $Id: e588f520e36b9f55a693fd61957d41f186b9c1fc $
50 */
51 public final class VisibilityTest {
52
53 /**
54 * Set of classes/interfaces that can be public.
55 */
56 private static final Set<String> SKIP = ImmutableSet.<String>builder()
57 .add("com.jcabi.github.RtGithub")
58 .add("com.jcabi.github.Bulk")
59 .add("com.jcabi.github.Smarts")
60 .add("com.jcabi.github.wire.CarefulWire")
61 .add("com.jcabi.github.mock.MkGithub")
62 .build();
63
64 /**
65 * ClasspathRule.
66 * @checkstyle VisibilityModifierCheck (3 lines)
67 */
68 @Rule
69 public final transient ClasspathRule classpath = new ClasspathRule();
70
71 /**
72 * Test for visibility.
73 * Checks that there are not public classes in package
74 * {@code com.jcabi.github}.
75 *
76 */
77 @Test
78 public void checkVisibility() {
79 MatcherAssert.assertThat(
80 Iterables.filter(
81 this.classpath.allTypes(),
82 input -> !(
83 input.isInterface()
84 || SKIP.contains(input.getName())
85 || input.getEnclosingClass() != null
86 && input.getName().endsWith("Smart")
87 )
88 ),
89 Matchers.everyItem(
90 new CustomTypeSafeMatcher<Class<?>>("not public type") {
91 @Override
92 protected boolean matchesSafely(final Class<?> item) {
93 return !Modifier.isPublic(item.getModifiers());
94 }
95 }
96 )
97 );
98 }
99
100 }