auntie 0.2.0 → 0.3.0

data/lib/bbc/schedule.rb

@@ -1,16 +1,20 @@
 # encoding: utf-8
 
+# Shows schedule information for BBC Television and Radio stations
+#
 # Helpful urls
 #
 # http://www.bbc.co.uk/programmes/developers
 # http://www.bbc.co.uk/ontologies/programmes/2009-09-07.shtml
-
+#
 class Schedule
-  def initialize(io=STDOUT)
+  include ShellColors, Timings
+
+  def initialize(io = STDOUT)
     @io = io
   end
 
-  def load channel
+  def load(channel)
     station = channel[:id]
     region = channel[:region] ||= ''
     period = channel[:period] ||= ''
@@ -22,7 +26,7 @@ class Schedule
     list data, period
   end
 
-  def list data, period
+  def list(data, period)
     now = time_now
 
     data['schedule']['day']['broadcasts'].each do |e|
@@ -31,22 +35,17 @@ class Schedule
       next if ends < now unless period == '/yesterday'
 
       title = e['programme']['display_titles']['title']
-      #synopsis = e['programme']['short_synopsis']
+      # synopsis = e['programme']['short_synopsis']
 
       starts = Time.parse(e['start'])
 
-      starts_at = starts.strftime("%H:%M") # "%I:%M%P"
+      starts_at = starts.strftime('%H:%M') # "%I:%M%P"
       desc = "#{starts_at} #{title}"
 
-      if (starts < now) && (ends > now)
-        desc = light_green desc
-      end
+      on_now = (starts < now && ends > now)
+      desc = light_green desc if on_now
 
       @io.puts desc
     end
   end
-
-  def time_now
-    Time.now
-  end
 end

data/lib/bbc/shell/characters.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 
-#http://www.utf8-chartable.de/unicode-utf8-table.pl
-
+# Easy output of characters in your terminal
+#
+# http://www.utf8-chartable.de/unicode-utf8-table.pl
+#
 module ShellCharacters
-
   def west
     "\xe2\x86\x90"
   end
@@ -37,7 +38,11 @@ module ShellCharacters
   end
 
   def degrees_c
-    "\xC2\xB0C" #Shell escaped °C
+    "\xC2\xB0C"
+  end
+
+  def degrees_f
+    "\xC2\xB0F"
   end
 
   def square_block
@@ -46,23 +51,28 @@ module ShellCharacters
 
   def symbol_for_compass(direction)
     case direction
-      when 'N' then north
-      when 'NNE' then north
-      when 'NE' then north_east
-      when 'ENE' then east
-      when 'E' then east
-      when 'ESE' then east
-      when 'SE' then south_east
-      when 'SSE' then south
-      when 'S' then south
-      when 'SSW' then south
-      when 'SW' then south_west
-      when 'WSW' then west
-      when 'W' then west
-      when 'WNW' then west
-      when 'NW' then north_west
-      when 'NNW' then north
-      else north
+    when 'N' then north
+    when 'NNE' then north
+    when 'NE' then north_east
+    when 'ENE' then east
+    when 'E' then east
+    when 'ESE' then east
+    when 'SE' then south_east
+    when 'SSE' then south
+    when 'S' then south
+    when 'SSW' then south
+    when 'SW' then south_west
+    when 'WSW' then west
+    when 'W' then west
+    when 'WNW' then west
+    when 'NW' then north_west
+    when 'NNW' then north
+    else north
     end
   end
-end
+
+  module_function :symbol_for_compass,
+                  :north, :east, :south, :west,
+                  :north_east, :south_east, :south_west, :north_west,
+                  :degrees_c, :degrees_f, :square_block
+end

data/lib/bbc/shell/colors.rb

@@ -1,39 +1,46 @@
 # encoding: utf-8
 
+# Outputs the input in technicolour, for a happier terminal.
+#
 # Useful list of colour codes
 # http://misc.flogisoft.com/bash/tip_colors_and_formatting
-
+#
 # And alternatives
 # http://stackoverflow.com/questions/1108767/terminal-color-in-ruby
