clearwater 0.3.1 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afbb0bbf131048da2de56cb1d537494ae700f50d
-  data.tar.gz: 7f8af1b4c90ec41c1b364694236e413eab834033
+  metadata.gz: 7209c39df1f317e2f636b5b18d19c800c051313e
+  data.tar.gz: de84c3390eb8008f4e4bad72382816c78417c15e
 SHA512:
-  metadata.gz: 1b38f6d804c0ce1f75f50f26f54fdb0d86145d2aadc3bad8fdd0dc1899bb54ef400490c56d13ee73754eb4007a011ec72599f5ac75671a3cdd7b7a9918f49d92
-  data.tar.gz: c395b5559c0fe7cf55fc21da688ecbb5e71c4553a4af70ce46b3a7677953a69ff13ffd6b2e0b5e655890aa41969d4951c84d4ca3471338b20c16a6d914ab6f8b
+  metadata.gz: 241b9c7654b51e7600ad9d2d9e77547f923035373f128ed9d4f221d21395f9a60cb38a51a398af34c5247c4bc55a1742df094b93e1a9876c7de480bc6c6c503d
+  data.tar.gz: 93657a5db3cf006c60b146ea50fea5ce8f141b6513f424c8d7cc5601d9aca430996f47005871a4b102b241a06a53f4fac75520824c79141b3d5d4d8352abfaf7

data/lib/clearwater/version.rb

@@ -1,3 +1,3 @@
 module Clearwater
-  VERSION = "0.3.1"
+  VERSION = "1.0.0.beta1"
 end

data/lib/clearwater.rb

@@ -1,5 +1,5 @@
 require "opal"
-require "opal/browser"
+require "bowser"
 
 module Clearwater
   require_relative "clearwater/version"

data/opal/clearwater/application.rb

@@ -1,7 +1,4 @@
-require 'browser'
-require 'browser/delay'
-require 'browser/event'
-require 'browser/animation_frame'
+require 'bowser'
 require 'clearwater/router'
 require 'clearwater/application_registry'
 require 'native'
@@ -20,8 +17,8 @@ module Clearwater
       @router     = options.fetch(:router)     { Router.new }
       @component  = options.fetch(:component)  { nil }
       @element    = options.fetch(:element)    { nil }
-      @document   = options.fetch(:document)   { $document }
-      @window     = options.fetch(:window)     { $window }
+      @document   = options.fetch(:document)   { Bowser.document }
+      @window     = options.fetch(:window)     { Bowser.window }
       @on_render  = []
 
       router.application = self
@@ -64,7 +61,7 @@ module Clearwater
         return
       end
 
-      animation_frame { perform_render }
+      @window.animation_frame { perform_render }
 
       nil
     end

data/opal/clearwater/black_box_node.rb

@@ -0,0 +1,67 @@
+require 'bowser/element'
+require 'clearwater/virtual_dom'
+
+module Clearwater
+  module BlackBoxNode
+    def node
+      VirtualDOM.node :div
+    end
+
+    def mount node
+    end
+
+    def update previous, node
+    end
+
+    def unmount node
+    end
+
+    def render
+      Renderable.new(self)
+    end
+
+    class Renderable
+      def initialize delegate
+        @delegate = delegate
+      end
+
+      def wrap node
+        Bowser::Element.new(node)
+      end
+
+      def create_element
+        wrap(VirtualDOM.create_element(@delegate.node))
+      end
+
+      %x{
+        // Use the virtual-dom Widget type
+        Opal.defn(self, 'type', 'Widget');
+
+        // virtual-dom Widget init hook. Must return a real DOM node.
+        // We call the Ruby-land #mount method so we can define hooks for this
+        // in Ruby instead of requiring users to drop down to JS.
+        Opal.defn(self, 'init', function() {
+          var self = this;
+          var node = #{create_element};
+          #{@delegate.mount(`node`)};
+          return node.native;
+        });
+
+        // virtual-dom update hook
+        //   previous: the instance of this object used in the previous render
+        //   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`))};
+        });
+
+        // virtual-dom destroy hook
+        //   node: Bowser-wrapped version of the DOM node
+        Opal.defn(self, 'destroy', function(node) {
+          var self = this;
+          #{@delegate.unmount(wrap(`node`))};
+        });
+      }
+    end
+  end
+end

data/opal/clearwater/component.rb

@@ -1,13 +1,9 @@
 require 'clearwater/virtual_dom'
-require 'browser'
 
 module Clearwater
   module Component
     attr_accessor :router, :outlet
 
-    def render
-    end
-
     HTML_TAGS = %w(
       a
       abbr
@@ -122,27 +118,8 @@ module Clearwater
       wbr
     )
 
