statbank_denmark 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe13751db3842c5b7628fa470243b2fe1aba17ca9f0f3dba9b2d98299341929
-  data.tar.gz: 678f45c7a3da9ce45ae4baafe3ecb55acb1d9e5a87fb44f815e64b18b3487ea4
+  metadata.gz: 6d0a8e0c92420913c343d904f90f28636ff241d0a9d218d9ca24c170aff2a6ad
+  data.tar.gz: b9dc4ace09453161698d89f42fded461dc84be0f7d6b18c2c8a40ed9fd2e2c2b
 SHA512:
-  metadata.gz: 13005041a71c6ae61c4edea58c0de8381fe68c37acc1a8743e955544a866f85ab0907a69c70c8fda0d545f850793cffa072e743e9bfa0b502a91a7c8a4dd4c70
-  data.tar.gz: abbc0c2b0002d9a2f7ac6d1d07e09e6022efde6d54484a83f8db0ad1c5866948b9bfc8b0541d3b63df1119e23054242cc86947066afe3bb84efb599fc52791a8
+  metadata.gz: 24f71e8c419da107d3398b516d6813f15dd6f70fb9c718daccd622565435d7aabcc10f22887061969b727f23e0891f5a506fc69c16576951cea25f1b83e20356
+  data.tar.gz: 7416ec1be1476ea1738bc9058a049927b03f6b61308f04be7d1f35a409c52e0f7a1218b1bb5d4e3e809f9d269a1e7fd927019e661f30e09c60170ee4bd9ca74b

data/CHANGELOG

@@ -0,0 +1,50 @@
+# statbank_denmark/CHANGELOG
+
+## 20260928
+
+0.1.1: alias_method :tableinfo, :table_info
+
+1. + StatBankDenmark.tableinfo
+2. + StatBankDenmark::Client#tableinfo
+3. ~ StatBankDenmark::VERSION: /0.1.0/0.1.1/
+
+0.1.0: + StatBankDenmark::Tables
+
+1. + StatBankDenmark::Tables: six crime and population tables and their dimensions, taken from table_info.
+2. + StatBankDenmark::Tables.[], .ids, .dimensions, and .column.
+3. + test/StatBankDenmark/Tables_test.rb
+4. ~ lib/StatBankDenmark.rb: + require_relative './StatBankDenmark/Tables'
+5. ~ statbank_denmark.gemspec: - spec.date
+6. ~ StatBankDenmark::VERSION: /0.0.2/0.1.0/
+
+0.0.2: ~ test/StatBankDenmark_test.rb: /test_helper/helper/
+
+1. It named a file which does not exist, so this test had never run.
+2. ~ StatBankDenmark::VERSION: /0.0.1/0.0.2/
+
+
+## 20260822
+
+0.0.1: + LICENSE
+
+1. + LICENSE
+2. ~ statbank_denmark.gemspec: + 'LICENSE'
+3. ~ StatBankDenmark::VERSION: /0.0.0/0.0.1/
+
+
+## 20250908
+
+0.0.0: + /subjects, /tables, /tableinfo, and /data endpoints; and provide basic table searching.
+
+1. + StatBankDenmark
+2. + StatBankDenmark.subjects: A convenience method StatBankDenmark::Client#subjects.
+3. + StatBankDenmark.tables: A convenience method StatBankDenmark::Client#tables.
+4. + StatBankDenmark.table_info: A convenience method StatBankDenmark::Client#table_info.
+5. + StatBankDenmark.data: A convenience method StatBankDenmark::Client#data.
+6. + StatBankDenmark.search: A convenience method StatBankDenmark::Client#search.
+7. + StatBankDenmark::Client
+8. + StatBankDenmark::Client#subjects: /subjects endpoint
+9. + StatBankDenmark::Client#tables: /tables endpoint
+10. + StatBankDenmark::Client#table_info: /tableinfo endpoint
+11. + StatBankDenmark::Client#data: /data endpoint
+12. + StatBankDenmark::Client.search: Search all tables by string.

data/README.md

@@ -58,6 +58,7 @@ StatBankDenmark.tables(include_inactive: true, subject: 4)
 StatBankDenmark.table_info('STRAF42') # implicitly format: 'json'
 StatBankDenmark.table_info('STRAF42', format: 'json') # explicitly format: 'json'
 StatBankDenmark.table_info('STRAF42', format: 'csv') # format: 'csv'
