ruta 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a8777ca0158cf75be951622603e8213369e4d41
-  data.tar.gz: fa3f3d3ce7a1713c25c9928b1493a5a4ed1e7299
+  metadata.gz: 4ce32584f9e3d2b39f68447190c03b70940c3a12
+  data.tar.gz: 825005efef9a9c759f9ce6fc6e3a4a55bc1cfa4e
 SHA512:
-  metadata.gz: ffcd6159486425e1d7f7d827d30fc5767dab0e5a4d9a1ddb8e151f00cc2f259f503f07568d957690c8970ffaed9a97bc6f49dbc53a92dec366f55825e239214f
-  data.tar.gz: acd9e9a34d23d88e0cb44bbd525c0917ef50773d6c59e07035855d0e4bbe7817e9f4c17293ff367a4524fdf690491f4e8e50f3418c716ee3005823cce69377d6
+  metadata.gz: cdba23f5df9a660249604385b34b896cbeb121eeb4ec5843b22a50039d9cce3c97172c91aa71f71953e85cb9973770137694928f4d09f500c7a7d19ff6adc82b
+  data.tar.gz: 5ac91648139d2077b398eb2be4dc92dc61e3478fe8a1282e2547f75df7c637b59e48e918812e5fc822250edfafa536c28961baa841958877692e2dd5ecfb0f9b

data/README.md

@@ -155,7 +155,22 @@ Ruta::Context.handle_render do |component,element_id|
 end
 ```
 
-###starting the app
+###Navigating your app
+
+Navigating your app is super duper easy.
+All you have to do is this
+
+```ruby
+Ruta.navigate_to_ref(:info_view,:i_switch,value)
+```
+The first arg is the context the route you wish to navigate to is located in, the second is the
+reference of the route, lastly any params you wish to place into the route go next, they are placed into the route as they come.
+
+You would most probably use it in a 'click' callback in response to the user clicking on somthing
+
+
+
+###Starting the app
 
 The last step is to start the router and thus your app this can be accomplished by using `Ruta.start_app`;
 it's best to wrap this inside of a `$document.ready` block so that the app will only start when the dom is

data/lib/ruta.rb

@@ -1,5 +1,5 @@
-# @todo: Ensure sub-context routes are mounted into parent context routes
-# @todo: Allow empty components to be exists and ensure they are only rendered when they are not blank
+# @todo: allow contexts to be mounted to roots
+# @todo: Allow empty components to exists and ensure they are only rendered when they are not blank
 
 if RUBY_ENGINE == 'opal'
   require 'browser'
@@ -18,7 +18,7 @@ if RUBY_ENGINE == 'opal'
 
 
 
-      # used to retrive a stored url
+      # used to retrieve a stored url
       #
       # @param [Symbol] context of the stored url, if this is nil it defaults to the current context
       # @param [Symbol] reference to the route
@@ -32,7 +32,6 @@ if RUBY_ENGINE == 'opal'
       # @param [Symbol] context that route is mounted to
       # @param [Symbol] ref to a route that you wish to navigate to
       # @param [Array<String,Number,Boolean>] *params 0 or more params to replace params in the paramterized route
-      # @note you have to use this function as a proc direcly as in the example, if you place this into a callback block and call it there, you will find that the incorrect context is used for the route
       # @return [Proc] A proc that can be used as a callback block for an event
       def navigate_to_ref context, ref,*params
         route = Router.route_for(context,ref,params)
@@ -41,7 +40,7 @@ if RUBY_ENGINE == 'opal'
       end
 
       # used to start the app
-      # @example app start command placed inside of $document.ready block
+      # @example start command placed inside of $document.ready block
       #   $document.ready do
       #     Ruta.start_app
       #   end

data/lib/ruta/context.rb

@@ -28,7 +28,7 @@ module Ruta
         instance_exec &block if block
     end
 
-    # an element of the composition
+    # define a component of the composition
     #
     # @param [Symbol] id of element to mount element contents to
     # @param [{Symbol => String,Number,Boolean}] list of attributes to attach to tag
@@ -104,7 +104,7 @@ module Ruta
         @collection[ref] = new(ref,block)
       end
 
-      # used to wipe clear an elementt's content
+      # used to wipe clear an element's content
       #
       # @param [String] id of element to be cleared, if no id is provided will clear body tag of content
       def wipe id=nil

data/lib/ruta/handler.rb

@@ -22,13 +22,12 @@ module Ruta
     # wipe the matching element and render a context
     #
     # @param [Symbol] context context to be mounted to matching element of handler
-    # @todo Move these functions to execution context?
     # @return [Proc] returns a proc to be executed later
     def mount context
       handler_name = @handler_name
       proc {
         Context.wipe handler_name
-        Context.render context
+        Context.render context, handler_name
       }
     end
 
@@ -36,14 +35,14 @@ module Ruta
       # define handlers for a context
       #
       # @example
-      # Ruta::Handlers.define_for :main do
-      #  handler :header do |params,url|
-      #   some code that process the params and returns a component
-      #  end
-      #  handler :header do |params,url|
-      #   some code that process the params and returns a component
-      #  end
-      # end
+      #   Ruta::Handlers.define_for :main do
+      #    handler :header do |params,url|
+      #     some code that process the params and returns a component
+      #    end
+      #    handler :footer do |params,url|
+      #     some code that process the params and returns a component
+      #    end
+      #   end
       # @param [Symbol] context to define handlers for
       # @yield block containing handlers for a context
       def define_for context, &block

data/lib/ruta/history.rb

@@ -43,17 +43,17 @@ module Ruta
         `location.href = #{path}`
       end
 
-      # get current `thing` from locaction
+      # get current `item` from locaction
       #
-      # current things supported are:
+      # current items supported are:
       #   * query
       #   * fragment
       #   * path
       #   * url
       #   * uri
-      # @param [Symbol] thing to get the current value of from the current location
-      def current thing
-        case thing
+      # @param [Symbol] item to get the current value of from the current location
+      def current item
+        case item
         when :query
           `location.query`
         when :fragment
@@ -92,13 +92,13 @@ module Ruta
       def listen_for_on_before_load
         `window.onbeforeunload = function (evt) {
           var message = 'Are you sure you want to leave?';
-         if (typeof evt == 'undefined') {
+          if (typeof evt == 'undefined') {
            evt = window.event;
-         }
-         if (evt) {
+          }
+          if (evt) {
            evt.returnValue = message;
-         }
-         return message;
+          }
+          return message;
         }`
       end
     end

data/lib/ruta/router.rb

@@ -4,7 +4,7 @@ module Ruta
   class Router
 
 
-    # @todo: ensure sub-context routes are mounted into parent context routes
+    
 
     # @!attribute [r,w] current_context
     # @return [Array<Symbol>] current_context a list of contexts, the last being the current

data/lib/ruta/version.rb

@@ -1,3 +1,3 @@
 module Ruta
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruta
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Martin Becker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal