Exspec 1.0.2 → 1.0.3

data/bin/exspec

@@ -1,14 +1,29 @@
 #!/usr/bin/env ruby
 
-require "exspec"
+ARG_PREFIX = "--"
+DEBUG_ARG = "debug"
 
-if ARGV.empty?
+spec_args = ARGV.take_while { |arg| !arg.start_with?(ARG_PREFIX) }
+ARGV.shift spec_args.length
+debug = ARGV.delete ARG_PREFIX + DEBUG_ARG
+
+if debug
+  require_relative "../lib/exspec"
+else
+  require "exspec"
+end
+
+if spec_args.empty?
+  Exspec::Extension.test_hook(:before_stack, nil)
+  Exspec::Extension.test_hook(:before, nil)
   started = Exspec::Extension.start_exspec
   Exspec::IrbExspec.start_irb unless started
+  Exspec::Extension.test_hook(:after, nil)
+  Exspec::Extension.test_hook(:after_stack, nil)
 else
   exspec = Exspec::Exspec.new
 
-  spec_arg = ARGV.join " "
+  spec_arg = spec_args.join " "
   spec = exspec.spec spec_arg
 
   reporter = Exspec::REGRESSION_TEST_REPORTER.new
@@ -18,9 +33,7 @@ else
     specs = exspec.specs spec_arg, true
     specs.each do |spec|
       spec.stack.each do |parent|
-        if parent != spec
-          specs.delete(parent)
-        end
+        specs.delete(parent) if parent != spec
       end
     end
     exspec.report_to(reporter) { exspec.run_specs specs }

data/lib/exspec.rb

@@ -7,10 +7,11 @@ require_relative "exspec/logger"
 require_relative "exspec/spec_runner"
 require_relative "exspec/reporter"
 require_relative "exspec/regression_test_reporter"
-require_relative "exspec/helpers"
+require_relative "exspec/helpers/helpers"
 require_relative "exspec/extensions/extension"
 require_relative "exspec/extensions/mocking"
 require_relative "exspec/extensions/rails"
+require_relative "exspec/extensions/capybara"
 parent_dirs do |parent_dir|
   configured = false
   ["exspec.rb", "config/exspec.rb", "exspec/config.rb", "exspec/exspec.rb"].each do |file|
@@ -31,7 +32,7 @@ module Exspec
       :regression_test_reporter => RegressionTestReporter
     }
     Extension.config config
-    config
+    @@config = config
   end
 
   TEST_DIR = File.expand_path(config[:test_dir])
@@ -52,6 +53,8 @@ module Exspec
       @logger = components[:logger] || Logger.new
       @runner = components[:runner] || SpecRunner.new(self)
       @reporter = components[:reporter] || Reporter.new
+      @execute_stack = []
+      Extension.initialized_exspec self
     end
 
     delegate :without_logging, :last_instruction, :erase_last_instruction, :log, :to => :@logger
@@ -68,17 +71,19 @@ module Exspec
     end
 
     def execute(instruction)
+      @execute_stack << false
       executor.eval instruction do |callbacks|
         callbacks.after do |command, params, value|
           context.last_exspec_value = value
           if command.nil?
             commit instruction, value
           end
-          if last_exspec_value != last_value || command == "_" || command == ""
+          if @execute_stack.length == 1 && (last_exspec_value != last_value || command == "_" || command == "")
             puts "#{COMMAND_PREFIX}_: #{last_exspec_value.inspect}"
           end
         end
       end
+      @execute_stack.pop
     end
 
     def report_to(reporter=reporter)
@@ -96,15 +101,24 @@ module Exspec
 
     def save(description, comment=nil)
       comment(comment) unless comment.nil?
-      spec_manager.save logger, description
+      spec = spec_manager.save logger, description
+      Extension.test_hook(:after, spec)
+      Extension.test_hook(:before, nil)
+      spec
     end
 
     def load(description)
+      Extension.test_hook(:after, nil)
+      Extension.test_hook(:after_stack, nil)
       reset
       spec = spec(description)
