f1results 0.2.pre.alpha.3 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c381557affdd5f2d9ce7294b915df1120a78a04f
-  data.tar.gz: 067d5b07bae14ce0c051997d0668cf5d69fe85b3
+  metadata.gz: 1b051ec7bbb7427df68b608f368ec9da378563ad
+  data.tar.gz: 7e0c83eaae83f0f033c0bd6137819b6d9f2e5fed
 SHA512:
-  metadata.gz: 7cec638c906397d24bfdfa57162387c800ad1fa571c83e6944d16feaca4885c5675aaa4f39ab5efde1b0b541265aa39230bd044e8a484a09094eaba2c6af09b1
-  data.tar.gz: e844bd99064029f4c3ac02f1c25580462f4726a410df61c5e7e86bc9a1a5d88b95a4a098b978e8b90646ab5bd05647aa57d98fcc07ee3461eace8c91e02f837c
+  metadata.gz: 81e62187f6284f0a4449a31ca52e676b390e1dbb1ecbe946074f1020b139be6f628a2caee888582ec18ebb2ba0fb959ccbeff78a1adcd24a1c1565e76a046a32
+  data.tar.gz: b69492c988f8047988587a10097f0577ea3be5b8a19b6e3614249040f6917e3e092120361e97d848be6ffa0e2169153df71ff702d54d73882588e1e5ef0feb7d

data/README.md

@@ -22,4 +22,4 @@ Or install it yourself as:
 
 ### Command Line
 
-    $ f1results <season> [<round>] [-q, --qualifying]
+    $ f1results -y <year> -c <country> [-e p1|p2|p3|q|r]

data/bin/f1results

@@ -8,33 +8,41 @@ require File.expand_path('../../lib/f1results.rb', __FILE__)
 year       = Time.now.year
 country    = ''
 event_type = :race
+url        = nil
 
 optparse = OptionParser.new do |opts|
   opts.on('-y', '--year=YEAR', Integer)      { |val| year = val }
   opts.on('-c', '--country=COUNTRY', String) { |val| country = val.downcase }
   opts.on('-e', '--event=EVENT', String)     { |val| event_type = val.downcase.to_sym }
+  opts.on('-u', '--url=URL', String)         { |val| url = val }
   opts.parse!
 end
 
 begin
-  event = F1Results.get(year, country, event_type)
-rescue Exception => e
-  puts e
+  event = if url.nil?
+    F1Results.fetch(year, country, event_type)
+  else
+    F1Results.fetch_with_url(url)
+  end
+rescue
+  event_summary = url || "#{year} #{country} #{event_type}"
+  puts "No results for #{event_summary}"
   exit
 end
 
-title = "#{event.season} #{event.country} #{event.type_name}\n#{event.name}"
+title = url.nil? ? "#{event.year} #{event.country_name} #{event.type_name}\n#{event.name}" : event.name
 table = Terminal::Table.new title: title, rows: event.to_a
 
 if event.practice?
-  table.headings = %W(Pos Driver Team Time Laps)
+  table.headings = %W(Pos Num Driver Team Time Gap Laps)
   table.align_column 0, :right
+  table.align_column 1, :right
   table.align_column 4, :right
+  table.align_column 6, :right
 
 elsif event.qualifying?
   table.headings = %W(Pos Driver Team Q1 Q2 Q3 Laps)
   table.align_column 0, :right
-  table.align_column 1, :right
   table.align_column 6, :right
 
 elsif event.race?

data/lib/f1results/agent.rb

@@ -2,20 +2,103 @@ require 'mechanize'
 
 module F1Results
   class Agent < ::Mechanize
-    def get_event(season, country, type)
-      event = Event.new(season: season, country: country, type: type)
-      path = "content/fom-website/en/championship/results/#{season}-race-results/#{season}-#{event.country_slug}-results/#{event.type_slug}.html"
+    attr_accessor :event
 
+    def initialize(event = nil)
+      if event.nil?
+        @event = F1Results::Event.new
+      else
+        self.event = event
+      end
+      super
+    end
+
+    def fetch_results
+      return fetch_results_with_url(@default_url)
+    end
+
+    def fetch_results_with_url(url)
       begin
-        get(::File.join(F1Results::BASEURL, path))
+        get(url)
+        @event.type = parse_event_type if @event.type.nil?
+        @event.country = parse_event_country if @event.country.nil?
+        @event.name = parse_event_title
+        @event.results = parse_event_results
+        return @event
       rescue Mechanize::ResponseCodeError, Net::HTTPNotFound
-        raise 'No results'
+        raise "No results found at #{url}"
       end
+    end
 
