wikidata_position_history 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef4815c74d73d50bd3d74a70af9d9b47177d5f3c00e35748892cad201150bed
-  data.tar.gz: fdd1e8b5fa7fe220da78daabdcdc016e8ee729c57648103bbc384860e2ef0ce6
+  metadata.gz: d6133f77b6d65f7decf2dcac481ff36a661a136fb79aff442677669801248437
+  data.tar.gz: dccd3b0a0ed29d89c945756c9efa30e8c02f1c912b4402bec1a45a1c45d81e88
 SHA512:
-  metadata.gz: fe138774ce37cf9258c7f11bfc3bc95cbaafa3811507a2b963d006d1e5982e9257ce754ea46fe47fe7e3eabb95520ae534549badcc6a7c8335ee3ff4368cef82
-  data.tar.gz: 2e266bd52f9bef2e8736bcf566c1ec5e4b7ad10a90f13d4a31f6613411797ff01e4a528263db3b15cce573de10c4c41eb36ea46838f7d16c30748a3a58585564
+  metadata.gz: 0112ca4aae8b9631d86bbf1c2cca5120808e9eb1bb207008e8ba8d221ec0c0c2d16e5f22ec0c59fe9454839c04fcd32bd71f67d1e1793e0d8c053b9d2f1d1471
+  data.tar.gz: 8fd03fc79a37459686524927ba536ab770c22ac4c8d948fde53be1eafba155a3a0f2b072cd8ab8142867e0f57a8138ac62c1535d54bf5330e987bbfc7a2a553e

data/.rubocop.yml

@@ -1,3 +1,7 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
   Exclude:
     - 'Vagrantfile'
@@ -29,6 +33,13 @@ Lint/AssignmentInCondition:
 Naming/ClassAndModuleCamelCase:
   Enabled: false
 
+RSpec/DescribedClass:
+  Enabled: false
+
+# TODO: remove this?
+RSpec/MultipleExpectations:
+  Max: 2
+
 Style/CollectionMethods:
   Enabled: true
 
@@ -52,3 +63,6 @@ Style/TrailingCommaInHashLiteral:
 
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: no_comma
+
+Layout/ClassStructure:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+# [1.6.0] 2020-09-07
+
+## Enhancements
+
+* If a position has an inception date and/or abolition date, those will
+  now also be displayed. (If a position has more than one of either of
+  those — which really shouldn't happen, but sometimes does — then the
+  behaviour may not be particularly sensible. Later evolutions of this
+  feature will hopefully handle that better.)
+
+## Fixes
+
+* Previously, any warnings would be displayed at the bottom of the page,
+  which was fine if this table was the only thing on the page, but would
+  be slightly odd if there was other discussion after it. Now the
+  footnotes are explicitly displayed immediately after the table.
+
+# [1.5.0] 2020-09-06
+
+## Enhancements
+
+* When showing the results for a position from long long ago (such as
+  the High Kings of Ireland), display the dates as "862 – 879" not as
+  "862 – 879"
+* If we only know that someone took (or left) office sometime in a given
+  decade (i.e. at date precision 8), display that as (say) "1930s"
+
+## Fixes
+
+* No longer blows up when a P39 has a start date, but no end date
+
+# [1.4.2] 2020-09-05
+
+## Fixes
+
+* Bring back the warnings when start or end dates are missing.
+
+# [1.4.1] 2020-09-04
+
+## Fixes
+
+* Work around template deployment issue.
+
 # [1.4.0] 2020-09-04
 
 ## Enhancements

data/Rakefile

