mspec/bin/completeness mspec/bin/mkspec mspec/bin/name_map.rb @@ -1,191 +1,3 @@ #!/usr/bin/env ruby -# -# Generate a completeness report from MRI classes and modules -# based on the specs. -require 'optparse' -require File.dirname(__FILE__) + '/name_map' - -module Completeness - VERSION = '0.0.1' -end - -get_class_or_module = lambda do |const| - constant = const.split('::').inject(nil) { |c,s| c ? c.const_get(s) : Object.const_get(s) } - return constant if (constant.is_a?(Module) or constant.is_a?(Class)) and - not ['DTracer', 'OptionParser', 'SystemExit'].include?(constant.name) -end - -target = 'shotgun/rubinius' -base = nil -constants = [] -except = [] -requires = [] -constant_names = [] -report_failures = false -use_color = false -verbose = false -quiet = false - -opts = OptionParser.new("", 24, ' ') do |opts| - opts.banner = "completeness [options]" - opts.separator "" - - opts.on("-r", "--require LIBRARY", String, "Name of library to require") do |f| - requires << f - end - opts.on("-c", "--constant CONSTANT", String, - "Name of a Class or Module") do |c| - constant_names << c - end - opts.on("-b", "--base BASE", String, - "Set base directory to BASE") do |b| - base = b - end - opts.on("-t", "--target TARGET", String, - "Implementation to test for completeness: r:ruby|r19:ruby19|x:rbx|j:jruby") do |t| - case t - when 'r', 'ruby' - target = 'ruby' - when 'r19', 'ruby19' - target = 'ruby19' - when 'x', 'rbx', 'rubinius' - target = 'shotgun/rubinius' - when 'j', 'jruby' - target = 'jruby' - else - target = t - end - end - opts.on("-x", "--exclude STRING|FILE", String, - "Exclude example(s) with descriptions matching STRING or each line of FILE") do |r| - except << r - end - opts.on("-v", "--version", "Show version") do - puts "Completeness Reporter #{Completeness::VERSION}" - exit - end - opts.on("-F", "--report-failures", "Report spec failure locations") do - report_failures = true - end - opts.on("-o", "--color", "Use colors green=NoFailures yellow=WithFailures red=NoExamples") do - use_color = true - end - opts.on("-V", "--verbose", "Show mspec command being executed") do - verbose = true - end - opts.on("-q", "--quiet", "Suppress output except for final summary") do - quiet = true - end - opts.on("-h", "--help", "Show this message") do - puts opts - exit - end - - opts.parse ARGV -end - -requires.each { |r| require r } - -cmd = lambda do |name, c, m| - base = 'spec/ruby/1.8/core/' unless base - dir = NameMap.get_dir_name(c, base) - spec_file = NameMap.get_spec_name(m, c.name) - - mspec_cmd = %(bin/mspec -t #{target} #{requires.map { |r| "-r#{r}" }.join(" ")} -e '#{name} ' #{except.map { |x| "-x #{x}" }.join(' ')} -f d #{dir}/#{spec_file} 2> /dev/null) - puts mspec_cmd if verbose - %x{#{mspec_cmd}} -end - -colors = { - :clear => "\033[0m", - :red => "\033[0;31m", - :green => "\033[0;32m", - :yellow => "\033[0;33m", - :blue => "\033[0;34m", -} - -print_summary = lambda do |str, name, tab| - examples = failures = errors = 0 - failure_messages = [] - str.scan(/(\d+) example.*(\d+) failure.*(\d+) error./) do |ex, f, er| - examples += ex.to_i - failures += f.to_i - errors += er.to_i - end - str.scan(/\n(\d+\)\n)(([^\n]+\n)+)/) do |number, error| - failure_messages << error - end - summary = if examples > 0 - "#{examples} examples, #{failures} failures, #{errors} errors" - else - "No examples found" - end - unless quiet - if use_color - color = if examples == 0 - colors[:red] - elsif failures == 0 - colors[:green] - else - colors[:yellow] - end - name = color + name + colors[:clear] - end - puts "#{name}\n #{summary}" - end - tab.add(examples, failures, errors, failure_messages) -end - -constants = constant_names.map { |c| NameMap.get_class_or_module(c) } -if constants.empty? - constants = Object.constants.map { |c| NameMap.get_class_or_module(c) } -end -constants.sort! { |a,b| a.to_s <=> b.to_s } - -class Tabulator - def initialize - @methods = @examples = @failures = @errors = @missing = 0 - @failure_messages = [] - @start = Time.now - end - - def add(examples, failures, errors, failure_messages = []) - @methods += 1 - @examples += examples - @failures += failures - @errors += errors - @failure_messages.push *failure_messages - @missing += 1 if examples == 0 - end - - def summarize(list_failures=false) - puts "\nFinished in #{Time.now - @start} seconds\n\n" - puts "#{@methods} methods, #{@examples} examples, #{@failures} failures, #{@errors} errors, #{@missing} methods with no examples" - if list_failures && @failure_messages.size > 0 - puts "\nFailed specs:\n\n" - @failure_messages.each_with_index do |message, number| - puts "#{number+1})\n#{message}\n\n" - end - end - end - -end - -tabulator = Tabulator.new - -constants.compact.each do |c| - (c.methods(false) + c.singleton_methods).uniq.sort.each do |m| - name = "#{c}.#{m}" - print_summary.call(cmd[name, c, m], name, tabulator) - end - - (c.public_instance_methods(false) + - c.private_instance_methods(false) + - c.protected_instance_methods(false)).sort.each do |m| - name = "#{c}\##{m}" - print_summary.call(cmd[name, c, m], name, tabulator) - end -end - -tabulator.summarize(!quiet && report_failures) +exec 'mspec/bin/completeness', *ARGV bin/completeness @@ -1,130 +1,3 @@ -#! /usr/bin/env ruby -# -# mkspec - utility to create spec stubs - -require 'optparse' -require File.dirname(__FILE__) + '/name_map' - -class MkSpec - VERSION = '0.0.1' - - def self.process_args(argv) - modules = [] - base = nil - - opts = OptionParser.new do |opts| - opts.version = VERSION - opts.banner = "mkspec [options]" - opts.separator "" - - opts.on("-c", "--constant CONSTANT", - "Class or Module to generate spec stubs for") do |name| - constant = NameMap.get_class_or_module(name) - - if constant.nil? then - raise OptionParser::InvalidArgument, "#{name} is not a constant" - end - - modules << constant - end - - opts.on("-b", "--base BASE", - "Directory to generate specs into") do |directory| - base = File.expand_path directory - end - - opts.on("-r", "--require LIBRARY", - "A library to require") do |file| - begin - require file - rescue LoadError - raise OptionParser::InvalidArgument, "#{file} could not be required" - end - end - - opts.parse argv - end - - if modules.empty? then - Object.constants.map { |const| NameMap.get_class_or_module(const) } - end - - modules = modules.compact - - return base, modules - rescue OptionParser::ParseError => e - puts opts - puts - puts e - exit 1 - end - - def self.run(argv = ARGV) - base, modules = process_args argv - - mkspec = new base - mkspec.generate base, modules - end - - def initialize(base) - @base = base - end - - def create_file(dir, name, mod, meth) - file = File.join dir, name - - unless File.exist? file then - /\A#{Regexp.escape @base}\/?(.*)/ =~ dir - - parent_dirs = '../' * ($1.split('/').length + 1) - - File.open file, 'w' do |f| - f.puts "require File.dirname(__FILE__) + '/#{parent_dirs}spec_helper'" - f.puts - f.puts "describe '#{mod}##{meth}' do" - f.puts " it 'should spec something' do" - f.puts " raise 'not yet'" - f.puts " end" - f.puts "end" - end - - puts file - end - end - - def generate(dir, modules) - modules.each do |mod| - subdir = NameMap.get_dir_name mod, dir - if File.exist? subdir then - unless File.directory? subdir then - puts "A file named #{subdir} already exists and is not a directory." - exit 1 - end - else - Dir.mkdir subdir - end - - methods = [ - mod.methods(false), - mod.public_instance_methods(false), - mod.private_instance_methods(false), - mod.protected_instance_methods(false), - ].flatten.uniq.sort - - methods.each do |method| - name = NameMap.get_spec_name method, mod.name - create_file subdir, name, mod, method unless File.exist? name - end - - sub_mods = mod.constants.sort.map do |constant_name| - NameMap.get_class_or_module "#{mod}::#{constant_name}" - end.compact - - generate subdir, sub_mods - end - end - -end - -MkSpec.run if __FILE__ == $0 +#!/usr/bin/env ruby +exec 'mspec/bin/mkspec', *ARGV bin/mkspec bin/name_map.rb 67d3869e9b3fef6d47727206d02814da410e02fc Brian Ford bford@engineyard.com http://github.com/evanphx/rubinius/commit/4ad3b46a2ef8327f54667c904759605063481987 4ad3b46a2ef8327f54667c904759605063481987 2008-04-07T12:20:25-07:00 2008-04-04T12:12:57-07:00 Moved bin/mkspec, completeness to mspec/bin. 9bd655f75516234b95e5f4c0b25f961653b7fc00 Brian Ford bford@engineyard.com