clearwater 1.0.0.rc4 → 1.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98660a461c2da1071bbc7a8f0cfd3db413ff2224
-  data.tar.gz: 53727157dec9793aafce8f6ec538099fc11c57d3
+  metadata.gz: 36c47513423cf3f1e0a6b3705f3e07d59bbbed31
+  data.tar.gz: 9040af257c8ce168472c92d4ff4dff608bf1da67
 SHA512:
-  metadata.gz: 1016b8ce23f014f05d8aa14df5e7721c59b1950896b45e7f60e498ec4722ab24dde35c58fbc24c2ecac9171c216bb9966fc5a0ace8e510f77de571a8dca1f521
-  data.tar.gz: 38d578979f4aaed936e475d80c577e77a64dc76ce595a4c645eec7bf55d5688b15af2d5d05d604bc4c7d8986d4efd16073975253d0b7fbdcb68b159e45c743e6
+  metadata.gz: 553ce8493b33aa68602b4d4b792083e1ab7c5bb957183e3a5474f9103ac97a3ffa5bfad03f5a1eb6e3075db9e0d04fa8309c8ebe110edc7006a36dacac587faa
+  data.tar.gz: 4341d6edfe0eef28e0a20b1e405a2ad6d93a675bf96471f69268aab0e9088670788da5a1f915128f91a9882fb2c8ee3cda78d267573dae22f05c8a412d6431a0

data/lib/clearwater/component.rb

@@ -27,12 +27,8 @@ module Clearwater
     end
 
     def to_s
-      html = render.to_s
-      if html.respond_to? :html_safe
-        html = html.html_safe
-      end
-
-      html
+      html = Array(render).join
+      html.respond_to?(:html_safe) ? html.html_safe : html
     end
 
     def params

data/lib/clearwater/version.rb

@@ -1,3 +1,3 @@
 module Clearwater
-  VERSION = "1.0.0.rc4"
+  VERSION = "1.0.0.rc5"
 end

data/opal/clearwater/application.rb

@@ -47,11 +47,15 @@ module Clearwater
 
     def unmount
       AppRegistry.delete self
+      @window.off :popstate, &@popstate_listener
+
+      @popstate_listener = nil # Allow the proc to get GCed
+      @watching_url = false
     end
 
     def watch_url
       unless @watching_url
-        @window.on('popstate') { render_current_url }
+        @popstate_listener = @window.on(:popstate) { render_current_url }
         @watching_url = true
       end
     end

data/opal/clearwater/application_registry.rb

@@ -6,6 +6,10 @@ module Clearwater
       @apps = Set.new
     end
 
+    def each &block
+      @apps.each &block
+    end
+
     def << app
       @apps << app
     end

data/opal/clearwater/black_box_node.rb

@@ -20,9 +20,15 @@ module Clearwater
       Renderable.new(self)
     end
 
+    def key
+    end
+
     class Renderable
       def initialize delegate
         @delegate = delegate
+        if delegate.key
+          @key = delegate.key
+        end
       end
 
       def wrap node
