page_magic 2.0.6 → 2.0.12

data/spec/page_magic/element/locators_spec.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element::Locators do
-  subject { element_clazz.new }
-
-  let(:element_clazz) do
-    Class.new do
-      extend(PageMagic::Elements)
-      include(PageMagic::Element::Locators)
-    end
-  end
-
-  describe '#element_by_name' do
-    it 'returns the required element' do
-      selector = { id: 'child' }
-      element_clazz.element :child1, selector
-      element_clazz.element :child2, id: 'child 2'
-
-      child_1_builder = PageMagic::ElementDefinitionBuilder.new(
-        definition_class: PageMagic::Element,
-        selector: PageMagic::Element::Selector.find(:id).build(:element, 'child')
-      )
-
-      expect(subject.element_by_name(:child1)).to eq(child_1_builder)
-    end
-
-    context 'element not found' do
-      it 'raises an error' do
-        expected_message = (described_class::ELEMENT_NOT_DEFINED_MSG % :child)
-        expect do
-          subject.element_by_name(:child)
-        end.to raise_exception PageMagic::ElementMissingException, expected_message
-      end
-    end
-  end
-end

data/spec/page_magic/element/not_found_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-describe PageMagic::Element::NotFound do
-  describe '#method_missing' do
-    it 'raises an error' do
-      subject = described_class.new(Exception.new('message'))
-      expect { subject.any_missing_method }.to raise_exception(PageMagic::ElementMissingException, 'message')
-    end
-  end
-
-  describe '#visible?' do
-    it 'returns false' do
-      subject = described_class.new(Exception.new('message'))
-      expect(subject.visible?).to eq(false)
-    end
-  end
-
-  describe '#present?' do
-    it 'returns false' do
-      subject = described_class.new(Exception.new('message'))
-      expect(subject.present?).to eq(false)
-    end
-  end
-end

data/spec/page_magic/element/query/multiple_results_spec.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element::Query::MultipleResults do
-  describe '#find' do
-    context 'when multiple results found' do
-      it 'returns an array' do
-        element = PageMagic::Element.load('<a></a><a></a>')
-        subject = described_class.new('a')
-        result = subject.execute(element)
-        expect(result.size).to eq(2)
-      end
-    end
-  end
-end

data/spec/page_magic/element/query/single_result_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element::Query::SingleResult do
-  describe '#find' do
-    context 'when more than one result is returned' do
-      it 'raises an error' do
-        element = PageMagic::Element.load('<a></a><a></a>')
-        query = described_class.new('a')
-        expected_message = 'Ambiguous match, found 2 elements matching visible css "a"'
-        expect { query.execute(element) }.to raise_error PageMagic::AmbiguousQueryException, expected_message
-      end
-    end
-
-    it 'returns the result of the capybara query' do
-      element = PageMagic::Element.load('<a>link</a>')
-      query = described_class.new('a')
-      result = query.execute(element)
-      expect(result.text).to eq('link')
-    end
-  end
-end

data/spec/page_magic/element/query_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element::Query do
-  describe '#execute' do
-    it 'calls find' do
-      subject = described_class.new
-      allow(subject).to receive(:find)
-
-      subject.execute(:capybara_element)
-      expect(subject).to have_received(:find).with(:capybara_element)
-    end
-
-    context 'when a formatter supplied' do
-      it 'uses it' do
-        subject = described_class.new
-        allow(subject).to receive(:find) { |_r, &formatter| formatter.call(:result) }
-
-        result = subject.execute(:capybara_element) { |capybara_result| "formatter_called_on_#{capybara_result}" }
-        expect(result).to eq('formatter_called_on_result')
-      end
-    end
-
-    context 'when no results are found' do
-      subject(:query_class) do
-        Class.new(described_class) do
-          def find(element)
-            element.find('missing')
-          end
-        end
-      end
-
-      it 'Returns `NotFound`' do
-        element = PageMagic::Element.load('<html></html>')
-        expect(query_class.new.execute(element)).to be_a(PageMagic::Element::NotFound)
-      end
-    end
-  end
-end

