Added testing, and readme update with instructions on usage

Author: apat183

.gitignore

@@ -0,0 +1,2 @@
+bower_components
+node_modules

Gruntfile.js

@@ -0,0 +1,38 @@
+module.exports = function(grunt) {
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-karma');
+
+  grunt.initConfig({
+
+    pkg: grunt.file.readJSON('package.json'),
+
+    uglify: {
+      my_target: {
+        options: {
+          sourceMap: 'dist/angularjs-string-humanize.map.js',
+          banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' +
+                  '<%= grunt.template.today("yyyy-mm-dd") %> - ' +
+                  '<%= pkg.repository.url %> */'
+        },
+        files: {
+          'dist/angularjs-string-humanize.min.js': ['src/angularjs-string-humanize.js']
+        }
+      }
+    },
+
+    karma: {
+      unit: {
+        configFile: 'test/karma.conf.js',
+        autoWatch: false,
+        singleRun: true
+      }
+    }
+
+  });
+
+  grunt.registerTask('test', ['karma:unit']);
+  grunt.registerTask('build', ['uglify']);
+
+  grunt.registerTask('default', ['karma:unit', 'uglify']);
+
+};

README.md

@@ -1,2 +1,62 @@
-# angularjs-string-humanize
-AngularJS filter wrapping the 'string-humanize' library
+# AngularJS String Humanize (angularjs-string-humanize)
+
+## Description
+AngularJS filter wrapping the 'string-humanize' library to handle unknown string format and convert to human readable.
+
+## Usage
+
+Apply filter to string in HTML or JS to convert formatted string to human readable.
+
+### In HTML Template Binding
+`{{ someString | stringHumanize}}`
+### In JavaScript
+`$filter('stringHumanize')(someString)`
+### Returns
+
+String in human readable form. The first letter will be capitalized in the word or phrase. 
+
+### Examples 
+Javascript 
+```
+$filter('stringHumanize')('snake_case_string') // 'Snake case string'
+$filter('stringHumanize')('camelCaseString') // 'Camel case string'
+$filter('stringHumanize')('hyphen-case-string-with-ext.html') // 'Hyphen case string with ext'
+$filter('stringHumanize')(undefined) // ''
+```
+
+HTML
+```
+{{ 'hyphen-case-string' | stringHumanize}} // 'Hyphen case string'
+{{ 'lower cased phrase' | stringHumanize}} // 'Lower cased phrase'
+{{ '  remove extra  spaces  ' | stringHumanize}} //'Remove extra spaces'
+{{ null | stringHumanize}} // ''
+```
+
+## Install
+
+### Via bower
+
+```
+bower install --save angularjs-string-humanize
+```
+
+Include `src/angularjs-string-humanize.js` or `dist/angularjs-string-humanize.min.js` to your project or index file.
+
+```
+<script src="/bower_components/angularjs-string-humanize/dist/angularjs-string-humanize.min.js"></script>
+```
+
+Add it as a dependency to your angularjs project:
+
+```
+var app = angular.module("myApp", ['angularStringHumanize']);
+```
+
+
+## Compatibility
+
+Functionality verified with unit test with angular versions from `v1.6.0`+.
+
+## Credits
+
+All credits go to [string-humanize](https://github.com/jxson/string-humanize) and [string-capitalize](https://github.com/jxson/string-capitalize). This is just packaged and tested version of their code. 

bower.json

@@ -1,15 +1,20 @@
 {
   "name": "angularjs-string-humanize",
   "version": "0.0.1",
-  "main": "src/angular-string-humanize.js",
+  "main": "src/angularjs-string-humanize.js",
   "description": "Angular 1.x filter for rendering strings to human-readable data",
   "license": "MIT",
+  "dependencies": {
+    "angular": "~1.6.0"
+  },
   "ignore": [
     "**/.*",
-    "*.md",
-    "package.json"
+    "node_modules",
+    "bower_components",
+    "test"
   ],
-  "dependencies": {
-    "angular": "~1.6.0"
+  "devDependencies": {
+    "angular": "~1.6.0",
+    "angular-mocks": "~1.6.0"
   }
 }

dist/angular-string-humanize.min.js

@@ -1,10 +1,38 @@
 {
   "name": "angularjs-string-humanize",
   "version": "0.0.1",
-  "main": "src/angular-string-humanize.js",
-  "description": "Angular 1.x filter for rendering strings to human-readable data",
+  "main": "src/angularjs-string-humanize.js",
+  "description": "Angular 1.x filter for rendering unknown formatted strings to human-readable data",
   "repository": {
     "type": "git",
     "url": "https://github.com/apat183/angularjs-string-humanize"
-  }
+  },
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "grunt": "0.4.4",
+    "grunt-contrib-uglify": "0.4.0",
+    "grunt-karma": "0.8.2",
+    "karma": "0.12.0",
+    "karma-jasmine": "0.1.5",
+    "karma-chrome-launcher": "0.1.2",
+    "karma-firefox-launcher": "0.1.3",
+    "karma-phantomjs-launcher": "0.1.2",
+    "karma-script-launcher": "0.1.0"
+  },
+  "scripts": {
+    "test": "grunt karma"
+  },
+  "keywords": [
+    "angularjs",
+    "string",
+    "filter",
+    "humanize"
+  ],
+  "author": "Anand Patel",
+  "contributors": [
+    "Anand Patel (https://github.com/apat183)"
+  ]
 }