@@ -52,7 +58,14 @@ module Clearwater
         //   node: a Bowser-wrapped version of the DOM node
         Opal.defn(self, 'update', function(previous, node) {
           var self = this;
-          #{@delegate.update(`previous.delegate`, wrap(`node`))};
+          if(self.delegate.$$class === previous.delegate.$$class) {
+            #{@delegate.update(`previous.delegate`, wrap(`node`))};
+          } else {
+            previous.destroy(#{wrap(`node`)});
+            var new_node = #{create_element};
+            #{@delegate.mount(`new_node`)};
+            return new_node.native;
+          }
         });
 
         // virtual-dom destroy hook

data/opal/clearwater/cached_render/wrapper.rb

@@ -5,7 +5,7 @@ module Clearwater
 
       def initialize content
         @content = content
-        @key = content.key
+        @key = content.key if content.key
       end
 
       # Hook into vdom diff/patch
@@ -15,6 +15,7 @@ module Clearwater
           var self = this;
 
           if(prev && prev.vnode && #{!@content.should_render?(`prev.content`)}) {
+            #{ @content = `prev.content` }
             return prev.vnode;
           } else {
             var content = #{Component.sanitize_content(@content.render)};

data/opal/clearwater/cached_render.rb

@@ -13,7 +13,6 @@ module Clearwater
     end
 
     def key
-      `undefined`
     end
   end
 end

data/opal/clearwater/component.rb

@@ -43,10 +43,9 @@ module Clearwater
 
     def self.sanitize_content content
       %x{
+        // Is this a Ruby object?
         if(content && content.$$class) {
-          if(content.$$is_array) {
-            return #{content.map { |c| sanitize_content(c) }};
-          } else {
+          if(!content.$$is_array) {
             var render = content.$render;
 
             if(content.$$cached_render) {
@@ -56,7 +55,11 @@ module Clearwater
             } else {
               return content;
             }
+          } else {
+            return #{content.map { |c| sanitize_content(c) }};
           }
+
+        // If it's not a Ruby object, it's probably a virtual-dom node.
         } else {
           return content;
         }
@@ -82,11 +85,13 @@ module Clearwater
       end
     end
 
+    `var vdom = #{VirtualDOM}`
+    `var component = self`
     def tag tag_name, attributes=nil, content=nil
-      VirtualDOM.node(
+      `vdom`.node(
         tag_name,
-        Component.sanitize_attributes(attributes),
-        Component.sanitize_content(content)
+        `component`.sanitize_attributes(attributes),
+        `component`.sanitize_content(content)
       )
     end
 

data/opal/clearwater/dom_reference.rb

@@ -1,5 +1,7 @@
 module Clearwater
   class DOMReference
+    attr_reader :node
+
     def mount node, previous
       @node = node
     end
@@ -34,12 +36,12 @@ module Clearwater
     %x{
       Opal.defn(self, 'hook', function(node, name, previous) {
         var self = this;
-        #{mount(wrap(`node`), `previous`)};
+        #{mount(wrap(`node`), `previous == null ? nil : previous`)};
       });
 
       Opal.defn(self, 'unhook', function(node, name, previous) {
         var self = this;
-        #{unmount(wrap(`node`), `previous`)};
+        #{unmount(wrap(`node`),  `previous == null ? nil : previous`)};
       });
     }
   end

data/opal/clearwater/memoized_component.rb

@@ -0,0 +1,79 @@
+require 'clearwater/component'
+require 'clearwater/black_box_node'
+
+module Clearwater
+  class MemoizedComponent
+    include Clearwater::Component
+
+    def self.memoize *args, &block
+      Placeholder.new(self, args, block)
+    end
+
+    def self.[] key
+      memoize[key]
+    end
+
+    def should_update?
+      true
+    end
+
+    def update
+    end
+
+    def destroy
+    end
+
+    class Placeholder
+      include Clearwater::BlackBoxNode
+
+      attr_reader :klass, :key, :vdom
+
+      def initialize klass, args, block
+        @klass = klass
+        @args = args
+        @block = block
+      end
+
+      def memoize *args, &block
+        initialize @klass, args, block
+        self
+      end
+
+      def [] key
+        @key = key.to_s
+        self
+      end
+
+      def component
+        @component ||= @klass.new(*@args, &@block)
+      end
+
+      def node
+        @node ||= Clearwater::Component.sanitize_content(component)
+      end
+
+      def mount element
+        @vdom = VirtualDOM::Document.new(element)
+
+        # TODO: add a public interface to generate a pre-initialized VDOM::Doc
+        `#@vdom.tree = #{element.to_n}`
+        `#@vdom.node = #{node}`
+        `#@vdom.rendered = true`
+      end
+
+      def update previous
+        @vdom = previous.vdom
+        @component = previous.component
+
+        if component.should_update?(*@args, &@block)
+          component.update(*@args, &@block)
+          @vdom.render component.render
+        end
+      end
+
+      def unmount
+        component.destroy
+      end
+    end
+  end
+end

data/opal/clearwater/virtual_dom.rb

@@ -2,11 +2,13 @@ require 'clearwater/virtual_dom/js/virtual_dom.js'
 
 module Clearwater
   module VirtualDOM
+    `var hash_utils;`
+
     def self.node(tag_name, attributes=nil, content=nil)
       %x{
         return virtualDom.h(
           tag_name,
-          #{HashUtils.camelized_native(attributes)},
+          #{`hash_utils`.camelized_native(attributes)},
           #{sanitize_content(content)}
         );
       }
@@ -36,15 +38,15 @@ module Clearwater
 
     def self.sanitize_content content
       %x{
-        if(content === Opal.nil || content === undefined) return null;
+        if(content === #{nil} || content == null) return null;
         if(content.$$is_array)
           return #{content.map!{ |c| sanitize_content c }};
-        return content;
+        return content.valueOf();
       }
     end
 
     class Document
-      def initialize(root=Bowser.document.create_element('div'))
+      def initialize(root=Bowser.document.create_element(:div))
         @root = root
       end
 
@@ -91,6 +93,8 @@ module Clearwater
     end
 
     module HashUtils
+      `var string_utils = #{StringUtils}`
+
       def self.camelized_native hash
         return hash.to_n unless `!!hash.$$is_hash`
 
@@ -99,7 +103,7 @@ module Clearwater
           for(var index = 0; index < keys.length; index++) {
             key = keys[index];
             v = #{hash[`key`]};
-            js_obj[#{StringUtils.camelize(`key`)}] = v.$$is_hash
+            js_obj[#{`string_utils`.camelize(`key`)}] = v.$$is_hash
               ? self.$camelized_native(v)
               : (
                 (v && v.$$class) // If this is a Ruby object, nativize it
@@ -111,5 +115,6 @@ module Clearwater
         }
       end
     end
+    `hash_utils = #{HashUtils}`
   end
 end

data/shared/clearwater/router/route.rb

@@ -10,10 +10,12 @@ module Clearwater
         @target = options.fetch(:target)
         @parent = options.fetch(:parent)
 
-        if `#@target.type === 'Thunk' && typeof #@target.render === 'function'`
-          warn "Route '#{key}' points to a cached component. Cached " +
-               "components must not be persistent components, such as " +
-               "application roots or routing targets."
+        if RUBY_ENGINE == 'opal'
+          if `#@target.type === 'Thunk' && typeof #@target.render === 'function'`
+            warn "Route '#{key}' points to a cached component. Cached " +
+                 "components must not be persistent components, such as " +
+                 "application roots or routing targets."
+          end
         end
       end
 

data/shared/clearwater/router.rb

@@ -81,16 +81,26 @@ module Clearwater
     end
 
     def navigate_to path
+      self.class.previous_path = current_path
       history.push path
       set_outlets
       render_application
     end
 
     def self.navigate_to path
+      self.previous_path = current_path
       Bowser.window.history.push path
       render_all_apps
     end
 
+    def self.previous_path=(path)
+      @previous_path = path
+    end
+
+    def self.previous_path
+      @previous_path.to_s
+    end
+
     def navigate_to_remote path
       location.href = path
     end
@@ -99,23 +109,38 @@ module Clearwater
       history.back
     end
 
-    def set_outlets targets=targets_for_path(current_path)
-      @old_targets = @targets || []
-      @targets = targets
-      navigating_from = @old_targets - @targets
-      navigating_to = @targets - @old_targets
-
-      navigating_from.each do |target|
-        if target.respond_to? :on_route_from
-          target.on_route_from
-        end
+    def trigger_routing_callbacks(path:, previous_path:)
+      # If the paths are the same, there are no callbacks to trigger
+      return if path == previous_path
+
+      targets = targets_for_path(path)
+      old_targets = targets_for_path(previous_path)
+      routes = routes_for_path(path)
+      old_params = params(previous_path)
+      new_params = params(path)
+
+      changed_dynamic_segments = new_params
+        .select { |k, v| old_params[k] != v }
+        .map { |key, _| ":#{key}" }
+
+      changed_dynamic_targets = routes.drop_while { |route|
+        !changed_dynamic_segments.include?(route.key)
+      }.map(&:target)
+
+      navigating_from = old_targets - targets
+      navigating_to = targets - old_targets
+
+      (navigating_from | changed_dynamic_targets).each do |target|
+        target.on_route_from if target.respond_to? :on_route_from
       end
 
-      navigating_to.each do |target|
-        if target.respond_to? :on_route_to
-          target.on_route_to
-        end
+      (navigating_to | changed_dynamic_targets).each do |target|
+        target.on_route_to if target.respond_to? :on_route_to
       end
+    end
+
+    def set_outlets targets=targets_for_path(current_path)
+      trigger_routing_callbacks(path: current_path, previous_path: self.class.previous_path)
 
       if targets.any?
         (targets.count).times do |index|

data/spec/clearwater/component_spec.rb

@@ -13,6 +13,17 @@ module Clearwater
       expect(html).to eq('<div id="foo" class="bar"><p>baz</p></div>')
     end
 
+    it 'generates html for components rendering an array' do
+      component_class = Class.new do
+        include Clearwater::Component
+
+        def render
+          [ div({}, "1"), div({}, "2") ]
+        end
+      end
+      expect(component_class.new.to_s).to eq('<div>1</div><div>2</div>')
+    end
+
     it 'converts styles into strings' do
       html = component.div({
         style: {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clearwater
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -132,6 +132,7 @@ files:
 - opal/clearwater/component.rb
 - opal/clearwater/dom_reference.rb
 - opal/clearwater/link.rb
+- opal/clearwater/memoized_component.rb
 - opal/clearwater/svg_component.rb
 - opal/clearwater/virtual_dom.rb
 - opal/clearwater/virtual_dom/js/virtual_dom.js
@@ -164,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Front-end Ruby web framework for fast, reasonable, and composable applications