-      event.name = page.parser.xpath('//a[contains(@class, "level-0")]').text
-      table = page.parser.xpath('//tbody')
-
-      return event.parse_results_table(table)
+    def event=(event)
+      path = "content/fom-website/en/championship/results/#{event.year}-race-results/#{event.year}-#{event.country_slug}-results/#{event.type_slug}.html"
+      @default_url = ::File.join F1Results::BASEURL, path
+      @event = event
     end
+
+    private
+
+      def parse_event_type
+        return page.parser.xpath('//h1[@class="headline"]').text.strip rescue nil
+      end
+
+      def parse_event_country
+        return page.parser.xpath('//a[@class="tag-link"]').text.strip.parameterize rescue nil
+      end
+
+      def parse_event_title
+        return page.parser.xpath('//a[contains(@class, "level-0")]').text rescue nil
+      end
+
+      def parse_event_results
+        results = []
+        table = page.parser.xpath('//tbody')
+
+        # Remove driver abbreviation from cell
+        table.xpath('//span[@class="tla"]').each(&:remove)
+
+        # Turn HTML table into an array of arrays
+        data = table.xpath('//tr').map do |row|
+          row.xpath('./td|./th').map do |cell|
+            cell = cell.text.gsub(/[[:space:]]+/, ' ').strip
+            cell.blank? ? nil : cell
+          end
+        end
+
+        # Remove rows that have the cell "Q1 107% Time"
+        regex = /107%/
+        data.reject! { |row| row.any? { |cell| regex =~ cell } }
+
+        header = parse_table_header(data.shift)
+
+        result_class = case
+        when @event.practice?
+          PracticeResult
+        when @event.qualifying?
+          QualifyingResult
+        else
+          RaceResult
+        end
+
+        data.each_with_index do |row, i|
+          hash = Hash[header.zip(row)]
+          hash[:index] = i
+
+          result = result_class.new(hash)
+          results << result
+        end
+
+        return results
+      end
+
+      # Turn array of words to symbols
+      def parse_table_header(header)
+        header.map do |cell|
+          # Fix i18n cells that look like this
+          # {'Position' @ i18n}, {'Driver' @ i18n}, ...
+          cell = cell.match(/(')(.+)(')/)[2] if /i18n/ =~ cell
+          cell.to_s.strip.parameterize('_').to_sym
+        end
+      end
   end
 end

data/lib/f1results/event.rb

@@ -2,9 +2,9 @@ require 'active_support/core_ext/string'
 
 module F1Results
   class Event
-    attr_accessor :season, :country, :type, :name, :results
+    attr_accessor :year, :country, :type, :name, :results
 
