metar-parser 1.1.8 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f2c3aa5a4cae4d28cfa2ac65827416eae8ea706
+  data.tar.gz: 2edc10a772b9142531f3e3a942b5c913d043c98b
+SHA512:
+  metadata.gz: aa27381ba8e8bca2a90df135f4d1d3d9558d8c063f119e575a51e76577b4bb97164412204d0cffd49d4557e6ea99654ddd44b48c3781dfd4826bb3a4e18c93dd
+  data.tar.gz: 18eb8ba4319e3864b129dce58fffc9231623e63da8f8c737445c53693e5eaef669c9d4da3c87377d2b3dffcdaac00787a848c51fcd679cecd31d47396a2e08e5

data/README.md

@@ -15,19 +15,15 @@ metar-parser [![Build Status](https://secure.travis-ci.org/joeyates/metar-parser
 
 The information comes from the National Oceanic and Atmospheric Association's raw data source.
 
-Usage
-=====
+# Installation
 
 ```ruby
-require 'rubygems' if RUBY_VERSION < '1.9'
 require 'metar'
 ```
 
-Examples
-========
+# Examples
 
-Hello World
------------
+## Hello World
 
 This prints the latest weather report for Portland International Airport:
 
@@ -36,39 +32,59 @@ station = Metar::Station.find_by_cccc('KPDX')
 puts station.report.to_s
 ```
 
-Countries
----------
+## Using Your Own Raw Data
 
-List countries:
+The parser needs to know the full date when the reading was taken. Unfortunately,
+the METAR string itself only contains the day of the month.
+
+### When you know the date of the reading
+
+Use `Metar::Raw::Data` and supply the date as the second parameter:
 
 ```ruby
-puts Metar::Station.countries
+metar_string = "KHWD 280554Z AUTO 29007KT 10SM OVC008 14/12 A3002 RMK AO2 SLP176 T01390117 10211\n"
+raw    = Metar::Raw::Data.new(metar_string, reading_date)
+parser = Metar::Parser.new(raw)
 ```
 
-Find a country's weather stations:
+### When you do not know the date
+
+Use `Metar::Raw::Metar` - the library will choose the date as the most recent
+day with the day of the month indicated in the METAR string:
+
+I.e. on 11th April 2016:
 
 ```ruby
-spanish = Metar::Station.find_all_by_country('Spain')
+metar_string = "KHWD 280554Z AUTO 29007KT 10SM OVC008 14/12 A3002 RMK AO2 SLP176 T01390117 10211\n"
+raw    = Metar::Raw::Metar.new(metar_string)
+raw.time.to_s                              # => "2016-03-28"
+parser = Metar::Parser.new(raw)
 ```
 
-Get The Data
-------------
+## Access Specific Data
+
 ```ruby
 station = Metar::Station.find_by_cccc('KPDX')
 parser  = station.parser
 puts parser.temperature.value
 ```
 
-Use Your Own Raw Data
----------------------
+# Countries
+
+List countries:
+
 ```ruby
-metar_string = "KHWD 280554Z AUTO 29007KT 10SM OVC008 14/12 A3002 RMK AO2 SLP176 T01390117 10211\n"
-raw    = Metar::Raw::Data.new(metar_string)
-parser = Metar::Parser.new(raw)
+puts Metar::Station.countries
 ```
 
-Translations
-------------
+Find a country's weather stations:
+
+```ruby
+spanish = Metar::Station.find_all_by_country('Spain')
+```
+
+# Translations
+
 Translations are available for the following languages (and region):
 * :de
 * :en
@@ -84,8 +100,7 @@ I18n.locale = :'en-US'
 I18n.t('metar.station_code.title') # station code
 ```
 
-Compliance
-==========
+# Compliance
 
 By default, the parser runs in 'loose' compliance mode. That means that it tries to
 accept non-standard input.

data/Rakefile

@@ -8,14 +8,3 @@ task :default => :spec
 RSpec::Core::RakeTask.new do | t |
   t.pattern = 'spec/**/*_spec.rb'
 end
-
-if RUBY_VERSION < '1.9'
-
-  RSpec::Core::RakeTask.new( 'spec:rcov' ) do |t|
-    t.pattern   = 'spec/**/*_spec.rb'
-    t.rcov      = true
-    t.rcov_opts = [ '--exclude', 'spec/,/gems/' ]
-  end
-
-end
-

data/bin/parse_raw.rb

@@ -6,7 +6,6 @@ Use the data downloaded by 'download_raw.rb' to bulk test the Report
 
 =end
 
-require 'rubygems' if RUBY_VERSION < '1.9'
 require 'yaml'
 require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'metar')
 

data/lib/metar/raw.rb

@@ -1,26 +1,70 @@
+require 'date'
 require 'net/ftp'
 require 'time'
 
 module Metar
-
   module Raw
-
     class Base
-      attr_reader :cccc
       attr_reader :metar
       attr_reader :time
       alias :to_s :metar
-
-      def parse
-        @cccc = @metar[/\w+/]
-      end
     end
 
+    ##
+    # Use this class when you have a METAR string and the date of reading
     class Data < Base
-      def initialize(metar, time = Time.now)
+      def initialize(metar, time = nil)
+        if time == nil
+          warn <<-EOT
+          Using Metar::Raw::Data without a time parameter is deprecated.
+          Please supply the reading time as the second parameter.
+          EOT
+          time = Time.now
+        end
         @metar, @time = metar, time
+      end
+    end
 
-        parse
+    ##
+    # Use this class when you only have a METAR string.
+    # The date of the reading is decided as follows:
+    # * the day of the month is extracted from the METAR,
+    # * the most recent day with that day of the month is taken as the
+    #   date of the reading.
+    class Metar < Base
+      def initialize(metar)
+        @metar = metar
+        @time = nil
+      end
+
+      def time
+        return @time if @time
+        dom = day_of_month
+        date = Date.today
+        loop do
+          if date.day >= dom
+            @time = Date.new(date.year, date.month, dom)
+            break
+          end
+          # skip to the last day of the previous month
+          date = Date.new(date.year, date.month, 1).prev_day
+        end
+        @time
+      end
+
+      private
+
+      def datetime
+        datetime = metar[/^\w{4} (\d{6})Z/, 1]
+        raise "The METAR string must have a 6 digit datetime" if datetime.nil?
+        datetime
+      end
+
+      def day_of_month
+        dom = datetime[0..1].to_i
+        raise "Day of month must be at most 31" if dom > 31
+        raise "Day of month must be greater than 0" if dom == 0
+        dom
       end
     end
 
@@ -44,9 +88,9 @@ module Metar
         end
 
         def disconnect
-          return if @connection.nil
-          @connection.close
-          @cconnection = nil
+          return if @@connection.nil
+          @@connection.close
+          @@connection = nil
         end
 
         def fetch(cccc)
@@ -101,13 +145,8 @@ module Metar
 
       def parse
         raw_time, @metar = @data.split("\n")
-        @time            = Time.parse(raw_time)
-        super
+        @time            = Time.parse(raw_time + " UTC")
       end
-
     end
-
   end
-
 end
-

data/lib/metar/version.rb

@@ -1,8 +1,8 @@
 module Metar
   module VERSION #:nodoc:
     MAJOR = 1
-    MINOR = 1
-    TINY  = 8
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'rspec'
-require 'rspec/autorun'
 
 if RUBY_VERSION > '1.9'
   require 'simplecov'

data/spec/unit/distance_spec.rb

@@ -1,86 +1,76 @@
 # encoding: utf-8
-load File.expand_path( '../spec_helper.rb', File.dirname(__FILE__) )
+require "spec_helper"
 
 describe Metar::Distance do
+  let(:value) { 12345.6789 }
 
-  context '#value' do
-
-    it 'should treat the parameter as meters' do
-      @distance = Metar::Distance.new( 12345.67 )
+  subject { described_class.new(value) }
 
-      @distance.units.            should     == :meters
-      @distance.value.            should     == 12345.67
+  context '#value' do
+    it 'treats the parameter as meters' do
+      expect(subject.units).to eq(:meters)
+      expect(subject.value).to eq(12345.6789)
     end
-
   end
 
   context '#to_s' do
-
     it 'should default to meters' do
-      @distance = Metar::Distance.new( rand * 1000.0 )
-
-      @distance.to_s.             should     =~ %r(^\d+m)
+      expect(subject.to_s).to match(%r(^\d+m))
     end
 
-    it 'should round down to the nearest meter' do
-      @distance = Metar::Distance.new( 12.345 )
+    context 'when <= 0.5' do
+      let(:value) { 12.345678 }
 
-      @distance.to_s.             should     == '12m'
+      it 'should round down to the nearest meter' do
+        expect(subject.to_s).to eq('12m')
+      end
     end
 
-    it 'should round up to meters' do
-      @distance = Metar::Distance.new( 8.750 )
+    context 'when > 0.5' do
+      let(:value) { 8.750 }
 
-      @distance.to_s.             should     == '9m'
+      it 'should round up to meters' do
+        expect(subject.to_s).to eq('9m')
+      end
     end
 
-    it 'should allow units overrides' do
-      @distance = Metar::Distance.new( 12345.67 )
-
-      @distance.to_s( :units => :kilometers ).
-                                  should     == '12km'
+    it 'allows units overrides' do
+      expect(subject.to_s(units: :kilometers)).to eq('12km')
     end
 
-    it 'should allow precision overrides' do
-      @distance = Metar::Distance.new( 12.34567 )
-
-      @distance.to_s( :precision => 1 ).
-                                  should     == '12.3m'
+    it 'allows precision overrides' do
+      expect(subject.to_s(precision: 1)).to eq('12345.7m')
     end
 
-    it 'should handle nil' do
-      @distance = Metar::Distance.new( nil )
+    context 'when value is nil' do
+      let(:value) { nil }
 
-      @distance.to_s.             should     == 'unknown'
+      it 'is unknown' do
+        expect(subject.to_s).to eq('unknown')
+      end
     end
 
     context 'translated' do
-
-      before :each do
+      before do
         @locale     = I18n.locale
         I18n.locale = :it
       end
 
-      after :each do
+      after do
         I18n.locale = @locale
       end
 
-      it 'should allow precision overrides' do
-        @distance = Metar::Distance.new( 12.34567 )
-
-        @distance.to_s( :precision => 1 ).
-                                    should     == '12,3m'
+      it 'localizes the decimal separator' do
+        expect(subject.to_s(precision: 1)).to eq('12345,7m')
       end
 
-      it 'should handle nil' do
-        @distance = Metar::Distance.new( nil )
+      context 'when value is nil' do
+        let(:value) { nil }
 
-        @distance.to_s.           should     == 'sconosciuto'
+        it 'translates' do
+          expect(subject.to_s).to eq('sconosciuto')
+        end
       end
-
     end
-
   end
-
 end
-

data/spec/unit/parser_spec.rb

@@ -1,19 +1,25 @@
 # encoding: utf-8
 require 'spec_helper'
 
+require 'timecop'
+
 describe Metar::Parser do
   after do
     Metar::Parser.compliance = :loose
   end
 
   context '.for_cccc' do
-    it 'returns a loaded parser' do
-      station = stub('station')
-      raw = stub('raw', :metar => "XXXX 061610Z 24006KT 1 3/4SM -SN BKN016 OVC030 M17/M20 A2910 RMK AO2 P0000",
-                         :time  => '2010/02/06 16:10')
-      Metar::Station.stub!(:new => station)
-      Metar::Raw::Noaa.stub!(:new => raw)
+    let(:station) { double(Metar::Station) }
+    let(:raw) { double(Metar::Raw::Noaa, metar: metar, time: time) }
+    let(:metar) { "XXXX 061610Z 24006KT 1 3/4SM -SN BKN016 OVC030 M17/M20 A2910 RMK AO2 P0000" }
+    let(:time) { '2010/02/06 16:10' }
 
+    before do
+      allow(Metar::Station).to receive(:new) { station }
+      allow(Metar::Raw::Noaa).to receive(:new) { raw }
+    end
+
+    it 'returns a loaded parser' do
       parser = Metar::Parser.for_cccc('XXXX')
 
       expect(parser).to be_a(Metar::Parser)
@@ -22,10 +28,10 @@ describe Metar::Parser do
   end
 
   context 'attributes' do
-    before do
-      @call_time = Time.parse('2011-05-06 16:35')
-      Time.stub!(:now).and_return(@call_time)
-    end
+    let(:call_time) { Time.parse('2011-05-06 16:35') }
+
+    before { Timecop.freeze(call_time) }
+    after { Timecop.return }
 
     it '.location missing' do
       expect do
@@ -46,6 +52,21 @@ describe Metar::Parser do
         end.to raise_error(Metar::ParseError, /Expecting datetime/)
       end
 
+      context 'across a month rollover' do
+        let(:time)  { Time.gm(2016, 3, 31, 23, 59) }
+        let(:metar) { "OPPS 312359Z 23006KT 4000 HZ SCT040 SCT100 17/12 Q1011" }
+        let(:raw) { double(Metar::Raw, metar: metar, time: time) }
+        let(:call_time) { Time.parse("2016/04/01 00:02:11 PDT") }
+
+        subject { described_class.new(raw) }
+
+        it 'has the correct date' 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 'in strict mode' do
         before do
           Metar::Parser.compliance = :strict
@@ -295,7 +316,7 @@ describe Metar::Parser do
     end
   
     def setup_parser(metar)
-      raw = Metar::Raw::Data.new(metar)
+      raw = Metar::Raw::Data.new(metar, Time.now)
       Metar::Parser.new(raw)
     end
   end