gribr 0.2.0 → 0.3.0

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "gribr"
-    gem.summary = %Q{Ruby wrapper to read gridded binary (GRIB) files with degrib.}
-    gem.description = %Q{Ruby wrapper to read gridded binary (GRIB) files with degrib.}
+    gem.summary = %Q{Read gridded binary (GRIB) files with ruby.}
+    gem.description = %Q{Ruby wrapper to read gridded binary (GRIB) files using degrib.}
     gem.email = "roman.scherer@burningswell.com"
     gem.homepage = "http://github.com/r0man/gribr"
     gem.authors = ["Roman Scherer"]

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/probe-wukong

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'gribr'
+require 'gribr/degrib/probe_mapper'
+require 'gribr/degrib/probe_reducer'
+Wukong::Script.new(Gribr::Degrib::ProbeMapper, Gribr::Degrib::ProbeReducer).run
+

data/lib/gribr/degrib.rb

@@ -1,10 +1,11 @@
-require 'gribr/executeable'
 require 'gribr/degrib/cube'
 require 'gribr/degrib/file'
 require 'gribr/degrib/index'
 require 'gribr/degrib/inventory'
 require 'gribr/degrib/inventory_record'
+require 'gribr/degrib/message'
 require 'gribr/degrib/probe_record'
+require 'gribr/executeable'
 
 module Gribr
 

data/lib/gribr/degrib/file.rb

@@ -35,7 +35,13 @@ module Gribr
         @inventory ||= Inventory.file(self)
       end
 
-      # Probe the grib file at the given location and return/yield the records.
+      # Returns the messages in the grib file.
+      def messages
+        @messages || inventory.records.map { |record| Message.new(self, record) }
+      end
+
+      # Probe the grib file at the given location and return/yield the
+      # records.
       def probe(latitude, longitude, options = { }, &block)
         probe_one(latitude, longitude, options, &block)
       end
@@ -69,7 +75,7 @@ module Gribr
       end
 
       def validate!
-        raise "Sorry, not a grib file: #{path}" unless self.class.gribfile?(self); ensure; rewind
+        raise "Sorry, not a grib file: #{path}" unless ::File.gribfile?(self); ensure; rewind
       end
 
     end

data/lib/gribr/degrib/inventory_record.rb

@@ -13,30 +13,66 @@ module Gribr
       REGEXP_LEVEL     = Regexp.new('([^,]+)').freeze
       REGEXP_TIMESTAMP = Regexp.new('((\d{2})/(\d{2})/(\d{4})\s+(\d{2}):(\d{2}))').freeze
 
+      TIME_FORMAT = "%m/%d/%Y %H:%M".freeze
+
       def end_position_of_previous
         start_position - 1 if number > 1
       end
 
-      def self.build(match_data)
-
-        if match_data
-          record = new
-          record.number = match_data[1].to_i
-          record.start_position = match_data[3].to_i
-          record.version = match_data[4].to_i
-          record.element = match_data[6]
-          record.description = match_data[7]
-          record.unit = match_data[8]
-          record.level = match_data[9]
-          record.reference_time = Time.utc(match_data[13].to_i, match_data[11].to_i, match_data[12].to_i, match_data[14].to_i, match_data[15].to_i)
-          record.valid_time = Time.utc(match_data[19].to_i, match_data[17].to_i, match_data[18].to_i, match_data[20].to_i, match_data[21].to_i)
-          record
-        end
+      def to_s
+        [ formatted_number, start_position, version, formatted_element, level, formatted_reference_time, formatted_valid_time, formatted_projection ].join(", ")
+      end
+
+      protected
+
+      def formatted_element
+        "#{element}=\"#{description}\""
+      end
 
+      def formatted_number
+        sprintf("%.1f", number)
       end
 
