flok 0.0.34 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d431abb68ddba76219f6dd4d845642c4263db2e
-  data.tar.gz: d990ed3ab70fc60574a881af9d0cbef55d5885e7
+  metadata.gz: 8c530893c64f57d4267ae2edd101adfe456954c2
+  data.tar.gz: a603052bb1bb83292214fc0b1fbcf386655f5987
 SHA512:
-  metadata.gz: fbc1e0e78c014293d361a40fed94158c2ad928b3679eebf4a994c43fe2ac9538a2593e6199218d080d666c5983cc194a76564b228e95f4dc5f5845a0a3fbcb76
-  data.tar.gz: d35279b656c9f60a2af1e5cefc6a8c8a82aea228be36c1279f55b34379896b8291c88d1b8cdca532880a40adbd15381cfc222b097b253a68bc66ad4955861387
+  metadata.gz: f21e469c145f3995ae115615def139675882cda69096f40eff514f76921badd257b21de65ed5b17321f70e020e134c53b62167d5ee3beb875346e2a8b0c8c18a
+  data.tar.gz: b8ff637ba02cb67f73c00f755e4a945f064870cab108471f74463820420518cbdea171bb855e1ba624f4e2f6fcd8dca339587615a80fc3967b62c60e12a79a50

data/app/kern/controller.js

