wikidata_position_history 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9b65df015932c64b9995789de132f401400b8641fe6da6d34529ee08a897f7
-  data.tar.gz: 8eb66f80771e638a76e477db20e48c20cf10aa69843e20660c49a995e7040126
+  metadata.gz: 43d866e3ec1ab0f61a2d8d66d46757dff7ecfd66f4c39bb7a1f90125befb3586
+  data.tar.gz: 9ac67f8d608c4ce7cc746b4e035664cfed07c5501f117d075fb3ab11444a4a69
 SHA512:
-  metadata.gz: 84464bf1eb62fad5dfe9287baa7988ed1e27024b3dce9ceefd1b2a74a79b7ea4fe472151c9b04bc10ed8bba846694553e929ce6f0bd316cff86aee4f09806ec4
-  data.tar.gz: 1b8813db12384488d4719a6858fa31b3dd69b9692b2df9c62c4d861a7c46ab533715fc374bd5b7fd2441b07108257cd782369175318e89afdbb7f5cdea106945
+  metadata.gz: 24824e0ad6207a9a3c8b3e8a547a6eda2dc7e9ee5f6503995dd330c82ecb2bab11a4c4655c3fddd1d8c0235b13bc6d607010901147f305d736e46cdd959c1688
+  data.tar.gz: 257e34dc5e7855720b101d33d2bbf8404f1d4486270667653d1386e077ae4fbdc631b1edba4c7439f3c5f16b4cb80e6932c53d70c136577456d758fe55963b0d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+# Unreleased
+
+# [2.3.0] 2020-10-01
+
+* Edits on Wikidata can now set a botflag if requested, based on the
+  `PHH_BOT` environemnt variable.
+
 # [2.2.0] 2020-09-18
 
 ## Enhancements

data/lib/wikidata_position_history.rb

@@ -16,6 +16,18 @@ require 'date'
 require 'mediawiki/client'
 require 'mediawiki/page'
 
+module MediaWiki
+  # mediawiki-page-replaceable_content does not provide a way to set a
+  # bot flag, so we need to monkey patch it. This should really be
+  # exposed somewhere in its interface.
+  class Client
+    def edit(hash)
+      hash['bot'] = ENV['PHH_BOT'] if ENV.key?('PHH_BOT')
+      wrapped_client.edit(hash)
+    end
+  end
+end
+
 module WikidataPositionHistory
   # Rewrites a Wiki page
   class PageRewriter

data/lib/wikidata_position_history/report.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'report/abstract'
+require_relative 'report/legislator'
+require_relative 'report/mandate'
+require_relative 'report/constituency'
+require_relative 'report/position'
+
 module WikidataPositionHistory
   # A list made up of both direct and indirect claims, where we
   # can tell which came from which, when required
@@ -102,122 +108,32 @@ module WikidataPositionHistory
     end
   end
 
-  # Construct the correct ReportConfig based on the position metadata
-  class ReportConfigFactory
-    def self.config(metadata)
-      return ReportConfig::Constituency.new if metadata.constituency?
-
-      ReportConfig::Position.new
-    end
-
-    private
-
-    attr_reader :metadata
-  end
-
-  # Encapsulates the different configuration for each type of position
-  module ReportConfig
-    # Configuration for 'default' single-holder position
-    class Position
-      def mandates_query
-        SPARQL::MandatesQuery
-      end
-
-      def biodata_query
-        SPARQL::BioQuery
-      end
-    end
-
-    # Configuration for representatives of a single-member constituency
-    class Constituency
-      def mandates_query
-        SPARQL::ConstituencyMandatesQuery
-      end
-
-      def biodata_query
-        SPARQL::ConstituencyBioQuery
-      end
-
-      def multimember_error_template
-        "\n{{PositionHolderHistory/error_multimember}}\n"
-      end
-    end
-  end
-
   # The entire wikitext generated for this report
   class Report
-    def initialize(position_id, template_class = ReportTemplate)
+    def initialize(position_id)
       @position_id = position_id
       @template_class = template_class
     end
 
     attr_reader :position_id, :template_class
 
-    def wikitext
-      return legislator_template if metadata.legislator?
-      return config.multimember_error_template if metadata.constituency? && (metadata.representative_count != 1)
-      return no_items_output if mandates.empty?
-
-      template_class.new(template_params).output
-    end
-
-    def template_params
-      {
-        metadata:   metadata,
-        table_rows: table_rows,
-        sparql_url: sparql.wdqs_url,
-      }
-    end
-
-    private
-
     def metadata
       @metadata ||= Metadata.new(SPARQL::PositionQuery.new(position_id).results_as(PositionRow))
     end
 
