flok 0.0.12 → 0.0.14

data/spec/kern/assets/goto2.rb

@@ -0,0 +1,19 @@
+controller :my_controller do
+  view :test_view
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "test_event", %{
+      Goto("my_other_action")
+    }
+  end
+
+  action :my_other_action do
+    on_entry %{
+    }
+    on "hello", %{
+    }
+  end
+end

data/spec/kern/assets/lower_event.rb

@@ -0,0 +1,30 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+      var payload = {secret: context.secret};
+      Embed("my_sub_controller", "hello", payload);
+    }
+
+    on "test_event", %{
+      //Forward params
+      Lower("hello", "lower_request", params);
+    }
+  end
+end
+
+controller :my_sub_controller do
+  view :test_view2
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "lower_request", %{
+      lower_request_called_with = params;
+    }
+  end
+end

data/spec/kern/assets/raise_event.rb

@@ -0,0 +1,30 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+      var payload = {secret: context.secret};
+      Embed("my_sub_controller", "hello", payload);
+    }
+
+    on "raise_res", %{
+      //Sets after on_entry of my_sub_controller
+      raise_res_context = params;
+    }
+  end
+end
+
+controller :my_sub_controller do
+  view :test_view2
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+      context.hello = "world"
+
+      //This sends context to 'my_controller'
+      Raise("raise_res", context);
+    }
+  end
+end

data/spec/kern/assets/rest_service.rb

@@ -0,0 +1,21 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "start_request", %{
+      var payload = {
+        url: "http://test.services.fittr.com/ping",
+        params: {},
+      };
+      Request("rest", payload, "request_response");
+    }
+
+    on "request_response", %{
+      response = params;
+    }
+  end
+end

data/spec/kern/assets/send_event.rb

@@ -0,0 +1,14 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+      on_entry_base_pointer = __base__;
+    }
+
+    on "hello", %{
+      Send("test_event", params);
+    }
+  end
+end

data/spec/kern/assets/test_event.rb

@@ -0,0 +1,14 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "test_event", %{
+      test_action_called_base = __base__;
+      test_action_called_params = params;
+    }
+  end
+end

data/spec/kern/assets/test_event2.rb

@@ -0,0 +1,26 @@
+controller :my_controller do
+  view :test_view
+  spots "content"
+
+  action :my_action do
+    on_entry %{
+      Embed("my_controller2", "content", {})
+    }
+
+    on "test_event", %{
+      test_action_called_base = __base__;
+      test_action_called_params = params;
+    }
+  end
+end
+
+#This controller will receive test_event but should
+#pass it up to 'my_controller'
+controller :my_controller2 do
+  view :test_view
+
+  action :my_action do
+    on_entry %{
+    }
+  end
+end

data/spec/kern/assets/test_event3.rb

@@ -0,0 +1,21 @@
+controller :my_controller do
+  view :test_view
+  spots "content"
+
+  action :my_action do
+    on_entry %{
+      Embed("my_controller2", "content", {})
+    }
+  end
+end
+
+#This controller will receive test_event but should
+#pass it up to 'my_controller'
+controller :my_controller2 do
+  view :test_view
+
+  action :my_action do
+    on_entry %{
+    }
+  end
+end

data/spec/kern/assets/timer_service.rb

@@ -0,0 +1,20 @@
+controller :my_controller do
+  view :test_view
+  spots "hello", "world"
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "start_request", %{
+      var payload = {
+        ticks: 4
+      };
+      Request("timer", payload, "tick");
+    }
+
+    on "tick", %{
+      did_tick = true;
+    }
+  end
+end

data/spec/kern/controller_spec.rb

