Sha256: e286b476833cd5fbc87930a82461ed8ce2e050111fb002637745fba2a6a6845c
Contents?: true
Size: 1.58 KB
Versions: 11
Compression:
Stored size: 1.58 KB
Contents
module Trackerific
# Provides details for a tracking event
class Event
# Provides a new instance of Event
# @param [DateTime] date the date / time of the event
# @param [String] description the event's description
# @param [String] location where the event took place
# @api private
def initialize(date, description, location)
@date = date
@description = description
@location = location
end
# The date and time of the event
# @example Get the date of an event
# date = details.events.first.date
# @return [DateTime]
# @api public
def date
@date
end
# The event's description
# @example Get the description of an event
# description = details.events.first.description
# @return [String]
# @api public
def description
@description
end
# Where the event took place (usually in City State Zip format)
# @example Get the location of an event
# location = details.events.first.location
# @return [String]
# @api public
def location
@location
end
# Converts the event into a string
# @example Get a human-readable string from an event
# event = details.event.to_s
# @example A bulleted list of events in haml
# %ul
# - details.events.each do |event|
# %li= event
# @return [String] converts the event into a string
# @api public
def to_s
dte = self.date.strftime('%b %d %I:%M %P')
des = self.description
loc = self.location
"#{dte} #{des} #{loc}"
end
end
end
Version data entries
11 entries across 11 versions & 1 rubygems