swissmatch-location 0.0.1.201208 → 0.1.1.201304

data/data/{swissmatch/plz_p2_20120821.txt → swissmatch-location/plz_p2_20130318.txt}

@@ -145,7 +145,6 @@
 535	2	3	2	Le Creux VD	Le Creux VD
 541	2	3	2	Vers-chez-Grosjean	Vers-chez-Grosjean
 545	1	3	2	Esserts-de-Rive	Les Esserts-de-Rive
-545	2	3	2	Le S�chey	Le S�chey
 546	1	3	2	Chez-le-Ma�tre	Chez-le-Ma�tre
 546	3	3	2	La Golisse	La Golisse
 546	4	3	2	Le Rocheray	Le Rocheray
@@ -871,7 +870,6 @@
 2378	3	3	2	Pinsec	Pinsec
 2378	7	3	2	Mayoux	Mayoux
 2378	8	3	2	Soussillon	Soussillon
-2381	1	3	2	Mission	Mission
 2381	5	3	2	Mottec	Mottec
 2383	1	3	2	Moiry VS	Moiry VS
 2386	1	3	2	Diogne	Diogne
@@ -1371,7 +1369,6 @@
 4526	1	3	1	Sellenb�ren	Sellenb�ren
 4529	2	3	1	Katzenr�ti	Katzenr�ti
 4531	3	3	1	Mettmenhasli	Mettmenhasli
-4531	4	3	1	Nassenwil	Nassenwil
 4535	1	3	1	Niedersteinmaur	Niedersteinmaur
 4535	2	3	1	Obersteinmaur	Obersteinmaur
 4543	2	3	1	Riedt b. Neerach	Riedt b. Neerach

data/lib/swissmatch/communities.rb

@@ -104,6 +104,12 @@ module SwissMatch
       @by_community_number[number]
     end
 
+    # @return [Array<SwissMatch::Community>]
+    #   The communities with the given community numbers (also known as BFSNR).
+    def by_community_numbers(*numbers)
+      @by_community_number.values_at(*numbers)
+    end
+
     # @return [SwissMatch::Community]
     #   The community with the given name.
     def by_name(name)

data/lib/swissmatch/community.rb

@@ -76,7 +76,7 @@ module SwissMatch
     # @private
     # @see Object#eql?
     def eql?(other)
-      self.class == other.class && @community_number == other.community_number
+      self.class.eql?(other.class) && @community_number.eql?(other.community_number)
     end
 
     # @return [String]

data/lib/swissmatch/district.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+
+
+module SwissMatch
+
+  # Represents a swiss district.
+  class District
+
+    # @return [String]
+    #   The district number.
+    attr_reader :district_number
+
+    # @return [String]
+    #   The name of the district.
+    attr_reader :name
+
+    # @return [SwissMatch::Communities]
+    #   The political communities belonging to this district
+    attr_reader :communities
+
+    attr_reader :canton
+
+    # @param [String] district_number
+    #   The two letter abbreviation of the districts name as used on license plates.
+    # @param [String] name
+    #   The official name of the district.
+    # @param [SwissMatch::Canton] canton
+    #   The canton this district belongs to
+    # @param [SwissMatch::Communities] communities
+    #   The communities belonging to this district
+    def initialize(district_number, name, canton, communities)
+      @district_number  = district_number
+      @name             = name
+      @canton           = canton
+      @communities      = communities
+    end
+
+    # @param [Boolean] retain_references
+    #   If set to false, :agglomeration will be set to the community_number and
+    #   :canton to the canton's license_tag.
+    #
+    # @return [Hash]
+    #   All properties of the district as a hash.
+    def to_hash(retain_references=false)
+      if retain_references
+        canton        = @canton
+        communities   = @communities
+      else
+        canton        = @canton && @canton.license_tag
+        communities   = @communities.map(&:community_number)
+      end
+
+      {
+        :name             => @name,
+        :district_number  => @district_number,
+        :canton           => canton,
+        :communities      => communities,
+      }
+    end
+
+    alias to_s name
+
+    # @private
+    # @see Object#hash
+    def hash
+      [self.class, @number].hash
+    end
+
+    # @private
+    # @see Object#eql?
+    def eql?(other)
+      self.class.eql?(other.class) && @number.eql?(other.number)
+    end
+
+    # @return [String]
+    # @see Object#inspect
+    def inspect
+      sprintf "\#<%s:%014x %d %p>", self.class, object_id, @district_number, to_s
+    end
+  end
+end

