shopify-measurementjs
v0.1.0
Published
Fork of measurement.js with everything properly published
Downloads
3
Readme
MeasurementJs
Nice unit of measure conversion, featuring:
- Simplicity: an easy to-use, Behaviour driven API
- Sophistication: full test coverage from project day one
- Quality: aiming at high performance whilst maintaining a fair trade-off between accuracy
- Adaptability: Easy to extend for new measurement types (incl. i18n tables)
measurement('Temperature').convert(20)
.from(measurement.Unit.Temperature.CELSIUS)
.to(measurement.Unit.Temperature.FAHRENHEIT); // returns 68
measurement('Distance').convert(1)
.from(measurement.Unit.Distance.KILOMETRE)
.to(measurement.Unit.Distance.METRE); // returns 1000
measurement('Speed').convert(10)
.from(measurement.Unit.Speed.KILOMETRE_PER_HOUR)
.to(measurement.Unit.Speed.METRE_PER_SECOND); // returns 2.7777777777777777
Test-Driven Development
The API definition and all conversion operations are covered by jasmine tests. The test suite can be executed straightaway and easily, for example:
Test directly in the browser Simply open test/index.html in the browser
PhantomJs via Karma test driver
npm run-script karma
That command is just a shorthand fornode_modules/.bin/karma start
. If you havekarma-cli
already installed globally, you can also just dokarma start
. Karma will startup and run all tests on phantomjsAny Browser you like with Karma
- Set
singleRun:false
in./karma.conf.js
- Start the Karma with
npm run-script karma
ornpm test
or ... (see above) - navigate any browser you'd like to test to http://localhost:9876
- observe the output on the test console
- Set
Roadmap
For current and future state of affairs, have a peek at the Roadmap in the root project folder.
Get it
Currently you only need to download and include measurement.js in your project.
latest release - install via NPM:
In case the node package manager is part of your development stack, this may be more comfortable for you:
Currently tested platforms
Please feel free to add your own test results.
PhantomJS 1.9.7 (Linux): Executed 46 of 46 SUCCESS (0.027 secs / 0.022 secs)
Chrome 18.0.1025 (Linux): Executed 46 of 46 SUCCESS (0.06 secs / 0.035 secs)
Firefox 28.0.0 (Ubuntu): Executed 46 of 46 SUCCESS (0.037 secs / 0.026 secs)
Inspiring projects
- http://www.codeproject.com/Articles/23087/Measurement-Unit-Conversion-Library (a C# / XML based approach)
- http://momentjs.com/ (Beautiful & small code base, great simplistic API - role model for MeasurementJs)
- http://www.convert-me.com/en/convert/weight/ (all possible conversions one could think of already implemented in JS)