lucid 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b01bc3ff174ec61a65f17cfb82cc08d924a4a10e
-  data.tar.gz: 45c1a13af33973644456fdb92fe08a3c7878b936
+  metadata.gz: b390e73608f98acdafab429d0931d92a51aa9716
+  data.tar.gz: 16d88cf605d75074f38cbaa18a2dffb05e4039ea
 SHA512:
-  metadata.gz: 3df8d6b4f7e87deabbe95b6a5ef1bfa2d8bae7241e6d4627b20ca92c9598da4c6f33928d813ca640e8c902861ef3b66e53aae3a398cef09be8ba5b28827b418f
-  data.tar.gz: d8f0da9e0190bfb05f27bd3b61cf8748608f3efd02d7a262ac78e9253d36f4cf74a6b6cfec93d1692b8dc44888f230a12dde78a9e1e5ac12d07fa94f5b590a6f
+  metadata.gz: e2e758b4b1d1816639a404479501ce44ba35602bd34670953e75e92f661c786a9e92920ab2ed6a60b6ac91a3d5b2a6279d3f3cd4a68de0dee7c04909fab4abb5
+  data.tar.gz: 166a0a2a6e087fbf28b9dd00431a463a35e0929df17b731ee48847375a9d4dedaeb46450dcd160517b520b7cdc41ad5642b413d7b846c736455580994c450f09

data/HISTORY.md

@@ -1,6 +1,19 @@
 Change Log and History
 ======================
 
