Refactor and Add Tests

[ReubenHill]

Big pull request which changes the API and makes everything much more robust.

Notes

• Only exports what is necessary
• Splits front and back end. Back end is now accessed via submodule LibFTD2XX.Wrapper (resolves #8)
• Supports much more back-end functionality
• Massively improves test coverage to cover all functions (resolves #5)
• Much improved documentation (resolves #9)
• resolves #16 and generally makes everything much more robust
• drops 0.6 support
• update licence/copyright notices

Issues

• Only cross-platform (OSX, Linux and Windows) features supported. For example there is no support yet of FTOpenEx with FT_OPEN_BY_LOCATION flag.
• Some cross-platform library functions are not yet supported.
• Needs auto-generated documentation.
• .Wrapper functions which fail throw FT_STATUS_ENUMs instead of exceptions. This should be replaced with a suitable exception type.
• timeouts = 0 are allowed but their behaviour is currently undefined. This needs investigation.
• test on linux and macos with hardware
• CI fails on linux but works on local linux machines. (See report at https://travis-ci.org/Gowerlabs/LibFTD2XX.jl/builds/511412464)

Todo

• [x] Document changes
• [x] Document all existing issues
  • [x] Only cross-platform (OSX, Linux and Windows) features supported. For example there is no support yet of FTOpenEx with FT_OPEN_BY_LOCATION flag.
  • [x] Missing cross-platform functions in library
  • [x] Needs auto-generated documentation
• [x] Test on Julia 0.6
• [x] Support timeout setting on front end
• [x] Update readme.md
• [x] Test with real use case to make sure nothing is broken
• [x] Stop functions that are not macos/linux compatible running on those platforms
• [x] Deal with CI failure on linux

[codecov-io]

Codecov Report

Merging #27 into master will increase coverage by 57.36%. The diff coverage is 49.07%.

@@             Coverage Diff             @@
##           master      #27       +/-   ##
===========================================
+ Coverage     2.8%   60.17%   +57.36%     
===========================================
  Files           1        3        +2     
  Lines         107      231      +124     
===========================================
+ Hits            3      139      +136     
+ Misses        104       92       -12

Impacted Files	Coverage Δ
src/wrapper.jl	73.33% <100%> (ø)
src/LibFTD2XX.jl	43.8% <44.89%> (+41%)	:arrow_up:
src/util.jl	83.33% <83.33%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update dfe0102...6dea8de. Read the comment docs.

[samuelpowell]

Drop 0.6 for sure

[ReubenHill]

Ready for review. @samuelpowell do you know how to get codecoverage to update?

[samuelpowell]

@ReubenHill it may be that the configuration scripts are out of date. I would suggest using PkgTemplates.jl to create the files you want with the appropriate options and then graft them into this repo as appropriate.

[samuelpowell]

@ReubenHill will clone and look through in further detail once you've addressed above

[samuelpowell]

Also, I know it's a bit late now, but had you not considered using Clang.jl? See e.g. Spinnaker.jlto see what it does.

[ReubenHill]

Also, I know it's a bit late now, but had you not considered using Clang.jl? See e.g. Spinnaker.jlto see what it does.

I decided learning how to use Clang.jl would take more time than expanding what I had already to cover more functions. In hindsight, that might have been wrong. The majority of this has been adding tests, making more robust and and adding high level stuff.