Add top and top_in helper methods

Add `top(number)` method as a shorthand of `members_from_rank_range(1,number)

Add `top_in(leaderboard_name, number)` method as a shorthan of `members_from_rank_range_in(leaderboard_name, 1, number)`

Testing top methods for rever leadearboard type

Testing Againts to Tie Ranking Leaderboard

Testing Competition Ranking Leaderboard

lib/leaderboard.rb

@@ -812,6 +812,29 @@ def members_from_rank_range_in(leaderboard_name, starting_rank, ending_rank, opt
     end
   end
 
+  # Retrieve members from the leaderboard within a range from 1 to the number given.
+  #
+  # @param ending_rank [int] Ending rank (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return number from the leaderboard that fall within the given rank range.
+  def top(number, options = {})
+    members_from_rank_range(1, number, options)
+  end
+
+  # Retrieve members from the named leaderboard within a range from 1 to the number given.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param starting_rank [int] Starting rank (inclusive).
+  # @param ending_rank [int] Ending rank (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return members from the leaderboard that fall within the given rank range.
+  def top_in(leaderboard_name, number, options={})
+    members_from_rank_range_in(leaderboard_name, 1, number, options)
+  end
+
+
   # Retrieve a member at the specified index from the leaderboard.
   #
   # @param position [int] Position in leaderboard.
@@ -989,4 +1012,4 @@ def validate_page_size(page_size)
 
     page_size
   end
-end
+end

spec/competition_ranking_leaderboard_spec.rb

@@ -123,5 +123,48 @@
 
       leaderboard.disconnect
     end
+
+    it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+      @leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top(5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+      @leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top_in("ties", 5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
   end
-end
+end

spec/leaderboard_spec.rb

@@ -626,6 +626,46 @@
     expect(members[24][:member]).to eql('member_1')
   end
 
+  it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top(5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[4][:member]).to eql('member_21')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_25')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[24][:member]).to eql('member_1')
+  end
+
+  it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top_in("name", 5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[4][:member]).to eql('member_21')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_25')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[24][:member]).to eql('member_1')
+  end
+
   it 'should sort by rank if the :sort_by option is set to :rank' do
     rank_members_in_leaderboard(25)
 
@@ -767,4 +807,4 @@
     expect(@redis_connection.exists("name:member_data")).to be_falsey
     expect(@redis_connection.exists("name:md")).to be_truthy
   end
-end
+end

spec/reverse_leaderboard_spec.rb

@@ -335,6 +335,48 @@
     expect(members[24][:member]).to eql('member_25')
   end
 
+  it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top(5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[4][:member]).to eql('member_5')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_1')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[24][:member]).to eql('member_25')
+  end
+
+  it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top_in("name", 5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[4][:member]).to eql('member_5')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_1')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[24][:member]).to eql('member_25')
+  end
+
+
+
   it 'should sort by rank if the :sort_by option is set to :rank' do
     rank_members_in_leaderboard(25)
 
@@ -370,4 +412,4 @@
     expect(ranked_members[2][:rank]).to be(10)
     expect(ranked_members[2][:score]).to eql(10.0)
   end
-end
+end

spec/tie_ranking_leaderboard_spec.rb

@@ -197,6 +197,69 @@
       end
     end
 
+    it 'should allow you to retrieve a given set of members from the leaderboard in a rank range' do
+      @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.members_from_rank_range(5, 9)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_21')
+      expect(members[0][:score].to_i).to be(21)
+      expect(members[4][:member]).to eql('member_17')
+
+      members = @leaderboard.members_from_rank_range(1, 1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.members_from_rank_range(-1, 26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+      @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top(5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+      @leaderboard = TieRankingLeaderboard.new('name', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top_in("name", 5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
     it 'should expire the ties leaderboard in a given number of seconds' do
       @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
@@ -238,4 +301,4 @@
       end
     end
   end
-end
+end