Add improvements to the build process and decoupled calls from the private to the public methods

Author: Rafael J. Staib

.gitignore

@@ -1,5 +1,5 @@
 dist
-build/dist
+build
 docs
 downloads
 *~

Gruntfile.js

@@ -8,16 +8,15 @@ module.exports = function (grunt)
         concat: {
             dist: {
                 files: {
-                    'dist/jquery.steps.js': [
-                        'src/banner.js',
-                        'src/variables.js',
-                        'src/privates.js',
-                        'src/publics.js',
-                        'src/enums.js',
-                        'src/model.js',
-                        'src/defaults.js',
-                        'src/globals.js',
-                        'src/footer.js'
+                    '<%= pkg.folders.dist %>/jquery.steps.js': [
+                        '<%= pkg.folders.src %>/banner.js',
+                        '<%= pkg.folders.src %>/variables.js',
+                        '<%= pkg.folders.src %>/privates.js',
+                        '<%= pkg.folders.src %>/publics.js',
+                        '<%= pkg.folders.src %>/objects.js',
+                        '<%= pkg.folders.src %>/defaults.js',
+                        '<%= pkg.folders.src %>/helper.js',
+                        '<%= pkg.folders.src %>/footer.js'
                     ]
                 }
             }
@@ -31,30 +30,30 @@ module.exports = function (grunt)
             },
             all: {
                 files: {
-                    'dist/jquery.steps.min.js': ['dist/jquery.steps.js']
+                    '<%= pkg.folders.dist %>/jquery.steps.min.js': ['<%= pkg.folders.dist %>/jquery.steps.js']
                 }
             }
         },
         compress: {
             main: {
                 options: {
-                    archive: 'dist/<%= pkg.name %>-<%= pkg.version %>.zip'
+                    archive: '<%= pkg.folders.dist %>/<%= pkg.name %>-<%= pkg.version %>.zip'
                 },
                 files: [
                     {
                         src: [
                             'README.md',
                             /*'changelog.txt',*/
-                            'src/**/*.*',
-                            'docs/**/*.*',
+                            '<%= pkg.folders.src %>/**/*.*',
+                            '<%= pkg.folders.docs %>/**/*.*',
                             'demo/**/*.*',
                             'lib/*.*',
                             'test/**/*.*'
                         ]
                     },
                     {
                         flatten: true,
-                        src: ['dist/*.js'],
+                        src: ['<%= pkg.folders.dist %>/*.js'],
                         filter: 'isFile'
                     }
                 ]
@@ -82,7 +81,7 @@ module.exports = function (grunt)
                 }
             },
             files: [
-                'dist/jquery-steps.js'
+                '<%= pkg.folders.dist %>/jquery-steps.js'
             ],
             test: {
                 options: {
@@ -124,11 +123,14 @@ module.exports = function (grunt)
                 options: {
                     exclude: 'qunit-1.11.0.js',
                     paths: '.',
-                    outdir: 'docs/'
+                    outdir: '<%= pkg.folders.docs %>/'
                 }
             }
         },
-        clean: ["dist", "docs"]
+        clean: {
+            api: ["<%= pkg.folders.docs %>"],
+            build: ["<%= pkg.folders.dist %>"]
+        }
     });
 
     grunt.loadNpmTasks('grunt-contrib-jshint');
@@ -139,7 +141,8 @@ module.exports = function (grunt)
     grunt.loadNpmTasks('grunt-contrib-compress');
     grunt.loadNpmTasks('grunt-contrib-clean');
 
-    grunt.registerTask('default', ['concat', 'jshint', 'qunit']);
-    grunt.registerTask('api', ['clean', 'yuidoc']);
-    grunt.registerTask('release', ['default', 'api', 'uglify', 'compress']);
+    grunt.registerTask('default', ['build']);
+    grunt.registerTask('api', ['clean:api', 'yuidoc']);
+    grunt.registerTask('build', ['clean:build', 'concat', 'jshint', 'qunit']);
+    grunt.registerTask('release', ['build', 'api', 'uglify', 'compress']);
 };

