lucid 0.3.3 → 0.4.0

data/lib/lucid/{tdl_builder.rb → spec_builder.rb}

@@ -5,8 +5,8 @@ require 'lucid/ast/empty_background'
 
 module Lucid
   module Parser
-    # The TDL Builder conforms to the Gherkin event API.
-    class TDLBuilder
+    # The SpecBuilder conforms to the Gherkin event API.
+    class SpecBuilder
       include Gherkin::Rubify
 
       def initialize(path = 'UNKNOWN-FILE')
@@ -26,16 +26,19 @@ module Lucid
         @path = uri
       end
 
+      # @param node [Object] instance of Gherkin::Formatter::Model::Feature
       def feature(node)
         @feature_builder = FeatureBuilder.new(file, node)
       end
 
+      # @param node [Object] instance of Gherkin::Formatter::Model::Background
       def background(node)
         builder = BackgroundBuilder.new(file, node)
         @feature_builder.background_builder = builder
         @current = builder
       end
 
+      # @param node [Object] instance of Gherkin::Formatter::Model::Scenario
       def scenario(node)
         builder = ScenarioBuilder.new(file, node)
         @feature_builder.add_child builder
@@ -50,8 +53,8 @@ module Lucid
 
       def examples(examples)
         examples_fields = [
-          AST::Location.new(file, examples.line),
-          AST::Comment.new(examples.comments.map{|comment| comment.value}.join("\n")),
+          Lucid::AST::Location.new(file, examples.line),
+          Lucid::AST::Comment.new(examples.comments.map{|comment| comment.value}.join("\n")),
           examples.keyword,
           examples.name,
           examples.description,
@@ -60,6 +63,7 @@ module Lucid
         @current.add_examples examples_fields, examples
       end
 
+      # @param node [Object] instance of Gherkin::Formatter::Model::Step
       def step(node)
         builder = StepBuilder.new(file, node)
         @current.add_child builder
@@ -69,7 +73,7 @@ module Lucid
       end
 
       def syntax_error(state, event, legal_events, line)
-        # raise "SYNTAX ERROR"
+        # Unsure if I should raise something here.
       end
 
       private
@@ -91,7 +95,7 @@ module Lucid
       end
 
       def language
-        @language || raise("Language has not been set")
+        @language || raise('Language has not been set.')
       end
 
       def file
@@ -102,7 +106,7 @@ module Lucid
         end
       end
 
-      class Builder
+      class Spec
         def initialize(file, node)
           @file, @node = file, node
         end
@@ -110,24 +114,24 @@ module Lucid
         private
 
         def tags
-          AST::Tags.new(nil, node.tags)
+          Lucid::AST::Tags.new(nil, node.tags)
         end
 
         def location
-          AST::Location.new(file, node.line)
+          Lucid::AST::Location.new(file, node.line)
         end
 
         def comment
-          AST::Comment.new(node.comments.map{ |comment| comment.value }.join("\n"))
+          Lucid::AST::Comment.new(node.comments.map{ |comment| comment.value }.join("\n"))
         end
 
         attr_reader :file, :node
       end
 
-      class FeatureBuilder < Builder
+      class FeatureBuilder < Spec
         def result(language)
           background = background(language)
-          feature = AST::Feature.new(
+          feature = Lucid::AST::Feature.new(
             location,
             background,
             comment,
@@ -157,14 +161,14 @@ module Lucid
         private
 
         def background(language)
-          return AST::EmptyBackground.new unless @background_builder
+          return Lucid::AST::EmptyBackground.new unless @background_builder
           @background ||= @background_builder.result(language)
         end
       end
 
-      class BackgroundBuilder < Builder
+      class BackgroundBuilder < Spec
         def result(language)
-          background = AST::Background.new(
+          background = Lucid::AST::Background.new(
             language,
             location,
             comment,
@@ -191,9 +195,9 @@ module Lucid
 
       end
 
-      class ScenarioBuilder < Builder
+      class ScenarioBuilder < Spec
         def result(background, language, feature_tags)
-          scenario = AST::Scenario.new(
+          scenario = Lucid::AST::Scenario.new(
             language,
             location,
             background,
@@ -222,9 +226,9 @@ module Lucid
         end
       end
 
-      class ScenarioOutlineBuilder < Builder
+      class ScenarioOutlineBuilder < Spec
         def result(background, language, feature_tags)
-          scenario_outline = AST::ScenarioOutline.new(
+          scenario_outline = Lucid::AST::ScenarioOutline.new(
             language,
             location,
             background,
@@ -263,14 +267,14 @@ module Lucid
         attr_reader :examples_sections
       end
 
-      class StepBuilder < Builder
+      class StepBuilder < Spec
         def result(language)
-          step = AST::Step.new(
+          step = Lucid::AST::Step.new(
             language,
             location,
             node.keyword,
             node.name,
-            AST::MultilineArgument.from(node.doc_string || node.rows)
+            Lucid::AST::MultilineArgument.from(node.doc_string || node.rows)
           )
           step.gherkin_statement(node)
           step

data/lib/lucid/spec_file.rb

@@ -1,4 +1,4 @@
-require 'lucid/tdl_builder'
+require 'lucid/spec_builder'
 require 'gherkin/formatter/filter_formatter'
 require 'gherkin/formatter/tag_count_formatter'
 require 'gherkin/parser/parser'
@@ -29,30 +29,31 @@ module Lucid
     def parse(specified_filters, tag_counts)
       filters = @lines || specified_filters
 
-      tdl_builder         = Lucid::Parser::TDLBuilder.new(@path)
-      filter_formatter    = filters.empty? ? tdl_builder : Gherkin::Formatter::FilterFormatter.new(tdl_builder, filters)
+      spec_builder         = Lucid::Parser::SpecBuilder.new(@path)
+      filter_formatter    = filters.empty? ? spec_builder : Gherkin::Formatter::FilterFormatter.new(spec_builder, filters)
       tag_count_formatter = Gherkin::Formatter::TagCountFormatter.new(filter_formatter, tag_counts)
 
       # Gherkin Parser parameters:
       # formatter, raise_on_error, machine_name, force_ruby
       # The machine name refers to a state machine table.
-      parser              = Gherkin::Parser::Parser.new(tag_count_formatter, true, "root", false)
+      parser              = Gherkin::Parser::Parser.new(tag_count_formatter, true, 'root', false)
 
       begin
         # parse parameters:
         # gherkin, feature_uri, line_offset
         parser.parse(source, @path, 0)
-        tdl_builder.language = parser.i18n_language
-        tdl_builder.result
-      rescue Gherkin::Lexer::LexingError, Gherkin::Parser::ParseError => e
-        e.message.insert(0, "#{@path}: ")
-        raise e
+        spec_builder.language = parser.i18n_language
+        spec_builder.result
+        rescue Gherkin::Lexer::LexingError => e
+        handle_lexing_error(e)
+      rescue Gherkin::Parser::ParseError => e
+        handle_parsing_error(e)
       end
     end
 
     # The source method is used to return a properly encoded spec file.
     # If the spec source read in declares a different encoding, then this
-    # method will make sure to use Lucid's default encoding.
+    # method will make sure to use the default encoding of Lucid.
     def source
       @source ||= if @path =~ /^http/
         require 'open-uri'
@@ -70,13 +71,13 @@ module Lucid
           e.message << "\nLucid was unable to access #{File.expand_path(@path)}."
           raise e
         rescue Errno::ENOENT => e
-          if @path == "specs"
+          if @path == 'specs'
             STDOUT.puts ["\nYou don't have a 'specs' directory. This is the default specification",
-                         "directory that Lucid will use if one is not specified. So either create",
+                         'directory that Lucid will use if one is not specified. So either create',
                          "that directory or specify where your test repository is located.\n\n"].join("\n")
           else
             STDOUT.puts ["\nThere is no '#{@path}' directory. Since that is what you specified as",
-                         "your spec repository, this directory must be present."].join("\n")
+                         'your spec repository, this directory must be present.'].join("\n")
           end
           Kernel.exit(1)
         end
@@ -85,6 +86,25 @@ module Lucid
 
     private
 
+    def handle_lexing_error(e)
+      core_exception = e.message[0..e.message.index('See http:') - 1]
+      core_exception.insert(0, "Lucid was looking at: #{@path}\n\n")
+      puts 'Lucid: Lexing Error with Gherkin'
+      puts core_exception
+      Kernel.exit(1)
+    end
+
+    def handle_parsing_error(e)
+      core_exception = "Lucid was looking at: #{@path}\n\n"
+      core_message_start = e.message.index('Found')
+      core_state_start = e.message.index('(Current')
+      core_message = e.message[core_message_start..core_state_start - 1]
+      core_state = e.message[core_state_start..-1]
+      puts 'Lucid: Parsing Error with Gherkin'
+      puts core_exception, core_message, core_state
+      Kernel.exit(1)
+    end
+
     def encoding_for(source)
       encoding = DEFAULT_ENCODING
 

data/lib/lucid/{runtime/specs_loader.rb → spec_loader.rb}

@@ -1,32 +1,28 @@
 require 'lucid/errors'
 
 module Lucid
-  class Runtime
-    class SpecsLoader
+  class ContextLoader
+    class SpecLoader
       include Formatter::Duration
 
       def initialize(spec_files, filters, tag_expression)
         @spec_files, @filters, @tag_expression = spec_files, filters, tag_expression
       end
 
-      # @see Lucid::Runtime.specs
-      def specs
-        load unless (defined? @specs) and @specs
-        @specs
+      # @see Lucid::ContextLoader.load_spec_context
+      def load_specs
+        load unless (defined? @spec) and @spec
+        @spec
       end
 
-    private
+      private
 
       # The specs loader will call upon load to load up all specs that were
-      # found in the spec repository. During this process, a Specs instance
+      # found in the spec repository. During this process, a Spec instance
       # is created that will hold instances of the high level construct,
       # which is basically the feature.
       def load
-        specs = AST::Specs.new
-
-        # Note that "specs" is going to be an instance of Lucid::AST::Specs.
-        # It will contain a @specs instance variable that is going to contain
-        # an specs found.
+        spec = Lucid::AST::Spec.new
 
         tag_counts = {}
         start = Time.new
@@ -35,15 +31,10 @@ module Lucid
         @spec_files.each do |f|
           spec_file = SpecFile.new(f)
 
-          # The "spec_file" will contain a Lucid::SpecFile instance, a
-          # primary attribute of which will be a @location instance variable.
-
-          spec = spec_file.parse(@filters, tag_counts)
-
-          # The "spec" will contain an instance of Lucid::AST::Feature.
+          feature = spec_file.parse(@filters, tag_counts)
 
-          if spec
-            specs.add_feature(spec)
+          if feature
+            spec.add_feature(feature)
             log.info("  * #{f}\n")
           end
         end
@@ -53,7 +44,7 @@ module Lucid
 
         check_tag_limits(tag_counts)
 
-        @specs = specs
+        @spec = spec
       end
 
       def check_tag_limits(tag_counts)

data/lib/lucid/{step_definition_light.rb → step_definition_usage.rb}

@@ -1,8 +1,6 @@
 module Lucid
-  # Only used for keeping track of available and invoked step definitions
-  # in a way that also works for other programming languages (i.e. cuke4duke)
-  # Used for reporting purposes only (usage formatter).
-  class StepDefinitionLight
+  # Only used for keeping track of available and invoked step definitions.
+  class StepDefinitionUsage
     attr_reader :regexp_source, :file_colon_line
 
     def initialize(regexp_source, file_colon_line)

data/lib/lucid/step_definitions.rb

@@ -1,9 +1,9 @@
 module Lucid
   class StepDefinitions
-    def initialize(configuration = Configuration.default)
-      configuration = Configuration.parse(configuration)
-      @orchestrator = Runtime::Orchestrator.new(nil, false)
-      @orchestrator.load_files_from_paths(configuration.autoload_code_paths)
+    def initialize(context = Context.default)
+      context = Context.parse(context)
+      @orchestrator = ContextLoader::Orchestrator.new(nil, false)
+      @orchestrator.load_files_from_paths(context.autoload_code_paths)
     end
 
     def to_json

data/spec/lucid/app_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lucid/tdl_builder'
+require 'lucid/spec_builder'
 require 'gherkin/formatter/model'
 
 module Lucid
@@ -23,7 +23,7 @@ module Lucid
 
           it 'configures the runtime' do
             configuration = double('Configuration').as_null_object
-            Configuration.stub(:new => configuration)
+            Context.stub(:new => configuration)
             runtime.should_receive(:configure).with(configuration)
             kernel.should_receive(:exit).with(1)
             do_start
@@ -31,7 +31,7 @@ module Lucid
 
           it 'uses that runtime for running and reporting results' do
             results = double('results', :failure? => true)
-            runtime.should_receive(:run)
+            runtime.should_receive(:execute)
             runtime.stub(:results).and_return(results)
             kernel.should_receive(:exit).with(1)
             do_start
@@ -45,8 +45,8 @@ module Lucid
 
           it 'should register as a failure' do
             results = double('results', :failure? => false)
-            runtime = Runtime.any_instance
-            runtime.stub(:run)
+            runtime = ContextLoader.any_instance
+            runtime.stub(:excute)
             runtime.stub(:results).and_return(results)
 
             Lucid.wants_to_quit = true
@@ -58,7 +58,7 @@ module Lucid
 
       describe 'verbose execution' do
         before(:each) do
-          b = Lucid::Parser::TDLBuilder.new('specs/test.spec')
+          b = Lucid::Parser::SpecBuilder.new('specs/test.spec')
           b.feature(Gherkin::Formatter::Model::Feature.new([], [], 'Feature', 'Testing', '', 99, ''))
           b.language = double
           @empty_feature = b.result
@@ -77,18 +77,6 @@ module Lucid
         end
       end
 
-      describe 'handling exceptions' do
-        [ProfilesNotDefinedError, YmlLoadError, ProfileNotFound].each do |exception_class|
-          it "rescues #{exception_class}, prints the message to the error stream" do
-            Configuration.stub(:new).and_return(configuration = double('configuration'))
-            configuration.stub(:parse).and_raise(exception_class.new('error message'))
-
-            subject.start!
-            stderr.string.should == "error message\n"
-          end
-        end
-      end
-
     end
   end
 end

data/spec/lucid/ast/background_spec.rb

@@ -11,7 +11,7 @@ module Lucid
 
       before do
         extend(Lucid::InterfaceRb::RbLucid)
-        @runtime = Lucid::Runtime.new
+        @runtime = Lucid::ContextLoader.new
         @rb = @runtime.load_code_language('rb')
 
         $x = $y = nil
@@ -22,7 +22,7 @@ module Lucid
           $y = $x * n.to_i
         end
 
-        @visitor = TDLWalker.new(@runtime)
+        @visitor = Walker.new(@runtime)
 
         @feature = double('feature', :visit? => true, :feature_elements => []).as_null_object
       end
@@ -122,7 +122,7 @@ module Lucid
           background.should be_failed
         end
       end
-      
+
     end
   end
-end
+end

data/spec/lucid/ast/feature_spec.rb

@@ -5,20 +5,20 @@ module Lucid
   module AST
     describe Feature do
       include TDLFactory
-      
+
       it 'should convert to a symbolic expression' do
-        runtime = Lucid::Runtime.new
+        runtime = Lucid::ContextLoader.new
         runtime.load_code_language('rb')
         dsl = Object.new
         dsl.extend Lucid::InterfaceRb::RbLucid
-        
+
         feature = create_feature(dsl)
         if Lucid::WINDOWS
           feature_file_path = 'specs\\test.spec'
         else
           feature_file_path = 'specs/test.spec'
         end
-        
+
         feature.to_sexp.should ==
             [
                 :feature,
@@ -48,7 +48,7 @@ module Lucid
       end
 
       it 'should store operating system specific file paths' do
-        runtime = Lucid::Runtime.new
+        runtime = Lucid::ContextLoader.new
         runtime.load_code_language('rb')
         dsl = Object.new
         dsl.extend Lucid::InterfaceRb::RbLucid
@@ -60,7 +60,7 @@ module Lucid
           feature.file.should == 'specs/test.spec'
         end
       end
-      
+
     end
   end
-end
+end