-      return nil if spec.nil?
-      without_logging { runner.run_stack spec }
-      spec_manager.current_spec = spec
+      Extension.test_hook(:before_stack, nil)
+      unless spec.nil?
+        without_logging { runner.run_stack spec }
+        spec_manager.current_spec = spec
+      end
+      Extension.test_hook(:before, nil)
+      spec
     end
 
     def include(description)
@@ -118,6 +132,7 @@ module Exspec
     def retry
       instructions = logger.instructions
       load current_spec
+      Extension.test_hook(:before, nil)
       instructions.each do |instruction|
         execute instruction rescue nil
       end
@@ -143,11 +158,16 @@ module Exspec
     end
 
     def assert(statement=nil, comment=nil)
-      val = without_logging { raw_eval statement }
-      if val
-        spec_succeeded "Successful: #{comment || statement}"
-      else
-        spec_failed "Failed: #{comment || statement}"
+      begin
+        val = without_logging { raw_eval statement }
+        if val
+          spec_succeeded "Successful: #{comment || statement}"
+        else
+          spec_failed "Failed: #{comment || statement}"
+        end
+      rescue Exception => e
+        val = e
+        spec_failed "Failed due to an exception: #{comment || statement} (#{e})"
       end
       commit "#{COMMAND_PREFIX}assert #{statement.strip}" + (comment ? " #{COMMENT_SIGN}#{comment}" : "")
       val
@@ -156,7 +176,7 @@ module Exspec
     def expect(statement=nil, comment=nil)
       return expect_inspect nil, comment if statement.nil?
       actual = last_value
-      expect = without_logging { raw_eval statement }
+      expect = value_or_exception { without_logging { raw_eval statement } }
       if expect == actual
         spec_succeeded "Successful: #{comment || "value is #{prepare_output(expect)}"}"
       else
@@ -195,7 +215,12 @@ module Exspec
       last_value.is_a?(String) ? last_value : last_value.inspect
     end
 
+    def commited?
+      @execute_stack.last
+    end
+
     def commit(instruction, value=last_value)
+      @execute_stack[@execute_stack.length - 1] = true unless @execute_stack.empty?
       logger.log instruction, value
       return_spec value
     end
@@ -209,6 +234,15 @@ module Exspec
       return "\"#{value}\"" if value.is_a? String
       value
     end
+
+    def value_or_exception
+      begin
+        val = yield
+      rescue Exception => e
+        val = e
+      end
+      val
+    end
   end
 end
 

data/lib/exspec/context_manager.rb

@@ -62,7 +62,11 @@ module Exspec
     def setup_global_context
       global_instance = global_eval "self"
       global_instance.instance_variable_set :@exspec, @exspec
-      global_instance.class.send :attr_reader, :exspec
+      class << global_instance
+        def exspec
+          @exspec
+        end
+      end
       global_eval "_ = nil"
       Extension.setup_global_context self, global_instance
     end

data/lib/exspec/executor.rb

@@ -6,7 +6,7 @@ module Exspec
       @exspec = exspec
     end
 
-    delegate :puts, :print, :return_spec, :context, :commit, :to => :@exspec
+    delegate :puts, :print, :return_spec, :context, :commit, :commited?, :without_logging, :value_or_exception, :to => :@exspec
     attr_reader :exspec
 
     def eval(instruction, &callback_block)
@@ -22,7 +22,7 @@ module Exspec
         param_string = parts[1..-1].join " "
         eval = false
         val = Extension.execute_command self, command, param_string, callbacks
-        if val.nil?
+        if val.nil? && !commited?
           val = case command
                   when ""
                     execute(command, parameters(param_string), callbacks) do
@@ -127,6 +127,10 @@ module Exspec
                   when "reset", "clear"
                     execute(command, callbacks) do
                       exspec.reset
+                      Extension.test_hook(:after, nil)
+                      Extension.test_hook(:after_stack, nil)
+                      Extension.test_hook(:before_stack, nil)
+                      Extension.test_hook(:before, nil)
                     end
                   when "log", "instructions", "history"
                     execute(command, callbacks) do
@@ -149,9 +153,11 @@ module Exspec
                       end
                     end
                   when "no_log", "without_logging", "silent", "no_history"
