flok 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5c7b4bc98442a8926cdedff0a1c7686d8a1682f
-  data.tar.gz: 76c5f330a8d1b8b892d55c88d3e8590e1a99675f
+  metadata.gz: e0aaa785dec6e5bd611a315aa4e7429461e06ce4
+  data.tar.gz: add685413b3340bb7fb21ff13b1331cbae7a586c
 SHA512:
-  metadata.gz: 1235a074303d2392ecd72f91e2e11f7e5c8ea989dbcb983a9b6182da279b949dcbef3f3732d8eb2cf83eca64af8704f241d5c5c7a04186af284759c4120a6a42
-  data.tar.gz: 52488120e65e47dba68a985324dfd9c78415b58cc3c740da01fb1aa2115e6728437525ffbc39f0dfbbb81f59c19c446c828ce7ddc277589b015bf25e46d21a33
+  metadata.gz: 4daf5b712620fddf856254b13a19f4fb5e74e8309d19c1074b3f41836e2a86176429e692b02df2bd1d7660c59bc1bc6a2acaeb4cfa5a0aa113485e7611e1f53f
+  data.tar.gz: 3c06fa286b16563bbc4a68f07d567477dd43023889e62925b9415bb37b92911ca704de81d7732de3b1302ecfa69b9ab41208eb679247e27f1b61bfda0fa07ead

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 seo
+Copyright (c) 2015 Seo Townsend
 
 MIT License
 

data/README.md

@@ -9,12 +9,19 @@
 
 A work in progress
 
+# Supported platforms
+ * iOS 8 (iPhone)
+ * HTML5
+
 ## Docs
 
  * [Project Layout](./docs/project_layout.md)
  * [Platform Drivers](./docs/platform_drivers.md)
+ * [Driver Interface](./docs/driver_interface.md)
  * [Architecture](./docs/architecture.md)
  * [Compilation](./docs/compilation.md)
+ * [System Interface](./docs/interface.md)
+ * [Testing](./docs/testing.md)
 
 ## Requirements
 

data/Rakefile

@@ -1,12 +1,14 @@
 require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
+require "fileutils"
+require './lib/flok'
 
 # Default directory to look in is `/specs`
 # Run with `rake spec`
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+#Gem things
+#############################################################################
 #Upgrade version of gem
 def upgrade_version
   versionf = './lib/flok/version.rb'
@@ -36,21 +38,15 @@ task :push do
   `gem push flok-#{version}.gem`
   `rm flok-#{version}.gem`
 end
+#############################################################################
 
-task :compile do
-  `rm ./products/application.js`
-  `ruby -Ilib ./bin/flok build`
-  `osascript -e 'tell application "Keyboard Maestro Engine" to do script "3B15D84D-30B0-4DC5-91BA-91BBE0AA340B"'`
-end
+#Compliation
+#############################################################################
+task :build_world do
+  #What platform are we working with?
+  raise "No $PLATFORM given" unless platform = ENV["PLATFORM"]
+  build_path = "./products/#{platform}"
 
-task :test_env do
-  puts ENV["FUCK"]
-end
-
-#Update documents to github
-task :udocs do
-  `git add ./docs/*`
-  `git add README.md`
-  `git commit -a -m "Update docs"`
-  `git push`
+  Flok.build_world(build_path, platform)
 end
+#############################################################################

data/app/drivers/chrome/Rakefile

@@ -1,24 +1,17 @@
 require 'fileutils'
+require 'flok/build'
+require 'securerandom'
 
 #Compile all the *.js files into one file
-BUILD_PATH = '../../../products/drivers/browser.js'
 task :build do
-  out = "/* THIS IS AN AUTOGENETARED FILE, DO NOT EDIT THIS */\n"
-  Dir["./vendor/*.js"].each do |js|
-    code = File.read(js)
-    out << code
-    out << "\n"
-  end
-
-  Dir["*.js"].each do |js|
-    code = File.read(js)
-    out << code
-    out << "\n"
-  end
+  raise "No BUILD_PATH given" unless BUILD_PATH=ENV["BUILD_PATH"]
 
-  Dir.chdir File.dirname(__FILE__) do
-    FileUtils.rm_f BUILD_PATH
-    FileUtils.mkdir_p File.dirname(BUILD_PATH)
-    File.write BUILD_PATH, out
+  my_path = File.expand_path(File.dirname(__FILE__))
+  Dir.mktmpdir(SecureRandom.hex) do |dir|
+    Dir.chdir dir do
+      Flok.src_glob("js", "#{my_path}/src/vendor", "0src_vendor.js")
+      Flok.src_glob("js", "#{my_path}/src/", "1src.js")
+      Flok.src_glob("js", ".", File.join(BUILD_PATH, "chrome.js"))
+    end
   end
 end

