cucumberator 0.0.8 → 1.0.0

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/features/undo.feature

@@ -0,0 +1,89 @@
+Feature: undo
+  Background:
+    Given a file named "examples/support/env.rb" with:
+      """
+      require 'cucumberator'
+      """
+    Given a file named "examples/step_definitions/extra.rb" with:
+      """
+      When(/I do some magical stuff with '(\w+)'/) do |*args|
+        # just example
+      end
+
+      """
+    Given a file named "examples/undo.feature" with:
+      """
+      Feature: example
+        Scenario: stop where exit
+          When I do some magical stuff with 'apples'
+          Then I will write new steps
+
+      """
+
+  Scenario: no undo available
+    When I run `cucumber examples/undo.feature` interactively
+    And I type "undo"
+    And I type "exit"
+    Then it should pass with:
+      """
+      There's nothing to revert yet
+      """
+
+  Scenario: simple undo
+    When I run `cucumber examples/undo.feature` interactively
+    And I type "When I do some magical stuff with 'water'"
+    And I type "undo"
+    And I type "exit"
+    Then it should pass with:
+      """
+      Saved `When I do some magical stuff with 'water'` to undo.feature
+      """
+    And it should pass with:
+      """
+      Removed `When I do some magical stuff with 'water'` from undo.feature
+      """
+    And the file "examples/undo.feature" should contain exactly:
+      """
+      Feature: example
+        Scenario: stop where exit
+          When I do some magical stuff with 'apples'
+          Then I will write new steps
+
+      """
+
+  Scenario: multiple undo
+    When I run `cucumber examples/undo.feature` interactively
+    And I type "When I do some magical stuff with 'water'"
+    And I type "When I do some magical stuff with 'fire'"
+    And I type "undo"
+    And I type "undo"
+    And I type "undo"
+    And I type "exit"
+    Then it should pass with:
+      """
+      Saved `When I do some magical stuff with 'water'` to undo.feature
+      """
+    And it should pass with:
+      """
+      Saved `When I do some magical stuff with 'fire'` to undo.feature
+      """
+    And it should pass with:
+      """
+      Removed `When I do some magical stuff with 'water'` from undo.feature
+      """
+    And it should pass with:
+      """
+      Removed `When I do some magical stuff with 'fire'` from undo.feature
+      """
+    And it should pass with:
+      """
+      There's nothing to revert yet
+      """
+    And the file "examples/undo.feature" should contain exactly:
+      """
+      Feature: example
+        Scenario: stop where exit
+          When I do some magical stuff with 'apples'
+          Then I will write new steps
+
+      """

data/features/where.feature

@@ -0,0 +1,55 @@
+Feature: it should display the code around
+  Background:
+    Given a file named "examples/support/env.rb" with:
+      """
+      require 'cucumberator'
+      """
+    Given a file named "examples/step_definitions/extra.rb" with:
+      """
+      When(/I do some magical stuff with "(\w+)"/) do |*args|
+        # just example
+      end
+      """
+
+  Scenario: display code for simple scenario
+    Given a file named "examples/where.feature" with:
+      """
+      Feature: example
+        Scenario: stop where exit
+          Then I will write new steps
+
+      """
+    When I run `cucumber examples/where.feature` interactively
+    And I type "where"
+    And I type "exit"
+    Then it should pass with:
+      """
+      2:      Scenario: stop where exit
+      """
+    And the output should contain "3: ->     Then I will write new steps"
+    And the output should contain "4:"
+
+  Scenario: display code for larger scenario
+    Given a file named "examples/where_bigger.feature" with:
+      """
+      Feature: example
+        Scenario: stop where exit
+          When I do some magical stuff with "apples"
+          And I do some magical stuff with "oranges"
+          And I do some magical stuff with "raspberries"
+          Then I will write new steps
+          And I do some magical stuff with "bananas"
+          And I do some magical stuff with "salad"
+      """
+    When I run `cucumber examples/where_bigger.feature` interactively
+    And I type "where"
+    And I type "exit"
+    Then it should pass with:
+      """
+      5:        And I do some magical stuff with "raspberries"
+      """
+    And the output should contain "6: ->     Then I will write new steps"
+    Then it should pass with:
+      """
+      7:        And I do some magical stuff with "bananas"
+      """

data/lib/cucumberator.rb

@@ -1,9 +1,10 @@
 require "readline"
