site_prism.vcr 0.1.2 → 0.2.0

data/spec/unit/dsl/initial_adjuster_spec.rb

@@ -9,8 +9,8 @@ describe SPV::DSL::InitialAdjuster do
   subject { described_class.new(options) }
 
   before do
-    SPV::Fixtures::TmpKeeper.stub(:new).and_return(tmp_keeper)
-    SPV::Fixtures::Handler.stub(:new).and_return(fixtures_handler)
+    allow(SPV::Fixtures::TmpKeeper).to receive(:new).and_return(tmp_keeper)
+    allow(SPV::Fixtures::Handler).to receive(:new).and_return(fixtures_handler)
   end
 
   describe '.new' do
@@ -33,12 +33,12 @@ describe SPV::DSL::InitialAdjuster do
     let(:relative_path_modifier) { double('relative path modifier') }
 
     before do
-      SPV::Fixtures::Modifiers::HomePath.stub(:new).and_return(home_path_modifier)
-      SPV::Fixtures::Modifiers::RelativePath.stub(:new).and_return(relative_path_modifier)
+      allow(SPV::Fixtures::Modifiers::ShortcutPath).to receive(:new).and_return(home_path_modifier)
+      allow(SPV::Fixtures::Modifiers::RelativePath).to receive(:new).and_return(relative_path_modifier)
     end
 
     it 'initializes the home path modifier' do
-      expect(SPV::Fixtures::Modifiers::HomePath).to receive(:new).with(options)
+      expect(SPV::Fixtures::Modifiers::ShortcutPath).to receive(:new).with(options)
 
       subject.fixtures(raw_fixtures)
     end
@@ -71,13 +71,29 @@ describe SPV::DSL::InitialAdjuster do
   describe '#home_path' do
     let(:raw_home_path) { 'some home path' }
 
-    it 'defines a default home path' do
-      expect(options).to receive(:home_path=).with(raw_home_path)
+    it 'defines a shortcut for a home path' do
+      expect(options).to receive(:add_shortcut_path).with(
+        '~',
+        raw_home_path
+      )
 
       subject.home_path(raw_home_path)
     end
   end
 
+  describe '#shortcut_path' do
+    let(:raw_path) { 'some path' }
+
+    it 'defines a shortcut for the path' do
+      expect(options).to receive(:add_shortcut_path).with(
+        'test_shortcut',
+        raw_path
+      )
+
+      subject.shortcut_path('test_shortcut', raw_path)
+    end
+  end
+
   describe '#path' do
     def set_path
       subject.path 'path', raw_fixtures
@@ -90,9 +106,9 @@ describe SPV::DSL::InitialAdjuster do
     let(:home_path_modifier) { double('home path modifier') }
 
     before do
-      SPV::OptionsWithPath.stub(:new).and_return(options_with_path)
-      SPV::Fixtures::Modifiers::Path.stub(:new).and_return(path_modifier)
-      SPV::Fixtures::Modifiers::HomePath.stub(:new).and_return(home_path_modifier)
+      allow(SPV::OptionsWithPath).to receive(:new).and_return(options_with_path)
+      allow(SPV::Fixtures::Modifiers::Path).to receive(:new).and_return(path_modifier)
+      allow(SPV::Fixtures::Modifiers::ShortcutPath).to receive(:new).and_return(home_path_modifier)
     end
 
     it 'initializes a new object with options' do
@@ -117,7 +133,7 @@ describe SPV::DSL::InitialAdjuster do
 
     it 'initializes the modifier to set home path' do
       expect(
-        SPV::Fixtures::Modifiers::HomePath
+        SPV::Fixtures::Modifiers::ShortcutPath
       ).to receive(:new).with(options_with_path)
 
       set_path
@@ -169,9 +185,9 @@ describe SPV::DSL::InitialAdjuster do
     let(:raw_fixtures) { 'some raw fixtures' }
 
     before do
-      SPV::Fixtures.stub(:new).and_return(fixtures)
+      allow(SPV::Fixtures).to receive(:new).and_return(fixtures)
 
-      tmp_keeper.stub(:fixtures).and_return(raw_fixtures)
+      allow(tmp_keeper).to receive(:fixtures).and_return(raw_fixtures)
     end
 
     it 'initializes the fixtures handler' do

data/spec/unit/element_spec.rb

@@ -6,7 +6,7 @@ describe SPV::Element do
   let(:applier) { instance_double('SPV::Applier', apply_vcr: true) }
 
   before do
-    SPV::Applier.stub(:new).and_return(applier)
+    allow(SPV::Applier).to receive(:new).and_return(applier)
   end
 
   describe '.new' do
