nl_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d97c1ea88c6eb2592475755ae67a84785ad1bd74
-  data.tar.gz: 5eaf71defddf43d66d8a8af0cf31e11941d459f0
+  metadata.gz: 35a62d543c02fe196a4f120689b5af59bf67e9fb
+  data.tar.gz: a2f585406841c936c16808ee9eb4df73f1072289
 SHA512:
-  metadata.gz: eace9313b2353c36424af8be82ff88cc765c5b1c9ae0879d7f89bf09895d4f10e555121b835d68135660f5bb193dd8e3e023c9b973a636a0b27f00a7ea7b4cf8
-  data.tar.gz: 0a27e52885f00ce66b12ec8ae1f743a765750bcd2e4f6c29a1dff2bf3a9cbbccdea003594b08ddc2c82193623d49f9dc2a9d9c5055c32a5a7d5092ab63badfd2
+  metadata.gz: 892924aa185379fe44533207bc5e3b37c8d8336e7fa152e2af8924049612b7e11246542ace5df3c974c37b4ad1569c825a65ded30e7c610a35b086ae1f9ca929
+  data.tar.gz: 7e6b2201cb49c20cf63caaea88fd100e728d34e4349ba952179bba6eb01502f1f769f36606f6554592308912f7b4611e509d7075259bb481143538d432a2baa9

data/README.md

@@ -18,12 +18,43 @@ Or install it yourself as:
 
     $ gem install nl_api
 
+## Usage
+
+Find municipalities by name:
+
+```ruby
+# Find municipality
+municipality = NlApi::Municipality.find_by(name: 'Rotterdam')
+
+# Get province of municipality
+province = municipality.province
+
+# Get municipalities in the province
+province.municipalities
+# [#<NlApi::Municipality:0x007fa8fc2247a8 @code=482, @name="Alblasserdam", @province_name="Zuid-Holland", @province_code=28>, ...]
+
+# Get the municipalities this one is the result of
+municipality.merged_municipalities
+# Result: [#<NlApi::HistoricMunicipality:0x007fa8fbc37ed0 @code=1037, @name="Charlois", @code_after_merge=599>, ...]
+
+# Find history municipality
+historic_municipality = NlApi::HistoricMunicipality.find_by(name: 'Overschie')
+historic_municipality.municipality_after_merge
+# Result: #<NlApi::Municipality:0x007fa8fc1cf5a0 @code=599, @name="Rotterdam", @province_name="Zuid-Holland", @province_code=28>
+
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Changelog
+
+  - v1.1 Add class to deal with no longer existing municipalities
+  - v1.0 first release
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nl_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/nl_api.rb

@@ -1,4 +1,5 @@
 require "nl_api/version"
+require "nl_api/historic_municipality"
 require "nl_api/municipality"
 require "nl_api/province"
 module NlApi

data/lib/nl_api/historic_municipality.rb

@@ -0,0 +1,68 @@
+class NlApi::HistoricMunicipality
+  attr_reader :code, :name, :code_after_merge
+
+  def initialize(attributes)
+    @code = attributes[:code]
+    @name = attributes[:name]
+    @code_after_merge = attributes[:code_after_merge]
+  end
+
+  def province
+    municipality_after_merge.province
+  end
+
+  def municipality_after_merge
+    has_merged? ? NlApi::Municipality.find_by(code: code_after_merge) : nil
+  end
+
+  def has_merged?
+    !!code_after_merge
+  end
+
+  class << self
+    include Enumerable
+    require 'csv'
+
+    attr_writer :filename
+
+    def filename
+      @filename ||= '../../data/BAG_gemeententabel.csv'
+    end
+
+    def path
+      File.join(File.dirname(File.expand_path(__FILE__)), filename)
+    end
+
+    def read_csv
+      @store ||= CSV.read(path, headers: true, col_sep: ',').map{ |line|
+      NlApi::HistoricMunicipality.new(
+        code: line[0].to_i,
+        name: line[1],
+        code_after_merge: line[2].to_i
+      ) }
+    end
+
+    def all
+      @all ||= read_csv
+    end
+
+    def each(&block)
+      all.each(&block)
+      self
+    end
+
+    def find_by(where)
+      field = where.keys.first
+      value = where.values.first
+
+      find{ |i| i.send(field.to_sym) == value }
+    end
+
+    def find_all_by(where)
+      field = where.keys.first
+      value = where.values.first
+
+      find_all{ |i| i.send(field.to_sym) == value }
+    end
+  end
+end

data/lib/nl_api/municipality.rb

@@ -12,6 +12,10 @@ class NlApi::Municipality
     self.class.provinces[province_code] ||= NlApi::Province.new(province_code, province_name)
   end
 
+  def merged_municipalities
+    NlApi::HistoricMunicipality.find_all_by(code_after_merge: code)
+  end
+
   class << self
     include Enumerable
     require 'csv'

data/lib/nl_api/version.rb

@@ -1,3 +1,3 @@
 module NlApi
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nl_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Maarten van Vliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - data/BAG_gemeententabel.csv
 - data/gemeentenalfabetisch2016.csv
 - lib/nl_api.rb
+- lib/nl_api/historic_municipality.rb
 - lib/nl_api/municipality.rb
 - lib/nl_api/province.rb
 - lib/nl_api/version.rb
@@ -101,4 +102,3 @@ signing_key:
 specification_version: 4
 summary: Simple wrapper for CBS municipality data
 test_files: []
-has_rdoc: