gribr 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,11 @@
+*~
+*.sw?
+.DS_Store
+coverage
+doc
+ext
+rdoc
+pkg
+/.yardoc
+/spec/fixtures/wind.dat
+/WIND_09101200.txt

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Roman Scherer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,42 @@
+= Gribr - Read gridded binary (GRIB) files with Ruby.
+
+Gribr is a Ruby library for reading gridded binary (GRIB)
+files. Currently there is only a wrapper around the command line
+program "degrib" available. More to come. See the spec folder for
+examples ...
+
+  require 'gribr'
+  
+  file = Gribr::Degrib::File.new("spec/fixtures/t12z.HTSGW.grib")
+
+  # Probe a location and return the records as an array.
+  file.probe(43.121, 10.232) #=> Array
+
+  # Probe a location and yield the records.
+  file.probe(43.121, 10.232) do |record|
+    puts record
+  end
+
+  # Do we have an index?
+  file.indexed? #=> false
+
+  # Create the index. Probing a location is much faster with an index ...
+  file.index!
+  file.indexed? #=> true
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+
+* Commit, do not mess with rakefile, version, or history (if you want
+  to have your own version, that is fine but bump version in a commit
+  by itself I can ignore when I pull).
+
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Roman Scherer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "roman.scherer@burningswell.com"
+    gem.homepage = "http://github.com/r0man/gribr"
+    gem.authors = ["Roman Scherer"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+task :default => [:spec]
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/gribr.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gribr}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Scherer"]
+  s.date = %q{2009-11-02}
+  s.description = %q{Ruby wrapper to read gridded binary (GRIB) files with degrib.}
+  s.email = %q{roman.scherer@burningswell.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gribr.gemspec",
+     "lib/gribr.rb",
+     "lib/gribr/degrib.rb",
+     "lib/gribr/degrib/file.rb",
+     "lib/gribr/degrib/inventory_record.rb",
+     "lib/gribr/degrib/probe_record.rb",
+     "spec/fixtures/wind.grib",
+     "spec/gribr_spec.rb",
+     "spec/lib/gribr/degrib/file_spec.rb",
+     "spec/lib/gribr/degrib/inventory_record_spec.rb",
+     "spec/lib/gribr/degrib/probe_record_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/r0man/gribr}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Ruby wrapper to read gridded binary (GRIB) files with degrib.}
+  s.test_files = [
+    "spec/gribr_spec.rb",
+     "spec/lib/gribr/degrib/probe_record_spec.rb",
+     "spec/lib/gribr/degrib/inventory_spec.rb",
+     "spec/lib/gribr/degrib/inventory_record_spec.rb",
+     "spec/lib/gribr/degrib/file_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end

data/lib/gribr/core_ext/file.rb

@@ -0,0 +1,38 @@
+module Gribr
+  module CoreExt
+
+    module File
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :extend, ClassMethods
+      end
+
+      module InstanceMethods
+
+        def exist?
+          ::File.exist? path
+        end
+
+        def delete
+          ::File.delete path
+        end
+
+        alias_method :unlink, :delete
+
+      end
+
+      module ClassMethods
+
+        def gribfile?(path)
+          ::File.open(path.respond_to?(:path) ? path.path : path) { |file| file.read(4) == "GRIB" }
+        end
+
+      end
+
+    end
+
+  end
+end
+
+::File.send(:include, Gribr::CoreExt::File)

data/lib/gribr/core_ext.rb

@@ -0,0 +1 @@
+require 'gribr/core_ext/file'

data/lib/gribr/degrib/cube.rb

@@ -0,0 +1,15 @@
+module Gribr
+  module Degrib
+
+    class Cube < ::File
+
+      EXTNAME = "dat".freeze
+
+      def self.extname
+        EXTNAME
+      end
+
+    end
+
+  end
+end

data/lib/gribr/degrib/file.rb

@@ -0,0 +1,78 @@
+require 'gribr/degrib/index'
+require 'gribr/degrib/inventory'
+
+module Gribr
+  module Degrib
+
+    class File < ::File
+
+      def initialize(*params)
+        super; validate!
+      end
+
+      # Return the degrib index file.
+      def index
+        @index ||= (indexed? ? Index.new(indexname) : Index.create(self))
+      end
+
+      # Build the degrib index file.
+      def index!
+        @index = Index.create!(self)
+      end
+
+      # Return true if the degrib index file exists.
+      def indexed?
+        File.exists?(indexname)
+      end
+
+      # Returns the pathname of the degrib index file.
+      def indexname
+        path.gsub(Regexp.new("#{File.extname(path)}$"), ".#{Index::EXTNAME}")
+      end
+
+      # Returns the inventory of the file.
+      def inventory(options = {})
+        @inventory ||= Inventory.file(self)
+      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
+
+      protected
+
+      def probe_one(latitude, longitude, options = { }, &block)
+
+        records = Array.new
+        command = probe_one_command(latitude, longitude, options)
+
+        IO.popen(command).each_with_index do |line, index|
+          next if index == 0
+          record = ProbeRecord.parse!(line)
+          records << record
+          yield(record) if block_given?
+        end
+
+        records
+
+      end
+
+      def probe_one_command(latitude, longitude, options = { })
+        command = "#{Degrib.executeable.name}"
+        command << " #{indexed? ? indexname : path}"
+        command << " #{indexed? ? '-DP' : '-P'}"
+        command << " -pnt #{latitude},#{longitude}"
+        command << " -Unit m"
+        command << " -pntStyle 1"
+        command
+      end
+
+      def validate!
+        raise "Sorry, not a grib file: #{path}" unless self.class.gribfile?(self); ensure; rewind
+      end
+
+    end
+
+  end
+end

data/lib/gribr/degrib/index.rb

@@ -0,0 +1,51 @@
+require 'gribr/degrib/cube'
+
+module Gribr
+  module Degrib
+
+    class Index < ::File
+
+      EXTNAME = "idx".freeze
+
+      def delete
+        super
+        cube.delete if cube.exist?
+      end
+
+      # Returns the cube of the degrib index.
+      def cube
+        @cube ||= Cube.new(cubename)
+      end
+
+      # Returns the pathname of the degrib cube file.
+      def cubename
+        path.gsub(Regexp.new("#{File.extname(path)}$"), ".#{Cube.extname}")
+      end
+
+      class << self
+
+        def command(file)
+          file = File.new(file.respond_to?(:path) ? file.path : file) unless file.kind_of?(File)
+          "#{Degrib.executeable.name} #{file.path} -Data -Index #{file.indexname}"
+        end
+
+        def create(file)
+          gribfile = File.new(file.respond_to?(:path) ? file.path : file)
+          system(command(gribfile))
+          new(gribfile.indexname) if $? == 0
+        end
+
+        def create!(file)
+          create(file) || raise("Can't create degrib index for #{file}.")
+        end
+
+        def extname
+          EXTNAME
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/gribr/degrib/inventory.rb

@@ -0,0 +1,24 @@
+require 'gribr/inventory'
+require 'gribr/degrib/inventory_record'
+
+module Gribr
+  module Degrib
+
+    class Inventory < Gribr::Inventory
+
+      class << self
+
+        def command(file)
+          "degrib #{file.respond_to?(:path) ? file.path : file} -I"
+        end
+
+        def parse_record(line)
+          InventoryRecord.parse!(line)
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/gribr/degrib/inventory_record.rb

@@ -0,0 +1,44 @@
+require 'gribr/utils'
+
+module Gribr
+  module Degrib
+
+    class InventoryRecord < Struct.new(:description, :element, :end_position, :level, :number, :start_position, :unit, :reference_time, :valid_time, :version)
+
+      include Gribr::RegexpParser
+
+      REGEXP_ELEMENT   = Regexp.new('(([^=]+)="(.*\[(.+)\])")').freeze
+      REGEXP_FLOAT     = Regexp.new('((\+|-)?\d+.?\d*)').freeze
+      REGEXP_INTEGER   = Regexp.new('(\d+)').freeze
+      REGEXP_LEVEL     = Regexp.new('([^,]+)').freeze
+      REGEXP_TIMESTAMP = Regexp.new('((\d{2})/(\d{2})/(\d{4})\s+(\d{2}):(\d{2}))').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
+
+      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
+      end
+
+    end
+  end
+end

data/lib/gribr/degrib/probe_record.rb

@@ -0,0 +1,56 @@
+require 'gribr/utils'
+
+module Gribr
+  module Degrib
+
+    class ProbeRecord < Struct.new(:element, :latitude, :longitude, :reference_time, :unit, :valid_time, :value)
+
+      include RegexpParser
+
+      REGEXP_ELEMENT   = Regexp.new("(.*)").freeze
+      REGEXP_FLOAT     = Regexp.new("((\\+|-)?\\d+.?\\d*)").freeze
+      REGEXP_LOCATION  = Regexp.new("((#{REGEXP_FLOAT}),(#{REGEXP_FLOAT}))").freeze
+      REGEXP_TIMESTAMP = Regexp.new("(\\d{4})(\\d{2})(\\d{2})(\\d{2})(\\d{2})").freeze
+      REGEXP_UNIT      = Regexp.new("([^)]+)").freeze
+
+      SEPARATOR   = "\t".freeze
+      TIME_FORMAT = "%Y-%m-%d %H:%M:%S".freeze
+
+      def to_s(options = {})
+        [ latitude.to_s, longitude.to_s, element, unit, format_time(reference_time, options), format_time(valid_time, options), value.to_s ].join(SEPARATOR)
+      end
+
+      protected
+
+      def format_time(time, options = {})
+        time.strftime(options[:time] || TIME_FORMAT)
+      end
+
+      class << self
+
+        def build(match_data)
+
+          if match_data
+            record = new
+            record.latitude = match_data[3].to_f
+            record.longitude = match_data[6].to_f
+            record.element = match_data[8]
+            record.unit = match_data[9]
+            record.reference_time = Time.utc(*match_data[10..14].map(&:to_i))
+            record.valid_time = Time.utc(*match_data[15..19].map(&:to_i))
+            record.value = match_data[20].to_f
+            record
+          end
+
+        end
+
+        def regexp
+          @regexp ||= Regexp.new("\\(#{REGEXP_LOCATION}\\),\\s+#{REGEXP_ELEMENT}\\[#{REGEXP_UNIT}\\],\\s+#{REGEXP_TIMESTAMP},\\s+#{REGEXP_TIMESTAMP},\\s+#{REGEXP_FLOAT}").freeze
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/gribr/degrib.rb

@@ -0,0 +1,21 @@
+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/probe_record'
+
+module Gribr
+
+  module Degrib
+
+    def self.executeable
+      @executeable ||= Executable.new("degrib")
+    end
+
+  end
+
+end
+
+

data/lib/gribr/executeable.rb

@@ -0,0 +1,26 @@
+module Gribr
+
+  class Executable
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def exist?
+      File.exist?(path)
+    end
+
+    def path
+      @path ||= candidates.find { |candidate| File.exists?(candidate) }
+    end
+
+    protected
+
+    def candidates
+      ENV["PATH"].split(":").collect { |path| File.join(path, name) }
+    end
+
+  end
+end

data/lib/gribr/inventory.rb

@@ -0,0 +1,62 @@
+module Gribr
+
+  class Inventory
+
+    def initialize(messages = Array.new)
+      @messages = Hash.new
+      messages.each { |message| add_message(message) }
+    end
+
+    def add_message(message)
+      set_end_position_of_previous(message)
+      @messages[message.number] = message
+    end
+
+    def messages
+      @messages.values.sort_by(&:number)
+    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]
+    end
+
+    class << self
+
+      def file(file)
+        Gribr::Degrib::File.gribfile?(file) ? grib_file(file) : inventory_file(file)
+      end
+
+      def io(io)
+
+        inventory = new
+
+        io.each_with_index do |line, index|
+
+          if index > 0
+            message = parse_record(line)
+            inventory.add_message(message)
+            yield(message) if block_given?
+          end
+
+        end
+
+        inventory
+
+      end
+
+      protected
+
+      def grib_file(file)
+        IO.popen(command(file)) { |io| io(io) }
+      end
+
+      def inventory_file(file)
+        ::File.open(file.respond_to?(:path) ? file.path : file) { |file| io(file) }
+      end
+
+    end
+
+  end
+end

data/lib/gribr/utils.rb

@@ -0,0 +1,23 @@
+module Gribr
+
+  module RegexpParser
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+
+      def parse(line)
+        build regexp.match(line.to_s)
+      end
+
+      def parse!(line)
+        parse(line) || raise(ArgumentError, "Can't parse: #{line}")
+      end
+
+    end
+
+  end
+
+end

data/lib/gribr/wgrib/inventory.rb

@@ -0,0 +1,24 @@
+require 'gribr/inventory'
+require 'gribr/wgrib/inventory_record'
+
+module Gribr
+  module Wgrib
+
+    class Inventory < Gribr::Inventory
+
+      class << self
+
+        def command(file)
+          "wgrib #{file.respond_to?(:path) ? file.path : file} -s"
+        end
+
+        def parse_record(line)
+          ShortInventoryRecord.parse!(line)
+        end
+
+      end
+
+    end
+
+  end
+end