swiss_municipality 0.1.0 → 0.1.2

data/lib/swiss_municipality.rb

@@ -1,5 +1,113 @@
+# frozen_string_literal: true
+
+# gem build swiss_municipality.gemspec
+# gem install ./swiss_municipality-0.1.1.gem
+
+# require 'swiss_municipality'
+#
+
 class SwissMunicipality
-  def self.hi
-    puts 'Tsüri'
+  def self.canton(**options)
+    options = sanitize_options(options)
+    validate_identifier(options)
+    validate_variant(options)
+
+    raise ArgumentError, 'Argument canton must not be given' unless options[:canton].nil?
+
+    if options[:municipality].nil?
+      zip_code_data = MunicipalityData.zip_hash[options[:zip_code]]
+
+      raise ArgumentError, "No municipality found for zip code #{options[:zip_code]}" if zip_code_data.nil?
+
+      canton_data = zip_code_data[:canton]
+    else
+      municipality_data = MunicipalityData.municipality_hash[options[:municipality]]
+      canton_data = municipality_data[:canton]
+    end
+
+    if options[:variant] == :short
+      canton_data[:short]
+    elsif options[:variant] == :full
+      canton_data[options[:language]]
+    end
   end
-end
+
+  def self.all_cantons(options)
+    options = sanitize_options(options)
+    validate_variant(options)
+
+    if options[:variant] == :short
+      MunicipalityData.canton_hash.keys.sort
+    elsif options[:variant] == :full
+      MunicipalityData.canton_hash.values.map { |canton| canton[:full_name][options[:language]] }
+    end
+  end
+
+  def self.municipality(**options)
+    options = sanitize_options(options)
+    validate_identifier(options)
+
+    raise ArgumentError, 'Argument municipality must not be given' unless options[:municipality].nil?
+    raise ArgumentError, 'Argument canton must not be given' unless options[:canton].nil?
+
+    zip_code_data = MunicipalityData.zip_hash[options[:zip_code]]
+    zip_code_data[:municipality]
+  end
+
+  def self.all_municipalities(**options)
+    options = sanitize_options(options)
+
+    if options[:canton].nil?
+      MunicipalityData.municipality_hash
+    else
+      MunicipalityData.canton_hash[options[:canton]][:municipalities]
+    end.keys.sort.map(&:to_s)
+  end
+
+  def self.all_zip_codes(**options)
+    options = sanitize_options(options)
+
+    zip_code_data = if !options[:municipality].nil?
+                      MunicipalityData.municipality_hash[options[:municipality]][:zip_codes]
+                    elsif !options[:canton].nil?
+                      MunicipalityData.canton_hash[options[:canton]][:zip_codes]
+                    else
+                      MunicipalityData.zip_hash.keys
+                    end
+
+    if options[:variant] == :with_municipality
+      zip_code_data.map { |zip_code| [zip_code, MunicipalityData.zip_hash[zip_code.to_sym][:municipality]].join(' ') }
+    else
+      zip_code_data.map(&:to_s)
+    end.sort
+  end
+
+  def self.sanitize_options(options)
+    options[:variant] = options[:variant]&.to_s&.downcase&.to_sym
+    options[:language] = options[:language]&.to_s&.downcase&.gsub('-ch', '')&.to_s&.to_sym
+    options[:zip_code] = options[:zip_code]&.to_s&.to_sym
+    options[:municipality] = options[:municipality]&.to_s&.to_sym
+    options[:canton] = options[:canton]&.to_s&.to_sym
+
+    options
+  end
+
+  def self.validate_variant(options)
+    unless %i[short full].include? options[:variant]
+      raise ArgumentError, "'Argument variant must be provided. The allowed values are 'short' and 'full'"
+    end
+
+    return unless options[:variant] == :full && !%i[de fr it].include?(options[:language])
+
+    raise ArgumentError,
+          "Language must be provided for variant :full. The allowed values are 'de-CH', 'de', 'fr-CH', 'fr', 'it-CH', 'it'"
+  end
+
+  def self.validate_identifier(options)
+    return unless [options[:zip_code], options[:municipality], options[:canton]].compact.count != 1
+
+    raise ArgumentError, 'Exactly one of the arguments zip_code, municipality or canton must be given'
+  end
+end
+
+require 'swiss_municipality/municipality_data'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiss_municipality
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Denis Müller
@@ -9,12 +9,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2023-11-11 00:00:00.000000000 Z
-dependencies: []
-description: |
-  A gem that provides the following mappings (bidirectionally):
-  - zip code to municipality
-  - zip code to canton
-  - municipality to canton
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A gem to map swiss municipalities to zip codes and cantons.
 email:
 - denis@synerma.ch
 executables: []
@@ -22,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/swiss_municipality.rb
+- lib/swiss_municipality/municipality_data.rb
 homepage: https://rubygems.org/gems/swiss_municipality
 licenses:
 - MIT