flok 0.0.56 → 0.0.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f11a251e7f7a6be8c6033610957b05c1c7f04278
-  data.tar.gz: 1646de98263783b810393d6820b5804b60cb7a03
+  metadata.gz: cecb7632c1464b7d9b8a55ed9d08f5eb4263d310
+  data.tar.gz: 578139d4896e901f26be711a8db1ed757f19c916
 SHA512:
-  metadata.gz: 12ddb9c8418d2f3db7be40f5f95a4043705f377dfe1bb3ca932bee73e0950a477a25a52739ee4630fd269634c6e2a109d1c4160ea38678a6079c7b4e346afbd4
-  data.tar.gz: acc4c1780455d4eaed34089b28ae76719312c208fd4b5efc8baea788a0ab3ea785d4dbd8666edf383179aa6b45ae32b4a5768d9b74b0abb501f69ae6a93bc629
+  metadata.gz: 0b927b5dd005df16cb2e8b909892e9779b5b8966112c94b53cfa3cd0823225c646ac92a5111611099fb79e12b8eed14ecd0c6028665732916e8d5494fd189213
+  data.tar.gz: 47a932f03f912ab6c601f75c6fc6a8d5d0a9c7f99028d315ca31ce93bb3f3114161e7effe9202baa585ca8af095b7c5e035d26e8c7357dd0e19a9e3580b1d647

data/app/kern/controller.js

