wasserstand 0.0.10 → 0.0.11

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wasserstand.gemspec
 gemspec
+
+# Put dalli into its own group so not everyone has to require it
+gem 'dalli', :group => :dalli

data/TODO

@@ -1,3 +1,2 @@
-* Tests for the command line client
 * CSV output for the command line client
 * JSON output for the command line client

data/bin/wasserstand

@@ -6,12 +6,27 @@ Bundler.require
 require 'wasserstand'
 require 'optparse'
 
-OptionParser.new do |opts|
+options = {}
+
+params = OptionParser.new do |opts|
   opts.banner = <<HERE
-Wasserstand provides water level information as provided by PegelOnline.
+Shows water level information as provided by PegelOnline.
 
 Usage:
-    #{File.basename($0)} [options] [WATERWAY | LEVEL]
+    #{File.basename($0)} [options] [WATERWAY | LEVEL | WATERWAY LEVEL]
+
+Examples:
+    # all waterways
+    #{File.basename($0)}
+
+    # single waterway
+    #{File.basename($0)} Rhein
+
+    # single level
+    #{File.basename($0)} Koblenz
+
+    # single level that happens to have the same name as a waterway
+    #{File.basename($0)} Ilm Ilmenau
 
 Author:
     Nicolas E. Rabenau nerab@gmx.at
@@ -33,34 +48,25 @@ HERE
   end
 
   opts.on("-u", "--url URL", "Use URL to fetch levels") do |url|
-    Wasserstand.logger.info("Using URL #{url}")
-    Wasserstand.provider = Wasserstand::Provider::PegelOnline.new(url)
+    options[:url] = url
   end
-end.parse!
 
-query = ARGV.shift
-
-if query.nil?
-  Wasserstand::Waterway.all.each{|ww| puts "#{ww.name} (#{ww.levels.size} levels)"}
-else
-  begin
-    waterway = Wasserstand::Waterway[query]
-
-    if waterway
-      puts "#{waterway.name} has #{waterway.levels.size} levels:"
-      waterway.levels.sort_by{|name, level| level.km}.each{|name, level| puts "#{name} (km #{level.km}): #{level.measurements.last}"}
-    else
-      level = Wasserstand::Level[query]
-
-      if level.nil?
-        STDERR.puts "#{File.basename($0)}: No waterway nor level found that matches '#{query}."
-      else
-        puts "Level #{level.name} (#{level.waterway}, km #{level.km}):"
-        level.measurements.each{|measurement| puts measurement}
-      end
-    end
-  rescue
-    STDERR.puts $!
-    $!.backtrace.each{|msg| Wasserstand.logger.debug(msg)}
+  opts.on("-c", "--cache [URL]", "Use memcached at URL instead of heap. URL defaults to 127.0.0.1:11211.") do |url|
+    options[:cache] = url || '127.0.0.1:11211'
   end
+end.parse!
+
+Wasserstand.provider = Wasserstand::Provider::PegelOnline.new(options[:url])
+
+if options[:cache]
+  Bundler.require(:default, :dalli)
+  Wasserstand.logger.info("Using memcached at #{options[:cache]}")
+  Wasserstand.provider.cache = Dalli::Client.new(options[:cache], :expires_in => 60 * 60)
+end
+
+begin
+  Wasserstand::Commandline.get(params)
+rescue
+  STDERR.puts $!
+  $!.backtrace.each{|msg| Wasserstand.logger.debug(msg)}
 end

data/lib/wasserstand.rb

@@ -13,10 +13,16 @@ module Wasserstand
   AmbigousNameError = Class.new(StandardError)
 
   class << self
-    attr_writer :provider
-
     def provider
-      @provider ||= Provider::PegelOnline.new
+      if @provider.nil?
+        self.provider = Provider::PegelOnline.new # go through attribute writer in order to log
+      end
+      @provider
+    end
+
+    def provider=(p)
+      Wasserstand.logger.info "Using provider #{p}"
+      @provider = p
     end
 
     def logger

data/lib/wasserstand/commandline.rb

