From 71ac539f2a96ead41746a1923f0f50663e0f1478 Mon Sep 17 00:00:00 2001 From: Mike Bierlee Date: Wed, 1 Jul 2015 21:05:00 +0200 Subject: [PATCH] Add canonical package module This commit deprecates non-canonical package module "dependency.d". --- CHANGES.md | 4 ++++ README.md | 2 +- example/qualifiers/app.d | 2 +- example/quickstart/app.d | 2 +- source/poodinis/dependency.d | 42 +++++++++++++++++++----------------- source/poodinis/package.d | 16 ++++++++++++++ 6 files changed, 45 insertions(+), 23 deletions(-) create mode 100644 source/poodinis/package.d diff --git a/CHANGES.md b/CHANGES.md index a60cf49..ec9e33f 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,9 @@ Poodinis Changelog ================== +**Next Release** +* ADD canonical package module "package.d". Use "import poodinis;" to import the project. +* DEPRECATE module "dependency.d". Please use the canonical package module. See previous point. + **Version 2.1.0** * ADD option for registering a class by concrete type when registering that class by supertype. diff --git a/README.md b/README.md index 54c5474..b580804 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ See the Poodinis [DUB project page] for instructions on how to include Poodinis ###Quickstart The following example shows the typical usage of Poodinis: ```d -import poodinis.dependency; +import poodinis; interface Database{}; class RelationalDatabase : Database {} diff --git a/example/qualifiers/app.d b/example/qualifiers/app.d index fc31a5b..816f741 100644 --- a/example/qualifiers/app.d +++ b/example/qualifiers/app.d @@ -1,4 +1,4 @@ -import poodinis.dependency; +import poodinis; import std.stdio; diff --git a/example/quickstart/app.d b/example/quickstart/app.d index 9a3b784..d1efce2 100644 --- a/example/quickstart/app.d +++ b/example/quickstart/app.d @@ -1,4 +1,4 @@ -import poodinis.dependency; +import poodinis; interface Database{}; class RelationalDatabase : Database {} diff --git a/source/poodinis/dependency.d b/source/poodinis/dependency.d index d3d04d8..956d7a4 100644 --- a/source/poodinis/dependency.d +++ b/source/poodinis/dependency.d @@ -1,20 +1,22 @@ -/** - * Main module for typical inclusion into client applications. - * - * This module publicly imports all Poodinis modules. - * - * Part of the Poodinis Dependency Injection framework. - * - * Authors: - * Mike Bierlee, m.bierlee@lostmoment.com - * Copyright: 2014-2015 Mike Bierlee - * License: - * This software is licensed under the terms of the MIT license. - * The full terms of the license can be found in the LICENSE file. - */ - -module poodinis.dependency; - -public import poodinis.autowire; -public import poodinis.container; -public import poodinis.registration; +/** + * Main module for typical inclusion into client applications. + * + * This module publicly imports all Poodinis modules. + * + * Part of the Poodinis Dependency Injection framework. + * + * Authors: + * Mike Bierlee, m.bierlee@lostmoment.com + * Copyright: 2014-2015 Mike Bierlee + * License: + * This software is licensed under the terms of the MIT license. + * The full terms of the license can be found in the LICENSE file. + */ + +module poodinis.dependency; + +pragma(msg, "Module 'dependency' is deprecated. Please use the canonical package module. To do this, simply 'import poodinis;'"); + +public import poodinis.autowire; +public import poodinis.container; +public import poodinis.registration; diff --git a/source/poodinis/package.d b/source/poodinis/package.d new file mode 100644 index 0000000..88f80c8 --- /dev/null +++ b/source/poodinis/package.d @@ -0,0 +1,16 @@ +/** + * Package module for the Poodinis Dependency Injection framework. + * + * Authors: + * Mike Bierlee, m.bierlee@lostmoment.com + * Copyright: 2014-2015 Mike Bierlee + * License: + * This software is licensed under the terms of the MIT license. + * The full terms of the license can be found in the LICENSE file. + */ + +module poodinis; + +public import poodinis.autowire; +public import poodinis.container; +public import poodinis.registration;