package.json

@@ -39,5 +39,10 @@
     "grunt-cli": "~0.1.9"
   },
   "readmeFilename": "README.md",
-  "gitHead": "0d9f4f8b6a0c3d3b8a73eabf6a4b8cececd52f7a"
+  "gitHead": "0d9f4f8b6a0c3d3b8a73eabf6a4b8cececd52f7a",
+  "folders": { 
+	"dist": "build",
+	"src": "src",
+	"docs": "docs"
+  }
 }

src/globals.js renamed to src/helper.js

@@ -1,3 +1,9 @@
+/*
+ * Enums
+ */
+
+
+
 /**
  * An enum represents the different content types of a step and their loading mechanisms.
  *
@@ -82,4 +88,39 @@ $.fn.steps.transitionEffect = {
      * @for transitionEffect
      **/
     slideLeft: 3
+};
+
+
+
+/*
+ * Model
+ */
+
+
+
+$.fn.steps.stepModel = {
+    title: "",
+    content: "",
+    contentUrl: "",
+    contentMode: $.fn.steps.contentMode.html,
+    contentLoaded: false
+};
+
+
+
+/*
+ * Model
+ */
+
+
+
+$.fn.steps.currentIndex = {
+    decrease: function (state, decreaseBy)
+    {
+        return state.currentIndex - decreaseBy;
+    },
+    increase: function (state, increaseBy)
+    {
+        return state.currentIndex + increaseBy;
+    }
 };

src/model.js

@@ -68,6 +68,30 @@ var privates = {
         });
     },
 
+    /**
+     * Triggers the onFinishing and onFinished event.
+     *
+     * @static
+     * @private
+     * @method finishStep
+     * @param wizard {Object} The jQuery wizard object
+     * @param state {Object} The state container of the current wizard
+     **/
+    finishStep: function (wizard, state)
+    {
+        var currentStep = wizard.find(".steps li").eq(state.currentIndex);
+
+        if (wizard.triggerHandler("finishing", [state.currentIndex]))
+        {
+            currentStep.addClass("done").removeClass("error");
+            wizard.triggerHandler("finished", [state.currentIndex]);
+        }
+        else
+        {
+            currentStep.addClass("error");
+        }
+    },
+
     generateMenuItem: function (tag, label)
     {
         return "<li><a href=\"#" + tag + "\" role=\"menuitem\">" + label + "</a></li>";
@@ -161,6 +185,38 @@ var privates = {
         }
     },
 
