site_prism.vcr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bea07665857e88334694b2c69c3d0ded874626cf
-  data.tar.gz: 7320da925829386acea9991b1572e0f93a9d0dd4
+  metadata.gz: f845bb94c87768204915d967e5f1264c2bea7e05
+  data.tar.gz: 1bbc6bbef92b1f871b85709dacf9b5c0288d3254
 SHA512:
-  metadata.gz: a7829ce24f5eab5d1a203712c9d38a362b0607af3f1cfd4c1d0c0b12d386f2c9b829ed1e06589940a9a471f7089094f15bf30fee9d8b19d4813d2fe10eb45a8e
-  data.tar.gz: 9ad8f2da29c6039106b5a7d03333c88b21cc87950926ab15806df271b1e044e8c6f03bfaf2afd9d042af250d218cf4100465692766f2380663a9450211e66d6d
+  metadata.gz: cd19a64df6381ccb647ce83099b3589074efb45a8a0cf41cb40357ab3557113ccdb92a5a36f6b2935c827fd336f6a2793faca4f100ebab59f8678ad2294d82b8
+  data.tar.gz: 954c82bb43f16351b039a853850ad00e9a300f9696fc8c8ea87aee3752b348be9cd7084dd803349e68d9c5352217619ce5f303d0cc5fcd65dc34c49de205229d

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.1
+  - 2.1.0
   - 2.0.0
   - 1.9.3
   - jruby-19mode

data/CHANGELOG.md

@@ -1,9 +1,33 @@
-# Version 0.1.0
+# 0.1.1
 
-## Changed
+  * fixed the issue with using replace and union actions in one block.
 
-  * dependencies. Now gem depends on Vcr 2.8.0 and SitePrism 2.5.
-  * re-factored the way how Vcr cassettes could be applying for any event of a page.
+  ```ruby
+    self.some_link.click_and_apply_vcr do
+      fixtures ['test', 'test2']
+      union
+      fixtures ['test3']
+      replace
+    end
+  ```
+
+  In some cases it may have leaded to unexpected behavior.
+  * internal improvements
+  * upgraded dependencies. Now gem depends on Vcr 2.9.2 and SitePrism 2.6.
+  * added possibility to use relative path with a home path.
+
+  ```ruby
+    self.some_link.click_and_apply_vcr do
+      home_path 'custom'
+
+      fixtures ['~/../test'] # '~' indicates a home path which is defined above in this block
+    end
+  ```
+
+# 0.1.0
+
+  * upgraded dependencies. Now gem depends on Vcr 2.8.0 and SitePrism 2.5.
+  * BREAKING CHANGE: re-factored the way how Vcr cassettes could be applying for any event of a page.
     Before that change we had to use ugly way
 
   ```ruby
@@ -24,9 +48,7 @@
     end
   ```
 
-## Fixed
-
-  * the issue with defining an action to be done over cassettes in the adjusting block. Now even if an action is defined before a list of cassettes, the adjusting block will be performed properly
+  * fixed the issue with defining an action to be done over cassettes in the adjusting block. Now even if an action is defined before a list of cassettes, the adjusting block will be performed properly
 
   ```ruby
     @products_page.cars_dropdown.click_and_apply_vcr do
@@ -35,9 +57,7 @@
     end
   ```
 
-## Added
-
-  * possibility to apply Vcr cassettes for any event of an element. [Roman Rott and Dmitriy Nesteryuk]
+  * added possibility to apply Vcr cassettes for any event of an element. [Roman Rott and Dmitriy Nesteryuk]
 
   ```ruby
     @products_page.cars_dropdown.shift_event{
@@ -47,7 +67,7 @@
     end
   ```
 
-  * possibility to link Vcr with already defined elements, it will be helpful in case they are inherited
+  * added possibility to link Vcr with already defined elements, it will be helpful in case they are inherited
 
   ```ruby
     class CarsPage < TransportPage
@@ -60,7 +80,7 @@
     @page.transport_details_link.click_and_apply_vcr
   ```
 
