wasserstand 0.0.8 → 0.0.9

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'minitest' do
+  watch(%r|^test/unit/test_(.*)\.rb|)
+  watch(%r|^lib/*\.rb|){'test'}
+  watch(%r{^lib/.*/([^/]+)\.rb$}){|m| "test/unit/test_#{m[1]}.rb"}
+  watch(%r|^test/helper\.rb|){'test'}
+end

data/README.md

@@ -20,12 +20,4 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+see tests

data/lib/wasserstand.rb

@@ -3,14 +3,19 @@ require 'open-uri'
 require 'tzinfo'
 require 'unicode_utils/upcase'
 require 'unicode_utils/downcase'
+require 'forwardable'
 
 require 'require_all'
 require_rel 'wasserstand'
 
 module Wasserstand
+  AmbigousNameError = Class.new(StandardError)
+
   class << self
-    def providers
-      @providers ||= Hash.new{|hash, k| hash[k] = k.new}
+    attr_writer :provider
+
+    def provider
+      @provider ||= Provider::PegelOnline.new
     end
   end
 end

data/lib/wasserstand/finders.rb

@@ -0,0 +1,16 @@
+module Wasserstand
+  module Finders
+    def [](name)
+      results = all.select{|named| UnicodeUtils.upcase(name) == named.name}
+
+      case results.size
+      when 0
+        nil # loookup returns nil if not found. This is a lookup, not find_all.
+      when 1
+        results.first
+      else
+        raise AmbigousNameError "Name '#{name}' is not unique. Found #{results.size} results."
+      end
+    end
+  end
+end

data/lib/wasserstand/hash_clod.rb

@@ -0,0 +1,10 @@
+# http://stackoverflow.com/questions/2030336/how-do-i-create-a-hash-in-ruby-that-compares-strings-ignoring-case
+class HashClod < Hash
+  def [](key)
+    key.respond_to?(:upcase) ? super(UnicodeUtils.upcase(key)) : super(key)
+  end
+
+  def []=(key, value)
+    key.respond_to?(:upcase) ? super(UnicodeUtils.upcase(key), value) : super(key, value)
+  end
+end

data/lib/wasserstand/heap_cache.rb

@@ -0,0 +1,16 @@
+class HeapCache
+  def initialize
+    @backend = {}
+  end
+
+  def get(name)
+    result = @backend[name]
+    STDERR.puts "#{self.class.name} GET #{result ? 'HIT' : 'MISS'} #{name}"
+    result
+  end
+
+  def set(name, value)
+    STDERR.puts "#{self.class.name} SET #{name} => #{value.inspect}"
+    @backend[name] = value
+  end
+end

data/lib/wasserstand/level.rb

@@ -2,24 +2,12 @@ module Wasserstand
   #
   # see http://www.pegelonline.wsv.de/gast/hilfe#hilfe_pegelparameter
   #
-  class Level # Pegel
+  class Level
     class << self
-      def [](name)
-        provider[name]
-      end
+      include Finders
 
       def all
-        provider.all
-      end
-
-      def find_by_name(regex)
-        provider.find_by_name(regex)
-      end
-
-      private
-
-      def provider
-        Wasserstand.providers[PegelOnline::LevelProvider]
+        Wasserstand.provider.levels
       end
     end
 
@@ -43,5 +31,9 @@ module Wasserstand
     def to_s
       name
     end
+
+    def inspect
+      "#<#{self.class.name}: #{name} (#{measurements.size} measurements)>"
+    end
   end
 end

data/lib/wasserstand/provider/level_mapper.rb

@@ -1,18 +1,18 @@
 module Wasserstand
-  module PegelOnline
+  module Provider
 =begin
-<item>
-  <no>8</no>
-  <psmgr>320</psmgr>
-  <pegelname>KONSTANZ</pegelname>
-  <messwert>380,7</messwert>
-  <km>0</km>
-  <pnp>391,89</pnp>
-  <tendenz>Gleich</tendenz>
-  <datum>13.09.2012</datum>
-  <uhrzeit>20:00:00</uhrzeit>
-  <pegelnummer>0906</pegelnummer>
-</item>
+  <item>
+    <no>8</no>
+    <psmgr>320</psmgr>
+    <pegelname>KONSTANZ</pegelname>
+    <messwert>380,7</messwert>
+    <km>0</km>
+    <pnp>391,89</pnp>
+    <tendenz>Gleich</tendenz>
+    <datum>13.09.2012</datum>
+    <uhrzeit>20:00:00</uhrzeit>
+    <pegelnummer>0906</pegelnummer>
+  </item>
 =end
     class LevelMapper
       class << self

