site_prism.vcr 0.0.1 → 0.1.0

data/lib/site_prism_vcr/version.rb

@@ -1,3 +1,3 @@
 module SPV
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/site_prism.vcr.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'site_prism', '~> 2.4'
-  spec.add_dependency 'vcr',        '~> 2.6.0'
+  spec.add_dependency 'site_prism', '~> 2.5'
+  spec.add_dependency 'vcr',        '~> 2.8.0'
   spec.add_dependency 'webmock'
 end

data/spec/integration/elements/apply_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_integration_helper'
+
+feature 'Elements > Apply Vcr' do
+  # It may be any other event, we use click event
+  # because it is the simplest one
+  def shift_click_event(link)
+    link.shift_event { link.click }
+  end
+
+  def shift_click_event_to(link_name)
+    link = test_app_page.public_send(link_name)
+    shift_click_event(link)
+  end
+
+  let(:cat_owner)     { test_app_page.cat_owner }
+  let(:test_app_page) { HomePage.new }
+  let(:action_method) { :apply_vcr }
+
+  before do
+    test_app_page.load
+  end
+
+  context 'clicks and handles one HTTP request' do
+    before do
+      shift_click_event_to(:link_with_one_request).apply_vcr
+    end
+
+    it 'applies a default fixture' do
+      expect(test_app_page.cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  context 'when VCR is associated with already defined elements' do
+    before do
+      shift_click_event_to(:link_without_vcr).apply_vcr
+    end
+
+    it 'applies a default fixture' do
+      expect(test_app_page.cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  context 'when there is a delay between clicking and doing an HTTP request' do
+    before do
+      shift_click_event_to(:link_with_one_request_and_delay).apply_vcr
+    end
+
+    it 'applies a fixture and waits for results' do
+      expect(cat_owner).to have_content('Ned Stark')
+    end
+  end
+
+  # TODO: should we write the same test for the page load?
+  context 'when an user clicks on the link which causes 2 HTTP requests' do
+    before do
+      shift_click_event_to(:link_with_2_requests).apply_vcr
+    end
+
+    it 'applies 2 fixtures' do
+      expect(cat_owner).to have_content('Ned Stark')
+      expect(cat_owner).to have_content('Robb Stark')
+    end
+  end
+
+  it_behaves_like 'when a custom fixture is applied' do
+    let(:actor) { shift_click_event_to(:link_with_one_request) }
+
+    context 'when clicks again without specifying a custom fixture' do
+      it 'uses a default fixture again' do
+        actor.apply_vcr
+
+        expect(cat_owner).to have_content('Ned Stark')
+      end
+    end
+  end
+
+  context 'waiters' do
+    it_behaves_like 'when a default waiter does not eject fixtures' do
+      let(:actor) { shift_click_event_to(:link_without_ejecting_fixtures) }
+    end
+
+    it_behaves_like 'when options are redefined for waiters' do
+      let(:actor) { shift_click_event_to(:link_with_2_requests) }
+    end
+
+    it_behaves_like 'custom waiters' do
+      let(:actor) { shift_click_event_to(:link_with_2_requests) }
+    end
+  end
+
+  it_behaves_like 'when a home path is define' do
+    let(:actor_with_home_path)    { shift_click_event_to(:link_with_home_path) }
+    let(:actor_without_home_path) { shift_click_event_to(:link_with_one_request) }
+  end
+
+  it_behaves_like 'when a default fixture is exchanged' do
+    let(:actor_with_home_path)    { shift_click_event_to(:link_with_home_path) }
+    let(:actor_without_home_path) { shift_click_event_to(:link_with_2_requests) }
+  end
+end

data/spec/integration/elements/events/click_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_integration_helper'
+
+feature 'Elements > Events > Click' do
+  let(:cat_owner)     { test_app_page.cat_owner }
+  let(:test_app_page) { HomePage.new }
+
+  before do
+    test_app_page.load
+  end
+
+  context 'applies and handles HTTP request' do
+    before do
+      test_app_page.link_with_one_request.click_and_apply_vcr
+    end
+
+    it 'applies a default fixture' do
+      expect(test_app_page.cat_owner).to have_content('Ned Stark')
+    end
+  end
+end

data/spec/integration/{immediate_http_interactions/page_load_on_click_spec.rb → pages/custom_event_spec.rb}

@@ -1,13 +1,15 @@
 require 'spec_integration_helper'
 
-feature 'Immediate Http interactions > Page load on click' do
-  let(:one_request_page) { ImmediateHttpInteractions::OneRequestPage.new }
+feature 'Pages > Load > Custom event' do
+  let(:one_request_page) { PageLoad::OneRequestPage.new }
 
   before do
     index_page = HomePage.new
     index_page.load
 
-    one_request_page.apply_vcr proc { index_page.link_to_go_to_another_page.click }
+    one_request_page.shift_event {
+      index_page.link_to_go_to_another_page.click
+    }.apply_vcr
   end
 
   it 'loads fixtures on opening a page by click on a link' do

data/spec/integration/{immediate_http_interactions/page_load_spec.rb → pages/load_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_integration_helper'
 
-feature 'Immediate Http interactions > Page load' do
+feature 'Pages > Load' do
   let(:cat_owner)     { test_app_page.cat_owner }
-  let(:test_app_page) { ImmediateHttpInteractions::OneRequestPage.new }
+  let(:test_app_page) { PageLoad::OneRequestPage.new }
   let(:action_method) { :load_and_apply_vcr }
 
   context 'when one default fixture is defined' do
@@ -20,7 +20,7 @@ feature 'Immediate Http interactions > Page load' do
   end
 
   context 'when a subpage inherits a page with a defined vcr options' do
-    let(:test_app_page) { ImmediateHttpInteractions::SubPage.new }
+    let(:test_app_page) { PageLoad::SubPage.new }
 
     it 'subpage inherits the defined options for its parent page' do
       test_app_page.load_and_apply_vcr
@@ -35,22 +35,26 @@ feature 'Immediate Http interactions > Page load' do
 
   context 'waiters' do
     it_behaves_like 'when a default waiter does not eject fixtures' do
-      let(:actor) { ImmediateHttpInteractions::WaiterWithoutFixturesEjectionPage.new }
+      let(:actor) { PageLoad::WaiterWithoutFixturesEjectionPage.new }
+    end
+
+    it_behaves_like 'when options are redefined for waiters' do
+      let(:actor) { PageLoad::TwoRequestsPage.new }
     end
 
     it_behaves_like 'custom waiters' do
-      let(:actor)         { ImmediateHttpInteractions::TwoRequestsPage.new }
+      let(:actor)         { PageLoad::TwoRequestsPage.new }
       let(:test_app_page) { actor }
     end
   end
 
   it_behaves_like 'when a home path is define' do
-    let(:actor_with_home_path)    { ImmediateHttpInteractions::HomePathPage.new }
-    let(:actor_without_home_path) { ImmediateHttpInteractions::OneRequestPage.new }
+    let(:actor_with_home_path)    { PageLoad::HomePathPage.new }
+    let(:actor_without_home_path) { PageLoad::OneRequestPage.new }
   end
 
   it_behaves_like 'when a default fixture is exchanged' do
-    let(:actor_without_home_path) { ImmediateHttpInteractions::TwoRequestsPage.new }
-    let(:actor_with_home_path)    { ImmediateHttpInteractions::HomePathPage.new }
+    let(:actor_without_home_path) { PageLoad::TwoRequestsPage.new }
+    let(:actor_with_home_path)    { PageLoad::HomePathPage.new }
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 
 require 'rspec'
+require 'rspec/fire'
 require 'coveralls'
 
 require 'site_prism.vcr'
@@ -11,6 +12,8 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.include(RSpec::Fire)
 end
 
 VCR.configure do |c|

data/spec/support/shared/integration/custom_fixtures.rb

@@ -29,4 +29,21 @@ shared_examples 'when a custom fixture is applied' do
       expect(cat_owner).to have_content('Robert Baratheon')
     end
   end
+
+  context 'when "replace" action is defined before defining fixtures to be used for replacing' do
+    before do
+      actor.public_send(action_method) do
+        replace
+        path 'custom', ['daenerys_targaryen']
+      end
+    end
+
+    after do
+      SPV::Helpers.eject_all_cassettes
+    end
+
+    it 'uses custom fixture anyway' do
+      expect(cat_owner).to have_content('Daenerys Targaryen')
+    end
+  end
 end

data/spec/support/shared/integration/exchange.rb

@@ -35,7 +35,7 @@ shared_examples 'when a default fixture is exchanged' do
       end
 
       it 'uses the exchanged fixture with specified erb variables' do
-
+        expect(cat_owner).to have_content('Robert Baratheon')
       end
     end
   end

data/spec/support/shared/integration/home_path.rb

@@ -1,7 +1,7 @@
 shared_examples 'when a home path is define' do
   shared_examples 'expects the custom fixture on the page' do
     it 'applies a stored fixture in the directory defined in the home path' do
-      expect(test_app_page.cat_owner).to have_content('Bran Stark')
+      expect(cat_owner).to have_content('Bran Stark')
     end
   end
 

data/spec/support/shared/integration/waiter.rb

@@ -1,3 +1,23 @@
+shared_examples 'when cassettes are not ejected' do |texts, cassettes|
+  after do
+    SPV::Helpers.eject_all_cassettes
+  end
+
+  it 'uses a default waiter' do
+    texts.each do |expected_text|
+      expect(cat_owner).to have_content(expected_text)
+    end
+  end
+
+  it 'VCR contains all cassettes' do
+    cassettes.each do |expected_cassette|
+      expect(VCR.eject_cassette.name).to eq(expected_cassette)
+    end
+
+    expect(VCR.eject_cassette).to be_nil
+  end
+end
+
 shared_examples 'custom waiters' do
   context 'when a waiter is redefined' do
     before do
@@ -36,20 +56,9 @@ shared_examples 'custom waiters' do
       end
     end
 
-    after do
-      SPV::Helpers.eject_all_cassettes
-    end
-
-    it 'uses a custom waiter' do
-      expect(cat_owner).to have_content('Arya Stark')
-      expect(cat_owner).to have_content('Jon Snow')
-    end
-
-    it 'VCR contains all cassettes' do
-      expect(VCR.eject_cassette.name).to eq('jon_snow')
-      expect(VCR.eject_cassette.name).to eq('arya_stark')
-      expect(VCR.eject_cassette).to be_nil
-    end
+    it_behaves_like 'when cassettes are not ejected',
+      ['Arya Stark', 'Jon Snow'],
+      ['jon_snow', 'arya_stark']
   end
 end
 
@@ -58,18 +67,21 @@ shared_examples 'when a default waiter does not eject fixtures' do
     actor.public_send(action_method)
   end
 
-  after do
-    SPV::Helpers.eject_all_cassettes
-  end
+  it_behaves_like 'when cassettes are not ejected',
+    ['Ned Stark', 'Robb Stark'],
+    ['robb_stark', 'ned_stark']
+end
 
-  it 'uses a default waiter' do
-    expect(cat_owner).to have_content('Ned Stark')
-    expect(cat_owner).to have_content('Robb Stark')
-  end
+shared_examples 'when options are redefined for waiters' do
+  context 'when the option to not eject default fixtures is passed' do
+    before do
+      actor.public_send(action_method) do
+        waiter_options(eject_cassettes: false)
+      end
+    end
 
-  it 'VCR contains all cassettes' do
-    expect(VCR.eject_cassette.name).to eq('robb_stark')
-    expect(VCR.eject_cassette.name).to eq('ned_stark')
-    expect(VCR.eject_cassette).to be_nil
+    it_behaves_like 'when cassettes are not ejected',
+      ['Ned Stark', 'Robb Stark'],
+      ['robb_stark', 'ned_stark']
   end
 end

data/spec/support/site_prism/pages/home.rb

@@ -41,4 +41,11 @@ class HomePage < BasePage
       fixtures ['ned_stark', 'robb_stark']
       waiter({eject_cassettes: false}, &:wait_for_ned_stark_and_robb_stark)
     end
+
+  element :link_without_vcr, '#link_with_one_request'
+
+  link_vcr_with_element :link_without_vcr do
+    fixtures ['ned_stark']
+    waiter   &:wait_for_cat_owner
+  end
 end

data/spec/support/site_prism/pages/{immediate_http_interactions → page_load}/home_path.rb

@@ -1,6 +1,6 @@
 require_relative '../base'
 
-module ImmediateHttpInteractions
+module PageLoad
   class HomePathPage < BasePage
     set_url '/immediate-http-interactions/one-request'
     set_url_matcher /immediate\-http\-interactions\/one\-request/

data/spec/support/site_prism/pages/{immediate_http_interactions → page_load}/one_request.rb

@@ -1,6 +1,6 @@
 require_relative '../base'
 
-module ImmediateHttpInteractions
+module PageLoad
   class OneRequestPage < BasePage
     set_url '/immediate-http-interactions/one-request?cat={cat}'
     set_url_matcher /immediate\-http\-interactions\/one\-request/

data/spec/support/site_prism/pages/{immediate_http_interactions → page_load}/subpage.rb

@@ -1,6 +1,6 @@
 require_relative './one_request'
 
-module ImmediateHttpInteractions
+module PageLoad
   class SubPage < OneRequestPage
     set_url '/immediate-http-interactions/one-request'
   end

data/spec/support/site_prism/pages/{immediate_http_interactions → page_load}/two_requests.rb

@@ -1,6 +1,6 @@
 require_relative '../base'
 
-module ImmediateHttpInteractions
+module PageLoad
   class TwoRequestsPage < BasePage
     set_url '/immediate-http-interactions/two-requests'
 

data/spec/support/site_prism/pages/{immediate_http_interactions → page_load}/waiter_without_fixtures_ejection.rb

@@ -1,6 +1,6 @@
 require_relative '../base'
 
-module ImmediateHttpInteractions
+module PageLoad
   class WaiterWithoutFixturesEjectionPage < BasePage
     set_url '/immediate-http-interactions/two-requests'
 

data/spec/unit/applier_spec.rb

@@ -1,11 +1,16 @@
 require 'spec_helper'
 
 describe SPV::Applier do
-  let(:node)             { double }
-  let(:options)          { double }
-  let(:fixtures_manager) { double(inject: true) }
-  let(:fixtures)         { double }
-  let(:initial_adjuster) { double(prepared_fixtures: fixtures) }
+  let(:node)             { double('node of DOM') }
+  let(:options)          { instance_double('SPV::Options') }
+  let(:fixtures_manager) { instance_double('SPV::Fixtures::Manager', inject: true) }
+  let(:fixtures)         { double('fixtures') }
+  let(:initial_adjuster) do
+    instance_double(
+      'SPV::DSL::InitialAdjuster',
+      prepare_fixtures: fixtures
+    )
+  end
 
   before do
     SPV::Options.stub(:new).and_return(options)
@@ -50,7 +55,7 @@ describe SPV::Applier do
     end
 
     it 'receives the fixtures container' do
-      expect(initial_adjuster).to receive(:prepared_fixtures)
+      expect(initial_adjuster).to receive(:prepare_fixtures)
 
       subject
     end
@@ -64,71 +69,84 @@ describe SPV::Applier do
     end
   end
 
-  describe '#apply' do
-    let(:cloned_options)    { 'cloned options' }
-    let(:options)           { double(clone_options: cloned_options) }
-    let(:waiter)            { double(wait: true) }
-    let(:prepared_fixtures) { 'prepared_fixtures by adjuster' }
-
-    let(:adjuster) do
-      double(
-        mymeth:            true,
-        fixtures:          true,
-        replace:           true,
-        prepared_fixtures: prepared_fixtures
-      )
-    end
-
+  describe '#apply_vcr' do
+    let(:node)        { double('node of DOM', click: true) }
     subject(:applier) { described_class.new(node) { } }
 
-    before do
-      SPV::DSL::Adjuster.stub(:new).and_return(adjuster)
-      SPV::Waiter.stub(:new).and_return(waiter)
-    end
+    context 'when an event is shifted' do
+      let(:cloned_options)    { 'cloned options' }
+      let(:options)           { instance_double('SPV::Options', clone_options: cloned_options) }
+      let(:waiter)            { instance_double('SPV::Waiter', wait: true) }
+      let(:prepared_fixtures) { 'prepared_fixtures by adjuster' }
+
+      let(:adjuster) do
+        instance_double(
+          'DSL::Adjuster',
+          fixtures:         true,
+          prepare_fixtures: prepared_fixtures
+        )
+      end
 
-    it 'initializes the fixtures adjuster with a new instance of options' do
-      expect(SPV::DSL::Adjuster).to receive(:new).with(
-        cloned_options,
-        fixtures
-      )
+      before do
+        SPV::DSL::Adjuster.stub(:new).and_return(adjuster)
+        SPV::Waiter.stub(:new).and_return(waiter)
 
-      applier.apply { }
-    end
+        applier.shift_event { node.click }
+      end
 
-    it 'calls a given block within the context of the adjuster' do
-      expect(adjuster).to receive(:mymeth)
+      it 'initializes the fixtures adjuster with a new instance of options' do
+        expect(SPV::DSL::Adjuster).to receive(:new).with(
+          cloned_options,
+          fixtures
+        )
 
-      applier.apply(proc{ mymeth }) {}
-    end
+        applier.apply_vcr
+      end
 
-    it 'applies fixtures' do
-      expect(fixtures_manager).to receive(:inject).with(prepared_fixtures)
+      context 'when a block is given' do
+        it 'calls a given block within the context of the adjuster' do
+          expect(adjuster).to receive(:fixtures)
 
-      applier.apply { }
-    end
+          applier.apply_vcr { fixtures }
+        end
+      end
 
-    it 'initializes the waiter' do
-      expect(SPV::Waiter).to receive(:new).with(
-        node,
-        fixtures_manager,
-        cloned_options
-      ).and_return(waiter)
+      it 'applies fixtures' do
+        expect(fixtures_manager).to receive(:inject).with(prepared_fixtures)
 
-      applier.apply { }
-    end
+        applier.apply_vcr
+      end
 
-    it 'does the click action over a node' do
-      expect(node).to receive(:click)
+      it 'initializes the waiter' do
+        expect(SPV::Waiter).to receive(:new).with(
+          node,
+          fixtures_manager,
+          cloned_options
+        ).and_return(waiter)
 
-      applier.apply do
-        node.click
+        applier.apply_vcr
       end
-    end
 
-    it 'waits until all HTTP interactions are finished' do
-      expect(waiter).to receive(:wait)
+      it 'does the click action over a node' do
+        expect(node).to receive(:click)
+
+        applier.apply_vcr
+      end
 
-      applier.apply { }
+      it 'waits until all HTTP interactions are finished' do
+        expect(waiter).to receive(:wait)
+
+        applier.apply_vcr
+      end
+    end
+
+    context 'when an event is not shifted' do
+      it 'raises an error about no event' do
+        expect{ subject.apply_vcr }.to raise_error(
+          SPV::Applier::EventError,
+          'Event is not shifted, before applying Vcr you have to shift event with "shift_event" method'
+        )
+      end
     end
   end
 end