Initial version - converted from require-yaml

Author: Martin Thurau

.gitignore

@@ -0,0 +1,6 @@
+*.sublime-project
+*.sublime-workspace
+*.idea
+node_modules/
+bower_components/
+test/main-built.js

.jshintrc

@@ -0,0 +1,23 @@
+{
+  "laxcomma" : true
+  , "smarttabs" : true
+  , "unused" : "vars"
+  , "forin" : true
+  , "quotmark" : "single"
+  , "undef" : true
+  , "browser" : true
+  , "noempty" : true
+  , "latedef" : true
+  , "noarg" : true
+  , "nonew" : true
+  , "freeze" : true
+  , "eqeqeq" : true
+  , "immed" : true
+  , "globals" : {
+    "define" : true
+    , "require" : true
+    , "requirejs" : true
+    , "console" : true
+    , "module" : true
+  }
+}

.travis.yml

@@ -0,0 +1,9 @@
+before_script:
+  - npm install -g bower
+  - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
+  - bower install -f
+language: node_js
+node_js:
+  - "0.12"
+  - "0.10"
+sudo: false

README.md

@@ -0,0 +1,60 @@
+#require-java-properties
+
+[![Build Status](https://travis-ci.org/martinth/require-java-properties.svg?branch=master)](https://travis-ci.org/martinth/require-java-properties)
+
+> a transform for loading Java .properties files in RequireJS, using [java.properties.js][1]
+
+## Install the plugin and its dependencies using bower
+```sh
+$ bower install java.properties.js --save
+```
+If you prefer a manual install, make sure to satisfy the `java.properties.js` and `text` dependencies.
+
+## Simple usage
+First, make sure the module names `java.properties.js` and `text` resolve to the proper locations:
+```js
+requirejs.config({
+    paths : {
+        'text': './bower_components/requirejs-text/text',
+        'java.properties': './bower_components/java.properties.js/dist/amd/java.properties',
+        'properties': './bower_components/require-java-properties/properties'
+    }
+});
+```
+
+Now you're ready to `require` Java properties files as plain JavaScript objects:
+```js
+require('properties!some/folder/afile.properties', function(data){
+    console.log(data); // => logs the transformed object
+});
+```
+**NOTE**: In contrast to the default [java.properties.js][1] behaviour keys with dots in them will *not* result in nested
+objects. So a properties key like:
+```
+key=12
+key.with.dots=foobar 
+```
+Will result in this JSON object:
+```js
+{
+    "key": 12,
+    "key.with.dots": "foobar"
+} 
+```
+This is due to the specific requirements for which this plugin was build.
+
+## Build time
+On build time you can simply use `stubModules` in your build config to get rid of the parser in the file you ship to production:
+```js
+({
+    stubModules: ['text', 'java.properties', 'properties']
+})
+```
+
+##License
+MIT
+
+##Attribution
+This plugin is a based upon [require-yaml](https://github.com/m90/require-yaml).
+
+[1]: https://github.com/mattdsteele/java-properties

bower.json

@@ -0,0 +1,40 @@
+{
+  "name": "require-java-properties",
+  "version": "0.1.0",
+  "authors": [
+    "Martin Thurau <martin.thurau@gmail.com>"
+  ],
+  "description": "RequireJS loader for java properties files",
+  "main": "properties.js",
+  "keywords": [
+    "requirejs",
+    "loader",
+    "plugin",
+    "amd",
+    "java",
+    "properties"
+  ],
+  "bugs": {
+    "url": "https://github.com/martinth/require-java-properties"
+  },
+  "url": "https://github.com/martinth/require-java-properties",
+  "license": "MIT",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/martinth/require-java-properties"
+  },
+  "dependencies": {
+    "requirejs-text": "~2.0.12",
+    "java.properties.js": "~1.0.0"
+  },
+  "devDependencies": {
+    "almond": "~0.3.0"
+  }
+}

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "require-java-properties",
+  "version": "0.1.0",
+  "description": "RequireJS loader for java properties files",
+  "url": "https://github.com/martinth/require-java-properties",
+  "bugs": {
+    "url": "https://github.com/martinth/require-java-properties"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/martinth/require-java-properties"
+  },
+  "main": "properties.js",
+  "scripts": {
+    "pretest": "node node_modules/jshint/bin/jshint properties.js",
+    "test": "node node_modules/mocha/bin/mocha test/test.js"
+  },
+  "keywords": [
+    "requirejs",
+    "lader",
+    "plugin",
+    "amd",
+    "java",
+    "properties"
+  ],
+  "author": "Martin Thurau <martin.thurau@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "java.properties.js": "~1.0.0"
+  },
+  "devDependencies": {
+    "jshint": "^2.5.6",
+    "mocha": "^2.0.1",
+    "requirejs": "^2.1.15"
+  }
+}