-  * possibility to redefine default options for a default waiter
+  * added possibility to redefine default options for a default waiter
 
   ```ruby
     class ProductsPage < SitePrism::Page
@@ -75,4 +95,4 @@
     @page.details_link.click_and_apply_vcr do
       waiter_options(eject_cassettes: true) # redefines default options
     end
-  ```
+  ```

data/Gemfile

@@ -3,17 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in site_prism.vcr.gemspec
 gemspec
 
-group :development do
-  gem 'rspec', '~> 2.14.1'
-  gem 'sinatra'
-  gem 'httpi'
-  gem 'capybara-firebug'
-  gem 'sandi_meter'
-end
-
-group :test do
-  gem 'rspec-fire'
-  gem 'selenium-webdriver'
-  gem 'coveralls', require: false
-end
-
+gem 'sinatra'
+gem 'httpi'
+gem 'capybara-firebug'
+gem 'sandi_meter'
+
+gem 'rspec', '~> 2.14.1'
+gem 'rspec-fire'
+gem 'selenium-webdriver', '~> 2.41.0'
+gem 'coveralls', require: false

data/README.md

@@ -147,6 +147,20 @@ class ProductsPage < SitePrism::Page
 end
 ```
 
+Sometimes you need to specify a cassette which lies in a parent directory of a home path, in this case you can use a relative path with a home path:
+
+```ruby
+class ProductsPage < SitePrism::Page
+  element_with_vcr \
+    :car_details_link,
+    '#car_details' do
+      home_path 'cars/small'
+
+      fixture ['~/../ford']
+    end
+end
+```
+
 ### Applying VCR cassettes on click
 
 Cassettes can be applied on a click event:

data/TODO.md

@@ -1,23 +1,16 @@
 # TODO
 
-## Release 0.1.1
+## Release 0.1.2
 
