marso 0.1.5297 → 0.1.15089

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb0aa2039c670471541472edde9051b6833be2f7
-  data.tar.gz: c6ff92eadaf654c61cfe301173c54ea3836a043b
+  metadata.gz: 9dd68ffdf94aa8dc6c18a66a1be55774e8aa2b4b
+  data.tar.gz: 07415303338d5c40520661aa865a656b171cb148
 SHA512:
-  metadata.gz: 36b63b9e57db5ab99e059c8a75d51a89214d69c01c0b91b364d1298f079f26cf310940115cd362c3af7e986b91102614d7639fae46522f9697f1e5320b2f5cdb
-  data.tar.gz: d4c4986c86c6542a8a5cf9695cf8c08d5c2c7bb8e90848c06dc4e574a5a2870ef79b976579f23839d4de5fe59bd33b7cfb5a47072d6988f07d090d69d2044048
+  metadata.gz: 1386739d560795b6bcc2e6e74a59030aa46e9eeacfe3951bc3d62fbb58b9b48da18ea7ba2e7cb0374c151e9699e04ccc8595725e2e2ce38115034e529dad03db
+  data.tar.gz: fab73a4f66f4856dc1f2500f0aeeb9693bd9240caa7f0ca12d9a8f6b35812635dff42fc7e7fabd4e88a006392f0277502fbff4917abc9a3c393dc9660b260f66

data/lib/marso.rb

@@ -1,3 +1,5 @@
 require "marso/version"
 require "marso/assert"
 require "marso/factories"
+require "marso/config"
+require "marso/scenario"

data/lib/marso/assert.rb

@@ -3,7 +3,7 @@ require "colorize"
 module Marso
 	module_function
 
-	def assert message, &block
+	def assert(message, &block)
 		begin
 			if (block.call)
 				puts "Assert #{message}: PASSED".green
@@ -11,7 +11,7 @@ module Marso
 				puts "Assert #{message}: FAILED".red
 			end
 		rescue Exception => e
-			puts "Assert #{message} FAILED with exception #{e}".red
+			puts "Assert #{message} FAILED with exception #{e.message}".red
 		end
 	end
 end

data/lib/marso/config.rb

@@ -0,0 +1,25 @@
+module Marso
+  class Config
+    @@configuration={
+      # If true, the result of each step is output to the console in realtime.
+      # The consequence os setting that config to true is that steps
+      # may be harder to read together when multiple scenarios are executed
+      # paralell. Steps of different scenarios may indeed be intertwined in the
+      # console
+      :realtime_step_stdout => false,
+
+      # If true, all steps of the same scenario defined after a broken step(i.e.
+      # step in status :failed, :error, or :cancelled) will not be executed, and
+      # will all be set so their status is :cancelled
+      :cancel_steps_upon_issues => true
+    }
+
+    def self.set(config_name, config_value)
+      @@configuration[config_name] = config_value if @@configuration.key?(config_name)
+    end
+
+    def self.get(config_name)
+      @@configuration[config_name]
+    end
+  end
+end

data/lib/marso/scenario.rb

