Merge pull request #3 from ellemenno/v0.0.3

pixeldroid · web-flow · commit f3476f1f5599 · 2016-12-31T16:06:20.000-05:00
v0.0.3
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
-bin/
+cli/bin/
 lib/build/
-logs/
 releases/
 test/bin/
-TEST-*.xml
+test/TEST-*.xml
diff --git a/README.md b/README.md
@@ -3,50 +3,14 @@ json-ls
 
 JSON helpers for Loom
 
-- `Json` - a utility to simplify json data access
-- `JsonPrinter` - a pretty printer for json data
+- [rationale](#rationale)
+- [installation](#installation)
+- [usage](#usage)
+- [building](#building)
+- [contributing](#contributing)
 
 
-## installation
-
-Download the library into its matching sdk folder:
-
-    $ curl -L -o ~/.loom/sdks/sprint34/libs/Json.loomlib \
-        https://github.com/pixeldroid/json-ls/releases/download/v0.0.2/Json-sprint34.loomlib
-
-To uninstall, simply delete the file:
-
-    $ rm ~/.loom/sdks/sprint34/libs/Json.loomlib
-
-
-## usage
-
-0. declare a reference to the Json loomlib in your `.build` file:
-    *
-    ```json
-    "references": [
-        "System",
-        "Json"
-    ],
-    ```
-0. import `pixeldroid.json.Json`
-0. instantiate a new `pixeldroid.json.Json` and call the `fromString()` or `fromObject()` method on it
-0. retrieve values for key / item chains as desired
-0. print to formatted JSON string with JsonPrinter
-
-```ls
-var jsonString:String = File.loadTextFile('assets/json.json');
-var j:Json = Json.fromString(jsonString);
-trace(j.keys['key_name'].items[2].value);
-```
-
-```ls
-var jsonObject:Dictionary.<String, Object> = { "bool": true, "array": [1,23], "string": "one two three" };
-var j:Json = Json.fromObject(jsonObject);
-trace(JsonPrinter.print(j, JsonPrinterOptions.compact));
-```
-
-### Json
+## rationale
 
 Loom provides the [JSON][loom-json] class, which provides strongly typed access to values, requiring  separate accessors for every data type, and two families of these accessors for retrieving from Objects or Arrays. There are 18 basic accessors, and 2 methods for determining type.
 
@@ -132,14 +96,55 @@ No extra whitespace:
 
 see an example of using Json here:
 
-* [JsonDemo.build][JsonDemo.build]
-* [JsonDemo.ls][JsonDemo.ls]
+* [JsonDemoCLI.build][JsonDemoCLI.build]
+* [JsonDemoCLI.ls][JsonDemoCLI.ls]
 
 you can compile and run the demo from the command line:
 
-    $ rake demo:gui
+    $ rake cli
+
+
+## installation
+
+Download the library into its matching sdk folder:
+
+    $ curl -L -o ~/.loom/sdks/sprint34/libs/Json.loomlib \
+        https://github.com/pixeldroid/json-ls/releases/download/v0.0.3/Json-sprint34.loomlib
+
+To uninstall, simply delete the file:
+
+    $ rm ~/.loom/sdks/sprint34/libs/Json.loomlib
+
+
+## usage
+
+0. declare a reference to the Json loomlib in your `.build` file:
+    *
+    ```json
+    "references": [
+        "System",
+        "Json"
+    ],
+    ```
+0. import `pixeldroid.json.Json`
+0. instantiate a new `pixeldroid.json.Json` and call the `fromString()` or `fromObject()` method on it
+0. retrieve values for key / item chains as desired
+0. print to formatted JSON string with JsonPrinter
+
+```ls
+var jsonString:String = File.loadTextFile('assets/json.json');
+var j:Json = Json.fromString(jsonString);
+trace(j.keys['key_name'].items[2].value);
+```
+
+```ls
+var jsonObject:Dictionary.<String, Object> = { "bool": true, "array": [1,23], "string": "one two three" };
+var j:Json = Json.fromObject(jsonObject);
+trace(JsonPrinter.print(j, JsonPrinterOptions.compact));
+```
+
 
-## working from source
+## building
 
 > first install [loomtasks][loomtasks]
 
@@ -163,5 +168,5 @@ Pull requests are welcome!
 
 [loomtasks]: https://github.com/pixeldroid/loomtasks "loomtasks"
 [loom-json]: http://docs.theengine.co/loom/1.1.4813/api/system/JSON.html "Loom JSON class"
-[JsonDemo.build]: ./test/src/JsonDemo.build "build file for the demo"
-[JsonDemo.ls]: ./test/src/JsonDemo.ls "source file for the demo"
+[JsonDemoCLI.build]: ./cli/src/JsonDemoCLI.build "build file for the CLI demo"
+[JsonDemoCLI.ls]: ./cli/src/JsonDemoCLI.ls "source file for the CLI demo"
diff --git a/Rakefile b/Rakefile
@@ -1,16 +1,12 @@
-
 LIB_NAME = 'Json'
 LIB_VERSION_FILE = File.join('lib', 'src', 'pixeldroid', 'json', 'Json.ls')
 
 begin
   load(File.join(ENV['HOME'], '.loom', 'tasks', 'loomlib.rake'))
-  load(File.join(ENV['HOME'], '.loom', 'tasks', 'loomlib_demo.rake'))
 rescue LoadError
   abort([
-    'error: missing loomtasks',
-    '  please install loomtasks v1.1.0 or later before running this Rakefile:',
+    'error: missing loomlib.rake',
+    '  please install loomtasks before running this Rakefile:',
     '  https://github.com/pixeldroid/loomtasks/',
   ].join("\n"))
 end
-
-Rake::Task['demo:cli'].clear # no cli demo for this project
diff --git a/cli/loom.config b/cli/loom.config
@@ -0,0 +1,3 @@
+{
+  "sdk_version": "sprint34"
+}
diff --git a/cli/src/JsonDemoCLI.build b/cli/src/JsonDemoCLI.build
@@ -0,0 +1,19 @@
+{
+  "name": "JsonDemoCLI",
+  "version": "1.0",
+  "outputDir": "bin",
+  "references": [
+    "System",
+    "Json"
+  ],
+  "modules": [
+    {
+      "name": "JsonDemoCLI",
+      "version": "1.0",
+      "sourcePath": [
+        "."
+      ]
+    }
+  ],
+  "executable": true
+}
diff --git a/cli/src/JsonDemoCLI.ls b/cli/src/JsonDemoCLI.ls
@@ -0,0 +1,35 @@
+package
+{
+    import system.application.ConsoleApplication;
+
+    import pixeldroid.json.Json;
+    import pixeldroid.json.JsonPrinter;
+    import pixeldroid.json.JsonPrinterOptions;
+
+
+    public class JsonDemoCLI extends ConsoleApplication
+    {
+        override public function run():void
+        {
+            var jsonObject:Dictionary.<String,Object> = { "bool": true, "array": [1,23], "string": "aA bB cC" };
+            trace('source:\n' +dictionaryToString(jsonObject));
+
+            var j:Json = Json.fromObject(jsonObject);
+            trace('standard:\n' +JsonPrinter.print(j, JsonPrinterOptions.standard));
+            trace('compact:\n' +JsonPrinter.print(j, JsonPrinterOptions.compact));
+            trace('minified:\n' +JsonPrinter.print(j, JsonPrinterOptions.minified));
+        }
+
+        private function dictionaryToString(d:Dictionary.<String,Object>):String
+        {
+            var s:String = '';
+
+            for (var k:String in d)
+            {
+                s += '"' +k +'": ' +d[k].toString() +'\n';
+            }
+
+            return s;
+        }
+    }
+}
diff --git a/lib/src/Json.build b/lib/src/Json.build
@@ -1,17 +1,17 @@
 {
-    "name": "Json",
-    "version": "1.0",
-    "outputDir": "./build",
-    "references": [
-        "System"
-    ],
-    "modules": [
-        {
-            "name": "Json",
-            "version": "1.0",
-            "sourcePath": [
-                "."
-            ]
-        }
-    ]
+  "name": "Json",
+  "version": "0.0.3",
+  "outputDir": "./build",
+  "references": [
+    "System"
+  ],
+  "modules": [
+    {
+      "name": "Json",
+      "version": "0.0.3",
+      "sourcePath": [
+        "."
+      ]
+    }
+  ]
 }
diff --git a/lib/src/pixeldroid/json/Json.ls b/lib/src/pixeldroid/json/Json.ls
@@ -6,7 +6,7 @@ package pixeldroid.json
 
     public class Json
     {
-        public static const version:String = '0.0.2';
+        public static const version:String = '0.0.3';
 
         static public function fromString(value:String):Json
         {
diff --git a/test/fixtures/json.json b/test/fixtures/json.json
diff --git a/test/loom.config b/test/loom.config
@@ -1,14 +1,3 @@
 {
-  "sdk_version": "sprint34",
-  "executable": "Main.loom",
-  "display": {
-    "width": 480,
-    "height": 320,
-    "title": "JsonTest",
-    "stats": true,
-    "orientation": "landscape"
-  },
-  "app_id": "pixeldroid.JsonTest",
-  "app_name": "JsonTest",
-  "app_version": "0.0.1"
-}
+  "sdk_version": "sprint34"
+}
diff --git a/test/src/JsonDemo.build b/test/src/JsonDemo.build
diff --git a/test/src/app/JsonTest.ls b/test/src/app/JsonTest.ls
@@ -1,61 +1,27 @@
-
 package
 {
-
-    import system.Process;
     import system.application.ConsoleApplication;
+    import system.Process;
 
-    import pixeldroid.bdd.Spec;
-    import pixeldroid.bdd.Reporter;
-    import pixeldroid.bdd.reporters.AnsiReporter;
-    import pixeldroid.bdd.reporters.ConsoleReporter;
-    import pixeldroid.bdd.reporters.JunitReporter;
+    import pixeldroid.bdd.SpecExecutor;
 
     import JsonSpec;
     import JsonPrinterSpec;
 
 
     public class JsonTest extends ConsoleApplication
     {
-        private var seed:Number = -1;
-        private const SUCCESS:Number = 0;
-        private const FAILURE:Number = 1;
-
         override public function run():void
         {
-            JsonSpec.describe();
-            JsonPrinterSpec.describe();
+            SpecExecutor.parseArgs();
 
-            parseArgs();
+            var returnCode:Number = SpecExecutor.exec([
+                JsonSpec,
+                JsonPrinterSpec
+            ]);
 
-            Process.exit(Spec.execute(seed) ? SUCCESS : FAILURE);
-        }
-
-        private function parseArgs():void
-        {
-            var arg:String;
-            for (var i = 0; i < CommandLine.getArgCount(); i++)
-            {
-                arg = CommandLine.getArg(i);
-                if (arg == '--format') Spec.addReporter(reporterByName(CommandLine.getArg(++i)));
-                if (arg == '--seed') seed = Number.fromString(CommandLine.getArg(++i));
-            }
-
-            if (Spec.numReporters == 0) Spec.addReporter(new ConsoleReporter());
-        }
-
-        private function reporterByName(name:String):Reporter
-        {
-            var r:Reporter;
-
-            switch (name.toLowerCase())
-            {
-                case 'ansi': r = new AnsiReporter(); break;
-                case 'console': r = new ConsoleReporter(); break;
-                case 'junit': r = new JunitReporter(); break;
-            }
-
-            return r;
+            Process.exit(returnCode);
         }
     }
+
 }
diff --git a/test/src/demo/JsonDemo.ls b/test/src/demo/JsonDemo.ls
diff --git a/test/src/spec/JsonPrinterSpec.ls b/test/src/spec/JsonPrinterSpec.ls
diff --git a/test/src/spec/JsonSpec.ls b/test/src/spec/JsonSpec.ls

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "sdk_version": "sprint34"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ package pixeldroid.json`
`6`	`6`
`7`	`7`	`public class Json`
`8`	`8`	`{`
`9`		`- public static const version:String = '0.0.2';`
	`9`	`+ public static const version:String = '0.0.3';`
`10`	`10`
`11`	`11`	`static public function fromString(value:String):Json`
`12`	`12`	`{`