ovto 0.5.0 → 0.6.2

data/examples/sinatra/Gemfile

@@ -4,3 +4,5 @@ gem 'opal-sprockets'
 gem 'sinatra'
 gem 'sinatra-contrib'
 gem 'rack'
+gem 'rake'
+gem 'puma'

data/examples/sinatra/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    ovto (0.4.1)
+    ovto (0.6.0)
       opal (>= 0.11, < 2)
       rack (~> 2.0)
       thor (~> 0.20)
@@ -9,44 +9,44 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    backports (3.13.0)
-    concurrent-ruby (1.1.5)
-    hike (1.2.3)
-    multi_json (1.13.1)
-    mustermann (1.0.3)
-    opal (0.11.4)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.8)
+    opal (1.2.0)
       ast (>= 2.3.0)
-      hike (~> 1.2)
-      parser (= 2.3.3.1)
-      sourcemap (~> 0.1.0)
-    opal-sprockets (0.4.3.0.11.0.3.7)
-      opal (~> 0.11.0)
-      sprockets (~> 3.7)
+      parser (~> 3.0)
+    opal-sprockets (1.0.2)
+      opal (>= 1.0, < 2.0)
+      sprockets (~> 4.0)
       tilt (>= 1.4)
-    parser (2.3.3.1)
-      ast (~> 2.2)
-    rack (2.0.8)
-    rack-protection (2.0.5)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    puma (5.5.2)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
-    sinatra (2.0.5)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
-    sinatra-contrib (2.0.5)
-      backports (>= 2.8.2)
+    sinatra-contrib (2.1.0)
       multi_json
       mustermann (~> 1.0)