-    HTML_TAGS.each do |tag_name|
-      define_method(tag_name) do |attributes, content|
-        tag(tag_name, attributes, content)
-      end
-    end
-
-    def tag tag_name, attributes=nil, content=nil
-      if !(`attributes.$$is_hash || attributes === #{nil}`)
-        content = attributes
-        attributes = nil
-      end
-
-      VirtualDOM.node(
-        tag_name,
-        Component.sanitize_attributes(attributes),
-        Component.sanitize_content(content)
-      )
-    end
-
     def params
-      router.params_for_path(router.current_path)
+      router.params
     end
 
     def self.sanitize_attributes attributes
@@ -162,7 +139,7 @@ module Clearwater
       attributes.each do |key, handler|
         if key[0, 2] == 'on'
           attributes[key] = proc do |event|
-            handler.call(Browser::Event.new(event))
+            handler.call(Bowser::Event.new(event))
           end
         end
       end
@@ -192,6 +169,31 @@ module Clearwater
       }
     end
 
+    # Default render method for stubbing
+    def render
+    end
+
+    module_function
+
+    HTML_TAGS.each do |tag_name|
+      define_method(tag_name) do |attributes, content|
+        tag(tag_name, attributes, content)
+      end
+    end
+
+    def tag tag_name, attributes=nil, content=nil
+      if !(`attributes.$$is_hash || attributes === #{nil}`)
+        content = attributes
+        attributes = nil
+      end
+
+      VirtualDOM.node(
+        tag_name,
+        Component.sanitize_attributes(attributes),
+        Component.sanitize_content(content)
+      )
+    end
+
     def call &block
       Clearwater::Application::AppRegistry.render_all(&block)
     end

data/opal/clearwater/dom_reference.rb

@@ -0,0 +1,30 @@
+module Clearwater
+  class DOMReference
+    def mount node, previous
+      @node = node
+    end
+
+    def unmount node, previous
+    end
+
+    def method_missing *args, &block
+      @node.public_send *args, &block
+    end
+
+    def wrap node
+      Bowser::Element.new(node)
+    end
+
+    %x{
+      Opal.defn(self, 'hook', function(node, name, previous) {
+        var self = this;
+        #{mount(wrap(`node`), `previous`)};
+      });
+
+      Opal.defn(self, 'unhook', function(node, name, previous) {
+        var self = this;
+        #{unmount(wrap(`node`), `previous`)};
+      });
+    }
+  end
+end

data/opal/clearwater/link.rb

@@ -1,22 +1,5 @@
 require 'clearwater/component'
-require 'browser'
-require 'browser/history'
-
-# TODO: Remove this once opal-browser supports coordinates natively
-# for touch events.
-module Browser
-  class Event
-    class Touch
-      def x
-        `#@native.pageX`
-      end
-
-      def y
-        `#@native.pageY`
-      end
-    end
-  end
-end
+require 'bowser'
 
 class Link
   include Clearwater::Component
@@ -56,6 +39,8 @@ class Link
   end
 
   def handle_touch event
+    document = Bowser.document
+
     # All links will treat this as touch because this is a touch device
     @@touch = true
     moved = false
@@ -78,24 +63,32 @@ class Link
         navigate event
       end
 
-      $document.off 'touchmove', &touch_move_handler
-      $document.off 'touchend', &touch_end_handler
+      document.off 'touchmove', &touch_move_handler
+      document.off 'touchend', &touch_end_handler
     end
 
-    $document.on 'touchmove', &touch_move_handler
-    $document.on 'touchend', &touch_end_handler
+    document.on 'touchmove', &touch_move_handler
+    document.on 'touchend', &touch_end_handler
   end
 
   def navigate event
     # Don't handle middle-button clicks and clicks with modifier keys. Let them
     # pass through to the browser's default handling or the user's modified handling.
-    unless event.meta? || event.shift? || event.ctrl? || event.alt? || (event.respond_to?(:button) && event.button == 1)
-      event.prevent
-      if href != $window.location.path
-        $window.history.push href
-        call
-        $window.scroll.to x: 0, y: 0
-      end
+    modified = (
+      event.meta? ||
+      event.shift? ||
+      event.ctrl? ||
+      event.alt? ||
+      event.button == 1
+    )
+
+    return if modified
+
+    event.prevent
+    window = Bowser.window
+    if href != window.location.path
+      Clearwater::Router.navigate_to href
+      window.scroll 0, 0
     end
   end
 
@@ -112,7 +105,7 @@ class Link
   end
 
   def check_active href