@@ -25,8 +25,8 @@ describe SPV::Element do
     subject { described_class.new(nil, parent) }
 
     before do
-      subject.stub(:click)
-      subject.stub(:shift_event).and_yield.and_return(applier)
+      allow(subject).to receive(:click)
+      allow(subject).to receive(:shift_event).and_yield.and_return(applier)
     end
 
     it 'shifts a click event to the applier' do

data/spec/unit/fixture_spec.rb

@@ -55,34 +55,64 @@ describe SPV::Fixture do
   end
 
   describe '#set_home_path' do
-    subject { described_class.new('~/fixture_name') }
+    context 'when a simple shortcut is used' do
+      it 'defines a new name with a replaced shortcut path' do
+        fixture = described_class.new(':shortcut/fixture_name')
+
+        expect(fixture).to receive(:path=).with('my_home_path/')
+
+        fixture.set_home_path('my_home_path/')
+      end
 
-    it 'defines a new name with replaced home path symbol' do
-      expect(subject).to receive(:path=).with('my_home_path/')
+      it 'defines a new name with a replaced shortcut path and keeps a path to subdirectory' do
+        fixture = described_class.new(':shortcut/sub/fixture_name')
 
-      subject.set_home_path('my_home_path/')
+        expect(fixture).to receive(:path=).with('my_home_path/sub')
+
+        fixture.set_home_path('my_home_path/')
+      end
     end
 
-    it 'defines a new name with replaced home path symbol and keeps a path to subdirectory' do
-      fixture = described_class.new('~/sub/fixture_name')
+    context 'when a home path is used' do
+      it 'defines a new name with a replaced home path symbol' do
+        fixture = described_class.new('~/fixture_name')
 
-      expect(fixture).to receive(:path=).with('my_home_path/sub')
+        expect(fixture).to receive(:path=).with('my_home_path/')
+
+        fixture.set_home_path('my_home_path/')
+      end
 
-      fixture.set_home_path('my_home_path/')
+      it 'defines a new name with replaced a home path symbol and keeps a path to subdirectory' do
+        fixture = described_class.new('~/sub/fixture_name')
+
+        expect(fixture).to receive(:path=).with('my_home_path/sub')
+
+        fixture.set_home_path('my_home_path/')
+      end
     end
   end
 
-  describe '#has_link_to_home_path?' do
-    it 'returns true when a name of fixture starts with "~/"' do
-      expect(
-        described_class.new('~/some').has_link_to_home_path?
-      ).to be_true
+  describe '#shortcut_path' do
+    context 'when a fixture has a shortcut' do
+      it 'returns "~" for "~/some"' do
+        expect(
+          described_class.new('~/some').shortcut_path
+        ).to eq('~')
+      end
+
+      it 'returns "path" for ":path/some"' do
+        expect(
+          described_class.new(':path/some').shortcut_path
+        ).to eq('path')
+      end
     end
 
-    it 'returns true when a name of fixture does not start with "~/"' do
-      expect(
-        described_class.new('some').has_link_to_home_path?
-      ).to be_false
+    context 'when a fixture has not a shortcut' do
+      it 'returns nil' do
+        expect(
+          described_class.new('some').shortcut_path
+        ).to be_nil
+      end
     end
   end
 

data/spec/unit/fixtures/converter_spec.rb

@@ -12,7 +12,7 @@ describe SPV::Fixtures::Converter do
     }
 
     before do
-      SPV::Fixture.stub(:new).and_return('first prepared', 'second prepared')
+      allow(SPV::Fixture).to receive(:new).and_return('first prepared', 'second prepared')
     end
 
     it 'initializes first object of Fixture class' do

data/spec/unit/fixtures/handler_spec.rb

@@ -8,7 +8,7 @@ describe SPV::Fixtures::Handler do
   subject { described_class.new(options) }
 
   before do
-    SPV::Fixtures::Converter.stub(:convert_raw).and_return(converted_fixtures)
+    allow(SPV::Fixtures::Converter).to receive(:convert_raw).and_return(converted_fixtures)
   end
 
   describe '#handle_raw' do
@@ -21,7 +21,7 @@ describe SPV::Fixtures::Handler do
     let(:converted_fixtures) { [converted_fixture] }
     let(:modifier)           do
       instance_double(
-        'SPV::Fixtures::Modifiers::HomePath',
+        'SPV::Fixtures::Modifiers::ShortcutPath',
         modify: true
       )
     end
@@ -55,7 +55,7 @@ describe SPV::Fixtures::Handler do
     let(:modifiers)          { 'some modifiers' }
 
     before do
