cocktail - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

lib/Cocktail.js

@@ -10,4 +10,3 @@ /*
     Cocktail,
-    ANNOTATION_REG_EXP = /^@/,
-    DEFAULT_PROCESSORS = {};
+    ANNOTATION_REG_EXP = /^@/;
 
@@ -22,4 +21,12 @@
 
+    /**
+     *@private
+     * Current processor list map
+     */
     _processors: {},
 
+    /**
+     * @protected   
+     * Returns the processor list map
+     */
     getProcessors : function(){
@@ -29,18 +36,16 @@ return this._processors;
 
-    // -- >Experimental
-    
-    // --- This methods are used for testing, find a better desing to avoid them
-    
-    restoreDefaultProcessors: function() {
-        this._processors = DEFAULT_PROCESSORS;
+    /**
+     * @protected
+     * sets the processor object list. It is an Object used as a map
+     */
+    setProcessors: function (processor) {
+        this._processors = processor;
     },
 
-    clearProcessors: function() {
-        var processors = this.getProcessors(),
-            key;
-        for(key in processors){
-            if(processors.hasOwnProperty(key) && key !== 'no-op'){
-                delete processors[key];
-            }        
-        }
+    /**
+     * @protected
+     * returns the list of default processors
+     */
+    getDefaultProcessors: function () {
+        return Cocktail._DEFAULT_PROCESSORS;
     },
@@ -58,6 +63,2 @@
 
-
-
-    // -- >End of Experimental
-
     /**
@@ -70,5 +71,3 @@ * @private
             P;
-
         P = (processors[key] || processors['no-op']);
-
         return new P();
@@ -167,13 +166,16 @@ },
     _isClassDefition: function (subject) {
-        var isClassDef = false,
+        var isClassDef = (subject && subject['@as'] && subject['@as'].toLowerCase() === 'class'),
             definitionProps = ['constructor', '@extends', '@traits', '@requires', '@annotation'],
             key;
 
-        for (key in subject) {
-            if(definitionProps.indexOf(key) > -1){
-                isClassDef = true;
-                break;
+        if (!isClassDef) {
+            for (key in subject) {
+                if(definitionProps.indexOf(key) > -1){
+                    isClassDef = true;
+                    break;
+                }
             }
         }
 
+
         return isClassDef; 
@@ -218,3 +220,2 @@ },
         options = subject;
-
         return this.mix(defaultConstructor, options);
@@ -251,4 +252,5 @@
  */
-DEFAULT_PROCESSORS = {
+Cocktail._DEFAULT_PROCESSORS = {
     'no-op'       : require('./processor/NoOp'),
+    '@as'         : undefined,
     '@merge'      : require('./processor/annotation/Merge'),
@@ -265,3 +267,3 @@ '@extends'    : require('./processor/annotation/Extends'),
 
-Cocktail.registerProcessors(DEFAULT_PROCESSORS);
+Cocktail.registerProcessors(Cocktail._DEFAULT_PROCESSORS);
 
@@ -271,5 +273,5 @@ Cocktail.mix(Cocktail, {
      * @public
-     * SEQUENCE is used to define a enumaration of priorities for annotations
+     * SEQUENCE is used to define a enumeration of priorities for annotations
      */
     SEQUENCE: sequence
 });

package.json

 {
   "name": "cocktail",
   "description": "CocktailJS is a small library to explore traits, talents, inheritance and annotations concepts in nodejs - Shake your objects and classes with Cocktail!",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "homepage": "http://cocktailjs.github.io",
@@ -6,0 +6,0 @@ "author": {

README.md

@@ -54,3 +54,20 @@ # Cocktail JS
 
+###Even easier Single Parameter Class Definition  
+Version 0.3 introduces a pseudo-annotation `@as` to help Single Parameter Class Definition. Now you can define
+a Class using `@as` passing a value of `class`:
 
+MySuperClass.js
+
+    var Cocktail = require('Cocktail')
+
+    Cocktail.mix({
+        '@exports' : module,
+        '@as'      : 'class',
+
+        '@properties' : {
+            name: 'a default name'
+        }
+    });
+
+
 ## Getting Started
@@ -95,4 +112,10 @@
 
-- 0.2.0 (current master)
+
+- 0.3.0 (current master)
     - status: Alpha
+    - Introduced pseudo-annotation `@as` intended for single parameter class definition
+    - Tests for pseudo-annotation `@as`
+
+- 0.2.0
+    - status: Alpha
     - Added single parameter class/trait definition. If the first parameter is an object literal and it contains a 
@@ -99,0 +122,0 @@ constructor definition, or the annotation '@extends', '@traits', '@requires' or '@annotation' it will be treated as

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

Number of lines in readme file

159

increased by16.91%

Worsened metrics

Total package byte prevSize

26889

decreased by-91.4%

Number of package files

14

decreased by-56.25%

Lines of code

626

decreased by-9.01%

No dependency changes