require 'test_helper'

def parse_link_ranges header
  links = Hash.new
  (header || '').split(',').each do |link|
    link =~ /rel="(.*)".*items="(.*)"/
    links[$1] = $2
  end
  links
end

class ApplicationControllerTest < ActionController::TestCase
  setup do
    @controller.stubs(:total_items).returns 101
    @controller.stubs(:max_range).returns 100
  end

  test 'rangeless request range works normally if max_range >= total' do
    @controller.stubs(:total_items).returns 100

    @controller.expects(:action).with(100, 0)
    get :index
    assert_equal 200, response.status
    assert_equal 'items', response.headers['Accept-Ranges']
  end

  test 'rangeless request truncates if max_range < total' do
    @controller.expects(:action).with(100, 0)
    get :index
    assert_equal 206, response.status
    assert_equal 'items', response.headers['Accept-Ranges']
    assert_equal '0-99/101', response.headers['Content-Range']
  end

  test 'an acceptable range succeeds' do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-99"

    @controller.expects(:action).with(100, 0)
    get :index
    assert_equal 206, response.status
    assert_equal 'items', response.headers['Range-Unit']
    assert_equal '0-99/101', response.headers['Content-Range']
  end

  test 'an oversized range is truncated' do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-100"

    get :index
    assert_equal 206, response.status
    assert_equal 'items', response.headers['Range-Unit']
    assert_equal '0-99/101', response.headers['Content-Range']
  end

  test "passes along exceptional status codes" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-99"

    [100, 301, 404, 500].each do |code|
      @controller.stubs(:index_status).returns code
      get :index
      assert_equal code, response.status
    end
  end

  test "reports infinite/unknown collection" do
    @controller.stubs(:total_items).returns Float::INFINITY

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-9"
    get :index
    assert_equal '0-9/*', response.headers['Content-Range']
  end

  test "refuses offside ranges" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "1-0"

    @controller.expects(:action).never
    get :index
    assert_equal 416, response.status
    assert_equal '*/101', response.headers['Content-Range']
  end

  test "returns 200 when no items found, delegates response to action" do
    @controller.stubs(:total_items).returns 0
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-9"

    @controller.expects(:action).with(0, 0)
    get :index
    assert_equal 200, response.status
    assert_equal '*/0', response.headers['Content-Range']
  end

  test "refuses a range with nonzero start when there are no items" do
    @controller.stubs(:total_items).returns 0
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "1-10"

    @controller.expects(:action).never
    get :index
    assert_equal 416, response.status
    assert_equal '*/0', response.headers['Content-Range']
  end

  test "refuses range start past end" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "101-"

    @controller.expects(:action).never
    get :index
    assert_equal 416, response.status
    assert_equal '*/101', response.headers['Content-Range']
  end

  test "optionally raise exception when range is invalid" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "1-0"
    @controller.stubs(:raise_errors).returns true

    @controller.expects(:action).never
    assert_raises(RangeError) do
      get :index
    end
  end

  test "optionally prevent rendering anything when range is invalid" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "1-0"
    @controller.stubs(:allow_render).returns false
    @controller.expects(:action).never
    assert_raises(ActionView::MissingTemplate) do
      get :index
    end
  end

  test "allows one-item requests" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-0"

    @controller.expects(:action).with(1, 0)
    get :index
    assert_equal 206, response.status
    assert_equal '0-0/101', response.headers['Content-Range']
  end

  test "allows one-item responses" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-9"
    @controller.stubs(:total_items).returns 1
    @controller.stubs(:max_range).returns 100

    @controller.expects(:action).with(1, 0)
    get :index
    assert_equal 200, response.status
    assert_equal '0-0/1', response.headers['Content-Range']
  end

  test "handles ranges beyond collection length via truncation" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-200"

    @controller.expects(:action).with(51, 50)
    get :index

    assert_equal 206, response.status
    assert_equal '50-100/101', response.headers['Content-Range']
  end

  test "includes link headers" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "20-29"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '30-39', links['next']
    assert_equal '10-19', links['prev']
    assert_equal '0-9', links['first']
    assert_equal '90-99', links['last']
  end

  test "next page range can extend beyond last item" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-89"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '90-129', links['next']
  end

  test "previous page range cannot go negative" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "10-99"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '0-89', links['prev']
  end

  test "first page range always starts at zero" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "63-72"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '0-9', links['first']
  end

  test "last page range can extend beyond the last item" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-6"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '98-104', links['last']
  end

  test "infinite collections have no last page" do
    @controller.stubs(:total_items).returns Float::INFINITY

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-9"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_nil links['last']
  end

  test "omitting the end number asks for everything" do
    @controller.stubs(:total_items).returns Float::INFINITY
    @controller.stubs(:max_range).returns 1000000
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-"

    @controller.expects(:action).with(1000000, 50)
    get :index
  end

  test "omitting the end number omits in first link too" do
    @controller.stubs(:total_items).returns Float::INFINITY
    @controller.stubs(:max_range).returns 1000000
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-"

    get :index
    links = parse_link_ranges response.headers['Link']
    assert_equal '0-', links['first']
  end

  test "next link with omitted end number shifts by max page" do
    @controller.stubs(:total_items).returns Float::INFINITY
    @controller.stubs(:max_range).returns 1000000
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-"

    get :index
    links = parse_link_ranges response.headers['Link']
    assert_equal '1000050-', links['next']
  end

  test "prev link with omitted end number shifts by max page" do
    @controller.stubs(:total_items).returns Float::INFINITY
    @controller.stubs(:max_range).returns 25
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "50-"

    get :index
    links = parse_link_ranges response.headers['Link']
    assert_equal '25-', links['prev']
  end

  test "shifts penultimate page to beginning, preserving length" do
    @controller.stubs(:total_items).returns 100

    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "10-49"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_equal '0-39', links['prev']
    assert_equal '0-39', links['first']
  end

  test "prev is the left inverse of next" do
    @request.headers['Range-Unit'] = 'items'

    100.times do
      total_items = rand(1..20)
      if total_items == 20
        total_items = Float::INFINITY
      end
      to = rand(1..[total_items, 20].min)
      from = rand(0...to)
      max_range = rand(1..20)

      msg = "#{from}-#{to}/#{total_items} max_range=#{max_range}"

      @controller.stubs(:total_items).returns total_items
      @controller.stubs(:max_range).returns max_range
      @request.headers['Range'] = "#{from}-#{to}"
      get :index

      links = parse_link_ranges response.headers['Link']
      if links['next']
        msg += " thence to #{links['next']}/#{total_items}"
        @request.headers['Range'] = links['next']
        get :index

        links = parse_link_ranges response.headers['Link']
        assert_equal "#{from}-#{to}", links['prev'], msg
      end
    end
  end

  test "for from > to-from, next is the right inverse of prev" do
    @request.headers['Range-Unit'] = 'items'

    100.times do
      total_items = rand(1..20)
      if total_items == 20
        total_items = Float::INFINITY
      end
      to = rand(1..[total_items, 20].min)
      from = rand(to/2+1...to)
      max_range = rand(1..20)

      msg = "#{from}-#{to}/#{total_items} max_range=#{max_range}"

      @controller.stubs(:total_items).returns total_items
      @controller.stubs(:max_range).returns max_range
      @request.headers['Range'] = "#{from}-#{to}"
      get :index

      links = parse_link_ranges response.headers['Link']
      if links['prev']
        msg += " thence to #{links['prev']}/#{total_items}"
        @request.headers['Range'] = links['prev']
        get :index

        links = parse_link_ranges response.headers['Link']
        assert_equal "#{from}-#{to}", links['next'], msg
      end
    end
  end

  test "omits prev and first links at start" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "0-9"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_nil links['first']
    assert_nil links['prev']
  end

  test "omits next and last links at end" do
    @controller.stubs(:total_items).returns 100
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "90-99"

    get :index
    links = parse_link_ranges response.headers['Link']

    assert_nil links['last']
    assert_nil links['next']
  end

  test "preserves query parameters in link headers" do
    @request.headers['Range-Unit'] = 'items'
    @request.headers['Range'] = "20-29"
    get :index, foo: 'bar'

    response.headers['Link'].scan(/<[^>]+>/).each do |link|
      assert_match(/\?foo=bar/, link)
    end
  end

  test "omits empty link header" do
    @controller.stubs(:total_items).returns 2

    get :index

    assert_equal false, response.headers.has_key?('Link')
  end
end