picturehouse_uk 3.0.14 → 4.0.0

data/README.md

@@ -2,10 +2,11 @@
 
 A simple gem to parse the [Picturehouse Cinemas UK website](http://picturehouses.com) and spit out useful formatted info.
 
-[![Gem Version](https://badge.fury.io/rb/picturehouse_uk.png)](http://badge.fury.io/rb/picturehouse_uk)
-[![Code Climate](https://codeclimate.com/github/andycroll/picturehouse_uk.png)](https://codeclimate.com/github/andycroll/picturehouse_uk)
-[![Build Status](https://travis-ci.org/andycroll/picturehouse_uk.png?branch=master)](https://travis-ci.org/andycroll/picturehouse_uk)
-[![Inline docs](http://inch-ci.org/github/andycroll/picturehouse_uk.png)](http://inch-ci.org/github/andycroll/picturehouse_uk)
+[![Gem Version](https://badge.fury.io/rb/picturehouse_uk.svg)](https://badge.fury.io/rb/picturehouse_uk)
+[![Code Climate](https://codeclimate.com/github/andycroll/picturehouse_uk/badges/gpa.svg)](https://codeclimate.com/github/andycroll/picturehouse_uk)
+[![Test Coverage](https://codeclimate.com/github/andycroll/picturehouse_uk/badges/coverage.svg)](https://codeclimate.com/github/andycroll/picturehouse_uk/coverage)
+[![Build Status](https://travis-ci.org/andycroll/picturehouse_uk.svg?branch=master)](https://travis-ci.org/andycroll/picturehouse_uk)
+[![Inline docs](http://inch-ci.org/github/andycroll/picturehouse_uk.svg?branch=master)](http://inch-ci.org/github/andycroll/picturehouse_uk)
 
 ## Installation
 

data/Rakefile

@@ -31,4 +31,16 @@ task :console do
   IRB.start
 end
 
+desc 'recreate test fixtures'
+task :fixtures do
+  require 'picturehouse_uk'
+  require_relative 'rake/fixture_creator'
+
+  FixtureCreator.new.home
+  %w(Duke_Of_Yorks Dukes_At_Komedia Phoenix_Picturehouse
+     National_Media_Museum).each do |cinema_id|
+    FixtureCreator.new.cinema(cinema_id)
+  end
+end
+
 task default: :test

data/lib/picturehouse_uk.rb

@@ -1,6 +1,5 @@
+require 'cinebase'
 require 'nokogiri'
-require 'tzinfo'
-require 'tzinfo/data'
 
 require_relative './picturehouse_uk/version'
 
@@ -10,8 +9,7 @@ require_relative './picturehouse_uk/internal/title_sanitizer'
 require_relative './picturehouse_uk/internal/website'
 
 require_relative './picturehouse_uk/cinema'
-require_relative './picturehouse_uk/film'
-require_relative './picturehouse_uk/screening'
+require_relative './picturehouse_uk/performance'
 
 module PicturehouseUk
 end

data/lib/picturehouse_uk/cinema.rb

@@ -1,59 +1,43 @@
 module PicturehouseUk
   # The object representing a cinema on the Picturehouse UK website
-  class Cinema
+  class Cinema < Cinebase::Cinema
     # address css
-    ADDRESS_CSS = '.static-content #contact-us + p:first'
+    ADDRESS_CSS = '.static-content #contact-us + p:first'.freeze
     # cinema link css
-    CINEMA_LINKS_CSS = '.footer .col-sm-3 option + option'
-
-    # @return [String] the brand of the cinema
-    attr_reader :brand
-    # @return [String] the id of the cinema on the Picturehouse website
-    attr_reader :id
-    # @return [String] the name of the cinema
-    attr_reader :name
-    # @return [String] the slug of the cinema
-    attr_reader :slug
-    # @return [String] the url of the cinema on the Picturehouse website
-    attr_reader :url
-
-    # @param [Hash] options id, name and url of the cinemas
-    # @return [PicturehouseUk::Cinema]
-    def initialize(options)
-      @brand = 'Picturehouse'
-      @id    = options[:id]
-      @name  = options[:name]
-      @slug  = @name.downcase.gsub(/[^0-9a-z ]/, '').gsub(/\s+/, '-')
-      @url   = if options[:url][0] == '/'
-                 "http://www.picturehouses.com#{options[:url]}"
-               else
-                 options[:url]
-               end
-    end
+    CINEMA_LINKS_CSS = '.footer .col-sm-3 option + option'.freeze
+
+    # @!attribute [r] id
+    #   @return [Integer] the numeric id of the cinema on the Cineworld website
+
+    # @!method initialize(options)
+    #   Constructor
+    #   @param [String] id the cinema id of the cinema in capitalized snake case
+    #   @return [PicturehouseUk::Cinema]
 
     # Return basic cinema information for all cinemas
     # @return [Array<PicturehouseUk::Cinema>]
     # @example
     #   PicturehouseUk::Cinema.all
-    #   # => [<PicturehouseUK::Cinema ...>, <PicturehouseUK::Cinema ...>, ...]
+    #   #=> [<PicturehouseUk::Cinema>, <PicturehouseUk::Cinema>, ...]
     def self.all
-      cinema_links.map { |link| new_from_link(link) }
+      cinema_hash.keys.map { |id| new(id) }
     end
 
-    # Find a single cinema
-    # @param [String] id the cinema id as used on the picturehouses.co.uk website
-    # @return [PicturehouseUk::Cinema, nil]
-    # @example
-    #   PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   # => <PicturehouseUK::Cinema ...>
-    def self.find(id)
-      all.find { |cinema| cinema.id == id }
+    # @api private
+    def self.cinema_hash
+      @cinema_hash ||= ListParser.new(cinema_links).to_hash
     end
 
+    # @!method address
+    #   Address of the cinema
+    #   @return [Hash] of different address parts
+    #   @see #adr
+
     # Address of the cinema
-    # @return [Hash] of different address parts
+    # @return [Hash] contains :street_address, :extended_address,
+    # :locality, :postal_code, :country
     # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
+    #   cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
     #   cinema.adr
     #   #=> {
     #         street_address:   '44-47 Gardner Street',
@@ -67,91 +51,97 @@ module PicturehouseUk
     def adr
       PicturehouseUk::Internal::Parser::Address.new(address_node.to_s).address
     end
-    alias_method :address, :adr
-
-    # The second address line of of the cinema
-    # @return [String, nil]
-    # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.extended_address
-    #   #=> 'North Laine'
-    # @note Uses method naming as at http://microformats.org/wiki/adr
-    def extended_address
-      address[:extended_address]
-    end
 
-    # Films with showings scheduled at this cinema
-    # @return [Array<PicturehouseUk::Film>]
+    # Brand of the cinema
+    # @return [String] which will always be 'Picturehouse'
     # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.films
-    #   # => [<PicturehouseUk::Film ...>, <PicturehouseUk::Film ...>, ...]
-    def films
-      PicturehouseUk::Film.at(@id)
-    end
+    #   cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #   cinema.brand
+    #   #=> 'Picturehouse'
+    def brand
+      'Picturehouse'.freeze
+    end
+
+    # @!method country_name
+    #   Country of the cinema
+    #   @return [String] which will always be 'United Kingdom'
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.country_name
+    #     #=> 'United Kingdom'
+
+    # @!method extended_address
+    #   The second address line of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.extended_address
+    #     #=> 'North Laine'
 
     # The name of the cinema (might include brand)
     # @return [String]
     # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
+    #   cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
     #   cinema.full_name
     #   #=> "Duke's At Komedia"
     def full_name
       name
     end
 
-    # The locality (town) of the cinema
-    # @return [String]
-    # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.locality
-    #   #=> 'Brighton'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def locality
-      address[:locality]
-    end
+    # @!method locality
+    #   The locality (town) of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.locality
+    #     #=> 'Brighton'
 
-    # Post code of the cinema
+    # The name of the cinema
     # @return [String]
     # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.postal_code
-    #   #=> 'BN1 1UN'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def postal_code
-      address[:postal_code]
-    end
-
-    # The region (county) of the cinema
+    #   cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #   cinema.name
+    #   #=> "Duke's At Komedia"
+    def name
+      self.class.cinema_hash.fetch(id, {})[:name]
+    end
+
+    # @!method postal_code
+    #   Post code of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.postal_code
+    #     #=> 'BN1 1UN'
+
+    # @!method region
+    #   The region (county) of the cinema if provided
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.region
+    #     #=> 'East Sussex'
+
+    # @!method slug
+    #   The URL-able slug of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.slug
+    #     #=> 'dukes-at-komedia'
+
+    # @!method street_address
+    #   The street address of the cinema
+    #   @return [String]
+    #   @example
+    #     cinema = PicturehouseUk::Cinema.new('Dukes_At_Komedia')
+    #     cinema.street_address
+    #     #=> '44-47 Gardner Street'
+
+    # The url of the cinema on the Picturehouse website
     # @return [String]
-    # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.region
-    #   #=> 'East Sussex'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def region
-      address[:region]
-    end
-
-    # All planned screenings
-    # @return [Array<PicturehouseUk::Screening>]
-    # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.screenings
-    #   # => [<PicturehouseUk::Screening ...>, <PicturehouseUk::Screening ...>]
-    def screenings
-      PicturehouseUk::Screening.at(@id)
-    end
-
-    # The street adress of the cinema
-    # @return a String
-    # @example
-    #   cinema = PicturehouseUk::Cinema.find('Dukes_At_Komedia')
-    #   cinema.street_address
-    #   #=> '44-47 Gardner Street'
-    # @note Uses the standard method naming as at http://microformats.org/wiki/adr
-    def street_address
-      address[:street_address]
+    def url
+      "http://www.picturehouses.com#/cinema/#{id}"
     end
 
     private
@@ -159,30 +149,49 @@ module PicturehouseUk
     def self.cinema_links
       home_doc.css(CINEMA_LINKS_CSS)
     end
+    private_class_method :cinema_links
 
     def self.home_doc
-      @home_doc ||= Nokogiri::HTML(website.home)
-    end
-
-    def self.website
-      @website ||= PicturehouseUk::Internal::Website.new
-    end
-
-    def self.new_from_link(link)
-      url =  link.get_attribute('data-href')
-      name = link.children.first.to_s.split(' — ')[1]
-
-      new(id:   url.match(%r{/cinema/(.+)$})[1],
-          name: name,
-          url:  url)
+      @home_doc ||=
+        Nokogiri::HTML(PicturehouseUk::Internal::Website.new.home)
     end
+    private_class_method :home_doc
 
     def address_node
       @address_node ||= info_doc.css(ADDRESS_CSS)
     end
 
     def info_doc
-      @info_doc ||= Nokogiri::HTML(self.class.website.info(id))
+      @info_doc ||=
+        Nokogiri::HTML(PicturehouseUk::Internal::Website.new.info(id))
+    end
+
+    # @api private
+    # Utility class to parse the links spat out from the options
+    class ListParser
+      def initialize(nodes)
+        @nodes = nodes
+      end
+
+      def to_hash
+        @nodes.each_with_object({}) do |node, result|
+          result[id(node)] = { name: name(node), url: url(node) }
+        end
+      end
+
+      private
+
+      def id(node)
+        url(node).match(%r{/cinema/(.+)$})[1]
+      end
+
+      def name(node)
+        node.children.first.to_s.split(' — ')[1]
+      end
+
+      def url(node)
+        node.get_attribute('data-href')
+      end
     end
   end
 end

data/lib/picturehouse_uk/internal/parser/address.rb

@@ -16,23 +16,35 @@ module PicturehouseUk
         def address
           {
             street_address:   array[1],
-            extended_address: array.length > 5 ? array[2] : nil,
+            extended_address: extended_address,
             locality:         town,
-            region:           array[-2] == town ? nil : array[-2],
-            postal_code:      array[-1],
-            country:          'United Kingdom'
+            region:           region,
+            postal_code:      postal_code,
+            country_name:     'United Kingdom'.freeze
           }
         end
 
         private
 
-        def town
-          @town ||= array[0].to_s.split(', ')[-1]
-        end
-
         def array
           @array ||= Array(@html.gsub(/\<.?p.?\>/, '').split('<br>'))
         end
+
+        def extended_address
+          array.length > 5 ? array[2] : nil
+        end
+
+        def postal_code
+          array[-1]
+        end
+
+        def region
+          array[-2] == town ? nil : array[-2]
+        end
+
+        def town
+          @town ||= array[0].to_s.split(', ')[-1]
+        end
       end
     end
   end

data/lib/picturehouse_uk/internal/parser/screenings.rb

@@ -4,23 +4,28 @@ module PicturehouseUk
     # @api private
     module Parser
       # Parses screenings page into an array of hashes for an individual cinema
-      Screenings = Struct.new(:cinema_id) do
+      class Screenings
         # css for a day of films & screenings
-        LISTINGS = '.listings li:not(.dark)'
-        DATE = '.nav-collapse.collapse'
+        LISTINGS = '.listings li:not(.dark)'.freeze
+        DATE = '.nav-collapse.collapse'.freeze
+
+        def initialize(cinema_id)
+          @cinema_id = cinema_id
+        end
 
         # parse the cinema page into an array of screenings attributes
         # @return [Array<Hash>]
         def to_a
           doc.css(LISTINGS).flat_map do |node|
-            FilmWithShowtimes.new(node, date_from_html(node.css(DATE).to_s)).to_a
+            FilmWithShowtimes.new(node,
+                                  date_from_html(node.css(DATE).to_s)).to_a
           end
         end
 
         private
 
         def date_from_html(html)
-          if !!html.match(/listings-further-ahead-today/)
+          if html =~ /listings-further-ahead-today/
             Date.now
           else
             html.match(/listings-further-ahead-(\d{4})(\d{2})(\d{2})/) do |m|
@@ -34,16 +39,23 @@ module PicturehouseUk
         end
 
         def page
-          @page ||= PicturehouseUk::Internal::Website.new.whats_on(cinema_id)
+          @page ||= PicturehouseUk::Internal::Website.new.whats_on(@cinema_id)
         end
       end
     end
 
-    FilmWithShowtimes = Struct.new(:node, :date) do
+    # @api private
+    # collection of timings for a specific film
+    class FilmWithShowtimes
       # film name css
-      NAME = '.top-mg-sm a'
+      NAME = '.top-mg-sm a'.freeze
       # variants css
-      VARIANTS = '.film-times .col-xs-10'
+      VARIANTS = '.film-times .col-xs-10'.freeze
+
+      def initialize(node, date)
+        @node = node
+        @date = date
+      end
 
       # The film name
       # @return [String]
@@ -54,8 +66,8 @@ module PicturehouseUk
       # Showings hashes
       # @return [Array<Hash>]
       def to_a
-        Array(node.css(VARIANTS)).flat_map do |variant|
-          Variant.new(variant, date).to_a.map do |hash|
+        Array(@node.css(VARIANTS)).flat_map do |variant|
+          Variant.new(variant, @date).to_a.map do |hash|
             {
               film_name: name,
               dimension: dimension
@@ -67,18 +79,19 @@ module PicturehouseUk
       private
 
       def dimension
-        raw_name.match(/3d/i) ? '3d' : '2d'
+        raw_name =~ /3d/i ? '3d' : '2d'
       end
 
       def raw_name
-        @raw_name ||= node.css(NAME).children.first.to_s
+        @raw_name ||= @node.css(NAME).children.first.to_s
       end
     end
 
+    # @api private
     # variants can have multiple screenings
-    Variant = Struct.new(:node, :date) do
-      SHOWTIMES  = '.btn'
-      VARIANT    = '.film-type-desc'
+    class Variant
+      SHOWTIMES  = '.btn'.freeze
+      VARIANT    = '.film-type-desc'.freeze
       TRANSLATOR = {
         'Big Scream'    => 'baby',
         'IMAX'          => 'imax',
@@ -86,13 +99,18 @@ module PicturehouseUk
         'NT Live'       => 'arts',
         'Screen Arts'   => 'arts',
         'Silver Screen' => 'senior'
-      }
+      }.freeze
+
+      def initialize(node, date)
+        @node = node
+        @date = date
+      end
 
       # Variant arrays
       # @return [Array<Hash>]
       def to_a
-        node.css(SHOWTIMES).map do |node|
-          { variant: variant }.merge(Showtime.new(node, date).to_hash)
+        @node.css(SHOWTIMES).map do |node|
+          { variant: variant }.merge(Showtime.new(@node, @date).to_hash)
         end
       end
 
@@ -105,26 +123,50 @@ module PicturehouseUk
       end
 
       def variant_text
-        @variant_text ||= node.css(VARIANT).to_s
+        @variant_text ||= @node.css(VARIANT).to_s
       end
     end
 
+    # @api private
     # parse an individual screening node
-    Showtime = Struct.new(:node, :date) do
+    class Showtime
+      def initialize(node, date)
+        @node = node
+        @date = date
+      end
+
       def to_hash
         {
-          booking_url: node['href'],
-          time:        time
+          booking_url: booking_url,
+          starting_at: starting_at
         }
       end
 
       private
 
-      def time
-        @time ||= begin
-          hour, min = node.text.split('.').map(&:to_i)
-          date.to_time + (hour * 60 + min) * 60
-        end
+      def booking_url
+        return if href.nil? || href.empty?
+        "https://picturehouses.com#{href}"
+      end
+
+      def hour
+        split[0]
+      end
+
+      def href
+        @href ||= @node['href']
+      end
+
+      def min
+        split[1]
+      end
+
+      def split
+        @split ||= @node.text.split('.').map(&:to_i)
+      end
+
+      def starting_at
+        @starting_at ||= @date.to_time + (hour * 60 + min) * 60
       end
     end
   end