require_spec.rb

require File.dirname(__FILE__) + '/../../spec_helper'

$require_fixture_dir = (File.dirname(__FILE__) + '/../../fixtures/require')
$LOAD_PATH << $require_fixture_dir

$require_spec   = nil
$require_spec_1 = nil
$require_spec_2 = nil
$require_spec_3 = nil
$require_spec_4 = nil
$require_spec_5 = nil
$require_spec_6 = nil
$require_spec_7 = nil
$require_spec_8 = nil
$require_spec_9 = nil
$require_spec_10 = nil
$require_spec_rooby = nil
$require_spec_recursive = nil

require 'rbconfig'

describe "Kernel#require" do
  runner_is_not :rspec do
    # RSpec requires rubygems, which redefines #require without setting
    # it's visibility back to module_function or private
    it "is a private method" do
      Kernel.private_instance_methods.should include("require")
    end
  end

  # Avoid storing .rbc in repo
  before :all do
    Dir.chdir($require_fixture_dir) {
      `rm -f ./*.rbc`
      `touch require_spec_dummy.#{Config::CONFIG['DLEXT']}`
      `touch require_spec_dummy.rb`
    }
  end

  # The files used below just contain code that assigns
  # Time.now to the respective global variable so that
  # reloads can easily be verified.

  # CAUTION: Some of these work because a different path is used to
  #          load the same file. Be careful if you change the order
  #          or add items.

  it "loads a .rb from an absolute path and returns true" do
    path = File.expand_path(File.dirname(__FILE__) + '/../../fixtures/require/require_spec_1.rb')

    require(path).should == true
    $require_spec_1.nil?.should == false
  end

  it "loads a .rb from a relative path and returns true" do
    Dir.chdir($require_fixture_dir) do |dir|
      $require_spec_1 = nil
      require('../../fixtures/require/require_spec_1.rb').should == true
      $require_spec_1.nil?.should == false

      $require_spec_1 = nil
      require('./../require/require_spec_1.rb').should == true
      $require_spec_1.nil?.should == false
    end
  end

  it "loads an unqualified .rb by looking in $LOAD_PATH and returns true" do
    require('require_spec_2.rb').should == true
    $require_spec_2.nil?.should == false
  end

  it "loads extension files" do
    # TODO: Not sure how to spec this yet since it needs an extfile
  end

  it "does not expand/resolve qualified files against $LOAD_PATH" do
    num_features = $LOADED_FEATURES.size
    Dir.chdir($require_fixture_dir + '/../') do |dir|
      # This would be a valid path if expanded against the fixture dir
      lambda { require '../require/require_spec_2.rb' }.should raise_error LoadError
    end
    $LOADED_FEATURES.size.should == num_features
  end

  it "allows unqualified files to contain path information (just not in the beginning)" do
    name = (File.dirname(__FILE__) + '/../../fixtures')
    $LOAD_PATH << name

    $require_spec2 = nil
    require('require/../require/require_spec_2.rb').should == true
    $require_spec_2.nil?.should == false
    
    $LOAD_PATH.delete name
  end

  it "appends a file with no extension with .rb/.<ext> in that order to locate file" do
    load('require_spec')
    $require_spec.should == :noext
    load('require_spec.rb')
    $require_spec.should == :rb

    $require_spec = nil

    require('require_spec')
    $require_spec.should == :rb
  end

  it "prefers to use .rb over .<ext> if given non-extensioned file and both exist" do
    require('require_spec_dummy').should == true
    $LOADED_FEATURES.include?('require_spec_dummy.rb').should == true
    $LOADED_FEATURES.include?("require_spec_dummy.#{Config::CONFIG['DLEXT']}").should == false
  end

  runner_is_not :rspec do
    it "will not add a bad load to LOADED_FEATURES" do
      lambda { require('require_spec_raises') }.should raise_error(RuntimeError)
    
      $LOADED_FEATURES.include?('require_spec_raises.rb').should == false
    end
  end

  it "will load file.rb when given 'file' if it exists even if file.<ext> is loaded" do
    $LOADED_FEATURES << "require_spec_3.#{Config::CONFIG['DLEXT']}"
    require('require_spec_3.rb').should == true
    $LOADED_FEATURES.include?('require_spec_3.rb').should == true
  end

  it "will not load file.<ext> when given 'file' if file.rb already loaded" do
    unless $LOADED_FEATURES.include?('require_spec_dummy.rb')
      require('require_spec_dummy.rb') 
    end

    require('require_spec_dummy').should == false
  end

  it "will load explicit file.<ext> even if file.rb already loaded and vice versa" do
    # Not sure how to spec this yet because it needs an extfile. 
  end

  it "appends any non-ruby extensioned file with .rb/.<ext> in that order to locate file" do
    load('require_spec.rooby')
    $require_spec_rooby.should == :rooby
    load('require_spec.rooby.rb')
    $require_spec_rooby.should == :rb

    $require_spec_rooby = nil

    require('require_spec.rooby')
    $require_spec_rooby.should == :rb
  end

  it "produces __FILE__ as the given filename and __LINE__ as the source line number" do
    Dir.chdir($require_fixture_dir) do |dir|
      require('require_spec_4').should == true 
      $require_spec_4.should == [['./require_spec_4.rb', 1], ['./require_spec_4.rb', 10]]

      extended_on :rubinius do
        `rm require_spec_4.rbc`
      end
    end

    $require_spec_4 = nil

    require("#{$require_fixture_dir}/require_spec_4").should == true 
    $require_spec_4[0][0].should =~ %r[^.*/fixtures/require/require_spec_4.rb]
    $require_spec_4[0][1].should == 1
    $require_spec_4[1][0].should =~ %r[^.*/fixtures/require/require_spec_4.rb]
    $require_spec_4[1][1].should == 10
  end

  it "stores the loaded file in $LOADED_FEATURES" do
    $LOADED_FEATURES.include?('require_spec_6.rb').should == false
    require('require_spec_6.rb').should == true
    $LOADED_FEATURES.include?('require_spec_6.rb').should == true
  end

  it "stores a non-extensioned file with its located suffix" do
    $LOADED_FEATURES.delete 'require_spec_6.rb'

    require('require_spec_6').should == true

    $LOADED_FEATURES.include?('require_spec_6.rb').should == true
  end

  it "bases the filename in $LOADED_FEATURES on the path given, not just basename" do
    $LOADED_FEATURES.include?('require_spec_6.rb').should == true

    Dir.chdir($require_fixture_dir) do |dir|
      require('../../fixtures/require/require_spec_6.rb').should == true 
    end

    $LOADED_FEATURES.include?('require_spec_6.rb').should == true
    $LOADED_FEATURES.include?('../../fixtures/require/require_spec_6.rb').should == true
  end

  it "will not load the same file twice, returns false instead" do
    $LOADED_FEATURES.include?('require_spec_7.rb').should == false

    require('require_spec_7.rb').should == true
    a = $require_spec_7
    a.nil?.should == false
    
    $LOADED_FEATURES.include?('require_spec_7.rb').should == true

    require('require_spec_7.rb').should == false
    b = $require_spec_7
    b.nil?.should == false

    # Timestamps should not differ
    a.eql?(b).should == true

    $LOADED_FEATURES.include?('require_spec_7.rb').should == true
  end

  it "checks $LOADED_FEATURES to see whether file is already loaded" do
    $LOADED_FEATURES.include?('require_spec_7.rb').should == true
    require('require_spec_7.rb').should == false

    $LOADED_FEATURES.delete 'require_spec_7.rb'
    require('require_spec_7.rb').should == true
    require('require_spec_7.rb').should == false

    $LOADED_FEATURES.include?('require_spec_7.rb').should == true
  end
  
  it "raises a LoadError if the file can't be found" do
    lambda { require "nonesuch#{$$}#{Time.now.to_f}" }.should raise_error LoadError
  end

  it "only accepts strings" do
    lambda { require(nil) }.should raise_error(TypeError)
    lambda { require(42)  }.should raise_error(TypeError)
    lambda { require([])  }.should raise_error(TypeError)
  end

  it "does not infinite loop on an rb file that requires itself" do
    $require_spec_recursive = nil
    $LOADED_FEATURES.delete 'require_spec_recursive.rb'

    $LOADED_FEATURES.include?('require_spec_recursive.rb').should == false
    require('require_spec_recursive').should == true
    $LOADED_FEATURES.include?('require_spec_recursive.rb').should == true
    $require_spec_recursive.nil?.should == false
  end
end

describe "Shell expansion in Kernel#require" do
  before :all do
    @rs_home = ENV["HOME"]
    ENV["HOME"] = $require_fixture_dir
    @rs_short = "~/require_spec_1.rb"
    @rs_long  = "#{$require_fixture_dir}/require_spec_1.rb"
  end

  after :all do
    ENV["HOME"] = @rs_home
  end

  before :each do
    $LOADED_FEATURES.delete @rs_long
    $LOADED_FEATURES.delete @rs_short
  end

  it "expands a preceding ~/ to the user's home directory for building the path to search" do
    $require_spec_1 = nil
    require(@rs_short).should == true
    $require_spec_1.nil?.should == false
  end

  it "adds the path to $LOADED_FEATURES" do
    $require_spec_1 = nil
    require(@rs_short).should == true
    $require_spec_1.nil?.should == false

    $LOADED_FEATURES.find {|f| f == @rs_short || f == @rs_long }.nil?.should == false
  end
end

describe "Kernel.require" do
  it "needs to be reviewed for spec completeness" do
  end
end