Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

This project is archived and is in readonly mode.

OrderedHash#shift should return nil when empty

#2342

Prior to 2.3, OrderedHash#shift returned nil when empty. In 2.3 it returns [nil, nil]. Hash#shift returns nil in 1.8 and 1.9, so OrderedHash#shift should also.

This bug causes an infinite loop in this idiom:


groups = foo.group_by(&:bar)
while group = groups.shift do
  # stuff
end

Reported by Grant Rodgers · March 26th, 2009 @ 02:58 AM

State: stale
Milestone: 3.x
Assigned to: nobody
Importance: none

Activity

  1. Grant Rodgers
    Grant Rodgers
    • Title changed from [PATCH]OrderedHash#shift should return nil when empty to OrderedHash#shift should return nil when empty

    March 26th, 2009 @ 02:58 AM

  2. Manfred Stienstra
    Manfred Stienstra

    Nice catch!

    I personally would rather see the the test for this bug extracted in a separate test, that way the intention of the test is apparent for future developers.

    
    def test_shift_returns_nil_when_empty
      while !@ordered_hash.empty?
        @ordered_hash.shift
      end
      assert_nil @ordered_hash.shift
    end
    

    March 26th, 2009 @ 08:19 AM

  3. Grant Rodgers
    Grant Rodgers

    Agreed, I stuffed it into the existing test because it looked like the convention was one test per method. Updated patch attached.

    March 26th, 2009 @ 06:37 PM

  4. Jeremy Kemper
    Jeremy Kemper
    • Milestone changed from 2.x to 3.x

    May 4th, 2010 @ 06:48 PM

  5. Santiago Pastorino
    Santiago Pastorino
    • State changed from new to open
    • Tag changed from 2.3.2, activesupport, active_support, hash, orderedhash, patch to 232, activesupport, active_support, hash, orderedhash, patch
    • Importance changed from to

    This issue has been automatically marked as stale because it has not been commented on for at least three months.

    The resources of the Rails core team are limited, and so we are asking for your help. If you can still reproduce this error on the 3-0-stable branch or on master, please reply with all of the information you have about it and add "[state:open]" to your comment. This will reopen the ticket for review. Likewise, if you feel that this is a very important feature for Rails to include, please reply with your explanation so we can consider it.

    Thank you for all your contributions, and we hope you will understand this step to focus our efforts where they are most helpful.

    February 2nd, 2011 @ 04:40 PM

  6. Santiago Pastorino
    Santiago Pastorino
    • State changed from open to stale

    February 2nd, 2011 @ 04:40 PM