volt 0.9.4.pre3 → 0.9.4.pre5

data/lib/volt/utils/promise_extensions.rb

@@ -3,7 +3,7 @@ require 'volt/utils/promise'
 
 # A temp patch for promises until https://github.com/opal/opal/pull/725 is released.
 class Promise
-
+  class UnrealizedPromiseException < RuntimeError ; end
   # We made a choice not to support comparitors and << and >> on method_missing
   # on Promises.  This makes it easier to understand what promise proxying does
   # and how it works.  It also prevents confusing situations where you try to
@@ -83,12 +83,25 @@ class Promise
     self.then {|v| v.to_json(*args, &block) }
   end
 
+  # unwrap lets you return a value or raise an exceptoin on a realized promise.
+  # An exception will be raised if the promise is not realized yet.
+  def unwrap
+    if realized?
+      if resolved?
+        value
+      else
+        Object.send(:fail, error)
+      end
+    else
+      raise UnrealizedPromiseException, "#unwrap called on a promise that has yet to be realized."
+    end
+  end
 
-
-  # Waits for the promise to resolve (assuming it is blocking on
-  # the server) and returns the result.
+  # Waits for the promise to be realized (resolved or rejected), then returns
+  # the resolved value or raises the rejection error.  .sync only works on
+  # the server (not in opal), and will raise a warning if on the client.
   def sync
-    raise ".sync can only be used on the client" if Volt.client?
+    raise ".sync can only be used on the server" if Volt.client?
 
     result = nil
     error = nil
@@ -103,7 +116,10 @@ class Promise
       err_str = "Exception in Promise at .sync: #{error.inspect}"
       err_str += error.backtrace.join("\n") if error.respond_to?(:backtrace)
       Volt.logger.error(err_str)
-      fail error
+
+      # The fail method in Promise is already defined, to re-raise the error,
+      # we send fail
+      Object.send(:fail, error)
     else
       return result
     end

data/lib/volt/utils/time_patch.rb

@@ -0,0 +1,12 @@
+# Patchs a bug in the Time class, where two instances of time with the same
+# value do not hash to the same hash as they do in MRI.
+# https://github.com/opal/opal/issues/963
+if RUBY_PLATFORM == 'opal'
+  require 'time'
+
+  class Time
+    def hash
+      "Time:#{to_i}"
+    end
+  end
+end

data/lib/volt/utils/timers.rb

@@ -16,16 +16,28 @@ module Volt
 
     # yields the passed in block after interval ms, or immediately if on the
     # server.
+    #
+    # @return - the timeout id generated by setTimeout
     def self.client_set_timeout(interval)
       if Volt.in_browser?
-        `setTimeout(function() {`
+        timer_id = nil
+        `timer_id = setTimeout(function() {`
           yield
-        `}, interval)`
+        `}, interval);`
+
+        # return the timer_id
+        timer_id
       else
         yield
       end
     end
 
+    def self.clear_timeout(timeout_id)
+      if Volt.in_browser?
+        `clearTimeout(timeout_id);`
+      end
+    end
+
     # On the server, we need to manually flush next tick timers.
     # This is done automatically in the console after each enter.
     def self.flush_next_tick_timers!

data/lib/volt/version.rb

@@ -1,5 +1,5 @@
 module Volt
   module Version
-    STRING = '0.9.4.pre3'
+    STRING = '0.9.4.pre5'
   end
 end

data/lib/volt/volt/app.rb

@@ -23,22 +23,27 @@ require 'volt/models/url'
 require 'volt/page/url_tracker'
 require 'volt/benchmark/benchmark'
 require 'volt/page/tasks'
-require 'volt/page/page'
+require 'volt/volt/repos'
+require 'volt/volt/templates'
 
-unless RUBY_PLATFORM == 'opal'
+if RUBY_PLATFORM == 'opal'
+  require 'volt/volt/client_setup/browser'
+else
   require 'volt/volt/server_setup/app'
 end
 
 module Volt
   class App
+    include Volt::Repos
+
     if RUBY_PLATFORM != 'opal'
       # Include server app setup
       include Volt::ServerSetup::App
     end
 
-    attr_reader :component_paths, :router, :page, :live_query_pool,
+    attr_reader :component_paths, :router, :live_query_pool,
                 :channel_live_queries, :app_path, :database, :message_bus,
-                :middleware
+                :middleware, :browser
     attr_accessor :sprockets
 
     def initialize(app_path=nil)
@@ -52,7 +57,9 @@ module Volt
       # Setup root path
       Volt.root = app_path
 