@@ -0,0 +1,278 @@
+require 'colorize'
+require 'securerandom'
+require_relative 'config'
+
+module Marso
+
+  class Scenario
+    ISSUES_LIST = [:error, :failed, :cancelled]
+    @@color_options=nil
+    @@color_options_size=0
+    attr_reader :name, :steps, :id, :status, :color_theme, :cancel_steps_upon_issues,
+    :realtime_step_stdout
+
+    # name: Scenario's name
+    # options:
+    #   :id => hex string (length 8). Default is randomly generated
+    #   :steps => array of Step objects
+    #   :color_theme => color from gem 'colorize'(e.g. :blue). That allows
+    #                   to visually group all steps from the same scenario.
+    #                   Default is randomly choosen from the available set
+    #   :cancel_steps_upon_issues => Boolean. If true, all steps defined after
+    #                                a broken step(i.e. step in status :failed,
+    #                                :error, or :cancelled) will not be
+    #                                executed, and will all be set so their
+    #                                status is :cancelled. If defined, it
+    #                                overrides the Config.cancel_steps_upon_issues
+    #                                setting.
+    def initialize(name, options={})
+
+      if @@color_options.nil?
+        @@color_options = String.colors
+        @@color_options_size = @@color_options.size
+      end
+
+      @name = name
+      @id =
+        options.key?(:id) ?
+        options[:id] :
+        SecureRandom.hex(4)
+
+      @status =
+        options.key?(:status) ?
+        options[:status] :
+        :pending
+
+      @color_theme =
+        options.key?(:color_theme) ?
+        options[:color_theme] :
+        @@color_options[rand(@@color_options_size)]
+
+      @steps =
+        options.key?(:steps) ?
+        options[:steps].map { |s| Step.new(s.text, @id, @color_theme, s.status, &s.block) } :
+        []
+
+      @cancel_steps_upon_issues =
+        options.key?(:cancel_steps_upon_issues) ?
+        options[:cancel_steps_upon_issues] :
+        Marso::Config.get(:cancel_steps_upon_issues)
+
+      @realtime_step_stdout =
+        options.key?(:realtime_step_stdout) ?
+        options[:realtime_step_stdout] :
+        Marso::Config.get(:realtime_step_stdout)
+    end
+
+    def given(assumption_text, *args, &block)
+      return add_step(:given, assumption_text, *args, &block)
+    end
+
+    def and(assumption_text, *args, &block)
+      return add_step(:and, assumption_text, *args, &block)
+    end
+
+    def when(assumption_text, *args, &block)
+      return add_step(:when, assumption_text, *args, &block)
+    end
+
+    def then(assumption_text, *args, &block)
+      return add_step(:then, assumption_text, *args, &block)
+    end
+
+    def but(assumption_text, *args, &block)
+      return add_step(:but, assumption_text, *args, &block)
+    end
+
+    def run
+      previous_step_status = nil
+      scenario_status = :passed
+      no_issues = true
+      puts "Scenario #{@id}".colorize(@color_theme) + ": " + "#{name}".blue if @realtime_step_stdout
+
+      processed_steps = @steps.map { |s|
+        executed_step = execute_step(s, previous_step_status)
+
+        print executed_step.print_context if @realtime_step_stdout
+
+        previous_step_status = executed_step.status
+
+        if no_issues
+          case previous_step_status
+          when :error
+            no_issues = false
+            scenario_status = :error
+          when :failed
+            no_issues = false
+            scenario_status = :failed
+          when :cancelled
+            no_issues = false
+            scenario_status = :failed
+          end
+        end
+
+        executed_step
+      }
+
+      return Scenario.new(@name, {
+        :id => @id,
+        :steps => processed_steps,
+        :status => scenario_status,
+        :color_theme => @color_theme
+      })
+    end
+
+    def context
+      return
+        "Scenario #{@id}: #{name}\n" +
+        (@steps.any? ? @steps.map { |s| s.context }.join("\n") : "")
+    end
+
+    def print_context
+      puts "Scenario #{@id}".colorize(@color_theme) + ": " + "#{name}".blue
+      @steps.map { |s| s.print_context  } if !@steps.nil?
+    end
+
+
+    private
+
+      def add_step(step_type, assumption_text, *args, &block)
+        body_msg = nil
+        status = :pending
+        step_name = step_type.to_s
+
+        begin
+          body_msg = "#{step_name} " + assumption_text % args
+        rescue Exception => e
+          status = :error
+          body_msg =
+            "#{assumption_text}: ERROR\n" +
+            "args: #{args.nil? ? '' : args.join(',')}\n" +
+            "#{e.message}\n" +
+            "#{e.backtrace}"
+        end
+
+        new_step_series = @steps | [Step.new(body_msg, @id, color_theme, status, &block)]
+
+        return Scenario.new(@name, {
+          :id => @id,
+          :steps => new_step_series,
+          :status => @status,
+          :color_theme => @color_theme
+        })
+      end
+
+      def execute_step(step, previous_step_status)
+        if ISSUES_LIST.include?(previous_step_status) && @cancel_steps_upon_issues
+          cancelled_step = Step.new(step.text, @id, @color_theme, :cancelled, &step.block)
+          return cancelled_step.execute
+        else
+          return step.execute
+        end
+      end
+  end
+
+  # A 'Step' is a Scenario's part. It contains
+  # a text that describe what that step does, as well
+  # as a status that indicates whether or not that step
+  # has already been executed. This status can take the
+  # following values:
+  # => :pending
+  # => :passed
+  # => :failed
+  # => :cancelled
+  # => :error
+  class Step
+    attr_reader :text, :status, :color_theme, :scenario_id, :block
+
+    def initialize(text, scenario_id, color_theme, status=:pending, &block)
+      @text=text
+      @status=status
+      @block=block
+      @scenario_id=scenario_id
+      @color_theme = color_theme
+    end
+
+    def execute
+      if @status != :cancelled
+        execute_block
+      else
+        return self
+      end
+    end
+
+    def context
+      scenario_id = "#{@scenario_id}"
+      body = nil
+      case @status
+      when :pending
+        body = "#{@text}: PENDING"
+      when :passed
+          body = "#{@text}: PASSED"
+      when :failed
+        body = "#{@text}: FAILED"
+      when :cancelled
+        body = "#{@text}: CANCELLED"
+      when :error
+        body = "#{@text}"
+      end
+
+      return "#{scenario_id}: #{body}"
+
+    end
+
+    def print_context
+      scenario_id = "#{@scenario_id}".colorize(@color_theme)
+      body = nil
+      case @status
+      when :pending
+        body = "#{@text}: PENDING".light_yellow
+      when :passed
+          body = "#{@text}: PASSED".green
+      when :failed
+        body = "#{@text}: FAILED".red
+      when :cancelled
+        body = "#{@text}: CANCELLED".light_black
+      when :error
+        body = "#{@text}".red
+      end
+
+      puts "#{scenario_id}: #{body}"
+
+    end
+
+    private
+      def execute_block
+        operation = lambda { |x|
+          begin
+            result = @block.call
+            result_type = result.class
+            if result_type == TrueClass || result_type == FalseClass
+              if result
+                return :passed, nil
+              else
+                return :failed, nil
+              end
+            else
+              return :passed, nil
+            end
+          rescue Exception => e
+            return :error, e
+          end
+        }
+
+        status, err = operation.call(nil)
+
+        updated_text = @text
+
+        if status==:error
+          updated_text =
+            "#{text}: ERROR\n" +
+            "#{err.message}\n" +
+            "#{err.backtrace}"
+        end
+
+        return Step.new(updated_text, @scenario_id, @color_theme, status, &@block)
+      end
+  end
+end

data/lib/marso/version.rb

@@ -1,3 +1,3 @@
 module Marso
-  VERSION ="0.1.5297"
+  VERSION ="0.1.15089"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marso
 version: !ruby/object:Gem::Version
-  version: 0.1.5297
+  version: 0.1.15089
 platform: ruby
 authors:
 - Nicolas Dao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,9 @@ files:
 - Rakefile
 - lib/marso.rb
 - lib/marso/assert.rb
+- lib/marso/config.rb
 - lib/marso/factories.rb
+- lib/marso/scenario.rb
 - lib/marso/version.rb
 - marso.gemspec
 homepage: https://github.com/nicolasdao/marso