flok 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0aaa785dec6e5bd611a315aa4e7429461e06ce4
-  data.tar.gz: add685413b3340bb7fb21ff13b1331cbae7a586c
+  metadata.gz: 02bb24d5057d0d06036a92ce5b13032ef7be96a4
+  data.tar.gz: 8f68855c6200a85af0331063ba46d627dab07296
 SHA512:
-  metadata.gz: 4daf5b712620fddf856254b13a19f4fb5e74e8309d19c1074b3f41836e2a86176429e692b02df2bd1d7660c59bc1bc6a2acaeb4cfa5a0aa113485e7611e1f53f
-  data.tar.gz: 3c06fa286b16563bbc4a68f07d567477dd43023889e62925b9415bb37b92911ca704de81d7732de3b1302ecfa69b9ab41208eb679247e27f1b61bfda0fa07ead
+  metadata.gz: 6c7cad839edb5768414bb7bd2f50b4941440f76683d858c22f4c749b7ec7128d84ab9e5a9c3fbbae3ca4bcb8e43414f481053770f0ee2642cd1e3f2b21b7b155
+  data.tar.gz: c8fd538e98704723ce48d99c2ed4dbc96e6e8309d8db0c1648a9fa4807656964714881f548645bb31220a0f44561098117070f14854102549ce5ada891ee769b

data/README.md

@@ -16,16 +16,25 @@ A work in progress
 ## 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)
+ * [Messaging](./docs/messaging.md)
+ * [Drivers](./docs/drivers.md)
+ * [Kernel API](./docs/kernel_api.md)
+ * [Rake Tasks](./docs/rakefile.md)
+ * [Interactive (Mostly debugging)](./docs/interactive.md)
  * [Testing](./docs/testing.md)
+ * [Modules](./docs/modules.md)
+  * [Event (event.js)](./mod/event.md) - Send and receive events to arbitrary objects
+  * [User Interface (ui.js)](./mod/ui.md) - Support displaying views and view hierarchies
+  * [Net (net.js)](./mod/net.md) - Support asynchronous network connections
+  * [Timer (timer.js)](./mod/timer.md) - A tick to keep the system up-to-date and support timeout callbacks
+  * [Persistance (store.js)](./mod/store.md) - A way to store data in a key value system as well as larger blobs
+  * [Transitions (transition.js)](./mod/transition.md) - Works with `ui` to provide interception of segues
 
 ## Requirements
 
-- Mac OS X 10.9+ (Untested)
+- Modern **nix** (FreeBSD, Mac, or Linux)
 - Ruby 2.1 or Higher
 
 ## Communication
@@ -36,6 +45,10 @@ A work in progress
 
 ## Installation
 
+RVM users:
+Run `gem install flok`
+
+System ruby installation?
 Run `sudo gem install flok`
 
 ---

data/Rakefile

@@ -3,10 +3,6 @@ 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)
-
 #Gem things
 #############################################################################
 #Upgrade version of gem
@@ -38,15 +34,85 @@ task :push do
   `gem push flok-#{version}.gem`
   `rm flok-#{version}.gem`
 end
+
+#Compile
 #############################################################################
+namespace :build do
+  task :world do
+    #What platform are we working with?
+    raise "No $PLATFORM given" unless platform = ENV["PLATFORM"]
+    raise "No $FLOK_ENV given" unless environment = ENV["FLOK_ENV"]
+    build_path = "./products/#{platform}"
+
+    Flok.build_world(build_path, platform, environment)
+  end
+end
 
-#Compliation
+#Server Pipe
 #############################################################################
-task :build_world do
-  #What platform are we working with?
-  raise "No $PLATFORM given" unless platform = ENV["PLATFORM"]
-  build_path = "./products/#{platform}"
+namespace :pipe do
+  task :kern => 'build:world' do
+    #Get the platform we are on
+    platform = ENV["PLATFORM"]
+    raise "No $PLATFORM given" unless platform
+    ENV["FLOK_ENV"] = "DEBUG"
 