-      rack-protection (= 2.0.5)
-      sinatra (= 2.0.5)
-      tilt (>= 1.3, < 3)
-    sourcemap (0.1.1)
-    sprockets (3.7.2)
+      rack-protection (= 2.1.0)
+      sinatra (= 2.1.0)
+      tilt (~> 2.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     thor (0.20.3)
-    tilt (2.0.9)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -54,9 +54,11 @@ PLATFORMS
 DEPENDENCIES
   opal-sprockets
   ovto!
+  puma
   rack
+  rake
   sinatra
   sinatra-contrib
 
 BUNDLED WITH
-   2.0.1
+   2.2.22

data/examples/sinatra/app.rb

@@ -3,16 +3,13 @@ require 'sinatra/reloader'
 require 'opal'
 
 class SinatraApp < Sinatra::Base
-  # Proc to generate javascript include tag (see config.ru)
-  set :generate_javascript_include_tag, nil
-
   configure(:development) do
     register Sinatra::Reloader
     also_reload "#{__dir__}/**/*.rb"
   end
 
   get '/' do
-    @js_tag = options.generate_javascript_include_tag
+    @js_tag = $GENERATE_JAVASCRIPT_INCLUDE_TAG.call # Defined in config.ru
     erb :index  # Render views/index.erb
   end
 end

data/examples/sinatra/config.ru

@@ -2,20 +2,20 @@ require 'opal/sprockets'
 require_relative './app.rb'
 
 Opal.use_gem 'ovto'
-opal = Opal::Sprockets::Server.new {|s|
+opal_server = Opal::Sprockets::Server.new {|s|
   s.append_path './ovto/'
   s.main = 'app'
 }
 
-sprockets   = opal.sprockets
+sprockets   = opal_server.sprockets
 prefix      = '/assets'
 
 map prefix do
   run sprockets
 end
 
-run Sinatra.new(SinatraApp){
-  set :generate_javascript_include_tag, proc{
-    ::Opal::Sprockets.javascript_include_tag('app', sprockets: sprockets, prefix: prefix, debug: true)
-  }
+$GENERATE_JAVASCRIPT_INCLUDE_TAG = ->{
+  ::Opal::Sprockets.javascript_include_tag('app', sprockets: sprockets, prefix: prefix, debug: true)
 }
+
+run SinatraApp

data/examples/static/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    ovto (0.4.1)
+    ovto (0.6.0)
       opal (>= 0.11, < 2)
       rack (~> 2.0)
       thor (~> 0.20)
@@ -9,15 +9,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.2)
     ifchanged (1.0.1)
-    opal (1.0.2)
+    opal (1.2.0)
       ast (>= 2.3.0)
-      parser (~> 2.6)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rack (2.0.8)
-    rake (12.3.2)
+      parser (~> 3.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rake (13.0.6)
     thor (0.20.3)
 
 PLATFORMS
@@ -29,4 +29,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.0.1
+   2.2.22

data/lib/ovto/actions.rb

@@ -1,6 +1,9 @@
 module Ovto
   # Base class for ovto actions.
   class Actions
+    # WiredActions must be set after initialization
+    # (this cannot be an argument of #initialize because Actions and
+    # WiredActions have references to each other)
     attr_writer :wired_actions
 
     def actions
@@ -10,5 +13,13 @@ module Ovto
     def state
       @wired_actions._app.state
     end
+
+    def middleware_name
+      WiredActionSet::I_AM_APP_NOT_A_MIDDLEWARE
+    end
+
+    def middleware_path
+      []
+    end
   end
 end

data/lib/ovto/app.rb

@@ -1,18 +1,37 @@
 module Ovto
   class App
+    # List of installed middleware classes
+    def self.middlewares
+      @middlewares ||= []
+    end
+
     # Create an App and start it
     def self.run(*args)
       new.run(*args)
     end
 
+    # Install a middleware
+    def self.use(middleware_class)
+      self.middlewares.push(middleware_class)
+    end
+
     def initialize
-      @state = self.class.const_get('State').new
-      @wired_actions = nil
+      app_state_class = self.class.const_get('State')
+      # Inject middleware states
+      app_state_class.item :_middlewares, default_proc: ->{
+        Ovto::Middleware.create_middleware_states_class(self.class.middlewares).new
+      }
+      @state = app_state_class.new
+      @wired_action_set = nil
+      @main_component = nil
     end
     attr_reader :state
 
+    # An instance of YourApp::MainComponent (mainly for testing)
+    attr_reader :main_component
+
     def actions
-      @wired_actions
+      @wired_action_set.app_wired_actions
     end
 
     # Internal use only
@@ -36,9 +55,9 @@ module Ovto
     def _run(id: nil)
       runtime = Ovto::Runtime.new(self)
       actions = self.class.const_get('Actions').new
-      @wired_actions = WiredActions.new(actions, self, runtime)
-      actions.wired_actions = @wired_actions
-      view = create_view
+      @wired_action_set = WiredActionSet.new(self, actions, [], self.class.middlewares, runtime)
+      actions.wired_actions = @wired_action_set.app_wired_actions
+      @main_component = create_view(@wired_action_set)
       if id
         %x{
           document.addEventListener('DOMContentLoaded', function(){
@@ -46,16 +65,16 @@ module Ovto
             if (!container) {
               throw "Ovto::App#run: tag with id='" + id + "' was not found";
             }
-            #{start_application(runtime, view, `container`)}
+            #{start_application(runtime, `container`)}
           });
         }
       else
-        start_application(runtime, view, nil)
+        start_application(runtime, nil)
       end
     end
 
     # Instantiate MyApp::MainComponent
-    def create_view
+    def create_view(wired_action_set)
       begin
         main_component_class = self.class.const_get('MainComponent')
       rescue NameError => orig_ex
@@ -68,12 +87,17 @@ module Ovto
                 "#{self.class}::View to #{self.class}::MainComponent"
         end
       end
-      return main_component_class.new(@wired_actions)
+      return main_component_class.new(wired_action_set)
     end
 
-    def start_application(runtime, view, container)
-      runtime.run(view, container)
-      setup
+    def start_application(runtime, container)
+      Ovto.log_error {
+        runtime.run(@main_component, container)
+        setup
+        self.class.middlewares.each do |m|
+          m._run_setup(@wired_action_set[m.name])
+        end
+      }
     end
   end
 end

data/lib/ovto/component.rb

@@ -13,10 +13,16 @@ module Ovto
       ret
     end
 
-    def initialize(wired_actions)
-      @wired_actions = wired_actions
+    # (internal) Defined for convenience
+    def self.middleware_name
+      WiredActionSet::I_AM_APP_NOT_A_MIDDLEWARE
+    end
+
+    def initialize(wired_action_set, middleware_path=[])
+      @wired_action_set = wired_action_set || WiredActionSet.dummy
+      @middleware_path = middleware_path
       # Initialize here for the unit tests
-      @vdom_tree = []
+      @vdom_stack = [[]]
       @components = []
       @components_index = 0
     end
@@ -26,7 +32,7 @@ module Ovto
     end
 
     def state
-      @wired_actions._app.state
+      @wired_action_set.app.state
     end
 
     private
@@ -37,35 +43,35 @@ module Ovto
       do_render({}, state)
     end
 
-    def do_render(args, state)
+    # Call #render to generate VDom
+    def do_render(args, state, &block)
       Ovto.debug_trace_log("rendering #{self}")
-      @vdom_tree = []
+      @vdom_stack = [[]]
       @components_index = 0
       @done_render = false
       @current_state = state
-      parameters = method(:render).parameters
-      if `!parameters` || parameters.nil? || accepts_state?(parameters)
-        # We can pass `state:` safely
-        args_with_state = {state: @current_state}.merge(args)
-        return render(args_with_state)
+      rendered = Ovto.log_error {
+        Ovto.send_args_with_state(self, :render, args, state, &block)
+      }
+      case rendered
+      when String
+        return rendered
+      when Array
+        if rendered.length > 1
+          raise MoreThanOneNode
+        end
+        raise "rendered is empty" if rendered.length == 0
+        return rendered[0]
       else
-        # Check it is empty (see https://github.com/opal/opal/issues/1872)
-        return args.empty? ? render() : render(**args)
-      end
-    end
-
-    # Return true if the method accepts `state:` keyword
-    def accepts_state?(parameters)
-      parameters.each do |item|
-        return true if item == [:key, :state] ||
-                       item == [:keyreq, :state] ||
-                       item[0] == :keyrest
+        console.error("#render returned unknown value", rendered)
+        raise "#render returned unknown value"
       end
-      return false
     end
 
     def actions
-      @wired_actions
+      return @middleware_path.inject(@wired_action_set){|wa_set, middleware_name|
+        wa_set[middleware_name]
+      }[WiredActionSet::THE_MIDDLEWARE_ITSELF]
     end
 
     # o 'div', 'Hello.'
@@ -78,31 +84,39 @@ module Ovto
     #   o 'h1', 'Hello.'
     # end
     # o 'div', `{nodeName: ....}`   # Inject VDom spec directly
+    # o SubComponentClass
+    # o SubComponentClass do ... end  # Ovto passes the block to SubComponent#render
     def o(_tag_name, arg1=nil, arg2=nil, &block)
-      if native?(arg1)
+      if native?(arg1)   # Embed VDom directly
         attributes = {}
         content = arg1
-      elsif arg1.is_a?(Hash)
+      elsif arg1.is_a?(Hash)  # Has attributes
         attributes = arg1
         content = arg2
-      elsif arg2 == nil
+      elsif arg2 == nil  # Has content instead of attributes, or both are nil
         attributes = {}
         content = arg1
       else
         raise ArgumentError
       end
 
-      children = render_children(content, block)
       case _tag_name
       when Class
-        result = render_component(_tag_name, attributes, children)
+        if content
+          raise ArgumentError, "use a block to pass content to sub component"
+        end
+        result = render_component(_tag_name, attributes, &block)
       when 'text'
         unless attributes.empty?
           raise ArgumentError, "text cannot take attributes"
         end
         result = content
       when String
+        children = render_children(content, block)
         tag_name, base_attributes = *extract_attrs(_tag_name)
+        if tag_name == "textarea" && (content || block)
+          raise ArgumentError, "Use `value:` to specify content of a textarea"
+        end
         # Ignore nil/false
         more_attributes = attributes.reject{|k, v| !v}
         result = render_tag(tag_name, merge_attrs(base_attributes, more_attributes), children)
@@ -110,16 +124,8 @@ module Ovto
         raise TypeError, "tag_name must be a String or Component but got "+
           Ovto.inspect(tag_name)
       end
-      if @vdom_tree.empty?
-        if @done_render
-          raise MoreThanOneNode, "#{self.class}#render must generate a single DOM node. Please wrap the tags with a 'div' or something."
-        end
-        @done_render = true
-        return result
-      else
-        @vdom_tree.last.push(result)
-        return @vdom_tree.last
-      end
+      @vdom_stack.last.push(result)
+      return @vdom_stack.last
     end
 
     def extract_attrs(tag_name)
@@ -164,37 +170,52 @@ module Ovto
           [content.to_s]
         end
       when block
-        @vdom_tree.push []
-        block_value = block.call
-        results = @vdom_tree.pop
-        if results.length > 0   # 'o' was called at least once
-          results 
-        elsif native?(block_value)
-          # Inject VDom tree written in JS object
-          # eg. Embed markdown
-          [block_value]
-        elsif block_value.is_a?(String)
-          # When 'o' is never called in the child block, use the last value 
-          # eg. 
-          #   o 'span' do
-          #     'Hello'  #=> This will be the content of the span tag
-          #   end
-          [block_value]
-        else
-          #   o 'div' do
-          #     # When items is `[]`, 'o' is never called and `block_value` will be `[]`
-          #     items.each{ o 'div', '...' }
-          #   end
-          []
-        end
+        render_block(block)
       else
         []
       end
     end
 
-    def render_component(comp_class, args, children)
+    def render_block(block)
+      @vdom_stack.push []
+      orig_depth = @vdom_stack.length
+      block_value = block.call
+      @vdom_stack = @vdom_stack.first(orig_depth)
+      results = @vdom_stack.pop
+
+      if results.length > 0   # 'o' was called at least once
+        results 
+      elsif native?(block_value)
+        # Inject VDom tree written in JS object
+        # eg. Embed markdown
+        [block_value]
+      elsif block_value.is_a?(String)
+        # When 'o' is never called in the child block, use the last value 
+        # eg. 
+        #   o 'span' do
+        #     'Hello'  #=> This will be the content of the span tag
+        #   end
+        [block_value]
+      elsif block_value.is_a?(Array)
+        # Case 1
+        #   o "div", &block
+        # Case 2
+        #   items = []
+        #   o 'div' do items.each{ o ... } end  # == o 'div' do [] end
+        block_value
+      else
+        console.error("Invalid block_value:", Ovto.inspect(block_value))
+        raise "Invalid block value"
+      end
+    end
+
+    # Instantiate component and call its #render to get VDom
+    def render_component(comp_class, args, &block)
       comp = new_component(comp_class)
-      return comp.do_render(args, @current_state){ children }
+      orig_stack, @vdom_stack = @vdom_stack, [[]]
+      ret = comp.do_render(args, @current_state, &block)
+      @vdom_stack = orig_stack
+      ret
     end
 
     def new_component(comp_class)
@@ -204,14 +225,56 @@ module Ovto
         return comp
       end
 
-      comp = @components[@components_index] = comp_class.new(@wired_actions)
+      middleware_path = new_middleware_path(comp_class)
+      comp = @components[@components_index] = comp_class.new(@wired_action_set, middleware_path)
       @components_index += 1
       comp
     end
 
+    # Make new middleware_path by adding comp_class
+    def new_middleware_path(comp_class)
+      mw_name = comp_class.middleware_name
+      if (idx = @middleware_path.index(mw_name))
+        # eg. suppose OvtoIde uses OvtoWindow
+        #   class CompI < OvtoIde::Component
+        #     def render
+        #       o Window do 
+        #         o AnotherComponentOfOvtoIde
+        #       end
+        #     end
+        #   end
+        #   class Window < OvtoWindow::Component
+        #     def render(&block)
+        #       o ".window", &block
+        #     end
+        #   end
+        # Rendering order:
+        #   1. CompI (ovto_ide)
+        #   2. Window (ovto_window)
+        #   3. AnotherComponentOfOvtoIde (ovto_ide again)
+        @middleware_path[0..idx]
+      else
+        if comp_class.middleware_name == WiredActionSet::I_AM_APP_NOT_A_MIDDLEWARE
+          @middleware_path
+        else
+         @middleware_path + [comp_class.middleware_name]
+        end
+      end
+      # TODO: it would be nice if we could raise an error when comp_class
+      # is invalid middleware (i.e. not use'd)
+    end
+
     def render_tag(tag_name, attributes, children)
-      js_attributes = Component.hash_to_js_obj(attributes || {})
-      if (style = attributes['style'])
+      attributes_ = attributes.map{|k, v|
+        if k.start_with?("on")
+          # Inject log_error to event handlers
+          [k, ->(e){ Ovto.log_error{ v.call(e) }}]
+        else
+          [k, v]
+        end
+      }.to_h
+      js_attributes = Component.hash_to_js_obj(attributes_ || {})
+      if (style = attributes_['style'])
         `js_attributes.style = #{Component.hash_to_js_obj(style)}`
       end
       children ||= `null`