metar-parser 1.1.8 → 1.2.0

data/spec/unit/pressure_spec.rb

@@ -1,33 +1,22 @@
-# encoding: utf-8
-load File.expand_path( '../spec_helper.rb', File.dirname(__FILE__) )
+require "spec_helper"
 
 describe Metar::Pressure do
-
   context '.parse' do
-
     it 'interprets the Q prefix as hectopascals' do
-      Metar::Pressure.parse( 'Q1300' ).value.
-                                  should     be_within( 0.01 ).of( 1.3 )
+      expect(Metar::Pressure.parse( 'Q1300' ).value).to be_within( 0.01 ).of( 1.3 )
     end
 
     it 'interprets the A prefix as inches of mercury' do
-      Metar::Pressure.parse( 'A1234' ).value.
-                                  should     be_within( 0.01 ).of( 0.42 )
+      expect(Metar::Pressure.parse( 'A1234' ).value).to be_within( 0.01 ).of( 0.42 )
     end
 
     it 'require 4 digits' do
-      Metar::Pressure.parse( 'Q12345' ).
-                                  should     be_nil
-      Metar::Pressure.parse( 'A123' ).
-                                  should     be_nil
+      expect(Metar::Pressure.parse( 'Q12345' )).to be_nil
+      expect(Metar::Pressure.parse( 'A123' )).to be_nil
     end
 
     it 'returns nil for nil' do
-      Metar::Pressure.parse( nil ).
-                                  should     be_nil
+      expect(Metar::Pressure.parse( nil )).to be_nil
     end
-
   end
-
 end
-

data/spec/unit/raw_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 
 require 'net/ftp'
 require 'time'
+require 'timecop'
 
 module MetarRawTestHelper
   def raw_metar
@@ -14,17 +15,88 @@ describe Metar::Raw::Data do
   include MetarRawTestHelper
 
   context 'initialization' do
-    let(:call_time) { Time.parse('2012-07-29 16:35') }
+    let(:time) { Time.parse('2012-07-29 16:35') }
 
-    it 'should parse data, if supplied' do
-      now = call_time
-      Time.stub(:now) { now }
+    subject { described_class.new(raw_metar, time) }
 