data/lib/wasserstand/provider/pegel_online.rb

@@ -0,0 +1,57 @@
+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 = []
+      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.
+      def waterways
+        replenish if @names.empty?
+        @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.
+          if ww.nil?
+            replenish
+            ww = cache.get(name)
+            # Still nil? Does not matter. Replenish has auto-removed an outdated name.
+          end
+
+          ww
+        end.compact # don't return nil entries
+      end
+
+      def levels
+        waterways.inject([]){|result, ww| result.concat(ww.levels.values)}
+      end
+
+      def cache
+        @cache ||= HeapCache.new
+      end
+
+      private
+
+      #
+      # Replenish the cache and names index
+      #
+      def replenish
+        @names.clear
+        STDERR.puts "FETCH #{@url}"
+        doc = Nokogiri::HTML(open(@url).read, nil, 'ISO-8859-1')
+        doc.xpath("//data/table/gewaesser").each do |node|
+          ww = WaterwayMapper.map(node)
+          @names << ww.name
+          cache.set(ww.name, ww)
+        end
+      end
+    end
+  end
+end

data/lib/wasserstand/provider/waterway_mapper.rb

@@ -1,21 +1,21 @@
 module Wasserstand
-  module PegelOnline
+  module Provider
 =begin
-      <gewaesser>
-        <name>BODENSEE</name>
-        <item>
-          <no>8</no>
-          <psmgr>320</psmgr>
-          <pegelname>KONSTANZ</pegelname>
-          <messwert>380,7</messwert>
-          <km>0</km>
-          <pnp>391,89</pnp>
-          <tendenz>Gleich</tendenz>
-          <datum>13.09.2012</datum>
-          <uhrzeit>20:00:00</uhrzeit>
-          <pegelnummer>0906</pegelnummer>
-        </item>
-      </gewaesser>
+    <gewaesser>
+      <name>BODENSEE</name>
+      <item>
+        <no>8</no>
+        <psmgr>320</psmgr>
+        <pegelname>KONSTANZ</pegelname>
+        <messwert>380,7</messwert>
+        <km>0</km>
+        <pnp>391,89</pnp>
+        <tendenz>Gleich</tendenz>
+        <datum>13.09.2012</datum>
+        <uhrzeit>20:00:00</uhrzeit>
+        <pegelnummer>0906</pegelnummer>
+      </item>
+    </gewaesser>
 =end
     class WaterwayMapper
       class << self

data/lib/wasserstand/version.rb

@@ -1,3 +1,3 @@
 module Wasserstand
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/wasserstand/waterway.rb

@@ -1,33 +1,10 @@
 module Wasserstand
-  # http://stackoverflow.com/questions/2030336/how-do-i-create-a-hash-in-ruby-that-compares-strings-ignoring-case
-  class HashClod < Hash
-    def [](key)
-      key.respond_to?(:upcase) ? super(UnicodeUtils.upcase(key)) : super(key)
-    end
-
-    def []=(key, value)
-      key.respond_to?(:upcase) ? super(UnicodeUtils.upcase(key), value) : super(key, value)
-    end
-  end
-
   class Waterway
     class << self
-      def [](name)
-        provider[name]
-      end
+      include Wasserstand::Finders
 
       def all
-        provider.all
-      end
-
-      def find_by_name(regex)
-        provider.find_by_name(regex)
-      end
-
-      private
-
-      def provider
-        Wasserstand.providers[PegelOnline::WaterwayProvider]
+        Wasserstand.provider.waterways
       end
     end
 
@@ -41,5 +18,9 @@ module Wasserstand
     def to_s
       name
     end
+
+    def inspect
+      "#<#{self.class.name}: #{name} (#{levels.size} levels)>"
+    end
   end
 end

data/test/helper.rb

@@ -6,7 +6,6 @@ class WasserstandTestCase < MiniTest::Unit::TestCase
 
   def setup
     url = File.join(File.dirname(__FILE__), 'fixtures', 'pegelstaende_neu.xml')
