lucid 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d2a717993789634de1b6ae5ba60727d9ba02530
-  data.tar.gz: d93ebd52e3040fe1419f06c6e7804a82bd81aae4
+  metadata.gz: 6f6ab1b9e2bd7bdabc5f6190c735f385d635a538
+  data.tar.gz: ff6d239bc7d8e5d962c8b19de35a8e44ea9199a3
 SHA512:
-  metadata.gz: fc9a55f318ff62840ffa90e03d8f2850567809ba830c05d50132d0e0128fc601bde88fbd64dd4a1fc06ea2c81eabaeb632bb74944e279b39ca2cac58958032cd
-  data.tar.gz: 29c79a655dc6bb08a68e83eaecfe894ffa18bf1cfe8765dd6ba8a0e1045b81ca1968073fb7521a90291b985f3f2fb72152980cf3f6594b37b89e5a01dba2f052
+  metadata.gz: f45cfb6e7b5cea2e9ae16e580df9007f08156c92904eb88247ab5186ecad39b1bf7f29c187a14c14ebb8e7a16cccf927810b0e4e245f3bece110e7c5afe3bc0d
+  data.tar.gz: 33f231e265a202d24de4f770d23bace5695f8de362b15cd35ccab38662ef895f194b16c09e969845b4a15e5b77702e7a088a82812bbbf614a252f1434ac55b08

data/HISTORY.md

@@ -1,11 +1,24 @@
 Change Log and History
 ======================
 