-1. Change integration tests to use real data.
-2. Think how to avoid monkey patching to add stuffs to SitePrism
-3. SPV::Applier#apply_vcr should be refactored, it is too complex
-4. Think about renaming current integration tests on acceptance tests and create new integration tests which will test integration between classes without involving a browser. It will solve a lot of issues with shared tests to check the same things for pages and elements. In acceptance tests we will test very basic stuffs.
-5. We should freeze an instance of SPV::Fixtures to make sure it is not mutable, otherwise, there may be situation when default fixtures will be corrupted.
-6. We should disable double defining actions in the adjusting block:
+1. Think how to avoid monkey patching to add stuffs to SitePrism
+2. Change code to use DI with build (http://solnic.eu/2013/12/17/the-world-needs-another-post-about-dependency-injection-in-ruby.html)
+3. Think about using something like:
 
   ```ruby
-    self.some_link.click_and_apply_vcr do
-      fixtures ['test', 'test2']
-      union
-      fixtures ['test3']
-      replace
-    end
+    ~/../bundle_offerings
   ```
-It will lead to mess.
+
+when define a path to a fixture, for that we can use a standard class Pathname of Ruby.
 
 ## Release 0.2.0
 
@@ -25,6 +18,7 @@ It will lead to mess.
 2. When we eject fixtures from Vcr we should eject only fixtures inserted into Vcr by one specific fixtures manager (See SPV#eject)
 3. Make this gem working on JRuby (since we eject all VCR cassettes, it may be not thread safe)
 4. Think about creating set of fixtures which can be exchanged by a name of set. It will be very helpful when you have to exchange a set of fixtures.
+5. Add code to not remove one specific cassete from VCR
 
 ## Should be implemented?
 
@@ -55,5 +49,7 @@ It will lead to mess.
 3. Should we add a test for testing to HTTP requests on page load?
 4. Should be Options class immutable?
 5. May be it makes sense to separately keep path from the name of a fixture? See SPV::Fixture class
+6. Think about renaming current integration tests on acceptance tests and create new integration tests which will test integration between classes without involving a browser. It will solve a lot of issues with shared tests to check the same things for pages and elements. In acceptance tests we will test very basic stuffs.
+7. May be SPV::Fixtures::TmpKeeper is redundant and SPV::Fixtures can be used as a tmp keeper of fixtures?
 
 

data/lib/site_prism_vcr/applier.rb

@@ -35,11 +35,7 @@ module SPV
     #
     # @return [void]
     def apply_vcr(&block)
-      if @event_action.nil?
-        raise EventError.new(
-          'Event is not shifted, before applying Vcr you have to shift event with "shift_event" method'
-        )
-      end
+      verify_define_event!
 
       options = @options.clone_options
 
@@ -56,13 +52,18 @@ module SPV
 
       @event_action.call
 
-      @waiter = Waiter.new(
+      Waiter.wait(
         @node,
         @fixtures_manager,
         options
       )
-
-      @waiter.wait
     end
-  end
-end
+
+    private
+      def verify_define_event!
+        raise EventError.new(
+          'Event is not shifted, before applying Vcr you have to shift event with "shift_event" method'
+        ) if @event_action.nil?
+      end
+  end # class Applier
+end # module SPV

data/lib/site_prism_vcr/dsl/adjuster.rb

@@ -1,5 +1,7 @@
 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
@@ -7,7 +9,7 @@ module SPV
         super options
 
         @options, @fixtures = options, fixtures
-        @action = :replace
+        @action = Action.new(:replace)
       end
 
       # Defines the replace action as an action which
@@ -26,7 +28,7 @@ module SPV
       #
       # @api public
       def replace
-        @action = :replace
+        @action.action = :replace
       end
 
       # Defines the union action as an action which
@@ -45,7 +47,7 @@ module SPV
       #
       # @api public
       def union
-        @action = :union
+        @action.action = :union
       end
 
       # Exchanges certain default fixtures with another fixtures.
@@ -91,13 +93,35 @@ module SPV
 
       # 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, @tmp_keeper.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

data/lib/site_prism_vcr/dsl/initial_adjuster.rb

@@ -19,7 +19,10 @@ module SPV
       def fixtures(list)
         prepared_fixtures = @fixtures_handler.handle_raw(
           list,
-          [Fixtures::Modifiers::HomePath.new(@options)]
+          [
+            Fixtures::Modifiers::HomePath.new(@options),
+            Fixtures::Modifiers::RelativePath.new(@options)
+          ]
         )
 
         @tmp_keeper.add_fixtures(prepared_fixtures)

data/lib/site_prism_vcr/fixture.rb

@@ -1,19 +1,29 @@
+require 'pathname'
+
 module SPV
-  # Keeps a path to fixture and options which should be
+  # Keeps a path to a fixture and options which should be
   # passed to Vcr while inserting a cassette
   class Fixture
-    attr_accessor :name, :options
+    attr_accessor :options, :path
 
     def initialize(name, vcr_options = {})
-      @name, @options = name, vcr_options
+      path = Pathname.new(name)
+
+      @fixture_name = path.basename
+      @path         = path.dirname
+      @options      = vcr_options
+    end
+
+    def name
+      (self.path + @fixture_name).to_path
     end
 
-    def add_path(path)
-      self.name = path + name
+    def path=(val)
+      @path = Pathname.new(val)
     end
 
     def set_home_path(home_path)
-      self.name = self.name.gsub(/\A\~\//, home_path)
+      self.path = self.path.to_path.gsub(/\A(\~\/|\~)/, home_path)
     end
 
     def has_link_to_home_path?
@@ -22,7 +32,7 @@ module SPV
 
     # Returns a name without a link to a home path
     def clean_name
-      self.name[2..-1]
+      @fixture_name.to_path
     end
-  end
-end
+  end # class Fixture
+end # module SPV

data/lib/site_prism_vcr/fixtures/converter.rb

@@ -1,5 +1,5 @@
 module SPV
-  # Converts raw fixtures into list of
+  # Converts list with fixture names into list of
   # SPV::Fixture objects.
   class Fixtures
     class Converter
@@ -12,6 +12,6 @@ module SPV
           end
         end
       end
-    end
-  end
-end
+    end # class Converter
+  end # class Fixtures
+end # module SPV

data/lib/site_prism_vcr/fixtures/handler.rb

@@ -1,7 +1,9 @@
 module SPV
   class Fixtures
-    # Prepares incoming raw fixtures to be used for inserting
-    # into VCR
+    # Prepares incoming raw list of fixtures to be used for inserting
+    # into VCR.
+    #
+    # Applies a given list of modifiers to list of fixtures.
     class Handler
       def initialize(options, convertor = Converter)
         @options = options
@@ -26,6 +28,6 @@ module SPV
           handle_raw fixtures_raw, modifiers
         end
       end
-    end
-  end
-end
+    end # class Handler
+  end # class Fixtures
+end # module SPV

data/lib/site_prism_vcr/fixtures/manager.rb

@@ -9,7 +9,7 @@ module SPV
 
       # Injects given fixtures to Vcr.
       #
-      # @param fixtures [Array<SPV::Fixture>] List of fixtures.
+      # @param fixtures [SPV::Fixtures] List of fixtures.
       #
       # @return [void]
       #
@@ -33,6 +33,6 @@ module SPV
       def eject
         SPV::Helpers.eject_all_cassettes
       end
-    end
-  end
-end
+    end # class Manager
+  end # class Fixtures
+end # module SPV

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

@@ -0,0 +1,11 @@
+module SPV
+  class Fixtures
+    module Modifiers
+      class Base
+        def initialize(options)
+          @options = options
+        end
+      end # class Base
+    end # module Modifiers
+  end # class Fixtures
+end # module SPV

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

@@ -1,13 +1,11 @@
+require_relative 'base'
+
 module SPV
   class Fixtures
     module Modifiers
       # It takes a fixture and replaces "~/" with
-      # a defined home path
-      class HomePath
-        def initialize(options)
-          @options = options
-        end
-
+      # a defined home path.
+      class HomePath < Base
         def modify(fixture)
           if fixture.has_link_to_home_path?
             if @options.home_path

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

@@ -1,12 +1,10 @@
+require_relative 'base'
+
 module SPV
   class Fixtures
     module Modifiers
-      # It takes a fixture and adds a path to it
-      class Path
-        def initialize(options)
-          @options = options
-        end
-
+      # It takes a fixture and adds a path to it.
+      class Path < Base
         def modify(fixture)
           if fixture.has_link_to_home_path?
             raise HomePathError.new(
@@ -19,7 +17,7 @@ module SPV
             path = @options.path
             path = path + '/' unless path[-1, 1] == '/'
 
-            fixture.add_path(path)
+            fixture.path = path
           end
         end
 

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

@@ -0,0 +1,21 @@
+require 'pathname'
+require_relative 'base'
+
+module SPV
+  class Fixtures
+    module Modifiers
+      # It allows to move up through a hierarchy of directories.
+      #
+      # Example:
+      #  ~/../some_fixture
+      #
+      class RelativePath < Base
+        def modify(fixture)
+          path = Pathname.new(fixture.path)
+
+          fixture.path = path.cleanpath.to_path
+        end
+      end
+    end
+  end
+end

data/lib/site_prism_vcr/fixtures.rb

@@ -37,5 +37,5 @@ module SPV
     def size
       @container.values
     end
-  end
-end
+  end # class Fixtures
+end # module SPV

data/lib/site_prism_vcr/options.rb

@@ -1,4 +1,7 @@
 module SPV
+  # Keeps options which are used to identify path to fixtures
+  # and options for a waiter which holds execution until expectation
+  # has been met.
   class Options
     attr_accessor :waiter, :waiter_options, :home_path
 
@@ -8,16 +11,34 @@ module SPV
       end
     end
 
+    # Defines path to fixtures.
+    #
+    # @param val [String] Path to fixtures.
+    #
+    # @return [void]
+    #
+    # @api private
     def home_path=(val)
       val << '/' unless val[-1, 1] == '/'
 
       @home_path = val
     end
 
+    # Returns a copy of itself.
+    #
+    # @return [SPV::Options]
+    #
+    # @api private
     def clone_options
       dup
     end
 
+    # Returns options of a waiter in a hash format.
+    # If no options are defined, returns an empty hash.
+    #
+    # @return [Hash]
+    #
+    # @api private
     def waiter_options
       @waiter_options || {}
     end
@@ -26,8 +47,12 @@ module SPV
     #
     # If waiter's options are not defined yet, it will define waiter options
     # with a given hash.
+    #
+    # @return [void]
+    #
+    # @api private
     def merge_waiter_options!(options)
       self.waiter_options = self.waiter_options.merge(options)
     end
-  end
-end
+  end # class Options
+end # module SPV

data/lib/site_prism_vcr/version.rb

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

data/lib/site_prism_vcr/waiter.rb

@@ -1,5 +1,11 @@
 module SPV
   class Waiter
+    def self.wait(node, fixtures_manager, options)
+      waiter = new(node, fixtures_manager, options)
+      waiter.wait
+      waiter
+    end
+
     def initialize(node, fixtures_manager, options)
       @node, @waiter_method = node, options.waiter
       @fixtures_manager = fixtures_manager

data/lib/site_prism_vcr.rb

@@ -14,6 +14,7 @@ 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/relative_path'
 require 'site_prism_vcr/options'
 require 'site_prism_vcr/options_with_path'
 require 'site_prism_vcr/dsl/initial_adjuster'

data/site_prism.vcr.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['nesterukd@gmail.com']
   spec.description   = 'This gem integrates VCR library into SitePrism'
   spec.summary       = 'VCR and SitePrism are awesome libraries. But, it is a bit difficult to work with them without some bridge between them. This gem combines these 2 libraries to provide a better way for stubbing external API request which your application is doing. This gem will be very helpful for developers which have an application working with an external API.'
-  spec.homepage      = 'https://github.com/nestd/site_prism.vcr'
+  spec.homepage      = 'http://github.com/dnesteryuk/site_prism.vcr'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -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.5'
-  spec.add_dependency 'vcr',        '~> 2.8.0'
+  spec.add_dependency 'site_prism', '~> 2.6'
+  spec.add_dependency 'vcr',        '~> 2.9.0'
   spec.add_dependency 'webmock'
 end