-  Flok.build_world(build_path, platform)
+    exec "ruby", "-e", %{
+      require 'flok'
+      platform = ENV["PLATFORM"]
+      server = Flok::InteractiveServer.new File.join ['products', platform, 'application.js']
+      server.begin_pipe
+    }
+  end
+
+  task :driver do
+    #Get the platform we are on
+    platform = ENV["PLATFORM"]
+    raise "No $PLATFORM given" unless platform 
+
+    build_path = File.join ["../../../", "products", platform, "drivers"]
+    exec "cd ./app/drivers/#{platform}; rake pipe BUILD_PATH=#{build_path}"
+  end
 end
+
+#Testing
 #############################################################################
+namespace :spec do
+  RSpec::Core::RakeTask.new(:_kern) do |t|
+    t.pattern = "./spec/kern/*_spec.rb"
+    ENV["FLOK_ENV"] = "DEBUG"
+  end
+  task :kern => ['build:world', :_kern]
+
+  RSpec::Core::RakeTask.new(:_iface) do |t|
+    t.pattern = "./spec/iface/**/*_spec.rb"
+    ENV["FLOK_ENV"] = "DEBUG"
+  end
+  task :iface => ['build:world', :_iface]
+
+  RSpec::Core::RakeTask.new(:_etc) do |t|
+    t.pattern = "./spec/etc/*_spec.rb"
+    ENV["FLOK_ENV"] = "DEBUG"
+  end
+  task :etc => ['build:world', :_etc] 
+
+  #Nice helper link
+  task :driver do
+    #Get platform
+    platform = ENV['PLATFORM']
+    raise "No platform given" unless platform
+
+    #Start the driver rake suite
+    system "cd ./app/drivers/#{platform}/; rake spec BUILD_PATH=../../products/#{platform}/driver"
+    raise "Driver spec for platform #{platform} has failed" if $? != 0
+  end
+
+  task :world => ['etc', 'kern', 'iface', 'driver'] do
+  end
+end
+
+task :spec do
+  Flok.platforms.each do |p|
+    Flok.system! "rake spec:world PLATFORM=#{p} FLOK_ENV=DEBUG"
+  end
+end

data/app/drivers/chrome/README.md

@@ -9,13 +9,10 @@ before your `application.js` file.
 There is excatly (1) divider that is used to place everything inside of that is visible.  This divider *must* have the following HTML code:
 ```html
 <!-- Mount point for view hierarchy, fully managed, do not touch -->
-<div id='root_surface' class='surface'>
-  <div class='view' data-name='main'></div>
-  <div class='view' data-name='hidden' style='display: none'></div>
-</div>
+<div id='root'></div>
 
-<!-- Insert your prototypes inside here -->
-<div id='surface-prototypes' style='display: none'>
+<div id='prototypes' style='display: none'>
+  <!-- Insert your prototypes inside here -->
 </div>
 
 ```
@@ -24,17 +21,17 @@ There is excatly (1) divider that is used to place everything inside of that is
 You may add surface prototypes like so under your #surface-prototypes divider
 ```html
 <!-- Insert your prototypes inside here -->
-<div id='surface-prototypes' style='display: none'>
+<div id='prototypes' style='display: none'>
   <!-- A tab container with a sub-view -->
-  <div class='surface' data-name='tab_container'>
+  <div class='view' data-name='nav_container'>
     <h1>Title</h1>
     <button>Back</button>
     <hr />
-    <div class='view' data-name='main'>
+    <div class='spot' data-name='main'>
   </div>
 
   <!-- A login view -->
-  <div class='surface' data-name='login'>
+  <div class='view' data-name='login'>
     <input type='text' placeholder='email' />
     <input type='text' placeholder='password' />
     <button>Login</button>
@@ -42,24 +39,42 @@ You may add surface prototypes like so under your #surface-prototypes divider
 </div>
 ```
 
