mspec 1.4.0 → 1.5.0

data/lib/mspec/commands/mkspec.rb

@@ -3,9 +3,9 @@
 MSPEC_HOME = File.expand_path(File.dirname(__FILE__) + '/../../..')
 
 require 'fileutils'
-require 'optparse'
 require 'rbconfig'
 require 'mspec/version'
+require 'mspec/utils/options'
 require 'mspec/utils/name_map'
 
 
@@ -22,39 +22,33 @@ class MkSpec
   end
 
   def options(argv=ARGV)
-    options = OptionParser.new
-    options.version = MSpec::VERSION
-    options.banner = "mkspec [options]"
-    options.separator ""
+    options = MSpecOptions.new "mkspec [options]"
 
-    options.on("-c", "--constant CONSTANT", String,
+    options.on("-c", "--constant", "CONSTANT",
                "Class or Module to generate spec stubs for") do |name|
       config[:constants] << name
     end
-    options.on("-b", "--base DIR", String,
+    options.on("-b", "--base", "DIR",
                "Directory to generate specs into") do |directory|
       config[:base] = File.expand_path directory
     end
-    options.on("-r", "--require LIBRARY", String,
+    options.on("-r", "--require", "LIBRARY",
                "A library to require") do |file|
       config[:requires] << file
     end
-
-    options.separator "\n How might this work in the real world?\n"
-    options.separator "   1. To create spec stubs for every class or module in Object\n"
-    options.separator "     $ mkspec\n"
-    options.separator "   2. To create spec stubs for Fixnum\n"
-    options.separator "     $ mkspec -c Fixnum\n"
-    options.separator "   3. To create spec stubs for Complex in 'superspec/complex'\n"
-    options.separator "     $ mkspec -c Complex -rcomplex -b superspec"
-    options.separator ""
+    options.version MSpec::VERSION
+    options.help
+
+    options.doc "\n How might this work in the real world?\n"
+    options.doc "   1. To create spec stubs for every class or module in Object\n"
+    options.doc "     $ mkspec\n"
+    options.doc "   2. To create spec stubs for Fixnum\n"
+    options.doc "     $ mkspec -c Fixnum\n"
+    options.doc "   3. To create spec stubs for Complex in 'superspec/complex'\n"
+    options.doc "     $ mkspec -c Complex -rcomplex -b superspec"
+    options.doc ""
 
     options.parse argv
-  rescue OptionParser::ParseError => e
-    puts options
-    puts
-    puts e
-    exit 1
   end
 
   def create_directory(mod)

data/lib/mspec/commands/mspec-ci.rb

@@ -2,69 +2,60 @@
 
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
-require 'optparse'
+require 'mspec/version'
 require 'mspec/utils/options'
 require 'mspec/utils/script'
 
 
 class MSpecCI < MSpecScript
   def options(argv=ARGV)
-    options = MSpecOptions.new config, "ci", "", 28, "   "
-
-    options.separator " Ask yourself:"
-    options.separator "  1. How to run the specs?"
-    options.separator "  2. How to display the output?"
-    options.separator "  3. What action to perform?"
-    options.separator "  4. When to perform it?"
-
-    options.separator "\n How to run the specs"
-    options.add_config { |f| load f }
-    options.add_name
-    options.add_pretend
-    options.add_interrupt
-
-    options.separator "\n How to display their output"
-    options.add_formatters
-    options.add_verbose
-
-    options.separator "\n What action to perform"
-    options.add_actions
-
-    options.separator "\n When to perform it"
-    options.add_action_filters
-
-    options.separator "\n Help!"
-    options.add_version
-    options.add_help
-
-    options.separator "\n How might this work in the real world?"
-    options.separator "\n   1. To simply run the known good specs"
-    options.separator "\n     $ mspec ci"
-    options.separator "\n   2. To run a subset of the known good specs"
-    options.separator "\n     $ mspec ci path/to/specs"
-    options.separator "\n   3. To start the debugger before the spec matching 'this crashes'"
-    options.separator "\n     $ mspec ci --spec-debug -S 'this crashes'"
-    options.separator ""
+    options = MSpecOptions.new "mspec ci [options] (FILE|DIRECTORY|GLOB)+", 30, config
+
+    options.doc " Ask yourself:"
+    options.doc "  1. How to run the specs?"
+    options.doc "  2. How to display the output?"
+    options.doc "  3. What action to perform?"
+    options.doc "  4. When to perform it?"
+
+    options.doc "\n How to run the specs"
+    options.configure { |f| load f }
+    options.name
+    options.pretend
+    options.interrupt
+
+    options.doc "\n How to display their output"
+    options.formatters
+    options.verbose
+
+    options.doc "\n What action to perform"
+    options.actions
+
+    options.doc "\n When to perform it"
+    options.action_filters
+
+    options.doc "\n Help!"
+    options.version MSpec::VERSION
+    options.help
+
+    options.doc "\n How might this work in the real world?"
+    options.doc "\n   1. To simply run the known good specs"
+    options.doc "\n     $ mspec ci"
+    options.doc "\n   2. To run a subset of the known good specs"
+    options.doc "\n     $ mspec ci path/to/specs"
+    options.doc "\n   3. To start the debugger before the spec matching 'this crashes'"
+    options.doc "\n     $ mspec ci --spec-debug -S 'this crashes'"
+    options.doc ""
 
     @patterns = options.parse argv
     @patterns = config[:ci_files] if @patterns.empty?
   end
 
   def run
-    files = []
-    @patterns.each do |item|
-      stat = File.stat(File.expand_path(item))
-      files << item if stat.file?
-      files.concat(Dir[item+"/**/*_spec.rb"].sort) if stat.directory?
-    end
-
     MSpec.register_tags_patterns config[:tags_patterns]
-    MSpec.register_files files
-    TagFilter.new(:exclude, "fails").register
-    TagFilter.new(:exclude, "critical").register
-    TagFilter.new(:exclude, "unstable").register
-    TagFilter.new(:exclude, "incomplete").register
-    TagFilter.new(:exclude, "unsupported").register
+    MSpec.register_files files(@patterns)
+    filter = TagFilter.new(:exclude,
+        "fails", "critical", "unstable", "incomplete", "unsupported")
+    filter.register
 
     MSpec.process
     exit MSpec.exit_code

data/lib/mspec/commands/mspec-run.rb

@@ -2,75 +2,68 @@
 
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
-require 'optparse'
+require 'mspec/version'
 require 'mspec/utils/options'
 require 'mspec/utils/script'
 
 
 class MSpecRun < MSpecScript
   def options(argv=ARGV)
-    options = MSpecOptions.new config, "run", "", 28, "   "
-
-    options.separator " Ask yourself:"
-    options.separator "  1. What specs to run?"
-    options.separator "  2. How to modify the execution?"
-    options.separator "  3. How to display the output?"
-    options.separator "  4. What action to perform?"
-    options.separator "  5. When to perform it?"
-
-    options.separator "\n What specs to run"
-    options.add_filters
-
-    options.separator "\n How to modify the execution"
-    options.add_config { |f| load f }
-    options.add_name
-    options.add_randomize
-    options.add_pretend
-    options.add_interrupt
-
-    options.separator "\n How to display their output"
-    options.add_formatters
-    options.add_verbose
-
-    options.separator "\n What action to perform"
-    options.add_actions
-    options.add_verify
-
-    options.separator "\n When to perform it"
-    options.add_action_filters
-
-    options.separator "\n Help!"
-    options.add_version
-    options.add_help
-
-    options.separator "\n How might this work in the real world?"
-    options.separator "\n   1. To simply run some specs"
-    options.separator "\n     $ mspec path/to/the/specs"
-    options.separator "     mspec path/to/the_file_spec.rb"
-    options.separator "\n   2. To run specs tagged with 'fails'"
-    options.separator "\n     $ mspec -g fails path/to/the_file_spec.rb"
-    options.separator "\n   3. To start the debugger before the spec matching 'this crashes'"
-    options.separator "\n     $ mspec --spec-debug -S 'this crashes' path/to/the_file_spec.rb"
-    options.separator ""
+    options = MSpecOptions.new "mspec run [options] (FILE|DIRECTORY|GLOB)+", 30, config
+
+    options.doc " Ask yourself:"
+    options.doc "  1. What specs to run?"
+    options.doc "  2. How to modify the execution?"
+    options.doc "  3. How to display the output?"
+    options.doc "  4. What action to perform?"
+    options.doc "  5. When to perform it?"
+
+    options.doc "\n What specs to run"
+    options.filters
+
+    options.doc "\n How to modify the execution"
+    options.configure { |f| load f }
+    options.name
+    options.randomize
+    options.pretend
+    options.interrupt
+
+    options.doc "\n How to display their output"
+    options.formatters
+    options.verbose
+
+    options.doc "\n What action to perform"
+    options.actions
+    options.verify
+
+    options.doc "\n When to perform it"
+    options.action_filters
+
+    options.doc "\n Help!"
+    options.version MSpec::VERSION
+    options.help
+
+    options.doc "\n How might this work in the real world?"
+    options.doc "\n   1. To simply run some specs"
+    options.doc "\n     $ mspec path/to/the/specs"
+    options.doc "     mspec path/to/the_file_spec.rb"
+    options.doc "\n   2. To run specs tagged with 'fails'"
+    options.doc "\n     $ mspec -g fails path/to/the_file_spec.rb"
+    options.doc "\n   3. To start the debugger before the spec matching 'this crashes'"
+    options.doc "\n     $ mspec --spec-debug -S 'this crashes' path/to/the_file_spec.rb"
+    options.doc ""
 
     @patterns = options.parse argv
     if @patterns.empty?
-      puts options.parser
+      puts options
       puts "No files specified."
       exit 1
     end
   end
 
   def run
-    files = []
-    @patterns.each do |item|
-      stat = File.stat(File.expand_path(item))
-      files << item if stat.file?
-      files.concat(Dir[item+"/**/*_spec.rb"].sort) if stat.directory?
-    end
-
     MSpec.register_tags_patterns config[:tags_patterns]
-    MSpec.register_files files
+    MSpec.register_files files(@patterns)
 
     MSpec.process
     exit MSpec.exit_code

data/lib/mspec/commands/mspec-tag.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
+require 'mspec/version'
 require 'mspec/utils/options'
 require 'mspec/utils/script'
 
@@ -12,72 +12,103 @@ class MSpecTag < MSpecScript
     config[:tagger]  = :add
     config[:tag]     = 'fails:'
     config[:outcome] = :fail
+    config[:ltags]   = []
   end
 
   def options(argv=ARGV)
-    options = MSpecOptions.new config, "tag", "", 28, "   "
-
-    options.separator " Ask yourself:"
-    options.separator "  1. What specs to run?"
-    options.separator "  2. How to modify the execution?"
-    options.separator "  3. How to display the output?"
-    options.separator "  4. What tag action to perform?"
-    options.separator "  5. When to perform it?"
-
-    options.separator "\n What specs to run"
-    options.add_filters
-
-    options.separator "\n How to modify the execution"
-    options.add_config { |f| load f }
-    options.add_name
-    options.add_pretend
-    options.add_interrupt
-
-    options.separator "\n How to display their output"
-    options.add_formatters
-    options.add_verbose
-
-    options.separator "\n What action to perform and when to perform it"
-    options.add_tagging
-
-    options.separator "\n Help!"
-    options.add_version
-    options.add_help
-
-    options.separator "\n How might this work in the real world?"
-    options.separator "\n   1. To add the 'fails' tag to failing specs"
-    options.separator "\n     $ mspec tag path/to/the_file_spec.rb"
-    options.separator "\n   2. To remove the 'fails' tag from passing specs"
-    options.separator "\n     $ mspec tag --del fails path/to/the_file_spec.rb"
-    options.separator ""
+    options = MSpecOptions.new "mspec tag [options] (FILE|DIRECTORY|GLOB)+", 30, config
+
+    options.doc " Ask yourself:"
+    options.doc "  1. What specs to run?"
+    options.doc "  2. How to modify the execution?"
+    options.doc "  3. How to display the output?"
+    options.doc "  4. What tag action to perform?"
+    options.doc "  5. When to perform it?"
+
+    options.doc "\n What specs to run"
+    options.filters
+
+    options.doc "\n How to modify the execution"
+    options.configure { |f| load f }
+    options.name
+    options.pretend
+    options.interrupt
+
+    options.doc "\n How to display their output"
+    options.formatters
+    options.verbose
+
+    options.doc "\n What action to perform and when to perform it"
+    options.on("-N", "--add", "TAG",
+       "Add TAG with format 'tag' or 'tag(comment)' (see -Q, -F, -L)") do |o|
+      config[:tagger] = :add
+      config[:tag] = "#{o}:"
+    end
+    options.on("-R", "--del", "TAG",
+       "Delete TAG (see -Q, -F, -L)") do |o|
+      config[:tagger] = :del
+      config[:tag] = "#{o}:"
+      config[:outcome] = :pass
+    end
+    options.on("-Q", "--pass", "Apply action to specs that pass (default for --del)") do
+      config[:outcome] = :pass
+    end
+    options.on("-F", "--fail", "Apply action to specs that fail (default for --add)") do
+      config[:outcome] = :fail
+    end
+    options.on("-L", "--all", "Apply action to all specs") do
+      config[:outcome] = :all
+    end
+    options.on("--list", "TAG", "Display descriptions of any specs tagged with TAG") do |t|
+      config[:tagger] = :list
+      config[:ltags] << t
+    end
+    options.on("--list-all", "Display descriptions of any tagged specs") do
+      config[:tagger] = :list_all
+    end
+
+    options.doc "\n Help!"
+    options.version MSpec::VERSION
+    options.help
+
+    options.doc "\n How might this work in the real world?"
+    options.doc "\n   1. To add the 'fails' tag to failing specs"
+    options.doc "\n     $ mspec tag path/to/the_file_spec.rb"
+    options.doc "\n   2. To remove the 'fails' tag from passing specs"
+    options.doc "\n     $ mspec tag --del fails path/to/the_file_spec.rb"
+    options.doc "\n   3. To display the descriptions for all specs tagged with 'fails'"
+    options.doc "\n     $ mspec tag --list fails path/to/the/specs"
+    options.doc ""
 
     @patterns = options.parse argv
     if @patterns.empty?
-      puts options.parser
+      puts options
       puts "No files specified."
       exit 1
     end
   end
 
   def register
-    super
-
-    tag = SpecTag.new config[:tag]
-    tagger = TagAction.new(config[:tagger], config[:outcome], tag.tag, tag.comment,
-                           config[:atags], config[:astrings])
+    case config[:tagger]
+    when :add, :del
+      tag = SpecTag.new config[:tag]
+      tagger = TagAction.new(config[:tagger], config[:outcome], tag.tag, tag.comment,
+                             config[:atags], config[:astrings])
+    when :list, :list_all
+      tagger = TagListAction.new config[:tagger] == :list_all ? nil : config[:ltags]
+      MSpec.register_mode :pretend
+      config[:formatter] = nil
+    else
+      raise ArgumentError, "No recognized action given"
+    end
     tagger.register
+
+    super
   end
 
   def run
-    files = []
-    @patterns.each do |item|
-      stat = File.stat(File.expand_path(item))
-      files << item if stat.file?
-      files.concat(Dir[item+"/**/*_spec.rb"].sort) if stat.directory?
-    end
-
     MSpec.register_tags_patterns config[:tags_patterns]
-    MSpec.register_files files
+    MSpec.register_files files(@patterns)
 
     MSpec.process
     exit MSpec.exit_code