-    def biodata
-      @biodata ||= biodata_sparql.results_as(BioRow)
-    end
-
-    def biodata_for(officeholder)
-      biodata.select { |bio| bio.person.id == officeholder.id }
-    end
-
-    def padded_mandates
-      [nil, mandates, nil].flatten(1)
-    end
-
-    def config
-      @config ||= ReportConfigFactory.config(metadata)
-    end
-
-    def sparql
-      @sparql ||= config.mandates_query.new(position_id)
-    end
-
-    def biodata_sparql
-      config.biodata_query.new(position_id)
-    end
-
-    def mandates
-      @mandates ||= sparql.results_as(MandateRow)
-    end
+    def report
+      return Report::Legislator.new(metadata) if metadata.legislator?
+      return Report::Constituency.new(metadata) if metadata.constituency?
 
-    def no_items_output
-      "\n{{PositionHolderHistory/error_no_holders|id=#{position_id}}}\n"
+      Report::Position.new(metadata)
     end
 
-    def legislator_template
-      "\n{{PositionHolderHistory/error_legislator|id=#{position_id}}}\n"
+    def template_params
+      report.template_params
     end
 
-    def table_rows
-      padded_mandates.each_cons(3).map do |later, current, earlier|
-        {
-          mandate: OutputRow::Mandate.new(later, current, earlier),
-          bio:     biodata_for(current.officeholder),
-        }
-      end
+    def wikitext
+      report.wikitext
     end
   end
 end

data/lib/wikidata_position_history/report/abstract.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  class Report
+    # Abstract base class for Reports
+    class Abstract
+      def initialize(metadata)
+        @metadata = metadata
+      end
+
+      protected
+
+      attr_reader :metadata
+
+      def position_id
+        metadata.position.id
+      end
+    end
+  end
+end

data/lib/wikidata_position_history/report/constituency.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  class Report
+    # Report of representatives for a single-member consttuency
+    class Constituency < Mandate
+      def wikitext
+        return multimember_error_template unless metadata.representative_count == 1
+
+        super
+      end
+
+      def mandates_query
+        SPARQL::ConstituencyMandatesQuery
+      end
+
+      def biodata_query
+        SPARQL::ConstituencyBioQuery
+      end
+
+      def multimember_error_template
+        "\n{{PositionHolderHistory/error_multimember}}\n"
+      end
+    end
+  end
+end

data/lib/wikidata_position_history/report/legislator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  class Report
+    # Report for a (presumed multi-member) legislative position
+    class Legislator < Abstract
+      def wikitext
+        "\n{{PositionHolderHistory/error_legislator|id=#{position_id}}}\n"
+      end
+    end
+  end
+end

data/lib/wikidata_position_history/report/mandate.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  class Report
+    # base report where each row is one person holding an office for a period
+    class Mandate < Abstract
+      def wikitext
+        return no_items_output if mandates.empty?
+
+        ReportTemplate.new(template_params).output
+      end
+
+      def template_params
+        {
+          metadata:   metadata,
+          table_rows: table_rows,
+          sparql_url: sparql.wdqs_url,
+        }
+      end
+
+      private
+
+      def biodata
+        @biodata ||= biodata_sparql.results_as(BioRow)
+      end
+
+      def biodata_for(officeholder)
+        biodata.select { |bio| bio.person.id == officeholder.id }
+      end
+
+      def padded_mandates
+        [nil, mandates, nil].flatten(1)
+      end
+
+      def sparql
+        @sparql ||= mandates_query.new(position_id)
+      end
+
+      def biodata_sparql
+        biodata_query.new(position_id)
+      end
+
+      def mandates
+        @mandates ||= sparql.results_as(MandateRow)
+      end
+
+      def no_items_output
+        "\n{{PositionHolderHistory/error_no_holders|id=#{position_id}}}\n"
+      end
+
+      def table_rows
+        padded_mandates.each_cons(3).map do |later, current, earlier|
+          {
+            mandate: OutputRow::Mandate.new(later, current, earlier),
+            bio:     biodata_for(current.officeholder),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/wikidata_position_history/report/position.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WikidataPositionHistory
+  class Report
+    # The default single-person-at-a-time position
+    class Position < Mandate
+      def mandates_query
+        SPARQL::MandatesQuery
+      end
+
+      def biodata_query
+        SPARQL::BioQuery
+      end
+    end
+  end
+end

data/lib/wikidata_position_history/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikidata_position_history
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Tony Bowden
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mediawiki-replaceable-content
@@ -212,6 +212,11 @@ files:
 - lib/wikidata_position_history/checks.rb
 - lib/wikidata_position_history/output_row.rb
 - lib/wikidata_position_history/report.rb
+- lib/wikidata_position_history/report/abstract.rb
+- lib/wikidata_position_history/report/constituency.rb
+- lib/wikidata_position_history/report/legislator.rb
+- lib/wikidata_position_history/report/mandate.rb
+- lib/wikidata_position_history/report/position.rb
 - lib/wikidata_position_history/template.rb
 - lib/wikidata_position_history/version.rb
 - wikidata_position_history.gemspec