site_prism.vcr 0.1.2 → 0.2.0

data/lib/site_prism_vcr/fixtures/modifiers/shortcut_path.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+
+module SPV
+  class Fixtures
+    module Modifiers
+      # It takes a fixture and replaces a shortcut path with
+      # a full path to it.
+      class ShortcutPath < Base
+        def modify(fixture)
+          if shortcut = fixture.shortcut_path
+            if path = @options.shortcut_path(shortcut)
+              fixture.set_home_path(path)
+            else
+              raise ArgumentError.new(
+                "You are trying to use the '#{shortcut}' shortcut path for #{fixture.name} 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."
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/mixins/element.rb

@@ -0,0 +1,23 @@
+module SPV
+  module Mixins
+    module Element
+      def element_with_vcr(element_name, *args, &block)
+        element element_name, *args
+
+        link_vcr_with_element(element_name, &block)
+      end
+
+      def link_vcr_with_element(element_name, &block)
+        origin_element_name = "origin_#{element_name}"
+
+        alias_method origin_element_name, element_name
+
+        define_method element_name.to_s do
+          elem = public_send(origin_element_name)
+
+          SPV::Element.new(elem, self, &block)
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/mixins/page.rb

@@ -0,0 +1,63 @@
+require 'forwardable'
+
+module SPV
+  module Mixins
+    module Page
+      def self.included(klass)
+        klass.extend(ClassMethods)
+        klass.send(:include, InstanceMethods)
+        klass.instance_variable_set(:@vcr_child_adjusters, [])
+      end
+
+      module ClassMethods
+        attr_reader :vcr_adjuster, :vcr_child_adjusters
+
+        def inherited(subclass)
+          # This code is required to allow subpages to inherit
+          # a defined adjuster block. Otherwise, that block should be
+          # duplicated in a subpage as well.
+          subclass.instance_variable_set(:@vcr_adjuster,        @vcr_adjuster)
+          subclass.instance_variable_set(:@vcr_child_adjusters, @vcr_child_adjusters.dup)
+        end
+
+        def vcr_options_for_load(&block)
+          @vcr_adjuster = block
+        end
+
+        def adjust_parent_vcr_options(&block)
+          raise ArgumentError.new(
+            'There is not any Vcr options defined for the parent class'
+          ) unless self.vcr_adjuster
+
+          self.vcr_child_adjusters << block
+        end
+      end
+
+      module InstanceMethods
+        def load_and_apply_vcr(*args, &block)
+          shift_event { load(*args) }.apply_vcr(&block)
+        end
+
+        def shift_event(&block)
+          vcr_applier.shift_event(&block)
+        end
+
+        private
+          def vcr_applier
+            @vcr_applier ||= begin
+              applier = SPV::Applier.new(
+                self,
+                &self.class.vcr_adjuster
+              )
+
+              self.class.vcr_child_adjusters.each do |block|
+                applier.alter_fixtures(&block)
+              end
+
+              applier
+            end
+          end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/options.rb

@@ -3,25 +3,39 @@ module SPV
   # and options for a waiter which holds execution until expectation
   # has been met.
   class Options
-    attr_accessor :waiter, :waiter_options, :home_path
+    attr_accessor :waiter, :waiter_options, :shortcut_paths
 
     def initialize(options = {})
+      @shortcut_paths = {}
+
       options.each do |key, val|
         public_send("#{key}=", val)
       end
     end
 
-    # Defines path to fixtures.
+    # Defines shortcut path to fixtures.
     #
-    # @param val [String] Path to fixtures.
+    # @param shortcut [String]
+    # @param path [String] Path to fixtures.
     #
     # @return [void]
     #
     # @api private
-    def home_path=(val)
-      val << '/' unless val[-1, 1] == '/'
+    def add_shortcut_path(shortcut, path)
+      path << '/' unless path[-1, 1] == '/'
+
+      self.shortcut_paths[shortcut] = path
+    end
 
-      @home_path = val
+    # Returns a full path associated with a shortcut.
+    #
+    # @param shortcut [String]
+    #
+    # @return [String]
+    #
+    # @api private
+    def shortcut_path(shortcut)
+      self.shortcut_paths[shortcut]
     end
 
     # Returns a copy of itself.

data/lib/site_prism_vcr/patches/element.rb

@@ -0,0 +1,4 @@
+require_relative '../mixins/element'
+
+SitePrism::Page.extend(SPV::Mixins::Element)
+SitePrism::Section.extend(SPV::Mixins::Element)

data/lib/site_prism_vcr/patches/page.rb

@@ -1,39 +1,3 @@
-require 'forwardable'
+require_relative '../mixins/page'
 
-module SitePrism
-  class Page
-    extend Forwardable
-
-    def_delegator :@applier, :shift_event
-
-    class << self
-      def inherited(subclass)
-        # This code is required to allow subpages to inherit
-        # a defined adjuster block. Otherwise, that block should be
-        # duplicated in a subpage as well.
-        subclass.instance_variable_set(:@vcr_adjuster, @vcr_adjuster)
-      end
-
-      def vcr_options_for_load(&block)
-        @vcr_adjuster = block
-      end
-
-      def vcr_adjuster
-        @vcr_adjuster
-      end
-    end
-
-    def initialize(*args)
-      super
-
-      @applier = SPV::Applier.new(
-        self,
-        &self.class.vcr_adjuster
-      )
-    end
-
-    def load_and_apply_vcr(*args, &block)
-      shift_event { load(*args) }.apply_vcr(&block)
-    end
-  end
-end
+SitePrism::Page.send(:include, SPV::Mixins::Page)

data/lib/site_prism_vcr/version.rb

@@ -1,3 +1,3 @@
 module SPV
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/site_prism_vcr.rb

@@ -13,7 +13,7 @@ require 'site_prism_vcr/fixtures/converter'
 require 'site_prism_vcr/fixtures/manager'
 require 'site_prism_vcr/fixtures/handler'
 require 'site_prism_vcr/fixtures/modifiers/path'
-require 'site_prism_vcr/fixtures/modifiers/home_path'
+require 'site_prism_vcr/fixtures/modifiers/shortcut_path'
 require 'site_prism_vcr/fixtures/modifiers/relative_path'
 require 'site_prism_vcr/options'
 require 'site_prism_vcr/options_with_path'
@@ -22,4 +22,4 @@ require 'site_prism_vcr/dsl/adjuster'
 require 'site_prism_vcr/waiter'
 require 'site_prism_vcr/vcr_helpers'
 require 'site_prism_vcr/patches/page'
-require 'site_prism_vcr/patches/element_container'
+require 'site_prism_vcr/patches/element'

data/spec/integration/elements/apply_spec.rb

@@ -93,6 +93,10 @@ feature 'Elements > Apply Vcr' do
     let(:actor_without_home_path) { shift_click_event_to(:link_with_one_request) }
   end
 
+  it_behaves_like 'when a shorcut path is define' do
+    let(:actor) { 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) }

