This project is archived and is in readonly mode.

#2342 ✓stale
Grant Rodgers

OrderedHash#shift should return nil when empty

Reported by Grant Rodgers | March 26th, 2009 @ 02:58 AM | in 3.x

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

Comments and changes to this ticket

  • Grant Rodgers

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

    • Title changed from “[PATCH]OrderedHash#shift should return nil when empty” to “OrderedHash#shift should return nil when empty”
  • Manfred Stienstra

    Manfred Stienstra March 26th, 2009 @ 08:19 AM

    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
    
  • Grant Rodgers

    Grant Rodgers March 26th, 2009 @ 06:37 PM

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

  • Jeremy Kemper

    Jeremy Kemper May 4th, 2010 @ 06:48 PM

    • Milestone changed from 2.x to 3.x
  • Santiago Pastorino

    Santiago Pastorino February 2nd, 2011 @ 04:40 PM

    • 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.

  • Santiago Pastorino

    Santiago Pastorino February 2nd, 2011 @ 04:40 PM

    • State changed from “open” to “stale”

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2 style="font-size: 14px">Tickets have moved to Github</h2>

The new ticket tracker is available at <a href="https://github.com/rails/rails/issues">https://github.com/rails/rails/issues</a>

People watching this ticket

Pages