-require "cucumberator/current_step"
-require "cucumberator/writer"
+require 'cucumberator/current_step'
+require 'cucumberator/input'
+#require 'pry'
 
 After('@cucumberize') do |scenario|
-  Cucumberator::Writer.new(self, scenario)
+  Cucumberator::Input.new(self, scenario)
 end
 
 Before do |scenario|
@@ -16,5 +17,5 @@ AfterStep do
 end
 
 Then /^I will write new steps$/ do
-  Cucumberator::Writer.new(self, @current_cucumberator_scenario, @current_step.line)
+  Cucumberator::Input.new(self, @current_cucumberator_scenario, @current_step.line)
 end

data/lib/cucumberator/commands.rb

@@ -0,0 +1,14 @@
+require 'cucumberator/commands/exit'
+require 'cucumberator/commands/exit_all'
+require 'cucumberator/commands/help'
+require 'cucumberator/commands/where'
+require 'cucumberator/commands/steps'
+require 'cucumberator/commands/last_step'
+require 'cucumberator/commands/save'
+require 'cucumberator/commands/undo'
+require 'cucumberator/commands/next'
+
+# todo: magic!
+module Cucumberator::Commands
+  AVAILABLE = %w(exit exit-all help last-step save undo next where steps)
+end

data/lib/cucumberator/commands/exit.rb

@@ -0,0 +1,10 @@
+module Cucumberator::Commands
+  class Exit
+    class << self
+      # return value - wants to quit?
+      def perform(*args, &block)
+        true
+      end
+    end
+  end
+end

data/lib/cucumberator/commands/exit_all.rb

@@ -0,0 +1,11 @@
+module Cucumberator::Commands
+  class ExitAll
+    class << self
+      # return value - wants to quit?
+      def perform(*args, &block)
+        Cucumber.wants_to_quit = true
+        true
+      end
+    end
+  end
+end

data/lib/cucumberator/commands/help.rb

@@ -0,0 +1,23 @@
+module Cucumberator::Commands
+  class Help
+    class << self
+      # return value - wants to quit?
+      def perform(*args, &block)
+        puts ":: Write a step here and watch it happen on the browser."
+        puts ":: Steps are automatically saved unless it raises exception. Use 'save' to force-save it anyway."
+        puts ":: Available commands:"
+        puts "::   save      - force-saves last step into current feature file"
+        puts "::   last-step - display last executed step (to be saved on 'save' command)"
+        puts "::   undo      - remove last saved line from feature file"
+        puts "::   next      - execute next step and stop"
+        puts "::   steps     - display available steps"
+        puts "::   where     - display current location in file"
+        puts "::   exit      - exits current scenario"
+        puts "::   exit-all  - exists whole Cucumber feature"
+        puts "::   help      - display this notification"
+
+        false
+      end
+    end
+  end
+end

data/lib/cucumberator/commands/last_step.rb

@@ -0,0 +1,9 @@
+module Cucumberator::Commands
+  class LastStep
+    class << self
+      def perform(_, _, last_input, *args, &block)
+        puts "It was: `#{last_input}`"
+      end
+    end
+  end
+end

data/lib/cucumberator/commands/next.rb

@@ -0,0 +1,39 @@
+module Cucumberator::Commands
+  class Next
+    class << self
+      def perform(scenario, step_line, *args, &block)
+        new(scenario, step_line).next_step
+      end
+    end
+
+    def initialize(scenario, step_line)
+      @scenario, @step_line = scenario, step_line
+      @steps = Cucumberator::Steps.new(@scenario)
+    end
+
+    def next_step
+      if next_step = detect_next_step
+        puts next_step.backtrace_line
+        @steps.current_visitor.visit_step(next_step)
+        @step_line.set(next_step.file_colon_line.split(':').last.to_i)
+        false
+      else
+        puts ":: Looks like it's the end of feature file. Happy coding! <3"
+        true
+      end
+    end
+
+    def detect_next_step
+      next_step = nil
+
+      @scenario.steps.each do |step|
+        if step.status == :skipped and not step.backtrace_line["Then I will write new steps"]
+          next_step = step
+          break
+        end
+      end
+
+      next_step
+    end
+  end
+end

data/lib/cucumberator/commands/save.rb

