gribr 0.2.0

data/lib/gribr/wgrib/inventory_record.rb

@@ -0,0 +1,51 @@
+require 'gribr/utils'
+
+module Gribr
+  module Wgrib
+
+    class InventoryRecord < Struct.new(:element, :end_position, :number, :start_position, :reference_time, :valid_time)
+
+      include Gribr::RegexpParser
+
+      def end_position_of_previous
+        start_position - 1 if number > 1
+      end
+
+    end
+
+    class ShortInventoryRecord < InventoryRecord
+
+      REGEX_TIMESTAMP = Regexp.new("(d=(\\d{2,4})(\\d{2})(\\d{2})(\\d{2}))").freeze
+
+      def self.build(match_data)
+
+        if match_data
+
+          record = new
+          record.number = match_data[1].to_i
+          record.start_position = match_data[2].to_i
+          record.element = match_data[8]
+
+          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)
+
+          # Calculte reference time
+          offset = match_data[10].split.first.to_i * 60 * 60
+          record.reference_time = record.valid_time + offset
+
+          record
+
+        end
+
+      end
+
+      def self.regexp
+        @regexp ||= Regexp.new("(\\d+):(\\d+):#{REGEX_TIMESTAMP}:(.+):(.+):(.+):(.+)").freeze
+      end
+
+    end
+
+  end
+
+end
+

data/lib/gribr/wgrib.rb

@@ -0,0 +1,15 @@
+require 'gribr/wgrib/inventory'
+require 'gribr/wgrib/inventory_record'
+
+module Gribr
+
+  module Wgrib
+
+    def self.executeable
+      @executeable ||= Executable.new("wgrib")
+    end
+
+  end
+
+end
+

data/lib/gribr.rb

@@ -0,0 +1,6 @@
+require 'gribr/core_ext'
+require 'gribr/degrib'
+require 'gribr/executeable'
+require 'gribr/inventory'
+require 'gribr/wgrib'
+require 'gribr/utils'

