#1807: Fix typo in README.md and improve code formatting in Bulk.java.

yegor256 · yegor256 · commit 6b2c4ff64386 · 2025-11-21T09:49:50.000+03:00
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+# GitHub API Object-Oriented Java Client
+
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
 [![DevOps By Rultor.com](https://www.rultor.com/b/jcabi/jcabi-github)](https://www.rultor.com/p/jcabi/jcabi-github)
 [![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
@@ -14,7 +16,7 @@ This is a Java adapter to the [GitHub RESTful API].
 There are a few other similar implementations on the market,
 but jcabi-github has a very strong focus on
 object-oriented principles of programming. On top of that,
-we have a unique implemenation of GitHub server-side functionality,
+we have a unique implementation of GitHub server-side functionality,
 which you can use in your unit tests, eliminating the necessity to connect
 to GitHub during unit/integration testing.
 Please, read the blog post
@@ -126,7 +128,8 @@ a new GitHub OAuth access tokens
 and provide them in command line, like this:
 
 ```bash
-mvn clean install -Dit.test=RtGistITCase -Dfailsafe.github.key=<token> -Dfailsafe.github.key.second=<second-token> -Dfailsafe.github.repo=<repo>
+mvn clean install -Dit.test=RtGistITCase -Dfailsafe.github.key=<token> \
+  -Dfailsafe.github.key.second=<second-token> -Dfailsafe.github.repo=<repo>
 ```
 
 Replace `<token>` and `<second-token>` with the OAuth access tokens
diff --git a/src/main/java/com/jcabi/github/Bulk.java b/src/main/java/com/jcabi/github/Bulk.java
@@ -77,7 +77,10 @@ public Bulk(final Iterable<T> items) {
                             } else {
                                 try {
                                     result = method.invoke(item, args);
-                                } catch (final IllegalAccessException | InvocationTargetException ex) {
+                                } catch (
+                                    final IllegalAccessException
+                                        | InvocationTargetException ex
+                                ) {
                                     throw new IllegalStateException(ex);
                                 }
                             }
diff --git a/src/main/java/com/jcabi/github/Repos.java b/src/main/java/com/jcabi/github/Repos.java
@@ -93,12 +93,12 @@ Iterable<Repo> iterate(
     @SuppressWarnings("PMD.TooManyMethods")
     @ToString
     @Loggable(Loggable.DEBUG)
-    @EqualsAndHashCode(of = {"nam", "priv", "descr", "home", "init"})
+    @EqualsAndHashCode(of = {"repo", "priv", "descr", "home", "init"})
     final class RepoCreate implements JsonReadable {
         /**
          * Name of the new repo.
          */
-        private final transient String nam;
+        private final transient String repo;
 
         /**
          * Privateness of the new repo.
@@ -164,7 +164,7 @@ private RepoCreate(
             if (nme.isEmpty()) {
                 throw new IllegalArgumentException("Name cannot be empty!");
             }
-            this.nam = nme;
+            this.repo = nme;
             this.priv = prvt;
             this.descr = desc;
             this.home = page;
@@ -178,7 +178,7 @@ private RepoCreate(
          * @return Name
          */
         public String name() {
-            return this.nam;
+            return this.repo;
         }
 
         /**
@@ -250,7 +250,7 @@ public Repos.RepoCreate withName(
          */
         public Repos.RepoCreate withPrivacy(final boolean privacy) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 privacy,
                 this.descr,
                 this.home,
@@ -268,7 +268,7 @@ public Repos.RepoCreate withDescription(
             final String desc
         ) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 this.priv,
                 desc,
                 this.home,
@@ -286,7 +286,7 @@ public Repos.RepoCreate withHomepage(
             final String page
         ) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 this.priv,
                 this.descr,
                 page,
@@ -302,7 +302,7 @@ public Repos.RepoCreate withHomepage(
          */
         public Repos.RepoCreate withAutoInit(final Optional<Boolean> auto) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 this.priv,
                 this.descr,
                 this.home,
@@ -318,7 +318,7 @@ public Repos.RepoCreate withAutoInit(final Optional<Boolean> auto) {
          */
         public Repos.RepoCreate withAutoInit(final boolean auto) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 this.priv,
                 this.descr,
                 this.home,
@@ -334,7 +334,7 @@ public Repos.RepoCreate withAutoInit(final boolean auto) {
          */
         public Repos.RepoCreate withOrganization(final String org) {
             return new Repos.RepoCreate(
-                this.nam,
+                this.repo,
                 this.priv,
                 this.descr,
                 this.home,
@@ -362,7 +362,7 @@ public Repos.RepoCreate with(final String key, final JsonValue value) {
         @Override
         public JsonObject json() {
             JsonObjectBuilder builder = Json.createObjectBuilder()
-                .add("name", this.nam)
+                .add("name", this.repo)
                 .add("description", this.descr)
                 .add("homepage", this.home)
                 .add("private", this.priv);
diff --git a/src/main/java/com/jcabi/github/RtBranch.java b/src/main/java/com/jcabi/github/RtBranch.java
@@ -15,7 +15,7 @@
  */
 @Immutable
 @Loggable(Loggable.DEBUG)
-@EqualsAndHashCode(of = { "entry", "owner", "nam", "hash" })
+@EqualsAndHashCode(of = { "entry", "owner", "branch", "hash" })
 public final class RtBranch implements Branch {
     /**
      * API entry point.
@@ -30,7 +30,7 @@ public final class RtBranch implements Branch {
     /**
      * Name of this branch.
      */
-    private final transient String nam;
+    private final transient String branch;
 
     /**
      * Commit SHA hash.
@@ -52,7 +52,7 @@ public final class RtBranch implements Branch {
         final String sha) {
         this.entry = req;
         this.owner = repo;
-        this.nam = nom;
+        this.branch = nom;
         this.hash = sha;
     }
 
@@ -63,7 +63,7 @@ public Repo repo() {
 
     @Override
     public String name() {
-        return this.nam;
+        return this.branch;
     }
 
     @Override
diff --git a/src/main/java/com/jcabi/github/RtHooks.java b/src/main/java/com/jcabi/github/RtHooks.java
@@ -101,15 +101,15 @@ public Hook create(
         for (final Map.Entry<String, String> entr : config.entrySet()) {
             configs.add(entr.getKey(), entr.getValue());
         }
-        final JsonArrayBuilder evnts = Json.createArrayBuilder();
+        final JsonArrayBuilder builder = Json.createArrayBuilder();
         for (final Event event : events) {
-            evnts.add(event.toString());
+            builder.add(event.toString());
         }
         final JsonStructure json = Json.createObjectBuilder()
             .add("name", name)
             .add("config", configs)
             .add("active", active)
-            .add("events", evnts)
+            .add("events", builder)
             .build();
         return this.get(
             this.request.method(Request.POST)
diff --git a/src/main/java/com/jcabi/github/RtSearchPagination.java b/src/main/java/com/jcabi/github/RtSearchPagination.java
@@ -211,7 +211,12 @@ public <T extends Response> T as(final Class<T> type) {
             try {
                 return type.getDeclaredConstructor(Response.class)
                     .newInstance(this);
-            } catch (final InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException ex) {
+            } catch (
+                final InstantiationException
+                    | IllegalAccessException
+                    | InvocationTargetException
+                    | NoSuchMethodException ex
+            ) {
                 throw new IllegalStateException(ex);
             }
         }
diff --git a/src/main/java/com/jcabi/github/Smarts.java b/src/main/java/com/jcabi/github/Smarts.java
@@ -82,7 +82,11 @@ public void remove() {
     private static <X> X wrap(final Object object) {
         try {
             return (X) Smarts.type(object).newInstance(object);
-        } catch (final InvocationTargetException | InstantiationException | IllegalAccessException ex) {
+        } catch (
+            final InvocationTargetException
+                | InstantiationException
+                | IllegalAccessException ex
+        ) {
             throw new IllegalStateException(ex);
         }
     }
diff --git a/src/main/java/com/jcabi/github/mock/MkBranch.java b/src/main/java/com/jcabi/github/mock/MkBranch.java
@@ -33,7 +33,7 @@ public final class MkBranch implements Branch {
     /**
      * Branch name.
      */
-    private final transient String nam;
+    private final transient String branch;
 
     /**
      * Commit sha.
@@ -61,7 +61,7 @@ public final class MkBranch implements Branch {
         this.storage = stg;
         this.self = login;
         this.coords = rep;
-        this.nam = nom;
+        this.branch = nom;
         this.hash = sha;
     }
 
@@ -72,7 +72,7 @@ public Repo repo() {
 
     @Override
     public String name() {
-        return this.nam;
+        return this.branch;
     }
 
     @Override
diff --git a/src/main/java/com/jcabi/github/mock/MkStorage.java b/src/main/java/com/jcabi/github/mock/MkStorage.java
@@ -160,7 +160,7 @@ private static File temp() throws IOException {
     }
 
     /**
-     * Syncronized.
+     * Synchronized.
      * @since 0.5
      */
     @Immutable
diff --git a/src/main/java/com/jcabi/github/package-info.java b/src/main/java/com/jcabi/github/package-info.java
@@ -4,12 +4,12 @@
  */
 
 /**
- * Object Oriented GitHub API.
+ * Object-Oriented GitHub API.
  *
  * <p>The only dependency you need is (check our latest version available
  * at <a href="http://github.jcabi.com">github.jcabi.com</a>):
  *
- * <pre>&lt;depedency&gt;
+ * <pre>&lt;dependency&gt;
  *   &lt;groupId&gt;com.jcabi&lt;/groupId&gt;
  *   &lt;artifactId&gt;jcabi-github&lt;/artifactId&gt;
  * &lt;/dependency&gt;</pre>
diff --git a/src/test/java/com/jcabi/github/FromPropertiesTest.java b/src/test/java/com/jcabi/github/FromPropertiesTest.java
@@ -13,7 +13,7 @@
  * Unit tests for {@link FromProperties}.
  * @since 0.37
  */
-final class FromPopertiesTest {
+final class FromPropertiesTest {
 
     @Test
     void formatsUserAgent() {
diff --git a/src/test/java/com/jcabi/github/LimitTest.java b/src/test/java/com/jcabi/github/LimitTest.java
@@ -38,7 +38,7 @@ void throwsWhenResourceIsAbsent() throws IOException {
     /**
      * Limit reset() method properly converts time.
      * GitHub reset property is in seconds, but java.util.Date
-     * constructor assumes miliseconds.
+     * constructor assumes milliseconds.
      */
     @Test
     void timeIsCreatedForReset() throws IOException {
diff --git a/src/test/java/com/jcabi/github/ReleaseTest.java b/src/test/java/com/jcabi/github/ReleaseTest.java
@@ -163,7 +163,7 @@ void fetchName() throws IOException {
      * (NULL json value).
      */
     @Test
-    void incidatesNoName() throws IOException {
+    void indicatesNoName() throws IOException {
         final Release release = Mockito.mock(Release.class);
         Mockito.doReturn(
             Json.createObjectBuilder()
diff --git a/src/test/java/com/jcabi/github/RepositoryStatisticsTest.java b/src/test/java/com/jcabi/github/RepositoryStatisticsTest.java
@@ -116,7 +116,7 @@ final class RepositoryStatisticsTest {
     private static String updatedValue = "2012-01-26T19:14:43Z";
 
     /**
-     * Checks that RepositryStatistics can convert all values to a map.
+     * Checks that RepositoryStatistics can convert all values to a map.
      * @throws IOException If some problem with I/O happened.
      */
     @Test
@@ -173,7 +173,7 @@ void retrievesBasicStatisticsFromRepo()
     }
 
     /**
-     * Checks that RepositryStatistics.Smart can retrieve all values.
+     * Checks that RepositoryStatistics.Smart can retrieve all values.
      * @throws IOException If some problem with I/O happened.
      */
     @Test
diff --git a/src/test/java/com/jcabi/github/RtGistsTest.java b/src/test/java/com/jcabi/github/RtGistsTest.java
@@ -79,7 +79,7 @@ void canRetrieveSpecificGist() throws IOException {
     }
 
     @Test
-    void canIterateThrouRtGists() throws IOException {
+    void canIterateThroughRtGists() throws IOException {
         try (
             MkContainer container = new MkGrizzlyContainer().next(
                 new MkAnswer.Simple(
diff --git a/src/test/java/com/jcabi/github/RtUserTest.java b/src/test/java/com/jcabi/github/RtUserTest.java
@@ -177,7 +177,7 @@ void hasHtmlUrl() throws IOException {
     }
 
     @Test
-    void hasFollwersUrl() throws IOException {
+    void hasFollowersUrl() throws IOException {
         final String value = "http://github.example.com/followers";
         final User.Smart smart = RtUserTest.userWith("followers_url", value);
         MatcherAssert.assertThat(
@@ -423,7 +423,7 @@ void markAsReadErrorIfResponseStatusIsNot205() throws IOException {
 
     /**
      * Return User.Smart with given property.
-     * @param property The propery as specified at https://developer.github.com/v3/users/#get-a-single-user
+     * @param property The property as specified at https://developer.github.com/v3/users/#get-a-single-user
      * @param value The property value
      * @return User.Smart with given property.
      */
diff --git a/src/test/java/com/jcabi/github/mock/MkContentsTest.java b/src/test/java/com/jcabi/github/mock/MkContentsTest.java
@@ -318,7 +318,7 @@ void canIterate() throws IOException {
     }
 
     /**
-     * Adds colection of test content items.
+     * Adds collection of test content items.
      * @param repo The repo.
      * @param paths Test items to be created inside the repo.
      * @return Iterable with created items.

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,10 @@ public Bulk(final Iterable<T> items) {`
`77`	`77`	`} else {`
`78`	`78`	`try {`
`79`	`79`	`result = method.invoke(item, args);`
`80`		`- } catch (final IllegalAccessException \| InvocationTargetException ex) {`
	`80`	`+ } catch (`
	`81`	`+ final IllegalAccessException`
	`82`	`+ \| InvocationTargetException ex`
	`83`	`+ ) {`
`81`	`84`	`throw new IllegalStateException(ex);`
`82`	`85`	`}`
`83`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,12 @@ public <T extends Response> T as(final Class<T> type) {`
`211`	`211`	`try {`
`212`	`212`	`return type.getDeclaredConstructor(Response.class)`
`213`	`213`	`.newInstance(this);`
`214`		`- } catch (final InstantiationException \| IllegalAccessException \| InvocationTargetException \| NoSuchMethodException ex) {`
	`214`	`+ } catch (`
	`215`	`+ final InstantiationException`
	`216`	`+ \| IllegalAccessException`
	`217`	`+ \| InvocationTargetException`
	`218`	`+ \| NoSuchMethodException ex`
	`219`	`+ ) {`
`215`	`220`	`throw new IllegalStateException(ex);`
`216`	`221`	`}`
`217`	`222`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,11 @@ public void remove() {`
`82`	`82`	`private static <X> X wrap(final Object object) {`
`83`	`83`	`try {`
`84`	`84`	`return (X) Smarts.type(object).newInstance(object);`
`85`		`- } catch (final InvocationTargetException \| InstantiationException \| IllegalAccessException ex) {`
	`85`	`+ } catch (`
	`86`	`+ final InvocationTargetException`
	`87`	`+ \| InstantiationException`
	`88`	`+ \| IllegalAccessException ex`
	`89`	`+ ) {`
`86`	`90`	`throw new IllegalStateException(ex);`
`87`	`91`	`}`
`88`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ private static File temp() throws IOException {`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`/**`
`163`		`- * Syncronized.`
	`163`	`+ * Synchronized.`
`164`	`164`	`* @since 0.5`
`165`	`165`	`*/`
`166`	`166`	`@Immutable`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,12 @@`
`4`	`4`	`*/`
`5`	`5`
`6`	`6`	`/**`
`7`		`- * Object Oriented GitHub API.`
	`7`	`+ * Object-Oriented GitHub API.`
`8`	`8`	`*`
`9`	`9`	`* <p>The only dependency you need is (check our latest version available`
`10`	`10`	`* at <a href="http://github.jcabi.com">github.jcabi.com</a>):`
`11`	`11`	`*`
`12`		`- * <pre><depedency>`
	`12`	`+ * <pre><dependency>`
`13`	`13`	`* <groupId>com.jcabi</groupId>`
`14`	`14`	`* <artifactId>jcabi-github</artifactId>`
`15`	`15`	`* </dependency></pre>`