lucid 0.3.3 → 0.4.0

data/lib/lucid/{runtime/interface_io.rb → interface_io.rb}

@@ -1,7 +1,7 @@
 require 'timeout'
 
 module Lucid
-  class Runtime
+  class ContextLoader
 
     module InterfaceIO
       attr_writer :visitor
@@ -33,7 +33,7 @@ module Lucid
         @visitor.embed(src, mime_type, label)
       end
 
-    private
+      private
 
       def mri_gets(timeout_seconds)
         begin

data/lib/lucid/interface_rb/rb_language.rb

@@ -1,4 +1,4 @@
-require 'lucid/core_ext/instance_exec'
+require 'lucid/lang_extend'
 require 'lucid/interface_rb/rb_lucid'
 require 'lucid/interface_rb/rb_world'
 require 'lucid/interface_rb/rb_step_definition'
@@ -9,42 +9,32 @@ require 'lucid/interface_rb/matcher'
 begin
   require 'rspec/expectations'
 rescue LoadError
-  begin
-    require 'spec/expectations'
-    require 'spec/runner/differs/default'
-    require 'ostruct'
-  rescue LoadError
-    require 'test/unit/assertions'
-  end
+  require 'test/unit/assertions'
 end
 
 module Lucid
   module InterfaceRb
     class NilDomain < StandardError
       def initialize
-        super("Domain procs should never return nil")
+        super('Domain procs should never return nil.')
       end
     end
 
-    # Raised if there are 2 or more Domain blocks.
     class MultipleDomain < StandardError
       def initialize(first_proc, second_proc)
         message = "You can only pass a proc to #Domain once, but it's happening\n"
         message << "in two places:\n\n"
         message << first_proc.backtrace_line('Domain') << "\n"
         message << second_proc.backtrace_line('Domain') << "\n\n"
-        message << "Use Ruby modules instead to extend your worlds. See the Lucid::InterfaceRb::RbLucid#Domain RDoc\n"
+        message << "Use Ruby modules instead to extend your worlds.\n"
         super(message)
       end
     end
 
-    # This module is the Ruby implementation of the TDL API.
     class RbLanguage
       include Interface::InterfaceMethods
       attr_reader :current_domain, :step_definitions
 
-      # Get the expressions of various I18n translations of TDL keywords.
-      # In this case the TDL is based on Gherkin.
       Gherkin::I18n.code_keywords.each do |adverb|
         RbLucid.alias_adverb(adverb)
       end
@@ -61,14 +51,7 @@ module Lucid
         begin
           ::RSpec::Matchers
         rescue NameError
-          # RSpec >=1.2.4
-          begin
-            options = OpenStruct.new(:diff_format => :unified, :context_lines => 3)
-            Spec::Expectations.differ = Spec::Expectations::Differs::Default.new(options)
-            ::Spec::Matchers
-          rescue NameError
-            ::Test::Unit::Assertions
-          end
+          ::Test::Unit::Assertions
         end
       end
 
@@ -162,7 +145,7 @@ module Lucid
             raise NilDomain.new
           rescue NilDomain => e
             e.backtrace.clear
-            e.backtrace.push(proc.backtrace_line("Domain"))
+            e.backtrace.push(proc.backtrace_line('Domain'))
             raise e
           end
         else

data/lib/lucid/interface_rb/rb_step_definition.rb

@@ -1,6 +1,5 @@
 require 'lucid/step_match'
-require 'lucid/core_ext/string'
-require 'lucid/core_ext/proc'
+require 'lucid/lang_extend'
 require 'lucid/interface_rb/regexp_argument_matcher'
 
 module Lucid

data/lib/lucid/{core_ext/instance_exec.rb → lang_extend.rb}