@@ -20,6 +20,11 @@ function _embed(vc_name, sp, context, event_gw) {
   var cte = ctable[vc_name];
 
   //Find the root view name
+  <% if @debug %>
+    if (cte === undefined) {
+      throw "Tried to embed a flok controller named: '" + vc_name + "' but you have not created that controller yet, add controller :" + vc_name + "do ...";
+    }
+  <% end %>
   var vname = cte.root_view;
 
   //Get spot names

data/docs/mod/intercept.md

@@ -0,0 +1,26 @@
+#Intercept
+The intercept module supports the animation system by allowing you to hijack an action change for a particular view controller.
+
+Typical Example:
+```js
+intercept("my_controller", "start_action", "to_action", function($sel) {
+  $sel.find("#content").css("left", "40%");
+  $sel.find("#tab-bar").css("left", "0%");
+
+  cd("../*/")
+});
+```
+
+The actual code used to define an interceptor function is dependent on the platform.
+
+An interceptor is defined like as follows:
+```
+transition "blah" do
+  #Define the context
+  controller "blah"
+  when "a" => "b"
+
+  path :home, "../../0"
+  path :about, "./1"
+end
+```

data/lib/flok.rb

@@ -7,6 +7,7 @@ require "flok/project"
 require "flok/interactive"
 require "flok/user_compiler"
 require "flok/services_compiler"
+require "flok/transition_compiler"
 
 module Flok
 end

data/lib/flok/transition_compiler.rb

@@ -0,0 +1,292 @@
+#Compile a controller ruby file into a javascript string
+
+require 'erb'
+module Flok
+  module TransitionCompiler
+    #Compile a ruby file containing flok controller definitions (from the transition)
+    def self.compile rb_src
+      #Execute code in this context, the context will hold all the information
+      #that is used to then generate code
+      context = TransitionCompilerContext.new
+      context.instance_eval(rb_src, __FILE__, __LINE__)
+
+      @src = ""
+      ctable_erb = File.read File.join(File.dirname(__FILE__), "./transition_compiler_templates/ttable.js.erb")
+      ctable_renderer = ERB.new(ctable_erb)
+      @src << ctable_renderer.result(context.get_binding)
+
+      #puts @src
+
+      return @src
+    end
+  end
+end
+
+#Compiler executes all rb code inside this context
+module Flok
+  class TransitionCompilerContext
+    attr_accessor :controllers, :actions, :ons
+
+    def initialize
+      @controllers = []
+      @actions = []
+      @ons = []
+    end
+
+    def get_binding
+      return binding
+    end
+
+    def transition name, &block
+    end
+
+    def action controller, name, &block
+      @actions << TransitionCompilerAction.new(controller, name, self, &block)
+    end
+
+    def on controller_name, action_name, name, &block
+    end
+
+    def actions_for_controller controller_name
+      return @actions.select{|e| e.controller.name == controller_name}
+    end
+
+    def spots_for_controller controller_name
+      return @controllers.detect{|e| e.name == controller_name}.spots
+    end
+  end
+
+  #Event handler inside an action
+  class TransitionCompilerOn
+    attr_accessor :controller_name, :action_name, :name
+  end
+
+  class TransitionCompilerAction
+    attr_accessor :controller, :name, :on_entry_src, :ons
+
+    def initialize controller, name, ctx, &block
+      @controller = controller
+      @name = name
+      @ctx = ctx
+      @ons = [] #Event handlers
+
+      self.instance_eval(&block)
+    end
+
+    def on_entry js_src
+      #returns a string
+      @on_entry_src = macro(js_src)
+    end
+
+    def on name, js_src
+      @ons << {:name => name, :src => macro(js_src)}
+    end
+
+    def macro js_src
+      lines = js_src.split("\n").map do |line|
+        
+      end
+
+      return lines.join("\n")
+    end
+
+    def macro text
+      out = StringIO.new
+
+      text.split("\n").each do |l|
+        #EMBED(vc_name, spot_name, context) macro
+        if l =~ /Embed/
+          l.strip!
+          l.gsub!(/Embed\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          vc_name = o.shift.gsub(/"/, "")
+          spot_name = o.shift.gsub(/"/, "")
+          context = o.shift
+
+          #Get the spot 
+          spot_index = @controller.spots.index(spot_name)
+          raise "controller #{@controller.name.inspect} attempted to embed #{spot_name.inspect} inside #{@name.inspect}, but #{spot_name.inspect} was not defined in 'spots' (#{@controller.spots.inspect})" unless spot_index
+
+          #Calculate spot index as an offset from the base address using the index of the spot in the spots
+          #address offset
+          res = %{
+            
+            var ptr = _embed("#{vc_name}", __base__+#{spot_index}+1, #{context}, __base__);
+            __info__.embeds[#{spot_index-1}].push(ptr);
+          }
+          out.puts res
+        #Send(event_name, info)
+        elsif l =~ /Send/
+          l.strip!
+          l.gsub!(/Send\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          event_name = o.shift.gsub(/"/, "")
+          info = o.shift
+
+          out << %{
+           main_q.push([3, "if_event", __base__, "#{event_name}", #{info}])
+          }
+        #Raise(event_name, info)
+        elsif l =~ /Raise/
+          l.strip!
+          l.gsub!(/Raise\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          event_name = o.shift
+          info = o.shift
+
+          out << %{
+            int_event(__info__.event_gw, #{event_name}, #{info});
+          }
+        #Lower(spot_name, event_name, info)
+        elsif l =~ /Lower/
+          l.strip!
+          l.gsub!(/Lower\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          spot_name = o.shift.gsub(/"/, "")
+          event_name = o.shift
+          info = o.shift
+
+          #Get the spot 
+          spot_index = @controller.spots.index(spot_name)
+          raise "controller #{@controller.name.inspect} attempted to lower message to #{spot_name.inspect} inside #{@name.inspect}, but #{spot_name.inspect} was not defined in 'spots' (#{@controller.spots.inspect})" unless spot_index
+
+          #Forward an event to the appropriate spot
+          out << %{
+
+            var vcs = __info__.embeds[#{spot_index-1}];
+            for (var i = 0; i < vcs.length; ++i) {
+              int_event(vcs[i], #{event_name}, #{info});
+            }
+          }
+
+        #GOTO(action_name)
+        elsif l =~ /Goto/
+          l.strip!
+          l.gsub!(/Goto\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          action_name = o.shift.gsub(/"/, "")
+
+          #Switch the actions, reset embeds, and call on_entry
+          res = %{
+            var old_action = __info__.action;
+            __info__.action = "#{action_name}";
+
+            //Remove all views
+            var embeds = __info__.embeds;
+            for (var i = 0; i < __info__.embeds.length; ++i) {
+              for (var j = 0; j < __info__.embeds[i].length; ++j) {
+                //Free +1 because that will be the 'main' view
+                main_q.push([1, "if_free_view", embeds[i][j]+1]);
+
+                <% if @debug %>
+                  var vp = embeds[i][j]+1;
+                  //First locate spot this view belongs to in reverse hash
+                  var spot = debug_ui_view_to_spot[vp];
+
+                  //Find it's index in the spot
+                  var idx = debug_ui_spot_to_views[spot].indexOf(vp);
+
+                  //Remove it from the spot => [view]
+                  debug_ui_spot_to_views[spot].splice(idx, 1);
+
+                  //Remove it from the reverse hash
+                  delete debug_ui_view_to_spot[vp];
+                <% end %>
+              }
+            }
+
+            //Prep embeds array, embeds[0] refers to the spot bp+2 (bp is vc, bp+1 is main)
+            __info__.embeds = [];
+            for (var i = 1; i < #{@controller.spots.count}; ++i) {
+              __info__.embeds.push([]);
+            }
+
+            //Call on_entry for the new action via the singleton on_entry
+            //located in ctable
+            __info__.cte.actions[__info__.action].on_entry(__base__)
+
+            //Send off event for action change
+            main_q.push([3, "if_event", __base__, "action", {
+              from: old_action,
+              to: "#{action_name}"
+            }]);
+          }
+          out.puts res
+        #Request(service_name, payload, event_name_cb)
+        elsif l =~ /Request/
+          l.strip!
+          l.gsub!(/Request\(/, "")
+          l.gsub! /\)$/, ""
+          l.gsub! /\);$/, ""
+          o = l.split(",").map{|e| e.strip}
+
+          name = o.shift.gsub(/"/, "")
+          info = o.shift.gsub(/"/, "")
+          event_name = o.shift
+
+          out << %{
+            service_#{name}_req(#{info}, __base__, #{event_name});
+          }
+        else
+          out.puts l
+        end
+      end
+
+      return out.string
+    end
+
+    #You can def things in controller and use them as macros inside actions
+    #But these defs. live in the TransitionCompilerController instance and we need
+    #to delegate these calls to the controller that are not available in the action
+    def method_missing method, *args, &block
+      if macro = @controller.macros[method]
+        #Call the macro in our context
+        self.instance_eval(&macro)
+      else
+        raise "No macro found named: #{method}"
+      end
+    end
+  end
+
+  class TransitionCompilerController
+    attr_accessor :name, :spots, :macros
+    def initialize name, ctx, &block
+      @name = name
+      @ctx = ctx
+      @spots = ['main']
+      @macros = {}
+
+      self.instance_eval(&block)
+    end
+
+    #Create an action macro
+    def macro name, &block
+      @macros[name] = block
+    end
+
+    #Names of spots
+    def spots *spots
+      @spots += spots
+    end
+
+    #Pass through action
+    def action name, &block
+      @ctx.action self, name, &block
+    end
+  end
+end

data/lib/flok/version.rb

@@ -1,3 +1,3 @@
 module Flok
-  VERSION = "0.0.34"
+  VERSION = "0.0.35"
 end

data/spec/etc/transition_compiler/trans0.rb

@@ -0,0 +1,8 @@
+transition :my_controller_tab_bar do
+  controller :my_controller
+  from :blah
+  to :blah2
+
+  path :tab_bar, './content.1'
+  path :home, './content.0'
+end

data/spec/etc/transition_complier_spec.rb

@@ -0,0 +1,32 @@
+#Load all the test files in ./user_compiler/*.js
+
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './lib/flok'
+
+#Testing the compilation of controller/action user files into javascript counterparts
+RSpec.describe "Transition compiler" do
+  #Return a v8 instance of a compiled js file
+  def compile fn
+    compiler = Flok::TransitionCompiler
+    js_src(fn)
+    js_res = compiler.compile(js_src(fn))
+    ctx = V8::Context.new
+    ctx.eval js_res
+    ctx
+  end
+
+  #Get the source for a file in  ./user_compiler/*.rb
+  def js_src fn
+    Dir.chdir File.join(File.dirname(__FILE__), "transition_compiler") do
+      return File.read(fn+'.rb')
+    end
+  end
+
+  it "Can load the ruby module" do
+    compiler = Flok::TransitionCompiler
+  end
+
+  it "Can compile a controller" do
+    ctx = compile "trans0"
+  end
+end

data/spec/kern/controller_spec.rb

@@ -9,7 +9,7 @@ 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
+  #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')
@@ -54,6 +54,26 @@ RSpec.describe "kern:controller_spec" do
     @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
   end
 
+  it "Does raise a sensible error if a controller does not exist" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller0.rb')
+
+    did_error = false
+    #Run the embed function
+    begin
+      secret = SecureRandom.hex
+      ctx.eval %{
+        //Call embed on main root view, should fail
+        base = _embed("my_non_existant_controller", 0, {secret: "#{secret}"}, null);
+      }
+    rescue V8::Error => e
+      expect(e.message).to include("my_non_existant_controller")
+      did_error = true
+    end
+
+    expect(did_error).to eq(true)
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flok
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.35
 platform: ruby
 authors:
 - seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -323,6 +323,7 @@ files:
 - docs/mod/debug.md
 - docs/mod/debug/dump_ui.md
 - docs/mod/event.md
+- docs/mod/intercept.md
 - docs/mod/net.md
 - docs/mod/persist.md
 - docs/mod/sockio.md
@@ -348,6 +349,8 @@ files:
 - lib/flok/project_template/app/controllers/controller.rb
 - lib/flok/service_compiler_templates/services.js.erb
 - lib/flok/services_compiler.rb
+- lib/flok/transition_compiler.rb
+- lib/flok/transition_compiler_templates/ttable.js.erb
 - lib/flok/user_compiler.rb
 - lib/flok/user_compiler_templates/ctable.js.erb
 - lib/flok/utilities.rb
@@ -366,6 +369,8 @@ files:
 - spec/etc/macro_spec.rb
 - spec/etc/service_compiler/service0.rb
 - spec/etc/services_compiler_spec.rb
+- spec/etc/transition_compiler/trans0.rb
+- spec/etc/transition_complier_spec.rb
 - spec/etc/user_compiler/controller0.rb
 - spec/etc/user_compiler_spec.rb
 - spec/iface/driver/assets/debug_socket_server.js
@@ -1159,6 +1164,8 @@ test_files:
 - spec/etc/macro_spec.rb
 - spec/etc/service_compiler/service0.rb
 - spec/etc/services_compiler_spec.rb
+- spec/etc/transition_compiler/trans0.rb
+- spec/etc/transition_complier_spec.rb
 - spec/etc/user_compiler/controller0.rb
 - spec/etc/user_compiler_spec.rb
 - spec/iface/driver/assets/debug_socket_server.js