Move to full OOP

[AtoraSuunva]

Essentially rewrite the whole thing to make it more easily extensible in terms of supporting different boorus, with the final goal of adding more functionality than just searching boorus (Things like fetching the comments or allowing for login use to favorite pics or whatever.)

Backwards compatibility will still remain in some form, but might be removed in later releases so don't depend on it.

If you have any questions/comments/suggestions reply to this issue and I'll get back to you.

A very basic schema of what is going to happen is here:

• [x] index.js // just requires/exports the required things

  • [x] Booru() => returns an object with
    • [x] .search(site, [tags...], {limit, random})
    • [~] .postView(site, id) BooruImages Posts have a .postView prop now!
  • [x] new Booru(site, {options})
  • [X] .resolveSite(site/alias) => {site details}
  • [X] .sites => {all sites}
  • [X] .commonfy() => Do nothing, add <Post>.common getter to images/posts instead

• [x] src/

  • [X] new Post

  • [X] Constructor, params => data:Object, booru:IBooru

  • [X] .common, get that replicates old .commonfy() function

  • [X] Utils

  • [X] .jsonfy([images])

  • [X] .shuffle([arr])

  • [X] .randInt(min, max)

  • [X] .resolveSite(site/alias)

  • [X] Constants

  • [X] .sites

  • [X] .BooruError

  • [X] .userAgent

  • [X] .searchURI(site, tags, limit) => http://${site}${sites[site].api}${(sites[site].tagQuery) ? sites[site].tagQuery : 'tags'}=${tags.join('+')}&limit=${limit}

  • [X] sites.json

• [X] src/booru

  • [X] new Booru // (Abstract Class), you shouldn't need to use this directly
  • [X] Constructor, params (site, [credentials])
  • [X] .search([tags...], {limit, random})
  • [X] .postView(id)
  • [X] .site
  • [x] new JSONBooru : Booru // Class for the default boorus
  • [x] new XMLBooru : Booru
  • [x] new Derpibooru : Booru // They have weird randomization logic & api
  • [x] 'Other boorus with specific things'?

Also coming is better JSDoc, for better intellisense :)

[AtoraSuunva]

https://github.com/AtlasTheBot/booru/tree/classes holds the in-dev version

Also, if someone knows how to refer to @typedef in other files help

nvm I fixy

[AtoraSuunva]

// Another example, where we instantiate a booru and then use it
// instantiating a booru allows for you to do more complex things,
// like favoriting a post (if you provide an api token) or posting/viewing comments, etc.
async function example() {
  const e9 = new Booru('e9', {token: 'goes here'})
  let imgs = await e9.search(['cat', 'cute'], {limit: 1, random: true})

  // Log the post url to the first image
  console.log(imgs[0].postView)

  // In the future, things like `e9.favorite(BooruImage)` or `e9.fetchComments(BooruImage)`
  // Will be available (and maybe even <BooruImage>.favorite())
}

That was fast

Above is valid code for booru v0.5.0

Creating Boorus and .postView on BooruImages might be the only really new things, but with the new structure for the module get ready to see some cool features :)

[AtoraSuunva]

Changelog

Breaking Changes

• resolveSite(site) now returns null if it cannot resolve
• sites.json is now formatted differently, .api now maps to an object representing a site's API, instead of being the path for the search api. (Shouldn't break anything though, unless you relied on it)

What's new

• Complete rewrite to move to a better (aka not in 1 file) & more object-oriented structure
  • This allows for more exciting things than just search boorus, like being able to instantiate a booru with an api token and then favorite images or post comments!
  • Boorus are split into classes that extend a base Booru class (in short, it's now ez to add new booru types or multi-booru functionality)
  • Some code split into either Utils.js or Constants.js for easier tweaking
  • Bug fixes are now 100000% easier
• (Most) Backwards-Capability remains, Booru.search(site, [tags], {opts}) still remains (with minor improvements)
  • tags can now a be a string
• The returned images are now Post objects, which now have both JSDoc for properties and don't need .common (No .commonfy() anymore!), and can now have other methods/getters attached to them
  • Added <Post>.file_url, <Post>.tags, etc... Props are now there without having to run .commonfy
  • Added <Post>.postView getter, which returns the post view url for that image
• JSDoc!!!
• Searches return a SearchResults object, which extends an array and mostly acts like an array of Post
  • .first & .last getters for the first and last results
  • .nextPage() to search the next page of results
  • .tagged(tags) to only get posts tagged with 1 or more tags specified
  • .blacklist(tags) to remove posts tagged with 1 or more tags specified
• Should be more stable. Should.

tl;dr

This update is only really exciting if you love JSDoc or are me, because now I can fix bugs and tweak parts more easily and stay sane :)

[AtoraSuunva]

I won't be releasing this until I test it out for a while.

For the curious (or adventurous), you can install the dev version (this one) with npm install --save booru@dev

Nothing should break, but it's better to be careful

[AtoraSuunva]

this is done heck yea