+    /**
+     * Routes to the next step.
+     *
+     * @static
+     * @private
+     * @method goToNextStep
+     * @param wizard {Object} The jQuery wizard object
+     * @param options {Object} Settings of the current wizard
+     * @param state {Object} The state container of the current wizard
+     * @return {Boolean} Indicates whether the action executed
+     **/
+    goToNextStep: function (wizard, options, state)
+    {
+        return privates.paginationClick(wizard, options, state, $.fn.steps.currentIndex.increase(state, 1));
+    },
+
+    /**
+     * Routes to the previous step.
+     *
+     * @static
+     * @private
+     * @method goToPreviousStep
+     * @param wizard {Object} The jQuery wizard object
+     * @param options {Object} Settings of the current wizard
+     * @param state {Object} The state container of the current wizard
+     * @return {Boolean} Indicates whether the action executed
+     **/
+    goToPreviousStep: function (wizard, options, state)
+    {
+        return privates.paginationClick(wizard, options, state, $.fn.steps.currentIndex.decrease(state, 1));
+    },
+
     /**
      * Routes to a specific step by a given index.
      *
@@ -393,9 +449,11 @@ var privates = {
      */
     keyUpHandler: function (event)
     {
-        var wizard = $(this);
+        var wizard = $(this),
+            options = wizard.data("options"),
+            state = wizard.data("state");
 
-        if (wizard.data("options").suppressPaginationOnFocus && wizard.find(":focus").is(":input"))
+        if (options.suppressPaginationOnFocus && wizard.find(":focus").is(":input"))
         {
             event.preventDefault();
             return false;
@@ -405,12 +463,12 @@ var privates = {
         if (event.keyCode === keyCodes.left)
         {
             event.preventDefault();
-            wizard.steps("previous");
+            privates.goToPreviousStep(wizard, options, state);
         }
         else if (event.keyCode === keyCodes.right)
         {
             event.preventDefault();
-            wizard.steps("next");
+            privates.goToNextStep(wizard, options, state);
         }
     },
 
@@ -458,14 +516,14 @@ var privates = {
      * @private
      * @method paginationClick
      * @param wizard {Object} The jQuery wizard object
+     * @param options {Object} Settings of the current wizard
+     * @param state {Object} The state container of the current wizard
      * @param index {Integer} The position (zero-based) to route to
      * @return {Boolean} Indicates whether the event fired successfully or not
      **/
-    paginationClick: function (wizard, index)
+    paginationClick: function (wizard, options, state, index)
     {
-        var options = wizard.data("options"),
-            state = wizard.data("state"),
-            oldIndex = state.currentIndex;
+        var oldIndex = state.currentIndex;
 
         if (index >= 0 && index < state.stepCount && !(options.forceMoveForward && index < state.currentIndex))
         {
@@ -504,20 +562,22 @@ var privates = {
 
         var anchor = $(this),
             wizard = anchor.parents(":has(.steps)"),
+            options = wizard.data("options"),
+            state = wizard.data("state"),
             href = anchor.attr("href");
 
         switch (href.substring(href.lastIndexOf("#")))
         {
             case "#finish":
-                wizard.steps("finish");
+                privates.finishStep(wizard, options, state);
                 break;
 
             case "#next":
-                wizard.steps("next");
+                privates.goToNextStep(wizard, options, state);
                 break;
 
             case "#previous":
-                wizard.steps("previous");
+                privates.goToPreviousStep(wizard, options, state)
                 break;
         }
     },

src/enums.js renamed to src/objects.js

@@ -45,19 +45,9 @@ $.fn.steps.add = function (step)
  **/
 $.fn.steps.finish = function ()
 {
-    var options = this.data("options"),
-        state = this.data("state"),
-        currentStep = this.find(".steps li").eq(state.currentIndex);
+    var state = this.data("state");
 
-    if (this.triggerHandler("finishing", [state.currentIndex]))
-    {
-        currentStep.addClass("done").removeClass("error");
-        this.triggerHandler("finished", [state.currentIndex]);
-    }
-    else
-    {
-        currentStep.addClass("error");
-    }
+    privates.finishStep(this, state);
 };
 
 /**
@@ -126,7 +116,10 @@ $.fn.steps.insert = function (index, step)
  **/
 $.fn.steps.next = function ()
 {
-    return privates.paginationClick(this, this.data("state").currentIndex + 1);
+    var options = this.data("options"),
+        state = this.data("state");
+
+    return privates.goToNextStep(this, options, state);
 };
 
 /**
@@ -137,7 +130,10 @@ $.fn.steps.next = function ()
  **/
 $.fn.steps.previous = function ()
 {
-    return privates.paginationClick(this, this.data("state").currentIndex - 1);
+    var options = this.data("options"),
+        state = this.data("state");
+
+    return privates.goToPreviousStep(this, options, state);
 };
 
 /**

src/privates.js

@@ -58,7 +58,7 @@ <h1>contentModeWithStringArgument</h1>
         <script src="qunit/qunit-1.11.0.js"></script>
         <script src="tests.js"></script>
         <script src="jquery.js"></script>
-        <script src="../dist/jquery.steps.js"></script>
+        <script src="../build/jquery.steps.js"></script>
         <script>
             $(function ()
             {