mediawiki-replaceable-content 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cba1d4d392f832817deceae7de443e872a0eeafa4c6321b1e5eab31baae996c
+  data.tar.gz: ce45f42317be4eb3ae5dca06d900e427d5b66fa9f42da8b9ac077495eaddcd01
+SHA512:
+  metadata.gz: 98f954935950afbd03bfed2bee7e7d0f5805d86147a6661c6361b801087ab983327ff9525ac72b540f0bb1ab1e201d5f8d082e690433ebd729365e397e44f6bb
+  data.tar.gz: 2f4a1089e4831f9f3a0bf355f1419982a62270bac5f2bbe3da81f5ac1b4b3ffb28fdf6e43bb391f7d59357878ace77c4fe4a16170638808f31ef22520e3ce7d0

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.5
+        bundler: 1
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rubocop-https---raw-githubusercontent-com-everypolitician-everypolitician-data-master--rubocop-base-yml

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  Exclude:
+    - 'Vagrantfile'
+    - 'vendor/**/*'
+    - 'exe/**/*'
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/test_helper.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'test/**/*.rb'
+
+Layout/LineLength:
+  Max: 150
+  Exclude:
+    - 'test/**/*.rb'
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+before_install: gem install bundler -v 1.15.3
+script:
+  - bundle exec rake
+  - bash <(curl -fsSL https://github.com/everypolitician/ensure-regression-tests/raw/master/ensure-regression-tests)

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [0.2.1] - 2020-00-01
+
+## Fixes
+
+Replacement page content can now contain percentage signs.
+
+# [0.2.0] - 2020-00-01
+
+The minimum allowed ruby verson is now 2.5
+
+# [0.1.4] - 2018-11-27
+
+Better handling for a template not being found.
+
+# [0.1.3] - 2017-11-03
+
+Support numbered and anonymous parameters

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mediawiki-replaceable-content.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Longair
+Copyright (c) 2020 Tony Bowden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# MediaWiki::Page::ReplaceableContent
+
+This gem provides a class,
+`MediaWiki::Page::ReplaceableContent`, to help you
+programmatically rewrite MediaWiki pages based on the parameters
+of a template tag in that page. (This is a model used by the
+[Listeria](https://tools.wmflabs.org/listeria/) bot, for
+example.)
+
+See the "Usage" section below for an example.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mediawiki-replaceable-content'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mediawiki-replaceable-content
+
+## Usage
+
+To use the `ReplaceableContent` class, you must first create a
+`Client` object, which specifies the MediaWiki site on which you
+want to rewrite a page, and the username and password for
+authentication.
+
+```ruby
+require 'mediawiki/client'
+
+client = MediaWiki::Client.new(
+  site:     'www.wikidata.org',
+  username: ENV['WIKI_USERNAME'],
+  password: ENV['WIKI_PASSWORD']
+)
+```
+
+Then you can use that to create a `ReplaceableContent` class,
+which specifies a particular page and the template on that page
+that your content will be placed directly after:
+
+```ruby
+require 'mediawiki/page'
+
+section = MediaWiki::Page::ReplaceableContent.new(
+  client:   client,
+  title:    'User:Mhl20/Fibonnacci test',
+  template: 'Fibonacci'
+)
+```
+
+For example, suppose that page at
+https://www.wikidata.org/wiki/User:Mhl20/Fibonnacci_test had the
+following content:
+
+```
+Here are some Fibonacci numbers:
+
+{{Fibonacci
+|max_fib=10
+}}
+
+You can find more about them here:
+https://en.wikipedia.org/wiki/Fibonacci_number
+```
+
+Then you could rewrite it, using the `ReplaceableContent` object
+created above, with:
+
+```ruby
+def fibonacci_numbers(limit)
+  numbers = []
+  i, j = 0, 1
+  while i <= limit
+    numbers << i
+    i, j = j, i + j
+  end
+  numbers
+end
+
+def wikitext_fibonacci_rows(limit)
+  fibs = fibonacci_numbers(limit)
+  "|-\n" + 0.upto(fibs.length - 1).map { |f| "| ''F''<sub>#{f}</sub>\n" }.join('') +
+    "|-\n" + fibs.map { |n| "| #{n}\n" }.join('')
+end
+
+def wikitext_fibonacci(limit)
+  "=== Some Fibonacci numbers ===\n:{| class=\"wikitable\"\n" +
+    wikitext_fibonacci_rows(limit) +
+    '|}'
+end
+
+limit = Integer(section.params[:max_fib])
+section.replace_output(
+  wikitext_fibonacci(limit),
+  "Rewrote with numbers up to #{limit}"
+)
+```
+
+The result of running that would be that the page had the
+following wikitext:
+
+```
+Here are some Fibonacci numbers:
+
+{{Fibonacci
+|max_fib=10
+}}
+=== Some Fibonacci numbers ===
+:{| class="wikitable"
+|-
+| ''F''<sub>0</sub>
+| ''F''<sub>1</sub>
+| ''F''<sub>2</sub>
+| ''F''<sub>3</sub>
+| ''F''<sub>4</sub>
+| ''F''<sub>5</sub>
+| ''F''<sub>6</sub>
+|-
+| 0
+| 1
+| 1
+| 2
+| 3
+| 5
+| 8
+|}
+<!-- OUTPUT END Rewrote with numbers up to 10 -->
+
+You can find more about them here:
+https://en.wikipedia.org/wiki/Fibonacci_number
+```
+
+On subsequent uses, only the text between the template tag and
+the `<!-- OUTPUT END ... --->` comment will be rewritten.
+
+If you need to rely on the previous content, you can get that
+with `section.existing_content`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tmtmtmtm/mediawiki-replaceable-content
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## History
+
+This was originally developed as part of a [Wikimedia Foundation grant-funded
+project](https://meta.wikimedia.org/wiki/Grants:Project/mySociety/EveryPolitician).
+
+This version is now maintained independently by Tony Bowden.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mediawiki/client'
+require 'mediawiki/page'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/fibonacci_example

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+
+require 'mediawiki/client'
+require 'mediawiki/page'
+
+client = MediaWiki::Client.new(
+  site:     'www.wikidata.org',
+  username: ENV['WIKI_USERNAME'],
+  password: ENV['WIKI_PASSWORD']
+)
+
+section = MediaWiki::Page::ReplaceableContent.new(
+  client:   client,
+  title:    'User:Mhl20/Fibonnacci test',
+  template: 'Fibonacci'
+)
+
+def fibonacci_numbers(limit)
+  numbers = []
+  i = 0
+  j = 1
+  while i <= limit
+    numbers << i
+    i = j
+    j = i + j
+  end
+  numbers
+end
+
+def wikitext_fibonacci_rows(limit)
+  fibs = fibonacci_numbers(limit)
+  "|-\n" + 0.upto(fibs.length - 1).map { |f| "| ''F''<sub>#{f}</sub>\n" }.join('') +
+    "|-\n" + fibs.map { |n| "| #{n}\n" }.join('')
+end
+
+def wikitext_fibonacci(limit)
+  "=== Some Fibonacci numbers ===\n:{| class=\"wikitable\"\n" +
+    wikitext_fibonacci_rows(limit) +
+    '|}'
+end
+
+limit = Integer(section.params[:max_fib])
+section.replace_output(
+  wikitext_fibonacci(limit),
+  "Rewrote with numbers up to #{limit}"
+)

data/lib/mediawiki/client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'mediawiki_api'
+
+module MediaWiki
+  class Client
+    def initialize(site:, username:, password:)
+      @site = site
+      @username = username
+      @password = password
+    end
+
+    extend Forwardable
+    def_delegators :wrapped_client, :edit, :get_wikitext
+
+    private
+
+    attr_accessor :site, :username, :password
+
+    def wrapped_client
+      @wrapped_client ||= MediawikiApi::Client.new("https://#{site}/w/api.php").tap do |c|
+        result = c.log_in(username, password)
+        raise "MediawikiApi::Client#log_in failed: #{result}" if result['result'] != 'Success'
+      end
+    end
+  end
+end

data/lib/mediawiki/page.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'mediawiki_api'
+
+module MediaWiki
+  module Page
+    class ReplaceableContent
+      NAMED_TEMPLATE_PARAM_RE = /(.*?)=(.*)/m.freeze
+
+      TemplateNotFoundError = Class.new(StandardError)
+
+      def initialize(client:, title:, template:)
+        @client = client
+        @title = title
+        @template = template
+      end
+
+      def existing_content
+        page_parts[:to_replace]
+      end
+
+      def reassemble_page(new_content, run_comment = '')
+        format("%<before>s{{%<template_name>s%<parameters>s}}\n%<new_content>s\n<!-- OUTPUT END %<run_comment>s -->%<keep>s",
+               page_parts.merge(new_content: new_content, run_comment: run_comment))
+      end
+
+      def replace_output(new_content, run_comment = '')
+        new_wikitext = reassemble_page(new_content, run_comment)
+        client.edit(title: title, text: new_wikitext)
+      end
+
+      def param_key_value_array(key, value)
+        [
+          if key.strip =~ /^\d+$/
+            Integer(Regexp.last_match[0])
+          else
+            key.strip.to_sym
+          end,
+          value
+        ]
+      end
+
+      def params
+        # Returns the named parameters from the template tag as a Hash
+        # where the keys are symbolized versions of the parameter
+        # names.
+        # FIXME: untemplate these using the MediaWiki API before
+        # returning them.
+        all_parameters.map do |p|
+          m = NAMED_TEMPLATE_PARAM_RE.match(p)
+          param_key_value_array(*m.captures) if m
+        end.compact.to_h
+      end
+
+      def anonymous_params
+        # FIXME: untemplate these using the MediaWiki API before
+        # returning them.
+        all_parameters.map { |p| NAMED_TEMPLATE_PARAM_RE =~ p ? nil : p }.compact
+      end
+
+      private
+
+      attr_accessor :client, :title, :template
+
+      def wikitext
+        @wikitext ||= client.get_wikitext(title).body
+      end
+
+      def template_re
+        # FIXME: there are obviously better ways of doing this parsing
+        # than with a regular expression. e.g. there is an EBNF
+        # version of the MediaWiki grammar which we could use to
+        # generate a proper parser.
+        /
+          ^(?<before>.*?)
+          \{\{
+          (?<template_name>#{Regexp.quote(template)})
+          (?<parameters>.*?)
+          \}\}
+          (?<after>.*)$
+        /xm
+      end
+
+      def page_parts
+        return @page_parts if @page_parts
+
+        m = template_re.match(wikitext)
+        raise TemplateNotFoundError, "The template '#{template}' was not found in '#{title}'" unless m
+
+        parts = matchdata_to_h(m)
+        @page_parts = parts.merge(split_after(parts[:after]))
+      end
+
+      def split_after(after)
+        # The part of the page after the template may or may not have
+        # the special HTML comment that marks the end of the previous
+        # output; if it's not there we insert the new content right
+        # after the template tag.
+        if after =~ /^(?<to_replace>.*?)\n<!-- OUTPUT END (?:.*?)-->(?<keep>.*)/m
+          matchdata_to_h(Regexp.last_match)
+        else
+          { to_replace: '', keep: after }
+        end
+      end
+
+      def all_parameters
+        # This returns all parameters, including anonymous, numbered and
+        # named parameters. (Though we only handle named parameters at
+        # the moment.)
+        page_parts[:parameters].split('|').select do |s|
+          s.strip!
+          s.empty? ? nil : s
+        end
+      end
+
+      def matchdata_to_h(matchdata)
+        matchdata.names.map(&:to_sym).zip(matchdata.captures).to_h
+      end
+    end
+  end
+end

data/mediawiki-page-replaceable_content.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.name          = 'mediawiki-replaceable-content'
+  spec.version       = '0.2.1'
+  spec.authors       = ['Tony Bowden', 'Mark Longair']
+  spec.email         = ['tony@tmtm.com']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'Rewrite content after a template tag based on the template parameters'
+  spec.homepage      = 'https://github.com/tmtm/mediawiki-replaceable-content'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mediawiki_api', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: mediawiki-replaceable-content
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Tony Bowden
+- Mark Longair
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mediawiki_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- tony@tmtm.com
+executables:
+- fibonacci_example
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fibonacci_example
+- lib/mediawiki/client.rb
+- lib/mediawiki/page.rb
+- mediawiki-page-replaceable_content.gemspec
+homepage: https://github.com/tmtm/mediawiki-replaceable-content
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: Rewrite content after a template tag based on the template parameters
+test_files: []