lopata 0.1.3 → 0.1.8

data/lib/lopata/shared_step.rb

@@ -1,9 +1,11 @@
 module Lopata
+  # @private
   class SharedStep
     attr_reader :name, :block
 
     class NotFound < StandardError; end
 
+
     def self.register(name, &block)
       raise ArgumentError, "Comma is not allowed in shared step name: '%s'" % name if name =~ /,/
       registry[name] = new(name, &block)

data/lib/lopata/step.rb

@@ -1,27 +1,25 @@
+require 'forwardable'
+
 module Lopata
+  # @private
   class Step
-    attr_reader :block, :args, :condition, :method_name, :shared_step, :group
+    attr_reader :block, :args, :condition, :method_name, :shared_step
     # metadata overrien by the step.
     attr_accessor :metadata
 
-    def initialize(method_name, *args, condition: nil, shared_step: nil, group: nil, &block)
+    def initialize(method_name, *args, condition: nil, shared_step: nil, &block)
       @method_name = method_name
       @args = args
       @block = block
       @shared_step = shared_step
       @condition = condition
-      @group = group
       initialized! if defined? initialized!
     end
 
     def title
       base_title = args.first
       base_title ||= shared_step && "#{method_name.capitalize} #{shared_step.name}" || "Untitled #{method_name}"
-      if group
-        "#{group.title}: #{base_title}"
-      else
-        base_title
-      end
+      base_title
     end
 
     def execution_steps(scenario, groups: [])
@@ -31,7 +29,8 @@ module Lopata
     end
   end
 
-  # Used for action, setup, teardown
+  # @private
+  # Used for action, setup, teardown, verify
   class ActionStep < Step
     def execution_steps(scenario, groups: [])
       steps = []
@@ -67,14 +66,11 @@ module Lopata
     end
 
     def title
-      if group
-        "%s: %s" % [group.title, method_name]
-      else
-        shared_step && "#{method_name.capitalize} #{shared_step.name}" || "Untitled #{method_name}"
-      end
+      shared_step && "#{method_name.capitalize} #{shared_step.name}" || "Untitled #{method_name}"
     end
   end
 
+  # @private
   # Used for context
   class GroupStep < Step
 
@@ -88,22 +84,26 @@ module Lopata
       steps.reject { |s| s.teardown_group?(self) } + steps.select { |s| s.teardown_group?(self) }
     end
 
+    def let_methods
+      @let_methods ||= {}
+    end
+
     private
 
     # Group step's block is a block in context of builder, not scenario. So hide the @block to not be used in scenario.
     def initialized!
       builder = Lopata::ScenarioBuilder.new(title)
-      builder.group = self
       builder.instance_exec(&@block)
       @steps = builder.steps
       @block = nil
     end
   end
 
+  #@private
   class StepExecution
     attr_reader :step, :status, :exception, :block, :pending_message, :groups
     extend Forwardable
-    def_delegators :step, :title, :method_name
+    def_delegators :step, :method_name
 
     class PendingStepFixedError < StandardError; end
 
@@ -115,9 +115,13 @@ module Lopata
       @groups = groups
     end
 
+    def title
+      group_title = groups.map { |g| "#{g.title}: " }.join
+      "#{group_title}#{step.title}"
+    end
+
     def run(scenario)
       @status = :running
-      world.notify_observers(:step_started, self)
       begin
         run_step(scenario)
         if pending?
@@ -130,7 +134,6 @@ module Lopata
         @status = :failed unless pending?
         @exception = e
       end
-      world.notify_observers(:step_finished, self)
     end
 
     def run_step(scenario)
@@ -138,10 +141,6 @@ module Lopata
       scenario.instance_exec(&block)
     end
 
-    def world
-      @world ||= Lopata::Config.world
-    end
-
     def failed?
       status == :failed
     end
@@ -181,7 +180,12 @@ module Lopata
 
     # Step metadata is a combination of metadata given for step and all contexts (groups) the step included
     def metadata
-      ([step] + groups).compact.inject({}) { |merged, part| merged.merge(part.metadata) }
+      (groups + [step]).compact.inject({}) { |merged, part| merged.merge(part.metadata) }
+    end
+
+    # Step methods is a combination of let_methods for all contexts (group) the step included
+    def let_methods
+      (groups).compact.inject({}) { |merged, part| merged.merge(part.let_methods) }
     end
   end
 end

