lopata 0.1.12 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f89b815ebe8514f78c803eab2bd2ece867e9fcdc9c28c178a721d717fd0341
-  data.tar.gz: c418371982133703b0b97921fd870937052854e6975b4bb47f664105c56ed6b6
+  metadata.gz: 774b79e80dea037bec71641e42289e46c8b756e7928fb2d928e448ccf9de7429
+  data.tar.gz: 262c23ee9ab55b1d3258bd41124ccce45bdb968b5afeeb67b778a30c293adc80
 SHA512:
-  metadata.gz: d54572c90bfdaea0aa91747541016d0d0b1ac1710a9d9a54c8278861643a07f5a8ea7157206a85cbaf3f3986c0dbabd14bfa741a5ce7eb7deb6bd2917d2d6b89
-  data.tar.gz: 3d82e45bd0fd6c2901c65a4a07437a27df8b8367e1682a67b191f4829bb6bf2a11b583f319804e560e08774f806c675d82547bdb87fec623a1d6fb143d9d2b72
+  metadata.gz: 6415bf6ab545f56a68cd8b6cf84c7f1e4a8322fc8615afd782b86590cb458bc64c493ac783ab952fc76ab085e0c4080cf85750bc6e4da120685775f4a6b7970a
+  data.tar.gz: d75b4a44b1ca80254b6ffca2822a166b263131facc4cef869fb0df4c437987ad421a716933eb356dce37bf742066613e384ce63478b9ab1c11be1660834519d9

data/README.md

