step_machine 0.0.3

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+require 'pry'
+
+# SimpleCov.start
+
+Dir[File.expand_path("../../", __FILE__) + "/lib/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+	# Ativa output colorido
+	config.color_enabled = true
+end

data/spec/step_machine_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+
+include StepMachine
+
+describe "StepMachine" do
+
+	before :each do
+	end	
+
+	describe "on step" do
+
+		it "should create an instance of the runner" do
+			step(:name) {}
+			@step_machine_runner.should be_a(Runner)
+		end
+
+		it "should create an step with the given name and block" do
+
+			block = proc { x + 1 }
+			step = step(:name, &block)
+
+			step.name.should == :name
+			step.block.should == block
+		end
+
+	end
+
+	describe "on group" do
+
+		it "should create an group and assign to the steps" do
+			group(:group) do
+				step(:step_1)
+			end
+
+			step(:step_1).group.should == group(:group)
+		end
+
+	end
+
+	describe "on run_steps" do
+		it "should run the given steps" do
+			step(:step) { 1 + 1}
+
+			run_steps
+
+			step(:step).result.should == 2
+		end	
+
+		it "should run the steps of the given group" do
+			x = 0
+
+			group(:group) do
+				step(:step) { x += 1 }
+			end
+				
+			step(:step_2) { x += 1 }
+
+			run_steps({:group => :group})
+
+			x.should == 1
+		end	
+
+		it "should run the steps up to given step" do
+		  x = 0
+		  step(:step_1) { x += 1 }
+		  step(:step_2) { x += 1 }
+		  step(:step_3) { x += 1 }
+
+		  run_steps :upto => :step_2
+
+		  x.should == 2
+		end
+	end
+
+	describe "callbacks" do
+
+		it "on_step_failure should execute the given block if the step fails" do
+		  step(:step_1){ }.validate{false}
+
+		  x = 0
+		  on_step_failure{x += 1}
+
+		  run_steps
+
+		  x.should == 1
+		end
+
+		it "should execute the given block before each step" do
+
+		  step(:step_1){ }
+		  step(:step_2){ }
+
+		  x = 0
+		  before_each_step {x += 1}
+
+		  run_steps
+
+		  x.should == 2
+		end
+
+		it "should execute the given block before each step" do
+
+		  step(:step_1){ }
+		  step(:step_2){ }
+
+		  x = 0
+		  after_each_step {x += 1}
+
+		  run_steps
+
+		  x.should == 2
+		end
+
+	end
+
+	it "should return the status on run_status" do
+		step(:step_1){ }
+	  step(:step_2){ }
+
+	  run_steps
+
+	  run_status.should == :success
+	end
+
+	it "should return the failed step" do
+		step(:step_1){ }
+	  step(:step_2){ }.validate {false}
+
+	  run_steps
+
+	  failed_step.should == step(:step_2)
+	end
+end

data/spec/step_spec.rb

@@ -0,0 +1,215 @@
+require "spec_helper"
+
+describe Step do
+
+	before :each do
+		@step = Step.new(:name)
+		@step.block = proc { 1 + 1 }
+	end
+
+	describe "Validate" do
+
+		it "validate should assign a block validation to the step" do
+
+			block = proc {|step| step.result = 2}
+
+			@step.validate(&block)
+			@step.validation.should == block
+		end
+
+		it "validate should return the step" do
+			block = proc {|step| step.result = 2}
+
+			@step.validate(&block).should == @step
+		end
+
+		it "success should return the step" do
+			block = proc {|step| step.result = 2}
+
+			@step.validate(&block).should == @step
+		end
+
+		it "should assign a value to validate the result of the step" do
+			@step.validate(1)
+			@step.validation.should == 1
+		end
+
+		it "should permit add errors on step in array format" do
+			@step.errors.push('error')
+			@step.errors.push('error 2')
+			expect(@step.errors).to have(2).items
+			expect(@step.errors).to be_a(Array)
+		end
+
+		it "should permit add errors on step in hash format" do
+			@step.errors({})[:step] = 'step error'
+			expect(@step.errors).to have(1).items				  
+			expect(@step.errors).to be_a(Hash)			
+		end
+
+		it "should permit add errors on step in string format" do
+			@step.errors("") << 'step error'
+			expect(@step.errors).to eql('step error')
+			expect(@step.errors).to be_a(String)			
+		end
+
+		it "should permit reset with formats: String, Array and Hash" do
+			@step.errors("") << 'step error'
+			expect(@step.errors).to be_a(String)					  
+			@step.errors([]) << 'step error'
+			expect(@step.errors).to be_a(Array)					  
+			@step.errors({})[:step_n] = 'error'
+			expect(@step.errors).to be_a(Hash)					  
+		end
+
+		it "should not clear errors when initialized with same variable format" do
+			@step.errors("") << 'step '
+			@step.errors("") << 'has '
+			@step.errors     << 'error'
+
+			expect(@step.errors).to eql('step has error')
+			expect(@step.errors).to be_a(String)
+		end
+
+		it "should clear errors when initialized with diferent varialbe format" do
+			@step.errors([]) << 'step '
+			@step.errors("") << 'has '
+			@step.errors     << 'error'
+
+			expect(@step.errors).to eql('has error')
+			expect(@step.errors).to be_a(String)
+		end
+
+
+	end
+
+	describe "next step" do
+		it "should assign a block to the next_step" do
+			block = proc {|step| }
+			@step.next_step(&block)
+			@step.next_step.should == block
+		end
+	end
+
+	describe "condition" do
+		it "should assign a condition block" do
+			block = proc {}
+			@step.condition(&block).should == @step
+			@step.condition_block.should == block
+		end
+	end
+
+	describe "next" do
+
+		it "should return the next step" do
+			next_step = Step.new(:step_2)
+
+			@step.next_step = next_step
+			@step.next.should == next_step
+		end
+
+		it "should return the next step evaluating the block" do
+			next_step = Step.new(:step_2)
+
+			@step.next_step do |s|
+				s.should == @step
+			end
+
+			@step.next
+		end
+
+		it "should return the next step evaluating the block" do
+			next_step = Step.new(:step_2)
+
+			@step.next_step { next_step }
+			@step.next.should == next_step
+		end
+
+	end
+
+	describe "on perform" do
+
+		it "should execute the block and store the result" do
+			@step.perform
+			@step.result.should == 2
+		end
+
+		it "should pass the step to the block" do
+			@step.block = proc do |step|
+				step.should == @step
+			end
+
+			@step.perform
+		end
+
+		it "should evaluate the validation block" do
+			@step.validate {|step| step.result == 1} # invalid
+			@step.perform.should be_false
+
+			@step.validate {|step| step.result == 2} # valid
+			@step.perform.should be_true
+		end
+
+		it "should evaluate the validation value" do
+			@step.validate(1) # invalid
+			@step.perform.should be_false
+
+			@step.validate(2) # valid
+			@step.perform.should be_true
+		end
+
+		it "should evaluate the validation regex" do
+			@step.block = proc { "validation" }
+			@step.validate(/^x/) # invalid
+			@step.perform.should be_false
+
+			@step.validate(/n$/) # valid
+			@step.perform.should be_true
+		end
+
+		it "should store the exception on step when raised" do
+			@step.block = proc { raise ArgumentError }
+			@step.perform.should be_false
+			@step.exception.class.should == ArgumentError
+		end
+
+		it "should execute a success block" do
+			x = 0
+			@step.success {|step| x += 1 }
+			x.should == 0
+			@step.perform
+			x.should == 1
+		end
+
+		it "should return true if step was executed" do
+			step_a = Step.new(:step_a)
+			step_a.block = proc { "step_a" }
+			step_a.should_not be_performed
+			step_a.perform
+			step_a.should be_performed
+		end
+
+		it "should evaluate the condition block to execute the step" do
+			@step.condition { true }
+			@step.perform
+			@step.should be_performed
+		end
+
+		it "should not execute the step if the condition block is false" do
+			@step.condition { false }
+			@step.perform.should be_true
+			@step.should_not be_performed
+		end
+
+		it "should not execute the step if the group condition block is false" do
+			group = Group.new(:group_1)
+			group.condition { false }
+			@step.group = group
+			expect(@step.perform).to be_true
+			expect(@step).not_to be_performed
+		end
+
+
+	end
+
+end

data/step_machine.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'step_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "step_machine"
+  spec.version       = StepMachine::VERSION
+  spec.authors       = ["Rafael Vettori"]
+  spec.email         = ["rafael.vettori@gmail.com"]
+  spec.description   = %q{When you want execute lazzy block commands, you need use this gem}
+  spec.summary       = %q{Gem to standardize the of any block execution}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/usage.rb

@@ -0,0 +1,101 @@
+class Hdi
+  include StepMachine
+
+  attr_accessor :agent
+
+  def initialize
+    self.agent = Mechanize.new
+    define_steps
+  end
+
+  def define_steps
+
+    group :login do
+      step :acessaar_pagina
+      step :sucursal
+    end    
+
+    step :dados_segurado do
+      agent.post("", "")
+    end.validate { |step| step.result.body.match(/cod_cotacao/) }
+
+    step :pessoa_fisica do
+      agent.post("", "")
+    end.validate { |step| step.result.code == '200' }
+
+    step :pessoa_juridica do
+      agent.post("", "")
+    end.validate { |step| step.result.code == '200' }
+
+    step[:dados_segurado].next_step = @cotacao.cliente.pessoa == 'F' ? steps[:pessoa_fisica] : steps[:pessoa_juridica]
+
+    step :pesquisar_veiculo do
+      veiculos = agent.post("", "").scan("")
+    end.validate { |step| step.result.code == '200' }.validate(/ul li/).next_step do |step|
+      return :selecionar_veiculo if step.result.search('ul li')
+      return :calcular
+    end
+ 
+    step :selecionar_veiculo do
+      veiculo = aproximado(veiculos, @cotacao.veiculo.descricao)
+      agent.post("", "")
+    end
+
+    step :calcular do
+      agent.post("", "")
+    end
+
+    step[:calcular].validate do |step| 
+      raise ValidacaoSeguradoraError unless step.result.search("#cod_cotacao") 
+    end
+
+    step[:calcular].success do |step| 
+      preco.cod_cotacao = step.result.search("#cod_cotacao")
+    end
+
+    step[:pesquisar_veiculo].next_step do |step|
+      return step[:selecionar_veiculo] if step.result.search('ul li')
+      return step[:calcular]
+    end
+
+    on_step_failure :except => {:dados_segurado, :pesquisar_veiculo} do |step|
+      step.exception
+      step.result
+      mail
+    end
+
+    on_step_failure :only => {:dados_segurado, :pesquisar_veiculo} do |step|
+      go_to_step step.name
+      repeat_step if condition            
+      go_to_step :calcular if condition
+      go_to_next_step if condition
+      go_to_step(:calcular).and_stop if condition
+      restart
+    end
+
+    before_each_step do
+    end
+    
+    after_each_step do
+    end
+    
+    run_steps
+  end
+end
+
+describe Hdi do
+
+  before :each do
+    @hdi.on_step_failure do |step|
+      p step
+    end
+  end
+
+  it do    
+
+    @hdi.cotar
+    @hdi.step_result.should be_success
+
+  end
+
+end