-      subject.stub(:handle_raw).and_return(handled_fixtures_1, handled_fixtures_2)
+      allow(subject).to receive(:handle_raw).and_return(handled_fixtures_1, handled_fixtures_2)
     end
 
     it 'handles the first set of raw fixtures' do

data/spec/unit/fixtures/manager_spec.rb

@@ -1,35 +1,63 @@
 require 'spec_helper'
 
 describe SPV::Fixtures::Manager do
-  let(:options) { instance_double('SPV::Options', fixtures: ['some fixture']) }
-
-  describe '#inject' do
-    let(:fixture1) do
-      instance_double(
-        'SPV::Fixture',
-        name: 'arya_stark',
-        options: {
-          erb: {
-            testvar: true,
-            port:    123
-          }
+  let(:options) { instance_double('SPV::Options') }
+
+  let(:fixture1) do
+    instance_double(
+      'SPV::Fixture',
+      name: 'arya_stark',
+      options: {
+        erb: {
+          testvar: true,
+          port:    123
         }
-      )
+      }
+    )
+  end
+
+  let(:fixture2) do
+    instance_double(
+      'SPV::Fixture',
+      name: 'jon_snow',
+      options: {}
+    )
+  end
+
+  let(:fixtures) do
+    [fixture1, fixture2]
+  end
+
+  describe '.inject' do
+    let(:manager) { instance_double('SPV::Fixtures::Manager', inject: true) }
+
+    subject { described_class.inject(fixtures, options) }
+
+    before do
+      allow(described_class).to receive(:new).and_return(manager)
     end
 
-    let(:fixture2) do
-      instance_double(
-        'SPV::Fixture',
-        name: 'jon_snow',
-        options: {}
-      )
+    it 'initializes a new instance of the fixtures manager class' do
+      expect(described_class).to receive(:new).with(fixtures, options)
+
+      subject
     end
 
-    let(:fixtures) do
-      [fixture1, fixture2]
+    it 'injects fixtures' do
+      expect(manager).to receive(:inject)
+
+      subject
     end
 
-    subject(:manager) { described_class.new(options) }
+    it 'returns an instance of the manager' do
+      res = subject
+
+      expect(manager).to eq(res)
+    end
+  end
+
+  describe '#inject' do
+    subject(:manager) { described_class.new(fixtures, options) }
 
     context 'when there are fixtures' do
       after do
@@ -39,7 +67,7 @@ describe SPV::Fixtures::Manager do
 
       context 'when VCR holds the first fixture' do
         before do
-          manager.inject(fixtures)
+          manager.inject
 
           VCR.eject_cassette
           @fixture = VCR.eject_cassette
@@ -56,7 +84,7 @@ describe SPV::Fixtures::Manager do
 
       context 'when VCR holds the second fixture' do
         before do
-          manager.inject(fixtures)
+          manager.inject
 
           @fixture = VCR.eject_cassette
         end
@@ -72,8 +100,10 @@ describe SPV::Fixtures::Manager do
     end
 
     context 'when there are not any fixtures' do
+      let(:fixtures) { [] }
+
       it 'raises an error about no fixtures' do
-        expect { manager.inject([]) }.to raise_error(
+        expect { manager.inject }.to raise_error(
           ArgumentError,
           'No fixtures were specified to insert them into VCR'
         )
@@ -82,12 +112,29 @@ describe SPV::Fixtures::Manager do
   end
 
   describe '#eject' do
-    subject { described_class.new(options).eject }
+    subject(:manager) { described_class.new(fixtures, options) }
 
-    it 'ejects all fixtures from VCR' do
-      expect(SPV::Helpers).to receive(:eject_all_cassettes)
+    before do
+      manager.inject
+    end
 
-      subject
+    it 'ejects the inserted fixtures' do
+      manager.eject
+
+      expect(VCR.eject_cassette).to equal(nil)
+    end
+
+    context 'when there are fixtures inserted by another code' do
+      before do
+        VCR.insert_cassette('test_cassette')
+      end
+
+      it 'does not remove fixtures which are not inserted by this instance of the fixtures manager' do
+        manager.eject
+
+        expect(VCR.eject_cassette.name).to eq('test_cassette')
+        expect(VCR.eject_cassette).to equal(nil)
+      end
     end
   end
 end

data/spec/unit/fixtures/modifiers/path_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe SPV::Fixtures::Modifiers::Path do
   describe '#modify' do
     let(:path)    { 'some path' }
-    let(:options) { instance_double('SPV::Options', path: path) }
-    let(:fixture) { instance_double('SPV::Fixture', :has_link_to_home_path? => false) }
+    let(:options) { instance_double('SPV::OptionsWithPath', path: path) }
+    let(:fixture) { instance_double('SPV::Fixture', shortcut_path: nil) }
 
     subject { described_class.new(options).modify(fixture) }
 
@@ -26,24 +26,24 @@ describe SPV::Fixtures::Modifiers::Path do
       end
     end
 
-    context 'when the fixture has a link to the home path' do
+    context 'when the fixture has a shortcut path' do
       let(:fixture) do
         instance_double(
           'SPV::Fixture',
-          :has_link_to_home_path? => true,
-          clean_name: 'Max'
+          shortcut_path: 'myshortcut',
+          clean_name:    'Max'
         )
       end
 
-      it 'raises an error about link to the home path' do
+      it 'raises an error about a shortcut path' do
         expect{
           subject
         }.to raise_error(
-          SPV::Fixtures::Modifiers::Path::HomePathError,
-          "You cannot use the home path while listing fixtures in the 'path' method. " <<
+          SPV::Fixtures::Modifiers::Path::ShortcutPathError,
+          "You cannot use a shortcut path while listing fixtures in the 'path' method. " <<
           "Please, use 'fixtures' method for 'Max' fixture or " <<
-          "you can additionally use the 'path' method where you will specify a home path as a path name." <<
-          "Example: path('~/', ['Max'])"
+          "you can additionally use the 'path' method where you will specify a shortcut path as a path name." <<
+          "Example: path(':myshortcut', ['Max'])"
         )
       end
     end

data/spec/unit/fixtures/modifiers/relative_path_spec.rb

@@ -13,7 +13,7 @@ describe SPV::Fixtures::Modifiers::RelativePath do
     end
 
     it 'moves up on 2 levels in the hierarchy of directories' do
-      fixture.stub(:path).and_return('parent_dir/some_dir/next_dir/../../')
+      allow(fixture).to receive(:path).and_return('parent_dir/some_dir/next_dir/../../')
 
       expect(fixture).to receive(:path=).with('parent_dir')
 

data/spec/unit/fixtures/modifiers/shortcut_path_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe SPV::Fixtures::Modifiers::ShortcutPath do
+  describe '#modify' do
+    let(:path)          { 'some home path' }
+    let(:shortcut_path) { 'some shortcut' }
+    let(:options)       { instance_double('SPV::Options') }
+    let(:fixture) do
+      instance_double(
+        'SPV::Fixture',
+        name:          'test_with_home_path',
+        shortcut_path: shortcut_path
+      )
+    end
+
+    subject { described_class.new(options).modify(fixture) }
+
+    context 'when a name of the fixture has a shortcut path' do
+      context 'when a given shortcut path is defined' do
+        it 'writes a proper path to the fixture' do
+          expect(options).to receive(:shortcut_path).with(shortcut_path).and_return(path)
+          expect(fixture).to receive(:set_home_path).with(path)
+
+          subject
+        end
+      end
+
+      context 'when a given shortcut path is not defined' do
+        before do
+          allow(options).to receive(:shortcut_path).and_return(nil)
+        end
+
+        it 'raises an argument error about wrong way of defining fixtures' do
+          msg = "You are trying to use the 'some shortcut' shortcut path " \
+            "for test_with_home_path fixture. This shortcut path cannot be " \
+            "used since it is not defined, please refer to the documentation to make " \
+            "sure you properly define the shortcut path."
+
+          expect { subject }.to raise_error(
+            ArgumentError, msg
+          )
+        end
+      end
+    end
+
+    context 'when a name of the fixture has not a shortcut path' do
+      let(:fixture) do
+        instance_double(
+          'SPV::Fixture',
+          shortcut_path: nil
+        )
+      end
+
+      it 'does not set any home path' do
+        expect(fixture).to_not receive(:set_home_path)
+
+        subject
+      end
+    end
+  end
+end

data/spec/unit/{patches/element_container_spec.rb → mixins/element_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class TestPageWithElement
-  extend SitePrism::ElementContainer
+  extend SPV::Mixins::Element
 
   class << self
     def element(*); end
@@ -15,7 +15,7 @@ class TestPageWithElement
   link_vcr_with_element :test_el2
 end
 
-describe SitePrism::ElementContainer do
+describe SPV::Mixins::Element do
   describe '.element_with_vcr' do
     subject do
       TestPageWithElement.instance_eval do

data/spec/unit/mixins/page_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+class TestPage
+  include SPV::Mixins::Page
+end
+
+describe SPV::Mixins::Page do
+  describe 'class methods' do
+    subject { TestPage }
+
+    describe '.adjust_parent_vcr_options' do
+      subject { TestPage.adjust_parent_vcr_options }
+
+      context 'when there are not defined vcr options' do
+        it 'raises an error' do
+          expect{
+            subject
+          }.to raise_error(ArgumentError, 'There is not any Vcr options defined for the parent class')
+        end
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    subject { TestPage.new }
+
+    let(:applier) do
+      instance_double(
+        'SPV::Applier',
+        apply_vcr:      true,
+        alter_fixtures: true
+      )
+    end
+
+    before do
+      TestPage.vcr_options_for_load { }
+    end
+
+    describe '#load_and_apply_vcr' do
+      before do
+        allow(subject).to receive(:shift_event).and_return(applier)
+        allow(subject).to receive(:load)
+      end
+
+      it 'shifts a load event to the applier' do
+        expect(subject).to receive(:shift_event).and_yield.and_return(applier)
+        expect(subject).to receive(:load).with('some arguments')
+
+        subject.load_and_apply_vcr('some arguments')
+      end
+
+      it 'applies vcr' do
+        expect(applier).to receive(:apply_vcr)
+
+        subject.load_and_apply_vcr
+      end
+    end
+
+    describe '#shift_event' do
+      before do
+        allow(SPV::Applier).to receive(:new).and_return(applier)
+        allow(applier).to receive(:shift_event).and_yield.and_return(applier)
+      end
+
+      context 'when the applier is not initialized yet' do
+        it 'initializes the fixtures applier' do
+          expect(SPV::Applier).to receive(:new).with(
+            subject
+          )
+
+          subject.shift_event {}
+        end
+
+        context 'when there are the defined blocks to adjust Vcr options' do
+          before do
+            TestPage.vcr_options_for_load { }
+            TestPage.adjust_parent_vcr_options {}
+            TestPage.adjust_parent_vcr_options {}
+          end
+
+          it 'alters Vcr fixtures' do
+            expect(applier).to receive(:alter_fixtures).twice
+
+            subject.shift_event {}
+          end
+        end
+      end
+
+      context 'when the applier is already initialized' do
+        it 'does not initialize it twice' do
+          expect(SPV::Applier).to receive(:new).once
+
+          subject.shift_event {}
+          subject.shift_event {}
+        end
+      end
+
+      it 'shifts an event to the applier' do
+        expect(applier).to receive(:shift_event)
+
+        subject.shift_event { }
+      end
+    end
+  end
+end

data/spec/unit/options_spec.rb

@@ -15,18 +15,18 @@ describe SPV::Options do
     end
   end
 
-  describe '#home_path=' do
+  describe '#add_shortcut_path' do
     context 'when the last symbol is a slash' do
-      it 'returns the home path as it is' do
-        options.home_path = 'some/path/'
-        expect(options.home_path).to eq('some/path/')
+      it 'returns the path as it is' do
+        options.add_shortcut_path('~', 'some/path/')
+        expect(options.shortcut_path('~')).to eq('some/path/')
       end
     end
 
     context 'when the last symbol is not slash' do
       it 'returns the home path with a slash at the end of the path' do
-        options.home_path = 'some/path'
-        expect(options.home_path).to eq('some/path/')
+        options.add_shortcut_path('~', 'some/path')
+        expect(options.shortcut_path('~')).to eq('some/path/')
       end
     end
   end

data/spec/unit/waiter_spec.rb

@@ -26,7 +26,7 @@ describe SPV::Waiter do
       let(:waiter) { instance_double('SPV::Waiter', wait: true) }
 
       before do
-        described_class.stub(:new).and_return(waiter)
+        allow(described_class).to receive(:new).and_return(waiter)
       end
 
       it 'initializes a new instance of the waiter' do
@@ -57,7 +57,7 @@ describe SPV::Waiter do
         let(:node) { double('node of DOM', wait_for_content: true) }
 
         before do
-          options.stub(:waiter).and_return(proc { self.wait_for_content })
+          allow(options).to receive(:waiter).and_return(proc { self.wait_for_content })
         end
 
         it 'calls the waiter to wait until all HTTP interactions are finished' do
@@ -76,7 +76,7 @@ describe SPV::Waiter do
 
         context 'when the option disallowing fixtures ejection is passed' do
           before do
-            options.stub(:waiter_options).and_return(eject_cassettes: false)
+            allow(options).to receive(:waiter_options).and_return(eject_cassettes: false)
           end
 
           it 'does not eject fixtures' do