data/spec/integration/pages/custom_event_spec.rb

@@ -13,7 +13,7 @@ feature 'Pages > Load > Custom event' do
   end
 
   it 'loads fixtures on opening a page by click on a link' do
-    expect(one_request_page.displayed?).to be_true
+    expect(one_request_page.displayed?).to be_truthy
 
     expect(one_request_page).to have_content('Ned Stark')
   end

data/spec/integration/pages/load_spec.rb

@@ -27,6 +27,17 @@ feature 'Pages > Load' do
 
       expect(cat_owner).to have_content('Ned Stark')
     end
+
+    context 'when a subpage defines own fixtures' do
+      let(:test_app_page) { PageLoad::SubPageWithFixtures.new }
+
+      it 'subpage uses fixtures from the parent page and own fixtures' do
+        test_app_page.load_and_apply_vcr
+
+        expect(cat_owner).to have_content('Ned Stark')
+        expect(cat_owner).to have_content('Robb Stark')
+      end
+    end
   end
 
   it_behaves_like 'when a custom fixture is applied' do

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'bundler/setup'
 
 require 'rspec'
-require 'rspec/fire'
 require 'coveralls'
 
 require 'site_prism.vcr'
@@ -13,7 +12,9 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.include(RSpec::Fire)
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
 end
 
 VCR.configure do |c|

data/spec/spec_integration_helper.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 require 'capybara/rspec'
-require 'capybara/firebug'
 
 require 'support/test_app/test_app'
 require 'support/server'
@@ -13,8 +12,6 @@ Capybara.app =            TestApp
 Capybara.default_driver = :selenium
 HTTPI.log =               false
 
-Selenium::WebDriver::Firefox::Profile.firebug_version = '1.11.0'
-
 Capybara.server_port = Server.find_available_port
 
 VCR.configure do |c|

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

@@ -61,7 +61,7 @@ shared_examples 'when a home path is define' do
     end
   end
 
-  context 'when a home path is used to point to a cessette in a sub directory', mytest: true do
+  context 'when a home path is used to point to a cassette in a sub directory' do
     before do
       actor_without_home_path.public_send(action_method) do
         home_path 'custom'

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

