Merge pull request #328 from csf-dev/craigfowler/issue326

Resolve #326 - LSP violation

Author: craigfowler

CSF.Screenplay.Selenium/Builders/FindElementBuilder.cs

@@ -19,6 +19,7 @@ namespace CSF.Screenplay.Selenium.Builders
     public class FindElementBuilder : IGetsPerformableWithResult<SeleniumElement>
     {
         readonly ITarget target;
+        readonly IHasSearchContext searchContext;
         Locator locator;
         string name;
 
@@ -46,7 +47,9 @@ public FindElementBuilder AndNameIt(string name)
 
         IPerformableWithResult<SeleniumElement> IGetsPerformableWithResult<SeleniumElement>.GetPerformable()
         {
-            return SingleElementPerformableWithResultAdapter.From(new FindElement(name, locator), target);
+            return target != null
+                ? new FindElement(target, name, locator)
+                : new FindElement(searchContext, name, locator);
         }
 
         /// <summary>
@@ -59,13 +62,12 @@ public FindElementBuilder(ITarget target)
         }
 
         /// <summary>
-        /// Converts a <see cref="FindElementsBuilder"/> to a <see cref="SingleElementPerformableWithResultAdapter{SeleniumElement}"/>.
+        /// Initializes a new instance of the <see cref="FindElementsBuilder"/> class with the specified target.
         /// </summary>
-        /// <param name="builder">The <see cref="FindElementBuilder"/> instance to convert.</param>
-        /// <returns>A <see cref="SingleElementPerformableWithResultAdapter{SeleniumElement}"/> instance.</returns>
-        public static implicit operator SingleElementPerformableWithResultAdapter<SeleniumElement>(FindElementBuilder builder)
+        /// <param name="searchContext">The target within which elements will be found.</param>
+        public FindElementBuilder(IHasSearchContext searchContext)
         {
-            return SingleElementPerformableWithResultAdapter.From(new FindElement(builder.name, builder.locator), builder.target);
+            this.searchContext = searchContext ?? throw new System.ArgumentNullException(nameof(searchContext));
         }
     }
 }

CSF.Screenplay.Selenium/Builders/FindElementsBuilder.cs

@@ -19,6 +19,7 @@ namespace CSF.Screenplay.Selenium.Builders
     public class FindElementsBuilder : IGetsPerformableWithResult<SeleniumElementCollection>
     {
         readonly ITarget target;
+        readonly IHasSearchContext searchContext;
         Locator locator;
         string name;
 
@@ -46,7 +47,9 @@ public FindElementsBuilder AndNameThem(string name)
 
         IPerformableWithResult<SeleniumElementCollection> IGetsPerformableWithResult<SeleniumElementCollection>.GetPerformable()
         {
-            return SingleElementPerformableWithResultAdapter.From(new FindElements(name, locator), target);
+            return target != null
+                ? new FindElements(target, name, locator)
+                : new FindElements(searchContext, name, locator);
         }
 
         /// <summary>
@@ -59,13 +62,12 @@ public FindElementsBuilder(ITarget target)
         }
 
         /// <summary>
-        /// Converts a <see cref="FindElementsBuilder"/> to a <see cref="SingleElementPerformableWithResultAdapter{SeleniumElementCollection}"/>.
+        /// Initializes a new instance of the <see cref="FindElementsBuilder"/> class with the specified target.
         /// </summary>
-        /// <param name="builder">The <see cref="FindElementsBuilder"/> instance to convert.</param>
-        /// <returns>A <see cref="SingleElementPerformableWithResultAdapter{SeleniumElementCollection}"/> instance.</returns>
-        public static implicit operator SingleElementPerformableWithResultAdapter<SeleniumElementCollection>(FindElementsBuilder builder)
+        /// <param name="searchContext">The target within which elements will be found.</param>
+        public FindElementsBuilder(IHasSearchContext searchContext)
         {
-            return SingleElementPerformableWithResultAdapter.From(new FindElements(builder.name, builder.locator), builder.target);
+            this.searchContext = searchContext ?? throw new System.ArgumentNullException(nameof(searchContext));
         }
     }
 }

CSF.Screenplay.Selenium/Elements/SeleniumElement.cs

@@ -12,18 +12,18 @@ namespace CSF.Screenplay.Selenium.Elements
     /// a <see cref="Name"/>.  This optional, but recommended, technique facilitates human-readable reporting.
     /// </para>
     /// </remarks>
-    public class SeleniumElement : ITarget
+    public class SeleniumElement : ITarget, IHasWebElement, IHasSearchContext
     {
         const string unknownNameFormat = "an HTML {0} element";
 
         /// <inheritdoc/>
         public string Name { get; }
 
-        /// <summary>
-        /// Gets the native Selenium web element.
-        /// </summary>
+        /// <inheritdoc/>
         public IWebElement WebElement { get; }
 
+        ISearchContext IHasSearchContext.SearchContext => WebElement;
+
         SeleniumElementCollection ITarget.GetElements(IWebDriver driver) => new SeleniumElementCollection(new[] { this }, Name);
 
         SeleniumElement ITarget.GetElement(IWebDriver driver) => this;
@@ -42,4 +42,26 @@ public SeleniumElement(IWebElement webElement, string name = null)
             Name = name ?? string.Format(unknownNameFormat, webElement.TagName);
         }
     }
+
+    /// <summary>
+    /// An object which exposes a Selenium web element.
+    /// </summary>
+    public interface IHasWebElement : IHasName
+    {
+        /// <summary>
+        /// Gets the native Selenium web element.
+        /// </summary>
+        IWebElement WebElement { get; }
+    }
+
+    /// <summary>
+    /// An object which exposes a Selenium search context.
+    /// </summary>
+    public interface IHasSearchContext : IHasName
+    {
+        /// <summary>
+        /// Gets the native Selenium search context.
+        /// </summary>
+        ISearchContext SearchContext { get; }
+    }
 }

CSF.Screenplay.Selenium/Elements/ShadowRoot.cs

@@ -0,0 +1,34 @@
+using System;
+using OpenQA.Selenium;
+
+namespace CSF.Screenplay.Selenium.Elements
+{
+    /// <summary>
+    /// Implementation of <see cref="IHasSearchContext"/> which represents an HTML shadow-root node.
+    /// </summary>
+    /// <seealso cref="Questions.GetShadowRootNatively"/>
+    /// <seealso cref="Questions.GetShadowRootWithJavaScript"/>
+    /// <seealso cref="Tasks.GetShadowRoot"/>
+    public class ShadowRoot : IHasSearchContext
+    {
+        readonly ISearchContext shadowRoot;
+
+        /// <inheritdoc/>
+        public ISearchContext SearchContext => shadowRoot;
+
+        /// <inheritdoc/>
+        public string Name { get; }
+
+        /// <summary>
+        /// Initializes a new instance of <see cref="ShadowRoot"/>.
+        /// </summary>
+        /// <param name="shadowRoot">The wrapped shadow root element</param>
+        /// <param name="name">The name of this Shadow Root object</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="shadowRoot"/> is <see langword="null"/></exception>
+        public ShadowRoot(ISearchContext shadowRoot, string name = null)
+        {
+            this.shadowRoot = shadowRoot ?? throw new ArgumentNullException(nameof(shadowRoot));
+            Name = name ?? "Shadow root";
+        }
+    }
+}