-      setup_page
+      if RUBY_PLATFORM == 'opal'
+        setup_browser
+      end
 
       if RUBY_PLATFORM != 'opal'
         # We need to run the root config first so we can setup the Rack::Session
@@ -86,14 +93,39 @@ module Volt
       end
     end
 
+    def templates
+      @templates ||= Templates.new
+    end
 
-    # Setup a Page instance.
-    def setup_page
-      # Run the app config to load all users config files
-      @page = Page.new(self)
+    # Called on the client side to add routes
+    def add_routes(&block)
+      @router ||= Routes.new
+      @router.define(&block)
+      url.router = @router
+    end
+
+    # Callled on the client to add store compiled templates
+    def add_template(*args)
+      templates.add_template(*args)
+    end
+
+    def tasks
+      @tasks ||= Tasks.new(self)
+    end
+
+    def channel
+      @channel ||= begin
+        if Volt.client?
+          Channel.new
+        else
+          ChannelStub.new
+        end
+      end
+    end
 
-      # Setup a global for now
-      $page = @page unless defined?($page)
+    # Setup a Page instance.
+    def setup_browser
+      @browser = Browser.new(self)
     end
   end
 end
@@ -102,6 +134,6 @@ if Volt.client?
   $volt_app = Volt::App.new
 
   `$(document).ready(function() {`
-    $volt_app.page.start
+    $volt_app.browser.start
   `});`
 end

data/lib/volt/volt/client_setup/browser.rb

@@ -0,0 +1,113 @@
+require 'volt/utils/ejson'
+
+module Volt
+  class Browser
+    attr_reader :events
+
+    def initialize(volt_app)
+      @volt_app = volt_app
+      # Run the code to setup the page
+
+      @url_tracker = UrlTracker.new(@volt_app)
+
+      @events = DocumentEvents.new
+
+      # Initialize tasks so we can get the reload message
+      @volt_app.tasks if Volt.env.development?
+
+      if RUBY_PLATFORM == 'opal'
+        if Volt.in_browser?
+          # Setup click handler for links
+          `
+            $(document).on('click', 'a', function(event) {
+              var browser = #{Volt.current_app.browser};
+              return browser.$link_clicked($(this).attr('href'), event);
+            });
+          `
+        end
+      end
+
+      if Volt.in_browser?
+        @volt_app.channel.on('reconnected') do
+          @volt_app.page._reconnected = true
+
+          `setTimeout(function() {`
+            @volt_app._reconnected = false
+          `}, 2000);`
+        end
+      end
+    end
+
+    def link_clicked(url = '', event = nil)
+      # Skip when href == ''
+      return false if url.blank?
+
+      # Normalize url
+      if @volt_app.url.parse(url)
+        if event
+          # Handled new url
+          `event.stopPropagation();`
+        end
+
+        # Clear the flash
+        @volt_app.flash.clear
+
+        # return false to stop the event propigation
+        return false
+      end
+
+      # Not stopping, process link normally
+      true
+    end
+
+    # We provide a binding_name, so we can bind events on the document
+    def binding_name
+      'page'
+    end
+
+    def start
+      # Setup to render template
+      `$('body').html('<!-- $CONTENT --><!-- $/CONTENT -->');`
+
+      load_stored_page
+
+      # Do the initial url params parse
+      @url_tracker.url_updated(true)
+
+      main_controller = Main::MainController.new(@volt_app)
+
+      # Setup main page template
+      TemplateRenderer.new(@volt_app, DomTarget.new, main_controller, 'CONTENT', 'main/main/main/body')
+
+      # Setup title reactive template
+      @title_template = StringTemplateRenderer.new(@volt_app, main_controller, 'main/main/main/title')
+
+      # Watch for changes to the title template
+      proc do
+        title = @title_template.html.gsub(/\n/, ' ')
+        `document.title = title;`
+      end.watch!
+    end
+
+    # When the page is reloaded from the backend, we store the page collection,
+    # so we can reload the page in the exact same state.  Speeds up development.
+    def load_stored_page
+      if Volt.client?
+        if `sessionStorage`
+          page_obj_str = nil
+
+          `page_obj_str = sessionStorage.getItem('___page');`
+          `if (page_obj_str) {`
+          `sessionStorage.removeItem('___page');`
+
+          EJSON.parse(page_obj_str).each_pair do |key, value|
+            page.send(:"_#{key}=", value)
+          end
+          `}`
+        end
+      end
+    rescue => e
+      Volt.logger.error("Unable to restore: #{e.inspect}")
+    end
+  end
+end

data/lib/volt/volt/repos.rb

