xxx_rename 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f2ab66c24ad8843af4181a46ceeb6c14803f69d3402d0249aa271b1eb70e235
+  data.tar.gz: d70c0efcc455708d3d761a9efc51ca5be69c8cd1a688b20dae40798cea72d532
+SHA512:
+  metadata.gz: 8a032226ed92ab39088d538aef98c14ed5580759d5ff83cb1117c4803688371cd6269aa38a51b3f9c2ededb54b6427cd8e17de040465318fd81bec88d7f9c1e0
+  data.tar.gz: 287f229670366353be4cedad9563b3cba54b22a42538ecfeb0375263a3d275d54e701e4b049dd5feb8299db71dc54ea9ac22d829c630eee22a9d3975721d7d26

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,42 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '45 7 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/ruby.yml

@@ -0,0 +1,44 @@
+# 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: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7']
+
+    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
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+        cache-version: 3
+    - name: Run tests
+      run: bundle exec rake
+
+    - name: Run CodeCov
+      uses: codecov/codecov-action@v2
+      with:
+        files: ./coverage/.resultset.json
+        flags: unittests # optional
+        name: codecov-umbrella # optional
+        fail_ci_if_error: true
+        verbose: true

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,41 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.7.0
+  SuggestExtensions: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Metrics/BlockLength:
+  IgnoredMethods: [ 'describe', 'context' ]
+  Exclude:
+    - spec/**/*
+    - xxx_rename.gemspec

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xxx_rename.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,174 @@
+PATH
+  remote: .
+  specs:
+    xxx_rename (0.0.1)
+      activesupport (~> 7.0)
+      algolia (~> 2.3)
+      awesome_print (~> 1.9)
+      colorize (~> 0.8.1)
+      deep_merge (~> 1.2)
+      dry-struct (~> 1.4)
+      dry-types (~> 1.5)
+      dry-validation (~> 1.8)
+      httparty (>= 0.18.1, < 0.22.0)
+      nokogiri (~> 1.12)
+      rake (~> 13.0)
+      thor (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    algolia (2.3.1)
+      faraday (>= 0.15, < 3)
+      faraday-net_http_persistent (>= 0.15, < 3)
+      multi_json (~> 1.0)
+      net-http-persistent
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.3.0)
+    crack (0.4.5)
+      rexml
+    deep_merge (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-configurable (0.14.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.1.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.9.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.8.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.8, >= 1.8.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-net_http_persistent (2.1.0)
+      faraday (~> 2.5)
+      net-http-persistent (~> 4.0)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    net-http-persistent (4.0.1)
+      connection_pool (~> 2.2)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.6.2)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.2.1)
+    timecop (0.9.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+
+DEPENDENCIES
+  codecov (~> 0.6.0)
+  pry (~> 0.13.1)
+  rspec (~> 3.10)
+  rubocop (~> 1.7)
+  simplecov
+  timecop (~> 0.9.4)
+  webmock (~> 3.14)
+  xxx_rename!
+
+BUNDLED WITH
+   2.3.14

data/README.md

@@ -0,0 +1,319 @@
+# XxxRename
+
+![pipeline](https://github.com/c477y/xxx_rename/actions/workflows/ruby.yml/badge.svg)
+
+A gem to rename your porn videos and integrate with your Stash app as a third-
+party scraper.
+
+Currently supports the following websites:
+
+* [AdultTime](https://www.adulttime.com/)*
+* [Babes](https://www.babes.com)
+* [Blacked](https://www.blacked.com/)
+* [BlackedRaw](https://www.blacked-raw.com/)
+* [Brazzers](https://www.brazzers.com)
+* [Casting Couch](https://castingcouch-x.com)
+* [Dark X](https://www.darkx.com/en)
+* [Digital Playground](https://www.digitalplayground.com)
+* [Elegant Angel](https://www.elegantangel.com/)
+* [Erotica X](https://www.eroticax.com/en)
+* [Evil Angel](https://evilangel.com/)
+* [Exotic4k](https://exotic4k.com)
+* [FantasyHD](https://fantasyhd.com)
+* [GoodPorn](https://goodporn.to/)
+* [Hard X](https://www.hardx.com/en)
+* [Holed](https://holed.com)
+* [Jules Jordan](https://www.julesjordan.com/)
+* [Lubed](https://lubed.com)
+* [Manuel Ferrara](https://manuelferrara.com/)
+* [Mofos](https://www.mofos.com)
+* [My Very First Time](https://myveryfirsttime.com)
+* [NF Busty](https://nfbusty.com/)
+* [Nanny Spy](https://nannyspy.com)
+* [POVd](https://povd.com)
+* [PassionHD](https://passion-hd.com)
+* [Puremature](https://puremature.com)
+* [Reality Kings](https://www.realitykings.com/)
+* [Slayed](https://www.slayed.com/)
+* [SpyFam](https://spyfam.com)
+* [Stash DB](https://stashdb.org/)
+* [Tiny 4k](https://tiny4k.com)
+* [Tushy Raw](https://www.tushyraw.com/)
+* [Tushy](https://www.tushy.com/)
+* [Twistys](https://www.twistys.com)
+* [Vixen](https://www.vixen.com/)
+* [X Empire](https://www.xempire.com/en)
+* [Wicked](https://www.wicked.com/)
+* [Zero Tolerance Films](https://www.zerotolerancefilms.com/en/?s=1)
+
+![output](./output.png)
+
+## Installation
+
+```shell
+gem install xxx_rename
+```
+
+### Usage
+
+#### Basic Usage
+
+```shell
+$ xxx_rename help
+
+Commands:
+  xxx_rename generate FILE|FOLDER        # Rename a file or all file(s) inside a given directory
+  xxx_rename help [COMMAND]              # Describe available commands or one specific command
+  xxx_rename migrate --version=VERSION   # Apply a rename migration file
+  xxx_rename rollback --version=VERSION  # Rollback a migration
+  xxx_rename version                     # Print the CLI version
+```
+
+#### Generate
+
+Generate command scans all files and stores their scraped data inside a file
+stored in the `xxx_rename` config directory. You can add actions that will
+be performed with each successful match:
+
+1. sync_to_stash : Sync the matched details to your Stash App. This will create
+   a movie as well on Stash if the scene belongs to a movie (which is something
+   that Stash does not do at the moment.)
+2. log_rename_op : Create a migration file that logs a file with its new
+   filename. Migrations are reversible operations that rename all files that
+   are matched by xxx_rename.
+
+```shell
+$ xxx_rename help generate
+
+Usage:
+  xxx_rename generate FILE|FOLDER
+
+Options:
+  [--config=CONFIG]                                             # path to config file
+  [--verbose], [--no-verbose]                                  # enable verbose logging
+  [--override-site=OVERRIDE_SITE]                              # force use an override site
+                                                               # Possible values: adult_time, babes, blacked, blacked_raw, brazzers, digital_playground, elegant_angel, evil_angel, goodporn, jules_jordan, manuel_ferrara, mofos, naughty_america, nf_busty, reality_kings, stash, tushy, tushy_raw, twistys, vixen, whale_media, wicked, x_empire, zero_tolerance
+  [--nested], [--no-nested]                                    # recursively search for all files in the given directory
+  [--force-refresh-datastore], [--no-force-refresh-datastore]  # force site client to fetch all scenes, if implemented
+  [--actions=ACTIONS]                                          # action to perform on a successful match
+                                                               # Possible values: sync_to_stash, log_rename_op
+  [--force-refresh], [--no-force-refresh]                      # force match scenes from original sites
+  [--checkpoint=CHECKPOINT]                                    # skip all iterations until check-pointed file is matched
+
+Description:
+  Scan files and generate metadata
+  For first time users, run the command without any flags to generate a config file in $HOME/.config/xxx_rename
+
+  $ xxx_rename generate
+
+  The cli will look for a config file in these three places in order:
+  * --config (This takes precedence over everything)
+  * $HOME/.config/xxx_rename
+  * HOME/xxx_rename
+
+  Examples
+  # Scan all files in a given directory and its sub-directories
+  $ xxx_rename generate . --nested
+
+  # Force the cli to use `brazzers` to match a file
+  $ xxx_rename generate . --verbose --override_site=brazzers
+
+  # Generate a migrations file to rename the matched files
+  $ xxx_rename generate . --actions=log_rename_op
+```
+
+#### Migrate
+
+```bash
+$ xxx_rename help migrate
+
+Usage:
+  xxx_rename migrate --version=VERSION
+
+Options:
+  [--config=CONFIG]    # path to config file
+  [--version=VERSION]  # Name of migration file to apply
+                       # Default: latest
+
+Description:
+  WARNING: This is a destructive operation as it will rename files Run this on a small subset to be sure and run it at your own risk
+
+  Rename files based on operations listed in a migration file.
+
+  All rename files are located in your `generated_files_dir` directory. Migration files are plain YAML files of format 'output_YYYYMMDDHHMM.yml'
+
+  Pass a migration file using option `--version YYYYMMDDHHMM`.
+  If you want to apply a migration file that you have just created, pass the --version as "latest". Or don't pass the --version flag and the CLI will use the latest version by default.
+
+  Migration files have the following format:
+
+  -
+    --- # 0 means the migration is not applied
+    # 1 means the migration is applied
+    # This flag prevents applying a migration that has already been applied
+    ___MIGRATION_STATUS___: 0
+    # All operations are stored as an array
+    ___RENAME_ACTIONS___:
+    # DO NOT MANIPULATE AN ARRAY ITEM! Doing so can result in unexpected
+    # behaviour. You can remove an operation from the list entirely, but
+    # the recommended way is to discard this migration completely,
+    # modify the `output_format` for your file in the config and run the
+    # generate command again
+    - !ruby/object:XxxRename::Data::FileRenameOp
+    attributes:
+      :key: eab204175567d39202c1df5895e443be # DO NOT MODIFY THIS
+      :directory: "/ABSOLUTE/DIRECTORY/TOFILE"
+      :source_filename: ORIGINAL_FILENAME.MP4
+      :output_filename: NEW_FILENAME.MP4
+      :mtime: 2000-01-01 00:00:00.000000000 +00:00
+
+  Example Usage:
+
+  $ xxx_rename migrate --version=202301131252
+
+  $ xxx_rename migrate
+```
+
+#### Rollback
+
+```bash
+$ xxx_rename help rollback
+
+Usage:
+  xxx_rename rollback --version=VERSION
+
+Options:
+  [--config=CONFIG]    # path to config file
+  [--version=VERSION]  # Name of migration file to apply
+                       # Default: latest
+
+Description:
+  Reverse the actions taken by the `migrate` command
+
+  Read the help command for more information
+
+  $ xxx_rename help migrate
+```
+
+## FAQs
+
+### How does this work?
+
+xxx_rename works assumes all files are a scene. Each scene can be matched by one
+(or more) site client (a site that will be scraped to fetch details). For some
+files that are downloaded from original sources (at this time these are mg
+premium sites brazzers along with evil angel, goodporn, NF busty and vixen
+media), xxx_rename will try to guess the site client based on the unique format
+of the filename themselves.
+
+In other case, you are required to define these rules yourself in the config
+file. Rules are just string of tokens that generate a regex to match a file. For
+example, let's say you have a file like this "[EvilAngel] Blake Blossom - Facial
+Fantasy 3.mp4". You can create a rule in your config file like this:
+
+```yml
+evil_angel:
+  file_source_format:
+     # Notice the missing .ext in the pattern
+     - "[EvilAngel] %female_actors - %title"
+```
+
+Now, when you run the `generate` command, xxx_rename will look at the rules and
+match the file with evil_angel. It will then use the %title(Facial Fantasy 3)
+and %female_actors([Blake Blossom]) data and search EvilAngel for a scene that
+matches the parsed details from a file. This will *near guarantee* that the
+match will be correct (which can be an issue with other tools like
+[stash-box](https://stashdb.org/) or
+[metadataapi.net](https://metadataapi.net/)).
+
+### What are `collection_tags` in the config?
+
+Think of `collection_tag` as reserved keywords. `collection_tags` are three
+character unique keywords that are used to associate a file with a site client.
+The CLI expects all filenames to have a unique format, which can be a problem
+when all files are renamed using a common format. `collection_tags` introduce
+just enough uniqueness in the filename to allow `xxx_rename` associate them with
+a site client.
+
+### What are the supported tokens
+
+| Token             | Regex                                                         | Description                                                        |
+| ----------------- | ------------------------------------------------------------- | ------------------------------------------------------------------ |
+| %title            | (?<title>[\\w\\s\\-_,'\"\\.]+)                             | Title of the scene                                                 |
+| %collection       | (?<collection>[\\w\\s\\-_,'\"\\.]+)                        | Usually the studio                                                 |
+| %collection_op    | (?<collection>[\\w\\s\\-_,'\"]*?)                          | Same as collection, but allows optional values                     |
+| %collection_tag_1 | (?<collection_tag>\\w)                                     | A single character reserved word                                   |
+| %collection_tag_2 | (?<collection_tag>\\w{,2})                                 | Two character reserved word                                        |
+| %collection_tag_3 | (?<collection_tag>\\w{,3})                                 | Three character reserved word                                      |
+| %female_actors    | (?<female_actors>[\\w\\s\\-_,'\"\\.]+)                     | Comma Separated list of names                                      |
+| %male_actors      | (?<male_actors>[\\w\\s\\-_,'\"\\.]+)                       | Comma Separated list of names                                      |
+| %male_actors_op   | (?<male_actors>[\\w\\s\\-_,'\"]*)?                         | Same as %male_actors, but optional                                 |
+| %actors           | (?<actors>[\\w\\s\\-_,'\"\\.]+)                            | Use if there's no obvious separator between male and female actors |
+| %id               | (?<id>(\\d+\|[a-z\\-\\_]+))                                | Unique ID                                                          |
+| %id_op            | (?<id>(\\d*\|[a-z\\-\\_]*))?                               | Same as ID, but optional                                           |
+| %ignore_1_word    | (\\w\\s){1}                                                   | Ignore a filler word                                               |
+| %ignore_2_words   | (\\w\\s){2}                                                   | Ignore 2 filler word                                               |
+| %ignore_3_words   | (\\w\\s){3}                                                   | Ignore 3 filler words                                              |
+| %ignore_4_words   | (\\w\\s){4}                                                   | Ignore 4 filler words                                              |
+| %ignore_5_words   | (\\w\\s){5}                                                   | Ignore 5 filler words                                              |
+| %ignore_6_words   | (\\w\\s){6}                                                   | Ignore 6 filler words                                              |
+| %ignore_7_words   | (\\w\\s){7}                                                   | Ignore 7 filler words                                              |
+| %ignore_all       | ".*                                                           | Ignore everything                                                  |
+| %yyyy_mm_dd       | (?<year>\\d{4})\_(?<month>\\d{1,2})_(?<day>\\d{1,2}) | Complete year in YYYY_MM_DD for                                    |
+| %dd               | (?<day>\\d{1,2})                                           | DD (Day of Month)                                                  |
+| %mm               | (?<month>\\d{1,2})                                         | MM (Month of Year)                                                 |
+| %yyyy             | (?<year>\\d{4})                                            | YYYY (Year)                                                        |
+| %yy               | (?<year>\\d{2,4})                                          | YY (Compressed Year)                                               |
+
+### How does xxx_rename compare with Stash DB?
+
+xxx_rename can be considered an extension to
+[Stash](https://github.com/stashapp/stash). It does not intend to compete with
+the sheer number of features provided by Stash. In fact, stash-box is considered
+a valid `site client` if you want to use it. Stash DB's matches are pretty
+accurate given their community contribution and phash matching algorithm.
+But I also realise stash is an overkill for a lot of people. For someone who
+has a casual collection and just want to organize their files with meaningful
+names (compared with obfuscated names some sites use for their original files),
+xxx_rename works beautifully and serves their purpose well.
+
+You choose how you want your files to be renamed and what data you like and what
+you don't. Change your mind in the future? No problem, xxx_rename remembers all
+scenes and you can choose a new format anytime you want.
+
+### How does xxx_rename compare with namer?
+
+[namer](https://github.com/ThePornDatabase/namer) works on a similar principle
+as xxx_rename, in which it also uses regexes to fetch metadata from a filename.
+But it matches a search using its own database
+[metadataapi.net](https://metadataapi.net). While the tool is really amazing and
+requires little configuration from the user, it results in mismatches and you
+can end up with a filename that is simply incorrect.
+
+xxx_rename works on the principle of BYOD (Bring Your Own Data). All search
+happens locally, there are no external servers, no tracking whatsoever and you
+own your database. Since there's a certain configuration required from your
+side, there are little chances for any errors. xxx_rename is not a swiss knife
+of all scrapers, it prefers correctness over convenience.
+
+### Why is Site X not supported?
+
+Some websites are really stubborn as they do not provide a basic search
+facility. The biggest example of this is Naughty America, which has been a paid
+to find a workaround and implement from scratch. Some websites lock their search
+behind a paywall(membership), so while it's possible for me to implement a
+search functionality, it is impossible to test and maintain once the membership
+period is over.
+
+### What sites can be supported?
+
+Any site that provide a meaningful filename and have a usable API/website. Raise
+a request on the [issues](https://github.com/c477y/xxx_rename/issues) page with
+the name of the website you want to get support for and a list of original
+filenames (not the actual files). I can't promise if I will be able to implement
+it but the request will be open for someone in the community to integrate.
+
+## Contribution
+
+Pull requests are welcome! See [Development](docs/DEVELOPMENT.md) for setup
+instructions.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]