-    Wasserstand.providers[PegelOnline::WaterwayProvider] = PegelOnline::WaterwayProvider.new(url)
-    Wasserstand.providers[PegelOnline::LevelProvider] = PegelOnline::LevelProvider.new(url)
+    Wasserstand.provider = Provider::PegelOnline.new(url)
   end
 end

data/test/unit/test_level.rb

@@ -12,11 +12,6 @@ class TestLevel < WasserstandTestCase
     assert_level({:name => 'PIRNA', :km => 34.67, :measurements_size => 1}, elbe_levels['PIRNA'])
   end
 
-  def test_finder
-    assert_equal(['HEIDELBERG UW', 'HAVELBERG EP', 'HAVELBERG STADT', 'HAVELBERG UP'], Level.find_by_name('ELBERG').map{|w| w.name})
-    assert_equal(21, Level.find_by_name('^E').size)
-  end
-
   def test_lookup
     pirna = Level['Pirna']
     assert(pirna)

data/test/unit/test_waterway.rb

@@ -2,11 +2,6 @@
 require 'helper'
 
 class TestWaterway < WasserstandTestCase
-  def test_finder
-    assert_equal(['ELBE', 'ELBE-HAVEL-KANAL', 'ELBESEITENKANAL'], Waterway.find_by_name('ELB.*').map{|w| w.name})
-    assert_equal(7, Waterway.find_by_name('^E').size)
-  end
-
   def test_size
     assert_equal(77, Waterway.all.size)
   end

data/wasserstand.gemspec

@@ -21,4 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'unicode_utils'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'rb-fsevent'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wasserstand
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -107,6 +107,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Unofficial Ruby wrapper for Pegel Online
 email:
 - nerab@gmx.net
@@ -117,16 +165,21 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/wasserstand
 - lib/wasserstand.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/provider/level_mapper.rb
-- lib/wasserstand/provider/pegel-online.rb
+- lib/wasserstand/provider/pegel_online.rb
 - lib/wasserstand/provider/waterway_mapper.rb
 - lib/wasserstand/trend.rb
 - lib/wasserstand/version.rb

data/lib/wasserstand/provider/pegel-online.rb

@@ -1,87 +0,0 @@
-module Wasserstand
-  module PegelOnline
-    class Provider
-      def initialize(url = 'http://www.pegelonline.wsv.de/svgz/pegelstaende_neu.xml')
-        @url = url
-      end
-
-      def [](name)
-        results = doc.xpath(xpath_lookup(name))
-
-        case results.size
-        when 0
-          return nil # loookup returns nil if not found. This is a lookup, not find_all.
-        when 1
-          return mapper.map(results.first)
-        else
-          raise "Name is not unique. Found #{results.size} results for #{name}."
-        end
-      end
-
-      def all
-        doc.xpath(xpath_all).map{|o| mapper.map(o)}
-      end
-
-      def find_by_name(name_expression)
-        # Not the best performing way, but it gives us the ability to use the  XPath 2.0 'matches' function
-        # which isn't supported in Nokogiri (yet).
-        doc.xpath(xpath_finder(name_expression), Class.new{
-          def matches(node_set, regex)
-            node_set.find_all do |node|
-              node.to_s.match(%r{#{regex}})
-            end
-          end
-        }.new).map{|o| mapper.map(o)}
-      end
-
-      protected
-
-      def xpath_lookup(name)
-        "#{xpath_all}[#{name_attribute}/text() = '#{UnicodeUtils.upcase(name)}']"
-      end
-
-      def xpath_finder(regex)
-        "#{xpath_all}[matches(#{name_attribute}/text(), '#{regex}')]"
-      end
-
-      def fetch(url)
-        STDERR.puts "FETCH #{url}"
-        open(url).read
-      end
-
-      def name_attribute
-        'name'
-      end
-
-      private
-
-      def doc
-        Nokogiri::HTML(fetch(@url), nil, 'ISO-8859-1')
-      end
-    end
-
-    class WaterwayProvider < Provider
-      def xpath_all
-        "//data/table/gewaesser"
-      end
-
-      def mapper
-        Wasserstand::PegelOnline::WaterwayMapper
-      end
-    end
-
-    class LevelProvider < Provider
-      def xpath_all
-        "//data/table/gewaesser/item"
-      end
-
-      def mapper
-        Wasserstand::PegelOnline::LevelMapper
-      end
-
-      def name_attribute
-        'pegelname'
-      end
-    end
-  end
-end