You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2020/11/07 20:05:38 UTC

[jspwiki] 17/23: Rename ReadWikiPage to ViewWikiPage

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git

commit ba10bd91b4691a500e899007faf700cf776ae355
Author: juanpablo <ju...@apache.org>
AuthorDate: Sat Nov 7 18:45:03 2020 +0100

    Rename ReadWikiPage to ViewWikiPage
---
 .../java/org/apache/wiki/its/AnonymousViewIT.java  |  8 +++----
 .../src/main/java/org/apache/wiki/its/EditIT.java  |  6 ++---
 .../src/main/java/org/apache/wiki/its/LoginIT.java |  6 ++---
 .../main/java/org/apache/wiki/its/SearchIT.java    |  4 ++--
 .../apache/wiki/pages/haddock/EditWikiPage.java    | 16 ++++++-------
 .../org/apache/wiki/pages/haddock/LoginPage.java   | 10 ++++----
 .../wiki/pages/haddock/SearchResultsPage.java      |  8 +++----
 .../{ReadWikiPage.java => ViewWikiPage.java}       | 28 +++++++++++-----------
 8 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/AnonymousViewIT.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/AnonymousViewIT.java
index 4e48897..44061b6 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/AnonymousViewIT.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/AnonymousViewIT.java
@@ -20,7 +20,7 @@ package org.apache.wiki.its;
 
 import com.codeborne.selenide.junit5.ScreenShooterExtension;
 import org.apache.wiki.pages.Page;
