feature: Bypass loading screen on some requests

McNull#3

Author: Null McNull

README.md

@@ -5,8 +5,22 @@ A simple AngularJS module that allows you to block user interaction on AJAX requ
 #### Dependencies
 Besides AngularJS (~1.2.4), none.  
 
+#### Installation
+Either copy the contents of the `package` directory of the [Github](https://github.com/McNull/angular-block-ui) project or install with _bower_ from the command line (**recommended**):
+    
+    bower install angular-block-ui
+
+Include both the JS and CSS file in your html:
+
+    <link rel="stylesheet" href="path-to-block-ui/angular-block-ui.min.css"/>
+    <!-- After AngularJS -->
+	<script src="path-to-block-ui/angular-block-ui.min.js"></script>
+Create a dependency on `blockUI` in your main Angular module:
+
+    angular.module('myApp', ['blockUI'])
+
 #### Usage
-By default the module will block the user interface on each pending request made from the browser. This behavior can be modified in the configuration.
+By default the module will block the user interface on each pending request made from the browser. This behaviour can be modified in the configuration.
 
 It's also possible to do the blocking manually. The blockUI module exposes a service by the same name. Access to the service is gained by injecting it into your controller or directive:
 
@@ -31,9 +45,9 @@ BlockUI service methods
 =======================
 
 #### start
-The start method will start the user interface block. Because multiple user interface elements can request a user interface block at the same time, the service keeps track of the number of start calls. Each call to start() will increase the count and every call to stop() will decrease the value. Whenever the count reaches 0 the block will end.
+The start method will start the user interface block. Because multiple user interface elements can request a user interface block at the same time, the service keeps track of the number of start calls. Each call to `start()` will increase the count and every call to `stop()` will decrease the value. Whenever the count reaches 0 the block will end.
 
-*Note: By default the block is immediately active after calling this method, but to prevent trashing the user interface everytime a button is pressed, the block is visible after a short delay. This behaviour can be modified in the configuration.*
+*Note: By default the block is immediately active after calling this method, but to prevent trashing the user interface each time a button is pressed, the block is visible after a short delay. This behaviour can be modified in the configuration.*
 
 **Arguments:**
 
@@ -60,7 +74,7 @@ The callback function to queue.
 BlockUI overlay template
 ========================
 
-The html and styling of the builtin template is kept barebone. It consist of two divs (overlay and message):
+The html and styling of the builtin template is kept bare bone. It consist of two divs (overlay and message):
 
     <div ng-show="blockCount > 0" class="block-ui-overlay" ng-class="{ 'block-ui-visible': blocking }"></div>
     <div ng-show="blocking" class="block-ui-message">{{ message }}</div>
@@ -118,7 +132,19 @@ By default the BlockUI module will start a block whenever the Angular *$http* se
     blockUIConfigProvider.autoBlock(false);
 
 #### resetOnException
-By default the BlockUI module will reset the block count and hide the overlay whenever an exception has occured. You can set this value to *false* if you don't want this behaviour.
+By default the BlockUI module will reset the block count and hide the overlay whenever an exception has occurred. You can set this value to *false* if you don't want this behaviour.
+
+    // Disable clearing block whenever an exception has occurred
+    blockUIConfigProvider.resetOnException(false);
+    
+#### requestFilter
+Allows you to specify a filter function to exclude certain ajax requests from blocking the user interface. The function is passed the [Angular request config object](http://docs.angularjs.org/api/ng/service/$http). The blockUI service will ignore requests when the function returns `false`.
 
-    // Disable clearing block whenever an exception has occured
-    blockUIConfigProvider.resetOnException(false);
+	// Tell the blockUI service to ignore certain requests
+    blockUIConfigProvider.requestFilter(function(config) {
+    
+      // If the request starts with '/api/quote' ...
+      if(config.url.match(/^\/api\/quote($|\/).*/)) {
+        return false; // ... don't block it.
+      }
+    });

bower.json

@@ -1,7 +1,13 @@
 {
   "name": "angular-block-ui",
-  "version": "0.0.3",
-  "keywords": ["angular", "angularjs", "block", "block-ui", "blockui"],
+  "version": "0.0.4",
+  "keywords": [
+    "angular",
+    "angularjs",
+    "block",
+    "block-ui",
+    "blockui"
+  ],
   "authors": [
     "Null McNull <[email protected]>"
   ],
@@ -31,6 +37,7 @@
     "angular-route": "~1.2.4",
     "angular-resource": "~1.2.4",
     "lodash": "~2.4.1",
-    "angular-mocks": "~1.2.4"
+    "angular-mocks": "~1.2.4",
+    "showdown": "~0.3.1"
   }
 }

grunt/grunt-common.js

@@ -26,6 +26,9 @@ module.exports = function(grunt) {
       grunt.registerTask('ejs', ['clean:render', 'render:index', 'render:karmaConf']);
       grunt.registerTask('test-single', ['render:karmaConf', 'karma:single']);
       grunt.registerTask('test', ['build', 'render:karmaConf', 'karma:unit']);
+      grunt.registerTask('postBuild', 'Executed after build', function() {
+        grunt.log.writeln('This task can be overwritten.');
+      });
     },
     expandGlobs: function(globs, cwd) {
 

grunt/grunt-debug.js

@@ -94,6 +94,8 @@ module.exports = function (grunt) {
       var args = [1, 0].concat(areas);
       Array.prototype.splice.apply(buildTasks, args);
 
+      buildTasks.push('postBuild');
+      
       grunt.registerTask('build', buildTasks);
       grunt.registerTask('default', 'build');
 

grunt/grunt-release.js

@@ -95,6 +95,8 @@ module.exports = function (grunt) {
       var args = [2, 0].concat(areas);
       Array.prototype.splice.apply(buildTasks, args);
 
+      buildTasks.push('postBuild');
+      
       grunt.registerTask('build', buildTasks);
       grunt.registerTask('default', 'build');
 

grunt/project-files-debug.js

@@ -37,14 +37,16 @@ var files = {
       'vendor/angular/angular.js',
       'vendor/angular-resource/angular-resource.js',
       'vendor/angular-route/angular-route.js',
-      'vendor/lodash/dist/lodash.js'
+      'vendor/lodash/dist/lodash.js',
+      'vendor/showdown/src/showdown.js'
     ],
     test: [
       'vendor/angular/angular.js',
       'vendor/angular-mocks/angular-mocks.js',
       'vendor/angular-resource/angular-resource.js',
       'vendor/angular-route/angular-route.js',
-      'vendor/lodash/dist/lodash.js'
+      'vendor/lodash/dist/lodash.js',
+      'vendor/showdown/src/showdown.js'
     ],
     css: [
       'vendor/bootstrap-css/css/bootstrap.css',

grunt/project-files-release.js

@@ -41,14 +41,16 @@ var files = {
       'vendor/angular/angular.min.js',
       'vendor/angular-resource/angular-resource.min.js',
       'vendor/angular-route/angular-route.min.js',
-      'vendor/lodash/dist/lodash.min.js'
+      'vendor/lodash/dist/lodash.min.js',
+      'vendor/showdown/compressed/showdown.js'
     ],
     test: [
       'vendor/angular/angular.js',
       'vendor/angular-resource/angular-resource.min.js',
       'vendor/angular-route/angular-route.min.js',
       'vendor/angular-mocks/angular-mocks.js',
-      'vendor/lodash/dist/lodash.min.js'
+      'vendor/lodash/dist/lodash.min.js',
+      'vendor/showdown/compressed/showdown.js'
     ],
     css: [
       'vendor/bootstrap-css/css/bootstrap.min.css',

gruntfile.js

@@ -1,11 +1,25 @@
+var fs = require('fs');
 
 module.exports = function(grunt) {
 
   var target = grunt.option('target') || 'debug';
-  var gruntTarget = require('./grunt/grunt-' + target);
-  
-  gruntTarget(grunt).addArea('angularBlockUI', 'angular-block-ui')
-                    .addArea('app')
-                    .initConfig();
+  var gruntTarget = require('./grunt/grunt-' + target)(grunt);
 
-};
+  gruntTarget.addArea('angularBlockUI', 'angular-block-ui')
+             .addArea('angularShowdown', 'angular-showdown')
+             .addArea('app')
+             .registerTasks();
+
+  var config = gruntTarget.getConfig();
+
+  grunt.task.registerTask('postBuild', 'Executed after build.', function() {
+    var readme = fs.readFileSync('README.md');
+    var license = fs.readFileSync('LICENSE');
+
+    fs.writeFileSync('dist/app/README.md', readme);
+    fs.writeFileSync('dist/angular-block-ui/README.md', readme);
+    fs.writeFileSync('dist/angular-block-ui/LICENSE', license);
+  });
+
+  grunt.initConfig(config);
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-block-ui",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A simple AngularJS module that allows you to block user interaction on AJAX requests. Blocking is done automatically for each http request and/or manually via an injectable service.",
   "main": "grunt",
   "scripts": {

package/angular-block-ui/README.md

@@ -5,8 +5,23 @@ A simple AngularJS module that allows you to block user interaction on AJAX requ
 #### Dependencies
 Besides AngularJS (~1.2.4), none.  
 
+#### Installation
+Either copy the contents of the `package` directory of the [Github](https://github.com/McNull/angular-block-ui) project or install with _bower_ from the command line (**recommended**):
+    
+    bower install angular-block-ui
+
+Include both the JS and CSS file in your html:
+
+    <link rel="stylesheet" href="path-to-block-ui/angular-block-ui.min.css"/>
+    <!-- After AngularJS -->
+    <script src="path-to-block-ui/angular-block-ui.min.js"></script>
+    
+Create a dependency on `blockUI` in your main Angular module:
+
+    angular.module('myApp', ['blockUI'])
+
 #### Usage
-By default the module will block the user interface on each pending request made from the browser. This behavior can be modified in the configuration.
+By default the module will block the user interface on each pending request made from the browser. This behaviour can be modified in the configuration.
 
 It's also possible to do the blocking manually. The blockUI module exposes a service by the same name. Access to the service is gained by injecting it into your controller or directive:
 
@@ -31,9 +46,9 @@ BlockUI service methods
 =======================
 
 #### start
-The start method will start the user interface block. Because multiple user interface elements can request a user interface block at the same time, the service keeps track of the number of start calls. Each call to start() will increase the count and every call to stop() will decrease the value. Whenever the count reaches 0 the block will end.
+The start method will start the user interface block. Because multiple user interface elements can request a user interface block at the same time, the service keeps track of the number of start calls. Each call to `start()` will increase the count and every call to `stop()` will decrease the value. Whenever the count reaches 0 the block will end.
 
-*Note: By default the block is immediately active after calling this method, but to prevent trashing the user interface everytime a button is pressed, the block is visible after a short delay. This behaviour can be modified in the configuration.*
+*Note: By default the block is immediately active after calling this method, but to prevent trashing the user interface each time a button is pressed, the block is visible after a short delay. This behaviour can be modified in the configuration.*
 
 **Arguments:**
 
@@ -60,7 +75,7 @@ The callback function to queue.
 BlockUI overlay template
 ========================
 
-The html and styling of the builtin template is kept barebone. It consist of two divs (overlay and message):
+The html and styling of the builtin template is kept bare bone. It consist of two divs (overlay and message):
 
     <div ng-show="blockCount > 0" class="block-ui-overlay" ng-class="{ 'block-ui-visible': blocking }"></div>
     <div ng-show="blocking" class="block-ui-message">{{ message }}</div>
@@ -118,7 +133,19 @@ By default the BlockUI module will start a block whenever the Angular *$http* se
     blockUIConfigProvider.autoBlock(false);
 
 #### resetOnException
-By default the BlockUI module will reset the block count and hide the overlay whenever an exception has occured. You can set this value to *false* if you don't want this behaviour.
+By default the BlockUI module will reset the block count and hide the overlay whenever an exception has occurred. You can set this value to *false* if you don't want this behaviour.
+
+    // Disable clearing block whenever an exception has occurred
+    blockUIConfigProvider.resetOnException(false);
+    
+#### requestFilter
+Allows you to specify a filter function to exclude certain ajax requests from blocking the user interface. The function is passed the [Angular request config object](http://docs.angularjs.org/api/ng/service/$http). The blockUI service will ignore requests when the function returns `false`.
 
-    // Disable clearing block whenever an exception has occured
-    blockUIConfigProvider.resetOnException(false);
+	// Tell the blockUI service to ignore certain requests
+    blockUIConfigProvider.requestFilter(function(config) {
+    
+      // If the request starts with '/api/quote' ...
+      if(config.url.match(/^\/api\/quote($|\/).*/)) {
+        return false; // ... don't block it.
+      }
+    });