-      def self.regexp
-        @regexp ||= Regexp.new([REGEXP_FLOAT, REGEXP_INTEGER, REGEXP_INTEGER, REGEXP_ELEMENT, REGEXP_LEVEL, REGEXP_TIMESTAMP, REGEXP_TIMESTAMP].join('\s*,\s*')).freeze
+      def formatted_time(time)
+        time.strftime(TIME_FORMAT)
+      end
+
+      def formatted_projection
+        sprintf("%.2f", (valid_time - reference_time) / 60 / 60)
+      end
+
+      def formatted_reference_time
+        formatted_time(reference_time)
+      end
+
+      def formatted_valid_time
+        formatted_time(valid_time)
+      end
+
+      class << self
+
+        def build(match_data)
+
+          if match_data
+            record = new
+            record.number = match_data[1].to_i
+            record.start_position = match_data[3].to_i
+            record.version = match_data[4].to_i
+            record.element = match_data[6]
+            record.description = match_data[7]
+            record.unit = match_data[8]
+            record.level = match_data[9]
+            record.reference_time = Time.utc(match_data[13].to_i, match_data[11].to_i, match_data[12].to_i, match_data[14].to_i, match_data[15].to_i)
+            record.valid_time = Time.utc(match_data[19].to_i, match_data[17].to_i, match_data[18].to_i, match_data[20].to_i, match_data[21].to_i)
+            record
+          end
+
+        end
+
+        def regexp
+          @regexp ||= Regexp.new([REGEXP_FLOAT, REGEXP_INTEGER, REGEXP_INTEGER, REGEXP_ELEMENT, REGEXP_LEVEL, REGEXP_TIMESTAMP, REGEXP_TIMESTAMP].join('\s*,\s*')).freeze
+        end
+
       end
 
     end

data/lib/gribr/degrib/message.rb

@@ -0,0 +1,34 @@
+module Gribr
+  module Degrib
+
+    class Message
+
+      attr_reader :file, :inventory_record
+
+      def initialize(file, inventory_record)
+        @file, @inventory_record = file, inventory_record
+      end
+
+      # Probe the grib message at the given location and return/yield
+      # the records.
+      def probe(latitude, longitude, options = { }, &block)
+
+        records = Array.new
+
+        file.probe(latitude, longitude, options) do |record|
+
+#          if record.element.downcase == inventory_record.element.downcase
+            yield(record) if block_given?
+            records << record
+#          end
+
+        end
+
+        records
+
+      end
+
+    end
+
+  end
+end

data/lib/gribr/inventory.rb

@@ -1,31 +1,38 @@
+require 'open-uri'
+
 module Gribr
 
   class Inventory
 
-    def initialize(messages = Array.new)
-      @messages = Hash.new
-      messages.each { |message| add_message(message) }
+    def initialize(records = Array.new)
+      @records = Hash.new
+      records.each { |record| add_record(record) }
+    end
+
+    def add_record(record)
+      set_end_position_of_previous(record)
+      @records[record.number] = record
+      record
     end
 
-    def add_message(message)
-      set_end_position_of_previous(message)
-      @messages[message.number] = message
+    def records
+      @records.values.sort_by(&:number)
     end
 
-    def messages
-      @messages.values.sort_by(&:number)
+    def to_s
+      records.join("\n")
     end
 
     protected
 
-    def set_end_position_of_previous(message)
-      @messages[message.number - 1].end_position = message.end_position_of_previous if @messages[message.number - 1]
+    def set_end_position_of_previous(record)
+      @records[record.number - 1].end_position = record.end_position_of_previous if @records[record.number - 1]
     end
 
     class << self
 
       def file(file)
-        Gribr::Degrib::File.gribfile?(file) ? grib_file(file) : inventory_file(file)
+        ::File.gribfile?(file) ? grib_file(file) : inventory_file(file)
       end
 
       def io(io)
@@ -35,9 +42,9 @@ module Gribr
         io.each_with_index do |line, index|
 
           if index > 0
-            message = parse_record(line)
-            inventory.add_message(message)
-            yield(message) if block_given?
+            record = parse_record(line)
+            inventory.add_record(record)
+            yield(record) if block_given?
           end
 
         end
@@ -46,6 +53,10 @@ module Gribr
 
       end
 
+      def url(url)
+        open(url) { |io| io(io) }
+      end
+
       protected
 
       def grib_file(file)

data/lib/gribr/wgrib/inventory_record.rb

@@ -3,7 +3,7 @@ require 'gribr/utils'
 module Gribr
   module Wgrib
 
-    class InventoryRecord < Struct.new(:element, :end_position, :number, :start_position, :reference_time, :valid_time)
+    class InventoryRecord < Struct.new(:average, :element, :end_position, :level, :number, :start_position, :projection, :reference_time, :valid_time)
 
       include Gribr::RegexpParser
 
@@ -16,6 +16,17 @@ module Gribr
     class ShortInventoryRecord < InventoryRecord
 
       REGEX_TIMESTAMP = Regexp.new("(d=(\\d{2,4})(\\d{2})(\\d{2})(\\d{2}))").freeze
+      TIME_FORMAT = "%Y%m%d%H".freeze
+
+      def to_s
+        [number, start_position, formatted_reference_time, element, level, projection, average].join(":")
+      end
+
+      protected
+
+      def formatted_reference_time
+        "d=" + reference_time.strftime(TIME_FORMAT)
+      end
 
       def self.build(match_data)
 