@@ -0,0 +1,48 @@
+# The Volt::Repos module provides access to each root collection (repo).
+
+module Volt
+  module Repos
+    def url
+      @url ||= URL.new
+    end
+
+    def params
+      @params ||= @url.params
+    end
+
+    def page
+      @page ||= PageRoot.new
+    end
+
+    def store
+      @store ||= StoreRoot.new({}, persistor: Persistors::StoreFactory.new(tasks))
+    end
+
+    def flash
+      @flash ||= begin
+        check_for_client?('flash')
+        FlashRoot.new({}, persistor: Persistors::Flash)
+      end
+    end
+
+    def local_store
+      @local_store ||= begin
+        check_for_client?('local_store')
+        LocalStoreRoot.new({}, persistor: Persistors::LocalStore)
+      end
+    end
+
+    def cookies
+      @cookies ||= begin
+        check_for_client?('cookies')
+        CookiesRoot.new({}, persistor: Persistors::Cookies)
+      end
+    end
+
+    def check_for_client?(repo_name)
+      unless Volt.client?
+        fail "The #{repo_name} collection can only be accessed from the client side currently"
+      end
+    end
+  end
+end

data/lib/volt/volt/server_setup/app.rb

@@ -13,7 +13,7 @@ module Volt
       def setup_paths
         # Load component paths
         @component_paths = ComponentPaths.new(@app_path)
-        @component_paths.require_in_components(@page || $page)
+        @component_paths.require_in_components(self)
       end
 
       def load_app_code
@@ -25,7 +25,6 @@ module Volt
         @router = Routes.new
       end
 
-
       def setup_preboot_middleware
         @middleware = MiddlewareStack.new
         DefaultMiddlewareStack.preboot_setup(self, @middleware)

data/lib/volt/volt/templates.rb

@@ -0,0 +1,39 @@
+# The Templates class holds all loaded templates.
+module Volt
+  class Templates
+    # On the server, we can delay loading the views until they are actually requeted.  This
+    # sets up an instance variable to call to load.
+    attr_writer :template_loader
+
+    def initialize
+      @templates = {}
+    end
+
+    def [](key)
+      templates[key]
+    end
+
+    def add_template(name, template, bindings)
+      # First template gets priority.  The backend will load templates in order so
+      # that local templates come in before gems (so they can be overridden).
+      #
+      # TODO: Currently this means we will send templates to the client that will
+      # not get used because they are being overridden.  Need to detect that and
+      # not send them.
+      unless @templates[name]
+        @templates[name] = { 'html' => template, 'bindings' => bindings }
+      end
+    end
+
+    # Load the templates on first use if a loader was specified
+    def templates
+      if @template_loader
+        # Load the templates
+        @template_loader.call
+        @template_loader = nil
+      end
+
+      @templates
+    end
+  end
+end

data/lib/volt/volt/users.rb

@@ -85,7 +85,7 @@ module Volt
     def current_user
       user_id = current_user_id
       if user_id
-        $page.store._users.where(id: user_id).first
+        Volt.current_app.store._users.where(id: user_id).first
       else
         Promise.new.resolve(nil)
       end
@@ -106,7 +106,7 @@ module Volt
     def login(username, password)
       UserTasks.login(login: username, password: password).then do |result|
         # Assign the user_id cookie for the user
-        $page.cookies._user_id = result
+        Volt.current_app.cookies._user_id = result
 
         # Pass nil back
         nil
@@ -114,14 +114,14 @@ module Volt
     end
 
     def logout
-      $page.cookies.delete(:user_id)
+      Volt.current_app.cookies.delete(:user_id)
     end
 
     # Fetches the user_id+signature from the correct spot depending on client
     # or server, does not verify it.
     def user_id_signature
       if Volt.client?
-        user_id_signature = $page.cookies._user_id
+        user_id_signature = Volt.current_app.cookies._user_id
       else
         # Check meta for the user id and validate it
         meta_data = Thread.current['meta']

data/lib/volt.rb

@@ -6,6 +6,7 @@ require 'volt/utils/modes'
 require 'volt/utils/volt_user_error'
 require 'volt/utils/boolean_patch'
 require 'volt/utils/set_patch'
+require 'volt/utils/time_patch'
 
 require 'volt/config'
 require 'volt/data_stores/data_store' unless RUBY_PLATFORM == 'opal'

data/spec/apps/file_loading/app/disable_auto/config/dependencies.rb

@@ -0,0 +1,3 @@
+disable_auto_import
+javascript_file '/assets/disable_auto/assets/js/test1.js'
+css_file 'test1'

data/spec/apps/file_loading/app/shared/config/dependencies.rb

@@ -1 +1 @@
-component 'bootstrap'
+component 'bootstrap'