data/lib/swissmatch/districts.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+
+
+require 'swissmatch/district'
+
+
+
+module SwissMatch
+
+  # Represents a collection of swiss districts and provides a query interface.
+  class Districts
+    include Enumerable
+
+    # @param [Array<SwissMatch::District>] districts
+    #   The SwissMatch::District objects this SwissMatch::Districts should contain
+    def initialize(districts)
+      @districts          = districts
+      @by_district_number = {}
+      @by_name            = {}
+
+      districts.each do |district|
+        @by_district_number[district.district_number] = district
+        @by_name[district.name]                       = district
+      end
+    end
+
+    # Calls the block once for every SwissMatch::District in this SwissMatch::Districts
+    # instance, passing that district as a parameter.
+    # The order is the same as the instance was constructed.
+    #
+    # @yield [district]
+    # @yieldparam [SwissMatch::District] district
+    #
+    # @return [self] Returns self
+    def each(&block)
+      @districts.each(&block)
+      self
+    end
+
+    # Calls the block once for every SwissMatch::District in this SwissMatch::Districts
+    # instance, passing that district as a parameter.
+    # The order is the reverse of what the instance was constructed.
+    #
+    # @yield [district]
+    # @yieldparam [SwissMatch::District] district
+    #
+    # @return [self] Returns self
+    def reverse_each(&block)
+      @districts.reverse_each(&block)
+      self
+    end
+
+    # @return [SwissMatch::Districts]
+    #   A SwissMatch::Districts collection with all SwissMatch::District objects for which the block
+    #   returned true (or a trueish value)
+    def select(*args, &block)
+      Districts.new(@districts.select(*args, &block))
+    end
+
+    # @return [SwissMatch::Districts]
+    #   A SwissMatch::Districts collection with all SwissMatch::District objects for which the block
+    #   returned false (or a falseish value)
+    def reject(*args, &block)
+      Districts.new(@districts.reject(*args, &block))
+    end
+
+    # @see Enumerable#sort
+    #
+    # @return [SwissMatch::Districts]
+    #   A SwissMatch::Districts collection sorted by the block
+    def sort(*args, &block)
+      Districts.new(@districts.sort(*args, &block))
+    end
+
+    # @see Enumerable#sort_by
+    #
+    # @return [SwissMatch::Districts]
+    #   A SwissMatch::Districts collection sorted by the block
+    def sort_by(*args, &block)
+      Districts.new(@districts.sort_by(*args, &block))
+    end
+
+    # @return [SwissMatch::District]
+    #   The district with the given district_number or name
+    def [](district_number_or_name)
+      @by_district_number[district_number_or_name] || @by_name[district_number_or_name]
+    end
+
+    # @return [SwissMatch::District]
+    #   The district with the given license tag.
+    def by_district_number(tag)
+      @by_district_number[tag]
+    end
+
+    # @return [SwissMatch::District]
+    #   The district with the given name (any language)
+    def by_name(name)
+      @by_name[name]
+    end
+
+    # @return [Integer] The number of SwissMatch::District objects in this collection.
+    def size
+      @districts.size
+    end
+
+    # @return [Array<SwissMatch::District>]
+    #   An Array with all SwissMatch::District objects in this SwissMatch::Districts.
+    def to_a
+      @districts.dup
+    end
+
+    # @private
+    # @see Object#inspect
+    def inspect
+      sprintf "\#<%s:%x size: %d>", self.class, object_id>>1, size
+    end
+  end
+end

data/lib/swissmatch/location.rb

@@ -57,6 +57,21 @@ module SwissMatch
       @data.cantons
     end
 
