vatrates - npm Package Compare versions

Comparing version 1.2.3 to 2.0.0

package.json

 {
   "name": "vatrates",
   "title": "VATRates",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "description": "Up-to-date European VAT Rates",
@@ -12,5 +12,5 @@ "keywords": [
   ],
-  "homepage": "http://github.com/staaky/vatrates",
+  "homepage": "http://vatrates.nickstakenburg.com",
   "bugs": "http://github.com/staaky/vatrates/issues",
-  "main": "./vatrates.js",
+  "main": "./dist/vatrates.js",
   "repository": {
@@ -24,12 +24,33 @@ "type": "git",
   },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "http://choosealicense.com/licenses/mit/"
-    }
-  ],
+  "license": "MIT",
+  "scripts": {
+    "mocha": "mocha ./tests/mocha/tests.js",
+    "peridot": "php ./vendor/peridot-php/peridot/bin/peridot -c ./tests/peridot.php",
+    "test": "npm run peridot && npm run mocha"
+  },
   "devDependencies": {
-    "grunt": "^0.4.5",
-    "grunt-contrib-copy": "^0.8.1"
+    "babel-cli": "^6.18.0",
+    "babel-core": "^6.22.1",
+    "babel-loader": "^6.2.10",
+    "babel-preset-env": "^1.1.5",
+    "babel-preset-es2015": "^6.18.0",
+    "babel-preset-latest": "^6.16.0",
+    "bootstrap": "^4.0.0-alpha.6",
+    "browser-sync": "^2.18.6",
+    "browserify": "^11.0.1",
+    "chai": "^3.5.0",
+    "gulp": "^3.9.0",
+    "gulp-connect-php": "0.0.8",
+    "gulp-util": "^3.0.6",
+    "gulp-watch": "^4.3.11",
+    "jquery": "^3.1.1",
+    "mocha": "^3.2.0",
+    "moment": "^2.17.1",
+    "pikaday": "^1.5.1",
+    "require-dir": "^0.3.1",
+    "vinyl-buffer": "^1.0.0",
+    "vinyl-source-stream": "^1.1.0",
+    "webpack": "^2.2.1",
+    "webpack-stream": "^3.2.0"
   }
 }

README.md

@@ -1,30 +0,454 @@
-# VAT Rates
+# VATRates
 
 _Up-to-date European VAT Rates_
 
