hapi-pioc - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
-    "name": "hapi-pioc",
-    "version": "0.1.0",
-    "description": "A plugin for hapi.js that integrates the pioc Dependency Injection Container for node.js",
-    "main": "index.js",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/pago/hapi-pioc.git"
-    },
-    "keywords": [
-        "hapi",
-        "dependency injection",
-        "provider",
-        "module",
-        "container",
-        "dependency",
-        "pioc",
-        "dic",
-        "ioc",
-        "di"
-    ],
-    "author": "Patrick Gotthardt <[e-mail]>",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/pago/hapi-pioc/issues"
-    },
-    "homepage": "https://github.com/pago/hapi-pioc"
+  "name": "hapi-pioc",
+  "version": "0.1.1",
+  "description": "A plugin for hapi.js that integrates the pioc Dependency Injection Container for node.js",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pago/hapi-pioc.git"
+  },
+  "keywords": [
+    "hapi",
+    "dependency injection",
+    "provider",
+    "module",
+    "container",
+    "dependency",
+    "pioc",
+    "dic",
+    "ioc",
+    "di"
+  ],
+  "author": "Patrick Gotthardt <[e-mail]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pago/hapi-pioc/issues"
+  },
+  "homepage": "https://github.com/pago/hapi-pioc",
+  "dependencies": {
+    "pioc": "^1.2.1"
+  }
 }

README.md

@@ -88,1 +88,87 @@ # hapi-pioc
 ```
+
+The above `Post` service is defined like this:
+
+```javascript
+var Joi = require('joi'),
+    MongoQuery = require('lib/MongoQueryMixin'),
+    ValidateMixin = require('lib/ValidateMixin');
+
+exports[MongoQuery.collection] = 'posts';
+exports[MongoQuery.indexes] = [
+    [{slug: 1}, {unique: true}],
+    [{tags: 1}]
+];
+Object.assign(exports, MongoQuery.Mixin, ValidateMixin, {
+    schema: Joi.object().keys({
+        slug: Joi.string().required(),
+        title: Joi.string().required(),
+        content: Joi.string().required(),
+        html: Joi.string().optional(),
+        tags: Joi.array().includes(Joi.string()).optional(),
+        createdAt: Joi.date().required(),
+        updatedAt: Joi.date().required()
+    }),
+
+    getBySlug(slug) {
+        return this.findOne({ slug });
+    },
+
+    getPage(query, options = { sort: '-created', limit: 20, page: 1 }, fields = '') {
+        var { sort, limit, page } = options;
+        return this.pagedFind(query, fields, sort, limit, page);
+    },
+
+    updateById(id, data) {
+        var update = { $set: data };
+        update.$currentDate = { updatedAt: true };
+        return this.findByIdAndUpdate(id, update);
+    }
+});
+```
+
+You'll probably notice that I'm still using the `require` statement and that is
+just fine. The two mixins that I'm importing are utilities, not services.
+Being mixins however, they can naturally depend on services themself, like this:
+
+```javascript
+import { inject } from 'pioc';
+import Mongo from 'mongodb';
+import Promise from 'bluebird';
+
+/**
+* A mixin for objects that expose the following properties:
+* - [collection]: String => The collection name
+* - [indexes]: Array<IndexDefinition> => the indexes
+*/
+export var collection = Symbol();
+export var indexes = Symbol();
+export var Mixin = {
+    connection: inject('MongoConnection'),
+
+    collection() {
+        return this.connection.get().then(db => db.collection(this[collection]));
+    },
+    // ...
+};
+```
+
+This pattern is well supported by pioc and when the `Post` service is resolved,
+the `MongoConnection` service is injected into the `Post` service.
+
+If, at some point, I were to decide that I'd like to use a cache in front of
+the `Post` service, I'd just define it as the service implementation by updating
+the configuration. If I were using confidence and multiple servers, I could even
+A/B test it that way as long as the cache implementation offered the same interface.
+
+# Summary
+By using the _Inversion of Control_ pattern, you can start to decouple your application.
+Route handlers become the simple controllers they were meant to be while your service
+layer is independend, easily testable and reusable.
+
+[pioc](http://npmjs.com/package/pioc) in particular supports many styles of
+module definitions and injections and can be an important part in any modern
+application, especially for isomorphic applications.
+
+# Changelog
+- 0.1.1 Include pioc as dependency

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

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

10462

increased by37.86%

Number of lines in readme file

174

increased by97.73%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedpioc@^1.2.1

• + Addedpioc@1.3.0(transitive)