dosage/dosagelib/plugins/x.py

# SPDX-License-Identifier: MIT
# Copyright (C) 2004-2008 Tristan Seligmann and Jonathan Jacobs
# Copyright (C) 2012-2014 Bastian Kleineidam
# Copyright (C) 2015-2022 Tobias Gruetzmacher
# Copyright (C) 2019-2020 Daniel Ring
from ..scraper import ParserScraper
from ..helpers import bounceStarter


class xkcd(ParserScraper):
    url = 'https://xkcd.com/'
    stripUrl = url + '%s/'
    firstStripUrl = stripUrl % '1'
    imageSearch = '//div[@id="comic"]//img'
    textSearch = imageSearch + '/@title'
    prevSearch = '//a[@rel="prev"]'
    nextSearch = '//a[@rel="next"]'
    starter = bounceStarter
    help = 'Index format: n (unpadded)'

    def namer(self, image_url, page_url):
        index = int(page_url.rstrip('/').rsplit('/', 1)[-1])
        name = image_url.rsplit('/', 1)[-1].split('.')[0]
        return '%04d-%s' % (index, name)

    def imageUrlModifier(self, url, data):
        if url and '/large/' in data:
            return url.replace(".png", "_large.png")
        return url
Update file headers The default encoding for source files is UTF-8 since Python 3, so we can drop all encoding headers. While we are at it, just replace them with SPDX headers. 2020-04-18 11:45:44 +00:00			`# SPDX-License-Identifier: MIT`
Fixup copyright years. 2016-10-28 22:21:41 +00:00			`# Copyright (C) 2004-2008 Tristan Seligmann and Jonathan Jacobs`
Updated copyright. 2014-01-05 15:50:57 +00:00			`# Copyright (C) 2012-2014 Bastian Kleineidam`
Deprecate underscore-prefixed parent classes This is trying to strike a balance between updating as much existing classes as possible, but not making the diff too big... 2022-06-06 10:08:32 +00:00			`# Copyright (C) 2015-2022 Tobias Gruetzmacher`
Add self to authors list, update copyright headers 2020-01-13 06:34:05 +00:00			`# Copyright (C) 2019-2020 Daniel Ring`
Deprecate underscore-prefixed parent classes This is trying to strike a balance between updating as much existing classes as possible, but not making the diff too big... 2022-06-06 10:08:32 +00:00			`from ..scraper import ParserScraper`
A lot of refactoring. 2012-10-11 10:03:12 +00:00			`from ..helpers import bounceStarter`
Initial commit to Github. 2012-06-20 19:58:13 +00:00
Some minor style fixes. 2017-05-14 22:54:02 +00:00
Deprecate underscore-prefixed parent classes This is trying to strike a balance between updating as much existing classes as possible, but not making the diff too big... 2022-06-06 10:08:32 +00:00			`class xkcd(ParserScraper):`
Replace online tests with mocks. We want to test our code, not the comic modules. 2017-10-12 22:34:37 +00:00			`url = 'https://xkcd.com/'`
Always have an url attribute in comic scrapers. 2013-02-04 20:00:26 +00:00			`stripUrl = url + '%s/'`
Add firstStripUrls. 2013-04-10 21:57:09 +00:00			`firstStripUrl = stripUrl % '1'`
Fix xkcd pages where comic is linked 2019-12-05 06:10:49 +00:00			`imageSearch = '//div[@id="comic"]//img'`
Minor fixes to several strips (#158) * Fix Twokinds * Fix XKCD * Fix Unsounded * Fix SluggyFreelance * Fix Oglaf * Fix missing and incorrect renames * Fix WLP/PeterIsTheWolf{General,Adult} 2020-04-06 11:23:23 +00:00			`textSearch = imageSearch + '/@title'`
xkcd now hone with xpaths 2016-08-18 09:28:25 +00:00			`prevSearch = '//a[@rel="prev"]'`
			`nextSearch = '//a[@rel="next"]'`
Minor fixes to several strips (#158) * Fix Twokinds * Fix XKCD * Fix Unsounded * Fix SluggyFreelance * Fix Oglaf * Fix missing and incorrect renames * Fix WLP/PeterIsTheWolf{General,Adult} 2020-04-06 11:23:23 +00:00			`starter = bounceStarter`
Initial commit to Github. 2012-06-20 19:58:13 +00:00			`help = 'Index format: n (unpadded)'`

Refactor: Make namer a method. When #42 is realized, the naming of files might differ between comic modules, so the namer's logical location is the instance, not the class. 2016-04-21 06:20:49 +00:00			`def namer(self, image_url, page_url):`
Skip non-image on xkcd. 2016-04-05 22:47:47 +00:00			`index = int(page_url.rstrip('/').rsplit('/', 1)[-1])`
			`name = image_url.rsplit('/', 1)[-1].split('.')[0]`
Minor fixes to several strips (#158) * Fix Twokinds * Fix XKCD * Fix Unsounded * Fix SluggyFreelance * Fix Oglaf * Fix missing and incorrect renames * Fix WLP/PeterIsTheWolf{General,Adult} 2020-04-06 11:23:23 +00:00			`return '%04d-%s' % (index, name)`
Store large xkcd images. 2013-12-04 16:56:54 +00:00
Refactor: url modifiers to normal methods. As before, to implement #42 these might want to access information from the instance, so they should be normal methods. 2016-04-21 19:28:41 +00:00			`def imageUrlModifier(self, url, data):`
Store large xkcd images. 2013-12-04 16:56:54 +00:00			`if url and '/large/' in data:`
			`return url.replace(".png", "_large.png")`
			`return url`