data/lib/lopata/version.rb

@@ -1,5 +1,6 @@
 module Lopata
+  # @private
   module Version
-    STRING = '0.1.3'
+    STRING = '0.1.8'
   end
 end

data/lib/lopata/world.rb

@@ -1,29 +1,25 @@
+# Container for gobal non-configuration data
 class Lopata::World
+  # Scenarios are selected for current run
+  # @return [Array<Lopata::Scenario::Execution>]
   attr_reader :scenarios
 
+  # @private
   def initialize
     @scenarios = []
   end
 
-  def start
-    notify_observers(:started, self)
-  end
-
-  # Called at the end of test running.
-  #
-  # Notifies observers about testing finish
-  def finish
-    notify_observers(:finished, self)
-  end
-
+  # @private
   def notify_observers(event, context)
     observers.each do |observer|
       observer.send event, context
     end
   end
 
+  private
+
   # Define observers based on configuration
   def observers
-    @observers ||= [Lopata::Observers::ConsoleOutputObserver.new]
+    Lopata.configuration.observers
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lopata
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Alexey Volochnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-23 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -87,20 +87,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - README.md
 - exe/lopata
 - lib/lopata.rb
 - lib/lopata/active_record.rb
 - lib/lopata/condition.rb
-- lib/lopata/config.rb
+- lib/lopata/configuration.rb
+- lib/lopata/environment.rb
 - lib/lopata/factory_bot.rb
 - lib/lopata/generators/app.rb
-- lib/lopata/generators/templates/.rspec
 - lib/lopata/generators/templates/Gemfile
 - lib/lopata/generators/templates/Lopatafile
 - lib/lopata/generators/templates/config/environments/qa.yml
 - lib/lopata/generators/templates/config/initializers/capybara.rb
-- lib/lopata/generators/templates/spec/spec_helper.rb
 - lib/lopata/id.rb
 - lib/lopata/loader.rb
 - lib/lopata/observers.rb
@@ -108,8 +108,7 @@ files:
 - lib/lopata/observers/base_observer.rb
 - lib/lopata/observers/console_output_observer.rb
 - lib/lopata/observers/web_logger.rb
-- lib/lopata/rspec/dsl.rb
-- lib/lopata/rspec/role.rb
+- lib/lopata/role.rb
 - lib/lopata/runner.rb
 - lib/lopata/scenario.rb
 - lib/lopata/scenario_builder.rb
@@ -139,5 +138,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: lopata-0.1.3
+summary: lopata-0.1.8
 test_files: []

data/lib/lopata/config.rb

@@ -1,97 +0,0 @@
-module Lopata
-  module Config
-    extend self
-
-    attr_accessor :build_number, :lopata_host, :lopata_code, :only_roles, :role_descriptions,
-                  :default_role, :ops
-
-    def init(env)
-      require 'yaml'
-      @config = {}
-      config_filename = "./config/environments/#{env}.yml"
-      @config = YAML::load(File.open(config_filename)) if File.exists?(config_filename)
-      init_db
-      @role_descriptions ||= {}
-      # init_includes
-    end
-
-    def [](key)
-      @config[key]
-    end
-
-    %w{url name readonly}.each do |opt|
-      define_method opt do
-        raise "Lopata::Config unititlalized, use Lopata::Config#init(env) to set environment" unless @config
-        @config[opt]
-      end
-    end
-
-    def init_db
-      ActiveRecord::Base.establish_connection(@config['db']) if @config['db']
-    end
-
-    def init_rspec
-      require 'lopata/rspec/dsl'
-      require 'lopata/rspec/role'
-      ::RSpec.configure do |c|
-        c.include Lopata::RSpec::DSL
-        c.include Lopata::RSpec::Role
-      end
-      init_rspec_filters
-    end
-
-    def init_lopata_logging(build)
-      self.build_number = build
-      require 'lopata/observers/web_logger'
-      add_observer Lopata::Observers::WebLogger.new
-    end
-
-    def init_rspec_filters
-      filters = {}
-      filters[:focus] = true if ops[:focus]
-      unless filters.blank?
-        ::RSpec.configure do |c|
-          c.inclusion_filter = filters
-        end
-      end
-    end
-
-    def before_start(&block)
-      @before_start = block
-    end
-
-    def before_scenario(*steps, &block)
-      before_scenario_steps.append(*steps) unless steps.empty?
-      before_scenario_steps.append(block) if block_given?
-    end
-
-    def before_scenario_steps
-      @before_scenario_steps ||= []
-    end
-
-    def after_scenario(*steps, &block)
-      after_scenario_steps.append(*steps) unless steps.empty?
-      after_scenario_steps.append(block) if block_given?
-    end
-
-    def after_scenario_steps
-      @after_scenario_steps ||= []
-    end
-
-    def initialize_test
-      @before_start.call if @before_start
-    end
-
-    def world
-      @world ||= Lopata::World.new
-    end
-
-    def filters
-      @filters ||= []
-    end
-
-    def add_observer(observer)
-      world.observers << observer
-    end
-  end
-end