-
-def paint txt, color
-  "\033[#{color}m#{txt}\033[0m"
-end
-
-def green txt
-  paint txt, 32
-end
-
-def red txt
-  paint txt, 31
-end
-
-def light_green txt
-  paint txt, 92
-end
-
-def yellow txt
-  paint txt, 33
-end
-
-def cyan txt
-  paint txt, 36
-end
-
-def blue txt
-  paint txt, 34
-end
-
-def white txt
-  paint txt, 37
+#
+module ShellColors
+  def paint(txt, color)
+    "\033[#{color}m#{txt}\033[0m"
+  end
+
+  def red(txt)
+    paint(txt, 31)
+  end
+
+  def green(txt)
+    paint(txt, 32)
+  end
+
+  def yellow(txt)
+    paint(txt, 33)
+  end
+
+  def blue(txt)
+    paint(txt, 34)
+  end
+
+  def cyan(txt)
+    paint(txt, 36)
+  end
+
+  def white(txt)
+    paint(txt, 37)
+  end
+
+  def light_green(txt)
+    paint(txt, 92)
+  end
+
+  module_function :paint, :green, :red, :light_green,
+                  :yellow, :cyan, :blue, :white
 end

data/lib/bbc/shell/describe_time.rb

@@ -1,20 +1,30 @@
 # encoding: utf-8
 
-def how_long_between past, future
-  a = (future-past).to_i
+# Collection of time related methods awaiting a relevantly named module.
+#
+module Timings
+  def how_long_between(past, future)
+    a = (future - past).to_i
 
-  case a
-    when -10000000..0 then "On now"
+    case a
+    when -10_000_000...0 then 'On now'
     when 0 then 'Now!'
     when 1 then 'A second'
-    when 2..59 then a.to_s+' secs'
-    when 60..119 then 'A min' #120 = 2 minutes
-    when 120..3540 then (a/60).to_i.to_s+' mins'
-    when 3541..7100 then 'An hour' # 3600 = 1 hour
-    when 7101..82800 then ((a+99)/3600).to_i.to_s+' hours'
-    when 82801..172000 then 'A day' # 86400 = 1 day
-    when 172001..518400 then ((a+800)/(60*60*24)).to_i.to_s+' days'
-    when 518400..1036800 then 'A week'
-    else ((a+180000)/(60*60*24*7)).to_i.to_s+' weeks'
+    when 2..59 then a.to_s + ' secs'
+    when 60..119 then 'A min' # 120 = 2 minutes
+    when 120..3_540 then (a / 60).to_i.to_s + ' mins'
+    when 3_541..7_100 then 'An hour' # 3600 = 1 hour
+    when 7_101..82_800 then ((a + 99) / 3600).to_i.to_s + ' hours'
+    when 82_801..172_000 then 'A day' # 86400 = 1 day
+    when 172_001..518_400 then ((a + 800) / (60 * 60 * 24)).to_i.to_s + ' days'
+    when 518_401..1_036_800 then 'A week'
+    else ((a + 180_000) / (60 * 60 * 24 * 7)).to_i.to_s + ' weeks'
+    end
   end
+
+  def time_now
+    Time.now
+  end
+
+  module_function :how_long_between, :time_now
 end

data/lib/bbc/sport.rb

@@ -1,17 +1,21 @@
 # encoding: utf-8
 
+# Lists the latest BBC Sport headlines
+#
 class Sport
-  def initialize(io=STDOUT)
+  include ShellColors
+
+  def initialize(io = STDOUT)
     @io = io
   end
 
   def headlines
-    data['entries'].each { |item|
+    data['entries'].each do |item|
       prompt = yellow item['prompt'].capitalize.ljust(22)
 
       headline = item['headline']
-      @io.puts prompt+headline
-    }
+      @io.puts prompt + headline
+    end
   end
 
   private
@@ -22,12 +26,10 @@ class Sport
 
   def data
     begin