-                    val = exspec.without_logging { exspec.execute param_string }
-                    return_spec exspec.logger.last_value
-                    val
+                    execute(command, parameters(param_string), callbacks) do
+                      val = without_logging { eval param_string }
+                      return_spec exspec.logger.last_value
+                      val
+                    end
                   when "log_off", "disable_log", "history_off", "disable_history"
                     execute(command, callbacks) do
                       exspec.logger.enabled = false

data/lib/exspec/extensions/capybara.rb

@@ -0,0 +1,76 @@
+require 'capybara'
+require 'capybara/dsl'
+
+module Exspec::Capybara
+  extend Exspec::Extension
+
+  @@capybara = nil
+
+  class CapybaraDSL < ContextDelegator
+    include Capybara::DSL
+  end
+
+  def self.config
+    config = {
+      :driver => :selenium
+    }
+    Exspec::Extension.apply :capybara_config, nil, false, config
+    config
+  end
+
+  initialized_exspec do |exspec|
+    @@capybara = CapybaraDSL.new exspec.context
+    Exspec::Extension.apply :capybara_setup, Capybara, false, config
+  end
+
+  capybara_setup do |config|
+    self.current_driver = config[:driver]
+  end
+
+  setup_global_context do |global_instance|
+    class << global_instance
+      def capybara
+        @@capybara
+      end
+
+      def page
+        @@capybara.page
+      end
+    end
+  end
+
+  # for examples see the comments after the commands below
+  # returned values can be checked with Exspec's assertion commands
+  execute_command do |command, param_string, options|
+    case command
+      when "capybara", "!" # E.g. !! visit "http://www.github.com"
+        execute(command, parameters(param_string), options) do
+          val = value_or_exception do
+            @@capybara.instance_eval param_string
+          end
+          commit "!capybara #{param_string}", val
+        end
+      when "!$", "!find" # E.g. !!$ div.myCssClass
+        execute(command, parameters(param_string), options) do
+          val = value_or_exception do
+            @@capybara.instance_eval { page.find(param_string) }
+          end
+          commit "!capybara page.find(\"#{param_string.inspect[1..-2]}\")", val
+        end
+      when "!<", "!eval" # E.g. !!< $("input").text() (to read values from JavaScript)
+        execute(command, parameters(param_string), options) do
+          val = value_or_exception do
+            @@capybara.instance_eval { page.evaluate_script param_string }
+          end
+          commit "!capybara page.evaluate_script(\"#{param_string.inspect[1..-2]}\")", val
+        end
+      when "!>", "!exec" # E.g. !!> $(".button").click() (to execute JavaScript)
+        execute(command, parameters(param_string), options) do
+          val = value_or_exception do
+            @@capybara.instance_eval { page.execute_script param_string }
+          end
+          commit "!capybara page.execute_script(\"#{param_string.inspect[1..-2]}\")"
+        end
+    end
+  end
+end

data/lib/exspec/extensions/extension.rb

@@ -1,70 +1,82 @@
-module Exspec::Extension
-  @@module = self
-  @@extensions = {}
+module Exspec
+  module Extension
+    @@module = self
+    @@extensions = {}
 
-  def self.loaded
-    apply :loaded
-  end
+    def self.loaded
+      apply :loaded
+    end
 
-  def self.config(config)
-    apply :config, nil, false, config
-  end
+    def self.config(config)
+      apply :config, nil, false, config
+    end
 
-  def self.start_exspec
-    apply :start_exspec, nil, true
-  end
+    def self.start_exspec
+      apply :start_exspec, nil, true
+    end
 
-  def self.set_execute_callbacks(options)
-    apply :set_execute_callbacks, nil, false, options
-  end
+    def self.set_execute_callbacks(options)
+      apply :set_execute_callbacks, nil, false, options
+    end
 
-  def self.initialize_exspec(exspec, components)
-    apply :initialize_exspec, exspec, false, components
-  end
+    def self.initialize_exspec(exspec, components)
+      apply :initialize_exspec, exspec, false, components
+    end
 
-  def self.execute_command(executor, command, param_string, options)
-    apply :execute_command, executor, true, command, param_string, options
-  end
+    def self.initialized_exspec(exspec)
+      apply :initialized_exspec, nil, false, exspec
+    end
 
