AnthonySuper/fatboy

class Fatboy
  ##
  # The viewed item class provides a (very) simple interface for interacting
  # with views on Models.
  # Almost always obtained from a TimeBasedPopularity, this struct simply
  # shows the id of the model, the number of views, and the rank.
  # NOTE: The highest-ranked item has rank 0. Ranks are 0-indexed.
  class ViewedItem
    def initialize(id, views, rank)
      @id = id.to_i
      @views = views.to_i
      @rank = rank.to_i
    end
    ##
    # Id of the model contained this this ViewedItem
    attr_reader :id
    ##
    # Amount this ViewedItem has been viewed in a time period.
    # This time period was pre-set on construction.
    attr_reader :views
    ##
    # The rank, 0 being the most viewed, of this item.
    # The time period was pre-set on construction, typically from a
    # Fatboy::TimeBasedView
    attr_reader :rank
  end
end