@@ -0,0 +1,76 @@
+module Wasserstand
+  module Commandline
+    def self.get(params = [])
+      case params.size
+      when 0
+        present_waterway(Wasserstand::Waterway.all)
+      when 1 # "Elbe" or "Dresden"
+        waterway = Wasserstand::Waterway[params.first]
+
+        if waterway
+          present_waterway(waterway)
+        else
+          # not a waterway, treat it as level
+          present_level(Wasserstand::Level[params.first])
+        end
+      when 2 # "Elbe Dresden" or "Ilm Ilmenau"
+        if waterway = Wasserstand::Waterway[params.first]
+          present_level(waterway.levels[params.last])
+        else
+          STDERR.puts "No matching waterway found."
+        end
+      else
+        raise "Unexpected number of parameters."
+      end
+    end
+
+    private
+
+    def self.present_waterway(waterway, dig = true)
+      if waterway.nil?
+        STDERR.puts "No matching waterway found."
+      else
+        if waterway.respond_to?(:each)
+          STDERR.puts "The following waterways are available:"
+          waterway.each{|w| present_waterway(w, false)}
+        else
+          if !dig
+            puts waterway.name
+          else
+            STDERR.puts "#{waterway.name} has #{waterway.levels.size} levels:"
+            present_level(waterway.levels.values)
+          end
+        end
+      end
+    end
+
+    def self.present_level(level, dig = true)
+      if level.nil?
+        STDERR.puts "No match found."
+      else
+        if level.respond_to?(:each)
+          level.each{|l| present_level(l, false)}
+        else
+          if !dig
+            puts level.name
+          else
+            STDERR.puts "#{level.name} (#{level.waterway}, km #{level.km}):"
+            present_measurement(level.measurements)
+          end
+        end
+      end
+    end
+
+    def self.present_measurement(measurement)
+      if measurement.nil?
+        STDERR.puts "No measurement found."
+      else
+        if measurement.respond_to?(:each)
+          measurement.each{|l| present_measurement(l)}
+        else
+          puts measurement
+        end
+      end
+    end
+  end
+end

data/lib/wasserstand/finders.rb

@@ -10,7 +10,7 @@ module Wasserstand
       when 1
         results.first
       else
-        raise AmbigousNameError "Name '#{name}' is not unique. Found #{results.size} results."
+        raise AmbigousNameError.new "Name '#{name}' is not unique. Found #{results.size} results."
       end
     end
   end

data/lib/wasserstand/heap_cache.rb

@@ -1,4 +1,7 @@
 module Wasserstand
+  #
+  # Cache objects in memory
+  #
   class HeapCache
     def initialize
       @backend = {}

data/lib/wasserstand/measurement.rb

@@ -11,7 +11,7 @@ module Wasserstand
     end
 
     def to_s
-      "#{@date}: #{@value} cm, Trend #{@trend}"
+      "#{@date.getlocal}: #{@value} cm, Trend #{@trend}"
     end
   end
 end

data/lib/wasserstand/null_cache.rb

@@ -0,0 +1,7 @@
+module Wasserstand
+  # Does nothing
+  class NullCache
+    def get(name);end
+    def set(name, value);end
+  end
+end

data/lib/wasserstand/provider/pegel_online.rb

@@ -1,24 +1,22 @@
 module Wasserstand
   module Provider
     class PegelOnline
-      attr_writer :cache
-
       include Enumerable
       extend Forwardable
       def_delegator :all, :each
 
-      def initialize(url = 'http://www.pegelonline.wsv.de/svgz/pegelstaende_neu.xml')
-        @url = url
-        @names = []
+      def initialize(url = nil)
+        @url = url || 'http://www.pegelonline.wsv.de/svgz/pegelstaende_neu.xml'
       end
 
-      # Cache entries may expire, and simply iterating over the list of current cache entries would render an incomplete picture. Therefore we maintain the knowledge of what waterways exist in a single list, which is the authoritative source of what waterways exist.
+      # Cache entries may expire, and simply iterating over the list of current cache entries would render an incomplete picture. Therefore we maintain the knowledge of what waterways exist in a single list, which is the authoritative source. If that one is gone, it is gone as a whole and everything will need to be refreshed.
       def waterways
-        replenish if @names.empty?
-        @names.map do |name|
+        names = cache.get(KEY_NAMES) || replenish
+
+        names.map do |name|
           ww = cache.get(name) # no fetch with block in Dalli, so we cannot use it here either ...
 
-          # Not finding the Waterway for a name means it was removed from the cache, but it may or may not exist in the backend. Therefore we need to replenish our cache including our knowledge about the name.
+          # Not finding the Waterway for a name means it was removed from the cache, but it may or may not exist in the backend. Therefore we need to replenish our cache including our knowledge about the names.
           if ww.nil?
             replenish
             ww = cache.get(name)
@@ -34,23 +32,40 @@ module Wasserstand
       end
 
       def cache
-        @cache ||= HeapCache.new
+        if @cache.nil?
+          self.cache = HeapCache.new
+        end
+        @cache
+      end
+
+      def cache=(c)
+        Wasserstand.logger.info "Using cache #{c}"
+        @cache = c
+      end
+
+      def to_s
+        "#<#{self.class.name}:#{@url}>"
       end
 
       private
 
+      KEY_NAMES = "#{self.name}#names"
+
       #
       # Replenish the cache and names index
       #
       def replenish
-        @names.clear
         Wasserstand.logger.info "Fetching #{@url}"
         doc = Nokogiri::HTML(open(@url).read, nil, 'ISO-8859-1')