-    if $window.location.path == href
+    if Bowser.window.location.path == href
       class_name = (
         @attributes.delete(:class_name) ||
         @attributes.delete(:class) ||

data/opal/clearwater/router.rb

@@ -6,9 +6,9 @@ module Clearwater
     attr_accessor :application
 
     def initialize options={}, &block
-      @window   = options.fetch(:window)   { Native(`window`)  }
-      @location = options.fetch(:location) { window[:location] }
-      @history  = options.fetch(:history)  { window[:history]  }
+      @window   = options.fetch(:window)   { Bowser.window  }
+      @location = options.fetch(:location) { window.location }
+      @history  = options.fetch(:history)  { window.history }
       @routes   = RouteCollection.new(self)
       @application = options[:application]
 
@@ -32,17 +32,17 @@ module Clearwater
       routes_for_path(path).map(&:target)
     end
 
-    def params_for_path path
+    def params path=current_path
       path_parts = path.split("/").reject(&:empty?)
       canonical_parts = canonical_path_for_path(path).split("/").reject(&:empty?)
 
       canonical_parts.each_with_index.reduce({}) { |params, (part, index)|
         if part.start_with? ":"
           param = part[1..-1]
-          params.merge! param => path_parts[index]
-        else
-          params
+          params[param] = path_parts[index]
         end
+
+        params
       }
     end
 
@@ -50,21 +50,38 @@ module Clearwater
     end
 
     def current_path
-      location[:pathname]
+      location.path
+    end
+
+    def self.current_path
+      location.path
+    end
+
+    def current_url
+      location.href
+    end
+
+    def self.current_url
+      location.href
+    end
+
+    def self.location
+      Bowser.window.location
     end
 
     def navigate_to path
-      push_state path
+      history.push path
       set_outlets
       render_application
     end
 
-    def navigate_to_remote path
-      location[:href] = path
+    def self.navigate_to path
+      Bowser.window.history.push path
+      render_all_apps
     end
 
-    def current_url
-      location[:href]
+    def navigate_to_remote path
+      location.href = path
     end
 
     def back
@@ -85,14 +102,14 @@ module Clearwater
 
     private
 
-    def push_state path
-      history.pushState({}, nil, path)
-    end
-
     def render_application
       if application && application.component
         application.component.call
       end
     end
+
+    def self.render_all_apps
+      Clearwater::Application.render
+    end
   end
 end

data/opal/clearwater/virtual_dom.rb

@@ -1,4 +1,3 @@
-require 'browser'
 require 'clearwater/virtual_dom/js/virtual_dom.js'
 
 module VirtualDOM
@@ -40,7 +39,7 @@ module VirtualDOM
   end
 
   class Document
-    def initialize(root=$document.create_element('div'))
+    def initialize(root=Bowser.document.create_element('div'))
       @root = root
     end
 

data/opal/clearwater.rb

@@ -1,4 +1,3 @@
-require 'browser'
 require 'clearwater/component'
 require 'clearwater/svg_component'
 require 'clearwater/cached_render'

data/spec/clearwater/application_spec.rb

@@ -1,5 +1,6 @@
 require 'clearwater'
 require 'clearwater/svg_component'
+require 'bowser'
 
 module Clearwater
   RSpec.describe Application do
@@ -33,7 +34,7 @@ module Clearwater
         end
       end.new
     }
-    let(:element) { $document.create_element('div') }
+    let(:element) { Bowser.document.create_element('div') }
 
     it 'renders to the specified element' do
       app.perform_render

data/spec/clearwater/black_box_node_spec.rb

@@ -0,0 +1,64 @@
+require 'clearwater/black_box_node'
+
+module Clearwater
+  describe BlackBoxNode do
+    let(:object) {
+      Class.new do
+        include Clearwater::BlackBoxNode
+
+        attr_reader :last_update
+
+        def node
+          VirtualDOM.node :span, { id: 'foo' }, ['hi']
+        end
+
+        def mount node
+          @mounted = true
+        end
+
+        def update
+          @last_update = Time.now
+        end
+
+        def unmount
+          @mounted = false
+        end
+
+        def mounted?
+          !!@mounted
+        end
+      end.new
+    }
+    let(:renderable) { BlackBoxNode::Renderable.new(object) }
+
+    it 'has the special type of "Widget"' do
+      r = renderable
+      expect(`r.type`).to eq 'Widget'
+    end
+
+    it 'uses the delegate node to render into the DOM' do
+      r = renderable
+      expect(`#{renderable.create_element}.native.outerHTML`).to eq '<span id="foo">hi</span>'
+    end
+
+    it 'calls mount when inserted into the DOM' do
+      r = renderable
+      `r.init()`
+      expect(object).to be_mounted
+    end
+
+    it 'calls unmount when removed from the DOM' do
+      r = renderable
+      `r.init()`
+      `r.destroy()`
+      expect(object).not_to be_mounted
+    end
+
+    it 'calls update when updated in the DOM' do
+      r = renderable
+      `r.update({})`
+
+      expect(object.last_update).not_to be_nil
+    end
+  end
+end