-  def self.setup_context(context_manager)
-    apply :setup_context, context_manager
-  end
+    def self.execute_command(executor, command, param_string, options)
+      apply :execute_command, executor, true, command, param_string, options
+    end
 
-  def self.setup_global_context(context_manager, global_instance)
-    apply :setup_global_context, context_manager, false, global_instance
-  end
+    def self.setup_context(context_manager)
+      apply :setup_context, context_manager
+    end
 
-  def self.setup_exspec_context(context_manager)
-    apply :setup_exspec_context, context_manager
-  end
+    def self.setup_global_context(context_manager, global_instance)
+      apply :setup_global_context, context_manager, false, global_instance
+    end
 
-  def self.apply(extension_point, extended_instance=nil, return_first=false, *args)
-    extensions(extension_point).each do |extension|
-      val = if extended_instance
-              extended_instance.instance_exec *args, &extension
-            else
-              extension.call *args
-            end
-      return val if return_first && !val.nil?
+    def self.setup_exspec_context(context_manager)
+      apply :setup_exspec_context, context_manager
     end
-    return nil
-  end
 
-  def self.extensions(extension_point)
-    extension_point = extension_point.to_sym
-    extensions = (@@extensions[extension_point] = []) unless extensions = @@extensions[extension_point]
-    extensions
-  end
+    def self.test_hook(hook, spec)
+      apply extension_point(:test_hook, hook), nil, false, spec
+    end
 
-  def method_missing(method, *args, &block)
-    def_extension method, block
-  end
+    def self.apply(extension_point, extended_instance=nil, return_first=false, *args)
+      extensions(extension_point).each do |extension|
+        val = if extended_instance
+                extended_instance.instance_exec *args, &extension
+              else
+                extension.call *args
+              end
+        return val if return_first && !val.nil?
+      end
+      return nil
+    end
 
-  def extensions(extension_point)
-    @@module.extensions extension_point
-  end
+    def self.extension_point(name, *args)
+      args.unshift(name).map(&:to_s).join(":").to_sym
+    end
+
+    def self.extensions(extension_point)
+      @@extensions[extension_point.to_sym] ||= []
+    end
+
+    def method_missing(method, *args, &block)
+      def_extension @@module.extension_point(method, *args), block
+    end
+
+    def extensions(extension_point)
+      @@module.extensions extension_point
+    end
 
-  def def_extension(extension_point, block)
-    extensions(extension_point.to_sym) << block
+    def def_extension(extension_point, block)
+      extensions(extension_point.to_sym) << block
+    end
   end
 end

data/lib/exspec/helpers/context_delegator.rb

@@ -0,0 +1,38 @@
+class ContextDelegator
+  def initialize(context_manager)
+    @_context = context_manager
+    @_args = []
+    @_blocks = []
+  end
+
+  def _args(index)
+    @_args[index].call
+  end
+
+  def _block(index)
+    @_blocks[index].call
+  end
+
+  def method_missing(method, *args, &block)
+    args_params = []
+    args.each do |argument|
+      args_index = @_args.length
+      @_args << argument
+      args_params << "capybara._args(#{args_index})"
+    end
+    block_param = ""
+    if block_given?
+      block_index = @_blocks.length
+      @_blocks << block
+      block_param = ", " unless args.empty?
+      block_param << "&capybara._block(#{block_index})"
+    end
+    params = "#{args_params.join ", "}#{block_param}"
+    call = method.to_s
+    call << "(#{params})" unless params.empty?
+    val = @_context.raw_eval call
+    @_args.pop args.length
+    @_blocks.pop if block_given?
+    val
+  end
+end

data/lib/exspec/helpers/helpers.rb

@@ -0,0 +1,12 @@
+require_relative "context_delegator"
+
+def parent_dirs
+  root = File.expand_path "/"
+  level = 0
+  begin
+    relative = "../" * level
+    path = File.expand_path relative
+    yield path
+    level += 1
+  end until path == root
+end

data/lib/exspec/regression_test_reporter.rb

@@ -64,7 +64,7 @@ module Exspec
       print_indented "."
     end
 
-    def skip_signal
+    def skip_signal(breaking)
       raise SkipSignal
     end
 