@@ -0,0 +1,13 @@
+shared_examples 'when a shorcut path is define' do
+    before do
+      actor.public_send(action_method) do
+        shortcut_path 'c', 'custom'
+
+        fixtures [':c/bran_stark']
+      end
+    end
+
+  it 'applies a stored fixture in the directory defined in the shorcut path' do
+    expect(cat_owner).to have_content('Bran Stark')
+  end
+end

data/spec/support/site_prism/pages/page_load/subpage_with_fixtures.rb

@@ -0,0 +1,14 @@
+require_relative './one_request'
+
+module PageLoad
+  class SubPageWithFixtures < OneRequestPage
+    set_url '/immediate-http-interactions/two-requests'
+
+    adjust_parent_vcr_options do
+      fixtures ['robb_stark']
+      waiter   &:wait_for_ned_stark_and_robb_stark
+
+      union
+    end
+  end
+end

data/spec/unit/applier_spec.rb

@@ -1,9 +1,31 @@
 require 'spec_helper'
 
 describe SPV::Applier do
+  shared_examples 'adjusting fixtures' do
+    it 'initializes the fixtures adjuster with proper options' do
+      expect(SPV::DSL::Adjuster).to receive(:new).with(
+        proper_options,
+        fixtures
+      )
+
+      do_action
+    end
+
+    it 'calls a given block within the context of the adjuster' do
+      expect(adjuster).to receive(:fixtures)
+
+      do_action
+    end
+
+    it 'receives the fixtures container' do
+      expect(adjuster).to receive(:prepare_fixtures)
+
+      do_action
+    end
+  end
+
   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(
@@ -13,14 +35,12 @@ describe SPV::Applier do
   end
 
   before do
-    SPV::Options.stub(:new).and_return(options)
-    SPV::DSL::InitialAdjuster.stub(:new).and_return(initial_adjuster)
-
-    SPV::Fixtures::Manager.stub(:new).and_return(fixtures_manager)
+    allow(SPV::Options).to receive(:new).and_return(options)
+    allow(SPV::DSL::InitialAdjuster).to receive(:new).and_return(initial_adjuster)
   end
 
   before do
-    SPV::DSL::InitialAdjuster.stub(:new).and_return(initial_adjuster)
+    allow(SPV::DSL::InitialAdjuster).to receive(:new).and_return(initial_adjuster)
   end
 
   describe '.new' do
@@ -42,9 +62,9 @@ describe SPV::Applier do
 
     context 'when a block is given' do
       it 'calls a given block within the context of the adjuster' do
-        expect(initial_adjuster).to receive(:mymeth)
+        expect(initial_adjuster).to receive(:home_path)
 
-        described_class.new(node) { mymeth }
+        described_class.new(node) { home_path 'test' }
       end
     end
 
@@ -59,61 +79,95 @@ describe SPV::Applier do
 
       subject
     end
+  end
 
-    it 'initializes the fixtures manager' do
-      expect(SPV::Fixtures::Manager).to receive(:new).with(
-        options
-      ).and_return(fixtures_manager)
+  describe '#alter_fixtures' do
+    let(:prepared_fixtures) { 'prepared_fixtures by adjuster' }
 
-      subject
+    let(:adjuster) do
+      instance_double(
+        'SPV::DSL::Adjuster',
+        fixtures:         true,
+        prepare_fixtures: prepared_fixtures
+      )
+    end
+
+    let(:do_action) { applier.alter_fixtures { fixtures [] } }
+
+    subject(:applier) { described_class.new(node) { } }
+
+    before do
+      allow(SPV::DSL::Adjuster).to receive(:new).and_return(adjuster)
+    end
+
+    it_behaves_like 'adjusting fixtures' do
+      let(:proper_options) { options }
     end
   end
 
   describe '#apply_vcr' do
-    let(:node)        { double('node of DOM', click: true) }
+    let(:node)             { double('node of DOM', click: true) }
+    let(:cloned_options)   { 'cloned options' }
+    let(:options)          { instance_double('SPV::Options', clone_options: cloned_options) }
+
+    let(:fixtures_manager) { instance_double('SPV::Fixtures::Manager', inject: true) }
+
     subject(:applier) { described_class.new(node) { } }
 
     context 'when an event is shifted' do
-      let(:cloned_options)    { 'cloned options' }
-      let(:options)           { instance_double('SPV::Options', clone_options: cloned_options) }
-      let(:prepared_fixtures) { 'prepared_fixtures by adjuster' }
-
-      let(:adjuster) do
-        instance_double(
-          'DSL::Adjuster',
-          fixtures:         true,
-          prepare_fixtures: prepared_fixtures
-        )
-      end
-
       before do
-        SPV::DSL::Adjuster.stub(:new).and_return(adjuster)
-        SPV::Waiter.stub(:wait)
+        allow(SPV::Fixtures::Manager).to receive(:inject).and_return(fixtures_manager)
+        allow(SPV::Waiter).to receive(:wait)
 
         applier.shift_event { node.click }
       end
 
-      it 'initializes the fixtures adjuster with a new instance of options' do
-        expect(SPV::DSL::Adjuster).to receive(:new).with(
-          cloned_options,
-          fixtures
-        )
+      context 'when the adjusting block is given' do
+        let(:prepared_fixtures) { 'prepared_fixtures by adjuster' }
 
-        applier.apply_vcr
-      end
+        let(:adjuster) do
+          instance_double(
+            'SPV::DSL::Adjuster',
+            fixtures:         true,
+            prepare_fixtures: prepared_fixtures
+          )
+        end
 
-      context 'when a block is given' do
-        it 'calls a given block within the context of the adjuster' do
-          expect(adjuster).to receive(:fixtures)
+        let(:do_action) { applier.apply_vcr { fixtures [] } }
 
-          applier.apply_vcr { fixtures }
+        before do
+          allow(SPV::DSL::Adjuster).to receive(:new).and_return(adjuster)
+        end
+
+        it_behaves_like 'adjusting fixtures' do
+          let(:proper_options) { cloned_options }
+        end
+
+        it 'applies the adjusted fixtures' do
+          expect(SPV::Fixtures::Manager).to receive(:inject).with(
+            prepared_fixtures,
+            cloned_options
+          )
+
+          do_action
         end
       end
 
-      it 'applies fixtures' do
-        expect(fixtures_manager).to receive(:inject).with(prepared_fixtures)
+      context 'when the adjusting block is not given' do
+        it 'does not initialize the fixture adjuster' do
+          expect(SPV::DSL::Adjuster).to_not receive(:new)
 
-        applier.apply_vcr
+          applier.apply_vcr
+        end
+
+        it 'applies the default fixtures' do
+          expect(SPV::Fixtures::Manager).to receive(:inject).with(
+            fixtures,
+            cloned_options
+          )
+
+          applier.apply_vcr
+        end
       end
 
       it 'does the click action over a node' do
@@ -137,7 +191,7 @@ describe SPV::Applier 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'
+          'Event is not shifted, before applying VCR you have to shift event with "shift_event" method'
         )
       end
     end