data/spec/page_magic/element/selector_spec.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element::Selector do
-  describe '.find' do
-    it 'returns the constant with the given name' do
-      expect(described_class.find(:css)).to be(described_class::CSS)
-    end
-
-    context 'when selector not found' do
-      it 'raises an exception' do
-        expect { described_class.find(:invalid) }.to raise_exception(PageMagic::UnsupportedCriteriaException)
-      end
-    end
-  end
-
-  describe '#build' do
-    it 'puts the locator and element type in to the result' do
-      expect(described_class.new.build(:field, :locator)).to have_attributes(
-        args: [:locator]
-      )
-    end
-
-    context 'when exact matching is required' do
-      it 'is added to options' do
-        expect(described_class.new(exact: true).build(:field, :locator)).to have_attributes(
-          options: { exact: true }
-        )
-      end
-    end
-
-    context 'when supports_type true' do
-      it 'includes the element type' do
-        expect(described_class.new(supports_type: true).build(:field, :locator)).to have_attributes(
-          args: %i[field locator]
-        )
-      end
-    end
-
-    # TODO: - new class?
-    context 'when selector formatter is provided' do
-      subject(:selector) do
-        described_class.new do |param|
-          "formatted_#{param}".to_sym
-        end
-      end
-
-      it 'uses the formatter' do
-        expect(selector.build(:field, :locator)).to have_attributes(
-          args: [:formatted_locator]
-        )
-      end
-    end
-
-    context 'when type supplied' do
-      it 'is added to the result' do
-        expect(described_class.new(:css).build(:field, :locator)).to have_attributes(
-          args: %i[css locator]
-        )
-      end
-    end
-  end
-
-  describe '#initialize' do
-    context 'when exact' do
-      it 'sets the option' do
-        subject = described_class.new(exact: true).build(:element_type, {})
-        expect(subject.options).to eq({ exact: true })
-      end
-    end
-  end
-
-  describe 'predefined selectors' do
-    shared_examples 'a selector' do |named: false, **options|
-      def selector_name
-        self.class.metadata[:parent_example_group][:description].to_sym
-      end
-
-      subject do
-        described_class.find(selector_name).build(:element_type, :locator)
-      end
-
-      it 'contains the selector args' do
-        name_arg = named && (named == true ? selector_name : named)
-
-        expected_args = [name_arg, :locator].compact
-        expect(subject.args).to eq(expected_args)
-      end
-
-      it 'contains the options' do
-        expect(subject.options).to eq(options)
-      end
-    end
-
-    let(:capybara_element) do
-      html_source = <<~HTML_SOURCE
-        <a href='#'>a link</a>
-
-
-          <div id='form' class="form">
-            <a id='form_link' href='/page2'>link in a form</a>
-            <label>enter text
-              <input id='field_id' name='field_name' class='input_class' type='text' value='filled in'/>
-            </label>
-            <button id='form_button' type='submit' value='a button'/>
-          </form>
-      HTML_SOURCE
-      PageMagic::Element.load(html_source)
-    end
-
-    describe 'label' do
-      it_behaves_like 'a selector', named: :field, exact: true
-
-      it 'finds elements by label' do
-        selector = described_class.find(:label).build(:text_field, 'enter text')
-        query = PageMagic::Element::Query::SingleResult.new(*selector.args)
-        expect(query.execute(capybara_element)[:name]).to eq('field_name')
-      end
-    end
-
-    describe 'name' do
-      it 'formats locators' do
-        name = 'my_button'
-        expect(described_class::NAME.build(:element_type, name)).to have_attributes(
-          args: ["*[name='#{name}']"],
-          options: {}
-        )
-      end
-
-      it 'finds elements by name' do
-        selector = described_class.find(:name).build(:text_field, 'field_name')
-        query = PageMagic::Element::Query::SingleResult.new(*selector.args)
-        expect(query.execute(capybara_element)[:name]).to eq('field_name')
-      end
-    end
-
-    describe 'xpath' do
-      it_behaves_like 'a selector', named: true
-
-      it 'finds elements by xpath' do
-        selector = described_class.find(:xpath).build(:element, '//div/label/input')
-        query = PageMagic::Element::Query::SingleResult.new(*selector.args)
-        expect(query.execute(capybara_element)[:name]).to eq('field_name')
-      end
-    end
-
-    describe 'id' do
-      it_behaves_like 'a selector', named: true
-
-      it 'finds elements by id' do
-        selector = described_class.find(:id).build(:text_field, 'field_id')
-        query = PageMagic::Element::Query::SingleResult.new(*selector.args)
-        expect(query.execute(capybara_element)[:name]).to eq('field_name')
-      end
-    end
-
-    describe 'text' do
-      it_behaves_like 'a selector', named: :element_type
-
-      it 'finds elements by text' do
-        selector = described_class.find(:text).build(:link, 'a link')
-        query = PageMagic::Element::Query::SingleResult.new(*selector.args)
-        expect(query.execute(capybara_element).text).to eq('a link')
-      end
-    end
-  end
-end