-As of 1 January 2015 new EU VAT regulations change the way in which VAT (consumer tax) is charged on digital services. Instead of the tax rate being applied according to where the supplier is located, the seller must determine where the buyer is located and apply the relevant local rate of tax to the purchaser.
+[vatrates.nickstakenburg.com](http://vatrates.nickstakenburg.com)
 
-See: http://ec.europa.eu/taxation_customs/taxation/vat/how_vat_works/telecom
+VAT rates stored in `JSON` format, with [Javascript](#javascript) and [PHP](#php) classes for easy access.
 
-This repository provides files in different formats (Javascript, JSON & PHP) to help you apply these local VAT rates.
+## Install
 
-## Updates
+Install through npm:
 
-VAT rates are updated using data provided by the [European Commission](http://ec.europa.eu/taxation_customs/resources/documents/taxation/vat/how_vat_works/rates/vat_rates_en.pdf) and [VATLive.com](http://www.vatlive.com).
+```
+npm install vatrates
+```
 
-If you notice anything out of date or would like to contribute, please create an issue or a pull request.
+For the PHP package, use composer:
 
-## Install
+```
+composer require staaky/vatrates
+```
 
-Pick the files you need or install via [Bower](http://bower.io) or npm:
+## Javascript
 
-* `bower install vatrates`
-* `npm install vatrates`
+Require vatrates or use a script tag to include vatrates.js:
 
-## License
+``` js
+var vatRates = require('vatrates');
+```
 
-Everything is [MIT Licensed](http://choosealicense.com/licenses/mit/), have at it!
+```
+<script type='text/javascript' src='vatrates.js'></script>
+```
 
-* * *
+Create an instance using `new VATRates()` and use the `isVATCountry()` check before calling any of the other functions that return VAT rates.
 
-[Nick Stakenburg](http://www.nickstakenburg.com)
+``` js
+var VATRates = require('vatrates');
+
+var vatRates = new VATRates();
+if (vatRates.isVATCountry('RO')) {
+    console.log(vatRates.getSuperReducedRate('RO')); // -> undefined
+    console.log(vatRates.getReducedRates('RO'));     // -> [5, 9]
+    console.log(vatRates.getStandardRate('RO'));     // -> 19
+    console.log(vatRates.getParkingRate('RO'));      // -> undefined
+}
+```
+
+Default rates are for today, to get rates for a different day pass in a `Date`:
+
+``` js
+var vatRates = new VATRates(new Date('2016-01-01'));
+if (vatRates.isVATCountry('RO')) {
+    console.log(vatRates.getStandardRate('RO')); // -> 20
+}
+```
+
+You can also change the date by calling `setDate()` on a previously created instance:
+
+``` js
+var vatRates = new VATRates();
+vatRates.setDate(new Date('2015-01-01'));
+if (vatRates.isVATCountry('RO')) {
+    console.log(vatRates.getStandardRate('RO')); // -> 24
+}
+``` 
+
+### getCountry(countryCode)
+
+Another approach is to use `getCountry()`, it returns a `VATCountry` or `undefined` if the country doesn't use VAT. With a VATCountry you'll have all the VAT rate functions and some extra helpers.
+
+``` js
+var vatRates = new VATRates();
+var country;
+if ((country = vatRates.getCountry('GB'))) {
+    console.log(country.getName());             // -> "United Kingdom"
+    console.log(country.getCode());             // -> "UK"
+    console.log(country.getCountryCode());      // -> "GB"
+    console.log(country.getSuperReducedRate()); // -> undefined
+    console.log(country.getReducedRates());     // -> [5]
+    console.log(country.getStandardRate());     // -> 20
+    console.log(country.getParkingRate());      // -> undefined
+}
+```
+
+The United Kingdom and Greece use extra non standard country codes "UK" and "EL", these are also accepted.
+
+``` js
+vatRates.getCountry('UK'); // -> same result as 'GB'
+```
+
+### getCountries()
+
+Returns an `Array` of all the countries using VAT, as `VATCountry`'s.
+
+``` js
+var vatRates = new VATRates();
+var countries = vatRates.getCountries();
+
+countries.forEach(function(country) {
+  console.log(country.getCountryCode() + " has VAT: " + country.getStandardRate());
+});
+```
+
+### setDate(date)
+
+Set the `Date` for which to return VAT rates.
+
+``` js
+var vatRates = new VATRates();
+vatRates.setDate(new Date('2015-01-01'));
+```
+
+This is identical to:
+
+``` js
+var vatRates = new VATRates(new Date('2015-01-01'));
+```
+
+> All other functions takes this date into account, so make sure to always set the date first.
+
+### isVATCountry(countryCode)
+
+Returns `true` if a country uses VAT, or `false` if not.
+
+``` js
+var vatRates = new VATRates();
+console.log(vatRates.isVATCountry('FR')); // -> true
+console.log(vatRates.isVATCountry('US')); // -> false
+```
+
+### getSuperReducedRate(countryCode)
+
+Returns the super reduced rate for a country, or `undefined` when none is available.
+
+``` js
+var vatRates = new VATRates();
+if (vatRates.isVATCountry('FR')) {
+  console.log(vatRates.getSuperReducedRate('FR')); // -> 2.1
+});
+```
+
+A `VATCountry` returned by `getCountry()` offers this method directly.
+
+``` js
+var vatRates = new VATRates();
+var country;
+if ((country = vatRates.getCountry('FR'))) {
+  console.log(country.getName());             // -> "France"
+  console.log(country.getSuperReducedRate()); // -> 2.1
+}
+```
+
+### getReducedRates(countryCode)
+
+Returns an `Array` of reduced rates for a country, or `undefined` when none are available.
+
+``` js
+var vatRates = new VATRates();
+if (vatRates.isVATCountry('IE')) {
+  console.log(vatRates.getReducedRates('IE')); // -> [9, 13.5]
+});
+```
+
+A `VATCountry` offers this method directly.
+
+``` js
+var vatRates = new VATRates();
+var country;
+if ((country = vatRates.getCountry('IE'))) {
+  console.log(country.getName());         // -> "Ireland"
+  console.log(country.getReducedRates()); // -> [9, 13.5]
+}
+```
+
+### getStandardRate(countryCode)
+
+Returns the standard rate for a country, or `undefined` when none is available.
+
+``` js
+var vatRates = new VATRates();
+if (vatRates.isVATCountry('NL')) {
+  console.log(vatRates.getStandardRate('NL')); // -> 21
+});
+```
+
+A `VATCountry` offers this method directly.
+
+``` js
+var vatRates = new VATRates();
+var country;
+if ((country = vatRates.getCountry('NL'))) {
+  console.log(country.getName());         // -> "Netherlands"
+  console.log(country.getStandardRate()); // -> 21
+}
+```
+
+### getParkingRate(countryCode)
+
+Returns the parking rate for a country, or `undefined` when none is available.
+
+``` js
+var vatRates = new VATRates();
+if (vatRates.isVATCountry('LU')) {
+  console.log(vatRates.getParkingRate('LU')); // -> 14
+}
+```
+
+A `VATCountry` offers this method directly.
+
+``` js
+var vatRates = new VATRates();
+var country;
+if ((country = vatRates.getCountry('LU'))) {
+  console.log(country.getName());        // -> "Luxembourg"
+  console.log(country.getParkingRate()); // -> 14
+}
+```
+
+## PHP
+
+After installing through composer use `Staaky\VATRates\VATRates`
+
+``` php
+use Staaky\VATRates\VATRates;
+```
+
+Create an instance using `new VATRates()` and use the `isVATCountry()` check before calling any of the other functions that return VAT rates.
+
+``` php
+use Staaky\VATRates\VATRates;
+
+$vatRates = new VATRates();
+if ($vatRates->isVATCountry('RO')) {
+    var_dump($vatRates->getSuperReducedRate('RO')); // -> null
+    var_dump($vatRates->getReducedRates('RO'));     // -> [5, 9]
+    var_dump($vatRates->getStandardRate('RO'));     // -> 19
+    var_dump($vatRates->getParkingRate('RO'));      // -> null
+}
+```
+
+Default rates are for today, to get rates for a different day pass in a `DateTime`:
+
+``` php
+$vatRates = new VATRates(new DateTime('2016-01-01'));
+if ($vatRates->isVATCountry('RO')) {
+    var_dump($vatRates->getStandardRate('RO')); // -> 20
+}
+```
+
+You can also change the date by calling `setDate()` on a previously created instance:
+
+``` php
+$vatRates = new VATRates();
+$vatRates->setDate(new DateTime('2015-01-01'));
+if ($vatRates->isVATCountry('RO')) {
+    var_dump($vatRates->getStandardRate('RO')); // -> 24
+}
+```
+
+### getCountry(countryCode)
+
+Another approach is to use `getCountry()`, it returns a `VATCountry` or `undefined` if the country doesn't use VAT. With a `VATCountry` you'll have all the VAT rate functions and some extra helpers.
+
+``` php
+$vatRates = new VATRates();
+if (($country = $vatRates->getCountry('GB'))) {
+    var_dump($country->getName());             // -> "United Kingdom"
+    var_dump($country->getCode());             // -> "UK"
+    var_dump($country->getCountryCode());      // -> "GB"
+    var_dump($country->getSuperReducedRate()); // -> null
+    var_dump($country->getReducedRates());     // -> [5]
+    var_dump($country->getStandardRate());     // -> 20
+    var_dump($country->getParkingRate());      // -> null
+}
+```
+
+The United Kingdom and Greece use extra non standard country codes "UK" and "EL", these are also accepted.
+
+``` php
+$vatRates->getCountry('UK'); // -> same result as 'GB'
+```
+
+### getCountries()
+
+Returns an `array` of all the countries using VAT, as `VATCountry`'s.
+
+``` php
+$vatRates = new VATRates();
+$countries = $vatRates->getCountries();
+
+foreach ($countries as $country) {
+  print_r($country->getCountryCode() . " has VAT: " . $country->getStandardRate() . "\n");
+}
+```
+
+### setDate(DateTime $date)
+
+Set the date for which to return VAT rates.
+
+``` php
+$vatRates = new VATRates();
+$vatRates->setDate(new DateTime('2015-01-01'));
+```
+
+This is identical to:
+
+``` php
+$vatRates = new VATRates(new DateTime('2015-01-01'));
+```
+
+> All other functions takes this date into account, so make sure to always set the date first.
+
+### isVATCountry($countryCode)
+
+Returns `true` if a country uses VAT, or `false` if not.
+
+``` php
+$vatRates = new VATRates();
+var_dump($vatRates->isVATCountry('FR')); // -> true
+var_dump($vatRates->isVATCountry('US')); // -> false
+```
+
+### getSuperReducedRate($countryCode)
+
+Returns the super reduced rate for a country, or `null` if none is available.
+
+``` php
+$vatRates = new VATRates();
+if ($vatRates->isVATCountry('FR')) {
+  var_dump($vatRates->getSuperReducedRate('FR')); // -> 2.1
+});
+```
+
+A `VATCountry` returned by `getCountry()` offers this method directly.
+
+``` php
+$vatRates = new VATRates();
+if (($country = $vatRates->getCountry('FR'))) {
+  var_dump($country->getName());             // -> "France"
+  var_dump($country->getSuperReducedRate()); // -> 2.1
+}
+```
+
+### getReducedRates($countryCode)
+
+Returns an `array` of reduced rates for a country, or `null` if none are available.
+
+``` php
+$vatRates = new VATRates();
+if ($vatRates->isVATCountry('IE')) {
+  var_dump($vatRates->getReducedRates('IE')); // -> [9, 13.5]
+}
+```
+
+A `VATCountry` offers this method directly.
+
+``` php
+$vatRates = new VATRates();
+if (($country = $vatRates->getCountry('IE'))) {
+  var_dump($country->getName());         // -> "Ireland"
+  var_dump($country->getReducedRates()); // -> [9, 13.5]
+}
+```
+
+### getStandardRate($countryCode)
+
+Returns the standard rate for a country, or `null` when none is available.
+
+``` php
+$vatRates = new VATRates();
+if ($vatRates->isVATCountry('NL')) {
+  var_dump($vatRates->getStandardRate('NL')); // -> 21
+});
+```
+
+A `VATCountry` offers this method directly.
+
+``` php
+$vatRates = new VATRates();
+if (($country = $vatRates->getCountry('NL'))) {
+  var_dump($country->getName());         // -> "Netherlands"
+  var_dump($country->getStandardRate()); // -> 21
+}
+```
+
+### getParkingRate($countryCode)
+
+Returns the parking rate for a country, or `null` when none is available.
+
+``` php
+$vatRates = new VATRates();
+if ($vatRates->isVATCountry('LU')) {
+  var_dump($vatRates->getParkingRate('LU')); // -> 14
+});
+```
+
+A `VATCountry` offers this method directly.
+
+``` php
+$vatRates = new VATRates();
+if (($country = $vatRates->getCountry('LU'))) {
+  var_dump($country->getName());        // -> "Luxembourg"
+  var_dump($country->getParkingRate()); // -> 14
+}
+```
+
+## Development
+
+### Webpack
+
+Use `webpack` to create a new build after you've made changes.
+
+```
+webpack
+```
+
+### Gulp
+
+Use `gulp` to load up the page in the `/example` folder. It shows the output of all files (Javascript, JSON & PHP) and automatically rebuilds with webpack as you modify source code.
+
+```
+gulp
+```
+
+### Unit Tests
+
+Run unit tests using `npm test`, this runs tests for every language.
+
+```
+npm test
+```
+
+Javascript tests are run with [Mocha](https://mochajs.org) and PHP tests with [Peridot](http://peridot-php.github.io). They can be run individually as well:
+
+```
+npm run mocha
+```
+
+```
+npm run peridot
+```
+
+## Contribute
+
+VAT rates are kept up to date **manually** using data from the [European Commission](http://ec.europa.eu/taxation_customs/resources/documents/taxation/vat/how_vat_works/rates/vat_rates_en.pdf) and [VATLive.com](http://www.vatlive.com). Initial historic rates are based on data from [jsonvat.com](http://jsonvat.com).
+
+If you notice an incorrect rate please [create an issue](https://github.com/staaky/vatrates/issues) or send a pull request. Future VAT changes can also be added to the `JSON` file. If you know of an upcoming change that isn't there yet, please let me know.
+
+Data on historic VAT rates is also appreciated. This can be hard to track down, especially the non-standard rates.
+
+## License
+
+VATRates is [MIT Licensed](https://raw.githubusercontent.com/staaky/vatrates/master/LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

134534

increased by157.17%

Number of package files

33

increased by73.68%

Lines of code

2489

increased by72.25%

Number of lines in readme file

455

increased by1367.74%

Worsened metrics

Dev dependency count

23

increased by1050%

Number of low quality alerts

1

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes