Conversion to use dependency injection

Author: addaleax

.gitignore

@@ -1,3 +1,19 @@
-/node_modules
-/test/build
-/?.js
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+node_modules
+npm-debug.log
+.nyc_output/
+coverage
+build
+node-addon-api

.travis.yml

@@ -1,33 +1,21 @@
 sudo: false
 
 env:
-  - CXX=g++-4.8
+  - CXX=g++-4.9
 addons:
   apt:
     sources:
       - ubuntu-toolchain-r-test
     packages:
-      - g++-4.8
+      - g++-4.9
 
 language: node_js
 
 node_js:
-  - "4"
-  - "5"
   - "6"
-  - "7"
   - "8"
+  - "9"
 
-install:
-  - PATH="`npm bin`:`npm bin -g`:$PATH"
-  # Node 0.8 comes with a too obsolete npm
-  - if [[ "`node --version`" =~ ^v0\.8\. ]]; then npm install -g [email protected] ; fi
-  # Install dependencies and build
-  - npm install
-
-script:
-  # Output useful info for debugging
-  - node --version
-  - npm --version
-  # Run tests
-  - npm test
+after_success:
+  - npm install coveralls
+  - nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nathan Rajlich <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,20 +1,27 @@
-ref-struct
-==========
+ref-struct-di
+=============
 ### Create ABI-compliant "[struct][]" instances on top of Buffers
-[![Build Status](https://secure.travis-ci.org/TooTallNate/ref-struct.svg)](https://travis-ci.org/TooTallNate/ref-struct)
-[![Build Status](https://ci.appveyor.com/api/projects/status/6v4h5v5kh9kmtke8?svg=true)](https://ci.appveyor.com/project/TooTallNate/ref-struct)
 
+[![NPM Version](https://img.shields.io/npm/v/ref-struct-di.svg?style=flat)](https://npmjs.org/package/ref-struct-di)
+[![NPM Downloads](https://img.shields.io/npm/dm/ref-struct-di.svg?style=flat)](https://npmjs.org/package/ref-struct-di)
+[![Build Status](https://travis-ci.org/node-ffi-napi/ref-struct-di.svg?style=flat&branch=master)](https://travis-ci.org/node-ffi-napi/ref-struct-di?branch=master)
+[![Coverage Status](https://coveralls.io/repos/node-ffi-napi/ref-struct-di/badge.svg?branch=master)](https://coveralls.io/r/node-ffi-napi/ref-struct-di?branch=master)
+[![Dependency Status](https://david-dm.org/node-ffi-napi/ref-struct-di.svg?style=flat)](https://david-dm.org/node-ffi-napi/ref-struct-di)
 
 This module offers a "struct" implementation on top of Node.js Buffers
 using the ref "type" interface.
 
+**Note**: The only difference to `ref-struct` is that this module takes its
+dependency on `ref` via dependency injection, so that it is easier to use
+e.g. `ref-napi` instead.
+
 Installation
 ------------
 
 Install with `npm`:
 
 ``` bash
-$ npm install ref-struct
+$ npm install ref-struct-di
 ```
 
 
@@ -32,7 +39,7 @@ struct timeval {
 
 ``` js
 var ref = require('ref')
-var StructType = require('ref-struct')
+var StructType = require('ref-struct-di')(ref)
 
 // define the time types
 var time_t = ref.types.long

appveyor.yml

@@ -2,32 +2,25 @@
 
 # Test against these versions of Node.js.
 environment:
-  # Visual Studio Version
-  MSVS_VERSION: 2013
   # Test against these versions of Node.js and io.js
   matrix:
-    - nodejs_version: "4"
+    # node.js
     - nodejs_version: "6"
-    - nodejs_version: "7"
     - nodejs_version: "8"
+    - nodejs_version: "9"
 
 platform:
   - x86
   - x64
 
 # Install scripts. (runs after repo cloning)
 install:
-  # Get the latest stable version of Node 0.STABLE.latest
-  - ps: if($env:nodejs_version -eq "0.8") {Install-Product node $env:nodejs_version}
-  - ps: if($env:nodejs_version -ne "0.8") {Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version)}
-  # Node 0.8 comes with a too obsolete npm
-  - IF %nodejs_version% == 0.8 (npm install -g [email protected])
-  # Install latest NPM only for node.js versions until built in node-gyp adds io.js support
-  # Update is required for node.js 0.8 because built in npm(node-gyp) does not know VS2013
-  - IF %nodejs_version% LSS 1 (npm install -g npm@2)
-  - IF %nodejs_version% LSS 1 set PATH=%APPDATA%\npm;%PATH%
-  # Typical npm stuff.
-  - npm install --msvs_version=%MSVS_VERSION%
+  - python -V
+  - set PYTHON=python
+  - ps: Install-Product node $env:nodejs_version $env:platform
+  - node -p process.arch
+  - node -p process.version
+  - npm install
 
 # Post-install test scripts.
 test_script:

code-of-conduct.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project maintainer at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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.
+
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

lib/struct.js

@@ -1,4 +1,4 @@
-
+'use strict';
 /**
  * An interface for modeling and instantiating C-style data structures. This is
  * not a constructor per-say, but a constructor generator. It takes an array of
@@ -46,7 +46,6 @@
  * Module dependencies.
  */
 
-var ref = require('ref')
 var util = require('util')
 var assert = require('assert')
 var debug = require('debug')('ref:struct')
@@ -55,7 +54,7 @@ var debug = require('debug')('ref:struct')
  * Module exports.
  */
 
-module.exports = Struct
+module.exports = function (ref) {
 
 /**
  * The Struct "type" meta-constructor.
@@ -358,3 +357,7 @@ proto.inspect = function inspect () {
 proto.ref = function ref () {
   return this['ref.buffer']
 }
+
+return Struct;
+
+};

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "ref-struct",
+  "name": "ref-struct-di",
   "description": "Create ABI-compliant \"struct\" instances on top of Buffers",
   "keywords": [
     "struct",
@@ -10,24 +10,29 @@
     "ffi"
   ],
   "version": "1.1.0",
-  "author": "Nathan Rajlich <[email protected]> (http://tootallnate.net)",
+  "author": "Anna Henningsen <[email protected]>",
+  "contributors": [
+    "Nathan Rajlich <[email protected]>"
+  ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/TooTallNate/ref-struct.git"
+    "url": "git://github.com/node-ffi-napi/ref-struct-di.git"
   },
   "main": "./lib/struct.js",
   "license": "MIT",
   "scripts": {
-    "test": "node-gyp rebuild --directory test && mocha -gc --reporter spec"
+    "test": "node-gyp rebuild --directory test && nyc mocha -gc --reporter spec"
   },
   "dependencies": {
-    "debug": "2",
-    "ref": "1"
+    "debug": "^3.1.0"
   },
   "devDependencies": {
+    "binding": "^3.0.3",
     "bindings": "~1.2.0",
-    "nan": "2",
-    "mocha": "*",
-    "ref-array": "~1.1.2"
+    "mocha": "^4.0.1",
+    "nan": "^2.8.0",
+    "nyc": "^11.3.0",
+    "ref-array": "^1.2.0",
+    "ref-napi": "^1.4.0"
   }
 }

test/struct.js

@@ -1,8 +1,8 @@
-
+'use strict';
 var assert = require('assert')
   , ref = require('ref')
   , ArrayType = require('ref-array')
-  , Struct = require('../')
+  , Struct = require('../')(ref)
   , bindings = require('bindings')({ module_root: __dirname, bindings: 'struct_tests' })
 
 describe('Struct', function () {