+StatBankDenmark.tableinfo('STRAF42') # an alias, /tableinfo being the endpoint
 
 # Get data from a specific table
 StatBankDenmark.data('STRAF42') # implicitly format: 'csv'
@@ -114,6 +115,37 @@ client.search('befolkning', lang: 'da') # lang: 'da'
 client.search('BEFOLKNING', lang: 'da') # case insensitive search and lang: 'da'
 ```
 
+### Table metadata
+
+Six crime and population tables and their dimensions. `table_info` answers with
+the values a dimension takes; this is a starting point for choosing which table
+to ask.
+
+```ruby
+# Which tables are described here
+StatBankDenmark::Tables.ids # => ["STRAF42", "STRAF10", "STRAFNA3", "FOLK1C", "FOLK2", "VAN66"]
+
+# What a table is
+StatBankDenmark::Tables['STRAF42'][:name] # => "Decisions, total"
+StatBankDenmark::Tables['straf42'] # the id is taken in any case
+
+# Every dimension of a table, named as the API names them
+StatBankDenmark::Tables.dimensions('STRAF10').keys # => ["OVERTRÆD", "Tid"]
+
+# What a dimension is called once the row is read as Ruby
+StatBankDenmark::Tables.column('STRAF42', 'HERKOMST1') # => :national_origin
+StatBankDenmark::Tables.column('FOLK2', 'STATSB') # => :citizenship
+```
+
+Two things are worth knowing before choosing a table. `HERKOMST1` in `STRAF42`
+and `HERKOMST` in `FOLK1C` and `FOLK2` are not two spellings of one dimension —
+the first is citizenship, the second residence — so they do not substitute. And
+`STRAFNA3` and `VAN66` have no ancestry dimension at all; `IELAND`, country of
+origin, is the nearest either offers.
+
+Asking with a dimension a table has not got answers 400, which reads as the table
+being broken when it is the request that is wrong.
+
 ## Contributing
 
 1. Fork it (https://github.com/thoran/statbank_denmark/fork)

data/lib/StatBankDenmark/Client.rb

@@ -72,6 +72,9 @@ module StatBankDenmark
       )
       handle_response(response)
     end
+    # The endpoint is /tableinfo, which is how StatBank's own documentation names
+    # it, and the spelling anyone arriving from there reaches for first.
+    alias_method :tableinfo, :table_info
 
     def data(
       table_id,

data/lib/StatBankDenmark/Tables.rb

@@ -0,0 +1,95 @@
+# lib/StatBankDenmark/Tables.rb
+# StatBankDenmark::Tables
+
+# Six crime and population tables and their dimensions, taken from table_info on
+# 20260928.  The values each dimension takes are not here: 1693 of them across
+# these six, Tid grows every year, and table_info answers with them already.
+#
+# Two things worth knowing before choosing a table.  HERKOMST1 in STRAF42 and
+# HERKOMST in FOLK1C and FOLK2 are not two spellings of one dimension: the first
+# is citizenship and the second residence, so they do not substitute.  And
+# STRAFNA3 and VAN66 have no ancestry dimension at all — IELAND, country of
+# origin, is the nearest either offers.
+
+module StatBankDenmark
+  module Tables
+    TABLES = {
+      'STRAF42' => {
+        name: 'Decisions, total',
+        dimensions: {
+          'HERKOMST1' => {name: 'national origin', as: :national_origin},
+          'OVERTRÆD' => {name: 'type of offence', as: :type_of_offence},
+          'AFGØRELSE' => {name: 'type of decision', as: :type_of_decision},
+          'ALDER' => {name: 'age', as: :age},
+          'KØN' => {name: 'sex', as: :sex},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+      'STRAF10' => {
+        name: 'Reported criminal offences',
+        dimensions: {
+          'OVERTRÆD' => {name: 'type of offence', as: :type_of_offence},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+      'STRAFNA3' => {
+        name: 'Persons guilty in crimes',
+        dimensions: {
+          'KOEN' => {name: 'sex', as: :sex},
+          'ALDER' => {name: 'age', as: :age},
+          'IELAND' => {name: 'country of origin', as: :country_of_origin},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+      'FOLK1C' => {
+        name: 'Population at the first day of the quarter',
+        dimensions: {
+          'OMRÅDE' => {name: 'region', as: :region},
+          'KØN' => {name: 'sex', as: :sex},
+          'ALDER' => {name: 'age', as: :age},
+          'HERKOMST' => {name: 'ancestry', as: :ancestry},
+          'IELAND' => {name: 'country of origin', as: :country_of_origin},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+      'FOLK2' => {
+        name: 'Population 1. January',
+        dimensions: {
+          'ALDER' => {name: 'age', as: :age},
+          'KØN' => {name: 'sex', as: :sex},
+          'HERKOMST' => {name: 'ancestry', as: :ancestry},
+          'STATSB' => {name: 'citizenship', as: :citizenship},
+          'IELAND' => {name: 'country of origin', as: :country_of_origin},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+      'VAN66' => {
+        name: 'Residence permits (year)',
+        dimensions: {
+          'STATSB' => {name: 'citizenship', as: :citizenship},
+          'OPHOLD' => {name: 'residence permit', as: :residence_permit},
+          'Tid' => {name: 'time', as: :time, time: true},
+        },
+      },
+    }
+
+    class << self
+      def [](table_id)
+        TABLES[table_id.to_s.upcase]
+      end
+
+      def ids
+        TABLES.keys
+      end
+
+      def dimensions(table_id)
+        self[table_id]&.fetch(:dimensions, nil)
+      end
+
+      # What a dimension is called once the row is read as Ruby.
+      def column(table_id, dimension)
+        dimensions(table_id)&.dig(dimension.to_s, :as)
+      end
+    end # class << self
+  end
+end

data/lib/StatBankDenmark/VERSION.rb

@@ -2,5 +2,5 @@
 # StatBankDenmark::VERSION
 
 module StatBankDenmark
-  VERSION = '0.0.2'
+  VERSION = '0.1.1'
 end

data/lib/StatBankDenmark.rb

@@ -3,6 +3,7 @@
 
 require_relative './StatBankDenmark/VERSION'
 require_relative './StatBankDenmark/Client'
+require_relative './StatBankDenmark/Tables'
 
 module StatBankDenmark
   class << self
@@ -17,6 +18,9 @@ module StatBankDenmark
     def table_info(table_id, **options)
       client.table_info(table_id, **options)
     end
+    # The endpoint is /tableinfo, which is how StatBank's own documentation names
+    # it, and the spelling anyone arriving from there reaches for first.
+    alias_method :tableinfo, :table_info
 
     def data(table_id, **options)
       client.data(table_id, **options)

data/statbank_denmark.gemspec

@@ -4,7 +4,6 @@ Gem::Specification.new do |spec|
   spec.name = 'statbank_denmark'
 
   spec.version = StatBankDenmark::VERSION
-  spec.date = '2025-09-09'
 
   spec.summary = "A Ruby client for the StatBank Denmark API."
   spec.description = "A Ruby client for easy access to StatBank; Denmark's official statistics (Danmarks Statistik) REST API."
@@ -17,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7'
 
   spec.files = [
-    'CHANGELOG.txt',
+    'CHANGELOG',
     'Gemfile',
     'LICENSE',
     'README.md',

data/test/StatBankDenmark/Client_test.rb

@@ -132,6 +132,11 @@ describe StatBankDenmark::Client do
       end
     end
 
+    it "answers to tableinfo, which is what the endpoint is called" do
+      _(client).must_respond_to(:tableinfo)
+      _(StatBankDenmark::Client.instance_method(:tableinfo).original_name).must_equal(:table_info)
+    end
+
     it "raises ArgumentError for nil table_id" do
       _(proc{client.table_info(nil)}).must_raise(ArgumentError)
     end

data/test/StatBankDenmark/Tables_test.rb

@@ -0,0 +1,73 @@
+# test/StatBankDenmark/Tables_test.rb
+
+require_relative '../helper'
+
+describe StatBankDenmark::Tables do
+  context "[]" do
+    it "answers a table by its id" do
+      _(StatBankDenmark::Tables['STRAF42'][:name]).must_equal("Decisions, total")
+    end
+
+    it "takes the id in any case, the API naming them in capitals" do
+      _(StatBankDenmark::Tables['straf42']).must_equal(StatBankDenmark::Tables['STRAF42'])
+    end
+
+    it "answers nil for one it does not know" do
+      _(StatBankDenmark::Tables['NOSUCHTABLE']).must_be_nil
+    end
+  end
+
+  context "dimensions" do
+    it "names them as the API does" do
+      _(StatBankDenmark::Tables.dimensions('STRAF10').keys).must_equal(%w{OVERTRÆD Tid})
+    end
+
+    it "marks the time dimension, there being one per table" do
+      StatBankDenmark::Tables.ids.each do |id|
+        timed = StatBankDenmark::Tables.dimensions(id).select{|_, detail| detail[:time]}
+        _(timed.keys).must_equal(%w{Tid}, "#{id} does not mark exactly one time dimension")
+      end
+    end
+  end
+
+  context "column" do
+    it "answers what a dimension is called once read as Ruby" do
+      _(StatBankDenmark::Tables.column('STRAF42', 'HERKOMST1')).must_equal(:national_origin)
+      _(StatBankDenmark::Tables.column('FOLK2', 'STATSB')).must_equal(:citizenship)
+    end
+
+    it "answers nil for a dimension the table has not got" do
+      _(StatBankDenmark::Tables.column('VAN66', 'HERKOMST1')).must_be_nil
+    end
+  end
+
+  # The header comment says these disagreements are real.  Were the API to settle
+  # them, these would fail and the comment would want deleting rather than keeping.
+  context "the disagreements the header records" do
+    it "spells ancestry differently in the crime and population tables" do
+      _(StatBankDenmark::Tables.dimensions('STRAF42')).must_include('HERKOMST1')
+      _(StatBankDenmark::Tables.dimensions('FOLK1C')).must_include('HERKOMST')
+      _(StatBankDenmark::Tables.dimensions('FOLK1C')).wont_include('HERKOMST1')
+    end
+
+    it "spells sex KOEN in STRAFNA3 and KØN everywhere else" do
+      _(StatBankDenmark::Tables.dimensions('STRAFNA3')).must_include('KOEN')
+      _(StatBankDenmark::Tables.dimensions('STRAF42')).must_include('KØN')
+    end
+  end
+
+  context "the tables themselves" do
+    it "names every one it knows" do
+      _(StatBankDenmark::Tables.ids.sort).must_equal(%w{FOLK1C FOLK2 STRAF10 STRAF42 STRAFNA3 VAN66})
+    end
+
+    it "gives every dimension a name and a column" do
+      StatBankDenmark::Tables.ids.each do |id|
+        StatBankDenmark::Tables.dimensions(id).each do |dimension, detail|
+          _(detail[:name]).wont_be_nil("#{id}/#{dimension} has no :name")
+          _(detail[:as]).wont_be_nil("#{id}/#{dimension} has no :as")
+        end
+      end
+    end
+  end
+end

data/test/StatBankDenmark_test.rb

@@ -11,5 +11,10 @@ describe StatBankDenmark do
       _(StatBankDenmark).must_respond_to(:data)
       _(StatBankDenmark).must_respond_to(:search)
     end
+
+    it "answers to tableinfo, which is what the endpoint is called" do
+      _(StatBankDenmark).must_respond_to(:tableinfo)
+      _(StatBankDenmark.method(:tableinfo).original_name).must_equal(:table_info)
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: statbank_denmark
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - thoran
 bindir: bin
 cert_chain: []
-date: 2025-09-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http.rb
@@ -100,7 +100,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.txt
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -108,11 +108,13 @@ files:
 - lib/StatBankDenmark.rb
 - lib/StatBankDenmark/Client.rb
 - lib/StatBankDenmark/Error.rb
+- lib/StatBankDenmark/Tables.rb
 - lib/StatBankDenmark/VERSION.rb
 - lib/statbank_denmark.rb
 - statbank_denmark.gemspec
 - test/StatBankDenmark/Client_test.rb
 - test/StatBankDenmark/Error_test.rb
+- test/StatBankDenmark/Tables_test.rb
 - test/StatBankDenmark/VERSION_test.rb
 - test/StatBankDenmark_test.rb
 - test/helper.rb

data/CHANGELOG.txt

@@ -1,18 +0,0 @@
-# CHANGELOG.md
-
-## [0.0.2] - 2026-09-28
-- ~ test/StatBankDenmark_test.rb: /test_helper/helper/. It named a file which does not exist, so this test had never run.
-- ~ StatBankDenmark::VERSION: /0.0.1/0.0.2/
-
-## [0.0.1] - 2026-08-22
-- + LICENSE: the MIT text, copyright 2025-2026 thoran. The gemspec has declared MIT while the repository carried no licence text at all.
-- ~ statbank_denmark.gemspec: + 'LICENSE' to spec.files, so the gem carries what the declaration claims.
-- ~ StatBankDenmark::VERSION: /0.0.0/0.0.1/
-
-## [0.0.0] - 2025-09-08
-- Initial release
-- subjects(): /subjects endpoint
-- tables(): /tables endpoint
-- tableinfo(): /tableinfo endpoint
-- data(): /data endpoint
-- search(): Search all tables by string.