cucumberator 0.0.2 → 0.0.3

data/README.md

@@ -2,9 +2,14 @@ Cucumberator is Cucumber extension to write steps in command line, whatch how br
 
 ## How to use
 
-* Put @cucumberize tag in front of Scenario you want to append with new steps
-* Fire up the cucumber and wait until prompt shows up
-* Write a step and when happy, type 'save' to get it saved into your .feature file
+* Put @cucumberize tag in front of empty Scenario you want to append with new steps.
+* Or place step "Then I will write new steps" anywhere in scenario.
+* Fire up the cucumber and wait until prompt shows up.
+* Write a step, watch it happen on the browser! 
+
+All steps are **automatically saved** into .feature file unless it's unsuccessful. If you're unhappy with the last step, type "undo". See all commands with "help".
+
+If you have Continuous Integration, do not forget to remove cucumberator tag/step before pushing! ;-)
 
 ## Installation
 
@@ -20,17 +25,21 @@ Then require it in one of your ruby files under features/support (e.g. env.rb)
 	
 	require 'cucumberator'
 
-Now put @cucumberize before any Scenario you want to fill up, for example
+Now use special step in any place:
+
+	# ...some steps...
+	Then I will write new steps
+	# ...can be the end or other steps...
+
+or put @cucumberize before last **empty** Scenario you want to fill up, for example
 
 	@javascript @cucumberize
 	Scenario: check fancy ajax login
-      Given user with email some@example.com
 
-and then run this feature file and watch your console for prompt shows up - after all existing steps are finished.
+and then run this feature file, watch your console for prompt to show up. Enjoy writing steps on the go!
 
 ## TODO
 
-* support of multiple scenarios per feature file
 * autocomplete for available steps
 * tests
 

data/cucumberator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/vidmantas/cucumberator"
   s.summary     = "cucumberator-#{s.version}"
   s.description = %q{Prompt for writing Cucumber tests}
-  s.post_install_message = "(::)\nCucumberator installed! Now require cucumberator in your env.rb and place @cucumberize before the scenario you'd like to append new steps\n(::)"
+  s.post_install_message = "(::)\nCucumberator installed! Now require cucumberator in your env.rb and check README for usage examples\n(::)"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/cucumberator/current_step.rb

@@ -0,0 +1,19 @@
+module Cucumberator
+  class CurrentStep
+    attr_accessor :line
+
+    def initialize(scenario)
+      @scenario_sexp = scenario.instance_variable_get("@steps").to_sexp
+    end
+
+    def increase
+      if self.line
+        @offset += 1
+      else
+        @offset = 0
+      end
+
+      self.line = @scenario_sexp[@offset][1]
+    end
+  end
+end

data/lib/cucumberator/version.rb

@@ -1,3 +1,3 @@
 module Cucumberator
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/cucumberator/writer.rb

