dnesteryuk/site_prism.vcr

module SPV
  module DSL
    class DoubleActionError < StandardError; end

    # This class extends SPV::DSL::InitialAdjuster with new methods
    # which can be used in a block for manipulating fixtures before applying them.
    class Adjuster < InitialAdjuster
      def initialize(options, fixtures)
        super options

        @options, @fixtures = options, fixtures
        @action = Action.new(:replace)
      end

      # Defines the replace action as an action which
      # will be performed over cassettes while adjusting cassettes.
      #
      # Example:
      #   @page.details_link.click_and_apply_vcr do
      #     fixtures ['no_found']
      #     replace
      #   end
      #
      # In this case 'no_found' cassette will be used instead
      # of default cassettes defined for 'details_link'.
      #
      # @return [void]
      #
      # @api public
      def replace
        @action.action = :replace
      end

      # Defines the union action as an action which
      # will be performed over cassettes while adjusting cassettes.
      #
      # Example:
      #   @page.details_link.click_and_apply_vcr do
      #     fixtures ['no_found']
      #     union
      #   end
      #
      # In this case 'no_found' cassette will be used a long with
      # default cassettes.
      #
      # @return [void]
      #
      # @api public
      def union
        @action.action = :union
      end

      # Exchanges certain default fixtures with another fixtures.
      #
      # @param old_fixtures [String, Array<String>] List of fixtures which should be removed.
      #   If string is passed instead of an array, it will be converted to an array.
      # @param new_fixtures [String, Array<String>] List of fixtures which should added.
      #   If string is passed instead of an array, it will be converted to an array.
      #
      # @return [void]
      #
      # @api public
      def exchange(old_fixtures, new_fixtures)
        home_path_modifier = Fixtures::Modifiers::ShortcutPath.new(@options)

        old_fixtures = [old_fixtures] unless old_fixtures.is_a?(Array)
        new_fixtures = [new_fixtures] unless new_fixtures.is_a?(Array)

        old_fixtures, new_fixtures = @fixtures_handler.handle_set_raws(
          old_fixtures,
          new_fixtures,
          [home_path_modifier]
        )

        @fixtures = @fixtures.exchange(
          old_fixtures,
          new_fixtures
        )
      end

      # Redefines default waiter options or if default waiter options is not defined,
      # it defines new options for a waiter. This method doesn't redefine all default options,
      # it redefines only options passed in a hash.
      #
      # @param options [Hash] Options for a waiter
      #
      # @return [void]
      #
      # @api public
      def waiter_options(options)
        @options.merge_waiter_options!(options)
      end

      # Performs the replace action when no explicit action is defined
      # in a block for manipulating fixtures before applying them.
      # Otherwise, performs a defined action (union or replace).
      #
      # @return [SPV::Fixtures] A set of prepared fixtures.
      #
      # @api public
      def prepare_fixtures
        @fixtures.public_send(
          @action.action,
          @tmp_keeper.fixtures
        )
      end

      # @private
      class Action
        attr_reader :action

        def initialize(default_action)
          @defined_actions, @action = Set.new, default_action
        end

        def action=(val)
          @action = val
          @defined_actions << val

          raise SPV::DSL::DoubleActionError.new(
            'You cannot use "replace" and "union" actions together. It may lead to unexpected behavior.'
          ) if @defined_actions.size == 2
        end
      end # class Action
    end # class Adjuster
  end # module DSL
end # module SPV