-### Binding a Controller to a surface
-You create a constructor for a controller and then pass `drivers.ui.regController("surface_name", ControllerConstructorName);` and it will
-automatically be bound when a new surface is created.
+### Binding a Controller to a view
+You create a constructor for a controller
 ```js
 //Constructor for a controller that will automatically bind to a surface with the attribute 'data-name=tab_controller'
-var TabController = function($sel, info, pipe) {
-  //Assign members
-  this.$sel = $sel;
-  this.info = info;
-  this.pipe = pipe;
+var TestController = function() {
+  this.base = FlokController; this.base(); var self = this;
+
+  self.init = function() {
+    //You have access to 'context' in here
+  }
+
+  self.action = function(from, to) {
+    var myH1Tag = self.$sel("h1");  //Example of a jQuery selector
+    self.send("spec", {from: from, to:to});
+  }
 
-  $sel.find("button").on('click', function() {
-    //Do something, like send an event
-  });
+  self.event = function(name, info) {
+    self.send("spec", {name:name, info:info})
+  }
 }
 
 //Register the new controller
 $(document).ready(function() {
-  drivers.ui.regController("tab_container", TabController);
+  regController("__test__", TestController);
 });
+
 ```
+
+### ERB Compliation
+The final `chrome.js` file is run through an `ERB` compiler that contains the variables:
+  * `@debug` - True if `FLOK_ENV=DEBUG`
+  * `@release` - True if `FLOK_ENV=RELEASE`
+  * `@mods` - A list of active kernel modules listed from `config.yml`
+
+### Debug information
+You may access the debug associated information via `debug_assoc` hash.
+
+### Testing
+All *js* files inside `./spec/spec` will be placed in one file under one document ready so QUnit will pick it up as one testing unit

data/app/drivers/chrome/Rakefile

@@ -1,17 +1,91 @@
 require 'fileutils'
-require 'flok/build'
+require_relative '../../../lib/flok'
 require 'securerandom'
+require 'tmpdir'
+require 'phantomjs'
+require 'tempfile'
+require 'erb'
+require File.join(File.dirname(__FILE__), "./build_context")
+require 'cakery'
+require '../../../spec/lib/helpers.rb'
 
 #Compile all the *.js files into one file
 task :build do
-  raise "No BUILD_PATH given" unless BUILD_PATH=ENV["BUILD_PATH"]
+  raise "No BUILD_PATH given" unless build_path=ENV["BUILD_PATH"]
+  build_path = File.expand_path(build_path)
+
+  raise "FLOK_ENV must be debug or release got #{ENV['FLOK_ENV']}" unless ["DEBUG", "RELEASE"].include? ENV["FLOK_ENV"]
 
   my_path = File.expand_path(File.dirname(__FILE__))
   Dir.mktmpdir(SecureRandom.hex) do |dir|
     Dir.chdir dir do
+      #We are in a temporary directory here
       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"))
+
+      #Almost done, we still technically have an ERB file (<%= %> inside our code)
+      #Which isn't technically 'real' JS, and we're still in the temporary folder
+      Flok.src_glob("js", ".", "chrome.js.erb")
+
+      src = File.read "chrome.js.erb"
+      rdr = ERB.new(src)
+      ctx = Chrome::BuildContext.new
+      File.write File.join(build_path, "chrome.js"), rdr.result(ctx.get_binding)
     end
   end
 end
+
+#Make sure it runs
+task :spec do
+  #Build the driver
+  ENV['BUILD_PATH'] = "../../../products/chrome/drivers/"
+  ENV['FLOK_ENV'] = 'DEBUG'
+  system('rake build')
+
+  recipe = Cakery.new("./cakery/spec.js.erb") do |f|
+    f.spec_js_init << "./spec/init/**/*.js"
+    f.spec_js_init << "./spec/config/**/*.js"
+    f.spec_js << "./spec/spec/**/*_spec.js"
+    f.app_js << File.join(ENV['BUILD_PATH'], './chrome.js')
+    f.app_js << File.join(ENV['BUILD_PATH'], '../application.js')
+  end
+
+  recipe.bake
+
+  f = Tempfile.new(SecureRandom.hex)
+  f.puts recipe.src
+  f.close
+
+  include SpecHelpers
+  $stderr.puts "Starting CHROME spec test"
+  $stderr.puts "-----------------------------------------------------"
+  sh2("boojs #{f.path}") do |stdin, stdout|
+    loop do
+      begin
+        Timeout::timeout(5) do
+          res = stdout.readline
+          $stderr.puts "\t"+res
+          if res =~ /__SUCCESS/
+            exit 0
+          elsif res =~ /__FAILED/
+            exit 1
+          end
+        end
+      rescue => e
+        $stderr.puts e.inspect
+        exit 1
+      end
+    end
+  end
+end
+
+#Establish an environment with a pipe assuming the world is built
+task :pipe => :build do
+  raise "No BUILD_PATH given" unless build_path=ENV["BUILD_PATH"]
+
+  exec "ruby", "-e", %{
+    require './pipe'
+    server = InteractiveServer.new "../../../products/chrome/drivers/chrome.js"
+    server.begin_pipe
+  }
+end