data/spec/unit/dsl/adjuster_spec.rb

@@ -19,7 +19,7 @@ describe SPV::DSL::Adjuster do
   }
 
   before do
-    SPV::Fixtures::TmpKeeper.stub(:new).and_return(tmp_keeper)
+    allow(SPV::Fixtures::TmpKeeper).to receive(:new).and_return(tmp_keeper)
   end
 
   subject { described_class.new(options, fixtures) }
@@ -57,17 +57,17 @@ describe SPV::DSL::Adjuster do
     let(:handled_new_fixtures) { ['old fixture'] }
 
     before do
-      SPV::Fixtures::Handler.stub(:new).and_return(fixtures_handler)
-      SPV::Fixtures::Modifiers::HomePath.stub(:new).and_return(home_path_modifier)
+      allow(SPV::Fixtures::Handler).to receive(:new).and_return(fixtures_handler)
+      allow(SPV::Fixtures::Modifiers::ShortcutPath).to receive(:new).and_return(home_path_modifier)
 
-      fixtures_handler.stub(:handle_set_raws).and_return([
+      allow(fixtures_handler).to receive(:handle_set_raws).and_return([
         handled_old_fixtures,
         handled_new_fixtures
       ])
     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)
 
       exchange
     end
@@ -108,7 +108,7 @@ describe SPV::DSL::Adjuster do
       let(:replaced_fixtures) { 'replaced fixtures' }
 
       before do
-        fixtures.stub(:replace).and_return(replaced_fixtures)
+        allow(fixtures).to receive(:replace).and_return(replaced_fixtures)
 
         subject.replace
       end
@@ -128,7 +128,7 @@ describe SPV::DSL::Adjuster do
       let(:new_fixtures) { 'new fixtures' }
 
       before do
-        fixtures.stub(:union).and_return(new_fixtures)
+        allow(fixtures).to receive(:union).and_return(new_fixtures)
         subject.union
       end