data/spec/gribr_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Gribr" do
+
+  it "should define the 'Gribr' module" do
+    Gribr.should be_kind_of(Module)
+  end
+
+end

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

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+require 'gribr/core_ext/file'
+
+module Gribr::CoreExt
+
+  describe File do
+
+    before(:each) do
+      @filename = ::File.expand_path(::File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+    end
+
+    it "should exist" do
+      ::File.exists?(@filename).should be_true
+    end
+
+    it "should return true if the given file is a gribfile" do
+      ::File.gribfile?(@filename).should be_true
+      ::File.gribfile?(::File.new(@filename)).should be_true
+    end
+
+    it "should return false if the given file is not a gribfile" do
+      ::File.gribfile?(::File.new(__FILE__)).should be_false
+      ::File.gribfile?(__FILE__).should be_false
+    end
+
+  end
+
+  describe "An existing file" do
+
+    before(:each) do
+      @file = ::File.new("test", "w")
+    end
+
+    it "should exists" do
+      @file.exist?
+    end
+
+    it "should delete the file" do
+      @file.delete
+    end
+
+    it "should unlink the file" do
+      @file.unlink
+    end
+
+  end
+
+end

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

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe Cube do
+
+    before(:each) do
+      @cube = File.new(File.dirname(__FILE__) + '/../../../fixtures/wind.grib').index.cube
+    end
+
+    it "should return the file extension name" do
+      Cube.extname.should == "dat"
+    end
+
+    it "should be kind of a ::File" do
+      @cube.should be_kind_of(::File)
+    end
+
+  end
+end

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

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe File do
+
+    before(:each) do
+      @latitude, @longitude = 0, 0
+      @filename = File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+      @file = Gribr::Degrib::File.new(@filename)
+    end
+
+    after(:each) do
+      FileUtils.rm_f(@file.indexname)
+    end
+
+    it "should be kind of ::File" do
+      @file.should be_kind_of(::File)
+    end
+
+    it "should exists" do
+      File.exists?(@file).should be_true
+    end
+
+    it "should return the indexname (unix path)" do
+      @file.stub!(:path).and_return("/tmp/wind.grib")
+      @file.indexname.should == "/tmp/wind.idx"
+    end
+
+    it "should return the indexname (end-of-line bug)" do
+      @file.stub!(:path).and_return("/home/roman/workspace/gribr/spec/fixtures/t12z.HTSGW.grib")
+      @file.indexname.should == "/home/roman/workspace/gribr/spec/fixtures/t12z.HTSGW.idx"
+    end
+
+    it "should return the indexname (windows path)" do
+      @file.stub!(:path).and_return('C:\tmp\wind.grib')
+      @file.indexname.should == 'C:\tmp\wind.idx'
+    end
+
+    it "should not be indexed" do
+      @file.should_not be_indexed
+    end
+
+    it "should build the index" do
+      @file.index!.should be_true
+      @file.should be_indexed
+    end
+
+    it "should return the inventory" do
+      @file.inventory.should be_kind_of(Inventory)
+    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
+
+    it "should probe at the given position and yield the records" do
+      @file.probe(@latitude, @longitude) { |record| record.should be_kind_of(ProbeRecord) }
+    end
+
+    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
+
+  end
+
+end

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

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe Index do
+
+    before(:each) do
+      @grib_filename = File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+    end
+
+    it "should return the file extension name" do
+      Index.extname.should == "idx"
+    end
+
+    [::File, Pathname, String].each do |clazz|
+
+      it "should return the index command for the file given as #{clazz}" do
+        Index.command(clazz.new(@grib_filename)).should == "#{Gribr::Degrib.executeable.name} #{@grib_filename} -Data -Index #{File.new(@grib_filename).indexname}"
+      end
+
+      it "should create the index command for the file given as #{clazz}" do
+        Index.create(clazz.new(@grib_filename)).should be_kind_of(Index)
+      end
+
+      it "should create the index command for the file given as #{clazz} with bang" do
+        Index.create!(clazz.new(@grib_filename)).should be_kind_of(Index)
+      end
+
+    end
+
+    describe "A degrib index" do
+
+      before(:each) do
+        @file = File.new(File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib'))
+        @file.index!
+        @index = @file.index
+      end
+
+      it "should be kind of a ::File" do
+        @file.should be_kind_of(::File)
+      end
+
+      it "should exist" do
+        ::File.exist?(@file).should be_true
+      end
+
+      it "should return the cubename (unix path)" do
+        @index.stub!(:path).and_return("/tmp/wind.grib")
+        @index.cubename.should == "/tmp/wind.dat"
+      end
+
+      it "should return the cubename (end-of-line bug)" do
+        @index.stub!(:path).and_return("/home/roman/workspace/gribr/spec/fixtures/t12z.HTSGW.grib")
+        @index.cubename.should == "/home/roman/workspace/gribr/spec/fixtures/t12z.HTSGW.dat"
+      end
+
+      it "should return the cubename (windows path)" do
+        @index.stub!(:path).and_return('C:\tmp\wind.grib')
+        @index.cubename.should == 'C:\tmp\wind.dat'
+      end
+
+      it "should return the cube file" do
+        @index.cube.should be_kind_of(Cube)
+      end
+
+      it "should have an existing cube" do
+        ::File.exist?(@index.cubename).should be_true
+      end
+
+      it "should delete the index file" do
+        @index.delete
+        ::File.exist?(@index.path).should be_false
+      end
+
+      it "should delete the cube file with the index" do
+        @index.delete
+        ::File.exist?(@index.cubename).should be_false
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe InventoryRecord do
+
+    before(:each) do
+      @raw = '61.0, 3025800, 1, WIND="Wind speed [m/s]", 1-SFC, 09/10/2009 12:00, 09/18/2009 00:00, 180.00'
+    end
+
+    it "should parse degrib inventory record" do
+      InventoryRecord.parse(@raw).should be_kind_of(InventoryRecord)
+    end
+
+    it "should parse a degrib record (with bang)" do
+      InventoryRecord.parse!(@raw).should be_kind_of(InventoryRecord)
+    end
+
+    it "should return nil when parsing an invalid degrib inventory record" do
+      InventoryRecord.parse(@raw.reverse).should be_nil
+    end
+
+    it "should raise an ArgumentError when parsing an invalid degrib inventory record (with bang)" do
+      lambda { InventoryRecord.parse!(@raw.reverse) }.should raise_error(ArgumentError)
+    end
+
+    shared_examples_for "An inventory record" do
+
+      [:number, :start_position, :version].each do |attribute|
+
+        it "should have a Fixnum object as #{attribute} attribute" do
+          @record.send(attribute).should be_kind_of(Fixnum)
+        end
+
+      end
+
+      [ :description, :element, :unit, :level].each do |attribute|
+
+        it "should have a String object as #{attribute} attribute" do
+          @record.send(attribute).should be_kind_of(String)
+        end
+
+      end
+
+      [ :reference_time, :valid_time].each do |attribute|
+
+        it "should have a Time object as #{attribute} attribute" do
+          @record.send(attribute).should be_kind_of(Time)
+        end
+
+        it "should have a Time object in the UTC timezone as #{attribute} attribute" do
+          @record.send(attribute).zone.should == "UTC"
+        end
+
+      end
+
+    end
+
+    describe "Parsing a degrib inventory record" do
+
+      before(:each) do
+        @record = InventoryRecord.parse(@raw)
+      end
+
+      it_should_behave_like "An inventory record"
+
+      it "should assign the number" do
+        @record.number.should == 61
+      end
+
+      it "should assign the start position" do
+        @record.start_position.should == 3025800
+      end
+
+      it "should assign nil as end position" do
+        @record.end_position.should be_nil
+      end
+
+      it "should assign the end position of the previous record" do
+        @record.end_position_of_previous.should == 3025800 - 1
+      end
+
+      it "should not assign the end position of the previous record if first record" do
+        @record.number = 1
+        @record.end_position_of_previous.should be_nil
+      end
+
+      it "should assign the version" do
+        @record.version.should == 1
+      end
+
+      it "should assign the element" do
+        @record.element.should == "WIND"
+      end
+
+      it "should assign the description" do
+        @record.description.should == "Wind speed [m/s]"
+      end
+
+      it "should assign the unit" do
+        @record.unit.should == "m/s"
+      end
+
+      it "should assign the level" do
+        @record.level.should == "1-SFC"
+      end
+
+      it "should assign the reference time" do
+        @record.reference_time.should == Time.utc(2009, 9, 10, 12)
+      end
+
+      it "should assign the valid time" do
+        @record.valid_time.should == Time.utc(2009, 9, 18, 0)
+      end
+
+    end
+
+  end
+
+end
+

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

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../inventory_spec')
+require 'tempfile'
+
+module Gribr::Degrib
+
+  describe "A degrib inventory" do
+
+    before(:each) do
+      @inventory = Inventory.file(File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib'))
+    end
+
+    it_should_behave_like "An inventory"
+
+  end
+
+  describe Inventory do
+
+    before(:each) do
+      @gribfile = File.expand_path(File.dirname(__FILE__) + '/../../../fixtures/wind.grib')
+    end
+
+    it "should return the inventory for the given io" do
+      IO.popen("degrib #{@gribfile} -I") { |io| Inventory.io(io).should be_kind_of(Inventory) }
+    end
+
+    [::File, Pathname, String].each do |clazz|
+
+      it "should return the inventory command for the file given as #{clazz}" do
+        Inventory.command(clazz.new(@gribfile)).should == "degrib #{@gribfile} -I"
+      end
+
+      it "should parse the inventory from the given grib file" do
+        Inventory.file(clazz.new(@gribfile)).should be_kind_of(Inventory)
+      end
+
+      it "should parse the inventory from the content of the given file" do
+        Tempfile.open("inventory") do |tempfile|
+          system("degrib #{@gribfile} -I > #{tempfile.path}")
+          Inventory.file(clazz.new(tempfile.path)).should be_kind_of(Inventory)
+        end
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Gribr::Degrib
+
+  describe ProbeRecord do
+
+    before(:each) do
+      @raw = "(43.421000,-2.684000), WIND[m/s], 200808041200, 200808041800, 1234.567"
+    end
+
+    it "should parse a valid a degrib record" do
+      ProbeRecord.parse(@raw).should be_kind_of(ProbeRecord)
+    end
+
+    it "should parse an invalid degrib record and return nil" do
+      ProbeRecord.parse(@raw.reverse).should be_nil
+    end
+
+    it "should parse a valid a degrib record (with bang)" do
+      ProbeRecord.parse!(@raw).should be_kind_of(ProbeRecord)
+    end
+
+    it "should parse an invalid degrib record and raise an ArgumentError" do
+      lambda { ProbeRecord.parse!(@raw.reverse) }.should raise_error(ArgumentError)
+    end
+
+    shared_examples_for "A degrib record" do
+
+      it "should have a latitude" do
+        @record.latitude.should be_kind_of(Float)
+      end
+
+      it "should have a longitude" do
+        @record.longitude.should be_kind_of(Float)
+      end
+
+      it "should have a element" do
+        @record.element.should be_kind_of(String)
+      end
+
+      it "should have a unit" do
+        @record.unit.should be_kind_of(String)
+      end
+
+      it "should have a reference time" do
+        @record.reference_time.should be_kind_of(::Time)
+      end
+
+      it "should have a valid time" do
+        @record.valid_time.should be_kind_of(::Time)
+      end
+
+      it "should have a value" do
+        @record.value.should be_kind_of(Float)
+      end
+
+    end
+
+    describe "A parsed degrib record representing wind speed" do
+
+      before(:each) do
+        @record = ProbeRecord.parse(@raw)
+      end
+
+      it_should_behave_like "A degrib record"
+
+      it "should have the expected latitude" do
+        @record.latitude.should == 43.421000
+      end
+
+      it "should have the expected longitude" do
+        @record.longitude.should == -2.684000
+      end
+
+      it "should have the expected element" do
+        @record.element.should == "WIND"
+      end
+
+      it "should have the expected unit" do
+        @record.unit.should == "m/s"
+      end
+
+      it "should have the expected reference time" do
+        @record.reference_time.should == ::Time.utc(2008, 8, 4, 12, 0)
+      end
+
+      it "should have the expected valid time" do
+        @record.valid_time.should == ::Time.utc(2008, 8, 4, 18, 0)
+      end
+
+      it "should have the expected value" do
+        @record.value.should == 1234.567
+      end
+
+      it "should return the expected string represantation" do
+        @record.to_s.should == "43.421\t-2.684\tWIND\tm/s\t2008-08-04 12:00:00\t2008-08-04 18:00:00\t1234.567"
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/gribr/degrib_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module Gribr
+
+  describe Degrib do
+
+    it "should return executeable" do
+      Degrib.executeable.should be_kind_of(Executable)
+    end
+
+    it "should return the wgrib executeable" do
+      Degrib.executeable.name.should == "degrib"
+    end
+
+  end
+
+end

data/spec/lib/gribr/executeable_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module Gribr
+
+  describe "The 'ls' executable" do
+
+    before(:each) do
+      @executable = Executable.new("ls")
+    end
+
+    it "should return the name" do
+      @executable.name.should == "ls"
+    end
+
+    it "should return the full path" do
+      @executable.path.should == "/bin/ls"
+    end
+
+    it "should exist" do
+      @executable.should be_exist
+    end
+
+  end
+
+end

data/spec/lib/gribr/inventory_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module Gribr
+
+  shared_examples_for "An inventory" do
+
+    it "should be an inventory" do
+      @inventory.should be_kind_of(Inventory)
+    end
+
+    it "should return the messages as an array" do
+      @inventory.messages.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 }
+    end
+
+  end
+
+end