data/app/drivers/chrome/src/config0.js

@@ -0,0 +1 @@
+flok = {};

data/app/drivers/chrome/src/helpers.js

@@ -0,0 +1,6 @@
+//Get a pseudo UUID
+flok.uuid_counter = 0;
+flok.UUID = function() {
+  flok.uuid_counter += 1;
+  return flok.uuid_counter;
+}

data/app/drivers/chrome/src/net.js

@@ -0,0 +1,46 @@
+//$(document).ready(function() {
+  //flok_request("GET", "http://test.services.fittr.com/ping", {}, null);
+//})
+
+//All requests are bound to this table and removed when cancelled
+flok.net = {};
+flok.net.callbackTable = {};
+flok.net.socketIndex = 0  //The current index of the socket, incremented for new sockets
+
+//A basic get request that supports callbacks
+flok.net.request = function(verb, url, params, completion) {
+  //Store callback in the table
+  var socketIndex = flok.net.socketIndex++
+  flok.net.callbackTable[socketIndex] = true
+
+  $.ajax({
+    url: url,
+    type: verb,
+    data: params,
+    success: function(data) {
+      data = JSON.parse(data);
+      completion = completion || function() {}
+      if (completion != null) {
+        //Callback if possible
+        if (flok.net.callbackTable[socketIndex] === true) { 
+          delete flok.net.callbackTable[socketIndex];
+          completion(data, false); 
+        }
+      }
+    },
+    error: function(xhr, status, err) {
+      if (flok.net.callbackTable[socketIndex] === true) { 
+          delete flok.net.callbackTable[socketIndex];
+          completion({"message":status}, true); 
+        }
+    }
+  })
+
+  return socketIndex
+}
+
+flok.net.cancel_request = function(socket) {
+  res = flok.net.callbackTable[socket];
+  //Clear callback
+  delete flok.net.callbackTable[socket]
+}

data/app/drivers/chrome/src/ui.js

@@ -0,0 +1,87 @@
+/*drivers = window.drivers || {}*/
+//drivers.ui = {}
+
+////Create a new surface based on a prototype name and information. Should return a surface pointer
+//drivers.ui.createSurface = function(protoName, info) {
+  //var $proto = $("#surface-prototypes").find(".surface[data-name=\'"+protoName+"\']");
+  //if ($proto.length === 0) {
+    //throw "Couldn't find a surface prototype named: \(protoName)";
+  //}
+
+  ////Get a UUID, move the surface to the 'body' element and hidden
+  //var uuid = UUID()
+  //$proto.attr("data-uuid", uuid);
+  //$("body").append($proto[0].outerHTML);
+  //$proto.removeAttr("data-uuid");
+
+  //$sel = $("[data-uuid='" + uuid + "']");
+  //$sel.addClass("hidden");
+
+  ////Does this have a controller?
+  //var scc = drivers.ui.scc[protoName];
+
+  //(function() {
+    //var _sel = $sel;
+    //var p = pipe(function(msg) {
+      //console.log("CLICKED!");
+      //if (msg === "sign_in_clicked") {
+        //var source = drivers.ui.createSurface("nav_container", {color: "blue"});
+        //var source2 = drivers.ui.createSurface("login", {color: "blue"});
+        //drivers.ui.embedSurface(source, $("#root-surface"), "main", false, null);
+        //drivers.ui.embedSurface(source2, source, "content", false, null);
+
+      //} else if (msg === "login") {
+        //var source = drivers.ui.createSurface("loading");
+        //drivers.ui.embedSurface(source, $("#root-surface"), "main", false, null);
+
+        //var callback = function() {
+          //alert("error!");
+        //var source = drivers.ui.createSurface("nav_container", {color: "blue"});
+        //var source2 = drivers.ui.createSurface("login", {color: "blue"});
+        //drivers.ui.embedSurface(source, $("#root-surface"), "main", false, null);
+        //drivers.ui.embedSurface(source2, source, "content", false, null);
+        //}
+        //setTimeout(callback, 400);
+
+      //} else {
+        //var source = drivers.ui.createSurface("splash");
+        //drivers.ui.embedSurface(source, $("#root-surface"), "main", false, null);
+      //}
+    //});
+
+    //if (scc != undefined) {
+      //new scc($sel, info, p);
+    //}
+  //})();
+
+  ////Our surface pointers are selectors
+  //return $sel
+//}
+
+////Delete a surface which removes it from the UI
+//drivers.ui.deleteSurface = function(sp) {
+  //sp.remove();
+//}
+
+////Embed a surface into another surface in the view with the correct name
+////source_sp - The surface we are embedding
+////dest_sp - The surface we are embedding into
+////animated - If true, a segue is allowed to take place
+////animationDidComplete - Call this funtction if animated is true when you are done animating.
+//drivers.ui.embedSurface = function(source_sp, dest_sp, viewName, animated, animationDidComplete) {
+  ////Lookup view selector
+  //var $view = dest_sp.find(".view[data-name=" + viewName + "]");
+  //if ($view.length === 0) {
+    //throw "Found surface, but couldn't find a view *inside* a surface named: " + viewName;
+  //}
+
+  //$view.html("");
+  //source_sp.appendTo($view);
+  //source_sp.removeClass('hidden');
+//}
+
+////Surface controller constructors
+//drivers.ui.scc = {};
+//drivers.ui.regController = function(surfaceName, constructor) {
+  //drivers.ui.scc[surfaceName] = constructor;
+/*}*/