@@ -81,9 +81,7 @@ module Exspec
     end
 
     def exception(exception)
-      if exception.is_a?(SpecFailedError)
-        raise exception
-      end
+      raise exception if exception.is_a? SpecFailedError
     end
 
     def show_comment(text)

data/lib/exspec/reporter.rb

@@ -8,7 +8,10 @@ module Exspec
     def executed_instruction(instruction, index, line); end
     def exception(exception); end
     def skip_signal(breaking); end
-    def show_comment(text); end
+
+    def show_comment(text)
+      puts text
+    end
 
     def puts(text)
       Kernel.puts text

data/lib/exspec/spec.rb

@@ -4,7 +4,7 @@ class Spec
   def self.name(description)
     name = File.basename(description, File.extname(description))
     name = name.split(".").last.strip
-    name.gsub(/ +/, "_").underscore
+    name.underscore.gsub(/[\W_]+/, "_")
   end
 
   def initialize(spec_manager, name, file, parent=nil)

data/lib/exspec/spec_manager.rb

@@ -51,8 +51,8 @@ module Exspec
     def specs(parent=current_spec, recursive=false)
       parent = "" if parent.nil?
       if parent.is_a?(String)
-        parent = parent.strip
-        relative_directory = current_spec.nil? ? TEST_DIR : current_spec.directory
+        parent.strip!
+        relative_directory = parent.start_with?(SPEC_SEPARATOR) || current_spec.nil? ? TEST_DIR : current_spec.directory
         parent_directory = File.expand_path(parent, relative_directory)
         return find_specs(parent_directory, recursive) if File.directory?(parent_directory)
       end
@@ -84,7 +84,7 @@ module Exspec
         if File.directory? file
           specs.push(*find_specs(file, recursively)) if recursively
         elsif file.end_with? SPEC_EXTENSION
-          specs << create_spec(file)
+          specs << create_spec(file, nil)
         end
       end
       specs

data/lib/exspec/spec_runner.rb

@@ -2,9 +2,10 @@ module Exspec
   class SpecRunner
     def initialize(exspec)
       @exspec = exspec
+      @break_on_skip_signal = false
     end
 
-    delegate :reporter, :to => :@exspec
+    delegate :reporter, :commit, :without_logging, :to => :@exspec
 
     attr_accessor :break_on_skip_signal
 
@@ -16,12 +17,14 @@ module Exspec
       spec.for_instructions do |instruction, index, line|
         reporter.execute_instruction instruction, index, line
         begin
-          val = @exspec.execute instruction
+          val = without_logging { @exspec.execute instruction }
+          commit instruction, val
         rescue SkipSignal
           reporter.skip_signal break_on_skip_signal
           break if break_on_skip_signal
         rescue Exception => e
           reporter.exception e
+          commit instruction, e
         ensure
           reporter.executed_instruction instruction, index, line
         end
@@ -36,9 +39,12 @@ module Exspec
       reporter.start_stack spec
       spec.stack.each do |spec|
         begin
+          Extension.test_hook(:before, spec)
           run spec
         rescue
           break
+        ensure
+          Extension.test_hook(:after, spec)
         end
       end
     ensure
@@ -48,7 +54,9 @@ module Exspec
     def run_specs(specs)
       specs.each do |spec|
         @exspec.reset
+        Extension.test_hook(:before_stack, spec)
         run_stack(spec)
+        Extension.test_hook(:after_stack, spec)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Exspec
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-10 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Don't write specs anymore, just save 'em while testing your code interactively.
   Specs will become a byproduct.
 email: helgeho@invelop.de
@@ -38,9 +70,12 @@ files:
 - lib/exspec/context_manager.rb
 - lib/exspec/execute_callbacks.rb
 - lib/exspec/executor.rb
+- lib/exspec/extensions/capybara.rb
 - lib/exspec/extensions/extension.rb
 - lib/exspec/extensions/mocking.rb
 - lib/exspec/extensions/rails.rb
+- lib/exspec/helpers/context_delegator.rb
+- lib/exspec/helpers/helpers.rb
 - lib/exspec/helpers.rb
 - lib/exspec/irb/irb_context_manager.rb
 - lib/exspec/irb/irb_exspec.rb