@@ -37,9 +37,6 @@ function _embed(vc_name, sp, context, event_gw) {
   //the 'main' spot, and so on
   var base = tels(spots.length+1);
 
-  //TODO: choose action
-  var action = Object.keys(cte.actions)[0];
-
   spots.unshift("vc") //Borrow spots array to place 'vc' in the front => ['vc', 'main', ...]
     //Initialize the view at base+1 (base+0 is vc), and the vc at base+0
     SEND("main", "if_init_view", vname, {}, base+1, spots);
@@ -78,7 +75,7 @@ function _embed(vc_name, sp, context, event_gw) {
   //Create controller information struct
   var info = {
     context: context,
-    action: action,
+    action: "choose_action",
     cte: cte,
     embeds: embeds,
     event_gw: event_gw
@@ -94,11 +91,13 @@ function _embed(vc_name, sp, context, event_gw) {
   cte.__init__(base);
 
   //Call the on_entry function with the base address
-  cte.actions[action].on_entry(base);
+  cte.actions[info.action].on_entry(base);
 
-  //Notify action
-  var payload = {from: null, to: action};
-  SEND("main", "if_event", base, "action", payload);
+  <% if @debug %>
+  if (info.action === "choose_action") {
+    throw "choose_action did not specify a Goto";
+  }
+  <% end %>
 
   return base;
 }
@@ -111,7 +110,7 @@ function controller_event_callback(ep, event_name, info) {
   //Now, get the ctable entry
   var cte = inst.cte;
 
-  //Now find the event handler
+  //Now find the event handler for the current action of the controller
   var handler = cte.actions[inst.action].handlers[event_name];
   if (handler !== undefined) {
     handler(ep, info);

data/app/kern/services/test.rb

@@ -4,4 +4,12 @@ service :test do
       <%= @name %>_function_args = x;
     }
   }
+
+  on "test_sync", %{
+    int_event(bp, "test_sync_res", params);
+  }
+
+  on "test_async", %{
+    int_event_defer(bp, "test_async_res", params);
+  }
 end

data/docs/controllers.md

@@ -24,9 +24,11 @@ Let's write a `fuc` controller that has 2 tabs and a content area. The view is i
 ```ruby
 controller "tab_controller" do
   spots "content"
-  services "my_service" #See docs on services for what this means
+  services "my_service", "vm" #See docs on services for what this means
 
-  #Global on_entry, will only be run once on the first action
+  #Global on_entry, will only be run once on the first action. If chooose_action
+  #is used, this is run before choose_action, but still only once throughout this
+  #controller's lifetime
   on_entry %{
   }
 
@@ -37,6 +39,32 @@ controller "tab_controller" do
     end
   end
 
+  #Optional
+  #Called after on_entry, but before any action is entered. This is a pseudo
+  #action and assumes that everything you do inside will be performed fully
+  #synchronously. This action will not notify your view hierarchy that the
+  #action has been entered. Only supports Request and Goto macros. Embedding will
+  #result in undefined behavior. If you decide to not use choose_action then
+  #the first action will be the action that is run first
+  choose_action do
+    on_entry %{
+      var info = {ns: "session", id: "session"};
+      Request("vm", "read_sync", info);
+    }
+
+    #Like every normal action, choose_action supports getting events
+    #Here we are checking a synchronous read for the session information
+    #You *must* use only synchronous events here
+    on "read_sync_res", %{
+      if (params.page === null) {
+        Goto("home");
+      } else {
+        Goto("about");
+      }
+    }
+  end
+
+  #Actions are independent of one another, you may not name an action "choose_action"
   #The home tab
   action "home" do
     #Macros can be called via their name

data/docs/services/test.md

@@ -0,0 +1,39 @@
+#Test Service
+This is the test service. Used for various specs
+
+#Requests
+  * `test_sync` - Will send you a synchronous response via the event `test_sync_res` that contains
+    the same parameters that you sent
+  * `test_async` - Will send you a synchronous response via the event `test_async_res` that contains
+e.g.
+
+###`test_sync`
+```ruby
+on_entry %{
+  var info = {
+    foo: "bar"
+  }
+  Request("test", "test_sync", info);
+}
+
+#This is called immediately
+on "test_sync_res", %{
+  test_sync_res_params = params; //params will equal {foo: "bar"}
+}
+```
+
+###`test_async`
+```ruby
+on_entry %{
+  var info = {
+    foo: "bar"
+  }
+  Request("test", "test_async", info);
+}
+
+#This is called after the next int_event comes through via int_event_defer
+on "test_async_res", %{
+  test_async_res_params = params; //params will equal {foo: "bar"}
+}
+```
+

data/lib/flok/user_compiler.rb

@@ -196,6 +196,11 @@ module Flok
             //located in ctable
             __info__.cte.actions[__info__.action].on_entry(__base__)
 
+            //'choose_action' pseudo-action will be sent as 'null' as it's the initial state
+            if (old_action === "choose_action") {
+              old_action = null;
+            }
+
             //Send off event for action change
             main_q.push([3, "if_event", __base__, "action", {
               from: old_action,
@@ -479,6 +484,16 @@ module Flok
       @controller = self
 
       self.instance_eval(&block)
+
+      #Ensure that choose_action exists
+      actions = @ctx.actions_for_controller(@name)
+      unless actions.detect{|e| e.name === :choose_action}
+        @ctx.action self, :choose_action do
+          on_entry %{
+            Goto("#{actions[0].name}");
+          }
+        end
+      end
     end
 
     #Create an action macro
@@ -490,6 +505,10 @@ module Flok
       @_on_entry = _macro(str)
     end
 
+    def choose_action &block
+      @ctx.action self, :choose_action, &block
+    end
+
     #Names of spots
     def spots *spots
       @spots += spots

data/lib/flok/user_compiler_templates/ctable.js.erb

@@ -2,6 +2,7 @@ ctable = {
   <% @controllers.each do |c| %>
       <%= c.name %>: {
         __init__: function(__base__) {
+          //Call service on_connect
           <% c._services.each do |s| %>
               <%= s %>_on_connect(__base__);
           <% end %>

data/lib/flok/version.rb

@@ -1,3 +1,3 @@
 module Flok
-  VERSION = "0.0.56"
+  VERSION = "0.0.57"
 end

data/spec/kern/assets/choose_action.rb

@@ -0,0 +1,24 @@
+controller :my_controller do
+  spots "content"
+
+  on_entry %{
+    on_entry_call_order = ["global_on_entry"];
+  }
+
+  choose_action do
+    on_entry %{
+      on_entry_call_order.push("choose_action_on_entry");
+
+      Goto("index");
+    }
+  end
+
+  action "index" do
+    on_entry %{
+      on_entry_call_order.push("index_on_entry");
+    }
+  end
+
+  action "alt" do
+  end
+end

data/spec/kern/assets/choose_action_async.rb

@@ -0,0 +1,25 @@
+controller :my_controller do
+  spots "content"
+  services "test"
+
+  choose_action do
+    on_entry %{
+      var info = {foo: "bar"};
+      Request("test", "test_async", info);
+    }
+
+    #This is illegal, we are testing for an exception. All
+    #events received in choose_action must be synchronous
+    on "test_async_res", %{
+      Goto("index");
+    }
+  end
+
+  action "index" do
+    on_entry %{
+    }
+  end
+
+  action "alt" do
+  end
+end

data/spec/kern/assets/choose_action_sync.rb

@@ -0,0 +1,23 @@
+controller :my_controller do
+  spots "content"
+  services "test"
+
+  choose_action do
+    on_entry %{
+      var info = {foo: "bar"};
+      Request("test", "test_sync", info);
+    }
+
+    on "test_sync_res", %{
+      Goto("index");
+    }
+  end
+
+  action "index" do
+    on_entry %{
+    }
+  end
+
+  action "alt" do
+  end
+end

data/spec/kern/assets/choose_action_sync_no_goto.rb

@@ -0,0 +1,22 @@
+controller :my_controller do
+  spots "content"
+  services "test"
+
+  choose_action do
+    on_entry %{
+      var info = {foo: "bar"};
+      Request("test", "test_sync", info);
+    }
+
+    on "test_sync_res", %{
+    }
+  end
+
+  action "index" do
+    on_entry %{
+    }
+  end
+
+  action "alt" do
+  end
+end

data/spec/kern/assets/no_choose_action.rb

@@ -0,0 +1,16 @@
+controller :my_controller do
+  spots "content"
+
+  on_entry %{
+    on_entry_call_order = ["global_on_entry"];
+  }
+
+  action "index" do
+    on_entry %{
+      on_entry_call_order.push("index_on_entry");
+    }
+  end
+
+  action "alt" do
+  end
+end

data/spec/kern/assets/rest_service/controller2.rb

@@ -0,0 +1,17 @@
+controller :my_controller do
+  services :rest
+
+  action :my_action do
+    on_entry %{
+      var info = {
+        path: "test",
+        params: {"hello": "world"}
+      }
+      Request("rest", "get", info);
+    }
+
+    on "rest_res", %{
+      rest_res_params = params;
+    }
+  end
+end

data/spec/kern/assets/test_service/config0.rb

@@ -0,0 +1,3 @@
+#Simple service config that uses built-in spec service to create a instance called 'spec'
+service_instance :test, :test, {
+}

data/spec/kern/assets/test_service/controller0.rb

@@ -0,0 +1,9 @@
+controller :my_controller do
+  services :test
+
+  action :my_action do
+    on_entry %{
+      my_action_entered = true;
+    }
+  end
+end

data/spec/kern/assets/test_service/controller1.rb

@@ -0,0 +1,16 @@
+controller :my_controller do
+  services :test
+
+  action :my_action do
+    on_entry %{
+      var info = {
+        foo: "bar"
+      }
+      Request("test", "test_sync", info);
+    }
+
+    on "test_sync_res", %{
+      test_sync_res_params = params;
+    }
+  end
+end

data/spec/kern/assets/test_service/controller2.rb

@@ -0,0 +1,16 @@
+controller :my_controller do
+  services :test
+
+  action :my_action do
+    on_entry %{
+      var info = {
+        foo: "bar"
+      }
+      Request("test", "test_async", info);
+    }
+
+    on "test_async_res", %{
+      test_async_res_params = params;
+    }
+  end
+end

data/spec/kern/assets/test_service_config.rb

@@ -0,0 +1,2 @@
+#Simple service config that uses built-in spec service to create a instance called 'spec'
+service_instance :test, :test, {}

data/spec/kern/controller_spec.rb

@@ -614,7 +614,6 @@ RSpec.describe "kern:controller_spec" do
     expect(ctx.eval("read_res_called")).to eq(true)
   end
 
-
   it "Does allow interval (every) events" do
     #Compile the controller
     ctx = flok_new_user File.read('./spec/kern/assets/interval.rb')
@@ -767,4 +766,106 @@ RSpec.describe "kern:controller_spec" do
 
     expect(ctx.eval("timer_called")).to eq(2)
   end
+
+  it "Does support the optional choose_action function" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/choose_action.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+    }
+  end
+
+  it "Does support the optional choose_action function with on_entry, and on_entry is called after on_entry global and before the first actions on_entry" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/choose_action.rb')
+
+    #Run the embed function
+    dump = ctx.evald %{
+      //Call embed on main root view
+      dump.base = _embed("my_controller", 0, {}, null);
+      dump.on_entry_call_order = on_entry_call_order; 
+
+      for (var i = 0; i < 100; ++i) {
+        int_dispatch([]);
+      }
+    }
+
+    #Global on_entry should be called before choose_action_on_entry
+    expect(dump["on_entry_call_order"]).to eq([
+      "global_on_entry",
+      "choose_action_on_entry",
+      "index_on_entry"
+    ])
+
+    #Expect not to get an event from the choose_action
+    @driver.ignore_up_to "if_event"
+    @driver.mexpect("if_event", [Integer, "action", {"from" => nil, "to" => "index"}])
+  end
+
+  it "Does support a controller that lacks choose_action, the first action will be the first action that appears in the controller" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/no_choose_action.rb')
+
+    #Run the embed function
+    dump = ctx.evald %{
+      //Call embed on main root view
+      dump.base = _embed("my_controller", 0, {}, null);
+      dump.on_entry_call_order = on_entry_call_order; 
+
+      for (var i = 0; i < 100; ++i) {
+        int_dispatch([]);
+      }
+    }
+
+    #Global on_entry should be called before choose_action_on_entry
+    expect(dump["on_entry_call_order"]).to eq([
+      "global_on_entry",
+      "index_on_entry"
+    ])
+
+    #Expect not to get an event from the choose_action
+    @driver.ignore_up_to "if_event"
+    @driver.mexpect("if_event", [Integer, "action", {"from" => nil, "to" => "index"}])
+  end
+
+  it "Does support using a synchronous request in choose_action" do
+    ctx = flok_new_user File.read('./spec/kern/assets/choose_action_sync.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    dump = ctx.evald %{
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    #Expect not to get an event from the choose_action
+    @driver.ignore_up_to "if_event"
+    @driver.mexpect("if_event", [Integer, "action", {"from" => nil, "to" => "index"}])
+  end
+
+  it "Not setting a Goto will result in an exception" do
+    ctx = flok_new_user File.read('./spec/kern/assets/choose_action_sync_no_goto.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    expect {
+      ctx.evald %{
+        base = _embed("my_controller", 0, {}, null);
+
+        //Drain queue
+        int_dispatch([]);
+      }
+    }.to raise_exception
+  end
+
+  it "Calling an asynchronous request for the Goto in choose_action will result in an exception" do
+    ctx = flok_new_user File.read('./spec/kern/assets/choose_action_async.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    expect {
+      ctx.evald %{
+        base = _embed("my_controller", 0, {}, null);
+
+        //Drain queue
+        int_dispatch([]);
+      }
+    }.to raise_error(/choose_action.*Goto/)
+  end
 end

data/spec/kern/test_service_spec.rb

@@ -0,0 +1,83 @@
+#The test service
+
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+require 'zlib'
+
+RSpec.describe "kern:test_service" do
+  include Zlib
+  include_context "kern"
+
+  it "Can use test service" do
+    ctx = flok_new_user File.read('./spec/kern/assets/test_service/controller0.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    dump = ctx.evald %{
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      dump.my_action_entered = my_action_entered;
+    }
+
+    expect(dump["my_action_entered"]).to eq(true)
+  end
+
+  it "Can use test service to make a test_sync request" do
+    ctx = flok_new_user File.read('./spec/kern/assets/test_service/controller1.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    dump = ctx.evald %{
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      dump.test_sync_res_params = test_sync_res_params;
+    }
+
+    expect(dump["test_sync_res_params"]).to eq({
+      "foo" => "bar"
+    })
+  end
+
+  it "Can use test service to make a test_sync request and should still succeed if int_dispatch isnt called" do
+    ctx = flok_new_user File.read('./spec/kern/assets/test_service/controller1.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    dump = ctx.evald %{
+      base = _embed("my_controller", 0, {}, null);
+      dump.test_sync_res_params = test_sync_res_params;
+    }
+
+    expect(dump["test_sync_res_params"]).to eq({
+      "foo" => "bar"
+    })
+  end
+
+
+  it "Can use test service to make a test_async request, and this request will fail unless int_dispatch is called (which triggers the async reply)" do
+    ctx = flok_new_user File.read('./spec/kern/assets/test_service/controller2.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    expect {
+      ctx.evald %{
+        base = _embed("my_controller", 0, {}, null);
+        dump.test_async_res_params = test_async_res_params;
+      }
+    }.to raise_exception(V8::Error)
+  end
+
+  it "Can use test service to make a test_async request, and should succeed after int_dispatch is called (dispatching the async reply)" do
+    ctx = flok_new_user File.read('./spec/kern/assets/test_service/controller2.rb'), File.read("./spec/kern/assets/test_service/config0.rb") 
+    dump = ctx.evald %{
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      dump.test_async_res_params = test_async_res_params;
+    }
+
+    expect(dump["test_async_res_params"]).to eq({
+      "foo" => "bar"
+    })
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flok
 version: !ruby/object:Gem::Version
-  version: 0.0.56
+  version: 0.0.57
 platform: ruby
 authors:
 - seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -344,6 +344,7 @@ files:
 - docs/rakefile.md
 - docs/services.md
 - docs/services/rest.md
+- docs/services/test.md
 - docs/services/vm.md
 - docs/services/vm/diff.md
 - docs/services/vm/pagers.md
@@ -1128,6 +1129,10 @@ files:
 - spec/iface/kern/ping_spec.rb
 - spec/iface/kern/pipe_spec.rb
 - spec/kern/assets/blank.rb
+- spec/kern/assets/choose_action.rb
+- spec/kern/assets/choose_action_async.rb
+- spec/kern/assets/choose_action_sync.rb
+- spec/kern/assets/choose_action_sync_no_goto.rb
 - spec/kern/assets/controller0.rb
 - spec/kern/assets/controller0defer.rb
 - spec/kern/assets/controller0defer0.rb
@@ -1153,10 +1158,12 @@ files:
 - spec/kern/assets/interval2.rb
 - spec/kern/assets/interval3.rb
 - spec/kern/assets/lower_event.rb
+- spec/kern/assets/no_choose_action.rb
 - spec/kern/assets/raise_event.rb
 - spec/kern/assets/rest_service/config0.rb
 - spec/kern/assets/rest_service/controller0.rb
 - spec/kern/assets/rest_service/controller1.rb
+- spec/kern/assets/rest_service/controller2.rb
 - spec/kern/assets/send_event.rb
 - spec/kern/assets/service0.rb
 - spec/kern/assets/service1.rb
@@ -1171,6 +1178,11 @@ files:
 - spec/kern/assets/test_event.rb
 - spec/kern/assets/test_event2.rb
 - spec/kern/assets/test_event3.rb
+- spec/kern/assets/test_service/config0.rb
+- spec/kern/assets/test_service/controller0.rb
+- spec/kern/assets/test_service/controller1.rb
+- spec/kern/assets/test_service/controller2.rb
+- spec/kern/assets/test_service_config.rb
 - spec/kern/assets/vm/config0.rb
 - spec/kern/assets/vm/config1.rb
 - spec/kern/assets/vm/config2.rb
@@ -1250,6 +1262,7 @@ files:
 - spec/kern/functions_spec.rb
 - spec/kern/rest_service_spec.rb
 - spec/kern/service_controller_spec.rb
+- spec/kern/test_service_spec.rb
 - spec/kern/vm_service_functional_spec.rb
 - spec/kern/vm_service_mem_pagers_spec.rb
 - spec/kern/vm_service_net_sim_pager_spec.rb
@@ -2039,6 +2052,10 @@ test_files:
 - spec/iface/kern/ping_spec.rb
 - spec/iface/kern/pipe_spec.rb
 - spec/kern/assets/blank.rb
+- spec/kern/assets/choose_action.rb
+- spec/kern/assets/choose_action_async.rb
+- spec/kern/assets/choose_action_sync.rb
+- spec/kern/assets/choose_action_sync_no_goto.rb
 - spec/kern/assets/controller0.rb
 - spec/kern/assets/controller0defer.rb
 - spec/kern/assets/controller0defer0.rb
@@ -2064,10 +2081,12 @@ test_files:
 - spec/kern/assets/interval2.rb
 - spec/kern/assets/interval3.rb
 - spec/kern/assets/lower_event.rb
+- spec/kern/assets/no_choose_action.rb
 - spec/kern/assets/raise_event.rb
 - spec/kern/assets/rest_service/config0.rb
 - spec/kern/assets/rest_service/controller0.rb
 - spec/kern/assets/rest_service/controller1.rb
+- spec/kern/assets/rest_service/controller2.rb
 - spec/kern/assets/send_event.rb
 - spec/kern/assets/service0.rb
 - spec/kern/assets/service1.rb
@@ -2082,6 +2101,11 @@ test_files:
 - spec/kern/assets/test_event.rb
 - spec/kern/assets/test_event2.rb
 - spec/kern/assets/test_event3.rb
+- spec/kern/assets/test_service/config0.rb
+- spec/kern/assets/test_service/controller0.rb
+- spec/kern/assets/test_service/controller1.rb
+- spec/kern/assets/test_service/controller2.rb
+- spec/kern/assets/test_service_config.rb
 - spec/kern/assets/vm/config0.rb
 - spec/kern/assets/vm/config1.rb
 - spec/kern/assets/vm/config2.rb
@@ -2161,6 +2185,7 @@ test_files:
 - spec/kern/functions_spec.rb
 - spec/kern/rest_service_spec.rb
 - spec/kern/service_controller_spec.rb
+- spec/kern/test_service_spec.rb
 - spec/kern/vm_service_functional_spec.rb
 - spec/kern/vm_service_mem_pagers_spec.rb
 - spec/kern/vm_service_net_sim_pager_spec.rb