Contents

module OdeonUk
  # The object representing a film on the Odeon UK website
  class Film
    include Comparable

    # @return [String] the name of the film
    attr_reader :name
    # @return [String] the normalized slug derived from the film name
    attr_reader :slug

    # @param [String] name the film name
    # @return [OdeonUk::Film]
    def initialize(name)
      @name = name
      @slug = name.downcase.gsub(/[^0-9a-z ]/,'').gsub(/\s+/, '-')
    end

    # All currently listed films showing at a cinema
    # @param [Integer] cinema_id id of the cinema on the website
    # @return [Array<OdeonUk::Film>]
    def self.at(cinema_id)
      showtimes_page(cinema_id).to_a.map do |html|
        new(screenings_parser(html).film_name)
      end
    end

    # Allows sort on objects
    # @param [OdeonUk::Film] other another film object
    # @return [Integer] -1, 0 or 1
    def <=>(other)
      slug <=> other.slug
    end

    # Check an object is the same as another object.
    # @param [OdeonUk::Film] other another film
    # @return [Boolean] True if both objects are the same exact object, or if
    #   they are of the same type and share an equal slug
    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
    def eql?(other)
      self.class == other.class && self == other
    end

    # Generates hash of slug in order to allow two records of the same type and
    # id to work with something like:
    #
    #   [ Film.new('ABC'), Film.new('DEF') ] & [ Film.new('DEF'), Film.new('GHI') ]
    #   #=> [ Film.new('DEF') ]
    #
    # @return [Integer] hash of slug
    # @note Guided by http://woss.name/2011/01/20/equality-comparison-and-ordering-in-ruby/
    def hash
      slug.hash
    end

    private

    def self.screenings_parser(html)
      OdeonUk::Internal::FilmWithScreeningsParser.new(html)
    end

    def self.showtimes_page(cinema_id)
      OdeonUk::Internal::ShowtimesPage.new(cinema_id)
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
odeon_uk-2.0.4	lib/odeon_uk/film.rb
odeon_uk-2.0.3	lib/odeon_uk/film.rb
odeon_uk-2.0.2	lib/odeon_uk/film.rb
odeon_uk-2.0.1	lib/odeon_uk/film.rb
odeon_uk-2.0.0	lib/odeon_uk/film.rb