# Had to make this a module instead of a base class
# because the ruby test suite kept complaining that 
# the abstract test case didn't have any test mehods
# or assertions
module SproutTestCase # :nodoc:[all]
  FIXTURES_NAME = 'fixtures'

  # Gives us the ability to hide RubyGem output from
  # our test results...
  include Gem::DefaultUserInteraction

  def fixtures from=nil
    @fixtures ||= find_fixtures(from || Sprout.file_from_caller(caller.first))
  end

  def setup
    super
    @start_path = Dir.pwd
  end

  def teardown
    super
    clear_tasks
    Sprout::Executable.clear_entities!
    Sprout::Library.clear_entities!
    Sprout::Generator.clear_entities!

    remove_file @temp_path
    remove_file @temp_cache

    @temp_path  = nil
    @temp_cache = nil

    if(@start_path && Dir.pwd != @start_path)
      puts "[WARNING] >> SproutTestCase changing dir from #{Dir.pwd} back to: #{@start_path} - Did you mean to leave your working directory in a new place?"
      Dir.chdir @start_path
    end

  end

  def temp_path
    caller_file = Sprout.file_from_caller caller.first
    @temp_path ||= make_temp_folder File.dirname(caller_file)
  end

  def make_temp_folder from
    dir = File.join(fixtures(from), 'tmp')
    FileUtils.mkdir_p dir
    dir
  end

  def run_task(name)
    t = Rake.application[name]
    t.invoke
    return t
  end
  
  def get_task(name)
    return Rake.application[name]
  end

  def clear_tasks
    Rake::Task.clear
    Rake.application.clear
  end

  def create_file path
    dir = File.dirname path
    FileUtils.mkdir_p dir
    FileUtils.touch path
  end

  def remove_file(path=nil)
    if(path && File.exists?(path))
      FileUtils.rm_rf(path)
    end
  end

  def assert_file(path, message=nil)
    message ||= "Expected file not found at #{path}"
    assert(File.exists?(path), message)
    yield File.read(path) if block_given?
  end

  def assert_directory(path, message=nil)
    message ||= "Expected directory not found at #{path}"
    assert(File.directory?(path), message)
  end

  def assert_not_empty(path, message=nil)
    assert_file path, message
    files = FileList["#{path}/*"]
    message ||= " - Expected #{path} to not be empty, but it was"
    assert files.size > 0, message
  end
  
  def assert_matches(expression, string, message='')
    if(expression.is_a?(String))
      expresion = /#{expression}/
    end
    if(!string.match(expression))
      fail "#{message} - '#{string}' should include '#{expression}'"
    end
  end

  ##
  # Add the skip method that was introduced in Ruby 1.9.1 Test::Unit
  # This doesn't really work all that well...
  if(RUBY_VERSION == '1.8.7')
    def skip message=""
      puts
      puts ">> SproutTestCase.skip called from: #{caller[0]} ( #{message} )"
    end
  end

  def temp_cache
    dir = File.dirname(Sprout.file_from_caller(caller.first))
    @temp_cache ||= File.join(fixtures(dir), 'sprout', 'cache')
  end

  def as_each_system
    [
     Sprout::System::VistaSystem.new,
     Sprout::System::WinNixSystem.new,
     Sprout::System::WinSystem.new,
     Sprout::System::JavaSystem.new,
     Sprout::System::OSXSystem.new,
     Sprout::System::UnixSystem.new
    ].each do |sys|
      expectation = Sprout::System.stubs(:create).returns sys
      yield sys if block_given?
      # Ugh - This is way too greedy... We're killing all mocks in here
      # Doing it anyway b/c we need to get Windows support in place...
      # TODO: Implement this feature without clobbering all stubs/mocks
      Mocha::Mockery.instance.teardown
    end
  end

  def as_a_unix_system
    sys = Sprout::System::UnixSystem.new
    expectation = Sprout::System.stubs(:create).returns sys
    yield sys if block_given?
    # Ugh - This is way too greedy... We're killing all mocks in here
    # Doing it anyway b/c we need to get Windows support in place...
    # TODO: Implement this feature without clobbering all stubs/mocks
    Mocha::Mockery.instance.teardown
  end

  def as_a_mac_system
    sys = Sprout::System::OSXSystem.new
    Sprout::System.stubs(:create).returns sys
    yield sys if block_given?
    # Ugh - This is way too greedy... We're killing all mocks in here
    # Doing it anyway b/c we need to get Windows support in place...
    # TODO: Implement this feature without clobbering all stubs/mocks
    Mocha::Mockery.instance.teardown
  end
  
  def as_a_windows_system
    sys = Sprout::System::WinSystem.new
    Sprout::System.stubs(:create).returns sys
    yield sys if block_given?
    # Ugh - This is way too greedy... We're killing all mocks in here
    # Doing it anyway b/c we need to get Windows support in place...
    # TODO: Implement this feature without clobbering all stubs/mocks
    Mocha::Mockery.instance.teardown
  end

  
  private

  # Find the nearest fixtures folder to the provided
  # path by checking each parent directory.
  def find_fixtures path
    # Return nil if path is nil or is not a file:
    find_fixtures_error(path) if(find_reached_root?(path))
    # Get the parent directory if path is a file:
    path = File.dirname(path) if !File.directory? path
    if(should_create_fixtures_for?(path))
      FileUtils.makedirs File.join(path, FIXTURES_NAME)
    end
    # Check for a folder at "#{path}/fixtures":
    fixture_path = File.join(path, FIXTURES_NAME)
    # Return the fixtures folder if found:
    return fixture_path if File.directory? fixture_path
    # Move up one directory and try again:
    return find_fixtures File.dirname(path) unless File.dirname(path) == path
  end

  def should_create_fixtures_for? path
    basename = File.basename path
    return basename == 'test' || basename == 'tests'
  end

  def find_fixtures_error path
    raise Sprout::Errors::UsageError.new "Request to find a fixtures folder failed at: #{path}"
  end

  def find_reached_root? path
    return (path.nil? || !File.exists?(path) || File.dirname(path) == path)
  end

end

  # TODO: Consider adding these:
  # Some generator-related assertions:
  #   assert_generated_file(name, &block) # block passed the file contents
  #   assert_directory_exists(name)
  #   assert_generated_class(name, &block)
  #   assert_generated_module(name, &block)
  #   assert_generated_test_for(name, &block)
  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
  #
  # Other helper methods are:
  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
  #   bare_setup - place this in setup method to create the app_root folder for each test
  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or app_root folder after each test


# Prevent log messages from interrupting the test output:
Sprout::Log.debug = true
Sprout::ProgressBar.debug = true