+    # @param [String] district_number_or_name
+    #   The district_number or name of the district
+    #
+    # @return [SwissMatch::District]
+    #   The district with the given district_number or name
+    def self.district(district_number_or_name)
+      @data.districts[district_number_or_name]
+    end
+
+    # @return [SwissMatch::Districts]
+    #   All known districts
+    def self.districts
+      @data.districts
+    end
+
     # @param [Integer] key
     #   The community number of the community
     #
@@ -204,6 +219,16 @@ module SwissMatch
     SwissMatch::Location.cantons(*args, &block)
   end
 
+  # @see SwissMatch::Location::district
+  def self.district(*args, &block)
+    SwissMatch::Location.district(*args, &block)
+  end
+
+  # @see SwissMatch::Location::districts
+  def self.districts(*args, &block)
+    SwissMatch::Location.districts(*args, &block)
+  end
+
   # @see SwissMatch::Location::community
   def self.community(*args, &block)
     SwissMatch::Location.community(*args, &block)

data/lib/swissmatch/location/datafiles.rb

@@ -3,6 +3,15 @@
 
 
 require 'swissmatch/loaderror'
+require 'swissmatch/name'
+require 'swissmatch/canton'
+require 'swissmatch/cantons'
+require 'swissmatch/district'
+require 'swissmatch/districts'
+require 'swissmatch/community'
+require 'swissmatch/communities'
+require 'swissmatch/zipcode'
+require 'swissmatch/zipcodes'
 
 
 
@@ -21,16 +30,18 @@ module SwissMatch
       # Generates a regular expression, that matches +size+ tab separated fields,
       # delimited by \r\n.
       # @private
-      def self.generate_expression(size)
-        /^#{Array.new(size) { '([^\t]*)' }.join('\t')}\r\n/
+      def self.generate_expression(size, separator, terminator)
+        /^#{Array.new(size) { "([^#{separator}]*)" }.join(eval("'#{separator}'"))}#{terminator}/
       end
 
       # Regular expressions used to parse the different files.
       # @private
       Expressions = {
-        :community  => generate_expression(4),
-        :zip_2      => generate_expression(6),
-        :zip_1      => generate_expression(13),
+        :community    => generate_expression(4, '\t', '\r\n'),
+        :zip_2        => generate_expression(6, '\t', '\r\n'),
+        :zip_1        => generate_expression(13, '\t', '\r\n'),
+        :districts    => generate_expression(3, ',', '\n'),
+        :communities  => generate_expression(10, ',', '\n'),
       }
 
       # @private
@@ -89,6 +100,9 @@ module SwissMatch
       # @return [SwissMatch::Cantons] The loaded swiss cantons
       attr_reader :cantons
 
+      # @return [SwissMatch::Districts] The loaded swiss districts
+      attr_reader :districts
+
       # @return [SwissMatch::Communities] The loaded swiss communities
       attr_reader :communities
 
@@ -107,8 +121,8 @@ module SwissMatch
         elsif ENV['SWISSMATCH_DATA'] then
           @data_directory = ENV['SWISSMATCH_DATA']
         else
-          data_directory  = File.expand_path('../../../../data/swissmatch', __FILE__)
-          data_directory  = Gem.datadir 'swissmatch' if defined?(Gem) && !File.directory?(data_directory)
+          data_directory  = File.expand_path('../../../../data/swissmatch-location', __FILE__)
+          data_directory  = Gem.datadir 'swissmatch-location' if defined?(Gem) && !File.directory?(data_directory)
           @data_directory = data_directory
         end
       end
@@ -176,7 +190,7 @@ module SwissMatch
       # @return [self]
       #   Returns self.
       def load!
-        @cantons, @communities, @zip_codes = *load
+        @cantons, @districts, @communities, @zip_codes = *load
         self
       end
 
@@ -187,10 +201,11 @@ module SwissMatch
         reset_errors!
 
         cantons     = load_cantons
+        districts   = load_districts(cantons)
         communities = load_communities(cantons)
         zip_codes   = load_zipcodes(cantons, communities)
 
