wikidata_position_history 1.3.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018cdd5d51eee83b0738a0b84f32d92259bf4665fe25894b2d005f308c033466'
-  data.tar.gz: bf630179eacfe1e68b88dacd268ae4c1e35efdabfc0149963338cf9de3a20567
+  metadata.gz: 3cc474575654a299ceef536c692402288d072d7caf3d9bd62de17d9027bcd287
+  data.tar.gz: 2e6324cc0e272b5b747d65eab1aaa32f1c621a6e672487312f616afd9449d374
 SHA512:
-  metadata.gz: cb6dd44e9a746bf425a5ef8199d7bd10891ea887d3f61dab6fff676ecdb21ceec19da22ac585c0ac3c61d70a4deeb26c5fd1f602ab45d49aaa6595ca4aa0dccd
-  data.tar.gz: 583747329e14ed0f7292c5f7e71e1e4bafe63ca83dd028786449fa582af0b68880e90287e1028b249eeef28f125f54d3b7ae0d6940048cc122901f57b52e2aa5
+  metadata.gz: 709a0916f16fd2a890df7ae3e2873968a23f0640945cf756785eb59bf8d7589b578fb2bd51e6263b36de729e20ea2a200cfcd9731ee6957a2e539169cacb0cbf
+  data.tar.gz: 3dbe5d81f0fe77f6487ce0109b91205d3b4361e13c70b48f93464ea4a323d06f3c07b70ea263e4817592cedf1b632e10b10be832dd03a92114f59505b53dae5a

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,38 @@
 # Changelog
 
+# [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
+
+* Add an image column.
+* Improve the warning for inconsistent successor/predecessor values.
+
 # [1.3.4] - 2020-09-01
 
 ## Fixes

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/bio_data.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  module SPARQL
+    # SPARQL for fetching biographical about all holders of a position
+    #
+    # This is distinct from the mandate query itself to avoid complex
+    # GROUP BY scenarios where people have multiple values for
+    # biographical properties.
+    class BioData < ItemQuery
+      def raw_sparql
+        <<~SPARQL
+          # holder-biodata
+
+          SELECT DISTINCT ?item ?image
+          WHERE {
+            ?item wdt:P31 wd:Q5 ; p:P39/ps:P39 wd:%s .
+            OPTIONAL { ?item wdt:P18 ?image }
+          }
+          ORDER BY ?item
+        SPARQL
+      end
+    end
+  end
+
+  # Represents a single row returned from the Position query
+  class BioData
+    def initialize(row)
+      @row = row
+    end
+
+    def person
+      QueryService::WikidataItem.new(row.dig(:item, :value))
+    end
+
+    def image_title
+      return if image_url.to_s.empty?
+
+      image_url.split('/').last
+    end
+
+    def image_link(size = 75)
+      return '' unless image_title
+
+      "[[File:#{image_title}|#{size}px]]"
+    end
+
+    private
+
+    attr_reader :row
+
+    def image_url
+      row.dig(:image, :value)
+    end
+  end
+end

data/lib/sparql/mandates.rb

@@ -7,6 +7,7 @@ module WikidataPositionHistory
       def raw_sparql
         <<~SPARQL
           # position-mandates
+
           SELECT DISTINCT ?ordinal ?item ?start_date ?start_precision ?end_date ?end_precision ?prev ?next ?nature
           WHERE {
             ?item wdt:P31 wd:Q5 ; p:P39 ?posn .
@@ -19,7 +20,6 @@ module WikidataPositionHistory
             OPTIONAL { ?posn pq:P1366|pq:P156 ?next }
             OPTIONAL { ?posn pq:P1545 ?ordinal }
             OPTIONAL { ?posn pq:P5102 ?nature }
-            OPTIONAL { ?posn pq:P5102 ?nature }
           }
           ORDER BY DESC(?start_date)
         SPARQL
@@ -37,8 +37,13 @@ module WikidataPositionHistory
       row.dig(:ordinal, :value)
     end
 
+    def officeholder
+      QueryService::WikidataItem.new(row.dig(:item, :value))
+    end
+
+    # TODO: rename or remove. 'item' is meaningless/ambiguous
     def item
-      QueryService::WikidataItem.new(row.dig(:item, :value)).qlink
+      officeholder.qlink
     end
 
     def prev
@@ -58,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/wikidata_position_history.rb

@@ -3,8 +3,10 @@
 require 'query_service'
 require 'sparql/item_query'
 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'
 
@@ -20,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('_', ' ')
@@ -31,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
@@ -40,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

@@ -100,7 +100,7 @@ module WikidataPositionHistory
       end
 
       def possible_explanation
-        "#{current.item} has a {{P|1365}} of #{predecessor}, which differs from #{earlier.item}"
+        "#{current.item} has a {{P|1365}} of #{predecessor}, but follows #{earlier.item} here"
       end
     end
 
@@ -115,7 +115,7 @@ module WikidataPositionHistory
       end
 
       def possible_explanation
-        "#{current.item} has a {{P|1366}} of #{successor}, which differs from #{later.item}"
+        "#{current.item} has a {{P|1366}} of #{successor}, but is followed by #{later.item} here"
       end
     end
 
@@ -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

@@ -1,95 +1,62 @@
 # frozen_string_literal: true
 
 module WikidataPositionHistory
-  # A single output row of Wikitext for an officeholding
-  class MandateReport
+  # 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
       @earlier = earlier
     end
 