data/spec/clearwater/dom_reference_spec.rb

@@ -0,0 +1,15 @@
+require 'clearwater/dom_reference'
+
+module Clearwater
+  describe DOMReference do
+    let(:ref) { DOMReference.new }
+
+    it 'delegates to the DOM node passed in on mount' do
+      r = ref
+
+      `r.hook({ value: 'hi' })`
+
+      expect(r.value).to eq 'hi'
+    end
+  end
+end

data/spec/clearwater/router_spec.rb

@@ -1,4 +1,5 @@
 require 'clearwater/router'
+require 'ostruct'
 
 module Clearwater
   RSpec.describe Router do
@@ -22,7 +23,7 @@ module Clearwater
     end
 
     it 'gets the params for a given path' do
-      expect(router.params_for_path('/articles/foo')).to eq article_id: 'foo'
+      expect(router.params('/articles/foo')).to eq article_id: 'foo'
     end
 
     it 'gets the components for a given path' do
@@ -34,18 +35,18 @@ module Clearwater
     end
 
     it 'gets the current path' do
-      location = { pathname: '/foo' }
+      location = OpenStruct.new(path: '/foo')
       router = Router.new(location: location)
 
       expect(router.current_path).to eq '/foo'
 
-      location[:pathname] = '/bar'
+      location.path = '/bar'
 
       expect(router.current_path).to eq '/bar'
     end
 
     it 'gets the params from the path' do
-      expect(router.params_for_path('/articles/123')).to eq({ article_id: '123' })
+      expect(router.params('/articles/123')).to eq({ article_id: '123' })
     end
   end
 end

data/spec/component_spec.rb

@@ -1,15 +1,5 @@
 require 'clearwater/component'
 
-# When running specs from the CLI, it doesn't define this class
-unless defined? Browser::Event
-  module Browser
-    class Event
-      def initialize event
-      end
-    end
-  end
-end
-
 module Clearwater
   RSpec.describe Component do
     let(:component_class) {
@@ -32,13 +22,13 @@ module Clearwater
     it 'sanitizes element attributes' do
       attributes = Component.sanitize_attributes({
         class: 'foo',
-        onclick: proc { |event| expect(event).to be_a Browser::Event },
+        onclick: proc { |event| expect(event).to be_a Bowser::Event },
       })
 
       # Renames :class to :class_name
       expect(attributes[:class_name]).to eq 'foo'
 
-      # Wraps yielded events in a Browser::Event
+      # Wraps yielded events in a Bowser::Event
       attributes[:onclick].call(`document.createEvent('MouseEvent')`)
     end
 
@@ -57,7 +47,7 @@ module Clearwater
     it 'retrieves params from the router' do
       router = double('Router')
       params = { article_id: 123 }
-      allow(router).to receive(:params_for_path) { params }
+      allow(router).to receive(:params) { params }
       allow(router).to receive(:current_path) { '/articles/123' }
       component.router = router
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: clearwater
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: opal-browser
+  name: bowser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: opal-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0.beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0.beta2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Front-end web framework built on Opal
@@ -101,22 +101,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/clearwater.rb
 - lib/clearwater/version.rb
-- opal/clearwater.rb
+- lib/clearwater.rb
 - opal/clearwater/application.rb
 - opal/clearwater/application_registry.rb
+- opal/clearwater/black_box_node.rb
 - opal/clearwater/cached_render.rb
 - opal/clearwater/component.rb
+- opal/clearwater/dom_reference.rb
 - opal/clearwater/link.rb
-- opal/clearwater/router.rb
 - opal/clearwater/router/route.rb
 - opal/clearwater/router/route_collection.rb
+- opal/clearwater/router.rb
 - opal/clearwater/svg_component.rb
-- opal/clearwater/virtual_dom.rb
 - opal/clearwater/virtual_dom/js/virtual_dom.js
+- opal/clearwater/virtual_dom.rb
+- opal/clearwater.rb
 - spec/clearwater/application_spec.rb
+- spec/clearwater/black_box_node_spec.rb
 - spec/clearwater/cached_render_spec.rb
+- spec/clearwater/dom_reference_spec.rb
 - spec/clearwater/router_spec.rb
 - spec/component_spec.rb
 homepage: https://clearwater-rb.github.io/
@@ -129,22 +133,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Front-end web framework built on Opal
 test_files:
 - spec/clearwater/application_spec.rb
+- spec/clearwater/black_box_node_spec.rb
 - spec/clearwater/cached_render_spec.rb
+- spec/clearwater/dom_reference_spec.rb
 - spec/clearwater/router_spec.rb
 - spec/component_spec.rb