@@ -0,0 +1,500 @@
+#Anything and everything to do with view controllers (not directly UI) above the driver level
+
+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'
+
+RSpec.describe "kern:controller_spec" do
+  include_context "kern"
+
+#Can initialize a controller via embed and have the correct if_dispatch messages
+  it "Can initiate a controller via _embed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+  end
+
+ #Can initialize a controller via embed and that controller has the correct info
+  it "Can initiate a controller via _embed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    #Run the embed function
+    secret = SecureRandom.hex
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {secret: "#{secret}"}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {"secret" => secret}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+  end
+
+  #Can initialize a controller via embed and the sub-controller has the correct info
+  it "Can initiate a controller via _embed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/embed_info.rb')
+
+    #Run the embed function
+    secret = SecureRandom.hex
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {secret: "#{secret}"}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {"secret" => secret}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_init_view", ["test_view2", {}, base+5, ["main", "hello", "world"]])
+
+    #We expect the sub controller to receive the same info
+    @driver.mexpect("if_controller_init", [base+4, base+5, "my_sub_controller", {"secret" => secret}])
+  end
+
+  it "Can initiate a controller via _embed and have a controller_info located in tel table" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+    ctx.eval %{ 
+      info = tel_deref(#{base})
+    }
+
+    info = ctx.eval("info")
+    expect(info).not_to eq(nil)
+
+    #Should have the right set of keys in the controller info
+    ctx.eval %{
+      context = info.context
+      action = info.action
+      cte = info.cte
+      event_gw = info.event_gw
+    }
+
+    expect(ctx.eval('context')).not_to eq(nil)
+    expect(ctx.eval('action')).not_to eq(nil)
+    expect(ctx.eval('cte')).not_to eq(nil)
+    expect(ctx.eval('"event_gw" in info')).not_to eq(nil)
+  end
+
+ it "calls on_entry with the base pointer when a controller is embedded for the initial action" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    expect(ctx.eval('on_entry_base_pointer')).to eq(ctx.eval("base"))
+  end
+
+  it "calls on_entry with the base pointer when a controller is embedded for the initial action" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    expect(ctx.eval('on_entry_base_pointer')).to eq(ctx.eval("base"))
+  end
+
+  it "can embed a controller within a controller and put the right views in" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller1.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval('base')
+
+    #First, we expect the base vc to be setup as a view
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+
+    #Now we expect the embedded view to be setup as a view within the base view
+    #It's +5, because the base takes us 4 (+3) entries, and then the next embedded takes up
+    #the next view controlelr and finally main view entry (5th)
+    @driver.mexpect("if_init_view", ["test_view2", {}, base+5, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base+4, base+5, "my_sub_controller", {}])
+    @driver.mexpect("if_attach_view", [base+5, base+2])
+
+    #Now expect actions in reverse order up hierarchy
+    @driver.mexpect("if_event", [base+4, "action", {"from" => nil, "to" => "my_action"}])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+  end
+
+  it "can embed a controller within a controller and allocate the correct view controller instance" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller1.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view, this controller also embeds a controller
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval('base')
+
+    #+4 because it's after the parent vc's ['vc', 'main', 'hello', world'] ['vc', 'main', 'hello']
+    #                                                                        ^^
+    ctx.eval %{ 
+      info = tel_deref(#{base+4})
+    }
+
+    info = ctx.eval("info")
+    expect(info).not_to eq(nil)
+  end
+
+  it "calls on_entry with the base pointer when the sub_controller is embedded" do
+    #compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller1.rb')
+
+    #run the embed function
+    ctx.eval %{
+      //call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //drain queue
+      int_dispatch([]);
+    }
+
+    #+4 because the base has 2 spots, so it should have incremented to 4
+    expect(ctx.eval('on_entry_base_pointer')).to eq(ctx.eval("base")+4)
+  end
+
+  it "Can receive 'test_event' destined for the controller and set a variable" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/test_event.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base, "test_event", {}]);
+    }
+
+    #Now we expect some variables to be set in the action
+    expect(ctx.eval("test_action_called_base")).not_to eq(nil)
+    expect(ctx.eval("test_action_called_params")).not_to eq(nil)
+  end
+
+  it "Can initiate a controller via _embed and have a tracked list of embeds in info" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller1.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+    ctx.eval %{ 
+      info = tel_deref(#{base})
+    }
+
+    #Should have the right set of keys in the controller info
+    ctx.eval %{
+      embeds = JSON.stringify(info.embeds)
+    }
+    embeds = JSON.parse(ctx.eval("embeds"))
+
+    #Expect base+4 because it's the vc itself, not the spot it's in
+    expect(embeds).to eq([[base+4], []])
+  end
+
+  it "Can receive 'test_event' and change actions" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/goto.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base, "test_event", {}]);
+    }
+
+    #Now we expect the action for the controller to be 'my_other_action' and for it's on_entry
+    #to be called
+    expect(ctx.eval("my_other_action_on_entry_called")).not_to eq(nil)
+  end
+
+  it "Does tear down the old embedded view from the embedded view controller when switching actions" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/goto.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base, "test_event", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    #Expect that a view was embedded inside a view at this point
+    #The view (or main spot/view) should be base+1 because base+0 is the vc itself.
+    #['vc', 'main', 'hello', 'world'], ['vc', 'main']
+    #|--0-----1--------2--------3---|=======================The my_controller
+    #                                  |-4------5---|====== The my_controller2
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0]) #Attach to main root spot
+
+    #Embed my_controller2 in action 'my_action'
+    @driver.mexpect("if_init_view", ["test_view2", {}, base+5, ["main"]])
+    @driver.mexpect("if_controller_init", [base+4, base+5, "my_controller2", {}])
+    @driver.mexpect("if_attach_view", [base+5, base+2])
+
+    #Expect action start
+    @driver.mexpect("if_event", [base+4, "action", {"from" => nil, "to" => "my_action"}])
+
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+
+    #And then the request to switch views with the 'test_event' removed the second view
+    @driver.mexpect("if_free_view", [base+5])
+  end
+
+  it "Can receive 'test_event' in a child view and set a variable in the parent view (bubble up)" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/test_event2.rb')
+
+    #Run the embed function
+    #['vc', 'main', 'content'] ['vc', 'main']
+    #  0      1         2        3       4
+    #  Send message to base+3
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base+3, "test_event", {}]);
+    }
+
+    #Now we expect some variables to be set in the action
+    expect(ctx.eval("test_action_called_base")).not_to eq(nil)
+    expect(ctx.eval("test_action_called_params")).not_to eq(nil)
+  end
+
+  it "Can receive 'test_event' in a child view and not crash when bubble up" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/test_event3.rb')
+
+    #Run the embed function
+    #['vc', 'main', 'content'] ['vc', 'main']
+    #  0      1         2        3       4
+    #  Send message to base+3
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base+3, "test_event", {}]);
+    }
+  end
+
+  it "When it changes actions, it sends an event to the controller called 'action'" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/goto2.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base, "test_event", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    #The usual
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+    @driver.mexpect("if_event", [base, "action", {"from" => "my_action", "to" => "my_other_action"}])
+  end
+
+  #It can instate a controller that uses a def in the controller inside an action to define an event handler
+  it "Can initiate a controller via _embed and def a macro that can be used inside the action to define an event" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_def.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      //Drain queue with test event
+      int_dispatch([3, "int_event", base, "test_event", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "content"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+    @driver.mexpect("if_event", [base, "action", {"from" => "my_action", "to" => "my_other_action"}])
+  end
+
+  #Can send a custom event from the flok controller
+  it "Can send a custom event from the flok controller via Send" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/send_event.rb')
+
+    secret = SecureRandom.hex
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with an event
+      int_dispatch([3, "int_event", base, "hello", {secret: "#{secret}"}]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+    @driver.mexpect("if_event", [base, "test_event", {"secret" => secret}])
+  end
+
+  it "makes the child's event_gw the parent controller" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/event_gw.rb')
+
+    #Run the embed function
+    secret = SecureRandom.hex
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {secret: "#{secret}"}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+    sub_event_gw = ctx.eval("sub_event_gw")
+
+    expect(sub_event_gw).to eq(base)
+  end
+
+
+  #Can have a sub-controller Raise an event and for the parent controller to receive this
+  it "Can have a sub-controller Raise an event and for the parent controller to receive this" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/raise_event.rb')
+
+    #Run the embed function
+    secret = SecureRandom.hex
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {secret: "#{secret}"}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    #This is set when the parent controller receives an event
+    raise_res_context = JSON.parse(ctx.eval("JSON.stringify(raise_res_context)"))
+
+    expect(raise_res_context).to eq({"secret" => "#{secret}", "hello" => "world"})
+  end
+
+ #Can signal a spot from a parent controller
+  it "Can signal a spot sub-controller and trigger an event" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/lower_event.rb')
+
+    #Run the embed function
+    secret = SecureRandom.hex
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([3, "int_event", base, "test_event", {secret: "#{secret}"}]);
+    }
+
+    #This is set when the parent controller receives an event
+    lower_request_called_with = JSON.parse(ctx.eval("JSON.stringify(lower_request_called_with)"))
+
+    expect(lower_request_called_with).to eq({"secret" => "#{secret}"})
+  end
+end