@@ -8,7 +8,7 @@ require 'rubocop/rake_task'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/*_{spec,test}.rb']
 end
 
 desc 'Run rubocop'

data/lib/query_service.rb

@@ -54,6 +54,8 @@ module QueryService
   class WikidataDate
     include Comparable
 
+    DATELEN = { '11' => 10, '10' => 7, '9' => 4, '8' => 4 }.freeze
+
     def initialize(str, precision)
       @str = str
       @raw_precision = precision.to_s
@@ -66,12 +68,7 @@ module QueryService
     end
 
     def to_s
-      return str if precision == '11'
-      return str[0..6] if precision == '10'
-      return str[0..3] if precision == '9'
-
-      warn "Cannot handle precision #{precision} for #{str}"
-      str
+      precisioned_string.delete_prefix('0')
     end
 
     def empty?
@@ -99,5 +96,18 @@ module QueryService
     def parts
       to_s.split('-')
     end
+
+    def truncated_string
+      return str[0...DATELEN[precision]] if DATELEN.key?(precision)
+
+      warn "Cannot handle precision #{precision} for #{str}"
+      str
+    end
+
+    def precisioned_string
+      return "#{truncated_string}s" if precision == '8'
+
+      truncated_string
+    end
   end
 end

data/lib/sparql/mandates.rb

@@ -63,10 +63,14 @@ module WikidataPositionHistory
     end
 
     def start_date
+      return if start_date_raw.empty?
+
       QueryService::WikidataDate.new(start_date_raw, start_date_precision)
     end
 
     def end_date
+      return if end_date_raw.empty?
+
       QueryService::WikidataDate.new(end_date_raw, end_date_precision)
     end
 

data/lib/sparql/position_data.rb

@@ -28,10 +28,14 @@ module WikidataPositionHistory
     end
 
     def inception_date
+      return if inception_date_raw.empty?
+
       QueryService::WikidataDate.new(inception_date_raw, inception_date_precision)
     end
 
     def abolition_date
+      return if abolition_date_raw.empty?
+
       QueryService::WikidataDate.new(abolition_date_raw, abolition_date_precision)
     end
 

data/lib/wikidata_position_history.rb

@@ -6,6 +6,7 @@ require 'sparql/position_data'
 require 'sparql/bio_data'
 require 'sparql/mandates'
 require 'wikidata_position_history/checks'
+require 'wikidata_position_history/template'
 require 'wikidata_position_history/report'
 require 'wikidata_position_history/version'
 
@@ -21,6 +22,19 @@ module WikidataPositionHistory
     WIKI_USERNAME = ENV['WIKI_USERNAME']
     WIKI_PASSWORD = ENV['WIKI_PASSWORD']
 
+    NO_ID_ERROR = <<~WIKITEXT
+      '''#{WIKI_TEMPLATE_NAME} Error''': You must pass the <code>id</code>
+      parameter to the <code>#{WIKI_TEMPLATE_NAME}</code> template; e.g.
+      <nowiki>{{#{WIKI_TEMPLATE_NAME}|id=Q14211}}</nowiki>
+    WIKITEXT
+
+    MALFORMED_ID_ERROR = <<~WIKITEXT
+      '''#{WIKI_TEMPLATE_NAME} Error''': The <code>id</code> parameter was
+      malformed; it should be Q followed by a number of digits, e.g. as in:
+
+      <nowiki>{{#{WIKI_TEMPLATE_NAME}|id=Q14211}}</nowiki>
+    WIKITEXT
+
     def initialize(mediawiki_site:, page_title:)
       @mediawiki_site = mediawiki_site
       @page_title = page_title.tr('_', ' ')
@@ -32,7 +46,7 @@ module WikidataPositionHistory
 
     def new_content
       return [NO_ID_ERROR, 'The id parameter was missing'] if position_id.empty?
-      return [MALFORMED_ID_ERROR, 'The id parameter was malformed'] unless position_id =~ /^Q\d+$/
+      return [MALFORMED_ID_ERROR, 'The id parameter was malformed'] unless position_id[/^Q\d+$/]
 
       [WikidataPositionHistory::Report.new(position_id).wikitext, "Successfully updated holders of #{position_id}"]
     end
@@ -41,19 +55,6 @@ module WikidataPositionHistory
 
     attr_reader :mediawiki_site, :page_title
 
-    NO_ID_ERROR = <<~EOERROR
-      '''#{WIKI_TEMPLATE_NAME} Error''': You must pass the <code>id</code>
-      parameter to the <code>#{WIKI_TEMPLATE_NAME}</code> template; e.g.
-      <nowiki>{{#{WIKI_TEMPLATE_NAME}|id=Q14211}}</nowiki>
-    EOERROR
-
-    MALFORMED_ID_ERROR = <<~EOERROR
-      '''#{WIKI_TEMPLATE_NAME} Error''': The <code>id</code> parameter was
-      malformed; it should be Q followed by a number of digits, e.g. as in:
-
-      <nowiki>{{#{WIKI_TEMPLATE_NAME}|id=Q14211}}</nowiki>
-    EOERROR
-
     def position_id
       return id_param unless id_param.empty?
 

data/lib/wikidata_position_history/checks.rb

@@ -124,10 +124,10 @@ module WikidataPositionHistory
       def problem?
         return false unless later
 
-        ends = current.end_date
-        return false if ends.empty?
+        next_starts = later.start_date or return false
+        ends = current.end_date or return false
 
-        ends > later.start_date
+        ends > next_starts
       rescue ArgumentError
         true
       end

data/lib/wikidata_position_history/report.rb

@@ -3,6 +3,8 @@
 module WikidataPositionHistory
   # Date for a single mandate row, to be passed to the report template
   class MandateData
+    CHECKS = [Check::MissingFields, Check::WrongPredecessor, Check::WrongSuccessor, Check::Overlap].freeze
+
     def initialize(later, current, earlier)
       @later = later
       @current = current
@@ -20,8 +22,7 @@ module WikidataPositionHistory
 
     def dates
       dates = [current.start_date, current.end_date]
-      # compact doesn't work here, even if we add #nil? to WikidataDate
-      return '' if dates.reject(&:empty?).empty?
+      return '' if dates.compact.empty?
 
       dates.join(' – ')
     end
@@ -36,43 +37,17 @@ module WikidataPositionHistory
 
     private
 
-    CHECKS = [Check::MissingFields, Check::WrongPredecessor, Check::WrongSuccessor, Check::Overlap].freeze
-
     attr_reader :later, :current, :earlier
   end
 
-  # Interface to the ERB Template for the output
-  class ReportTemplate
-    def initialize(file, data)
-      @file = file
-      @data = data
-    end
-
-    def output
-      template.result_with_hash(data)
-    end
-
-    private
-
-    def template_path
-      Pathname.new(file)
-    end
-
-    def template
-      @template ||= ERB.new(template_path.read)
-    end
-
-    attr_reader :file, :data
-  end
-
   # The entire wikitext generated for this report
   class Report
-    def initialize(position_id, template_file = 'report.erb')
+    def initialize(position_id, template_class = ReportTemplate)
       @position_id = position_id
-      @template_file = template_file
+      @template_class = template_class
     end
 
-    attr_reader :position_id, :template_file
+    attr_reader :position_id, :template_class
 
     def wikitext
       return no_items_output if mandates.empty?
@@ -95,6 +70,14 @@ module WikidataPositionHistory
       [header, wikitext].join("\n")
     end
 
+    def template_params
+      {
+        metadata:   metadata,
+        table_rows: table_rows,
+        sparql_url: sparql.wdqs_url,
+      }
+    end
+
     private
 
     def metadata
@@ -128,14 +111,7 @@ module WikidataPositionHistory
     end
 
     def output
-      ReportTemplate.new(template_file, template_params).output
-    end
-
-    def template_params
-      {
-        table_rows: table_rows,
-        sparql_url: sparql.wdqs_url,
-      }
+      template_class.new(template_params).output
     end
 
     def table_rows

data/lib/wikidata_position_history/template.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  # Interface to the ERB Template for the output
+  class ReportTemplate
+    def initialize(data)
+      @data = data
+    end
+
+    def output
+      template.result_with_hash(data)
+    end
+
+    private
+
+    attr_reader :data
+
+    def template
+      @template ||= ERB.new(template_text, nil, '-')
+    end
+
+    def template_text
+      <<~ERB
+        {| class="wikitable" style="text-align: center; border: none;"
+        <% if metadata.abolition_date -%>
+        |-
+        | colspan="3" style="padding:0.5em 2em; border: none; background: #fff; font-size: 1.25em; text-align: right;" | '''Position abolished''': <%= metadata.abolition_date %>
+        | style="padding:0.5em 2em 0.5em 1em; border: none; background: #fff; text-align: left;" | 
+        <% end -%>
+        <% table_rows.map(&:values).each do |mandate, bio| -%>
+        |-
+        | style="padding:0.5em 2em" | <%= mandate.ordinal_string %>
+        | style="padding:0.5em 2em" | <%= bio.map(&:image_link).first %>
+        | style="padding:0.5em 2em" | <span style="font-size: <%= mandate.acting? ? '1.25em; font-style: italic;' : '1.5em' %>; display: block;"><%= mandate.person %></span> <%= mandate.dates %>
+        | style="padding:0.5em 2em 0.5em 1em; border: none; background: #fff; text-align: left;" | \
+        <% mandate.warnings.each do |warning| -%>
+        <span style="display: block">[[File:Pictogram voting comment.svg|15px|link=]]&nbsp;<span style="color: #d33; font-weight: bold; vertical-align: middle;"><%= warning.headline %></span>&nbsp;<ref><%= warning.explanation %></ref></span>\
+        <% end %>
+        <% end -%>
+        <% if metadata.inception_date -%>
+        |-
+        | colspan="3" style="padding:0.5em 2em; border: none; background: #fff; font-size: 1.25em; text-align: right;" | '''Position created''': <%= metadata.inception_date %>
+        | style="padding:0.5em 2em 0.5em 1em; border: none; background: #fff; text-align: left;" | 
+        <% end -%>
+        |}
+
+        <div style="margin-bottom:5px; border-bottom:3px solid #2f74d0; font-size:8pt">
+          <div style="float:right">[<%= sparql_url %> WDQS]</div>
+        </div>
+        {{reflist}}
+      ERB
+    end
+  end
+end

data/lib/wikidata_position_history/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WikidataPositionHistory
-  VERSION = '1.4.0'
+  VERSION = '1.6.0'
 end

data/wikidata_position_history.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.authors               = ['Tony Bowden', 'Mark Longair']
   spec.email                 = ['tony@tmtm.com']
 
-  spec.summary  = 'Generates a wikitext history of a holders of a position in Wikidata'
-  spec.homepage = 'https://github.com/everypolitician/wikidata-position-history/'
+  spec.summary  = 'Generates a table of historic holders of a Wikidata position'
+  spec.homepage = 'https://github.com/tmtmtmtm/wikidata-position-history/'
   spec.license  = 'MIT'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'mediawiki-replaceable-content', '0.2.1'
+  spec.add_runtime_dependency 'mediawiki-replaceable-content', '0.2.2'
   spec.add_runtime_dependency 'rest-client', '~> 2.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'reek', '~> 6.0'
   spec.add_development_dependency 'rubocop', '~> 0.89'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43.2'
   spec.add_development_dependency 'warning', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikidata_position_history
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Tony Bowden
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mediawiki-replaceable-content
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.89'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.43.2
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.8.3
 description:
 email:
 - tony@tmtm.com
@@ -183,10 +211,10 @@ files:
 - lib/wikidata_position_history.rb
 - lib/wikidata_position_history/checks.rb
 - lib/wikidata_position_history/report.rb
+- lib/wikidata_position_history/template.rb
 - lib/wikidata_position_history/version.rb
-- report.erb
 - wikidata_position_history.gemspec
-homepage: https://github.com/everypolitician/wikidata-position-history/
+homepage: https://github.com/tmtmtmtm/wikidata-position-history/
 licenses:
 - MIT
 metadata:
@@ -210,5 +238,5 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
-summary: Generates a wikitext history of a holders of a position in Wikidata
+summary: Generates a table of historic holders of a Wikidata position
 test_files: []

data/report.erb

@@ -1,11 +0,0 @@
-{| class="wikitable" style="text-align: center; border: none;"
-<% table_rows.map(&:values).each do |mandate, bio| %>|-
-| style="padding:0.5em 2em" | <%= mandate.ordinal_string %>
-| style="padding:0.5em 2em" | <%= bio.map(&:image_link).first %>
-| style="padding:0.5em 2em" | <span style="font-size: <%= mandate.acting? ? '1.25em; font-style: italic;' : '1.5em' %>; display: block;"><%= mandate.person %></span> <%= mandate.dates %>
-| style="padding:0.5em 2em 0.5em 1em; border: none; background: #fff; text-align: left;" | <% mandate.warnings.each do |warning| %><span style="display: block">[[File:Pictogram voting comment.svg|15px|link=]]&nbsp;<span style="color: #d33; font-weight: bold; vertical-align: middle;"><%= warning.headline %></span>&nbsp;<ref><%= warning.explanation %></ref></span><% end %>
-<% end %>|}
-
-<div style="margin-bottom:5px; border-bottom:3px solid #2f74d0; font-size:8pt">
-  <div style="float:right">[<%= sparql_url %> WDQS]</div>
-</div>