-     raw = open(url, 'UserAgent' => AUNTIE::USER_AGENT).read
-     JSON.parse(raw)
+      raw = open(url, 'UserAgent' => AUNTIE::USER_AGENT).read
+      JSON.parse(raw)
     rescue
-      @io.puts "Unable to download sport"
-      exit
+      raise 'Unable to download sport data'
     end
   end
-
 end

data/lib/bbc/version.rb

@@ -1,7 +1,9 @@
 # encoding: utf-8
 
+# Gem versioning and identification constants
+#
 module AUNTIE
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
   NAME = 'auntie'
   USER_AGENT = "#{NAME}-#{VERSION}"
 end

data/lib/bbc/weather.rb

@@ -1,11 +1,14 @@
 # encoding: utf-8
 
+# Lists BBC weather for the requested location
+#
+#
 class Weather
-  include ShellCharacters
+  include ShellCharacters, ShellColors
 
   attr_reader :base_url
 
-  def initialize(location, io=STDOUT)
+  def initialize(location, io = STDOUT)
     @io = io
     @base_url = "http://open.live.bbc.co.uk/weather/feeds/en/#{location}"
   end
@@ -18,7 +21,7 @@ class Weather
     @io.puts "\nThe next 24 hours in #{location}\n\n"
     @io.puts "Day        Time    Weather            Max#{degrees_c}    Wind"
 
-    feed['forecastContent']['forecasts'].each { |e|
+    feed['forecastContent']['forecasts'].each do |e|
 
       day = e['dayName'].ljust(10)
       time = e['timeSlot'].ljust(7)
@@ -28,17 +31,18 @@ class Weather
       temp = "#{temp}#{degrees_c}".ljust(6)
 
       wind = e['wind']['directionDesc']
-      wind_dir = e['wind']['direction']
+      # wind_dir = e['wind']['direction']
       wind_spd = e['wind']['windspeed']['mph'] || '?'
       wind_spd = "#{wind_spd}mph".ljust(5)
 
-      #visibility = e['visibility']
-      #millibars = e['pressureMillibars']
-      #humidity = e['humidityPercent']
-      #temp_colour = temp_to_color(temp.to_i)
+      # visibility = e['visibility']
+      # millibars = e['pressureMillibars']
+      # humidity = e['humidityPercent']
+      # temp_colour = temp_to_color(temp.to_i)
 
       @io.puts "#{yellow day} #{time} #{desc} #{temp} #{wind_spd} #{wind}"
-    }
+    end
+
     @io.puts "\n"
   end
 
@@ -50,11 +54,11 @@ class Weather
     @io.puts "\nThe next 3 days in #{location}\n\n"
     @io.puts "Day        Weather           Max#{degrees_c}  Wind"
 
-    feed['forecastContent']['forecasts'].each { |e|
-      day = sprintf "%-10s", e['dayName']
+    feed['forecastContent']['forecasts'].each do |e|
+      day = sprintf '%-10s', e['dayName']
 
       d_weather = e['day']['weatherType']
-      d_weather = sprintf "%-12s", d_weather unless d_weather.nil?
+      d_weather = sprintf '%-12s', d_weather unless d_weather.nil?
 
       d_temp = e['day']['maxTemperature']['centigrade']
       d_temp = "#{d_temp}\xC2\xB0C" unless d_temp.nil?
@@ -63,36 +67,34 @@ class Weather
       d_wind_spd = e['day']['wind']['windspeed']['mph']
       d_wind_spd = "#{d_wind_spd}mph" unless d_wind_spd.nil?
 
-      day_desc = sprintf "%-17s %-6s %-5s %-20s", d_weather, d_temp, d_wind_spd, d_wind
+      day_desc = sprintf '%-17s %-6s %-5s %-20s', d_weather, d_temp, d_wind_spd, d_wind
 
       n_weather = e['night']['weatherType']
       n_temp = e['night']['minTemperature']['centigrade']
       n_temp = "#{n_temp}\xC2\xB0C" unless n_temp.nil?
 
-      night_desc = sprintf "%-17s %-3s", n_weather, n_temp
+      night_desc = sprintf '%-17s %-3s', n_weather, n_temp
 
       @io.puts "#{yellow day} #{day_desc} #{cyan 'Night'} #{white night_desc}"
-    }
+    end
   end
 
   private
 
   def load(url)
     begin
