flok 0.0.12 → 0.0.14

data/app/drivers/iface/ui.js

@@ -1,31 +0,0 @@
-//Handles displaying UI
-//Key conceptsr
-// 1) Surface is like a 'View Controller', a surface contains named views.
-// 2) Creating a surface will never show anything. You must embed it.
-// 3) Embedding a surface should only trigger an animation segue if animated is false.
-// 4) 'sp' stands for 'surface pointer'.  This is an opaque type that is platform dependent.  
-//    For websites it could be selectors. For iOS, it could be a UIView or UIViewController
-
-//Surface structure
-//{
-//  parent: sp                 The surface that embedded this surface
-//  childs: [sp, sp, sp, ...]  An array of surfaces that this embeds. N(childs) =< N(namedViews)
-//}
-
-//Create a new surface based on a prototype name and information. Should return a surface pointer
-drivers.ui.createSurface = function(protoName, info) {
-  return sp;
-}
-
-//Delete a surface which removes it from the UI
-drivers.ui.deleteSurface = function(sp) {
-}
-
-//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
-//viewName - The name of the view in the destination surface
-//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) {
-}

data/app/kern/hello.js

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

data/docs/driver_interface.md

@@ -1,61 +0,0 @@
-#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

@@ -1,5 +0,0 @@
-#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