@@ -25,13 +36,16 @@ module Gribr
           record.number = match_data[1].to_i
           record.start_position = match_data[2].to_i
           record.element = match_data[8]
+          record.level = match_data[9]
 
           year = (match_data[4].size == 4 ? match_data[4] : Time.now.utc.year.to_s.gsub(/\d{2}$/, match_data[4])).to_i
-          record.valid_time = Time.utc(year, match_data[5].to_i, match_data[6].to_i, match_data[7].to_i)
+          record.reference_time = Time.utc(year, match_data[5].to_i, match_data[6].to_i, match_data[7].to_i)
 
-          # Calculte reference time
           offset = match_data[10].split.first.to_i * 60 * 60
-          record.reference_time = record.valid_time + offset
+          record.valid_time = record.reference_time + offset
+
+          record.projection = match_data[10]
+          record.average = match_data[11]
 
           record
 

data/spec/lib/gribr/degrib/file_spec.rb

@@ -50,6 +50,14 @@ module Gribr::Degrib
       @file.inventory.should be_kind_of(Inventory)
     end
 
+    it "should return the messages as an array" do
+      @file.messages.should be_kind_of(Array)
+    end
+
+    it "should return the messages as an array of Gribr::Degrib::Message objects" do
+      @file.messages.each { |message| message.should be_kind_of(Message) }
+    end
+
     it "should probe at the given position and return the records in an array" do
       @file.probe(@latitude, @longitude).should be_kind_of(Array)
     end
@@ -61,9 +69,12 @@ module Gribr::Degrib
     it "should probe at the given position and yield the records" do
       @file.index!
       @file.probe(@latitude, @longitude) { |record| record.should be_kind_of(ProbeRecord) }
-      #     @file.probe(@latitude, @longitude) { |record| puts record }
     end
 
+    # it "should probe at the given position and yield the records" do
+    #   @file.probe(@latitude, @longitude) { |record| puts record }
+    # end
+
   end
 
 end

data/spec/lib/gribr/degrib/inventory_record_spec.rb

@@ -113,6 +113,10 @@ module Gribr::Degrib
         @record.valid_time.should == Time.utc(2009, 9, 18, 0)
       end
 
+      it "should have the same string representation as the raw record" do
+        @record.to_s.should == @raw
+      end
+
     end
 
   end

data/spec/lib/gribr/degrib/inventory_spec.rb

@@ -7,11 +7,18 @@ module Gribr::Degrib
   describe "A degrib inventory" do
 
     before(:each) do