data/spec/controllers/model_controller_spec.rb

@@ -27,5 +27,12 @@ if RUBY_PLATFORM != 'opal'
       promise.resolve(Volt::Model.new)
       expect(controller.loaded?).to eq(true)
     end
+
+    it 'should provide a u method that disables reactive updates' do
+      expect(Volt::Computation).to receive(:run_without_tracking)
+
+      controller = Volt::ModelController.new(volt_app)
+      controller.u { 5 }
+    end
   end
 end

data/spec/models/{model_helpers/model_helpers_spec.rb → helpers/base_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Volt::ModelHelpers do
+describe Volt::Models::Helpers::Base do
   # it 'should have a root method on models that returns the root collection' do
   #   model = store._posts.create
   #   expect(model.root).to eq(store)

data/spec/models/helpers/model_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Volt::Models::Helpers::Model do
+  describe "saved_state" do
+    it 'should start not_saved for a buffer' do
+      item = the_page._items.buffer
+      expect(item.saved_state).to eq(:not_saved)
+    end
+
+    it 'should move to saved when the buffer is saved' do
+      item = the_page._items.buffer
+      item.save!.then do
+        expect(item.saved_state).to eq(:saved)
+      end
+    end
+
+    it 'should start as saved after create' do
+      item = the_page._items.create({name: 'One'})
+
+      expect(item.saved_state).to eq(:saved)
+    end
+
+    # TODO: because server side model loading is done synchronusly, we can't
+    # test the
+  end
+end

data/spec/models/model_spec.rb

@@ -6,6 +6,9 @@ end
 class Item < Volt::Model
 end
 
+class Items < Volt::ArrayModel
+end
+
 class TestAssignsMethod < Volt::Model
   def name=(val)
     self._name = val
@@ -603,4 +606,10 @@ describe Volt::Model do
       expect(array_model.to_json).to eq(array_model.to_a.to_json)
     end
   end
+
+  it 'creates sub-arrays with correct classes' do
+    model = Volt::Model.new
+    model._items << {}
+    expect(model._items).to be_instance_of Items
+  end
 end

data/spec/models/persistors/params_spec.rb

@@ -8,7 +8,7 @@ describe Volt::Persistors::Params do
     #
     # expect(a._test!._cool!.persistor.class).to eq(Volt::Persistors::Params)
 
-    a._items! << { name: 'Test' }
+    a._items << { name: 'Test' }
     #
     # expect(a._items.persistor.class).to eq(Volt::Persistors::Params)
     # expect(a._items[0].persistor.class).to eq(Volt::Persistors::Params)

data/spec/models/persistors/store_spec.rb

@@ -20,6 +20,7 @@ describe Volt::Persistors::Store do
     persistor_instance = double('volt/persistor instance')
     expect(persistor_instance).to receive(:loaded)
     expect(persistor).to receive(:new).and_return(persistor_instance)
+    expect(persistor_instance).to receive(:async?).and_return(false)
 
     @model = Volt::ArrayModel.new([1, 2, 3], persistor: persistor)
 

data/spec/page/bindings/content_binding_spec.rb

@@ -24,11 +24,9 @@ describe Volt::ContentBinding do
       }
     }
 
-    page = double('volt/page')
-    expect(page).to receive(:templates).and_return(templates)
-
     volt_app = double('volt/app')
-    expect(volt_app).to receive(:page).and_return(page)
+    expect(volt_app).to receive(:templates).and_return(templates)
+
 
 
     dom = Volt::AttributeTarget.new(0)

data/spec/page/bindings/each_binding_spec.rb

@@ -42,11 +42,8 @@ describe Volt::EachBinding do
       }
     }
 
-    page = double('volt/page')
-    expect(page).to receive(:templates).and_return(templates).at_least(1).times
-
     volt_app = double('volt/app')
-    expect(volt_app).to receive(:page).and_return(page).at_least(1).times
+    expect(volt_app).to receive(:templates).and_return(templates).at_least(1).times
 
     Volt::TemplateRenderer.new(volt_app, dom, context, 'main', 'main/main')
 

data/spec/page/bindings/if_binding_spec.rb

@@ -40,11 +40,8 @@ describe Volt::IfBinding do
       }
     }
 
-    page = double('volt/page')
-    expect(page).to receive(:templates).and_return(templates).at_least(1).times
-
     volt_app = double('volt/app')
-    expect(volt_app).to receive(:page).and_return(page).at_least(1).times
+    expect(volt_app).to receive(:templates).and_return(templates).at_least(1).times
 
     Volt::TemplateRenderer.new(volt_app, dom, context, 'main', 'main/main')