-      raw = Metar::Raw::Data.new(raw_metar)
-     
-      expect(raw.metar).to eq(raw_metar)
-      expect(raw.cccc).to eq('ESSB')
-      expect(raw.time).to eq(call_time)
+    it "accepts a METAR string" do
+      expect(subject.metar).to eq(raw_metar)
+    end
+
+    it "accepts a reading time" do
+      expect(subject.time).to eq(time)
+    end
+
+    context "when called without a time parameter" do
+      it "warns that the usage is deprecated" do
+        expect { described_class.new(raw_metar) }.to output(/deprecated/).to_stderr
+      end
+    end
+  end
+end
+
+describe Metar::Raw::Metar do
+  context "time" do
+    let(:call_time) { Time.parse("2016-04-01 16:35") }
+    let(:raw_metar) { "OPPS 312359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+    subject { described_class.new(raw_metar) }
+
+    before { Timecop.freeze(call_time) }
+    after { Timecop.return }
+
+    it "is the last day with the day of month from the METAR datetime" do
+      expect(subject.time.year).to eq(2016)
+      expect(subject.time.month).to eq(3)
+      expect(subject.time.day).to eq(31)
+    end
+
+    context "when the current day of month is greater than the METAR's day of month" do
+      let(:call_time) { Time.parse("2016-04-11 16:35") }
+      let(:raw_metar) { "OPPS 092359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+      it "uses the date from the current month" do
+        expect(subject.time.year).to eq(2016)
+        expect(subject.time.month).to eq(4)
+        expect(subject.time.day).to eq(9)
+      end
+    end
+
+    context "when the previous month did not have the day of the month" do
+      let(:call_time) { Time.parse("2016-05-01 16:35") }
+
+      it "skips back to a previous month" do
+        expect(subject.time.year).to eq(2016)
+        expect(subject.time.month).to eq(3)
+        expect(subject.time.day).to eq(31)
+      end
+    end
+
+    context "when the datetime doesn't have 6 numerals" do
+      let(:raw_metar) { "OPPS 3123Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+      it "throws an error" do
+        expect { subject.time }.
+          to raise_error(RuntimeError, /6 digit/)
+      end
+    end
+
+    context "when the day of month in the datetime is > 31" do
+      let(:raw_metar) { "OPPS 332359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+      it "throws an error" do
+        expect { subject.time }.
+          to raise_error(RuntimeError, /at most 31/)
+      end
+    end
+
+    context "when the day of month in the datetime is 0" do
+      let(:raw_metar) { "OPPS 002359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+      it "throws an error" do
+        expect { subject.time }.
+          to raise_error(RuntimeError, /greater than 0/)
+      end
     end
   end
 end
@@ -32,13 +104,16 @@ end
 describe Metar::Raw::Noaa do
   include MetarRawTestHelper
 
-  let(:ftp) { double('ftp', :login => nil, :chdir => nil, :passive= => nil, :retrbinary => nil) }
+  let(:cccc) { "ESSB" }
+  let(:ftp) do
+    double(Net::FTP, login: nil, chdir: nil, :passive= => nil, retrbinary: nil)
+  end
 
   before do
-    Net::FTP.stub(:new).and_return(ftp)
+    allow(Net::FTP).to receive(:new) { ftp }
   end
 
-  after :each do
+  after do
     Metar::Raw::Noaa.send(:class_variable_set, '@@connection', nil)
   end
 
@@ -75,7 +150,7 @@ describe Metar::Raw::Noaa do
       Metar::Raw::Noaa.connect
 
       expect(Net::FTP).to have_received(:new)
-      expect(ftp).to have_received(:login).with()
+      expect(ftp).to have_received(:login).with(no_args)
       expect(ftp).to have_received(:chdir).with('data/observations/metar/stations')
       expect(ftp).to have_received(:passive=).with(true)
     end
@@ -143,37 +218,20 @@ describe Metar::Raw::Noaa do
     end
   end
 
-  context 'initialization' do
-    it 'should accept CCCC codes' do
-      raw = Metar::Raw::Noaa.new('XXXX')
-
-      expect(raw.cccc).to eq('XXXX')
-    end
-      
-    it 'should accept Stations' do
-      station = double('Metar::Station', :cccc => 'YYYY')
-      raw = Metar::Raw::Noaa.new(station)
-
-      expect(raw.cccc).to eq('YYYY')
-    end
-  end
-
-  context 'lazy loading' do
-    let(:noaa_metar) do
-      raw_time  = "2010/02/15 10:20"
-      "#{raw_time}\n#{raw_metar}"
-    end
+  context "fetching" do
+    let(:noaa_metar) { "#{raw_time}\n#{raw_metar}" }
+    let(:raw_time)   { "2010/02/15 10:20" }
 
     before do
-      Metar::Raw::Noaa.stub(:fetch => noaa_metar)
+      allow(ftp).to receive(:retrbinary).and_yield(noaa_metar)
     end
 
-    subject { Metar::Raw::Noaa.new('ESSB') }
+    subject { Metar::Raw::Noaa.new(cccc) }
 
-    it 'should fetch data on demand' do
+    it "queries for the station's data" do
       subject.metar
 
-      expect(Metar::Raw::Noaa).to have_received(:fetch).with('ESSB')
+      expect(ftp).to have_received(:retrbinary).with("RETR #{cccc}.TXT", 1024)
     end
 
     it 'sets data to the returned value' do
@@ -181,6 +239,27 @@ describe Metar::Raw::Noaa do
 
       expect(subject.data).to eq(noaa_metar)
     end
+
+    context "times" do
+      let(:cccc)      { "OPPS" }
+      let(:raw_time)  { "2016/03/31 23:59" }
+      let(:raw_metar) { "OPPS 312359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+
+      specify "are parsed as UTC" do
+        expect(subject.time.zone).to eq("UTC")
+      end
+
+      context "across month rollover" do
+        let(:after_midnight) { Time.parse("2016/04/01 00:02:11 UTC") }
+
+        specify "have correct date" do
+          Timecop.freeze(after_midnight) do
+            expect(subject.time.day).to eq(31)
+            expect(subject.time.month).to eq(3)
+            expect(subject.time.year).to eq(2016)
+          end
+        end
+      end
+    end
   end
 end
-

data/spec/unit/remark_spec.rb

@@ -1,20 +1,16 @@
-# encoding: utf-8
-load File.expand_path( '../spec_helper.rb', File.dirname(__FILE__) )
+require "spec_helper"
  
 describe Metar::Remark do
-
   context '.parse' do
-
-    it 'should delegate to subclasses' do
-      Metar::Remark.parse('21012').  should    be_a(Metar::TemperatureExtreme)
+    it 'delegate to subclasses' do
+      expect(Metar::Remark.parse('21012')).to be_a(Metar::TemperatureExtreme)
     end
 
-    it 'should return nil for unrecognised' do
-      Metar::Remark.parse('FOO').    should    be_nil
+    it 'returns nil for unrecognised' do
+      expect(Metar::Remark.parse('FOO')).to be_nil
     end
 
     context '6-hour maximum or minimum' do
-
       [
         ['positive maximum', '10046', [:maximum,  4.6]],
         ['negative maximum', '11012', [:maximum, -1.2]],
@@ -22,8 +18,7 @@ describe Metar::Remark do
         ['negative minimum', '21012', [:minimum, -1.2]],
       ].each do |docstring, raw, expected|
         example docstring do
-          Metar::Remark.parse(raw).
-                                should    be_temperature_extreme(*expected)
+          expect(Metar::Remark.parse(raw)).to be_temperature_extreme(*expected)
         end
       end
 
@@ -34,8 +29,8 @@ describe Metar::Remark do
       it 'returns minimum and maximum' do
         max, min = Metar::Remark.parse('400461006')
 
-        max.                      should    be_temperature_extreme(:maximum,  4.6)
-        min.                      should    be_temperature_extreme(:minimum, -0.6)
+        expect(max).to be_temperature_extreme(:maximum,  4.6)
+        expect(min).to be_temperature_extreme(:minimum, -0.6)
       end
 
     end
@@ -45,9 +40,9 @@ describe Metar::Remark do
       it 'steady_then_decreasing' do
         pt = Metar::Remark.parse('58033')
 
-        pt.                       should    be_a(Metar::PressureTendency)
-        pt.character.             should    == :steady_then_decreasing
-        pt.value.                 should    == 3.3
+        expect(pt).to be_a(Metar::PressureTendency)
+        expect(pt.character).to eq(:steady_then_decreasing)
+        expect(pt.value).to eq(3.3)
       end
 
     end
@@ -57,9 +52,9 @@ describe Metar::Remark do
       it '60009' do
         pr = Metar::Remark.parse('60009')
         
-        pr.                       should    be_a(Metar::Precipitation)
-        pr.period.                should    == 3
-        pr.amount.value.          should    == 0.002286
+        expect(pr).to be_a(Metar::Precipitation)
+        expect(pr.period).to eq(3)
+        expect(pr.amount.value).to eq(0.002286)
       end
 
     end
@@ -69,9 +64,9 @@ describe Metar::Remark do
       it '70015' do
         pr = Metar::Remark.parse('70015')
         
-        pr.                       should    be_a(Metar::Precipitation)
-        pr.period.                should    == 24
-        pr.amount.value.          should    == 0.003810
+        expect(pr).to be_a(Metar::Precipitation)
+        expect(pr.period).to eq(24)
+        expect(pr.amount.value).to eq(0.003810)
       end
 
     end
@@ -85,8 +80,8 @@ describe Metar::Remark do
         example docstring do
           aut = Metar::Remark.parse(raw)
 
-          aut.                      should    be_a(expected[0])
-          aut.type.                 should    == expected[1]
+          expect(aut).to be_a(expected[0])
+          expect(aut.type).to eq(expected[1])
         end
       end
 
@@ -97,8 +92,8 @@ describe Metar::Remark do
       it 'SLP125' do
         slp = Metar::Remark.parse('SLP125')
 
-        slp.                      should    be_a(Metar::SeaLevelPressure)
-        slp.pressure.value.       should    == 0.0125
+        expect(slp).to be_a(Metar::SeaLevelPressure)
+        expect(slp.pressure.value).to eq(0.0125)
       end
 
     end
@@ -108,9 +103,9 @@ describe Metar::Remark do
       it 'T00640036' do
         htm = Metar::Remark.parse('T00641036')
 
-        htm.                      should    be_a(Metar::HourlyTemperaturAndDewPoint)
-        htm.temperature.value.    should    ==  6.4
-        htm.dew_point.value.      should    == -3.6
+        expect(htm).to be_a(Metar::HourlyTemperaturAndDewPoint)
+        expect(htm.temperature.value).to eq(6.4)
+        expect(htm.dew_point.value).to eq(-3.6)
       end
 
     end
@@ -134,37 +129,37 @@ describe Metar::Lightning do
         chunks = section.split(' ')
         r = Metar::Lightning.parse_chunks(chunks)
 
-        r.                        should    be_a(Metar::Lightning)
-        r.type.                   should    == expected[0]
+        expect(r).to be_a(Metar::Lightning)
+        expect(r.type).to eq(expected[0])
         if expected[1]
-          r.distance.value.       should    == expected[1]
+          expect(r.distance.value).to eq(expected[1])
         else
-          r.distance.             should    be_nil
+          expect(r.distance).to be_nil
         end
-        r.directions.             should    == expected[2]
+        expect(r.directions).to eq(expected[2])
       end
     end
 
-    it 'should remove parsed chunks' do
+    it 'removes parsed chunks' do
       chunks = ['LTG', 'DSNT', 'SE', 'FOO']
 
       r = Metar::Lightning.parse_chunks(chunks)
 
-      chunks.                     should    == ['FOO']
+      expect(chunks).to eq(['FOO'])
     end
 
-    it 'should fail if the first chunk is not LTGnnn' do
+    it 'fails if the first chunk is not LTGnnn' do
       expect do
         Metar::Lightning.parse_chunks(['FOO'])
       end.                        to        raise_error(RuntimeError, /not lightning/)
     end
 
-    it 'should not fail if all chunks are parsed' do
+    it "doesn't not fail if all chunks are parsed" do
       chunks = ['LTG', 'DSNT', 'SE']
 
       r = Metar::Lightning.parse_chunks(chunks)
 
-      chunks.                     should    == []
+      expect(chunks).to eq([])
     end
 
   end

data/spec/unit/report_spec.rb

@@ -1,44 +1,32 @@
 # encoding: utf-8
-load File.expand_path( '../spec_helper.rb', File.dirname(__FILE__) )
+require "spec_helper"
 
 describe Metar::Report do
-
-  context 'initialization' do
-    
-    it 'loads the Station' do
-      station = stub( 'station' )
-      parser = stub( 'parser', :station_code => 'SSSS' )
-
-      Metar::Station.             should_receive( :find_by_cccc ).
-                                  with( 'SSSS' ).
-                                  and_return( station )
-
-      Metar::Report.new( parser )
-    end
-    
-  end
-
   context 'attributes' do
-
-    before :each do
-      @locale       = I18n.locale
-      @station_code = 'SSSS'
-      @metar_date   = '2008/05/06'
-      @metar_time   = '10:56'
-      @metar_datetime   = "#{@metar_date} #{@metar_time}"
-      @station      = stub( 'station', :name    => 'Airport 1',
-                                       :country => 'Wwwwww' )
-      @parser       = stub( 'parser', :station_code => @station_code,
-                                      :date         => Date.parse( @metar_date ),
-                                      :time         => Time.parse( @metar_datetime ),
-                                      :observer     => :real )
-      Metar::Station.stub( :find_by_cccc ).with( @station_code ).and_return( @station )
+    let(:parser) do
+      double(
+        Metar::Parser,
+        :station_code => station_code,
+        :date         => Date.parse(metar_date),
+        :time         => Time.parse(metar_datetime),
+        :observer     => :real
+      )
+    end
+    let(:station_code) { "SSSS" }
+    let(:locale) { I18n.locale }
+    let(:metar_date) { "2008/05/06" }
+    let(:metar_time) { "10:56" }
+    let(:metar_datetime) { "#{metar_date} #{metar_time}" }
+    let(:station) { double(Metar::Station, :name => 'Airport 1', :country => 'Wwwwww') }
+
+    before do
+      allow(Metar::Station).to receive(:find_by_cccc).with(station_code) { station }
     end
 
-    subject { Metar::Report.new( @parser ) }
+    subject { described_class.new(parser) }
 
     after :each do
-      I18n.locale = @locale
+      I18n.locale = locale
     end
 
     context '#date' do
@@ -48,30 +36,42 @@ describe Metar::Report do
     end
 
     context '#time' do
-      specify { subject.time.     should     == @metar_time }
+      it "is equal to the METAR time" do
+        expect(subject.time).to eq(metar_time)
+      end
 
       it 'zero-pads single figure minutes' do
-        @parser.stub(:time => Time.parse('10:02'))
+        allow(parser).to receive(:time) { Time.parse('10:02') }
 
         expect(subject.time).to eq('10:02')
       end
     end
 
     context '#observer' do
-      specify { subject.observer. should     == 'real' }
+      it "returns the observer" do
+        expect(subject.observer).to eq('real')
+      end
     end
 
-    specify { subject.station_name.
-                                  should     == 'Airport 1' }
+    context "#station_name" do
+      it "returns the name" do
+        expect(subject.station_name).to eq('Airport 1')
+      end
+    end
 
-    specify { subject.station_country.
-                                  should     == 'Wwwwww' }
+    context "#station_country" do
+      it "returns the country" do
+        expect(subject.station_country).to eq('Wwwwww')
+      end
+    end
 
-    specify { subject.station_code.
-                                  should     == @station_code }
+    context "#station_code" do
+      it "returns the station code" do
+        expect(subject.station_code).to eq(station_code)
+      end
+    end
 
     context 'proxied from parser' do
-
       context 'singly' do
         [
           :wind,
@@ -84,94 +84,86 @@ describe Metar::Report do
           :sea_level_pressure,
         ].each do | attribute |
           example attribute do
-            @attr = stub( attribute.to_s )
-            @parser.stub!( attribute => @attr )
+            allow(parser).to receive(attribute) { attribute.to_s }
 
-            @attr.                   should_receive( :to_s )
-
-            subject.send( attribute )
+            expect(subject.send(attribute)).to eq(attribute.to_s)
           end
         end
 
-        context '#sky_summary' do
-
-          it 'returns the summary' do
-            @skies1 = stub('sky_conditions')
-            @parser.stub!( :sky_conditions => [@skies1] )
+        context "#sky_summary" do
+          let(:conditions1) { double(:to_summary => "skies1") }
 
-            @skies1.              should_receive( :to_summary ).
-                                  and_return( 'skies1' )
+          it "returns the summary" do
+            allow(parser).to receive(:sky_conditions) { [conditions1] }
 
-            subject.sky_summary.  should     == 'skies1'
+            expect(subject.sky_summary).to eq("skies1")
           end
 
-          it 'clear skies when missing' do
-            @parser.stub!( :sky_conditions => [] )
+          it "clear skies when missing" do
+            allow(parser).to receive(:sky_conditions) { [] }
 
-            subject.sky_summary.  should     == 'clear skies'
+            expect(subject.sky_summary).to eq("clear skies")
           end
 
-          it 'uses the last, if there is more than 1' do
-            @skies1 = stub('sky_conditions1' )
-            @skies2 = stub('sky_conditions2' )
-            @parser.stub!( :sky_conditions => [ @skies1, @skies2 ] )
+          it "uses the last, if there is more than 1" do
+            @skies1 = double("sky_conditions1")
+            @skies2 = double("sky_conditions2", :to_summary => "skies2")
+            allow(parser).to receive(:sky_conditions) { [@skies1, @skies2] }
 
-            @skies2.              should_receive( :to_summary ).
-                                  and_return( 'skies2' )
-
-            subject.sky_summary.  should     == 'skies2'
+            expect(subject.sky_summary).to eq("skies2")
           end
         end
       end
 
-      context 'joined' do
-
-        it '#runway_visible_range' do
-          @rvr1 = stub( 'rvr1', :to_s => 'rvr1' )
-          @rvr2 = stub( 'rvr2', :to_s => 'rvr2' )
-          @parser.stub!( :runway_visible_range => [ @rvr1, @rvr2 ] )
+      context "joined" do
+        it "#runway_visible_range" do
+          @rvr1 = double("rvr1", :to_s => "rvr1")
+          @rvr2 = double("rvr2", :to_s => "rvr2")
+          allow(parser).to receive(:runway_visible_range) { [@rvr1, @rvr2] }
 
-          subject.runway_visible_range.
-                                  should     == 'rvr1, rvr2'
+          expect(subject.runway_visible_range).to eq("rvr1, rvr2")
         end
 
-        it '#present_weather' do
-          @parser.stub!( :present_weather => [ 'pw1', 'pw2' ] )
+        it "#present_weather" do
+          allow(parser).to receive(:present_weather) { ["pw1", "pw2"] }
 
-          subject.present_weather.should     == 'pw1, pw2'
+          expect(subject.present_weather).to eq("pw1, pw2")
         end
 
-        it '#remarks' do
-          @parser.stub!( :remarks => [ 'rem1', 'rem2' ] )
+        it "#remarks" do
+          allow(parser).to receive(:remarks) { ["rem1", "rem2"] }
 
-          subject.remarks.        should     == 'rem1, rem2'
+          expect(subject.remarks).to eq("rem1, rem2")
         end
 
         it '#sky_conditions' do
-          sky1 = stub( 'sky1', :to_s => 'sky1' )
-          sky2 = stub( 'sky2', :to_s => 'sky2' )
-          @parser.stub!( :sky_conditions => [ sky1, sky2 ] )
+          sky1 = double('sky1', :to_s => 'sky1')
+          sky2 = double('sky2', :to_s => 'sky2')
+          allow(parser).to receive(:sky_conditions) { [sky1, sky2] }
 
-          subject.sky_conditions. should     == 'sky1, sky2'
+          expect(subject.sky_conditions).to eq("sky1, sky2")
         end
-
       end
-
     end
 
-    it '#to_s' do
-      sky1 = stub( 'sky1', :to_summary => 'sky1' )
-      sky2 = stub( 'sky2', :to_summary => 'sky2' )
-      @parser.stub!( :wind            => 'wind',
-                     :visibility      => 'visibility',
-                     :minimum_visibility => 'min visibility',
-                     :present_weather => ['pw'],
-                     :sky_conditions  => [ sky1, sky2 ],
-                     :temperature     => 'temp' )
-      expected = <<EOT
+    context '#to_s' do
+      let(:sky1) { double('sky1', :to_summary => 'sky1') }
+      let(:sky2) { double('sky2', :to_summary => 'sky2') }
+
+      before do
+        allow(parser).to receive(:wind) { "wind" }
+        allow(parser).to receive(:visibility) { "visibility" }
+        allow(parser).to receive(:minimum_visibility) { "min visibility" }
+        allow(parser).to receive(:present_weather) { ["pw"] }
+        allow(parser).to receive(:sky_conditions) { [sky1, sky2] }
+        allow(parser).to receive(:temperature) { "temp" }
+      end
+
+      it "returns the full report" do
+        expected = <<EOT
 name: Airport 1
 country: Wwwwww
-time: #{@metar_time}
+time: #{metar_time}
 wind: wind
 visibility: visibility
 minimum visibility: min visibility
@@ -179,10 +171,8 @@ weather: pw
 sky: sky2
 temperature: temp
 EOT
-      subject.to_s.               should     == expected
+        expect(subject.to_s).to eq(expected)
+      end
     end
-
   end
-
 end
-