data/app/drivers/chrome/build_context.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "../../../lib/flok")
+
+module Chrome
+  class BuildContext
+    def initialize
+      @debug = (ENV['FLOK_ENV'] == "DEBUG")
+      @release = (ENV['FLOK_ENV'] == "RELEASE")
+      Dir.chdir File.join(File.dirname(__FILE__), "../../../") do
+        @mods = Flok::Platform.mods(ENV['PLATFORM'], ENV['FLOK_ENV'])
+      end
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/app/drivers/chrome/cakery/spec.js.erb

@@ -0,0 +1,11 @@
+//All the other code from chrome.js gets thrown in here
+<%= @app_js %>
+
+//This is QUnit and configuration
+<%= @spec_js_init %>
+
+//Execute these specs
+$(document).ready(function() {
+  QUnit.module("spec")
+  <%= @spec_js %>
+});

data/app/drivers/chrome/config.yml

@@ -1,3 +1,18 @@
-ifaces:
-  - ui
-  - network
+DEBUG:
+  debug_attach: socket_io
+  mods:
+    - ui
+    - event
+    - net
+    - segue
+    - controller
+    - debug
+    - sockio
+RELEASE:
+  mods:
+    - ui
+    - event
+    - net
+    - segue
+    - controller
+    - sockio

data/app/drivers/chrome/pipe.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'tempfile'
+require 'securerandom'
+require 'open3'
+
+#Interactive pipe for testing.
+#Creates a server that routes $stdin into if_dispatch and $stdout to int_dispatch.
+
+class InteractiveServer
+  def initialize app_js_path
+    @app_js = File.read app_js_path
+    inject_dispatch_shims
+  end
+
+  #Will take over any remaining IO
+  def begin_pipe
+    tmp = Tempfile.new(SecureRandom.hex)
+    path = tmp.path
+    tmp.close!
+    File.write path, @app_js
+
+    p = Open3.popen3 "boojs #{path}" do |inp, out, err, t|
+      pid = t[:pid]
+      begin
+        loop do
+          results = select([out, err, STDIN], [])
+          if results[0].include? err
+            err_msg = err.readline
+            $stderr.puts err_msg
+            #exit 1 unless err_msg =~ /[debug]/
+          end
+
+          if results[0].include? STDIN
+            begin
+              q = gets.strip
+              inp.puts "if_dispatch(JSON.parse('#{q}'))"
+            rescue Errno::EIO
+              #Can't say anything here, we don't have a pipe
+              exit 1
+            rescue NoMethodError
+              exit 1
+            end
+          end
+
+          if results[0].include? out
+            res = out.readline
+            $stdout.puts res
+            $stdout.flush
+          end
+        end
+      ensure
+        begin
+          Process.kill :INT, pid
+        rescue Errno::ESRCH
+        end
+      end
+    end
+  end
+
+  #JS Functions#####################################################
+  #Make calls to if_dispatch go to $stdout, make $stdin call int_dispatch
+  def inject_dispatch_shims
+    @app_js << %{
+      function int_dispatch(q) {
+        system.stdout.writeLine(JSON.stringify(q));
+      }
+    }
+  end
+  ##################################################################
+end