@@ -1,26 +1,26 @@
-# Lopata
-
-Functional acceptance testing using Ruby.
-
-## Installation
-
-    gem install lopata
-
-## Usage
-
-Create new lopata project:
-
-    lopata new <project-name>
-
-Setup environment: edit <project-name>/config/environments/qa.yml for setup project for testing.
-
-Write tests: puts tests in <project-name>/scenarios folder. Define shared steps in <project-name>/shared_steps folder.
-
-Run tests:
-
-    cd <project-name>
-    lopata
-
-## Documentation
-
+# Lopata
+
+Functional acceptance testing using Ruby.
+
+## Installation
+
+    gem install lopata
+
+## Usage
+
+Create new lopata project:
+
+    lopata new <project-name>
+
+Setup environment: edit <project-name>/config/environments/qa.yml for setup project for testing.
+
+Write tests: puts tests in <project-name>/scenarios folder. Define shared steps in <project-name>/shared_steps folder.
+
+Run tests:
+
+    cd <project-name>
+    lopata
+
+## Documentation
+
 See [features description](https://github.com/avolochnev/lopata/tree/master/features) for documentation.

data/exe/lopata

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-require 'bundler/setup'
-require 'lopata/runner'
-
-# use default command with arguments if given command is unknown.
-argv = ARGV.dup
-unless Lopata::Runner.all_commands.keys.map(&:to_s).include? argv.first
-  argv.unshift 'test'
-end
-
-Lopata::Runner.start argv
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'lopata/runner'
+
+# use default command with arguments if given command is unknown.
+argv = ARGV.dup
+unless Lopata::Runner.all_commands.keys.map(&:to_s).include? argv.first
+  argv.unshift 'test'
+end
+
+Lopata::Runner.start argv

data/lib/lopata.rb

@@ -1,74 +1,123 @@
-require 'lopata/id'
-require 'lopata/configuration'
-require 'lopata/environment'
-require 'lopata/scenario_builder'
-require 'lopata/scenario'
-require 'lopata/step'
-require 'lopata/shared_step'
-
-# Namespace for all Lopata code.
-module Lopata
-  # Define the scenario.
-  # @see Lopata::ScenarioBuilder.define
-  def self.define(*args, &block)
-    Lopata::ScenarioBuilder.define(*args, &block)
-  end
-
-  # Skip scenario definition. Option to temporary ignore scenario
-  def self.xdefine(*args, &block)
-  end
-
-  # Register the shared step
-  #
-  # @example
-  #     Lopata.shared_step 'test user' do
-  #       setup { @user = create(:user) }
-  #     end
-  #
-  # Shared step may be used in scenarios by name:
-  # @example
-  #     Lopata.define 'user' do
-  #       setup 'test user'
-  #
-  #       it 'exists' do
-  #         expect(@user).to_not be_nil
-  #       end
-  #     end
-  # @param name [String] shared step unique name
-  # @param block [Block] shared step action sequence definition
-  def self.shared_step(name, &block)
-    Lopata::SharedStep.register(name, &block)
-  end
-
-  # Yields the global configuration to a block.
-  # @yield [Lopata::Configuration] global configuration
-  #
-  # @example
-  #     Lopata.configure do |config|
-  #       config.before_scenario 'setup test user'
-  #     end
-  # @see Lopata::Configuration
-  def self.configure(&block)
-    yield Lopata.configuration
-  end
-
-  # Returns global configuration object.
-  # @return [Lopata::Configuration]
-  # @see Lopata.configure
-  def self.configuration
-    @configuration ||= Lopata::Configuration.new
-  end
-
-  # @private
-  # Internal container for global non-configuration data.
-  def self.world
-    @world ||= Lopata::World.new
-  end
-
-  # Return global environment object
-  # @return [Lopata::Environment]
-  # @see Lopata::Environment
-  def self.environment
-    Lopata.configuration.environment
-  end
-end
+require 'lopata/id'
+require 'lopata/configuration'
+require 'lopata/environment'
+require 'lopata/scenario_builder'
+require 'lopata/scenario'
+require 'lopata/step'
+require 'lopata/shared_step'
+
+# Namespace for all Lopata code.
+module Lopata
+  # Define the scenario.
+  # @see Lopata::ScenarioBuilder.define
+  def self.define(*args, &block)
+    Lopata::ScenarioBuilder.define(*args, &block)
+  end
+
+  # Skip scenario definition. Option to temporary ignore scenario
+  def self.xdefine(*args, &block)
+  end
+
+  # Register the shared step
+  #
+  # @example
+  #     Lopata.shared_step 'test user' do
+  #       setup { @user = create(:user) }
+  #     end
+  #
+  # Shared step may be used in scenarios by name:
+  # @example
+  #     Lopata.define 'user' do
+  #       setup 'test user'
+  #
+  #       it 'exists' do
+  #         expect(@user).to_not be_nil
+  #       end
+  #     end
+  # @param name [String] shared step unique name
+  # @param block [Block] shared step action sequence definition
+  def self.shared_step(name, &block)
+    Lopata::SharedStep.register(name, &block)
+  end
+
+  # Register the shared step for setup.
+  # 
+  # shared_setup is a shortcat for shared_step 'name' { setup { .. } }. The block will be arrounded into the setup call.
+  #
+  # @example
+  #     Lopata.shared_setup 'test user' do
+  #       @user = create(:user)
+  #     end
+  #
+  # Shared step may be used in scenarios by name:
+  # @example
+  #     Lopata.define 'user' do
+  #       setup 'test user'
+  #
+  #       it 'exists' do
+  #         expect(@user).to_not be_nil
+  #       end
+  #     end
+  # @param name [String] shared step unique name
+  # @param block [Block] shared setup definition
+  def self.shared_setup(name, &block)
+    Lopata::SharedStep.register(name) do
+      setup(&block)
+    end
+  end
+
+  # Register the shared step for context.
+  # 
+  # shared_context is a shortcat for shared_step('name') { context('name') { .. } }. The block will be arrounded into the context call.
+  #
+  # @example
+  #     Lopata.shared_context 'calculation' do
+  #       it('correct') { expect(1 + 1).to eq 2 }
+  #       it('incorrect') { expect(1 + 2).to eq 4 }
+  #     end
+  #
+  # Shared context may be used in scenarios by name:
+  # @example
+  #     Lopata.define 'verify calcuation in context' do
+  #       verify 'calculation'
+  #     end
+  # @param name [String] shared step unique name, will be used as a context's name
+  # @param block [Block] shared context definition
+  def self.shared_context(name, &block)
+    Lopata::SharedStep.register(name) do
+      context(name, &block)
+    end
+  end
+
+  # Yields the global configuration to a block.
+  # @yield [Lopata::Configuration] global configuration
+  #
+  # @example
+  #     Lopata.configure do |config|
+  #       config.before_scenario 'setup test user'
+  #     end
+  # @see Lopata::Configuration
+  def self.configure(&block)
+    yield Lopata.configuration
+  end
+
+  # Returns global configuration object.
+  # @return [Lopata::Configuration]
+  # @see Lopata.configure
+  def self.configuration
+    @configuration ||= Lopata::Configuration.new
+  end
+
+  # @private
+  # Internal container for global non-configuration data.
+  def self.world
+    @world ||= Lopata::World.new
+  end
+
+  # Return global environment object
+  # @return [Lopata::Environment]
+  # @see Lopata::Environment
+  def self.environment
+    Lopata.configuration.environment
+  end
+end

data/lib/lopata/active_record.rb

@@ -1,136 +1,136 @@
-module Lopata
-  # Helpers for ActiveRecord usage in tests.
-  #
-  # Make helpers available in scenarios by
-  #
-  #     require 'lopata/active_record'
-  #
-  # @example
-  #
-  #     # Configure db connection at config/environments/qa.yml like rails:
-  #     # db:
-  #     #   adapter: postgresql
-  #     #   host: your.database.host
-  #     #   username: username
-  #     #   password: password
-  #     #   database: database
-  #     require 'active_record'
-  #     require 'lopata/active_record'
-  #
-  #     class User < ActiveRecord::Base; end
-  #
-  #     Lopata.define 'User creation' do
-  #       setup do
-  #         @user = User.create!(username: 'testuser')
-  #       end
-  #       # Remove user from database after scenario
-  #       cleanup :user
-  #
-  #       it 'works' do
-  #         expect(@user).to_not be_nil
-  #       end
-  #     end
-  #
-  module ActiveRecord
-    # To be included in Lopata::Scenario. The methods may be used in runtime.
-    module Methods
-      # Destroy ActiveRecord objects.
-      #
-      # Does nothing if 'keep' mode is enabled:
-      #
-      #     Lopata.configure do |c|
-      #       c.keep = true
-      #     end
-      #
-      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be destroyed
-      # @see Lopata::Configuration#keep
-      def cleanup(*objects)
-        return if Lopata.configuration.keep
-        objects.flatten.compact.each do |o|
-          begin
-            o.reload.destroy!
-          rescue ::ActiveRecord::RecordNotFound
-            # Already destroyed - skip
-          rescue ::ActiveRecord::InvalidForeignKey
-            # Possible async job created new relationships (e.g. history records). Try again once.
-            o.reload.destroy!
-          end
-        end
-      end
-
-      # Reload ActiveRecord objects
-      #
-      # @example
-      #
-      #     # use in steps
-      #     reload @a, @b
-      #     # instead of
-      #     @a.reload; @b.reload
-      #
-      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be reloaded
-      def reload(*objects)
-        objects.flatten.compact.each(&:reload)
-      end
-
-      # Marks object to be destroyed at the end of scenario
-      #
-      # @param object [ActiveRecord::Base] the object to be destoryed at the end of scenario
-      # @return the given object, so chains can be build
-      def cleanup_later(object)
-        return nil unless object
-        @created_objects ||= []
-        @created_objects << object
-        object
-      end
-
-      # Find ActiveRecord object of given class by params.
-      # Marks the returned object to be destroyed at the end of scenario.
-      #
-      # @example
-      #     action do
-      #       # UI actions creating the user
-      #       @user = find_created(User, username: 'testuser')
-      #     end
-      #     it 'created' do
-      #       expect(@user).to_not be_nil
-      #     end
-      #     # No cleanup needed
-      #     # cleanup :user
-      #
-      # @param cls [Class] active record model class
-      # @param params [Hash] options for record finding
-      # @return [ActiveRecord::Base, nil] the object or nil if not found
-      # @see #cleanup_later called on the hood
-      def find_created(cls, params)
-        cleanup_later cls.where(params).take
-      end
-    end
-
-    # To be included in Lopata::ScenarioBuilder. The methods may be used in build time.
-    module DSL
-      # Mark instance variables to call #destroy at teardown phase of scenario or context running.
-      #
-      # Does nothing if 'keep' mode is enabled.
-      #
-      # @param vars [Array<Symbol, String>] instance variable names to be destroyed on teardown phase.
-      def cleanup(*vars, &block)
-        unless vars.empty?
-          teardown do
-            cleanup vars.map { |v| instance_variable_get "@#{v}" }
-          end
-        end
-        teardown &block if block_given?
-      end
-    end
-  end
-end
-
-Lopata.configure do |c|
-  c.after_scenario { cleanup @created_objects }
-end
-
-params = Lopata.environment['db']
-ActiveRecord::Base.establish_connection(params) if params
-
-Lopata::Scenario.include Lopata::ActiveRecord::Methods
+module Lopata
+  # Helpers for ActiveRecord usage in tests.
+  #
+  # Make helpers available in scenarios by
+  #
+  #     require 'lopata/active_record'
+  #
+  # @example
+  #
+  #     # Configure db connection at config/environments/qa.yml like rails:
+  #     # db:
+  #     #   adapter: postgresql
+  #     #   host: your.database.host
+  #     #   username: username
+  #     #   password: password
+  #     #   database: database
+  #     require 'active_record'
+  #     require 'lopata/active_record'
+  #
+  #     class User < ActiveRecord::Base; end
+  #
+  #     Lopata.define 'User creation' do
+  #       setup do
+  #         @user = User.create!(username: 'testuser')
+  #       end
+  #       # Remove user from database after scenario
+  #       cleanup :user
+  #
+  #       it 'works' do
+  #         expect(@user).to_not be_nil
+  #       end
+  #     end
+  #
+  module ActiveRecord
+    # To be included in Lopata::Scenario. The methods may be used in runtime.
+    module Methods
+      # Destroy ActiveRecord objects.
+      #
+      # Does nothing if 'keep' mode is enabled:
+      #
+      #     Lopata.configure do |c|
+      #       c.keep = true
+      #     end
+      #
+      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be destroyed
+      # @see Lopata::Configuration#keep
+      def cleanup(*objects)
+        return if Lopata.configuration.keep
+        objects.flatten.compact.each do |o|
+          begin
+            o.reload.destroy!
+          rescue ::ActiveRecord::RecordNotFound
+            # Already destroyed - skip
+          rescue ::ActiveRecord::InvalidForeignKey
+            # Possible async job created new relationships (e.g. history records). Try again once.
+            o.reload.destroy!
+          end
+        end
+      end
+
+      # Reload ActiveRecord objects
+      #
+      # @example
+      #
+      #     # use in steps
+      #     reload @a, @b
+      #     # instead of
+      #     @a.reload; @b.reload
+      #
+      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be reloaded
+      def reload(*objects)
+        objects.flatten.compact.each(&:reload)
+      end
+
+      # Marks object to be destroyed at the end of scenario
+      #
+      # @param object [ActiveRecord::Base] the object to be destoryed at the end of scenario
+      # @return the given object, so chains can be build
+      def cleanup_later(object)
+        return nil unless object
+        @created_objects ||= []
+        @created_objects << object
+        object
+      end
+
+      # Find ActiveRecord object of given class by params.
+      # Marks the returned object to be destroyed at the end of scenario.
+      #
+      # @example
+      #     action do
+      #       # UI actions creating the user
+      #       @user = find_created(User, username: 'testuser')
+      #     end
+      #     it 'created' do
+      #       expect(@user).to_not be_nil
+      #     end
+      #     # No cleanup needed
+      #     # cleanup :user
+      #
+      # @param cls [Class] active record model class
+      # @param params [Hash] options for record finding
+      # @return [ActiveRecord::Base, nil] the object or nil if not found
+      # @see #cleanup_later called on the hood
+      def find_created(cls, params)
+        cleanup_later cls.where(params).take
+      end
+    end
+
+    # To be included in Lopata::ScenarioBuilder. The methods may be used in build time.
+    module DSL
+      # Mark instance variables to call #destroy at teardown phase of scenario or context running.
+      #
+      # Does nothing if 'keep' mode is enabled.
+      #
+      # @param vars [Array<Symbol, String>] instance variable names to be destroyed on teardown phase.
+      def cleanup(*vars, &block)
+        unless vars.empty?
+          teardown do
+            cleanup vars.map { |v| instance_variable_get "@#{v}" }
+          end
+        end
+        teardown &block if block_given?
+      end
+    end
+  end
+end
+
+Lopata.configure do |c|
+  c.after_scenario { cleanup @created_objects }
+end
+
+params = Lopata.environment['db']
+ActiveRecord::Base.establish_connection(params) if params
+
+Lopata::Scenario.include Lopata::ActiveRecord::Methods
 Lopata::ScenarioBuilder.include Lopata::ActiveRecord::DSL