properties.js

@@ -0,0 +1,41 @@
+define(['text', 'java.properties'], function (text, javaProperties) {
+    var buildMap = {};
+
+    var flattenObject = function (ob) {
+        return Object.keys(ob).reduce(function (toReturn, k) {
+            if ((typeof ob[k]) === 'object' && ob[k]) {
+                var flatObject = flattenObject(ob[k]);
+                Object.keys(flatObject).forEach(function (k2) {
+                    toReturn[k + '.' + k2] = flatObject[k2];
+                });
+            }
+            else {
+                toReturn[k] = ob[k];
+            }
+
+            return toReturn;
+        }, {});
+    };
+
+	return {
+        write: function (pluginName, name, write) {
+            if (name in buildMap) {
+                write('define("' + pluginName + '!' + name + '", function(){ return ' + JSON.stringify(buildMap[name]) + '; });\n');
+			}
+        },
+        load: function (name, parentRequire, onload, config) {
+            text.get(parentRequire.toUrl(name), function (propertiesString) {
+                try {
+                    var result = javaProperties.propertiesToObject(propertiesString);
+                    var flattened = flattenObject(result);
+                    buildMap[name] = flattened;
+                    onload(flattened);
+				} catch (e){
+					onload.error(e);
+				}
+			});
+
+		}
+        , version: '0.1.0'
+	};
+});

test/.gitignore

@@ -0,0 +1 @@
+main-built.js

test/fixtures/invalid.properties

@@ -0,0 +1,4 @@
+this
+
+is not
+       valid:data

test/fixtures/test.properties

@@ -0,0 +1,10 @@
+# This is a comment
+! Also a comment
+short text
+pi=3.14
+lang:en
+longtext This text \
+         is over multiple lines.
+paramText=Text with dynamic parameters: {0}
+unicodeText=a smiley: ☺
+deeply.nested.object=value

test/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>Test</title>
+</head>
+<body>
+	<script src="main-built.js"></script>
+</body>
+</html>

test/loadindex.js

@@ -0,0 +1,7 @@
+var page = require('webpage').create();
+page.open('test/index.html', function(status){
+	setTimeout(function(){
+	    console.log(page.content);
+	    phantom.exit();
+	}, 2000);
+});

test/main.js

@@ -0,0 +1,6 @@
+require(['properties!test/fixtures/test.properties'], function (data) {
+	var headline = document.createElement('h1');
+    headline.innerHTML = data['deeply.nested.object'];
+	headline.id = 'fixture';
+	document.body.appendChild(headline);
+});

test/test.js

@@ -0,0 +1,73 @@
+var requirejs = require('requirejs');
+var assert = require('assert');
+
+requirejs.config({
+    nodeRequire: require,
+    baseUrl: '.',
+    paths: {
+        'text': './bower_components/requirejs-text/text',
+        'java.properties': './bower_components/java.properties.js/dist/amd/java.properties',
+        'properties': './properties'
+	}
+});
+
+describe('properties loader', function () {
+
+    it('should render java properties into JavaScript objects', function (done) {
+        requirejs(['properties!test/fixtures/test.properties'], function (data) {
+			assert.deepEqual(data, {
+                short: 'text',
+                pi: 3.14,
+                lang: 'en',
+                longtext: 'This text is over multiple lines.',
+                paramText: 'Text with dynamic parameters: {0}',
+                unicodeText: 'a smiley: ☺',
+                'deeply.nested.object': 'value'
+			});
+			done();
+		});
+	});
+
+	it('should call the errback on malformed input', function(done){
+        requirejs(['properties!test/fixtures/invalid.properties'], function () {
+			assert(false);
+			done();
+		}, function(err){
+			assert(true);
+			done();
+		});
+	});
+
+});
+
+describe('properties writer', function (done) {
+    it('compiles java properties into dependency-less modules', function (done) {
+
+		this.timeout(7500);
+
+        requirejs.optimize({
+            baseUrl: '.',
+            name: './bower_components/almond/almond',
+            paths: {
+                'text': './bower_components/requirejs-text/text',
+                'java.properties': './bower_components/java.properties.js/dist/amd/java.properties',
+                'properties': './properties'
+            },
+            optimize: 'none',
+            include: ['./test/main'],
+            stubModules: ['text', 'java.properties', 'properties'],
+            out: 'test/main-built.js'
+        }, function () {
+            var exec = require('child_process').exec;
+            var process = exec('phantomjs test/loadindex.js', function (err, stdout) {
+                if (err) {
+                    assert(false);
+                } else {
+                    assert(stdout.indexOf('<h1 id="fixture">value</h1>') > -1);
+                }
+                done();
+            });
+        });
+
+	});
+});