+Version 0.3.0 / 2013-11-05
+--------------------------
+
+* Lucid now allows multiple spec file types. ([Allow Multiple Spec Files](https://github.com/jnyman/lucid/issues/6))
+
+Prior to this, Lucid would only recognize one spec file type. It was `.spec` by default or you could specify another one via the --spec-type option. Now Lucid will recognize `.feature`, `.spec`, and `.story` by default. Further, it will execute all such test spec files if it finds them. You can also still specify a custom file type via the --spec-type option. In that case Lucid will recognize your custom file type as well as all the standard ones.
+
+Lucid already uses the concept of a Domain, which is similar to Cucumber's World concept. Lucid now lets you refer to the Domain as World. This allows those familiar with Cucumber to use that wording and it also allows Lucid to better integrate into the Cucumber ecosystem.
+
+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
 --------------------------
 

data/bin/lucid

@@ -3,13 +3,7 @@
 app_lib = File.expand_path('../lib', File.dirname(__FILE__))
 $LOAD_PATH.unshift(app_lib) unless $LOAD_PATH.include?(app_lib)
 
-if(ENV['SIMPLECOV'] && RUBY_VERSION =~ /1\.9/)
-  require 'simplecov'
-  SimpleCov.root(File.expand_path(File.dirname(__FILE__) + '/..'))
-  SimpleCov.start
-end
-
 require 'lucid/rspec/disallow_options'
 require 'lucid/cli/app'
 
-Lucid::CLI::App.new(ARGV.dup).start
+Lucid::CLI::App.new(ARGV.dup).start!

data/lib/lucid/ast/doc_string.rb

@@ -4,7 +4,7 @@ module Lucid
       attr_accessor :file
 
       def self.default_arg_name
-        "string"
+        'string'
       end
 
       attr_reader :content_type

data/lib/lucid/ast/step_invocation.rb

@@ -91,8 +91,8 @@ module Lucid
         end
       end
 
-      BACKTRACE_FILTER_PATTERNS = [/vendor\/rails|lib\/lucid|bin\/lucid:|lib\/rspec|gems\/|minitest|test\/unit/]
-
+      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

data/lib/lucid/cli/app.rb

@@ -8,6 +8,10 @@ require 'lucid/cli/configuration'
 module Lucid
   module CLI
     class App
+      def self.start(args)
+        new(args).start!
+      end
+      
       def initialize(args, stdin=STDIN, out=STDOUT, err=STDERR, kernel=Kernel)
         raise "args can't be nil" unless args
         raise "out can't be nil" unless out
@@ -19,8 +23,8 @@ module Lucid
         @kernel = kernel
         @configuration = nil
       end
-
-      def start(existing_runtime = nil)
+      
+      def start!(existing_runtime = nil)
         trap_interrupt
 
         runtime = if existing_runtime

data/lib/lucid/cli/configuration.rb

@@ -25,7 +25,7 @@ module Lucid
         log.debug("Options: #{@options.inspect}")
 
         prepare_output_formatting
-        raise("You cannot use both --strict and --wip tags.") if strict? && wip?
+        raise('You cannot use both --strict and --wip tags.') if strict? && wip?
 
         @options[:tag_expression] = Gherkin::TagExpression.new(@options[:tag_expressions])
 
@@ -92,7 +92,11 @@ module Lucid
         extract_excluded_files(files)
 
         files.reject! {|f| !File.file?(f)}
-        files.reject! {|f| File.extname(f) == ".#{spec_type}" }
+
+        spec_types = spec_type.each do |type|
+          files.reject! {|f| File.extname(f) == ".#{type}" }
+        end
+
         files.reject! {|f| f =~ /^http/}
 
         files.sort
@@ -120,8 +124,15 @@ module Lucid
         files = specs_path(spec_source).map do |path|
           path = path.gsub(/\\/, '/')  # convert \ to /
           path = path.chomp('/')       # removing trailing /
+
+          files_to_sort = []
+
           if File.directory?(path)
-            Dir["#{path}/**/*.#{spec_type}"].sort
+            spec_type.each do |type|
+              files_to_sort << Dir["#{path}/**/*.#{type}"].sort
+            end
+
+            files_to_sort
           elsif path[0..0] == '@' and # @listfile.txt
               File.file?(path[1..-1]) # listfile.txt is a file
             IO.read(path[1..-1]).split
@@ -131,6 +142,7 @@ module Lucid
         end.flatten.uniq
 
         extract_excluded_files(files)
+
         files
       end
 
@@ -142,7 +154,8 @@ module Lucid
       end
 
       def spec_type
-        @options[:spec_type].empty? ? 'spec' : @options[:spec_type]
+        @options[:spec_type]
+
       end
 
       def library_path
@@ -215,7 +228,7 @@ module Lucid
         streams = @options[:formats].map { |(_, stream)| stream }
 
         if streams != streams.uniq
-          raise "All but one formatter must use --out, only one can print to each stream (or STDOUT)"
+          raise 'All but one formatter must use --out, only one can print to each stream (or STDOUT)'
         end
       end
 

data/lib/lucid/cli/options.rb

@@ -28,16 +28,16 @@ module Lucid
       largest = LUCID_FORMATS.keys.map{|s| s.length}.max
       FORMAT_LIST = (LUCID_FORMATS.keys.sort.map do |key|
         "  #{key}#{' ' * (largest - key.length)} : #{LUCID_FORMATS[key][1]}"
-      end) + ["Use --format rerun --out rerun.txt to write out failing",
-              "specs. You can rerun them with lucid @rerun.txt.",
-              "FORMAT can also be the fully qualified class name of",
+      end) + ['Use --format rerun --out rerun.txt to write out failing',
+              'specs. You can rerun them with lucid @rerun.txt.',
+              'FORMAT can also be the fully qualified class name of',
               "your own custom formatter. If the class isn't loaded,",
-              "Lucid will attempt to require a file with a relative",
-              "file name that is the underscore name of the class name.",
-              "  Example: --format Formatter::WordDoc",
-              "With that, Lucid will look for formatter/word_doc.rb",
-              "You can place the file with this relative path",
-              "underneath your common/support directory or anywhere",
+              'Lucid will attempt to require a file with a relative',
+              'file name that is the underscore name of the class name.',
+              '  Example: --format Formatter::WordDoc',
+              'With that, Lucid will look for formatter/word_doc.rb',
+              'You can place the file with this relative path',
+              'underneath your common/support directory or anywhere',
               "on Ruby's LOAD_PATH."
       ]
       PROFILE_SHORT_FLAG = '-p'
@@ -83,23 +83,24 @@ module Lucid
         @args.extend(::OptionParser::Arguable)
 
         @args.options do |opts|
-          opts.banner = ["Lucid: Test Description Language Execution Engine",
-                         "Usage: lucid [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+", "", ""
+          opts.banner = ['Lucid: Test Description Language Execution Engine',
+                         'Usage: lucid [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+', '', ''
           ].join("\n")
 
-          opts.on("--library-path PATH", "Location of spec project library files.") do |path|
+          opts.on('--library-path PATH', 'Location of spec project library files.') do |path|
             @options[:library_path] = path
           end
 
-          opts.on("--spec-type TYPE", "The file type (extension) for Lucid specifications.") do |type|
-            @options[:spec_type] = type
+          opts.on('--spec-type TYPE', 'The file type (extension) for Lucid specifications.') do |type|
+            #@options[:spec_type] = type
+            @options[:spec_type] << type
           end
 
-          opts.on("--driver-file FILE", "The file for Lucid to connect to an execution library.") do |file|
+          opts.on('--driver-file FILE', 'The file for Lucid to connect to an execution library.') do |file|
             @options[:driver_file] = file
           end
 
-          opts.separator ""
+          opts.separator ''
 
           opts.on('-r LIBRARY|DIR', '--require LIBRARY|DIR',
                   'Require files before executing the features. If this option',
@@ -107,8 +108,9 @@ module Lucid
                   'the features will be loaded automatically. Automatic loading',
                   'is disabled when this option is specified. That means all',
                   'loading becomes explicit.',
-                  "Files under directories named \"support\" will always be",
-                  'loaded first.',
+                  'Assuming a default specs repo configuration, files under',
+                  "directories named \"common\\support\" will always be loaded",
+                  'before any others.',
                   'This option can be specified multiple times.') do |v|
             @options[:require] << v
             if(Lucid::JRUBY && File.directory?(v))
@@ -147,10 +149,10 @@ module Lucid
           end
 
           opts.on('-n NAME', '--name NAME',
-                  'Lucid will only execute features or abilities that match with the name",
-                  "provided. The match can be done on partial information. If this option",
-                  "is provided multiple times, then the match will be performed against",
-                  "each set of provided names.'
+                  'Lucid will only execute features or abilities that match with the name',
+                  'provided. The match can be done on partial information. If this option',
+                  'is provided multiple times, then the match will be performed against',
+                  'each set of provided names.'
           ) do |v|
             @options[:name_regexps] << /#{v}/
           end
@@ -203,73 +205,73 @@ module Lucid
 
           opts.separator ''
 
-          opts.on("-c", "--[no-]color",
-                  "Specifies whether or not to use ANSI color in the output. If this",
-                  "option is not specified, Lucid makes the decision on colored output",
-                  "based on your platform and the output destination."
+          opts.on('-c', '--[no-]color',
+                  'Specifies whether or not to use ANSI color in the output. If this',
+                  'option is not specified, Lucid makes the decision on colored output',
+                  'based on your platform and the output destination.'
           ) do |v|
             Lucid::Term::ANSIColor.coloring = v
           end
 
-          opts.on("-m", "--no-multiline",
-                  "Lucid will not print multiline strings and tables under steps.") do
+          opts.on('-m', '--no-multiline',
+                  'Lucid will not print multiline strings and tables under steps.') do
             @options[:no_multiline] = true
           end
 
-          opts.on("-s", "--no-source",
-                  "Lucid will not print the file and line of the test definition with the steps.") do
+          opts.on('-s', '--no-source',
+                  'Lucid will not print the file and line of the test definition with the steps.') do
             @options[:source] = false
           end
 
-          opts.on("-i", "--no-matchers",
-                  "Lucid will not print matchers for pending steps.") do
+          opts.on('-i', '--no-matchers',
+                  'Lucid will not print matchers for pending steps.') do
             @options[:matchers] = false
           end
 
-          opts.on("-I", "--matchers-type TYPE",
-                  "Use different matcher type (Default: regexp).",
-                  "Available types:",
+          opts.on('-I', '--matchers-type TYPE',
+                  'Use different matcher type (Default: regexp).',
+                  'Available types:',
                   *Lucid::InterfaceRb::RbLanguage.cli_matcher_type_options
           ) do |v|
             @options[:matcher_type] = v.to_sym
           end
 
-          opts.on("-q", "--quiet", "Alias for --no-matchers --no-source.") do
+          opts.on('-q', '--quiet', 'Alias for --no-matchers --no-source.') do
             @quiet = true
           end
 
-          opts.on("-S", "--strict", "Fail if there are any undefined or pending steps.") do
+          opts.on('-S', '--strict', 'Fail if there are any undefined or pending steps.') do
             @options[:strict] = true
           end
 
-          opts.on("-w", "--wip", "Fail if there are any passing scenarios.") do
+          opts.on('-w', '--wip', 'Fail if there are any passing scenarios.') do
             @options[:wip] = true
           end
 
-          opts.on("-g", "--guess", "Guess best match for ambiguous steps.") do
+          opts.on('-g', '--guess', 'Guess best match for ambiguous steps.') do
             @options[:guess] = true
           end
 
-          opts.on("-x", "--expand", "Expand Scenario Outline tables in output.") do
+          opts.on('-x', '--expand', 'Expand Scenario Outline tables in output.') do
             @options[:expand] = true
           end
 
-          opts.separator ""
+          opts.separator ''
 
-          opts.on("--testdefs DIR", "Lucid will Write test definition metadata to the DIR.") do |dir|
+          opts.on('--testdefs DIR', 'Lucid will write test definition metadata to the DIR.') do |dir|
             @options[:testdefs] = dir
           end
 
           if(Lucid::JRUBY)
-            opts.on("-j DIR", "--jars DIR",
-                    "Load all the jars under the specified directory.") do |jars|
+            opts.on('-j DIR', '--jars DIR',
+                    'Load all the jars under the specified directory.') do |jars|
               Dir["#{jars}/**/*.jar"].each {|jar| require jar}
             end
           end
 
-          opts.on("--i18n LANG",
-                  "List keywords for a particular language.",
-                  %{Run with "--i18n help" to see all languages}) do |lang|
+          opts.on('--i18n LANG',
+                  'List keywords for a particular language.',
+                  'Run with "--i18n help" to see all languages') do |lang|
             if lang == 'help'
               list_languages_and_exit
             else
@@ -310,14 +312,14 @@ module Lucid
         rescue OptionParser::InvalidOption
           if $!.to_s =~ /invalid option\:\s+((?:-)?-\S+)/
             puts "You specified an invalid option: #{$1}"
-            puts "Please run lucid --help to see the list of available options."
+            puts 'Please run lucid --help to see the list of available options.'
           end
 
         rescue OptionParser::MissingArgument
           if $!.to_s =~ /missing argument\:\s+((?:-)?-\S+)/
             puts "You specified an valid option (#{$1}), but with an invalid argument."
-            puts "Make sure you are providing the expected argument for the option."
-            puts "Run lucid --help to see the list of available options."
+            puts 'Make sure you are providing the expected argument for the option.'
+            puts 'Run lucid --help to see the list of available options.'
           end
 
           Kernel.exit(1)
@@ -417,6 +419,7 @@ module Lucid
       def reverse_merge(other_options)
         @options = other_options.options.merge(@options)
         @options[:require] += other_options[:require]
+
         @options[:excludes] += other_options[:excludes]
         @options[:name_regexps] += other_options[:name_regexps]
         @options[:tag_expressions] += other_options[:tag_expressions]
@@ -471,9 +474,9 @@ module Lucid
           :name_regexps     => [],
           :env_vars         => {},
           :diff_enabled     => true,
-          :spec_type        => "",
-          :library_path     => "",
-          :driver_file      => ""
+          :spec_type        => %w(feature spec story),
+          :library_path     => '',
+          :driver_file      => ''
         }
       end
     end

data/lib/lucid/core_ext/instance_exec.rb

@@ -63,8 +63,7 @@ class Object #:nodoc:
       backtrace[replacement_line+1..end_pos] = nil
       backtrace.compact!
     else
-      # This happens with rails, because they screw up the backtrace
-      # before we get here (injecting erb stacktrace and such)
+      # Not sure what should happen here.
     end
   end
 end

data/lib/lucid/core_ext/proc.rb

@@ -27,10 +27,10 @@ class Proc #:nodoc:
     end
   else
     # This Ruby implementation doesn't implement Proc#to_s correctly
-    STDERR.puts "*** THIS RUBY IMPLEMENTATION DOESN'T REPORT FILE AND LINE FOR PROCS ***"
+    STDERR.puts '*** THIS RUBY IMPLEMENTATION DOES NOT REPORT FILE AND LINE FOR PROCS ***'
 
     def file_colon_line
-      "UNKNOWN:-1"
+      'UNKNOWN:-1'
     end
   end
 end

data/lib/lucid/errors.rb

@@ -1,5 +1,5 @@
 module Lucid
-  # Raised when there is no matching StepDefinition for a step.
+  # Raised when there is no matching test definition for a step.
   class Undefined < StandardError
     attr_reader :step_name
 
@@ -17,11 +17,11 @@ module Lucid
     end
   end
 
-  # Raised when a StepDefinition's block invokes Domain#pending
+  # Raised when a test definition block invokes Domain#pending.
   class Pending < StandardError
   end
 
-  # Raised when a step matches 2 or more StepDefinitions
+  # Raised when a step matches two or more test definitions.
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
       message = "Ambiguous match of \"#{step_name}\":\n\n"

data/lib/lucid/formatter/ansicolor.rb

@@ -5,28 +5,27 @@ if Lucid::IRONRUBY
   begin
     require 'iron-term-ansicolor'
   rescue LoadError
-    STDERR.puts %{*** WARNING: You must "igem install iron-term-ansicolor" to get coloured ouput in on IronRuby}
+    STDERR.puts %{*** WARNING: You must "gem install iron-term-ansicolor" to get colored ouput in on IronRuby}
   end
 end
 
 if Lucid::WINDOWS_MRI
   unless ENV['ANSICON']
-    STDERR.puts %{*** WARNING: You must use ANSICON 1.31 or higher (https://github.com/adoxa/ansicon/) to get coloured output on Windows}
+    STDERR.puts %{*** WARNING: You must use ANSICON 1.31 or higher (https://github.com/adoxa/ansicon/) to get colored output on Windows}
     Lucid::Term::ANSIColor.coloring = false
   end
 end
 
-Lucid::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.has_key?("AUTOTEST")
+Lucid::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.has_key?('AUTOTEST')
 
 module Lucid
   module Formatter
-    # Defines aliases for coloured output. You don't invoke any methods from this
-    # module directly, but you can change the output colours by defining
-    # a <tt>CUCUMBER_COLORS</tt> variable in your shell, very much like how you can
-    # tweak the familiar POSIX command <tt>ls</tt> with
-    # <a href="http://mipsisrisc.com/rambling/2008/06/27/lscolorsls_colors-now-with-linux-support/">$LSCOLORS/$LS_COLORS</a>
+    # Defines aliases for colored output. You don't invoke any methods from this
+    # module directly, but you can change the output colors by defining
+    # a <tt>LUCID_COLORS</tt> variable in your shell, very much like how you can
+    # tweak the familiar POSIX command <tt>ls</tt> with $LS_COLORS.
     #
-    # The colours that you can change are:
+    # The colors that you can change are:
     #
     # * <tt>undefined</tt>     - defaults to <tt>yellow</tt>
     # * <tt>pending</tt>       - defaults to <tt>yellow</tt>
@@ -50,10 +49,10 @@ module Lucid
     #
     # Examples: (On Windows, use SET instead of export.)
     #
-    #   export CUCUMBER_COLORS="passed=white"
-    #   export CUCUMBER_COLORS="passed=white,bold:passed_param=white,bold,underline"
+    #   export LUCID_COLORS="passed=white"
+    #   export LUCID_COLORS="passed=white,bold:passed_param=white,bold,underline"
     #
-    # To see what colours and effects are available, just run this in your shell:
+    # To see what colors and effects are available, just run this in your shell:
     #
     #   ruby -e "require 'rubygems'; require 'term/ansicolor'; puts Lucid::Term::ANSIColor.attributes"
     #
@@ -75,8 +74,8 @@ module Lucid
         'tag'       => 'cyan'
       })
 
-      if ENV['CUCUMBER_COLORS'] # Example: export CUCUMBER_COLORS="passed=red:failed=yellow"
-        ENV['CUCUMBER_COLORS'].split(':').each do |pair|
+      if ENV['LUCID_COLORS'] # Example: export LUCID_COLORS="passed=red:failed=yellow"
+        ENV['LUCID_COLORS'].split(':').each do |pair|
           a = pair.split('=')
           ALIASES[a[0]] = a[1]
         end
@@ -97,11 +96,11 @@ module Lucid
         unless method_name =~ /.*_param/
           code = <<-EOF
           def #{method_name}(string=nil, &proc)
-            #{ALIASES[method_name].split(",").join("(") + "(string, &proc" + ")" * ALIASES[method_name].split(",").length}
+            #{ALIASES[method_name].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name].split(',').length}
           end
           # This resets the colour to the non-param colour
           def #{method_name}_param(string=nil, &proc)
-            #{ALIASES[method_name+'_param'].split(",").join("(") + "(string, &proc" + ")" * ALIASES[method_name+'_param'].split(",").length} + #{ALIASES[method_name].split(",").join(' + ')}
+            #{ALIASES[method_name+'_param'].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name+'_param'].split(',').length} + #{ALIASES[method_name].split(',').join(' + ')}
           end
           EOF
           eval(code)
@@ -112,9 +111,9 @@ module Lucid
         begin
           gem 'genki-ruby-terminfo'
           require 'terminfo'
-          case TermInfo.default_object.tigetnum("colors")
+          case TermInfo.default_object.tigetnum('colors')
           when 0
-            raise "Your terminal doesn't support colours."
+            raise "Your terminal doesn't support colors."
           when 1
             ::Lucid::Term::ANSIColor.coloring = false
             alias grey white
@@ -125,9 +124,9 @@ module Lucid
           end
         rescue Exception => e
           if e.class.name == 'TermInfo::TermInfoError'
-            STDERR.puts "*** WARNING ***"
+            STDERR.puts '*** WARNING ***'
             STDERR.puts "You have the genki-ruby-terminfo gem installed, but you haven't set your TERM variable."
-            STDERR.puts "Try setting it to TERM=xterm-256color to get grey colour in output."
+            STDERR.puts 'Try setting it to TERM=xterm-256color to get grey color in output.'
             STDERR.puts "\n"
             alias grey white
           else
@@ -149,7 +148,7 @@ module Lucid
       define_grey
 
       def cukes(n)
-        ("(::) " * n).strip
+        ('(::) ' * n).strip
       end
 
       def green_cukes(n)