+
+        names = []
         doc.xpath("//data/table/gewaesser").each do |node|
           ww = WaterwayMapper.map(node)
-          @names << ww.name
           cache.set(ww.name, ww)
+          names << ww.name
         end
+        cache.set(KEY_NAMES, names)
+        names
       end
     end
   end

data/lib/wasserstand/version.rb

@@ -1,3 +1,3 @@
 module Wasserstand
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/test/unit/test_app.rb

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+require 'helper'
+require 'open3'
+
+#
+# End-to-end test
+#
+class TestApp < MiniTest::Unit::TestCase
+  APP_SCRIPT = 'ruby bin/wasserstand'
+  DEFAULT_OPTIONS = {
+    'url' => File.join(File.dirname(__FILE__), '..', 'fixtures', 'pegelstaende_neu.xml')
+  }
+
+  def test_all_waterways
+    stdout, stderr = execute
+    assert_equal(77, stdout.size)
+    assert_equal(["ILM\n", "ILMENAU\n", "ITTER ZUR DIEMEL\n", "ITTER ZUR EDER\n"], stdout.select{|name| name =~ /^I/i})
+  end
+
+  def test_waterway
+    stdout, stderr = execute('Diemel')
+    assert_equal(3, stdout.size)
+    assert_equal(["DIEMELTALSPERRE\n", "HELMINGHAUSEN\n", "WILHELMSBRÜCKE\n"], stdout)
+    assert_equal(["DIEMEL has 3 levels:\n"], stderr)
+  end
+
+  def test_unknown_waterway
+    stdout, stderr = execute("Donaukanal")
+    assert_equal(0, stdout.size)
+    assert_equal(["No match found.\n"], stderr)
+  end
+
+  def test_level
+    stdout, stderr = execute(['Cochem'])
+    assert_equal(["2012-09-13 18:15:00 +0000: 221.0 cm, Trend fallend\n"], stdout)
+    assert_equal(["COCHEM (MOSEL, km 51.6):\n"], stderr)
+  end
+
+  def test_level_with_waterway
+    stdout, stderr = execute(['Ems', 'Knock'])
+    assert_equal(["2012-09-13 20:31:00 +0000: 626.6 cm, Trend fallend\n"], stdout)
+    assert_equal(["KNOCK (EMS, km 50.848):\n"], stderr)
+  end
+
+  def test_unknown_level
+    stdout, stderr = execute("Altstadt")
+    assert_equal(0, stdout.size)
+    assert_equal(["No match found.\n"], stderr)
+  end
+
+  private
+
+  def execute(params = [], options = {})
+    line = []
+    line << "TZ='UTC'"
+    line << APP_SCRIPT
+    line.concat(Array(params))
+    line << DEFAULT_OPTIONS.merge(options).map do |k,v|
+      if v.nil? || v.to_s.empty?
+        "#{k}"
+      else
+        "--#{k}=#{v}"
+      end
+    end
+
+    out = ''
+    err = ''
+
+    Open3.popen3(line.join(' ')) do |stdin, stdout, stderr|
+      out << stdout.read
+      err << stderr.read
+    end
+
+    return [out.lines.to_a, err.lines.to_a]
+  end
+end

data/test/unit/test_level.rb

@@ -21,6 +21,12 @@ class TestLevel < WasserstandTestCase
     assert(Level['GENTHIN'])
   end
 
+  def test_ambigous_name
+    assert_raises(Wasserstand::AmbigousNameError) do
+      Level['Nienburg']
+    end
+  end
+
   private
 
   def assert_level(values, level)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wasserstand
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -190,11 +190,13 @@ files:
 - TODO
 - bin/wasserstand
 - lib/wasserstand.rb
+- lib/wasserstand/commandline.rb
 - lib/wasserstand/finders.rb
 - lib/wasserstand/hash_clod.rb
 - lib/wasserstand/heap_cache.rb
 - lib/wasserstand/level.rb
 - lib/wasserstand/measurement.rb
+- lib/wasserstand/null_cache.rb
 - lib/wasserstand/provider/level_mapper.rb
 - lib/wasserstand/provider/pegel_online.rb
 - lib/wasserstand/provider/waterway_mapper.rb
@@ -203,6 +205,7 @@ files:
 - lib/wasserstand/waterway.rb
 - test/fixtures/pegelstaende_neu.xml
 - test/helper.rb
+- test/unit/test_app.rb
 - test/unit/test_level.rb
 - test/unit/test_measurement.rb
 - test/unit/test_trend.rb
@@ -235,6 +238,7 @@ summary: Wasserstand auf deutschen Flüssen
 test_files:
 - test/fixtures/pegelstaende_neu.xml
 - test/helper.rb
+- test/unit/test_app.rb
 - test/unit/test_level.rb
 - test/unit/test_measurement.rb
 - test/unit/test_trend.rb