-        [cantons, communities, zip_codes]
+        [cantons, districts, communities, zip_codes]
       end
 
       # @return [SwissMatch::Cantons]
@@ -203,6 +218,20 @@ module SwissMatch
         )
       end
 
+      def load_districts(cantons)
+        # File format: GDEKT,GDEBZNR,GDEBZNA
+        path      = Dir.enum_for(:glob, "#{@data_directory}/districts_*.csv").last
+        data      = File.read(path, encoding: Encoding::UTF_8.to_s).scan(Expressions[:districts])
+        districts = data[1..-1].map { |canton_tag, district_number, district_name|
+          district_number = Integer(district_number, 10)
+          canton          = cantons.by_license_tag(canton_tag)
+
+          District.new(district_number, district_name, canton, SwissMatch::Communities.new([]))
+        }
+
+        Districts.new(districts)
+      end
+
       # @return [SwissMatch::Communities]
       #   An instance of SwissMatch::Communities containing all communities defined by the
       #   files known to this DataFiles instance.
@@ -243,13 +272,37 @@ module SwissMatch
         raise "Must load cantons first" unless cantons
         raise "Must load communities first" unless communities
 
-        temporary       = {}
-        self_delivered  = []
-        others          = []
-        zip1_file       = Dir.enum_for(:glob, "#{@data_directory}/plz_p1_*.txt").last
-        zip2_file       = Dir.enum_for(:glob, "#{@data_directory}/plz_p2_*.txt").last
+        temporary         = Hash.new { |h,k| h[k] = [] }
+        community_mapping = {}
+        self_delivered    = []
+        others            = []
+        zip1_file         = Dir.enum_for(:glob, "#{@data_directory}/plz_p1_*.txt").last
+        zip2_file         = Dir.enum_for(:glob, "#{@data_directory}/plz_p2_*.txt").last
+        communities_file  = Dir.enum_for(:glob, "#{@data_directory}/communities_*.csv").last
+
+        # KTKZ,OHW,ORTNAME,GHW,GDENR,GDENAMK,PHW,PLZ4,PLZZ,PLZNAMK
+        communities_data  = File.read(
+          communities_file,
+          encoding: Encoding::UTF_8.to_s
+        ).scan(Expressions[:communities])[1..-1].transpose.values_at(4,7,8)
+        communities_data[0].map!(&:to_i)
+        communities_data[1].map!(&:to_i)
+        communities_data[2].map!(&:to_i)
+        communities_data.transpose.each do |data|
+          temporary[data.last(2)] << data.at(0)
+        end
+
+        temporary.each do |key,coms|
+          # compact, because some communities already no longer exist, so by_community_numbers can
+          # contain nils which must be removed
+          community_mapping[key] = Communities.new(communities.by_community_numbers(*coms.uniq.sort).compact)
+        end
+
+        temporary         = {}
         load_table(zip1_file, :zip_1).each do |row|
           onrp                  = row.at(0).to_i
+          code                  = row.at(2).to_i
+          addon                 = row.at(3).to_i
           delivery_by           = row.at(10).to_i
           delivery_by           = case delivery_by when 0 then nil; when onrp then :self; else delivery_by; end
           language              = LanguageCodes[row.at(7).to_i]
@@ -259,8 +312,8 @@ module SwissMatch
           data                  = [
             onrp,                              # ordering_number
             row.at(1).to_i,                    # type
-            row.at(2).to_i,                    # code
-            row.at(3).to_i,                    # add_on
+            code,
+            addon,
             name,                              # name (official)
             [name],                            # names (official + alternative)
             name_short,                        # name_short (official)
@@ -273,6 +326,7 @@ module SwissMatch
             row.at(9) == "1",                  # sortfile_member
             delivery_by,                       # delivery_by
             communities.by_community_number(row.at(11).to_i),  # community_number
+            community_mapping[[code, addon]],
             Date.civil(*row.at(12).match(/^(\d{4})(\d\d)(\d\d)$/).captures.map(&:to_i)) # valid_from
           ]
           temporary[onrp] = data