-    def output
-      [row_start, ordinal_cell, member_cell, warnings_cell].join("\n")
-    end
-
-    private
-
-    CHECKS = [Check::MissingFields, Check::WrongPredecessor, Check::WrongSuccessor, Check::Overlap].freeze
-
-    WARNING_LAYOUT = [
-      '<span style="display: block">[[File:Pictogram voting comment.svg|15px|link=]]&nbsp;',
-      '<span style="color: #d33; font-weight: bold; vertical-align: middle;">%s</span>&nbsp;',
-      '<ref>%s</ref></span>'
-    ].join
-
-    attr_reader :later, :current, :earlier
-
-    def row_start
-      '|-'
-    end
-
-    def ordinal_cell
-      %(| style="padding:0.5em 2em" | #{ordinal_string})
-    end
-
     def ordinal_string
       ordinal = current.ordinal or return ''
-      ordinal.concat('.')
+      "#{ordinal}."
     end
 
-    def member_style
-      return 'font-size: 1.25em; display: block; font-style: italic;' if current.acting?
-
-      'font-size: 1.5em; display: block;'
+    def person
+      current.item
     end
 
-    def member_cell
-      format('| style="padding:0.5em 2em" | <span style="%s">%s</span> %s',
-             member_style, membership_person, membership_dates)
-    end
+    def dates
+      dates = [current.start_date, current.end_date]
+      return '' if dates.compact.empty?
 
-    def warnings_cell
-      format('| style="padding:0.5em 2em 0.5em 1em; border: none; background: #fff; text-align: left;" | %s',
-             combined_warnings)
+      dates.join(' – ')
     end
 
-    def combined_warnings
-      CHECKS.map do |check_class|
-        check = check_class.new(later, current, earlier)
-        format(WARNING_LAYOUT, check.headline, check.explanation) if check.problem?
-      end.join
+    def acting?
+      current.acting?
     end
 
-    def membership_person
-      current.item
+    def warnings
+      CHECKS.map { |klass| klass.new(later, current, earlier) }.select(&:problem?)
     end
 
-    def membership_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?
+    private
 
-      dates.join(' – ')
-    end
+    attr_reader :later, :current, :earlier
   end
 
   # The entire wikitext generated for this report
   class Report
-    def initialize(subject_item_id)
-      @subject_item_id = subject_item_id
+    def initialize(position_id, template_class = ReportTemplate)
+      @position_id = position_id
+      @template_class = template_class
     end
 
-    attr_reader :subject_item_id
+    attr_reader :position_id, :template_class
 
     def wikitext
       return no_items_output if mandates.empty?
 
-      [table_header, table_rows, table_footer, wdqs_section].compact.join("\n")
+      output
     end
 
     def header
-      "== {{Q|#{subject_item_id}}} officeholders #{position_dates} =="
+      "== {{Q|#{position_id}}} officeholders #{position_dates} =="
     end
 
     def position_dates
@@ -108,7 +75,15 @@ module WikidataPositionHistory
     def metadata
       # TODO: we might get more than one response, if a position has
       # multiple dates
-      @metadata ||= SPARQL::PositionData.new(subject_item_id).results_as(PositionData).first
+      @metadata ||= SPARQL::PositionData.new(position_id).results_as(PositionData).first
+    end
+
+    def biodata
+      @biodata ||= SPARQL::BioData.new(position_id).results_as(BioData)
+    end
+
+    def biodata_for(officeholder)
+      biodata.select { |bio| bio.person.id == officeholder.id }
     end
 
     def padded_mandates
@@ -116,7 +91,7 @@ module WikidataPositionHistory
     end
 
     def sparql
-      @sparql ||= SPARQL::Mandates.new(subject_item_id)
+      @sparql ||= SPARQL::Mandates.new(position_id)
     end
 
     def mandates
@@ -124,32 +99,26 @@ module WikidataPositionHistory
     end
 
     def no_items_output
-      "\n{{PositionHolderHistory/error_no_holders|id=#{subject_item_id}}}\n"
+      "\n{{PositionHolderHistory/error_no_holders|id=#{position_id}}}\n"
     end
 
-    def table_header
-      '{| class="wikitable" style="text-align: center; border: none;"'
-    end
-
-    def table_footer
-      "|}\n"
-    end
-
-    def wdqs_section
-      wdqs_div % sparql.wdqs_url
+    def output
+      template_class.new(template_params).output
     end
 
-    def wdqs_div
-      <<~HTML
-        <div style="margin-bottom:5px; border-bottom:3px solid #2f74d0; font-size:8pt">
-          <div style="float:right">[%s WDQS]</div>
-        </div>
-      HTML
+    def template_params
+      {
+        table_rows: table_rows,
+        sparql_url: sparql.wdqs_url,
+      }
     end
 
     def table_rows
       padded_mandates.each_cons(3).map do |later, current, earlier|
-        MandateReport.new(later, current, earlier).output
+        {
+          mandate: MandateData.new(later, current, earlier),
+          bio:     biodata_for(current.officeholder),
+        }
       end
     end
   end

data/lib/wikidata_position_history/template.rb

@@ -0,0 +1,38 @@
+# 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)
+    end
+
+    def template_text
+      <<~ERB
+        {| 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>
+      ERB
+    end
+  end
+end

data/lib/wikidata_position_history/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WikidataPositionHistory
-  VERSION = '1.3.4'
+  VERSION = '1.5.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.3.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Tony Bowden
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2020-09-06 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
@@ -176,15 +204,17 @@ files:
 - exe/position-history-for-item
 - exe/update_wikidata_page
 - lib/query_service.rb
+- lib/sparql/bio_data.rb
 - lib/sparql/item_query.rb
 - lib/sparql/mandates.rb
 - lib/sparql/position_data.rb
 - 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
 - wikidata_position_history.gemspec
-homepage: https://github.com/everypolitician/wikidata-position-history/
+homepage: https://github.com/tmtmtmtm/wikidata-position-history/
 licenses:
 - MIT
 metadata:
@@ -208,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: []