+Version 0.4.0 / 2013-02-15
+--------------------------
+
+A large purpose for this release of Lucid is to clean up the internals of the code base, in particular naming code structures in such a way that they are more reflective of what they actually do. This release is very much in the category of tech-debt reduction.
+
+* This version of Lucid removes the project generator (lucid-gen) that was originally part of it. That project has been separated off into its own project [LucidGen](https://github.com/jnyman/lucid-gen). This, at least partially, responds to the issue [External Project Generator Mechanism](https://github.com/jnyman/lucid/issues/14).
+
+* A slightly better logging mechanism is in place such that executing Lucid with `--debug` specified will now provide a much better output of objects, making it easier to determine the internal state of Lucid's operations. Included with this is debug output of the AST when a spec file is read.
+
+* A change has been put in place regarding how the `--dry-run` functionality works. Prior to this release, the driver file (by default, common/support/driver.rb) would not be included when you performed a dry-run against your repository. That's still in place but now Lucid will also exclude any page or activity definition files. This was found to be necessary because those files will often utilize elements that are required in the driver file.
+
+* It is now possible to specifically indicate, via the command line, the steps path (by default, steps) and the definitions page (by default, pages). The latter is meant to build in support for the concept of page objects.
+
 Version 0.3.3 / 2013-02-13
 --------------------------
 
@@ -17,13 +30,11 @@ Lucid already uses the concept of a Domain, which is similar to Cucumber's World
 
 The project generator for creating Fluent projects has been updated. The main change of note here is that the `lucid.yml` configuration file is no longer automatically generated. The reason for this is that Lucid operation requires no configuration at all if the conventions in place are what you want to use.
 
-
 Version 0.2.1 / 2013-10-21
 --------------------------
 
 This is a small patch release. The patch is in the project generator. The [Symbiont](https://github.com/jnyman/symbiont) test framework is being deprecated in favor of [Fluent](https://github.com/jnyman/fluent). The project generator has been updated accordingly.
 
-
 Version 0.2.0 / 2013-09-28
 --------------------------
 
@@ -31,7 +42,6 @@ This release introduces a fairly major change, which is that of sequences. The i
 
 This release also introduces a new formatter called "condensed." This formatter is used simply to display a much more limited set of information about the scenarios that are being executed. Specifically, all that gets returned are the scenario titles, essentially hiding all of the steps. Pass/fail information is still reported.
 
-
 Version 0.1.1 / 2013-06-04
 --------------------------
 
@@ -41,7 +51,6 @@ This patch release was needed to fix one issue and update a gem dependency.
 
 * I am trusting multi_json again by including just it and not forcing Ruby's built-in json gem. This is based on the issue [Incorrectly Reporting Old or Stdlib Json?](https://github.com/intridea/multi_json/issues/114) that I originally raised and finally had a response with the [Remove stdlib warning since it's doing more harm than good](https://github.com/intridea/multi_json/pull/122) update to multi_json.
 
-
 Version 0.1.0 / 2013-06-02
 --------------------------
 
@@ -59,7 +68,6 @@ This version is being released to introduce a few more behind-the-scenes logic r
 
 As a note, this is the final "patch" version of Lucid prior to going to a semantic versioning approach. Lucid will next enter the initial development phase.
 
-
 Version 0.0.8 / 2013-05-20
 --------------------------
 
@@ -68,7 +76,6 @@ This version is being released to bring in two specific bug fixes.
 * Certain profile options were not being recognized. ([Spec Type Specified in Profile Not Recognized](https://github.com/jnyman/lucid/issues/10).)
 * The strict mode now works more as intended. ([Using "strict" Does Not Return Errors](https://github.com/jnyman/lucid/issues/8).)
 
-
 Version 0.0.7 / 2013-05-17
 --------------------------
 
@@ -81,7 +88,6 @@ Two specific changes worth calling out:
 
 The driver file in Cucumber is env.rb. In Lucid this defaults to driver.rb. Now, however, you can override that default. Regarding the library path, this is equivalent to what Cucumber refers to as the "support" directory. The main reason for these changes is that Lucid is trying to be a little more configurable than Cucumber.
 
-
 Version 0.0.6 / 2013-05-09
 --------------------------
 
@@ -92,7 +98,6 @@ This version attempts to fix a few issues to improve general operation.
 * Lucid now handles missing directories without raising exceptions. ([Extraneous "No File or Directory" Messages](https://github.com/jnyman/lucid/issues/3).)
 * The default generator project recognizes a missing Symbiont gem. ([Stack Trace When Symbiont Not Installed](https://github.com/jnyman/lucid/issues/5).)
 
-
 Version 0.0.5 / 2013-05-04
 --------------------------
 
@@ -107,7 +112,6 @@ Lucid is aiming to be more flexible than other tools, so certain elements -- lik
 
 This is very much an alpha release to determine how feasible Lucid is as a tool.
 
-
 Versions 0.0.1 to 0.0.4
 -----------------------
 

data/README.md

@@ -13,7 +13,7 @@ Description
 
 Lucid is a Test Description Language (TDL) specification and execution engine. It is a clone of the popular tool [Cucumber](http://cukes.info/). Lucid is diverging in many ways from Cucumber but it does owe much of its initial structure to it. Lucid will also be incorporating some of the good ideas that have come to light in tools like [Spinach](https://github.com/codegram/spinach) and [Turnip](https://github.com/jnicklas/turnip).
 
-This is an alpha release of Lucid as it strives to become its own entity in the world of BDD tools.
+Lucid is currently in an extended beta period, essentially becoming its own entity in the world of BDD tools.
 
 
 Installation
@@ -35,16 +35,12 @@ Or install it yourself as:
 Using Lucid
 -----------
 
-Much more detail on how to use Lucid will be coming soon. One way to get started however is to use the Lucid project generator. If you wanted to create a project directory called 'tutorial' for example, you could do this:
-
-    $ lucid-gen project tutorial
+Right now the best way to learn about Lucid is to check out some of my [blog posts related to Lucid](http://testerstories.com/category/lucid/). They will take you through various aspects of using the framework.
 
 In order to to check what options are available to you from the command line, do this:
 
     $ lucid --help
 
-You should also check out some of my [blog posts related to Lucid](http://testerstories.com/category/lucid/). They will take you through various aspects of using the framework.
-
 
 Contributing
 ------------

data/lib/lucid.rb

@@ -1,18 +1,32 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'pp'
 require 'yaml'
 require 'logger'
+require 'stringio'
 require 'lucid/platform'
-require 'lucid/runtime'
+require 'lucid/context_loader'
 require 'lucid/cli/app'
 require 'lucid/step_definitions'
-require 'lucid/term/ansicolor'
+require 'lucid/ansicolor'
 
 module Lucid
   class << self
     attr_accessor :wants_to_quit
 
+    def breakdown(*args)
+      current_output = $stdout
+      begin
+        msg_string = StringIO.new
+        $stdout = msg_string
+        pp(*args)
+      ensure
+        $stdout = current_output
+      end
+      msg_string.string
+    end
+
     def logger
       return @log if @log
       @log = Logger.new(STDOUT)
@@ -27,7 +41,12 @@ module Lucid
 
   class LogFormatter < ::Logger::Formatter
     def call(severity, time, progname, msg)
-      "\n[ LUCID (#{severity}) ] #{msg}"
+      if msg.is_a?(String)
+        "\n[ LUCID (#{severity}) ] #{msg}\n"
+      else
+        msg = Lucid.breakdown(msg)
+        "\n[ LUCID (#{severity}) ] \n#{msg}\n"
+      end
     end
   end
 

data/lib/lucid/{term/ansicolor.rb → ansicolor.rb}

@@ -1,51 +1,44 @@
 module Lucid
   module Term
-    # The ANSIColor module can be used for namespacing and mixed into your own
-    # classes.
     module ANSIColor
-      # :stopdoc:
       ATTRIBUTES = [
-        [ :clear        ,   0 ],
-        [ :reset        ,   0 ],     # synonym for :clear
-        [ :bold         ,   1 ],
-        [ :dark         ,   2 ],
-        [ :italic       ,   3 ],     # not widely implemented
-        [ :underline    ,   4 ],
-        [ :underscore   ,   4 ],     # synonym for :underline
-        [ :blink        ,   5 ],
-        [ :rapid_blink  ,   6 ],     # not widely implemented
-        [ :negative     ,   7 ],     # no reverse because of String#reverse
-        [ :concealed    ,   8 ],
-        [ :strikethrough,   9 ],     # not widely implemented
-        [ :black        ,  30 ],
-        [ :red          ,  31 ],
-        [ :green        ,  32 ],
-        [ :yellow       ,  33 ],
-        [ :blue         ,  34 ],
-        [ :magenta      ,  35 ],
-        [ :cyan         ,  36 ],
-        [ :white        ,  37 ],
-        [ :on_black     ,  40 ],
-        [ :on_red       ,  41 ],
-        [ :on_green     ,  42 ],
-        [ :on_yellow    ,  43 ],
-        [ :on_blue      ,  44 ],
-        [ :on_magenta   ,  45 ],
-        [ :on_cyan      ,  46 ],
-        [ :on_white     ,  47 ],
+        [:clear        ,   0],
+        [:reset        ,   0],     # synonym for :clear
+        [:bold         ,   1],
+        [:dark         ,   2],
+        [:italic       ,   3],     # not widely implemented
+        [:underline    ,   4],
+        [:underscore   ,   4],     # synonym for :underline
+        [:blink        ,   5],
+        [:rapid_blink  ,   6],     # not widely implemented
+        [:negative     ,   7],     # no reverse because of String#reverse
+        [:concealed    ,   8],
+        [:strikethrough,   9],     # not widely implemented
+        [:black        ,  30],
+        [:red          ,  31],
+        [:green        ,  32],
+        [:yellow       ,  33],
+        [:blue         ,  34],
+        [:magenta      ,  35],
+        [:cyan         ,  36],
+        [:white        ,  37],
+        [:on_black     ,  40],
+        [:on_red       ,  41],
+        [:on_green     ,  42],
+        [:on_yellow    ,  43],
+        [:on_blue      ,  44],
+        [:on_magenta   ,  45],
+        [:on_cyan      ,  46],
+        [:on_white     ,  47],
       ]
 
       ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
-      # :startdoc:
 
-      # Returns true, if the coloring function of this module
-      # is switched on, false otherwise.
       def self.coloring?
         @coloring
       end
 
-      # Turns the coloring on or off globally, so you can easily do
-      # this for example:
+      # Example Usage:
       #  Lucid::Term::ANSIColor::coloring = STDOUT.isatty
       def self.coloring=(val)
         @coloring = val
@@ -73,9 +66,9 @@ module Lucid
       end
 
       # Regular expression that is used to scan for ANSI-sequences while
-      # uncoloring strings.
+      # there are uncolored strings.
       COLORED_REGEXP = /\e\[(?:[34][0-7]|[0-9])?m/
-      
+
       def self.included(klass)
         if klass == String
           ATTRIBUTES.delete(:clear)
@@ -83,9 +76,9 @@ module Lucid
         end
       end
 
-      # Returns an uncolored version of the string, that is all
-      # ANSI-sequences are stripped from the string.
-      def uncolored(string = nil) # :yields:
+      # Returns an uncolored version of the string. This means all
+      # ANSI-sequences will be stripped from the string.
+      def uncolored(string = nil)
         if block_given?
           yield.gsub(COLORED_REGEXP, '')
         elsif string

data/lib/lucid/ast.rb

@@ -1,5 +1,5 @@
 require 'lucid/ast/comment'
-require 'lucid/ast/specs'
+require 'lucid/ast/spec'
 require 'lucid/ast/feature'
 require 'lucid/ast/background'
 require 'lucid/ast/scenario'
@@ -14,7 +14,7 @@ require 'lucid/ast/tags'
 require 'lucid/ast/doc_string'
 require 'lucid/ast/outline_table'
 require 'lucid/ast/examples'
-require 'lucid/ast/tdl_walker'
+require 'lucid/ast/walker'
 
 module Lucid
   module AST

data/lib/lucid/ast/outline_table.rb

@@ -83,7 +83,7 @@ module Lucid
         end
 
         def accept(visitor)
-          if visitor.configuration.expand?
+          if visitor.context.expand?
             accept_expand(visitor)
           else
             visitor.visit_table_row(self) do
@@ -101,7 +101,7 @@ module Lucid
           else
             visitor.runtime.with_hooks(self) do
               @step_invocations.each do |step_invocation|
-                step_invocation.invoke(visitor.runtime, visitor.configuration)
+                step_invocation.invoke(visitor.runtime, visitor.context)
                 @exception ||= step_invocation.reported_exception
               end
 

data/lib/lucid/ast/{specs.rb → spec.rb}

@@ -1,6 +1,6 @@
 module Lucid
   module AST
-    class Specs #:nodoc:
+    class Spec
       include Enumerable
 
       attr_reader :duration
@@ -17,6 +17,7 @@ module Lucid
         @features.each(&proc)
       end
 
+      # @see Lucid::SpecLoader.load
       def add_feature(feature)
         @features << feature
       end
@@ -30,6 +31,8 @@ module Lucid
           start = Time.now
 
           self.each do |feature|
+            log.debug('Feature AST:')
+            log.debug(feature)
             feature.accept(visitor)
           end
 
@@ -40,6 +43,12 @@ module Lucid
       def step_count
         @features.inject(0) { |total, feature| total += feature.step_count }
       end
+
+      private
+
+      def log
+        Lucid.logger
+      end
     end
   end
 end

data/lib/lucid/ast/step.rb

@@ -1,10 +1,10 @@
-require 'lucid/core_ext/string'
+require 'lucid/lang_extend'
 require 'lucid/step_match'
 require 'lucid/ast/location'
 
 module Lucid
   module AST
-    class Step #:nodoc:
+    class Step
       include HasLocation
 
       attr_reader :keyword, :name, :language
@@ -15,7 +15,7 @@ module Lucid
 
       def initialize(language, location, keyword, name, multiline_arg=nil)
         @language, @location, @keyword, @name, @multiline_arg = language, location, keyword, name, multiline_arg
-        @language || raise("Language is required!")
+        @language || raise('Language is required.')
       end
 
       attr_reader :gherkin_statement

data/lib/lucid/ast/step_invocation.rb

@@ -5,7 +5,7 @@ require 'gherkin/rubify'
 
 module Lucid
   module AST
-    class StepInvocation #:nodoc:
+    class StepInvocation
       attr_writer :step_collection, :background
       attr_reader :name, :matched_cells, :status, :reported_exception
       attr_accessor :exception
@@ -33,58 +33,58 @@ module Lucid
 
       def accept(visitor)
         visitor.visit_step(self) do
-          invoke(visitor.runtime, visitor.configuration)
+          invoke(visitor.runtime, visitor.context)
           step_result.accept(visitor)
         end
       end
 
-      def invoke(runtime, configuration)
-        find_step_match!(runtime, configuration)
-        unless @skip_invoke || configuration.dry_run? || @exception || @step_collection.exception
+      def invoke(runtime, context)
+        find_step_match!(runtime, context)
+        unless @skip_invoke || context.dry_run? || @exception || @step_collection.exception
           @skip_invoke = true
           begin
             @step_match.invoke(@multiline_arg)
             runtime.after_step
             status!(:passed)
           rescue Pending => e
-            failed(configuration, e, false)
+            failed(context, e, false)
             status!(:pending)
           rescue Undefined => e
-            failed(configuration, e, false)
+            failed(context, e, false)
             status!(:undefined)
           rescue Lucid::AST::Table::Different => e
             @different_table = e.table
-            failed(configuration, e, false)
+            failed(context, e, false)
             status!(:failed)
           rescue Exception => e
-            failed(configuration, e, false)
+            failed(context, e, false)
             status!(:failed)
           end
         end
       end
 
-      def find_step_match!(runtime, configuration)
+      def find_step_match!(runtime, context)
         return if @step_match
         begin
           @step_match = runtime.step_match(@name)
         rescue Undefined => e
-          failed(configuration, e, true)
+          failed(context, e, true)
           status!(:undefined)
           @step_match = NoStepMatch.new(@step, @name)
         rescue Ambiguous => e
-          failed(configuration, e, false)
+          failed(context, e, false)
           status!(:failed)
           @step_match = NoStepMatch.new(@step, @name)
         end
         runtime.step_visited(self)
       end
 
-      def failed(configuration, e, clear_backtrace)
+      def failed(context, e, clear_backtrace)
         e.set_backtrace([]) if e.backtrace.nil? || clear_backtrace
         e.backtrace << @step.backtrace_line unless @step.backtrace_line.nil?
         e = filter_backtrace(e)
         @exception = e
-        if(configuration.strict? || !(Undefined === e) || e.nested?)
+        if(context.strict? || !(Undefined === e) || e.nested?)
           @reported_exception = e
         else
           @reported_exception = nil
@@ -92,7 +92,7 @@ module Lucid
       end
 
       BACKTRACE_FILTER_PATTERNS = [/vendor\/rails|lib\/lucid|bin\/lucid:|lib\/rspec|gems\/|minitest|test\/unit|\/\.gem\//]
-      
+
       if(Lucid::JRUBY)
         BACKTRACE_FILTER_PATTERNS << /org\/jruby/
       end
@@ -101,7 +101,7 @@ module Lucid
 
       def filter_backtrace(e)
         return e if Lucid.use_full_backtrace
-        e.backtrace.each{|line| line.gsub!(PWD_PATTERN, "./")}
+        e.backtrace.each{|line| line.gsub!(PWD_PATTERN, './')}
 
         filtered = (e.backtrace || []).reject do |line|
           BACKTRACE_FILTER_PATTERNS.detect { |p| line =~ p }