data/spec/page_magic/element_context_spec.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::ElementContext do
-  describe '#method_missing' do
-    let(:element_class) do
-      Class.new(PageMagic::Element)
-    end
-
-    context 'when method is a element definition' do
-      it 'returns the sub page element' do
-        element_class.link(:a_link, text: 'a link')
-        element = described_class.new(element_class.load("<a href='#'>a link</a>")).a_link
-        expect(element.text).to eq('a link')
-      end
-
-      it 'passes arguments through to the element definition' do
-        element_class.link(:pass_through, css: 'a') { |args| args[:passed_through] = true }
-
-        args = {}
-        described_class.new(element_class.load("<a href='#'>a link</a>")).pass_through(args)
-        expect(args[:passed_through]).to eq(true)
-      end
-
-      it 'does not evaluate any of the other definitions' do
-        element_class.link(:a_link, text: 'a link')
-        element_class.link(:another_link, :selector) { raise('should not have been evaluated') }
-
-        described_class.new(element_class.load("<a href='#'>a link</a>")).a_link
-      end
-    end
-
-    context 'when the method is found on page_element' do
-      it 'calls page_element method' do
-        element_class.define_method(:page_method) do
-          :called
-        end
-
-        expect(described_class.new(element_class.load("<a href='#'>a link</a>")).page_method).to eq(:called)
-      end
-    end
-
-    context 'when the method is not found on page_element or as a element definition' do
-      it 'raises an error' do
-        expect do
-          described_class.new(PageMagic::Element.load('')).missing_method
-        end.to raise_error(PageMagic::ElementMissingException)
-      end
-    end
-  end
-
-  describe '#respond_to?' do
-    let(:page_element_class) do
-      Class.new(PageMagic::Element) do
-        link(:a_link, text: 'a link')
-      end
-    end
-
-    context 'when the page_element responds to method name' do
-      it 'returns true' do
-        element = described_class.new(page_element_class.load("<a href='#'>a link</a>"))
-        expect(element).to respond_to(:a_link)
-      end
-    end
-
-    context 'when the method is not on the page_element' do
-      it 'calls super' do
-        element = described_class.new(page_element_class.load("<a href='#'>a link</a>")).a_link
-        expect(element.text).to respond_to(:methods)
-      end
-    end
-  end
-end

data/spec/page_magic/element_definition_builder_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::ElementDefinitionBuilder do
-  describe '#build' do
-    it 'returns an instance of `definition_class`' do
-      options = { count: 1 }
-      builder = described_class.new(
-        definition_class: PageMagic::Element,
-        selector: PageMagic::Element::Selector.find(:xpath).build(:text_field, '//xpath', options: options)
-      )
-
-      allow_any_instance_of(PageMagic::Element::Query::SingleResult).to receive(:execute) do |_query, element, &block|
-        block.call(element)
-      end
-
-      expect(builder.build(:capybara_object)).to have_attributes(browser_element: :capybara_object)
-    end
-  end
-end