-import org.apache.wiki.pages.haddock.ReadWikiPage;
+import org.apache.wiki.pages.haddock.ViewWikiPage;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -39,12 +39,12 @@ public class AnonymousViewIT {
     
     @Test
     void anonymousView() {
-        final ReadWikiPage main = ReadWikiPage.open( "Main" );
+        final ViewWikiPage main = ViewWikiPage.open( "Main" );
         Assertions.assertEquals( "JSPWiki: Main", main.title() );
         Assertions.assertEquals( "Main", main.wikiTitle() );
         
         Assertions.assertTrue( main.wikiPageContent().contains( "You have successfully installed" ) );
-        final ReadWikiPage about = main.navigateTo( "JSPWiki" );
+        final ViewWikiPage about = main.navigateTo( "JSPWiki" );
         Assertions.assertTrue( about.wikiPageContent().contains( "This Wiki is done using" ) );
     }
     
@@ -56,7 +56,7 @@ public class AnonymousViewIT {
     
     @Test
     void anonymousReaderView() {
-        final ReadWikiPage main = ReadWikiPage.open( "Main" );
+        final ViewWikiPage main = ViewWikiPage.open( "Main" );
         Assertions.assertEquals( "JSPWiki: Main", main.title() );
         Assertions.assertEquals( "Main", main.wikiTitle() );
         main.sidebar().should( exist );
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/EditIT.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/EditIT.java
index 7f5c302..a8d5f6c 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/EditIT.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/EditIT.java
@@ -20,7 +20,7 @@ package org.apache.wiki.its;
 
 import com.codeborne.selenide.junit5.ScreenShooterExtension;
 import org.apache.wiki.pages.haddock.EditWikiPage;
-import org.apache.wiki.pages.haddock.ReadWikiPage;
+import org.apache.wiki.pages.haddock.ViewWikiPage;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -35,12 +35,12 @@ public class EditIT {
     void createPageAndTestEditPermissions() {
         final String pageName = "RandomPage" + System.currentTimeMillis();
 
-        final ReadWikiPage randomPage = EditWikiPage.open( pageName )
+        final ViewWikiPage randomPage = EditWikiPage.open( pageName )
                                                     .saveText( "random page [{ALLOW edit janne}] [{ALLOW view All}]", "random page" );
         Assertions.assertEquals( pageName, randomPage.wikiTitle() );
         Assertions.assertEquals( "random page", randomPage.wikiPageContent() );
 
-        final ReadWikiPage requiresJannesAccess = randomPage.hoverLoginArea().clickOnLogin().performLogin();
+        final ViewWikiPage requiresJannesAccess = randomPage.hoverLoginArea().clickOnLogin().performLogin();
         requiresJannesAccess.editPage().saveText( "random page [{ALLOW edit janne}]", "random page" );
         Assertions.assertEquals( pageName, requiresJannesAccess.wikiTitle() );
         Assertions.assertEquals( "random page", requiresJannesAccess.wikiPageContent() );
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/LoginIT.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/LoginIT.java
index b3606df..72b5685 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/LoginIT.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/LoginIT.java
@@ -20,7 +20,7 @@ package org.apache.wiki.its;
 
 import com.codeborne.selenide.junit5.ScreenShooterExtension;
 import org.apache.wiki.pages.haddock.LoginPage;
-import org.apache.wiki.pages.haddock.ReadWikiPage;
+import org.apache.wiki.pages.haddock.ViewWikiPage;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -34,7 +34,7 @@ public class LoginIT {
     
     @Test
     void loginAndLogout() {
-        ReadWikiPage main = ReadWikiPage.open( "Main" );
+        ViewWikiPage main = ViewWikiPage.open( "Main" );
         Assertions.assertEquals( "JSPWiki: Main", main.title() );
         Assertions.assertEquals( "Main", main.wikiTitle() );
         Assertions.assertEquals( "G’day (anonymous guest)", main.hoverLoginArea().authenticatedText() );
@@ -53,7 +53,7 @@ public class LoginIT {
     
     @Test
     void loginKO() {
-        ReadWikiPage main = ReadWikiPage.open( "Main" );
+        ViewWikiPage main = ViewWikiPage.open( "Main" );
         Assertions.assertEquals( "JSPWiki: Main", main.title() );
         Assertions.assertEquals( "Main", main.wikiTitle() );
         Assertions.assertEquals( "G’day (anonymous guest)", main.hoverLoginArea().authenticatedText() );
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/SearchIT.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/SearchIT.java
index 9d0b9c3..3d4d3d6 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/SearchIT.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/its/SearchIT.java
@@ -20,7 +20,7 @@ package org.apache.wiki.its;
 
 import com.codeborne.selenide.junit5.ScreenShooterExtension;
 import org.apache.wiki.its.environment.Env;
-import org.apache.wiki.pages.haddock.ReadWikiPage;
+import org.apache.wiki.pages.haddock.ViewWikiPage;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -37,7 +37,7 @@ public class SearchIT {
 
         // first, search for a term indexed on startup (wait a bit to allow the initial search indexing to complete first)
         Thread.sleep( Env.TESTS_CONFIG_SEARCH_INDEX_WAIT );
-        final ReadWikiPage main = ReadWikiPage.open( "Main" )
+        final ViewWikiPage main = ViewWikiPage.open( "Main" )
                                               .searchFor( "Congratulations" ).shouldContain( "Main" )
                                               .navigateTo( "Main" );
 
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/EditWikiPage.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/EditWikiPage.java
index 89d6c29..e17a16d 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/EditWikiPage.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/EditWikiPage.java
@@ -43,20 +43,20 @@ public class EditWikiPage implements HaddockPage {
     /**
      * Press the cancel button and disacrd page Edit.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage cancel() {
+    public ViewWikiPage cancel() {
         Selenide.$( By.name( "cancel" ) ).click();
-        return new ReadWikiPage();
+        return new ViewWikiPage();
     }
 
     /**
      * Edits the page with the given text. Ensures edition is complete by ensuring the preview pane shows the edited text.
      *
      * @param text text to edit.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage saveText(final String text ) {
+    public ViewWikiPage saveText(final String text ) {
         return saveText( text, text );
     }
 
@@ -65,14 +65,14 @@ public class EditWikiPage implements HaddockPage {
      *
      * @param text text text to edit.
      * @param preview expected text to hsow up on the preview pane (i.e., page directives on edit pane shouldn't show up here).
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage saveText(final String text, final String preview ) {
+    public ViewWikiPage saveText(final String text, final String preview ) {
         Selenide.$( By.cssSelector( EDIT_TEXTAREA ) ).clear();
         Selenide.$( By.cssSelector( EDIT_TEXTAREA ) ).val( text );
         Selenide.$( By.className( "ajaxpreview" ) ).waitUntil( Condition.text( preview ), 1_000L );
         Selenide.$( By.name( "ok" ) ).click();
-        return new ReadWikiPage();
+        return new ViewWikiPage();
     }
 
 }
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
index f7d95da..b66a055 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/LoginPage.java
@@ -30,9 +30,9 @@ public class LoginPage implements HaddockPage {
     /**
      * Logs in using Janne username and password.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage performLogin() {
+    public ViewWikiPage performLogin() {
         return performLogin( Env.LOGIN_JANNE_USERNAME, Env.LOGIN_JANNE_PASSWORD );
     }
 
@@ -41,14 +41,14 @@ public class LoginPage implements HaddockPage {
      *
      * @param login user login.
      * @param password user password.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage performLogin( final String login, final String password ) {
+    public ViewWikiPage performLogin(final String login, final String password ) {
         Selenide.$( By.id( "j_username" ) ).val( login );
         Selenide.$( By.id( "j_password" ) ).val( password );
         Selenide.$( By.name( "submitlogin" ) ).click();
         
-        return new ReadWikiPage();
+        return new ViewWikiPage();
     }
 
 }
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/SearchResultsPage.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/SearchResultsPage.java
index 6b353b2..8458c67 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/SearchResultsPage.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/SearchResultsPage.java
@@ -37,7 +37,7 @@ public class SearchResultsPage implements HaddockPage {
      * Open the search results page with a given query text to search for.
      *
      * @param pageName Wiki page name to View.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
     public static SearchResultsPage open( final String pageName ) {
         return Page.withUrl( Page.baseUrl() + "/Search.jsp?query=" + pageName ).openAs( new SearchResultsPage() );
@@ -71,11 +71,11 @@ public class SearchResultsPage implements HaddockPage {
      * Navigates to a view page from the search results.
      *
      * @param result wikipage name to navigate to.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage navigateTo( final String result ) {
+    public ViewWikiPage navigateTo(final String result ) {
         Selenide.$( By.cssSelector( ".wikitable.table-striped" ) ).find( By.linkText( result ) ).click();
-        return new ReadWikiPage();
+        return new ViewWikiPage();
     }
 
 }
diff --git a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ReadWikiPage.java b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ViewWikiPage.java
similarity index 82%
rename from jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ReadWikiPage.java
rename to jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ViewWikiPage.java
index ae43e2d..1de53ef 100644
--- a/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ReadWikiPage.java
+++ b/jspwiki-it-tests/jspwiki-selenide-tests/src/main/java/org/apache/wiki/pages/haddock/ViewWikiPage.java
@@ -28,16 +28,16 @@ import com.codeborne.selenide.SelenideElement;
 /**
  * Actions available on the View page.
  */
-public class ReadWikiPage implements HaddockPage {
+public class ViewWikiPage implements HaddockPage {
 
     /**
      * Open a given page for view.
      *
      * @param pageName Wiki page name to View.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public static ReadWikiPage open( final String pageName ) {
-        return Page.withUrl( Page.baseUrl() + "/Wiki.jsp?page=" + pageName ).openAs( new ReadWikiPage() );
+    public static ViewWikiPage open(final String pageName ) {
+        return Page.withUrl( Page.baseUrl() + "/Wiki.jsp?page=" + pageName ).openAs( new ViewWikiPage() );
     }
 
     /**
@@ -62,9 +62,9 @@ public class ReadWikiPage implements HaddockPage {
     /**
      * Clicks on the show reader view link.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage clickOnShowReaderView() {
+    public ViewWikiPage clickOnShowReaderView() {
         Selenide.$( By.linkText( "Show Reader View" ) ).click();
         return this;
     }
@@ -72,9 +72,9 @@ public class ReadWikiPage implements HaddockPage {
     /**
      * Hover's the user's icon, so the login area gets visible.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage hoverLoginArea() {
+    public ViewWikiPage hoverLoginArea() {
         Selenide.$( By.className( "icon-user" ) ).hover();
         return this;
     }
@@ -82,9 +82,9 @@ public class ReadWikiPage implements HaddockPage {
     /**
      * Hover's the More tab, making its associated pane visible.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage hoverMoreArea() {
+    public ViewWikiPage hoverMoreArea() {
         Selenide.$( By.id( "more" ) ).hover();
         return this;
     }
@@ -116,9 +116,9 @@ public class ReadWikiPage implements HaddockPage {
     /**
      * Logs the user out.
      *
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage logout() {
+    public ViewWikiPage logout() {
         Selenide.$( By.linkText( "Log out" ) ).click();
         Selenide.$( By.className( "btn-success" ) ).waitUntil( Condition.visible, 1_000L ).click();
         return this;
@@ -128,9 +128,9 @@ public class ReadWikiPage implements HaddockPage {
      * Navigates to a given view page.
      *
      * @param wikiPageName wikipage name to navigate to.
-     * @return {@link ReadWikiPage} instance, to allow chaining of actions.
+     * @return {@link ViewWikiPage} instance, to allow chaining of actions.
      */
-    public ReadWikiPage navigateTo( final String wikiPageName ) {
+    public ViewWikiPage navigateTo(final String wikiPageName ) {
         Selenide.$( By.linkText( wikiPageName ) ).click(); 
         return this;
     }