data/lib/lopata/generators/templates/.rspec

@@ -1,3 +0,0 @@
---color
---format documentation
---require spec_helper

data/lib/lopata/generators/templates/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-Lopata::Config.role_descriptions = { user: 'User' }
-Lopata::Config.default_role = :user

data/lib/lopata/rspec/dsl.rb

@@ -1,39 +0,0 @@
-module Lopata
-  module RSpec
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def action *contexts, &block
-          contexts.each do |context|
-            if context.is_a?(Proc)
-              action(&context)
-            else
-              verify context
-            end
-          end
-          before(:all, &block) if block_given?
-        end
-
-        def setup *contexts, &block
-          root_setup = false
-          unless @doing_setup
-            root_setup = true
-            @doing_setup = true
-          end
-          action *contexts, &block
-          if root_setup
-            # action Config.after_setup if Config.after_setup
-            @doing_setup = false
-          end
-        end
-
-        def teardown &block
-          after(:all, &block) if block_given?
-        end
-      end
-    end
-  end
-end

data/lib/lopata/rspec/role.rb

@@ -1,74 +0,0 @@
-module Lopata::RSpec::Role
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  # Filter names
-  def self.filter_roles *names
-    allowed = Lopata::Config.only_roles
-    selected = names.flatten.select { |n| allowed.blank? || allowed.member?(n) }
-    # ENV['quick'] ? [selected.first] : selected
-    selected
-  end
-
-  # http://jorgemanrubia.net/2010/01/16/using-macros-to-create-custom-example-groups-in-rspec/
-  module ClassMethods
-    def as *names, &block
-      return if current_role && !Lopata::RSpec::Role.filter_roles(*names).include?(current_role)
-      if current_role
-        self.class_eval(&block)
-      else
-        Lopata::RSpec::Role.filter_roles(*names).each do |name|
-          example_group_class = describe role_description(name), :current_role => name do
-            define_method :current_role do
-              name
-            end
-          end
-          example_group_class.class_eval(&block)
-        end
-      end
-    end
-
-    def except(*names, &block)
-      raise "'expecpt' block must be neseted for 'as' block" unless current_role
-      return if names.include? current_role
-      self.class_eval(&block)
-    end
-
-    def current_role
-      metadata[:current_role]
-    end
-
-    # To be redefined in impelemntations so RSpec descriptions to be more verbal
-    def role_description(name)
-      Lopata::Config.role_descriptions[name] || name
-    end
-
-    def scenario(*args, &block)
-      raise "scenario required a name in first argument" unless args.first.is_a? String
-      example_group_class = describe(*args)
-      example_group_class.nested_with_as(*args, &block)
-    end
-
-    def nested_with_as(*args, &block)
-      if (args.last.is_a?(Hash) && args.last[:as])
-        roles = args.last[:as]
-        roles = [roles] unless roles.is_a?(Array)
-        class_eval { as(*roles, &block) }
-      else
-        class_eval(&block)
-      end
-    end
-  end
-end
-
-module Lopata
-  # Adds the #scenario method to the top-level namespace.
-  def self.scenario(*args, &block)
-    raise "scenario required a name in first argument" unless args.first.is_a? String
-    example_group_class = RSpec.describe(*args)
-    example_group_class.nested_with_as(*args, &block)
-    # example_group_class.register
-  end
-end
-