├── .babelrc.js
├── .esdoc.json
├── .gitignore
├── .npmignore
├── .sgcrc
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── config
├── .eslintrc.js
├── release-rules.js
└── release.config.js
├── docs
├── ast
│ └── source
│ │ ├── .external-ecmascript.js.json
│ │ ├── TorrentLibrary.js.json
│ │ ├── docs
│ │ ├── events
│ │ │ └── events.js.json
│ │ └── types
│ │ │ └── types.js.json
│ │ └── filters
│ │ ├── filterBooleanProperty.js.json
│ │ ├── filterNumberProperty.js.json
│ │ ├── filterProperties.js.json
│ │ └── filterStringProperty.js.json
├── badge.svg
├── class
│ └── src
│ │ └── TorrentLibrary.js~TorrentLibrary.html
├── coverage.json
├── css
│ ├── github.css
│ ├── identifiers.css
│ ├── manual.css
│ ├── prettify-tomorrow.css
│ ├── search.css
│ ├── source.css
│ ├── style.css
│ └── test.css
├── file
│ └── src
│ │ ├── TorrentLibrary.js.html
│ │ ├── docs
│ │ ├── events
│ │ │ └── events.js.html
│ │ └── types
│ │ │ └── types.js.html
│ │ └── filters
│ │ ├── filterBooleanProperty.js.html
│ │ ├── filterNumberProperty.js.html
│ │ ├── filterProperties.js.html
│ │ └── filterStringProperty.js.html
├── function
│ └── index.html
├── identifiers.html
├── image
│ ├── badge.svg
│ ├── esdoc-logo-mini-black.png
│ ├── esdoc-logo-mini.png
│ ├── github.png
│ ├── manual-badge.svg
│ └── search.png
├── index.html
├── index.json
├── lint.json
├── manual
│ ├── CHANGELOG.html
│ ├── asset
│ │ ├── fileMapping.png
│ │ ├── filterMovies.png
│ │ ├── filterTvSeries.png
│ │ ├── foundMovies.png
│ │ └── foundTvSeries.png
│ ├── createPlaylist.html
│ ├── filterMoviesByParameters.html
│ ├── filterTvSeriesByParameters.html
│ ├── getCategoryForEachFile.html
│ ├── index.html
│ ├── listEachTvSerie.html
│ └── listFoundMovies.html
├── script
│ ├── inherited-summary.js
│ ├── inner-link.js
│ ├── manual.js
│ ├── patch-for-local.js
│ ├── prettify
│ │ ├── Apache-License-2.0.txt
│ │ └── prettify.js
│ ├── pretty-print.js
│ ├── search.js
│ ├── search_index.js
│ └── test-summary.js
├── source.html
├── test-file
│ └── test
│ │ ├── getters
│ │ ├── allFilesWithCategory.js.html
│ │ ├── allMovies.js.html
│ │ ├── allTvSeries.js.html
│ │ └── constants.js.html
│ │ └── methods
│ │ ├── addNewPath.js.html
│ │ ├── createFromJSON.js.html
│ │ ├── filterMovies.js.html
│ │ ├── filterTvSeries.js.html
│ │ ├── removeOldFiles.js.html
│ │ ├── scan.js.html
│ │ └── toJSON.js.html
├── test.html
└── typedef
│ └── index.html
├── index.js
├── manual
├── assets
│ ├── fileMapping.png
│ ├── filterMovies.png
│ ├── filterTvSeries.png
│ ├── foundMovies.png
│ └── foundTvSeries.png
└── examples
│ ├── createPlaylist.md
│ ├── filterMoviesByParameters.md
│ ├── filterTvSeriesByParameters.md
│ ├── getCategoryForEachFile.md
│ ├── listEachTvSerie.md
│ └── listFoundMovies.md
├── package-lock.json
├── package.json
├── src
├── TorrentLibrary.js
├── docs
│ ├── events
│ │ └── events.js
│ └── types
│ │ └── types.js
└── filters
│ ├── filterBooleanProperty.js
│ ├── filterNumberProperty.js
│ ├── filterProperties.js
│ └── filterStringProperty.js
└── test
├── _constants.js
├── fixtures
├── example.json
├── folder1
│ ├── Bad.Ass.2012.REMASTERED.TRUEFRENCH.DVDRiP.XviD-www.zone-telechargement.ws.avi
│ └── The.Blacklist.S04E21.FRENCH.WEBRip.XviD.avi
└── folder2
│ └── The.Blacklist.S04E14.FRENCH.WEBRip.XviD.avi
├── getters
├── allFilesWithCategory.js
├── allMovies.js
├── allTvSeries.js
└── constants.js
└── methods
├── addNewPath.js
├── createFromJSON.js
├── filterMovies.js
├── filterTvSeries.js
├── removeOldFiles.js
├── scan.js
└── toJSON.js
/.babelrc.js:
--------------------------------------------------------------------------------
1 | let env = process.env.BABEL_ENV || process.env.NODE_ENV;
2 | let presets = [];
3 | let plugins = ["@babel/plugin-proposal-object-rest-spread"];
4 | let ignore = ["src/docs/**/*.js"];
5 | let comments = false;
6 |
7 | // custom settings for prod/test ; for example babel-istanbul-plugin , etc.
8 | switch (env){
9 | case 'test':
10 | // ./fix-coverage/arrow-function-coverage-fix.js : Because some odd issue for istanbul/nyc
11 | plugins.push.apply(plugins, ["babel-plugin-istanbul"]);
12 | break;
13 |
14 | case 'production':
15 | // workaround : https://github.com/babel/minify/issues/790#issuecomment-365750066
16 | presets.push.apply(presets, [['minify', { removeUndefined: false }]] );
17 | break;
18 | }
19 |
20 | // default preset
21 | presets.push.apply(presets, ["@babel/preset-env"]);
22 |
23 | module.exports = {
24 | presets: presets,
25 | plugins: plugins,
26 | ignore: ignore,
27 | comments: comments,
28 | };
--------------------------------------------------------------------------------
/.esdoc.json:
--------------------------------------------------------------------------------
1 | {
2 | "source": "./src",
3 | "destination": "./docs",
4 | "plugins": [
5 | {"name": "esdoc-standard-plugin",
6 | "option": {
7 | "test": {
8 | "source": "./test/",
9 | "interfaces": ["test"],
10 | "includes": ["\\.js$"],
11 | "excludes": ["_constants.js"]
12 | },
13 | "manual": {
14 | "globalIndex": true,
15 | "asset": "./manual/assets",
16 | "files": [
17 | "./manual/examples/getCategoryForEachFile.md",
18 | "./manual/examples/listFoundMovies.md",
19 | "./manual/examples/listEachTvSerie.md",
20 | "./manual/examples/filterMoviesByParameters.md",
21 | "./manual/examples/filterTvSeriesByParameters.md",
22 | "./manual/examples/createPlaylist.md",
23 | "./CHANGELOG.md"
24 | ]
25 | }
26 | }
27 | },
28 | {"name": "esdoc-ecmascript-proposal-plugin", "option": {"all": true}}
29 | ]
30 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 |
8 | # Runtime data
9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 |
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 |
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 |
20 | # nyc test coverage
21 | .nyc_output
22 |
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 |
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 |
29 | # node-waf configuration
30 | .lock-wscript
31 |
32 | # Compiled binary addons (http://nodejs.org/api/addons.html)
33 | build/Release
34 |
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 |
39 | # Typescript v1 declaration files
40 | typings/
41 |
42 | # Optional npm cache directory
43 | .npm
44 |
45 | # Optional eslint cache
46 | .eslintcache
47 |
48 | # Optional REPL history
49 | .node_repl_history
50 |
51 | # Output of 'npm pack'
52 | *.tgz
53 |
54 | # Yarn Integrity file
55 | .yarn-integrity
56 |
57 | # dotenv environment variables file
58 | .env
59 |
60 | # babel src to lib
61 | lib
62 |
63 | # intellij files
64 | *.iml
65 | .idea
66 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | # uncompiled files
2 | src
--------------------------------------------------------------------------------
/.sgcrc:
--------------------------------------------------------------------------------
1 | {
2 | "scope": false,
3 | "body": true,
4 | "emoji": true,
5 | "lowercaseTypes": false,
6 | "initial-commit": {
7 | "isEnabled": true,
8 | "emoji": ":tada:",
9 | "message": "Initial commit"
10 | },
11 | "types": [
12 | {
13 | "emoji": ":wrench:",
14 | "type": "Chore:",
15 | "description": "Changes that affect the build system or external dependencies and moving files"
16 | },
17 | {
18 | "emoji": ":construction_worker:",
19 | "type": "CI:",
20 | "description": "Changes to our CI configuration files and scripts"
21 | },
22 | {
23 | "emoji": ":memo:",
24 | "type": "Docs:",
25 | "description": "Documentation only changes"
26 | },
27 | {
28 | "emoji": ":sparkles:",
29 | "type": "Feat:",
30 | "description": "New feature"
31 | },
32 | {
33 | "emoji": ":bug:",
34 | "type": "Fix:",
35 | "description": "Bug fix"
36 | },
37 | {
38 | "emoji": ":zap:",
39 | "type": "Perf:",
40 | "description": "Code change that improves performance"
41 | },
42 | {
43 | "emoji": ":hammer:",
44 | "type": "Refactor:",
45 | "description": "Code change that neither fixes a bug nor adds a feature"
46 | },
47 | {
48 | "emoji": ":art:",
49 | "type": "Style:",
50 | "description": "Changes that do not affect the meaning of the code"
51 | },
52 | {
53 | "emoji": ":white_check_mark:",
54 | "type": "Test:",
55 | "description": "Adding missing tests or correcting existing tests"
56 | },
57 | {
58 | "emoji": ":boom:",
59 | "type": "Breaking:",
60 | "description": "Breaking Change"
61 | }
62 | ],
63 | "rules": {
64 | "max-char": 72,
65 | "min-char": 10,
66 | "end-with-dot": false
67 | }
68 | }
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | dist: trusty
3 | sudo: required
4 | cache:
5 | directories:
6 | - node_modules
7 | notifications:
8 | slack:
9 | on_success: change
10 | on_failure: always
11 | node_js:
12 | - 'node'
13 | - '7'
14 | - '6'
15 | os:
16 | - linux
17 | before_install:
18 | - npm i -g npm@latest
19 | - npm i -g travis-deploy-once
20 | - npm install -g greenkeeper-lockfile@latest
21 | install:
22 | - npm install
23 | - npm audit fix
24 | before_script:
25 | - npm prune
26 | - echo "GreenKeeper lockfile update"
27 | - greenkeeper-lockfile-update
28 | after_script:
29 | - greenkeeper-lockfile-upload
30 | after_success:
31 | - npm run coverage
32 | # In order to have production files for release : I should rerun compile in production mode in the master build
33 | - travis-deploy-once && npm run prepare && npx -p node@8 npm run semantic-release
34 | branches:
35 | except:
36 | - /^v\d+\.\d+\.\d+$/
37 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6 |
7 | ## Our Standards
8 |
9 | Examples of behavior that contributes to creating a positive environment include:
10 |
11 | * Using welcoming and inclusive language
12 | * Being respectful of differing viewpoints and experiences
13 | * Gracefully accepting constructive criticism
14 | * Focusing on what is best for the community
15 | * Showing empathy towards other community members
16 |
17 | Examples of unacceptable behavior by participants include:
18 |
19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
20 | * Trolling, insulting/derogatory comments, and personal or political attacks
21 | * Public or private harassment
22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
23 | * Other conduct which could reasonably be considered inappropriate in a professional setting
24 |
25 | ## Our Responsibilities
26 |
27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28 |
29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30 |
31 | ## Scope
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34 |
35 | ## Enforcement
36 |
37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jacques.yakoub+github@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38 |
39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40 |
41 | ## Attribution
42 |
43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44 |
45 | [homepage]: http://contributor-covenant.org
46 | [version]: http://contributor-covenant.org/version/1/4/
47 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 jy95
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # torrent-files-library [](https://travis-ci.org/jy95/torrent-files-library) [](https://coveralls.io/github/jy95/torrent-files-library?branch=master) [](https://david-dm.org/jy95/torrent-files-library) [](https://david-dm.org/jy95/torrent-files-library?type=dev) [](https://opensource.org/licenses/MIT) [](https://github.com/semantic-release/semantic-release) [](https://gitter.im/torrent-files-library-/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://greenkeeper.io/)
2 | > Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions
3 |
4 | PS: see the repository [mediaScan](https://github.com/jy95/mediaScan) for the TypeScript version of this lib.
5 |
6 | ## What to do with this library ?
7 |
8 | A lot of things :
9 | * Basic listing purposes :
10 | * [List found movies](https://jy95.github.io/torrent-files-library/manual/listFoundMovies.html)
11 | * [List each found tv serie](https://jy95.github.io/torrent-files-library/manual/listEachTvSerie.html)
12 | * [Detect the category of each file](https://jy95.github.io/torrent-files-library/manual/getCategoryForEachFile.html)
13 | * Filtering purposes :
14 | * [Filter movies based on search parameters](https://jy95.github.io/torrent-files-library/manual/filterMoviesByParameters.html)
15 | * [Filter tv-shown based on search parameters](https://jy95.github.io/torrent-files-library/manual/filterTvSeriesByParameters.html)
16 | * Miscellaneous purposes
17 | * [Create custom playlist(s)](https://jy95.github.io/torrent-files-library/manual/createPlaylist.html)
18 | * ...
19 |
20 | Don't hesitate to suggest new features : it is always worthy :)
21 |
22 | ## Documentation
23 | For more examples and API details, see [API documentation with manual](https://jy95.github.io/torrent-files-library/)
24 |
25 | ## Installation
26 |
27 | For npm users :
28 |
29 | ```shell
30 | $ npm install --save torrent-files-library
31 | ```
32 |
33 | for Yarn :
34 | ```shell
35 | $ yarn add torrent-files-library
36 | ```
37 |
38 | ## Test
39 |
40 | ```shell
41 | npm test
42 | ```
43 |
44 | To generate a test coverage report:
45 |
46 | ```shell
47 | npm run coverage
48 | ```
49 | ## Contributing
50 |
51 | * If you're unsure if a feature would make a good addition, you can always [create an issue](https://github.com/jy95/torrent-files-library/issues/new) first.
52 | * We aim for 100% test coverage. Please write tests for any new functionality or changes.
53 | * Any API changes should be fully documented.
54 | * Make sure your code meets our linting standards. Run `npm run lint` to check your code.
55 | * Be mindful of others when making suggestions and/or code reviewing.
56 |
--------------------------------------------------------------------------------
/config/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | "extends": "airbnb-base",
3 | "rules" :{
4 | "linebreak-style": 0,
5 | "valid-jsdoc": "error",
6 | "max-len": ["error", { "ignoreComments": true }],
7 | "import/extensions": ['off', 'never'],
8 | "no-bitwise": ["error", { "allow": ["|"] }],
9 | "no-restricted-syntax": ['off', "ForInStatement"],
10 | "prefer-const" : "off"
11 | },
12 | "env" : {
13 | "es6" : true,
14 | "node": true,
15 | "mocha" : true
16 | }
17 | };
--------------------------------------------------------------------------------
/config/release-rules.js:
--------------------------------------------------------------------------------
1 | module.exports = [
2 | {
3 | tag: 'Feat',
4 | release: 'minor',
5 | },
6 | {
7 | tag: 'Refactor',
8 | release: 'patch',
9 | },
10 | {
11 | tag: 'Fix',
12 | release: 'patch',
13 | },
14 | {
15 | tag: 'Perf',
16 | release: 'patch',
17 | },
18 | {
19 | tag: 'Breaking',
20 | release: 'major',
21 | },
22 | ];
23 |
--------------------------------------------------------------------------------
/config/release.config.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable no-useless-escape,max-len,no-template-curly-in-string */
2 | module.exports = {
3 | analyzeCommits: {
4 | preset: 'eslint',
5 | releaseRules: './config/release-rules.js',
6 | parserOpts: {
7 | headerPattern: /^(?::([\w-]*):)?\s*(\w*):\s*(.*)$/,
8 | headerCorrespondence: [
9 | 'emoji',
10 | 'tag',
11 | 'message',
12 | ],
13 | },
14 | },
15 | generateNotes: {
16 | preset: 'eslint',
17 | parserOpts: {
18 | headerPattern: /^(?::([\w-]*):)?\s*(\w*):\s*(.*)$/,
19 | headerCorrespondence: [
20 | 'emoji',
21 | 'tag',
22 | 'message',
23 | ],
24 | },
25 | },
26 | verifyConditions:
27 | ['@semantic-release/changelog', '@semantic-release/npm', '@semantic-release/git', '@semantic-release/github'],
28 | publish:
29 | ['@semantic-release/changelog', '@semantic-release/npm',
30 | {
31 | path: '@semantic-release/git',
32 | message: ':wrench: Chore: update package.json and CHANGELOG.md for release ${nextRelease.version} [skip ci]',
33 | }, '@semantic-release/github'],
34 | };
35 |
--------------------------------------------------------------------------------
/docs/badge.svg:
--------------------------------------------------------------------------------
1 |
18 |
--------------------------------------------------------------------------------
/docs/coverage.json:
--------------------------------------------------------------------------------
1 | {
2 | "coverage": "100%",
3 | "expectCount": 39,
4 | "actualCount": 39,
5 | "files": {
6 | "src/filters/filterBooleanProperty.js": {
7 | "expectCount": 3,
8 | "actualCount": 3,
9 | "undocumentLines": []
10 | },
11 | "src/filters/filterNumberProperty.js": {
12 | "expectCount": 5,
13 | "actualCount": 5,
14 | "undocumentLines": []
15 | },
16 | "src/filters/filterProperties.js": {
17 | "expectCount": 3,
18 | "actualCount": 3,
19 | "undocumentLines": []
20 | },
21 | "src/filters/filterStringProperty.js": {
22 | "expectCount": 4,
23 | "actualCount": 4,
24 | "undocumentLines": []
25 | },
26 | "src/TorrentLibrary.js": {
27 | "expectCount": 24,
28 | "actualCount": 24,
29 | "undocumentLines": []
30 | }
31 | }
32 | }
--------------------------------------------------------------------------------
/docs/css/github.css:
--------------------------------------------------------------------------------
1 | /* github markdown */
2 | .github-markdown {
3 | font-size: 16px;
4 | }
5 |
6 | .github-markdown h1,
7 | .github-markdown h2,
8 | .github-markdown h3,
9 | .github-markdown h4,
10 | .github-markdown h5 {
11 | margin-top: 1em;
12 | margin-bottom: 16px;
13 | font-weight: bold;
14 | padding: 0;
15 | }
16 |
17 | .github-markdown h1:nth-of-type(1) {
18 | margin-top: 0;
19 | }
20 |
21 | .github-markdown h1 {
22 | font-size: 2em;
23 | padding-bottom: 0.3em;
24 | }
25 |
26 | .github-markdown h2 {
27 | font-size: 1.75em;
28 | padding-bottom: 0.3em;
29 | }
30 |
31 | .github-markdown h3 {
32 | font-size: 1.5em;
33 | }
34 |
35 | .github-markdown h4 {
36 | font-size: 1.25em;
37 | }
38 |
39 | .github-markdown h5 {
40 | font-size: 1em;
41 | }
42 |
43 | .github-markdown ul, .github-markdown ol {
44 | padding-left: 2em;
45 | }
46 |
47 | .github-markdown pre > code {
48 | font-size: 0.85em;
49 | }
50 |
51 | .github-markdown table {
52 | margin-bottom: 1em;
53 | border-collapse: collapse;
54 | border-spacing: 0;
55 | }
56 |
57 | .github-markdown table tr {
58 | background-color: #fff;
59 | border-top: 1px solid #ccc;
60 | }
61 |
62 | .github-markdown table th,
63 | .github-markdown table td {
64 | padding: 6px 13px;
65 | border: 1px solid #ddd;
66 | }
67 |
68 | .github-markdown table tr:nth-child(2n) {
69 | background-color: #f8f8f8;
70 | }
71 |
72 | .github-markdown hr {
73 | border-right: 0;
74 | border-bottom: 1px solid #e5e5e5;
75 | border-left: 0;
76 | border-top: 0;
77 | }
78 |
79 | /** badge(.svg) does not have border */
80 | .github-markdown img:not([src*=".svg"]) {
81 | max-width: 100%;
82 | box-shadow: 1px 1px 1px rgba(0,0,0,0.5);
83 | }
84 |
--------------------------------------------------------------------------------
/docs/css/identifiers.css:
--------------------------------------------------------------------------------
1 | .identifiers-wrap {
2 | display: flex;
3 | align-items: flex-start;
4 | }
5 |
6 | .identifier-dir-tree {
7 | background: #fff;
8 | border: solid 1px #ddd;
9 | border-radius: 0.25em;
10 | top: 52px;
11 | position: -webkit-sticky;
12 | position: sticky;
13 | max-height: calc(100vh - 155px);
14 | overflow-y: scroll;
15 | min-width: 200px;
16 | margin-left: 1em;
17 | }
18 |
19 | .identifier-dir-tree-header {
20 | padding: 0.5em;
21 | background-color: #fafafa;
22 | border-bottom: solid 1px #ddd;
23 | }
24 |
25 | .identifier-dir-tree-content {
26 | padding: 0 0.5em 0;
27 | }
28 |
29 | .identifier-dir-tree-content > div {
30 | padding-top: 0.25em;
31 | padding-bottom: 0.25em;
32 | }
33 |
34 | .identifier-dir-tree-content a {
35 | color: inherit;
36 | }
37 |
38 |
--------------------------------------------------------------------------------
/docs/css/manual.css:
--------------------------------------------------------------------------------
1 | .github-markdown .manual-toc {
2 | padding-left: 0;
3 | }
4 |
5 | .manual-index .manual-cards {
6 | display: flex;
7 | flex-wrap: wrap;
8 | }
9 |
10 | .manual-index .manual-card-wrap {
11 | width: 280px;
12 | padding: 10px 20px 10px 0;
13 | box-sizing: border-box;
14 | }
15 |
16 | .manual-index .manual-card-wrap > h1 {
17 | margin: 0;
18 | font-size: 1em;
19 | font-weight: 600;
20 | padding: 0.2em 0 0.2em 0.5em;
21 | border-radius: 0.1em 0.1em 0 0;
22 | border: none;
23 | }
24 |
25 | .manual-index .manual-card-wrap > h1 span {
26 | color: #555;
27 | }
28 |
29 | .manual-index .manual-card {
30 | height: 200px;
31 | overflow: hidden;
32 | border: solid 1px rgba(230, 230, 230, 0.84);
33 | border-radius: 0 0 0.1em 0.1em;
34 | padding: 8px;
35 | position: relative;
36 | }
37 |
38 | .manual-index .manual-card > div {
39 | transform: scale(0.4);
40 | transform-origin: 0 0;
41 | width: 250%;
42 | }
43 |
44 | .manual-index .manual-card > a {
45 | position: absolute;
46 | top: 0;
47 | left: 0;
48 | width: 100%;
49 | height: 100%;
50 | background: rgba(210, 210, 210, 0.1);
51 | }
52 |
53 | .manual-index .manual-card > a:hover {
54 | background: none;
55 | }
56 |
57 | .manual-index .manual-badge {
58 | margin: 0;
59 | }
60 |
61 | .manual-index .manual-user-index {
62 | margin-bottom: 1em;
63 | border-bottom: solid 1px #ddd;
64 | }
65 |
66 | .manual-root .navigation {
67 | padding-left: 4px;
68 | margin-top: 4px;
69 | }
70 |
71 | .navigation .manual-toc-root > div {
72 | padding-left: 0.25em;
73 | padding-right: 0.75em;
74 | }
75 |
76 | .github-markdown .manual-toc-title a {
77 | color: inherit;
78 | }
79 |
80 | .manual-breadcrumb-list {
81 | font-size: 0.8em;
82 | margin-bottom: 1em;
83 | }
84 |
85 | .manual-toc-title a:hover {
86 | color: #039BE5;
87 | }
88 |
89 | .manual-toc li {
90 | margin: 0.75em 0;
91 | list-style-type: none;
92 | }
93 |
94 | .navigation .manual-toc [class^="indent-h"] a {
95 | color: #666;
96 | }
97 |
98 | .navigation .manual-toc .indent-h1 a {
99 | color: #555;
100 | font-weight: 600;
101 | display: block;
102 | }
103 |
104 | .manual-toc .indent-h1 {
105 | display: block;
106 | margin: 0.4em 0 0 0.25em;
107 | padding: 0.2em 0 0.2em 0.5em;
108 | border-radius: 0.1em;
109 | }
110 |
111 | .manual-root .navigation .manual-toc li:not(.indent-h1) {
112 | margin-top: 0.5em;
113 | }
114 |
115 | .manual-toc .indent-h2 {
116 | display: none;
117 | margin-left: 1.5em;
118 | }
119 | .manual-toc .indent-h3 {
120 | display: none;
121 | margin-left: 2.5em;
122 | }
123 | .manual-toc .indent-h4 {
124 | display: none;
125 | margin-left: 3.5em;
126 | }
127 | .manual-toc .indent-h5 {
128 | display: none;
129 | margin-left: 4.5em;
130 | }
131 |
132 | .manual-nav li {
133 | margin: 0.75em 0;
134 | }
135 |
--------------------------------------------------------------------------------
/docs/css/prettify-tomorrow.css:
--------------------------------------------------------------------------------
1 | /* Tomorrow Theme */
2 | /* Original theme - https://github.com/chriskempson/tomorrow-theme */
3 | /* Pretty printing styles. Used with prettify.js. */
4 | /* SPAN elements with the classes below are added by prettyprint. */
5 | /* plain text */
6 | .pln {
7 | color: #4d4d4c; }
8 |
9 | @media screen {
10 | /* string content */
11 | .str {
12 | color: #718c00; }
13 |
14 | /* a keyword */
15 | .kwd {
16 | color: #8959a8; }
17 |
18 | /* a comment */
19 | .com {
20 | color: #8e908c; }
21 |
22 | /* a type name */
23 | .typ {
24 | color: #4271ae; }
25 |
26 | /* a literal value */
27 | .lit {
28 | color: #f5871f; }
29 |
30 | /* punctuation */
31 | .pun {
32 | color: #4d4d4c; }
33 |
34 | /* lisp open bracket */
35 | .opn {
36 | color: #4d4d4c; }
37 |
38 | /* lisp close bracket */
39 | .clo {
40 | color: #4d4d4c; }
41 |
42 | /* a markup tag name */
43 | .tag {
44 | color: #c82829; }
45 |
46 | /* a markup attribute name */
47 | .atn {
48 | color: #f5871f; }
49 |
50 | /* a markup attribute value */
51 | .atv {
52 | color: #3e999f; }
53 |
54 | /* a declaration */
55 | .dec {
56 | color: #f5871f; }
57 |
58 | /* a variable name */
59 | .var {
60 | color: #c82829; }
61 |
62 | /* a function name */
63 | .fun {
64 | color: #4271ae; } }
65 | /* Use higher contrast and text-weight for printable form. */
66 | @media print, projection {
67 | .str {
68 | color: #060; }
69 |
70 | .kwd {
71 | color: #006;
72 | font-weight: bold; }
73 |
74 | .com {
75 | color: #600;
76 | font-style: italic; }
77 |
78 | .typ {
79 | color: #404;
80 | font-weight: bold; }
81 |
82 | .lit {
83 | color: #044; }
84 |
85 | .pun, .opn, .clo {
86 | color: #440; }
87 |
88 | .tag {
89 | color: #006;
90 | font-weight: bold; }
91 |
92 | .atn {
93 | color: #404; }
94 |
95 | .atv {
96 | color: #060; } }
97 | /* Style */
98 | /*
99 | pre.prettyprint {
100 | background: white;
101 | font-family: Consolas, Monaco, 'Andale Mono', monospace;
102 | font-size: 12px;
103 | line-height: 1.5;
104 | border: 1px solid #ccc;
105 | padding: 10px; }
106 | */
107 |
108 | /* Specify class=linenums on a pre to get line numbering */
109 | ol.linenums {
110 | margin-top: 0;
111 | margin-bottom: 0; }
112 |
113 | /* IE indents via margin-left */
114 | li.L0,
115 | li.L1,
116 | li.L2,
117 | li.L3,
118 | li.L4,
119 | li.L5,
120 | li.L6,
121 | li.L7,
122 | li.L8,
123 | li.L9 {
124 | /* */ }
125 |
126 | /* Alternate shading for lines */
127 | li.L1,
128 | li.L3,
129 | li.L5,
130 | li.L7,
131 | li.L9 {
132 | /* */ }
133 |
--------------------------------------------------------------------------------
/docs/css/search.css:
--------------------------------------------------------------------------------
1 | /* search box */
2 | .search-box {
3 | position: absolute;
4 | top: 10px;
5 | right: 50px;
6 | padding-right: 8px;
7 | padding-bottom: 10px;
8 | line-height: normal;
9 | font-size: 12px;
10 | }
11 |
12 | .search-box img {
13 | width: 20px;
14 | vertical-align: top;
15 | }
16 |
17 | .search-input {
18 | display: inline;
19 | visibility: hidden;
20 | width: 0;
21 | padding: 2px;
22 | height: 1.5em;
23 | outline: none;
24 | background: transparent;
25 | border: 1px #0af;
26 | border-style: none none solid none;
27 | vertical-align: bottom;
28 | }
29 |
30 | .search-input-edge {
31 | display: none;
32 | width: 1px;
33 | height: 5px;
34 | background-color: #0af;
35 | vertical-align: bottom;
36 | }
37 |
38 | .search-result {
39 | position: absolute;
40 | display: none;
41 | height: 600px;
42 | width: 100%;
43 | padding: 0;
44 | margin-top: 5px;
45 | margin-left: 24px;
46 | background: white;
47 | box-shadow: 1px 1px 4px rgb(0,0,0);
48 | white-space: nowrap;
49 | overflow-y: scroll;
50 | }
51 |
52 | .search-result-import-path {
53 | color: #aaa;
54 | font-size: 12px;
55 | }
56 |
57 | .search-result li {
58 | list-style: none;
59 | padding: 2px 4px;
60 | }
61 |
62 | .search-result li a {
63 | display: block;
64 | }
65 |
66 | .search-result li.selected {
67 | background: #ddd;
68 | }
69 |
70 | .search-result li.search-separator {
71 | background: rgb(37, 138, 175);
72 | color: white;
73 | }
74 |
75 | .search-box.active .search-input {
76 | visibility: visible;
77 | transition: width 0.2s ease-out;
78 | width: 300px;
79 | }
80 |
81 | .search-box.active .search-input-edge {
82 | display: inline-block;
83 | }
84 |
85 |
--------------------------------------------------------------------------------
/docs/css/source.css:
--------------------------------------------------------------------------------
1 | table.files-summary {
2 | width: 100%;
3 | margin: 10px 0;
4 | border-spacing: 0;
5 | border: 0;
6 | border-collapse: collapse;
7 | text-align: right;
8 | }
9 |
10 | table.files-summary tbody tr:hover {
11 | background: #eee;
12 | }
13 |
14 | table.files-summary td:first-child,
15 | table.files-summary td:nth-of-type(2) {
16 | text-align: left;
17 | }
18 |
19 | table.files-summary[data-use-coverage="false"] td.coverage {
20 | display: none;
21 | }
22 |
23 | table.files-summary thead {
24 | background: #fafafa;
25 | }
26 |
27 | table.files-summary td {
28 | border: solid 1px #ddd;
29 | padding: 4px 10px;
30 | vertical-align: top;
31 | }
32 |
33 | table.files-summary td.identifiers > span {
34 | display: block;
35 | margin-top: 4px;
36 | }
37 | table.files-summary td.identifiers > span:first-child {
38 | margin-top: 0;
39 | }
40 |
41 | table.files-summary .coverage-count {
42 | font-size: 12px;
43 | color: #aaa;
44 | display: inline-block;
45 | min-width: 40px;
46 | }
47 |
48 | .total-coverage-count {
49 | position: relative;
50 | bottom: 2px;
51 | font-size: 12px;
52 | color: #666;
53 | font-weight: 500;
54 | padding-left: 5px;
55 | }
56 |
--------------------------------------------------------------------------------
/docs/css/test.css:
--------------------------------------------------------------------------------
1 | table.test-summary thead {
2 | background: #fafafa;
3 | }
4 |
5 | table.test-summary thead .test-description {
6 | width: 50%;
7 | }
8 |
9 | table.test-summary {
10 | width: 100%;
11 | margin: 10px 0;
12 | border-spacing: 0;
13 | border: 0;
14 | border-collapse: collapse;
15 | }
16 |
17 | table.test-summary thead .test-count {
18 | width: 3em;
19 | }
20 |
21 | table.test-summary tbody tr:hover {
22 | background-color: #eee;
23 | }
24 |
25 | table.test-summary td {
26 | border: solid 1px #ddd;
27 | padding: 4px 10px;
28 | vertical-align: top;
29 | }
30 |
31 | table.test-summary td p {
32 | margin: 0;
33 | }
34 |
35 | table.test-summary tr.test-interface .toggle {
36 | display: inline-block;
37 | float: left;
38 | margin-right: 4px;
39 | cursor: pointer;
40 | font-size: 0.8em;
41 | padding-top: 0.25em;
42 | }
43 |
44 | table.test-summary tr.test-interface .toggle.opened:before {
45 | content: '▼';
46 | }
47 |
48 | table.test-summary tr.test-interface .toggle.closed:before {
49 | content: '▶';
50 | }
51 |
52 | table.test-summary .test-target > span {
53 | display: block;
54 | margin-top: 4px;
55 | }
56 | table.test-summary .test-target > span:first-child {
57 | margin-top: 0;
58 | }
59 |
--------------------------------------------------------------------------------
/docs/file/src/docs/events/events.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | src/docs/events/events.js | torrent-files-library
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
28 |
29 |
65 |
66 | src/docs/events/events.js
67 |
// events
68 |
69 | /**
70 | * missing_parameter event
71 | * @typedef {Object} Events#missing_parameter
72 | * @property {string} functionName - Indicates the function name when the error occurs.
73 | * @example
74 | * TorrentLibraryInstance.on('missing_parameter',function(callback){
75 | * console.log('Parameter is missing in ' + callback.functionName);
76 | * })
77 | */
78 |
79 | /**
80 | * error_in_function event
81 | * @typedef {Object} Events#error_in_function
82 | * @property {string} functionName - Indicates the function name when the error occurs.
83 | * @property {string} error - The error message got by error.message
84 | * @example
85 | * TorrentLibraryInstance.on('error_in_function',function(callback){
86 | * console.log('Function ' + callback.functionName + ' has the following error : ' + callback.error);
87 | * })
88 | */
89 |
90 | /**
91 | * addNewPath event
92 | * @typedef {Object} Events#addNewPath
93 | * @property {...string} paths - all the paths that were added
94 | * @example
95 | * TorrentLibraryInstance.on('addNewPath',function(callback){
96 | * console.log('The following files were added : ' + callback.paths);
97 | * })
98 | */
99 |
100 | /**
101 | * scan event
102 | * @typedef {object} Events#scan
103 | * @property {...string} files - all the files that were found and added if not yet in lib
104 | * @example
105 | * TorrentLibraryInstance.on('scan',function(callback){
106 | * console.log('The following files were found : ' + callback.files);
107 | * })
108 | */
109 |
110 | /**
111 | * removeOldFiles event
112 | * @typedef {object} Events#removeOldFiles
113 | * @property {...string} files - all the files that were found and removed if not yet in lib
114 | * @example
115 | * TorrentLibraryInstance.on('removeOldFiles',function(callback){
116 | * console.log('The following files were added : ' + callback.files);
117 | * })
118 | */
119 |
120 |
121 |
src/filters/filterBooleanProperty.js
67 |
/**
68 | * Provides a map with valid default properties
69 | * @param {searchParameters} searchObject - search parameters
70 | * @return {Map<string, boolean>} the result map
71 | */
72 | export function filterDefaultBooleanProperties(searchObject) {
73 | const {
74 | extended, unrated, proper, repack, convert, hardcoded, retail, remastered,
75 | } = searchObject;
76 |
77 |
78 | const propertiesArray = [extended, unrated, proper,
79 | repack, convert, hardcoded, retail, remastered];
80 | const propertiesNames = ['extended', 'unrated', 'proper', 'repack', 'convert',
81 | 'hardcoded', 'retail', 'remastered'];
82 |
83 | return propertiesArray.reduce((propertiesMap, val, index) => {
84 | // eslint-disable-next-line max-len
85 | if (val === true || val === false) { propertiesMap.set(propertiesNames[index], val); }
86 | return propertiesMap;
87 | }, new Map());
88 | }
89 |
90 | /**
91 | * Remove the default boolean properties
92 | * @param {searchParameters} searchObject - search parameters
93 | * @return {searchParameters} searchParameters without these properties
94 | */
95 | export function excludeDefaultBooleanProperties(searchObject) {
96 | let {
97 | extended, unrated, proper, repack, convert, hardcoded, retail, remastered,
98 | ...rest
99 | } = searchObject;
100 | return rest;
101 | }
102 |
103 | /**
104 | * Filter the set based on boolean properties
105 | * @param {Set<TPN>} set The TPN set
106 | * @param {Map<string, boolean>} propertiesMap The map from filterDefaultBooleanProperties
107 | * @return {Set<TPN>} the filtered set
108 | */
109 | export function filterByBoolean(set, propertiesMap) {
110 | // first step : get an array so that we can do filter/reduce stuff
111 | // second step : iterate the propertiesMap and do filter and return the filtered array
112 | // val[0] : the key ; val[1] : the value
113 | return new Set(Array
114 | .from(propertiesMap.entries())
115 | .reduce(
116 | // eslint-disable-next-line max-len
117 | (currentMoviesArray, val) => currentMoviesArray.filter(TPN => TPN[val[0]] === val[1])
118 | , [...set],
119 | ));
120 | }
121 |
122 |
123 |
src/filters/filterStringProperty.js
67 |
/**
68 | * Provides a map with valid default properties
69 | * @param {searchParameters} searchObject - search parameters
70 | * @return {Map<string, string|string[]>} the result map
71 | */
72 | export function filterDefaultStringProperties(searchObject) {
73 | const {
74 | title, resolution, codec, audio, group, region, container, language, source,
75 | } = searchObject;
76 |
77 |
78 | const propertiesArray = [title, resolution, codec, audio, group,
79 | region, container, language, source];
80 | const propertiesNames = ['title', 'resolution', 'codec', 'audio', 'group',
81 | 'region', 'container', 'language', 'source'];
82 |
83 | return propertiesArray.reduce((propertiesMap, val, index) => {
84 | if (val !== undefined) {
85 | propertiesMap.set(propertiesNames[index], val);
86 | }
87 | return propertiesMap;
88 | }, new Map());
89 | }
90 |
91 | /**
92 | * Remove the default string properties
93 | * @param {searchParameters} searchObject - search parameters
94 | * @return {searchParameters} searchParameters without these properties
95 | */
96 | export function excludeDefaultStringProperties(searchObject) {
97 | let {
98 | title, resolution, codec, audio, group, region, container, language, source,
99 | ...rest
100 | } = searchObject;
101 | return rest;
102 | }
103 |
104 | /**
105 | * Filter function for filterByString
106 | * @param {string} property The property to be checked
107 | * @param {string[]|string} expected The expected result
108 | * @param {TPN} object the object to be checked
109 | * @return {boolean} the result
110 | */
111 | function filterFunctionByType(property, expected, object) {
112 | if (Array.isArray(expected)) { return expected.includes(object[property]); }
113 | return object[property] === expected;
114 | }
115 |
116 | /**
117 | * Filter the set based on string properties
118 | * @param {Set<TPN>} set The TPN set
119 | * @param {Map<string, string|string[]>} propertiesMap The map from filterDefaultStringProperties
120 | * @return {Set<TPN>} the filtered set
121 | */
122 | export function filterByString(set, propertiesMap) {
123 | // first step : get an array so that we can do filter/reduce stuff
124 | // second step : iterate the propertiesMap and do filter and return the filtered array
125 | // val[0] : the key ; val[1] : the value
126 | return new Set(Array
127 | .from(propertiesMap.entries())
128 | .reduce(
129 | // eslint-disable-next-line max-len
130 | (currentMoviesArray, val) => currentMoviesArray.filter(TPN => filterFunctionByType(val[0], val[1], TPN))
131 | , [...set],
132 | ));
133 | }
134 |
135 |
136 |
test/getters/allFilesWithCategory.js
67 |
import test from 'ava';
68 | import TorrentLibrary from '../../index';
69 | import { files, folders } from '../_constants';
70 |
71 |
72 | // TESTS
73 | /** @test {TorrentLibrary#allFilesWithCategory} */
74 | test('Should correctly detect the category of each file', async (t) => {
75 | let libInstance = new TorrentLibrary();
76 | await t.notThrows(libInstance.addNewPath(...folders));
77 | await t.notThrows(libInstance.scan());
78 | t.deepEqual(
79 | new Map([
80 | [files[2], TorrentLibrary.MOVIES_TYPE],
81 | [files[0], TorrentLibrary.TV_SERIES_TYPE],
82 | [files[1], TorrentLibrary.TV_SERIES_TYPE],
83 | ]),
84 | libInstance.allFilesWithCategory,
85 | 'Not the same',
86 | );
87 | });
88 |
89 |
90 |
test/getters/allMovies.js
67 |
import test from 'ava';
68 | import path from 'path';
69 | import { parse as nameParser } from 'parse-torrent-title';
70 | import TorrentLibrary from '../../index';
71 | import { files, folders } from '../_constants';
72 |
73 | // TESTS
74 | /** @test {TorrentLibrary#allMovies} */
75 | test('Returns the movies', async (t) => {
76 | let libInstance = new TorrentLibrary();
77 | await t.notThrows(libInstance.addNewPath(...folders));
78 | await t.notThrows(libInstance.scan());
79 | t.deepEqual(
80 | new Set([
81 | Object.assign(
82 | nameParser(path.basename(files[2])),
83 | { filePath: files[2] },
84 | ),
85 | ]),
86 | libInstance.allMovies,
87 | 'Not the same',
88 | );
89 | });
90 |
91 |
92 |
93 |
test/getters/allTvSeries.js
67 |
import test from 'ava';
68 | import path from 'path';
69 | import { parse as nameParser } from 'parse-torrent-title';
70 | import TorrentLibrary from '../../index';
71 | import { files, folders } from '../_constants';
72 |
73 | // TESTS
74 | /** @test {TorrentLibrary#allTvSeries} */
75 | test('Returns the tv-shows', async (t) => {
76 | let libInstance = new TorrentLibrary();
77 | await t.notThrows(libInstance.addNewPath(...folders));
78 | await t.notThrows(libInstance.scan());
79 | t.deepEqual(
80 | new Map([
81 | [nameParser(path.basename(files[0])).title, new Set([
82 | Object.assign(
83 | nameParser(path.basename(files[0])),
84 | { filePath: files[0] },
85 | ),
86 | Object.assign(
87 | nameParser(path.basename(files[1])),
88 | { filePath: files[1] },
89 | ),
90 | ])],
91 | ]),
92 | libInstance.allTvSeries,
93 | 'Not the same',
94 | );
95 | });
96 |
97 |
98 |
99 |
test/getters/constants.js
67 |
import test from 'ava';
68 | import videosExtension from 'video-extensions';
69 | import TorrentLibrary from '../../index';
70 |
71 | /** @test {TorrentLibrary.MOVIES_TYPE} */
72 | test('Constant MOVIES_TYPE', (t) => {
73 | t.is(
74 | TorrentLibrary.MOVIES_TYPE,
75 | 'MOVIES',
76 | 'Someone changed this constant value !',
77 | );
78 | });
79 |
80 | /** @test {TorrentLibrary.TV_SERIES_TYPE} */
81 | test('Constant TV_SERIES', (t) => {
82 | t.is(
83 | TorrentLibrary.TV_SERIES_TYPE,
84 | 'TV_SERIES',
85 | 'Someone changed this constant value !',
86 | );
87 | });
88 |
89 | /** @test {TorrentLibrary.listVideosExtension} */
90 | test('List of videos extension', (t) => {
91 | t.is(
92 | TorrentLibrary.listVideosExtension(),
93 | videosExtension,
94 | 'Someone changed this constant value !',
95 | );
96 | });
97 |
98 |
99 |
test/methods/addNewPath.js
67 |
import test from 'ava';
68 | import path from 'path';
69 | import * as sinon from 'sinon';
70 | import TorrentLibrary from '../../index';
71 | import { folders } from '../_constants';
72 |
73 | // TESTS
74 | /** @test {TorrentLibrary#addNewPath} */
75 | test('missing parameter', async (t) => {
76 | let eventSpy = sinon.spy();
77 | let libInstance = new TorrentLibrary();
78 | libInstance.on('missing_parameter', eventSpy);
79 | await t.throws(libInstance.addNewPath());
80 | t.truthy(eventSpy.called, 'Event did not fire.');
81 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
82 | t.is(
83 | libInstance.hasPathsProvidedByUser(),
84 | false, 'No paths by user should be added',
85 | );
86 | });
87 |
88 | /** @test {TorrentLibrary#addNewPath} */
89 | test('Not an existent path', async (t) => {
90 | let eventSpy = sinon.spy();
91 | let libInstance = new TorrentLibrary();
92 |
93 | libInstance.on('error_in_function', eventSpy);
94 | await t.throws(libInstance.addNewPath(path.join(__dirname, 'wrongPath')));
95 | t.truthy(eventSpy.called, 'Event did not fire.');
96 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
97 | t.is(
98 | libInstance.hasPathsProvidedByUser(),
99 | false, 'No paths by user should be added',
100 | );
101 | });
102 |
103 | /** @test {TorrentLibrary#addNewPath} */
104 | test('existent paths', async (t) => {
105 | let eventSpy = sinon.spy();
106 | let libInstance = new TorrentLibrary();
107 | libInstance.on('addNewPath', eventSpy);
108 | await t.notThrows(libInstance.addNewPath(...folders));
109 | t.truthy(eventSpy.called, 'Event did not fire.');
110 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
111 | t.is(
112 | libInstance.hasPathsProvidedByUser(),
113 | true, 'The path should be added',
114 | );
115 | });
116 |
117 |
118 |
119 |
test/methods/createFromJSON.js
67 |
import test from 'ava';
68 | import TorrentLibrary from '../../index';
69 | import { folders } from '../_constants';
70 |
71 | /** @test {TorrentLibrary.createFromJSON} */
72 | test('create a perfect copy of instance', async (t) => {
73 | let libInstance = new TorrentLibrary();
74 | await t.notThrows(libInstance.addNewPath(...folders));
75 | await t.notThrows(libInstance.scan());
76 | const jsonFromLib = JSON.parse(libInstance.toJSON());
77 | const createdInstance = TorrentLibrary.createFromJSON(jsonFromLib);
78 | t.deepEqual(
79 | createdInstance.allFilesWithCategory,
80 | libInstance.allFilesWithCategory,
81 | 'allFilesWithCategory different',
82 | );
83 | t.deepEqual(
84 | createdInstance.allMovies,
85 | libInstance.allMovies, 'allMovies different',
86 | );
87 | t.deepEqual(
88 | createdInstance.allTvSeries,
89 | libInstance.allTvSeries, 'allTvSeries different',
90 | );
91 | });
92 |
93 | // dummy test for ES6 code coverage
94 | /** @test {TorrentLibrary.createFromJSON} */
95 | test('empty instance(s)', async (t) => {
96 | TorrentLibrary.createFromJSON({});
97 | t.pass();
98 | });
99 |
100 |
101 |
test/methods/scan.js
67 |
import test from 'ava';
68 | import * as sinon from 'sinon';
69 | import { parse as nameParser } from 'parse-torrent-title';
70 | import TorrentLibrary from '../../index';
71 | import { folders } from '../_constants';
72 |
73 | // TESTS
74 | /** @test {TorrentLibrary#scan} */
75 | test('Scan without user provided paths', async (t) => {
76 | let eventSpy = sinon.spy();
77 | let libInstance = new TorrentLibrary();
78 | libInstance.on('scan', eventSpy);
79 | await t.notThrows(libInstance.scan());
80 | t.truthy(eventSpy.called, 'Event did not fire.');
81 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
82 | });
83 |
84 | /** @test {TorrentLibrary#scan} */
85 | test('Scan with user provided paths', async (t) => {
86 | let eventSpy = sinon.spy();
87 | let libInstance = new TorrentLibrary();
88 | libInstance.on('scan', eventSpy);
89 | // whatever path that should exists
90 | await t.notThrows(libInstance.addNewPath(...folders));
91 | await t.notThrows(libInstance.scan());
92 | t.truthy(eventSpy.called, 'Event did not fire.');
93 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
94 | });
95 |
96 | // test to handle default parameters
97 | /** @test {TorrentLibrary#scan} */
98 | test('Scan with user provided paths and custom parser', async (t) => {
99 | let eventSpy = sinon.spy();
100 | let libInstance = new TorrentLibrary({}, nameParser);
101 | libInstance.on('scan', eventSpy);
102 | // whatever path that should exists
103 | await t.notThrows(libInstance.addNewPath(...folders));
104 | await t.notThrows(libInstance.scan());
105 | t.truthy(eventSpy.called, 'Event did not fire.');
106 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
107 | });
108 |
109 | /** @test {TorrentLibrary#scan} */
110 | test('Scan with user provided paths and wrong custom parser', async (t) => {
111 | let eventSpy = sinon.spy();
112 | let libInstance = new TorrentLibrary({}, {});
113 | libInstance.on('error_in_function', eventSpy);
114 | // whatever path that should exists
115 | await t.notThrows(libInstance.addNewPath(...folders));
116 | await t.throws(libInstance.scan());
117 | t.truthy(eventSpy.called, 'Event did not fire.');
118 | t.truthy(eventSpy.calledOnce, 'Event fired more than once');
119 | });
120 |
121 |
122 |
test/methods/toJSON.js
67 |
import test from 'ava';
68 | import TorrentLibrary from '../../index';
69 | import { expectedJson, folders } from '../_constants';
70 |
71 | /** @test {TorrentLibrary#toJSON} */
72 | test('return a valid stringified JSON', async (t) => {
73 | const expectedJsonString = JSON.stringify(expectedJson);
74 | let libInstance = new TorrentLibrary();
75 | await t.notThrows(libInstance.addNewPath(...folders));
76 | await t.notThrows(libInstance.scan());
77 | const dataFromInstance = libInstance.toJSON();
78 | t.deepEqual(
79 | JSON.stringify(JSON.parse(dataFromInstance)),
80 | expectedJsonString,
81 | 'Not the same JSON',
82 | );
83 | });
84 |
85 |
86 |
23 |
24 | 