@@ -1,69 +1,112 @@
-require 'lucid/platform'
-
-module Lucid
-  # Raised if the number of a StepDefinition's Regexp match groups
-  # is different from the number of Proc arguments.
-  class ArityMismatchError < StandardError
-  end
-end
-
-class Object #:nodoc:
-  # TODO: Move most of this stuff out to an InstanceExecutor class.
-  def lucid_instance_exec(check_arity, pseudo_method, *args, &block)
-    lucid_run_with_backtrace_filtering(pseudo_method) do
-      if check_arity && !lucid_compatible_arity?(args, block)
-        instance_exec do
-          ari = block.arity
-          ari = ari < 0 ? (ari.abs-1).to_s+"+" : ari
-          s1 = ari == 1 ? "" : "s"
-          s2 = args.length == 1 ? "" : "s"
-          raise Lucid::ArityMismatchError.new(
-            "Your block takes #{ari} argument#{s1}, but the regexp matched #{args.length} argument#{s2}."
-          )
-        end
-      else
-        instance_exec(*args, &block)
-      end
-    end
-  end
-
-  private
-
-  def lucid_compatible_arity?(args, block)
-    return true if block.arity == args.length
-    if block.arity < 0
-      return true if args.length >= (block.arity.abs - 1)
-    end
-    false
-  end
-
-  def lucid_run_with_backtrace_filtering(pseudo_method)
-    begin
-      yield
-    rescue Exception => e
-      instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `lucid_run_with_backtrace_filtering'"
-      replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
-      raise e
-    end
-  end
-
-  INSTANCE_EXEC_OFFSET = (Lucid::RUBY_2_0 || Lucid::RUBY_1_9 || Lucid::JRUBY) ? -3 : -4
-
-  def replace_instance_exec_invocation_line!(backtrace, instance_exec_invocation_line, pseudo_method)
-    return if Lucid.use_full_backtrace
-
-    instance_exec_pos = backtrace.index(instance_exec_invocation_line)
-    if instance_exec_pos
-      replacement_line = instance_exec_pos + INSTANCE_EXEC_OFFSET
-      backtrace[replacement_line].gsub!(/`.*'/, "`#{pseudo_method}'") if pseudo_method
-
-      depth = backtrace.count { |line| line == instance_exec_invocation_line }
-      end_pos = depth > 1 ? instance_exec_pos : -1
-
-      backtrace[replacement_line+1..end_pos] = nil
-      backtrace.compact!
-    else
-      # Not sure what should happen here.
-    end
-  end
-end
+require 'lucid/platform'
+
+module Lucid
+  # Raised if the number of a StepDefinition's Regexp match groups
+  # is different from the number of Proc arguments.
+  class ArityMismatchError < StandardError
+  end
+end
+
+class String
+  def indent(n)
+    if n >= 0
+      gsub(/^/, ' ' * n)
+    else
+      gsub(/^ {0,#{-n}}/, '')
+    end
+  end
+end
+
+class Proc
+  PROC_PATTERN = /[\d\w]+@(.+):(\d+).*>/
+  PWD = Dir.pwd
+
+  def to_comment_line
+    "# #{file_colon_line}"
+  end
+
+  def backtrace_line(name)
+    "#{file_colon_line}:in `#{name}'"
+  end
+
+  if Proc.new{}.to_s =~ PROC_PATTERN
+    def file_colon_line
+      path, line = *to_s.match(PROC_PATTERN)[1..2]
+      path = File.expand_path(path)
+      pwd = File.expand_path(PWD)
+      pwd.force_encoding(path.encoding)
+      if path.index(pwd)
+        path = path[pwd.length+1..-1]
+      elsif path =~ /.*\/gems\/(.*\.rb)$/
+        path = $1
+      end
+      "#{path}:#{line}"
+    end
+  else
+    STDERR.puts '*** This implementation of Ruby does not report file and line information for procs. ***'
+
+    def file_colon_line
+      'UNKNOWN:-1'
+    end
+  end
+end
+
+class Object
+  def lucid_instance_exec(check_arity, pseudo_method, *args, &block)
+    lucid_run_with_backtrace_filtering(pseudo_method) do
+      if check_arity && !lucid_compatible_arity?(args, block)
+        instance_exec do
+          ari = block.arity
+          ari = ari < 0 ? (ari.abs-1).to_s + '+' : ari
+          s1 = ari == 1 ? '' : 's'
+          s2 = args.length == 1 ? '' : 's'
+          raise Lucid::ArityMismatchError.new(
+            "Your block takes #{ari} argument#{s1}, but the expression matched #{args.length} argument#{s2}."
+          )
+        end
+      else
+        instance_exec(*args, &block)
+      end
+    end
+  end
+
+  private
+
+  def lucid_compatible_arity?(args, block)
+    return true if block.arity == args.length
+    if block.arity < 0
+      return true if args.length >= (block.arity.abs - 1)
+    end
+    false
+  end
+
+  def lucid_run_with_backtrace_filtering(pseudo_method)
+    begin
+      yield
+    rescue Exception => e
+      instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `lucid_run_with_backtrace_filtering'"
+      replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
+      raise e
+    end
+  end
+
+  INSTANCE_EXEC_OFFSET = (Lucid::RUBY_2_0 || Lucid::RUBY_1_9 || Lucid::JRUBY) ? -3 : -4
+
+  def replace_instance_exec_invocation_line!(backtrace, instance_exec_invocation_line, pseudo_method)
+    return if Lucid.use_full_backtrace
+
+    instance_exec_pos = backtrace.index(instance_exec_invocation_line)
+    if instance_exec_pos
+      replacement_line = instance_exec_pos + INSTANCE_EXEC_OFFSET
+      backtrace[replacement_line].gsub!(/`.*'/, "`#{pseudo_method}'") if pseudo_method
+
+      depth = backtrace.count { |line| line == instance_exec_invocation_line }
+      end_pos = depth > 1 ? instance_exec_pos : -1
+
+      backtrace[replacement_line+1..end_pos] = nil
+      backtrace.compact!
+    else
+      # Not sure what should happen here.
+    end
+  end
+end

data/lib/lucid/{runtime/orchestrator.rb → orchestrator.rb}

@@ -1,11 +1,9 @@
 require 'lucid/factory'
 require 'lucid/ast/multiline_argument'
-require 'lucid/runtime/facade'
+require 'lucid/facade'
 
 module Lucid
-
-  class Runtime
-
+  class ContextLoader
     class Orchestrator
 
       require 'forwardable'
@@ -20,7 +18,7 @@ module Lucid
         end
 
         def step(step)
-          @orchestrator.invoke(step.name, AST::MultilineArgument.from(step.doc_string || step.rows))
+          @orchestrator.invoke(step.name, Lucid::AST::MultilineArgument.from(step.doc_string || step.rows))
         end
 
         def eof
@@ -29,16 +27,16 @@ module Lucid
 
       include Factory
 
-      def initialize(user_interface, configuration={})
-        @configuration = Configuration.parse(configuration)
-        @runtime_facade = Runtime::Facade.new(self, user_interface)
+      def initialize(user_interface, context={})
+        @context = Context.parse(context)
+        @runtime_facade = ContextLoader::Facade.new(self, user_interface)
         @unsupported_languages = []
         @supported_languages = []
         @language_map = {}
       end
 
-      def configure(new_configuration)
-        @configuration = Configuration.parse(new_configuration)
+      def configure(new_context)
+        @context = Context.parse(new_context)
       end
 
       # Invokes a series of steps +steps_text+. Example:
@@ -66,19 +64,24 @@ module Lucid
       # The orchestrator will register the the code language and load up an
       # implementation of that language. There is a provision to make sure
       # that the language is not already registered.
-      def load_code_language(code)
-        return @language_map[code] if @language_map[code]
-        lucid_language = create_object_of("Lucid::Interface#{code.capitalize}::#{code.capitalize}Language")
+      #
+      # @param type [String] the type of file, passed in as an extension value
+      # @return [Object] language class
+      def load_code_language(type)
+        return @language_map[type] if @language_map[type]
+        lucid_language = create_object_of("Lucid::Interface#{type.capitalize}::#{type.capitalize}Language")
         language = lucid_language.new(@runtime_facade)
         @supported_languages << language
-        @language_map[code] = language
+        @language_map[type] = language
         language
       end
 
       # The orchestrator will load only the loadable execution context files.
       # This is how the orchestrator will, quite literally, orchestrate the
       # execution of specs with the code logic that supports those specs.
-      # @see Lucid::Runtime.load_execution_context
+      #
+      # @param files [Array] all files gathering for the execution context
+      # @see Lucid::ContextLoader.load_execution_context
       def load_files(files)
         log.info("Orchestrator Load Files:\n")
         files.each do |file|
@@ -98,10 +101,10 @@ module Lucid
         end.flatten
       end
 
-      def matcher_text(step_keyword, step_name, multiline_arg_class) #:nodoc:
+      def matcher_text(step_keyword, step_name, multiline_arg_class)
         load_code_language('rb') if unknown_programming_language?
         @supported_languages.map do |programming_language|
-          programming_language.matcher_text(step_keyword, step_name, multiline_arg_class, @configuration.matcher_type)
+          programming_language.matcher_text(step_keyword, step_name, multiline_arg_class, @context.matcher_type)
         end.join("\n")
       end
 
@@ -131,7 +134,7 @@ module Lucid
         end.flatten
       end
 
-      def step_match(step_name, name_to_report=nil) #:nodoc:
+      def step_match(step_name, name_to_report=nil)
         @match_cache ||= {}
 
         match = @match_cache[[step_name, name_to_report]]
@@ -151,7 +154,7 @@ module Lucid
       end
 
       def guess_step_matches?
-        @configuration.guess?
+        @context.guess?
       end
 
       def matches(step_name, name_to_report)
@@ -160,7 +163,7 @@ module Lucid
         end.flatten
       end
 
-      def best_matches(step_name, step_matches) #:nodoc:
+      def best_matches(step_name, step_matches)
         no_groups      = step_matches.select {|step_match| step_match.args.length == 0}
         max_arg_length = step_matches.map {|step_match| step_match.args.length }.max
         top_groups     = step_matches.select {|step_match| step_match.args.length == max_arg_length }
@@ -178,12 +181,16 @@ module Lucid
 
       # For each execution context file, the orchestrator will determine the
       # code language associated with the file.
+      #
+      # @param file [String] relative path/file reference from the spec repo
       def load_file(file)
-        if language = get_language_for(file)
+        language = get_language_for(file)
+
+        if language.nil?
+          log.info("  * #{file} [NOT SUPPORTED]\n")
+        else
           log.info("  * #{file}\n")
           language.load_code_file(file)
-        else
-          log.info("  * #{file} [NOT SUPPORTED]\n")
         end
       end
 
@@ -197,8 +204,13 @@ module Lucid
       # of a supported language. If an object is returned it will be an
       # object of this sort:
       #     Lucid::InterfaceRb::RbLanguage
+      #
+      # @param file [String] relative path/file reference from the spec repo
+      # @return [nil or class] full class reference if found, nil otherwise
       def get_language_for(file)
-        if extension = File.extname(file)[1..-1]
+        extension = File.extname(file)[1..-1]
+
+        if extension
           return nil if @unsupported_languages.index(extension)
           begin
             load_code_language(extension)

data/lib/lucid/platform.rb

@@ -2,7 +2,7 @@ require 'rbconfig'
 
 module Lucid
   unless defined?(Lucid::VERSION)
-    VERSION       = '0.3.3'
+    VERSION       = '0.4.0'
     BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/lucid')
     LIBDIR        = File.expand_path(File.dirname(__FILE__) + '/../../lib')
     JRUBY         = defined?(JRUBY_VERSION)

data/lib/lucid/{runtime/results.rb → results.rb}

@@ -1,18 +1,18 @@
 module Lucid
-  class Runtime
+  class ContextLoader
 
     class Results
-      def initialize(configuration)
-        @configuration = configuration
+      def initialize(context)
+        @context = context
         @inserted_steps = {}
         @inserted_scenarios = {}
       end
 
-      def configure(new_configuration)
-        @configuration = Configuration.parse(new_configuration)
+      def configure(new_context)
+        @context = Context.parse(new_context)
       end
 
-      def step_visited(step) #:nodoc:
+      def step_visited(step)
         step_id = step.object_id
 
         unless @inserted_steps.has_key?(step_id)
@@ -21,7 +21,7 @@ module Lucid
         end
       end
 
-      def scenario_visited(scenario) #:nodoc:
+      def scenario_visited(scenario)
         scenario_id = scenario.object_id
 
         unless @inserted_scenarios.has_key?(scenario_id)
@@ -39,7 +39,7 @@ module Lucid
         end
       end
 
-      def scenarios(status = nil) #:nodoc:
+      def scenarios(status = nil)
         @scenarios ||= []
         if(status)
           @scenarios.select{|scenario| scenario.status == status}
@@ -49,11 +49,11 @@ module Lucid
       end
 
       def failure?
-        if @configuration.wip?
+        if @context.wip?
           scenarios(:passed).any?
         else
           scenarios(:failed).any? || steps(:failed).any? ||
-          (@configuration.strict? && (steps(:undefined).any? || steps(:pending).any?))
+          (@context.strict? && (steps(:undefined).any? || steps(:pending).any?))
         end
       end
     end