dist/angular-string-humanize.min.map

@@ -0,0 +1,51 @@
+(function (angular) {
+  'use strict';
+
+  angular.module('angularStringHumanize', []).filter('stringHumanize', function () {
+
+      function humanize(string) {
+        string = string || '';
+        string = string.toString();
+        string = string.trim();
+        string = string.replace(extname(string), '');
+        string = underscore(string);
+        string = string.replace(/[\W_]+/g, ' ');
+
+        return capitalize(string);
+      }
+
+      function underscore(string) {
+        string = string || '';
+        string = string.toString();
+        string = string.trim();
+        string = string.replace(/([a-z\d])([A-Z]+)/g, '$1_$2');
+        string = string.replace(/[-\s]+/g, '_').toLowerCase();
+
+        return string;
+      }
+
+      function extname(string) {
+        var index = string.lastIndexOf('.');
+        var ext = string.substring(index, string.length);
+
+        return (index === -1) ? '' : ext;
+      }
+
+      function capitalize(string) {
+        string = string || '';
+        string = string.trim();
+
+        if (string[0]) {
+          string = string[0].toUpperCase() + string.substr(1).toLowerCase();
+        }
+
+        return string;
+      }
+
+      return function (input) {
+        return humanize(input);
+      };
+
+    });
+
+}(angular));

package.json

@@ -0,0 +1,22 @@
+/*global module */
+module.exports = function ( config ) {
+  'use strict';
+
+  var files = [
+    '../bower_components/angular/angular.js',
+    '../bower_components/angular-mocks/angular-mocks.js',
+    '../src/angularjs-string-humanize.js',
+    '../test/unit/angularjs-string-humanize.spec.js'
+  ];
+
+  config.set({
+    files : files,
+    basePath: '',
+    frameworks: ['jasmine'],
+    reporters: ['progress'],
+    browsers: ['Chrome'],
+    autoWatch: true,
+    singleRun: false,
+    colors: true
+  });
+};

src/angularjs-string-humanize.js

@@ -0,0 +1,54 @@
+/*global beforeEach, describe, it, inject, expect, module */
+'use strict';
+
+describe('String Humanize', function () {
+
+  var humanize;
+
+  beforeEach(module('angularStringHumanize'));
+
+  beforeEach(inject(function ($filter) {
+    humanize = $filter('stringHumanize');
+  }));
+
+  describe('default functionality', function () {
+
+    it('should format snake case strings', function () {
+      expect(humanize('snake_case_string')).toEqual('Snake case string');
+    });
+
+    it('should format camel case string', function () {
+      expect(humanize('camelCaseString')).toEqual('Camel case string');
+    });
+
+    it('should format hyphen case string', function () {
+      expect(humanize('hyphen-case-string')).toEqual('Hyphen case string');
+    });
+
+    it('should remove extensions and format strings any case', function () {
+      expect(humanize('snake_case_string.js')).toEqual('Snake case string');
+      expect(humanize('camelCaseString.md')).toEqual('Camel case string');
+      expect(humanize('hyphen-case-string.html')).toEqual('Hyphen case string');
+    });
+
+    it('should format lower cased phrase string', function () {
+      expect(humanize('lower cased phrase')).toEqual('Lower cased phrase');
+    });
+
+    it('should format and remove all excess spaces in string', function () {
+      expect(humanize('  remove extra  spaces  ')).toEqual('Remove extra spaces');
+    });
+
+    it('should format numbers to string', function () {
+      expect(humanize('123')).toEqual('123');
+    });
+
+    it('should be able to handle blank null and undefined', function () {
+      expect(humanize('')).toEqual('');
+      expect(humanize(null)).toEqual('');
+      expect(humanize(undefined)).toEqual('');
+    });
+
+  });
+
+});