Rename byIndex() to filteringByIndex() (#71)

README.md

@@ -47,7 +47,7 @@ Provided `Gatherers`:
   - takes elements until a change is detected based on a key extractor function
 - `MoreGatherers.windowSliding(int, int)`
   - creates a sliding window of a fixed size with a fixed step, extends `Gatherers.windowSliding(int)` by adding a step parameter
-- `MoreGatherers.byIndex(BiPredicate<Long, T>)`
+- `MoreGatherers.filteringByIndex(BiPredicate<Long, T>)`
   - filters elements based on their index and value
 
 ### Philosophy

src/main/java/com/pivovarit/gatherers/MoreGatherers.java

@@ -260,7 +260,7 @@ private MoreGatherers() {
      *
      * @return a {@link Gatherer} that applies the given filter based on element index and value
      */
-    public static <T> Gatherer<T, ?, T> byIndex(BiPredicate<Long, ? super T> predicate) {
+    public static <T> Gatherer<T, ?, T> filteringByIndex(BiPredicate<Long, ? super T> predicate) {
         return new FilterByIndexGatherer<>(predicate);
     }
 }

src/test/java/com/pivovarit/gatherers/FilterByIndexBenchmark.java

@@ -14,7 +14,7 @@ public class FilterByIndexBenchmark {
     @Benchmark
     public List<Integer> filterByIndex() {
         return source.stream()
-          .gather(MoreGatherers.byIndex((i, _) -> i % 2 == 0))
+          .gather(MoreGatherers.filteringByIndex((i, _) -> i % 2 == 0))
           .toList();
     }
 

src/test/java/com/pivovarit/gatherers/blackbox/ByIndexTest.java

@@ -4,26 +4,26 @@
 
 import java.util.stream.Stream;
 
-import static com.pivovarit.gatherers.MoreGatherers.byIndex;
+import static com.pivovarit.gatherers.MoreGatherers.filteringByIndex;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 class ByIndexTest {
 
     @Test
     void shouldRejectNullPredicate() {
-        assertThatThrownBy(() -> byIndex(null)).isInstanceOf(NullPointerException.class);
+        assertThatThrownBy(() -> filteringByIndex(null)).isInstanceOf(NullPointerException.class);
     }
 
     @Test
     void shouldFilterByIndexEmptyStream() {
-        assertThat(Stream.empty().gather(byIndex((_, _) -> true))).isEmpty();
+        assertThat(Stream.empty().gather(filteringByIndex((_, _) -> true))).isEmpty();
     }
 
     @Test
     void shouldFilterByIndex() {
         assertThat(Stream.of("a", "bb", "cc", "ddd")
-          .gather(byIndex((i, _) -> i % 2 == 0)))
+          .gather(filteringByIndex((i, _) -> i % 2 == 0)))
           .containsExactly("a", "cc");
     }
 }