@@ -0,0 +1,80 @@
+module Cucumberator::Commands
+  class Save
+    class << self
+      def perform(scenario, step_line, last_input, saved_stack, *args, &block)
+        new(scenario, step_line, last_input, saved_stack).save
+        false
+      end
+
+      def save_empty_line(scenario, step_line, saved_stack)
+        new(scenario, step_line, "", saved_stack).force_save_empty_line
+        false
+      end
+    end
+
+    attr_accessor :step_line, :saved_stack
+
+    def initialize(scenario, step_line, last_input, saved_stack)
+      @step_line, @last_input, @saved_stack = step_line, last_input, saved_stack
+      @feature_file = Cucumberator::FeatureFile.new(scenario)
+    end
+
+    def save
+      if @last_input.to_s.empty?
+        puts "Hm... nothing to save yet?"
+      else
+        string_to_save = (" " * spaces_in_last_input) + @last_input
+        save_to_feature_file(string_to_save)
+
+        puts "Saved `#{@last_input}` to #{@feature_file}"
+        @last_input = nil
+      end
+    end
+
+    def force_save_empty_line
+      save_to_feature_file("")
+      @last_input = nil
+    end
+
+    def save_to_feature_file(line)
+      if step_line
+        insert_line_to_feature_file(line)
+      else
+        append_line_to_feature_file(line)
+      end
+    end
+
+    def insert_line_to_feature_file(line)
+      lines = @feature_file.lines
+      lines.insert(step_line - 1, line.to_s+$/) # $/ - default newline separator
+      @feature_file.overwrite(lines.join)
+
+      self.saved_stack << [step_line.number, line]
+      self.step_line.increment!
+    end
+
+    def append_line_to_feature_file(line)
+      @feature_file.append(line)
+      self.saved_stack << [@feature_file.lines.size, line]
+    end
+
+    def spaces_in_last_input
+      line = detect_last_line(@feature_file.lines)
+      spaces = line.to_s =~ /\S/
+      spaces.to_i
+    end
+
+    def detect_last_line(lines)
+      if step_line
+        line  = lines[step_line-1]
+        lines = lines.slice(0, step_line-1) if line.to_s.empty?
+      end
+
+      if line.to_s.empty?
+        line = lines.reverse.detect { |l| !l.to_s.empty? }
+      end
+
+      line
+    end
+  end
+end

data/lib/cucumberator/commands/steps.rb

@@ -0,0 +1,19 @@
+module Cucumberator::Commands
+  class Steps
+    class << self
+      def perform(scenario, *args, &block)
+        steps = all_steps(scenario)
+        if steps and steps.size > 0
+          puts ":: Yay, you have #{@steps.size} steps in your pocket:"
+          steps.each { |s| puts s }
+        else
+          puts ":: Sorry, no steps detected"
+        end
+      end
+
+      def all_steps(scenario)
+        @steps ||= Cucumberator::Steps.new(scenario).all
+      end
+    end
+  end
+end

data/lib/cucumberator/commands/undo.rb

@@ -0,0 +1,27 @@
+module Cucumberator::Commands
+  class Undo
+    class << self
+      def perform(scenario, step_line, last_input, saved_stack, *args, &block)
+        if saved_stack.empty?
+          puts "There's nothing to revert yet"
+          return false
+        end
+
+        new(scenario, step_line, saved_stack)
+        false
+      end
+    end
+
+    def initialize(scenario, step_line, saved_stack)
+      @feature_file = Cucumberator::FeatureFile.new(scenario)
+      lines = @feature_file.lines
+
+      remove_line, remove_string = saved_stack.pop
+      lines.delete_at(remove_line - 1)
+      @feature_file.overwrite(lines.join)
+      step_line.decrement!
+
+      puts "Removed `#{remove_string.to_s.strip}` from #{@feature_file}"
+    end
+  end
+end

data/lib/cucumberator/commands/where.rb

@@ -0,0 +1,33 @@
+module Cucumberator::Commands
+  class Where
+    class << self
+      # return value - wants to quit?
+      def perform(scenario, step_line, *args, &block)
+        new(scenario, step_line)
+        false
+      end
+    end
+
+    def initialize(scenario, step_line)
+      @feature_file = Cucumberator::FeatureFile.new(scenario)
+
+      display_line(step_line - 1)
+      display_line(step_line.number, current: true)
+      display_line(step_line + 1)
+    end
+
+    def display_line(line_number, opts = {})
+      lines = @feature_file.lines
+      line_string = sprintf("%3d", line_number)
+
+      if opts[:current]
+        line_string << ": -> "
+      else
+        line_string << ":    "
+      end
+
+      line_string << lines[line_number-1].to_s
+      puts line_string
+    end
+  end
+end