@@ -0,0 +1,169 @@
+module Cucumberator
+  class Writer
+    attr_accessor :world, :scenario, :step_line, :original_step_line, :last_input, :exit_flag, :saved_stack
+
+    FULL_BACKTRACE = false
+
+    def initialize(world, scenario, step_line = nil)
+      @world, @scenario = world, scenario
+      @step_line = @original_step_line = step_line if step_line
+      @saved_stack = []
+
+      check_scenario
+      set_autocomplete
+      read_input
+    end
+
+    def check_scenario
+      raise "Sorry, no cucumberator when scenario is already failing!" if scenario.failed?
+    end
+
+    def set_autocomplete
+      commands = %w(exit exit-all help last-step save undo)
+      Readline.completion_proc = proc{|s| commands.grep( /^#{Regexp.escape(s)}/ ) }
+    end
+
+    def read_input
+      input = Readline.readline("> ", true)
+      parse_input(input)
+      read_input unless exit_flag
+    end
+
+    def parse_input(input)
+      case input
+      when "exit"
+        self.exit_flag = true and return
+
+      when "exit-all"
+        Cucumber.wants_to_quit = true
+        self.exit_flag = true and return
+      
+      when "help"
+        display_help
+
+      when "last-step"
+        puts last_input
+
+      when "save"
+        save_last_input
+
+      when "undo" 
+        undo
+
+      when ""
+        save_empty_line
+
+      else
+        begin
+          execute_cucumber_step(input)
+          save_last_input
+        rescue Exception => e
+          raise e
+        end
+
+      end
+    rescue Exception => e
+      puts e.inspect
+      puts e.backtrace.join("\n") if FULL_BACKTRACE
+    end
+
+
+    ## COMMANDS 
+
+    def display_help
+      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 "::   exit      - exits current scenario"
+      puts "::   exit-all  - exists whole Cucumber feature"
+      puts "::   help      - display this notification"
+    end
+
+    def save_last_input
+      if last_input.blank?
+        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 #{File.basename(feature_file)}"
+        self.last_input = nil
+      end
+    end
+
+    def save_to_feature_file(string)
+      if step_line
+        feature_file_lines = File.readlines(feature_file)
+        feature_file_lines.insert(step_line, string.to_s+$/) # $/ - default newline separator
+        File.open(feature_file, 'w'){|f| f.puts(feature_file_lines.join) }
+        self.step_line += 1
+      else
+        File.open(feature_file, 'a'){|f| f.puts(string) }
+      end
+
+      self.saved_stack << string
+    end
+
+    def save_empty_line
+      save_to_feature_file("")
+      self.last_input = nil
+    end
+
+    def execute_cucumber_step(input)
+      return if input.blank?
+
+      self.last_input = input
+      world.steps(input)
+    end
+
+    def undo
+      if saved_stack.empty?
+        puts "There's nothing to revert yet" and return
+      end
+
+      feature_file_lines = File.readlines(feature_file)
+
+      removed = if step_line
+        self.step_line -= 1
+        feature_file_lines.delete_at(step_line)
+      else
+        feature_file_lines.pop
+      end
+
+      puts "Removed \"#{removed.to_s.strip}\" from #{File.basename(feature_file)}" 
+
+      File.open(feature_file, 'w'){|f| f.puts(feature_file_lines.join) }
+      self.saved_stack.pop
+    end
+
+
+    ## HELPERS
+
+    def feature_file
+      @feature_file ||= File.join(Rails.root, scenario.file_colon_line.split(":").first)
+    end
+
+    def spaces_in_last_input
+      spaces = 0
+      lines  = File.readlines(feature_file)
+
+      if step_line
+        line = lines[step_line-1]
+      else
+        for l in lines.reverse
+          unless l.blank?
+            line = l
+            break
+          end
+        end
+      end
+
+      spaces = line =~ /\S/
+      spaces
+    end
+  end
+
+end

data/lib/cucumberator.rb

@@ -1,6 +1,20 @@
 require "readline"
-require "cucumberator/cucumberizator"
+require "cucumberator/current_step"
+require "cucumberator/writer"
 
 After('@cucumberize') do |scenario|
-  Cucumberizator.new(self, scenario)
+  Cucumberator::Writer.new(self, scenario)
+end
+
+Before do |scenario|
+  @current_cucumberator_scenario = scenario
+  @current_step = Cucumberator::CurrentStep.new(scenario)
+end
+
+AfterStep do
+  @current_step.increase
+end
+
+Then /^I will write new steps$/ do
+  Cucumberator::Writer.new(self, @current_cucumberator_scenario, @current_step.line)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumberator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-16 00:00:00.000000000Z
+date: 2011-09-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &9675260 !ruby/object:Gem::Requirement
+  requirement: &7267520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *9675260
+  version_requirements: *7267520
 - !ruby/object:Gem::Dependency
   name: cucumber-rails
-  requirement: &9674100 !ruby/object:Gem::Requirement
+  requirement: &7265160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *9674100
+  version_requirements: *7265160
 description: Prompt for writing Cucumber tests
 email:
 - vidmantas@kabosis.lt
@@ -47,14 +47,15 @@ files:
 - Rakefile
 - cucumberator.gemspec
 - lib/cucumberator.rb
-- lib/cucumberator/cucumberizator.rb
+- lib/cucumberator/current_step.rb
 - lib/cucumberator/version.rb
+- lib/cucumberator/writer.rb
 homepage: https://github.com/vidmantas/cucumberator
 licenses: []
 post_install_message: ! '(::)
 
-  Cucumberator installed! Now require cucumberator in your env.rb and place @cucumberize
-  before the scenario you''d like to append new steps
+  Cucumberator installed! Now require cucumberator in your env.rb and check README
+  for usage examples
 
   (::)'
 rdoc_options: []
@@ -77,5 +78,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: cucumberator-0.0.2
+summary: cucumberator-0.0.3
 test_files: []

data/lib/cucumberator/cucumberizator.rb

@@ -1,105 +0,0 @@
-class Cucumberizator
-  attr_accessor :world, :scenario, :last_input, :exit_flag
-
-  FULL_BACKTRACE = false
-
-  def initialize(world, scenario)
-    @world, @scenario = world, scenario
-    
-    check_scenario
-    set_autocomplete
-    read_input
-  end
-
-  def check_scenario
-    raise "Sorry, no cucumberator when scenario is already failing!" if scenario.failed?
-  end
-
-  def set_autocomplete
-    commands = %w(exit exit-all help last-step save)
-    Readline.completion_proc = proc{|s| commands.grep( /^#{Regexp.escape(s)}/ ) }
-  end
-
-  def read_input
-    input = Readline.readline("> ", true)
-    parse_input(input)
-    read_input unless exit_flag
-  end
-
-  def parse_input(input)
-    case input
-    when "exit"
-      self.exit_flag = true and return
-
-    when "exit-all"
-      Cucumber.wants_to_quit = true
-      self.exit_flag = true and return
-    
-    when "help"
-      display_help
-
-    when "last-step"
-      puts last_input
-
-    when "save"
-      save_last_input
-
-    else
-      execute_cucumber_step(input)
-
-    end
-  rescue Exception => e
-    puts e.inspect
-    puts e.backtrace.join("\n") if FULL_BACKTRACE
-  end
-
-
-  ## COMMANDS 
-
-  def display_help
-    puts ":: Write a step here and watch it happen on the browser"
-    puts ":: Available commands:"
-    puts "::   save      - saves last step into current feature file"
-    puts "::   last-step - display last executed step (to be saved on 'save' command)"
-    puts "::   exit      - exits current scenario"
-    puts "::   exit-all  - exists whole Cucumber feature"
-    puts "::   help      - display this notification"
-  end
-
-  def save_last_input
-    if last_input.blank?
-      puts "Hm... nothing to save yet?"
-    else
-      File.open(feature_file, 'a') do |f|
-        f.puts((" " * spaces_in_last_line) + last_input) 
-      end
-
-      puts "Saved \"#{last_input}\" to #{File.basename(feature_file)}"
-      self.last_input = nil
-    end
-  end
-
-  def execute_cucumber_step(input)
-    self.last_input = input
-    input = "#{input.split.first} '#{input.split[1..-1].join(' ')}'" # making it like >>  When 'I do this and that'
-    world.instance_eval input
-  end
-
-
-  ## HELPERS
-
-  def feature_file
-    @feature_file ||= File.join(Rails.root, scenario.file_colon_line.split(":").first)
-  end
-
-  def spaces_in_last_line
-    for line in File.readlines(feature_file).reverse
-      unless line.blank?
-        spaces = line =~ /\S/
-        return spaces
-      end
-    end
-
-    0
-  end
-end