@@ -1,36 +0,0 @@
-#Platform Drivers
-Each platform has it's own set of drivers. You do not have to implement *all* the drivers on a platform and you may create your own drivers to suite your own needs.  Platform drivers sit in `app/drivers/$PLATFORM` and *must* contain at least the following files.
-  
-During compliation all platform drivers must respect enviorenmental variables. For example, for $BUILD_PATH you can read this in your Rakefile via `ENV['BUILD_PATH']`.		
-  * $BUILD_PATH    - The absolute file path (not including the filename) of where to put build files.		
-
-Your build path may contain additional files as you see fit.  These files will be available in the user's project in `./products/$PLATFORM/xxxxx` with the exception of the javascript outputfile which will be merged at the beginning of the complete source.		
-  
-Additionally, the full application contains the function `lsdrivers()` which will return an array of all the drivers that are supported`
-
-
-### $PLATFORM
-The 'platform' naming convention is for it to be completely upper-case.
-
-### Testing
-All drivers must pass the driver test suite located in `./spec/driver_interface/*_spec.rb` for any drivers they have enabled in their config.yml
-
-In order to run the *interface* driver test suite you must run `rake test:driver_iface` or `rake test:driver_iface PLATFORM=MY_PLATFORM`.  For running a test suite for the specific driver, that is accomplished through `rake test:driver PLATFORM=MY_PLATFORM`
-
-### Files
-  * ./Rakefile - You must at least have the tasks `test` and `build`.  Note that if you're writing custom drivers in your own project folder, this does not apply to you. Also, you must observe the rules in the platform's README.md		
-  * ./README.md - A description of this platform driver, how to extend it with custom drivers, and how it is deployed correctly.		
-  * ./config.yml - Must contain a list of the supported interfaces for a driver.
-
-### config.yml
-Your configuration must have a `ifaces` key. This is an array of the supported interfaces.  The interface name is just the filename located in
-`./app/drivers/iface/.*.js`.  In the example below there is a `ui.js` and `network.js` in the `./app/drivers/iface/` folder.
-```yml
-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/spec/build_valid_spec.rb

@@ -1,61 +0,0 @@
-#This spec checks to make sure that for each driver, the emitted javascript file actually executes correctly
-#In addition, it runs a sanity check by calling flok()
-
-require 'execjs'
-require 'helpers'
-require 'flok/build'
-
-def build_world_for_platform platform
-  Flok.system!("rake build_world PLATFORM=#{platform}")
-end
-
-RSpec.describe "Emitted build products are valid for all platforms" do
-  it "can run application.js on execjs environment without runtime initial failure" do
-    #get a list of the platforms based on the drev folder names
-    platforms = (Dir["./app/drivers/*"]).map!{|e| File.basename(e)} - ["iface"]
-
-    platforms.each do |p|
-      puts "testing #{p}"
-      puts "\t-building world for $platform=#{p}"
-      build_world_for_platform(p)
-
-      puts "\t-executing world"
-      ctx = ExecJS.compile(File.read("./products/#{p}/application.js"))
-    end
-  end
-
-  it "supports IFACES global" do
-    #get a list of the platforms based on the drev folder names
-    platforms = (Dir["./app/drivers/*"]).map!{|e| File.basename(e)} - ["iface"]
-
-    platforms.each do |p|
-      puts "testing #{p}"
-      puts "\t-building world for $platform=#{p}"
-      build_world_for_platform(p)
-
-      #IFACES
-      puts "\t-executing world"
-      ctx = ExecJS.compile(File.read("./products/#{p}/application.js"))
-      ifaces = ctx.eval("IFACES")
-      driver_ifaces = YAML.load_file("./app/drivers/#{p}/config.yml")["ifaces"]
-      expect(ifaces).to eq(driver_ifaces)
-    end
-  end
-
-  it "supports PLATFORM global" do
-    #get a list of the platforms based on the drev folder names
-    platforms = (Dir["./app/drivers/*"]).map!{|e| File.basename(e)} - ["iface"]
-
-    platforms.each do |p|
-      puts "testing #{p}"
-      puts "\t-building world for $platform=#{p}"
-      build_world_for_platform(p)
-
-      #IFACES
-      puts "\t-executing world"
-      ctx = ExecJS.compile(File.read("./products/#{p}/application.js"))
-      platform = ctx.eval("PLATFORM")
-      expect(platform).to eq(p)
-    end
-  end
-end

data/spec/drivers/net_spec.rb

@@ -1,159 +0,0 @@
-#require 'phantomjs'
-#require 'rspec/wait' 
-#require 'webrick'
-#require "./spec/helpers"
-#require 'json'
-#require 'os'
-
-#RSpec.describe "Drivers::Net" do
-  #before(:all) do
-    ##Respond to kill
-    #@killable = []
-  #end
-
-  #after(:all) do
-    #@killable ||= []
-    #@killable.each {|p| p.kill}
-
-    ##Stopgap to kill everything
-    #if OS.mac?
-      #`ps -ax | grep net_spec | awk '{print $1}' | grep -v #{Process.pid} | xargs kill -9 >/dev/null 2>&1`;
-      #`ps -ax | grep phantomjs| awk '{print $1}' | xargs kill -9 >/dev/null 2>&1`
-    #end
-  #end
-
- #it "can make a get request" do
-    ##Build driver
-    #`cd ./app/drivers/browser; rake build`
-
-    #cr = ChromeRunner.new "./products/drivers/browser.js"
-
-    ##Setup rspec test server
-    #called = false
-    #spek = Webbing.get "/" do |params|
-      #called = true
-      #{"hello" => "world"}.to_json
-    #end
-    #@killable << spek
-    #cr.eval "drivers.network.request('GET', 'http://localhost:#{spek.port}', {})"
-    #cr.commit
-
-    ##Load synchronously, but execute the code asynchronously, quit after it's been running for 3 seconds
-    #wait(3).for { called }.to eq(true)
-  #end
-
-  #it "can make a get request with parameters" do
-    ##Build driver
-    #`cd ./app/drivers/browser; rake build`
-
-    #cr = ChromeRunner.new "./products/drivers/browser.js"
-
-    ##Setup rspec test server
-    #called = false
-    #result = {}
-    #spek = Webbing.get "/" do |params|
-      #result = params
-      #called = true
-      #{"hello" => "world"}.to_json
-    #end
-    #@killable << spek
-    #cr.eval "drivers.network.request('GET', 'http://localhost:#{spek.port}', {'a':'b'})"
-    #cr.commit
-
-    ##Load synchronously, but execute the code asynchronously, quit after it's been running for 3 seconds
-    #wait(3).for { called }.to eq(true)
-    #expect(result).to eq({'a' => 'b'})
-  #end
-
-  #it "can make a get and respond from callback" do
-    ##Build driver
-    #`cd ./app/drivers/browser; rake build`
-
-    #cr = ChromeRunner.new "./products/drivers/browser.js"
-
-   ##Setup rspec test server
-    #@spek = Webbing.get "/" do |params|
-      #{"port" => @spek2.port}.to_json
-    #end
-
-    #called = false
-    #@spek2 = Webbing.get "/" do |params|
-      #called = true
-    #end
-
-    #@killable << @spek
-    #@killable << @spek2
-    #cr.eval %{
-      #drivers.network.request('GET', 'http://localhost:#{@spek.port}', {}, function(res) {
-        #var port = res.port;
-        #drivers.network.request('GET', 'http://localhost:'+port, {});
-      #})
-    #}
-    #cr.commit
-
-    ###Load synchronously, but execute the code asynchronously, quit after it's been running for 3 seconds
-    #wait(3).for { called }.to eq(true)
-  #end
-
-  #it "can make a get and cancel a request that has not yet been received via callback" do
-    ##Build driver
-    #`cd ./app/drivers/browser; rake build`
-
-    #cr = ChromeRunner.new "./products/drivers/browser.js"
-
-   ##Setup rspec test server
-   #called = false
-   #@spek = Webbing.get "/" do |params|
-     #{:port => @spek2.port}.to_json
-   #end
-
-  #@spek2 = Webbing.get "/" do |params|
-    #called = true
-  #end
-
-    #@killable << @spek
-    #cr.eval %{
-      #socket = drivers.network.request('GET', 'http://localhost:#{@spek.port}', {}, function(res) {
-        #var port = res.port;
-        #drivers.network.request('GET', 'http://localhost:'+port, {});
-
-      #});
-
-      #drivers.network.cancel_request(socket);
-    #}
-    #cr.commit
-
-    ##Load synchronously, but execute the code asynchronously, quit after it's been running for 3 seconds
-    #sleep 2
-    #expect(called).to eq(false)
- #end
-
-  #it "returns an error for a non-existant resource" do
-    ##Build driver
-    #`cd ./app/drivers/browser; rake build`
-
-    #cr = ChromeRunner.new "./products/drivers/browser.js"
-
-   ##Setup rspec test server
-   #@spek = Webbing.get "/" do |params|
-     #{:port => @spek2.port}.to_json
-   #end
-
-   #error = nil
-  #@spek2 = Webbing.get "/" do |params|
-    #error = params["error"]
-  #end
-
-    #@killable << @spek
-    #cr.eval %{
-      #socket = drivers.network.request('GET', 'http://localhost:#{@spek.port}/404', {}, function(res, error) {
-        #drivers.network.request('GET', 'http://localhost:'+#{@spek2.port}, {error: error});
-      #});
-    #}
-    #cr.commit
-
-    ##Load synchronously, but execute the code asynchronously, quit after it's been running for 3 seconds
-    #sleep 2
-    #expect(error).to eq("true")
-  #end
-#end

data/spec/helpers.rb

@@ -1,140 +0,0 @@
-require 'securerandom'
-require 'phantomjs'
-
-#Duplex pipe
-###################################################################################################################
-class IO
-  def self.duplex_pipe
-    return DuplexPipe.new
-  end
-end
-
-class DuplexPipe
-  def initialize
-    @r0, @w0 = IO.pipe
-    @r1, @w1 = IO.pipe
-  end
-
-  #Choose arbitrary side, just different ones for forked processes
-  def claim_low
-    @r = @r0
-    @w = @w1
-  end
-
-
-
-  def claim_high
-    @r = @r1
-    @w = @w0
-  end
-
-  def write msg
-    @w.write msg
-  end
-
-  def puts msg
-    @w.puts msg
-  end
-
-  def readline
-    @r.readline
-  end
-end
-###################################################################################################################
-
-#RESTful mock
-###################################################################################################################
-module Webbing
-  def self.get path, &block
-    Webbing.new "GET", path, &block
-  end
-
-  class Webbing
-    attr_accessor :pid
-    attr_accessor :port
-
-    def kill
-      Process.kill("KILL", @pid)
-    end
-
-    def initialize verb, path, &block
-      @verb = verb
-      @path = path
-      @block = block
-      @port = rand(30000)+3000
-
-      @pipe = IO.duplex_pipe
-      @pid = fork do
-        @pipe.claim_high
-        @server = WEBrick::HTTPServer.new :Port => @port, :DocumentRoot => ".", :StartCallback => Proc.new {
-          @pipe.puts("ready")
-        }
-        @server.mount_proc '/' do |req, res|
-          @pipe.puts req.query.to_json
-          res.body = @pipe.readline
-          res.header["Access-Control-Allow-Origin"] = "*"
-          res.header["Content-Type"] = "json/text"
-        end
-        @server.mount_proc '/404' do |req, res|
-          res.header["Access-Control-Allow-Origin"] = "*"
-
-          raise WEBrick::HTTPStatus::NotFound
-        end
-        @server.start
-      end
-
-      @pipe.claim_low
-      @pipe.readline #Wait for 'ready'
-      Thread.new do
-        begin
-          loop do
-            params = JSON.parse(@pipe.readline)
-            res = @block.call(params)
-            @pipe.puts res.to_json
-          end
-        rescue => e
-          puts "Exception: #{e.inspect}"
-        end
-      end
-    end
-  end
-end
-###################################################################################################################
-
-#Mock chrome javascript running  (Will not do anything until you run commit)
-#Meant to be for one shot tests
-#(1) load with                       --- cr = ChromeRunner.new('code.js')
-#(2) queue execute with              --- cr.eval('console.log("hello world");')
-#(3) run in it's own process via     --- cr.commit
-###################################################################################################################
-class ChromeRunner
-  #Load a javascript file
-  def initialize fn
-    @code = File.read(fn)
-    @code << "\n"
-    @@phantomjs_path ||= Phantomjs.path
-  end
-
-  def eval(code)
-    @code << code
-    @code << "\n"
-  end
-
-  def commit
-    file = Tempfile.new SecureRandom.hex
-    file.write @code
-
-    @pid = fork do
-      system("#{@@phantomjs_path} #{file.path}")
-    end
-  end
-
-  def kill
-    Process.kill("KILL", @pid)
-  end
-end
-###################################################################################################################
-
-###################################################################################################################
-#Execute a system command, will throw an exception on error
-###################################################################################################################