-     raw = open(url, 'UserAgent' => AUNTIE::USER_AGENT).read
-     JSON.parse(raw)
+      raw = open(url, 'UserAgent' => AUNTIE::USER_AGENT).read
+      JSON.parse(raw)
     rescue
-      @io.puts "Unable to download the weather"
-      exit
+      raise 'Unable to download the weather'
     end
   end
 
-  #def temp_to_color(temp)
-  #  case temp
-  #  when -100..0 then blue(square_block)
-  #  when 0..10 then yellow(square_block)
-  #  else red(square_block)
-  #  end
-  #end
-
+  # def temp_to_color(temp)
+  #   case temp
+  #   when -100..0 then blue(square_block)
+  #   when 0..10 then yellow(square_block)
+  #   else red(square_block)
+  #   end
+  # end
 end

data/spec/bbc/colors_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), '/../spec_helper')
+
+describe ShellColors, 'colours text for terminal' do
+  it 'colours red' do
+    expect(ShellColors.red 'red').to eq "\e[31mred\e[0m"
+  end
+
+  it 'colours green, yellow, cyan, blue, light green' do
+    colours = %w(red green yellow blue cyan white)
+    codes   =   [31, 32,   33,    34,  36,  37]
+
+    colours.zip(codes) do |color, code|
+      expect(ShellColors.send(color, color)).to include("\e[#{code}m#{color}")
+    end
+  end
+end

data/spec/bbc/describe_time_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), '/../spec_helper')
+
+describe Timings do
+  describe 'what the time is now' do
+    it 'is now' do
+      expect(Timings.time_now.class).to be Time
+    end
+  end
+
+  describe 'how long until a programme starts' do
+    it 'is on now' do
+      expect(Timings.how_long_between(1, 0)).to eq 'On now'
+    end
+
+    it 'is now' do
+      expect(Timings.how_long_between(0, 0)).to eq 'Now!'
+    end
+
+    it 'is in a second' do
+      expect(Timings.how_long_between(0, 1)).to eq 'A second'
+    end
+
+    it 'in seconds' do
+      expect(Timings.how_long_between(0, 2)).to eq '2 secs'
+      expect(Timings.how_long_between(0, 59)).to eq '59 secs'
+    end
+
+    it 'is a minute' do
+      expect(Timings.how_long_between(0, 60)).to eq 'A min'
+      expect(Timings.how_long_between(0, 119)).to eq 'A min' # round here?
+    end
+
+    it 'is minutes' do
+      expect(Timings.how_long_between(0, 120)).to eq '2 mins'
+      expect(Timings.how_long_between(0, 3_540)).to eq '59 mins'
+    end
+
+    it 'is an hour' do
+      expect(Timings.how_long_between(0, 3_541)).to eq 'An hour'
+      expect(Timings.how_long_between(0, 7_100)).to eq 'An hour' # round here?
+    end
+
+    it 'is hours' do
+      expect(Timings.how_long_between(0, 7_101)).to eq '2 hours'
+      expect(Timings.how_long_between(0, 82_800)).to eq '23 hours'
+    end
+
+    it 'is a day' do
+      expect(Timings.how_long_between(0, 82_801)).to eq 'A day'
+      expect(Timings.how_long_between(0, 172_000)).to eq 'A day'
+    end
+
+    it 'is days' do
+      expect(Timings.how_long_between(0, 172_001)).to eq '2 days'
+      expect(Timings.how_long_between(0, 518_400)).to eq '6 days'
+    end
+
+    it 'is a week' do
+      expect(Timings.how_long_between(0, 518_401)).to eq 'A week'
+      expect(Timings.how_long_between(0, 1_036_800)).to eq 'A week'
+    end
+
+    it 'is weeks' do
+      expect(Timings.how_long_between(0, 1_036_801)).to eq '2 weeks'
+    end
+  end
+end