data/spec/page_magic/element_spec.rb

@@ -1,256 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe PageMagic::Element do
-  let(:described_class) do
-    Class.new(PageMagic::Element) # rubocop:disable RSpec/DescribedClass
-  end
-
-  it_behaves_like 'session accessor'
-  it_behaves_like 'element watcher'
-  it_behaves_like 'waiter'
-  it_behaves_like 'element locator'
-
-  describe '.after_events' do
-    context 'when a hook is registered' do
-      it 'returns that hook' do
-        hook = proc {}
-        described_class.after_events(&hook)
-        expect(described_class.after_events).to eq([described_class::DEFAULT_HOOK, hook])
-      end
-    end
-
-    context 'when a hook is not registered' do
-      it 'returns the default hook' do
-        expect(described_class.after_events).to eq([described_class::DEFAULT_HOOK])
-      end
-    end
-  end
-
-  describe '.before_events' do
-    context 'when a is hook registered' do
-      it 'returns that hook' do
-        hook = proc {}
-        described_class.before_events(&hook)
-        expect(described_class.before_events).to eq([described_class::DEFAULT_HOOK, hook])
-      end
-    end
-
-    context 'when a hook is not registered' do
-      it 'returns the default hook' do
-        expect(described_class.before_events).to eq([described_class::DEFAULT_HOOK])
-      end
-    end
-  end
-
-  describe '.inherited' do
-    it 'copies before hooks on to the inheritor' do
-      before_hook = proc {}
-      described_class.before_events(&before_hook)
-      sub_class = Class.new(described_class)
-      expect(sub_class.before_events).to include(before_hook)
-    end
-
-    it 'copies after hooks on to the inheritor' do
-      after_hook = proc {}
-      described_class.after_events(&after_hook)
-      sub_class = Class.new(described_class)
-      expect(sub_class.after_events).to include(after_hook)
-    end
-
-    context 'when subclasses define their own elements' do
-      it 'puts the element definition on the sub class' do
-        custom_element = Class.new(described_class) do
-          text_field :form_field, id: 'field_id'
-        end
-        expect(custom_element.new(:page_element).element_definitions).to include(:form_field)
-      end
-
-      it 'does not put the definition on the parent class' do
-        Class.new(described_class) do
-          text_field :form_field, id: 'field_id'
-        end
-        expect(described_class.new(:page_element).element_definitions).not_to include(:form_field)
-      end
-    end
-  end
-
-  describe '.load' do
-    let(:page_source) do
-      <<-HTML
-          <div id='links'>
-            <a class='cta'>link text</a>
-          </div>
-      HTML
-    end
-
-    it 'returns an instance that works against the supplied string' do
-      subject = Class.new(described_class) do
-        element(:links, id: 'links') { link(:cta, css: '.cta') }
-      end
-      expect(subject.load(page_source).links.cta.text).to eq('link text')
-    end
-  end
-
-  describe '.watch' do
-    it 'adds a before hook' do
-      watch_block = described_class.watch(:object_id).last
-      expect(described_class.before_events).to include(watch_block)
-    end
-
-    describe 'the before hook that is added' do
-      it 'contains a watcher' do
-        watch_block = described_class.watch(:object_id).last
-        instance = described_class.new(:element)
-        instance.instance_exec(&watch_block)
-
-        watcher = instance.watchers.first
-        expect(watcher.observed_value).to eq(instance.object_id)
-      end
-    end
-  end
-
-  describe 'EVENT_TYPES' do
-    it 'creates methods for each of the event types' do
-      instance = described_class.new(:capybara_element)
-      missing = described_class::EVENT_TYPES.find_all { |event| !instance.respond_to?(event) }
-      expect(missing).to be_empty
-    end
-
-    context 'when one of the methods are called' do
-      it 'calls the browser_element passing on all args' do
-        browser_element = instance_double(Capybara::Node::Actions)
-        allow(browser_element).to receive(:select)
-        described_class.new(browser_element).select :args
-        expect(browser_element).to have_received(:select).with(:args)
-      end
-    end
-
-    context 'when the underlying capybara element does not respond to the method' do
-      it 'raises an error' do
-        expected_message = (described_class::EVENT_NOT_SUPPORTED_MSG % 'click')
-        browser_element = instance_double(Capybara::Node::Element)
-        page_element = described_class.new(browser_element)
-        expect { page_element.click }.to raise_error(PageMagic::NotSupportedException, expected_message)
-      end
-    end
-  end
-
-  describe 'hooks' do
-    context 'when a method called from within a before_events hook' do
-      let(:page_element_class) do
-        Class.new(described_class) do
-          before_events do
-            call_in_before_events
-          end
-        end
-      end
-
-      it 'delegates to the `PageMagic::Element`' do
-        capybara_button = instance_double(Capybara::Node::Element, click: true)
-        page_element = page_element_class.new(capybara_button)
-        allow(page_element).to receive(:call_in_before_events)
-        page_element.click
-        expect(page_element).to have_received(:call_in_before_events)
-      end
-    end
-
-    context 'when a method called from within a after_events hook' do
-      let(:page_element_class) do
-        Class.new(described_class) do
-          after_events do
-            call_in_after_events
-          end
-        end
-      end
-
-      it 'delegates to the `PageMagic::Element`' do
-        capybara_button = instance_double(Capybara::Node::Element, click: true)
-        page_element = page_element_class.new(capybara_button)
-        allow(page_element).to receive(:call_in_after_events)
-        page_element.click
-        expect(page_element).to have_received(:call_in_after_events)
-      end
-    end
-  end
-
-  describe '#initialize' do
-    it 'sets the parent element' do
-      described_class.parent_element(:page)
-      instance = described_class.new(:element)
-      expect(instance.parent_element).to eq(:page)
-    end
-
-    describe 'inherited items' do
-      it 'copies the before hooks' do
-        before_hook = proc {}
-        described_class.before_events(&before_hook)
-
-        instance = described_class.new(:element)
-        expect(instance.before_events).to include(before_hook)
-      end
-
-      it 'copies the after hooks' do
-        after_hook = proc {}
-        described_class.after_events(&after_hook)
-
-        instance = described_class.new(:element)
-        expect(instance.after_events).to include(after_hook)
-      end
-    end
-  end
-
-  describe '#method_missing' do
-    context 'when no sub element definition found' do
-      it 'delegates to the capybara element' do
-        instance = described_class.new(instance_double(Capybara::Node::Element, visible?: true))
-        expect(instance).to be_visible
-      end
-    end
-
-    context 'when method not found on the capybara element' do
-      it 'calls method on parent element' do
-        element = Struct.new(:parent_method).new(:called)
-        described_class.parent_element(element)
-        instance = described_class.new(:capybara_element)
-        expect(instance.parent_method).to eq(:called)
-      end
-    end
-
-    context 'when the method is not found on parent' do
-      it 'throws and exception' do
-        described_class.parent_element(:parent_element)
-        instance = described_class.new(:capybara_element)
-        expect { instance.bobbins }.to raise_exception NoMethodError
-      end
-    end
-  end
-
-  describe '#respond_to?' do
-    subject(:instance) do
-      capybara_element = Struct.new(:element_method).new(:called)
-      Class.new(described_class) do
-        element :sub_element, css: '.sub-element'
-      end.new(capybara_element)
-    end
-
-    it 'checks for methods on self' do
-      expect(instance).to respond_to(:session)
-    end
-
-    it 'checks against registered elements' do
-      expect(instance).to respond_to(:sub_element)
-    end
-
-    it 'checks for the method of the browser_element' do
-      expect(instance).to respond_to(:element_method)
-    end
-  end
-
-  describe '#session' do
-    it 'has a handle to the session' do
-      described_class.parent_element(instance_double(PageMagic::InstanceMethods, session: :session))
-      instance = described_class.new(:capybara_element)
-      expect(instance.session).to eq(:session)
-    end
-  end
-end