-    TYPES = {
+    TYPE_ALIASES = {
       p1: :practice1,
       p2: :practice2,
       p3: :practice3,
@@ -17,20 +17,17 @@ module F1Results
       args.each { |k,v| send("#{k}=", v) }
     end
 
-    def country
-      @country.titleize
+    def country_name
+      @country.to_s.titleize
     end
 
     def country_slug
-      @country.parameterize
+      @country.to_s.parameterize
     end
 
     def type=(type)
-      if type.to_s.length <= 2
-        @type = TYPES[type]
-      else
-        @type = type
-      end
+      type = type.to_s.downcase.gsub(' ', '').to_sym
+      @type = TYPE_ALIASES[type] || type
     end
 
     # Human readable type, e.g. "Practice 1", "Qualifying"
@@ -43,7 +40,7 @@ module F1Results
     end
 
     def practice?
-      @type.to_s.gsub(/\d/, '') == 'practice'
+      /^practice(1|2|3)$/ =~ @type.to_s
     end
 
     def qualifying?
@@ -66,39 +63,14 @@ module F1Results
       @results.last.driver
     end
 
-    def parse_results_table(table)
-      @results = []
+    def fetch_results
+      agent = F1Results::Agent.new(self)
+      agent.fetch_results
+    end
 
-      # Remove driver abbreviation from cell, shown only in race results
-      table.xpath('//span[@class="tla"]').each(&:remove)
-
-      # Turn HTML table into an array of arrays
-      data = table.xpath('//tr').map do |row|
-        row.xpath('./td').map do |cell|
-          cell = cell.text.gsub(/[[:space:]]+/, ' ').strip
-          cell.blank? ? nil : cell
-        end
-      end
-
-      # Remove rows with empty position cells (Q1 107% Time), and table header if it's there
-      data.reject! { |row| row[0].nil? || row[0] == 'P' }
-
-      data.each_with_index do |row, i|
-        klass = case
-        when practice?
-          PracticeResult
-        when qualifying?
-          QualifyingResult
-        when race?
-          RaceResult
-        end
-
-        result = klass.new(row)
-        result.index = i
-        @results << result
-      end
-
-      self
+    def fetch_results_with_url(url)
+      agent = F1Results::Agent.new(self)
+      agent.fetch_results_with_url(url)
     end
   end
 end

data/lib/f1results/result.rb

@@ -1,9 +1,21 @@
 module F1Results
   class Result
-    attr_accessor :index, :position, :driver, :team, :laps
-
-    def initialize(row = nil)
-      build(row) unless row.nil?
+    attr_accessor :index, :position, :driver, :driver_number, :driver_country_abbr, :team, :time, :gap, :laps
+
+    alias :p=         :position=
+    alias :pos=       :position=
+    alias :name=      :driver=
+    alias :no=        :driver_number=
+    alias :country=   :driver_country_abbr=
+    alias :best_time= :time=
+    alias :race_time= :time=
+    alias :fastest=   :time=
+
+    def initialize(args = {})
+      args.each do |k, v|
+        # rescue here in case the results table has an obscure head cell like "Driver's Fastest Time"
+        send("#{k.to_s}=", v) rescue nil
+      end
     end
 
     def position=(n)
@@ -17,30 +29,23 @@ module F1Results
       end
     end
 
-    private
+    def driver_number
+      @driver_number.to_i == 0 ? nil : @driver_number.to_i
+    end
 
-      def build(row)
-        self.position = row[0]
-        @driver       = row[1]
-        row
-      end
+    def laps
+      @laps.to_i < 1 ? nil : @laps.to_i
+    end
+
+    def gap
+      @gap.to_f == 0.0 ? nil : @gap.to_f
+    end
   end
 
   class PracticeResult < Result
-    attr_accessor :time
-
     def to_a
-      [position, driver, team, time, laps]
+      [position, driver_number, driver, team, time, gap, laps]
     end
-
-    private
-
-      def build(row)
-        row = super
-        @team = row[2]
-        @time = row[3]
-        @laps = row[4].to_i
-      end
   end
 
   class QualifyingResult < Result
@@ -53,21 +58,12 @@ module F1Results
     def time
       q3 || q2 || q1
     end
-
-    private
-
-      def build(row)
-        row = super
-        @team = row[2]
-        @q1   = row[3]
-        @q2   = row[4]
-        @q3   = row[5]
-        @laps = row[6].to_i
-      end
   end
 
   class RaceResult < Result
-    attr_accessor :driver_country_abbr, :time, :retired, :points
+    attr_accessor :retired, :points
+
+    alias :points_awarded= :points=
 
     def to_a
       [position, driver, driver_country_abbr, team, time_or_retired, points]
@@ -85,14 +81,8 @@ module F1Results
       time || retired
     end
 
-    private
-
-      def build(row)
-        row = super
-        @driver_country_abbr = row[2]
-        @team                = row[3]
-        self.time_or_retired = row[4]
-        @points              = row[5].to_i
-      end
+    def points
+      @points.to_i
+    end
   end
 end

data/lib/f1results/version.rb

@@ -1,3 +1,3 @@
 module F1Results
-  VERSION = '0.2-alpha.3'
+  VERSION = '0.6'
 end

data/lib/f1results.rb

@@ -6,16 +6,22 @@ require 'f1results/result'
 module F1Results
   BASEURL = 'http://www.formula1.com'
 
-  # Get results from formula1.com for a given season, country, and event type
+  # Get results from formula1.com for a given year, country, and event type
   # (race or qualifying)
   #
-  #   F1Results.get(2010, 'australia', :qualifying)
+  #   F1Results.f1results(2010, 'australia', :qualifying)
   #
   # Returns an `F1Results::Event` object which has a method `results`, which
   # returns multiple objects of type `F1Results::Result`
 
-  def self.get(year, country, type = :race)
-    agent = F1Results::Agent.new
-    agent.get_event(year, country, type)
+  def self.fetch(year, country, type = :race)
+    event = Event.new(year: year, country: country, type: type)
+    event.fetch_results
+    return event
+  end
+
+  def self.fetch_with_url(url)
+    agent = Agent.new
+    return agent.fetch_results_with_url(url)
   end
 end

data/test/agent_test.rb

@@ -8,9 +8,9 @@ class AgentTest < MiniTest::Test
   end
 
   def test_get_event_2015_australia_race
-    event = @agent.get_event(2015, 'Australia', :race)
-    assert event.race?
-    assert_equal 'Australia', event.country
+    event = F1Results::Event.new(year: 2015, country: 'Australia', type: :race)
+    @agent.event = event
+    @agent.fetch_results
     assert_equal '2015 FORMULA 1 ROLEX AUSTRALIAN GRAND PRIX', event.name
     assert_equal 17, event.results.length
     assert_equal 'Lewis Hamilton', event.winner
@@ -18,9 +18,9 @@ class AgentTest < MiniTest::Test
   end
 
   def test_get_event_2015_australia_qualifying
-    event = @agent.get_event(2015, 'Australia', :qualifying)
-    assert event.qualifying?
-    assert_equal 'Australia', event.country
+    event = F1Results::Event.new(year: 2015, country: 'Australia', type: :qualifying)
+    @agent.event = event
+    @agent.fetch_results
     assert_equal '2015 FORMULA 1 ROLEX AUSTRALIAN GRAND PRIX', event.name
     assert_equal 20, event.results.length
     assert_equal 'Lewis Hamilton', event.winner
@@ -28,24 +28,47 @@ class AgentTest < MiniTest::Test
   end
 
   def test_get_event_2015_australia_practice1
-    event = @agent.get_event(2015, 'Australia', :practice1)
-    assert event.practice?
-    assert_equal 'Australia', event.country
+    event = F1Results::Event.new(year: 2015, country: 'Australia', type: :practice1)
+    @agent.event = event
+    @agent.fetch_results
     assert_equal '2015 FORMULA 1 ROLEX AUSTRALIAN GRAND PRIX', event.name
     assert_equal 16, event.results.length
     assert_equal 'Nico Rosberg', event.winner
     assert_equal 'Romain Grosjean', event.loser
   end
 
+  def test_get_event_2015_malaysia_practice2
+    event = F1Results::Event.new(year: 2015, country: 'Malaysia', type: :practice2)
+    @agent.event = event
+    @agent.fetch_results
+    assert_equal '2015 FORMULA 1 PETRONAS MALAYSIA GRAND PRIX', event.name
+    assert_equal 20, event.results.length
+    assert_equal 'Lewis Hamilton', event.winner
+    assert_equal 'Roberto Merhi', event.loser
+  end
+
+  def test_fetch_results_2015_hungary_race
+    event = @agent.fetch_results_with_url('http://www.formula1.com/content/fom-website/en/championship/results/2015-race-results/2015-Hungary-results/race.html')
+    assert_equal 'FORMULA 1 PIRELLI MAGYAR NAGYDÍJ 2015', event.name
+    assert_equal 'hungary', event.country
+    assert event.race?
+    assert_equal 20, event.results.length
+    assert_equal 'Sebastian Vettel', event.winner
+    assert_equal 'Nico Hulkenberg', event.loser
+  end
+
   def test_get_event_with_bad_year
-    assert_raises RuntimeError, 'No results' do
-      @agent.get_event(1900, 'Australia', :race)
+    assert_raises RuntimeError do
+      event = F1Results::Event.new(year: 1900, country: 'Australia', type: :race)
+      @agent.event = event
+      @agent.fetch_results
     end
   end
 
   def test_get_event_with_bad_grand_prix
-    assert_raises RuntimeError, 'No results' do
-      @agent.get_event(2015, 'New Zealand', :race)
+    assert_raises RuntimeError do
+      event = F1Results::Event.new(year: 2015, country: 'New Zealand', type: :race)
+      event.fetch_results
     end
   end
 end

data/test/event_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
 
 class EventTest < MiniTest::Test
+  include Fixtures
+
   def setup
     @event = F1Results::Event.new
-    @event.results << F1Results::RaceResult.new([1, 'Mark Webber', 'AUS', 'Red Bull Racing-Renault', '1:25:11.288', 2])
-    @event.results << F1Results::RaceResult.new([2, 'Fernando Alonso', 'ESP', 'Ferrari', '+3.0 secs', 1])
   end
 
   def test_type
@@ -12,16 +12,52 @@ class EventTest < MiniTest::Test
     assert_equal 'qualifying', @event.type_slug
     @event.type = :practice3
     assert_equal 'practice-3', @event.type_slug
+    @event.type = :p3
+    assert_equal :practice3, @event.type
+  end
+
+  def test_type_name
+    @event.type = :practice3
+    assert_equal 'Practice 3', @event.type_name
+    @event.type = :qualifying
+    assert_equal 'Qualifying', @event.type_name
+    @event.type = :race
+    assert_equal 'Race', @event.type_name
+  end
+
+  def test_type_setter_with_humanized_input
+    @event.type = 'Practice 3'
+    assert_equal :practice3, @event.type
+    @event.type = 'Qualifying'
+    assert_equal :qualifying, @event.type
+    @event.type = 'Race'
+    assert_equal :race, @event.type
+  end
+
+  def test_type_boolean_methods
+    @event.type = :race
+    assert @event.race?
+    @event.type = :qualifying
+    assert @event.qualifying?
+    @event.type = :practice1
+    assert @event.practice?
+    @event.type = :practice2
+    assert @event.practice?
+    @event.type = :practice3
+    assert @event.practice?
+    @event.type = :practice4
+    refute @event.practice?
   end
 
-  def test_country
-    @event.country = 'Australia'
-    assert_equal 'Australia', @event.country
+  def test_country_name
     @event.country = 'great britain'
-    assert_equal 'Great Britain', @event.country
+    assert_equal 'Great Britain', @event.country_name
   end
 
   def test_to_array
+    @event.results << F1Results::RaceResult.new(position: 1, driver: 'Mark Webber', driver_country_abbr: 'AUS', team: 'Red Bull Racing-Renault', time: '1:25:11.288', points: 2)
+    @event.results << F1Results::RaceResult.new(position: 2, driver: 'Fernando Alonso', driver_country_abbr: 'ESP', team: 'Ferrari', time: '+3.0 secs', points: 1)
+
     array = @event.to_a
     assert_equal 2, array.length
     assert_kind_of Array, array.first

data/test/result_test.rb

@@ -30,7 +30,7 @@ class ResultTest < MiniTest::Test
   end
 
   def test_parse_practice
-    result = F1Results::PracticeResult.new(['4', 'Carlos Sainz', 'Toro Rosso', '1:31.014',	'32'])
+    result = F1Results::PracticeResult.new(position: '4', driver: 'Carlos Sainz', team: 'Toro Rosso', time: '1:31.014', laps:	'32')
     assert_equal 4, result.position
     assert_equal 'Carlos Sainz', result.driver
     assert_equal 'Toro Rosso', result.team
@@ -39,7 +39,7 @@ class ResultTest < MiniTest::Test
   end
 
   def test_parse_qualifying
-    result = F1Results::QualifyingResult.new(['2', 'Nico Rosberg', 'Mercedes', '1:28.906', '1:27.097', '1:26.921', '14'])
+    result = F1Results::QualifyingResult.new(position: '2', driver: 'Nico Rosberg', team: 'Mercedes', q1: '1:28.906', q2: '1:27.097', q3: '1:26.921', laps: '14')
     assert_equal 2, result.position
     assert_equal 'Nico Rosberg', result.driver
     assert_equal 'Mercedes', result.team
@@ -50,7 +50,7 @@ class ResultTest < MiniTest::Test
   end
 
   def test_parse_race
-    result = F1Results::RaceResult.new(['3', 'Sebastian Vettel', 'GER', 'Ferrari', '+34.523s', '15'])
+    result = F1Results::RaceResult.new(position: '3', driver: 'Sebastian Vettel', driver_country_abbr: 'GER', team: 'Ferrari', time: '+34.523s', points: '15')
     assert_equal 3, result.position
     assert_equal 'Sebastian Vettel', result.driver
     assert_equal 'Ferrari', result.team
@@ -59,7 +59,7 @@ class ResultTest < MiniTest::Test
   end
 
   def test_parse_qualifying_with_blank_values
-    result = F1Results::QualifyingResult.new(['16', 'Marcus Ericsson', 'Sauber', '1:31.376', nil, nil, 10])
+    result = F1Results::QualifyingResult.new(position: '16', driver: 'Marcus Ericsson', team: 'Sauber', q1: '1:31.376', q2: nil, q3: nil, laps: 10)
     assert_equal '1:31.376', result.q1
     assert_equal nil, result.q2
     assert_equal nil, result.q3
@@ -67,7 +67,13 @@ class ResultTest < MiniTest::Test
   end
 
   def test_race_to_a
-    result = F1Results::RaceResult.new(['3', 'Sebastian Vettel', 'GER', 'Ferrari', '+34.523s', '15'])
+    result = F1Results::RaceResult.new(position: '3', driver: 'Sebastian Vettel', driver_country_abbr: 'GER', team: 'Ferrari', time: '+34.523s', points: '15')
     assert_equal [3, 'Sebastian Vettel', 'GER', 'Ferrari', '+34.523s', 15], result.to_a
   end
+
+  def test_unknown_key_doesnt_raise_error
+    assert_nothing_raised do
+      F1Results::Result.new(some_silly_column_name: 'value')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: f1results
 version: !ruby/object:Gem::Version
-  version: 0.2.pre.alpha.3
+  version: '0.6'
 platform: ruby
 authors:
 - Darren Jeacocke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -128,12 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: F1 Results