finishing basic structure of the project

Author: Viliam Rockai

.gitignore

@@ -13,6 +13,8 @@ lib-cov
 pids
 logs
 results
+test-results.xml
+dist/docs
 
 node_modules
 lib

Gruntfile.js

@@ -2,7 +2,6 @@
 
 module.exports = function(grunt) {
 
-
   require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
 
   function init() {
@@ -14,7 +13,8 @@ module.exports = function(grunt) {
             descriptions: {
               'help' : 'Task list helper for your Grunt enabled projects.',
               'clean' : 'Deletes the content of the dist directory.',
-              'build' : 'Builds the project (including documentation) into the dist directory.',
+              'build' : 'Builds the project (including documentation) into the dist directory. You can specify modules to be built as arguments (' +
+                'grunt build:buttons:notification) otherwise all available modules are built.',
               'test' : 'Executes the karma testsuite.',
               'watch' : 'Whenever js source files (from the src directory) change, the tasks executes jshint and documentation build.',
               'ngdocs' : 'Builds documentation into dist/docs.',
@@ -41,10 +41,6 @@ module.exports = function(grunt) {
         }
       },
       connect: {
-        options: {
-          keepalive: true
-        },
-        server: {},
         docs: {
           options: {
             base: 'dist/docs'
@@ -62,7 +58,6 @@ module.exports = function(grunt) {
             ignores: ['**.min.js']
           },
           files: {
-            // TODO make list of modules optional (= specify as args or build all)
             src: 'src/*/*.js'
           }
         }
@@ -99,17 +94,34 @@ module.exports = function(grunt) {
         },
         js: {
           files: ['Gruntfile.js', 'src/*/*.js'],
-          tasks: ['jshint', 'ngdocs'],
-          options: {
-            livereload: true
-          }
+          tasks: ['build']
         }
       }
     });
 
-    grunt.registerTask('build', ['clean', 'jshint:beforeconcat', 'jshint', 'test', 'concat', 'uglify:build', 'ngdocs']);
+    // You can specify which modules to build as arguments of the build task.
+    grunt.registerTask('build', 'Create bootstrap build files', function() {
+      var concatSrc = [];
+
+      if (this.args.length) {
+        this.args.forEach(function(file){
+          if (grunt.file.exists('./src/'+file)){
+            grunt.log.ok('Adding ' + file + ' to the build queue.');
+            concatSrc.push('src/'+file+'/*.js');
+          } else {
+            grunt.fail.warn('Unable to build module \'' + file + '\'. The module doesn\'t exist.');
+          }
+        });
+
+      } else {
+        concatSrc = 'src/*/*.js';
+      }
+
+      grunt.task.run(['clean', 'jshint:beforeconcat', 'jshint', 'test', 'concat', 'uglify:build', 'ngdocs']);
+    });
+
     grunt.registerTask('default', ['build']);
-    grunt.registerTask('ngdocs:view', ['build', 'connect:docs:livereload']);
+    grunt.registerTask('ngdocs:view', ['build', 'connect:docs', 'watch']);
     grunt.registerTask('test', ['karma']);
     grunt.registerTask('help', ['availabletasks']);
 

README.md

@@ -6,9 +6,10 @@ This project will provide a set of common AngularJS directives for use with the
 
 You have to install required software before you're able to use grunt:
 
-* Install npm - Find more information on [NPM](https://www.npmjs.org/)
-* Install bower - Find more information on [Bower](http://bower.io/)
-* Install grunt - Find more information on [Grunt](http://gruntjs.com/)
+* Install Node.js - Find more information on [Node.js](http://nodejs.org/)
+* Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on [NPM](https://www.npmjs.org/)
+* Install Bower - Find more information on [Bower](http://bower.io/)
+* Install Grunt - Find more information on [Grunt](http://gruntjs.com/)
 * Install npm dependencies with:
 ```shell
 npm install
@@ -18,7 +19,20 @@ npm install
 bower install
 ```
 
-You should have your enviroment ready now. To see which grunt tasks are available, type:
-```
+You should have your environment ready now. To see which grunt tasks are available, type:
+```shell
 grunt help
 ```
+## API documentation
+
+The API documentation can be built with:
+```shell
+grunt ngdocs
+```
+
+If you're interested in reading the docs right away, you can use special target, which will start a web server:
+```shell
+grunt ngdocs:view
+```
+
+After executing this tasks you'll be able to access the documentation at [http://localhost:8000/](http://localhost:8000/).

bower.json

@@ -1,27 +1,29 @@
 {
-	"name": "angular-patternfly",
-	"version": "0.0.0",
-	"authors": [
-		"[email protected]"
-	],
-	"description": "Angular extension of the Patternfly project.",
-	"keywords": [
-	],
-	"license": "MIT",
-	"ignore": [
-		"**/.*",
-		"node_modules",
-		"bower_components",
-		"test",
-		"tests"
-	],
-	"dependencies": {
-		"angular":"~1.2.0",
-		"angular-animate":"~1.2.0",
-		"angular-sanitize":"~1.2.0",
-		"angular-touch":"~1.2.0",
-		"angular-route":"~1.2.0"
-	},
-	"devDependencies": {
-	}
+  "name": "angular-patternfly",
+  "version": "0.0.0",
+  "authors": [
+    "[email protected]"
+  ],
+  "description": "Angular extension of the Patternfly project.",
+  "keywords": [ "angular", "patternfly"],
+  "license": "MIT",
+  "ignore": [
+    "*",
+    "**/.*",
+    "node_modules",
+    "lib",
+    "src",
+    "misc"
+  ],
+  "main": ["dist/angular-patternfly.js", "dist/angular-patternfly.min.js"],
+  "dependencies": {
+    "angular":"~1.2.0",
+    "angular-animate":"~1.2.0",
+    "angular-sanitize":"~1.2.0",
+    "angular-touch":"~1.2.0",
+    "angular-route":"~1.2.0"
+  },
+  "devDependencies": {
+  },
+  "private": true
 }

dist/angular-patternfly.js

@@ -14,36 +14,36 @@
  <file name="index.html">
  <div ng-controller="ButtonDemoCtrl">
   <form>
-    <button lo-button-clear="clearMe()">Clear</button>
+    <button pf-btn-clear="clearMe()">Clear</button>
     <pre>{{text}}</pre>
   </form>
  </div>
  </file>
 
  <file name="script.js">
  function ButtonDemoCtrl($scope) {
-    $scope.text = 'Text before clear.';
+    $scope.text = 'The text visible before clicking on the clear button.';
 
     $scope.clearMe = function() {
-      $scope.text = '';
+      $scope.text = 'Clear button clicked.';
     };
   }
  </file>
 
  </example>
  */
-angular.module('patternfly.buttons', []).directive('loButtonClear', function () {
+angular.module('patternfly.buttons', []).directive('pfBtnClear', function () {
   return {
     scope: {
-      loButtonClear: '&'
+      pfBtnClear: '&'
     },
     restrict: 'A',
     link: function (scope, elem) {
       elem.addClass('btn btn-default btn-lg');
       elem.attr('type','button');
       elem.bind('click', function() {
         scope.$apply(function() {
-          scope.loButtonClear();
+          scope.pfBtnClear();
         });
       });
     }

dist/angular-patternfly.min.js

@@ -6,12 +6,11 @@
   "homepage": "https://github.com/patternfly/angular-patternfly",
   "dependencies": {},
   "devDependencies": {
-    "connect-livereload": "~0.3.0",
     "express": "~3.4.4",
-    "grunt": "~0.4.1",
+    "grunt": "~0.4.2",
     "grunt-available-tasks": "~0.4.3",
     "grunt-contrib-clean": "0.4.1",
-    "grunt-contrib-connect": "~0.3.0",
+    "grunt-contrib-connect": "~0.5.0",
     "grunt-contrib-concat": "~0.3.0",
     "grunt-contrib-jshint": "~0.7.0",
     "grunt-contrib-uglify": "~0.2.5",
@@ -29,6 +28,6 @@
   },
   "repository": "",
   "engines": {
-    "node": "0.10.10"
+    "node": ">=0.10.10"
   }
 }

package.json

@@ -14,36 +14,36 @@
  <file name="index.html">
  <div ng-controller="ButtonDemoCtrl">
   <form>
-    <button lo-button-clear="clearMe()">Clear</button>
+    <button pf-btn-clear="clearMe()">Clear</button>
     <pre>{{text}}</pre>
   </form>
  </div>
  </file>
 
  <file name="script.js">
  function ButtonDemoCtrl($scope) {
-    $scope.text = 'Text before clear.';
+    $scope.text = 'The text visible before clicking on the clear button.';
 
     $scope.clearMe = function() {
-      $scope.text = '';
+      $scope.text = 'Clear button clicked.';
     };
   }
  </file>
 
  </example>
  */
-angular.module('patternfly.buttons', []).directive('loButtonClear', function () {
+angular.module('patternfly.buttons', []).directive('pfBtnClear', function () {
   return {
     scope: {
-      loButtonClear: '&'
+      pfBtnClear: '&'
     },
     restrict: 'A',
     link: function (scope, elem) {
       elem.addClass('btn btn-default btn-lg');
       elem.attr('type','button');
       elem.bind('click', function() {
         scope.$apply(function() {
-          scope.loButtonClear();
+          scope.pfBtnClear();
         });
       });
     }

src/buttons/buttons.js

@@ -18,7 +18,7 @@ describe('buttons', function () {
 
     it('should work correctly with default model values', function () {
       $scope.model = false;
-      var btn = compileButton('<button lo-button-clear>click</button>', $scope);
+      var btn = compileButton('<button pf-btn-clear>click</button>', $scope);
       expect(btn).toHaveClass('btn');
       expect(btn).toHaveClass('btn-default');
       expect(btn).toHaveClass('btn-lg');