data/app/kern/hello.js

@@ -0,0 +1 @@
+//console.log("Hello world");

data/docs/compilation.md

@@ -1,7 +1,7 @@
 # Compliation
 
-Compilation is handled by the `rake build platform=z` and then end result of that compliation is put in ./products/
-Compilation *always* results in a `./products/$PLATFORM/application.js` file along with other files in `./products/$PLATFORM/` that
+Compilation is handled by the `rake build_world PLATFORM=YOUR_PLATFORM` and then end result of that compliation is put in ./products/
+Compilation *always* results in a `./products/$PLATFORM/application.js` file along with other files in `./products/$PLATFORM/drivers/` that
 were deemed necessary by the platform driver `build` scripts.
 
 ### Build Order
@@ -10,11 +10,8 @@ as necessary.*
 
 ### Compilation is accomplished in the following order.
 
- 1. All files in `./app/config/.*.js` are globbed togeather and sent to `./products/$PLATFORM/glob/0config.js`
- 2. `rake build` is run inside `./app/drivers/$PLATFORM` with the environmental variables set to BUILD_PATH=`./produts/$PLATFORM/driver` (and folder
- 3. created)
- 4. All js files in `./app/libkern/` are globbed togeather and sent to `./products/$PLATFORM/glob/1libkern.js`
- 5. All js files in `./app/kern/` are globbed togeather and sent to `./products/$PLATFORM/glob/2kern.js`
- 6. All js files in `./app/user/config/*.js` are globbed togeather and sent to `./products/$PLATFORM/glob/3user_config.js`
- 7. All js files in `./app/user/*.js` are globbed togeather and sent to `./products/$PLATFORM/glob/4user.js`
- 8. All js files are globbed from `./products/$PLATFORM/glob` and combined into `./products/$PLATFORM/application.js`
+ 1. `rake build` is run inside `./app/drivers/$PLATFORM` with the environmental variables set to BUILD_PATH=`./produts/$PLATFORM/driver` (and folder
+ 2. All js files in `./app/kern/config/*.js` are globbed togeather and sent to `./products/$PLATFORM/glob/1kern_config.js`
+ 3. All js files in `./app/kern/*.js` are globbed togeather and sent to `./products/$PLATFORM/glob/2kern.js`
+ 4. All js files are globbed from `./products/$PLATFORM/glob` and combined into `./products/$PLATFORM/application.js`
+ 5. Auto-generated code is placed at the end (like uname_p)

data/docs/driver_interface.md

@@ -0,0 +1,61 @@
+#Driver Interface
+
+**This file contains a lot of information duplicated in [platform drivers](./platform_drivers.md)**
+
+There is no standard communication protocol or interface for drivers.  The driver stack operates by 
+
+1. The platform drivers bundle, e.g. `./app/drivers/CHROME/` will declare it's `ifaces` in `config.yml`
+2. During compilation, the `application.js` file is embedded with `lsiface()`
+3. Your application may now use `lsiface()` to dynamically alter it's behavior to be suitable.  The application may then make function calls that are specified in the `./app/drivers/iface/$YOUR_INTERFACE.js`.
+
+#What are Driver Interfaces?
+An interface is just a javascript file with a set of function definitions a-lot like C header files.  They are located in `./app/drivers/iface`.  These are not actually used in your compiled program but serve as a reference to other developers on how to implement your interface.  We have future plans to use the interface files themselves so please, please, please... implement the interface files.
+
+Here is an example interface file for a printer.
+
+```js
+//./app/drivers/iface/printer.js
+//This interface provides printing capabilities
+
+//Print a document out from a string, returns a opaque print job pointer. (job)
+function if_print(str) {}
+
+//Cancel a currently queued print.
+function if_cancel_print(job) {}
+```
+
+**Note the 'if_' infront of each function's name, this stands for interface and must be used on all interface functions**.
+
+As you can see, there is no implementation in this code.  This is not just an abbreviated example, this is the entire interface file.  For each platform, you will now have to do two things to use this driver.
+
+1. You must add this driver to your driver's `config.yml` file in the `ifaces`.  In this case, you would add  `printer` to the `ifaces` array.
+2. You must ensure that when the application makes a call to any functions declared in the interface, they are handled appropriately.  For full javascripts systems (like HTML5), this is accomplished by simply defining the needed functions.  For other platforms that use native code, the functions are usually implemented by exporting a native function into the javascript space.
+
+```swift
+let if_print: @objc_block String -> Int = { str in
+    var mutableString = NSMutableString(string: str) as CFMutableStringRef
+    /*
+      -------------------------
+      Execute print code here
+      -------------------------
+    */
+    
+    return printPointer;    
+}
+
+context.setObject(unsafeBitCast(if_print, AnyObject.self), forKeyedSubscript: "if_print")
+```
+
+#Writing good driver interfaces
+A good driver interface, and driver for that matter, implement no logic beyond what is necessary for the completion of that action.  There are exceptions to this rule and they usually are around performant code where it is necessary to use native drivers to number crunch, parse, etc. 
+
+#States & Opaque Pointers
+If it can be avoided, it is best to avoid using any state information in your drivers.  Opaque pointers can assist with this.  E.g. the `if_print` function as described above returns an `opaque pointer` that is compatible with `if_cancel_print`.  The driver that implements this interface is free to implement opaque pointers in any way that seems sensible. The only restriction is that the pointers are able to be read by javascript itself and regurgetated in a useful form. Try to avoid using a hash table if possible if you can directly feed native pointers as there are performance benefits and less state information.
+
+------
+
+
+#Dynamic Drivers
+Flok does not currently support dypnamic driver attachment or probing like many operating systems, e.g. Freebsd's `kldload`.  If you need the ability to probe dynamically, for example, some devices support *LTE Bleuetooth Activity Trackers*, then it would be best to create a driver interface called `sensors` which would tell you if any `LTE Bluetooth Activity Trackers` are available.
+
+

data/docs/interface.md

@@ -0,0 +1,5 @@
+#Kernel Interface
+
+### Information added into javascript during compilation
+ * `IFACES` - An array of strings representing the interfaces the driver supported (through config.yml).  Static compiled at end.
+ * `PLATFORM` - A string that represents the current platform name

data/docs/platform_drivers.md

@@ -30,6 +30,7 @@ ifaces:
   - ui
   - network
 ```
+You may access this list in a compiled kernel via `lsiface()`. See functions for more info.
 
 ### Platform specifics
 See the ./app/drivers/$PLATFORM/README.md file for information on each individual platforms specifics.

data/docs/project_layout.md

@@ -1,5 +1,6 @@
 # Project layout
  * app/ - All actual pieces of the kernel code sit here.
    * app/drivers - Parts of (a) and (b)
-     * app/drivers/interfaces - Generic interfaces that are suggested to be implemented.
-     * app/drivers/$PLATFORM - Platform specific way to implement the interface. See *platform drivers* for information.
+     * app/drivers/iface- Generic interfaces that are suggested to be implemented.
+     * app/drivers/$PLATFORM/ - Platform specific way to implement the interface. See [platform drivers](./platform_drivers.md) for information.
+   * app/kern - The remaining part, your app, the kernel, etc. all live under here.

data/docs/testing.md

@@ -0,0 +1 @@
+# Testing

data/flok.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "execjs", "~> 2.5"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.2"

data/lib/flok.rb

@@ -1,45 +1,5 @@
 require "flok/version"
+require "flok/build"
 
 module Flok
-  module MergeSource
-    #Merge all the kernel javascript files into one string
-    def self.merge_kernel
-      Dir.chdir(File.dirname(__FILE__)) do
-        #Embed drivers
-        Dir.chdir("../app/drivers/browser") do
-          `rake build`
-        end
-        out = File.read("../products/drivers/browser.js")
-
-        Dir.chdir("./js/kernel/") do
-          js_files = Dir["*.js"]
-          js_files.each do |js|
-            out << File.read(js)
-            out << "\n"
-          end
-        end
-
-        return out
-      end
-
-    end
-
-    def self.merge_user_app
-      js_files = Dir["./app/*.js"]
-      out = ""
-      js_files.each do |js|
-        out << File.read(js)
-        out << "\n"
-      end
-
-      return out
-    end
-
-    def self.merge_all
-      str_kernel = self.merge_kernel
-      str_user = self.merge_user_app
-
-      return str_kernel + "\n" + str_user
-    end
-  end
 end