-      @inventory = Inventory.file(File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib'))
+      @gribfilename = File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+      @inventory = Inventory.file(@gribfilename)
     end
 
     it_should_behave_like "An inventory"
 
+    it "should return the string representation" do
+      expected = (`degrib #{@gribfilename} -I`).split("\n")
+      expected = expected[1..(expected.size - 1)].join("\n")
+      @inventory.to_s.should == expected
+    end
+
   end
 
   describe Inventory do
@@ -34,7 +41,7 @@ module Gribr::Degrib
         Inventory.file(clazz.new(@gribfile)).should be_kind_of(Inventory)
       end
 
-      it "should parse the inventory from the content of the given file" do
+      it "should parse the inventory from the given inventory file" do
         Tempfile.open("inventory") do |tempfile|
           system("degrib #{@gribfile} -I > #{tempfile.path}")
           Inventory.file(clazz.new(tempfile.path)).should be_kind_of(Inventory)

data/spec/lib/gribr/degrib/message_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe Message do
+
+    before(:each) do
+      @latitude, @longitude = 0, 0
+      @filename = File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+      @message = Gribr::Degrib::File.new(@filename).messages.first
+    end
+
+    it "should be kind of Gribr::Degrib::Message" do
+      @message.should be_kind_of(Message)
+    end
+
+    it "should probe the records at the given position and return them in an array" do
+      @message.probe(@latitude, @longitude).should be_kind_of(Array)
+    end
+
+    it "should probe the records at the given position and yield them to the given block" do
+      @message.probe(@latitude, @longitude) { |record| record.should be_kind_of(ProbeRecord) }
+    end
+
+    # it "should probe at the given position and yield the records" do
+    #   @message.probe(@latitude, @longitude) { |record| puts record }
+    # end
+
+  end
+
+end

data/spec/lib/gribr/inventory_spec.rb

@@ -8,12 +8,16 @@ module Gribr
       @inventory.should be_kind_of(Inventory)
     end
 
-    it "should return the messages as an array" do
-      @inventory.messages.should be_kind_of(Array)
+    it "should return the records as an array" do
+      @inventory.records.should be_kind_of(Array)
     end
 
-    it "should return the messages sorted by number" do
-      @inventory.messages.each_cons(2) { |cons| cons.first.number.should < cons.last.number }
+    it "should return the records sorted by number" do
+      @inventory.records.each_cons(2) { |cons| cons.first.number.should < cons.last.number }
+    end
+
+    it "should calculate the end position for each record" do
+      @inventory.records.each_cons(2) { |cons| cons.first.end_position.should == cons.last.start_position - 1 }
     end
 
   end

data/spec/lib/gribr/wgrib/inventory_record_spec.rb

@@ -26,12 +26,24 @@ module Gribr::Wgrib
         @record.element.should == 'DIRSW'
       end
 
-      it 'should assign the valid time' do
-        @record.valid_time.should == Time.utc(2009, 11, 4, 0)
+      it 'should assign the level' do
+        @record.level.should == 'sfc'
+      end
+
+      it 'should assign the projection' do
+        @record.projection.should == '3hr fcst'
+      end
+
+      it 'should assign the average value' do
+        @record.average.should == 'NAve=0'
       end
 
       it 'should assign the reference time' do
-        @record.reference_time.should == @record.valid_time + (3 * 60 * 60)
+        @record.reference_time.should == Time.utc(2009, 11, 4, 0)
+      end
+
+      it 'should assign the valid time' do
+        @record.valid_time.should == @record.reference_time + (3 * 60 * 60)
       end
 
     end
@@ -54,6 +66,10 @@ module Gribr::Wgrib
 
       it_should_behave_like "Parsing a short wgrib record"
 
+      it "should return the wgrib string representation" do
+        @record.to_s.should == "22:1057378:d=2009110400:DIRSW:sfc:3hr fcst:NAve=0"
+      end
+
     end
 
   end

data/spec/lib/gribr/wgrib/inventory_spec.rb

@@ -12,6 +12,12 @@ module Gribr::Wgrib
 
     it_should_behave_like "An inventory"
 
+    it "should create an inventory from an url" do
+      url = "http://nomad5.ncep.noaa.gov/pub/waves/nww3/nww320091104/nww3.t00z.grib.inv"
+      Inventory.should_receive(:open).with(url).and_yield(StringIO.new(""))
+      Inventory.url(url).should be_kind_of(Inventory)
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gribr
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Roman Scherer
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 +01:00
-default_executable: 
+date: 2009-11-12 00:00:00 +01:00
+default_executable: probe-wukong
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -32,10 +32,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Ruby wrapper to read gridded binary (GRIB) files with degrib.
+description: Ruby wrapper to read gridded binary (GRIB) files using degrib.
 email: roman.scherer@burningswell.com
-executables: []
-
+executables: 
+- probe-wukong
 extensions: []
 
 extra_rdoc_files: 
@@ -58,6 +58,7 @@ files:
 - lib/gribr/degrib/index.rb
 - lib/gribr/degrib/inventory.rb
 - lib/gribr/degrib/inventory_record.rb
+- lib/gribr/degrib/message.rb
 - lib/gribr/degrib/probe_record.rb
 - lib/gribr/executeable.rb
 - lib/gribr/inventory.rb
@@ -73,6 +74,7 @@ files:
 - spec/lib/gribr/degrib/index_spec.rb
 - spec/lib/gribr/degrib/inventory_record_spec.rb
 - spec/lib/gribr/degrib/inventory_spec.rb
+- spec/lib/gribr/degrib/message_spec.rb
 - spec/lib/gribr/degrib/probe_record_spec.rb
 - spec/lib/gribr/degrib_spec.rb
 - spec/lib/gribr/executeable_spec.rb
@@ -108,12 +110,13 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Ruby wrapper to read gridded binary (GRIB) files with degrib.
+summary: Read gridded binary (GRIB) files with ruby.
 test_files: 
 - spec/gribr_spec.rb
 - spec/lib/gribr/degrib/index_spec.rb
 - spec/lib/gribr/degrib/cube_spec.rb
 - spec/lib/gribr/degrib/probe_record_spec.rb
+- spec/lib/gribr/degrib/message_spec.rb
 - spec/lib/gribr/degrib/inventory_spec.rb
 - spec/lib/gribr/degrib/inventory_record_spec.rb
 - spec/lib/gribr/degrib/file_spec.rb