ruta 1.0.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713338f9d71694f60b3d07c4dde867f4cd5424eb
-  data.tar.gz: accb5345eac50bb53720905eaaa2beb26f9115a9
+  metadata.gz: c031c5e2a865625d021d0f25c9bfb080bcb5355b
+  data.tar.gz: fa54e3be8f2f33388d2b21bb15f636872860b34d
 SHA512:
-  metadata.gz: 30eda8ca028915a8c03b9cd68f6e7db38195fd08010d732651065c0c607be06d7327e5011542db6aa11376e56526d74f2a325ae9896f081da2245298c290f8ad
-  data.tar.gz: e855f91c7cd7e88d16b3de849d2e8b39f04f55ab3f05aa193b09aee02d9f45706061cd28d8fc88d20899e61c7c22354bc017251d4c4b80ffa60fa445313e9a46
+  metadata.gz: 31a11420d5e281cc6a9d067625a4038d1e847067e7ad722157281fc6b45574e8e8a267879d36642da0c8ebb530412f130f7146395ef844f3e6731894b89f95b1
+  data.tar.gz: 453a1427861d14731546a0a86ec41173fc335f636bb4d3d5791e608eec0bd049c8f2f2198c7a72582b205dea763e4d50440b9081e718b689bc66af5054ef5189

data/README.md

@@ -1,5 +1,13 @@
 # Ruta
 
+##TODO
+### Patch
+
+
+### Minor
+
+### Major
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,6 +26,24 @@ Or install it yourself as:
 
 ## Usage
 
+##config settings
+
+To configure Ruta's settings you can use a config block
+
+Here's a config block with Ruta's default settings
+```ruby
+Ruta.configure do |config|
+  config.context_prefix = false
+end
+```
+
+The following settings have the following effects:
+1. `context_prefix`
+  This setting turns on context prefixing, whenever you navigate to a route
+  the context it's located in is pre-fixed to the front of it, navigating to
+  a context with this turned on will set the url to being just the context name
+
+
 Making use of this router is pretty simple.
 
 ###Contexts
@@ -76,15 +102,23 @@ end
 Next you should define some handlers, not every component needs a handler but every component has one
 needs to match names with a corresponding handler.
 
-you use the `handle` method to define a handler and you pass into it the name of the element you want this
+you use the `handle` macro to define a handler and you pass into it the name of the element you want this
 handler to drive.
 
+You can also however render a sub-context instead of a component, just use:
+
+```ruby
+handle :component do |params,url|
+  mount :sub_context
+end
+```
+
 The handler has two variables passed to it:
 
 1. `params` a hash containing the named params of the route
 2. `url` a string containing the url of the route being passed to the handler
 
-The handler must return a renderable component.
+The handler must return a renderable component or mount a sub-context.
 
 ```ruby
 Ruta::Handlers.define_for :main do
@@ -106,6 +140,9 @@ Ruta::Handlers.define_for :sign_up do
 end
 ```
 
+You can use `default` inside of a handler to render the component in the default state
+as it is defined in the context.
+
 ###Routes
 
 The last thing to define before your app is ready is the routes that will activate the correct handlers to
@@ -138,9 +175,9 @@ end
 
 ###Renderer
 
-The last step is to tell the router how to render your components.
+The penultimate step is to tell the router how to render your components.
 
-You do this using `Ruta::Context.handle_render` and then creating a macro.
+You do this using `Ruta::Context.handle_render` and then define the render macro.
 Passed into the macro is the `component` you wish to render and the `element_id` of the components mounting
 point.
 
@@ -163,7 +200,7 @@ 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
+The first arg is the context of 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

data/lib/ruta/context.rb

@@ -25,7 +25,7 @@ module Ruta
         @handlers = {}
         @routes = {}
         @sub_contexts = []
-        instance_exec &block if block
+        instance_exec(&block) if block
     end
 
     # define a component of the composition

data/lib/ruta/handler.rb

@@ -16,13 +16,12 @@ module Ruta
     # @see #Handlers#define_for
     def initialize context,block
       @context = context
-      instance_exec &block
+      instance_exec(&block)
     end
 
     # wipe the matching element and render a context
     #
     # @param [Symbol] context context to be mounted to matching element of handler
-    # @return [Proc] returns a proc to be executed later
     def mount context
       handler_name = @handler_name
       proc {
@@ -31,6 +30,21 @@ module Ruta
       }
     end
 
+    # Render the default content for this component as it is defined in the context.
+    #
+    def default
+      handler_name = @handler_name
+      proc {
+        comp = @context.elements[handler_name][:content]
+        if comp.kind_of?(Proc)
+          comp.call
+        else
+          Context.wipe handler_name
+          Context.render comp, handler_name
+        end
+      }
+    end
+
     class << self
       # define handlers for a context
       #

data/lib/ruta/history.rb

@@ -9,7 +9,8 @@ module Ruta
       # @param [String] url to be added to history
       # @param [Hash] data to be added to history
       # @param [String] title to be added to history, defaults to ""
-      def push(url,data,title="")
+      def push(context,url,data,title="")
+        url = Ruta.config.context_prefix ?  "/#{context}#{url}" : url
         `history.pushState(#{data.to_n}, #{title}, #{url})`
       end
 

data/lib/ruta/route.rb

@@ -31,7 +31,7 @@ module Ruta
 
      if flags[:to]
        @type = :handlers
-       @handlers = [flags.delete :to].flatten
+       @handlers = [flags.delete(:to)].flatten
      elsif flags[:context]
        @type = :context
        @handlers = flags.delete :context
@@ -129,6 +129,7 @@ module Ruta
      when :context
        Context.wipe
        Context.render handlers
+       History.push(@context_ref.ref,"",[],@context_ref.ref)
      end
     end
 

data/lib/ruta/router.rb

@@ -15,7 +15,7 @@ module Ruta
     def initialize block
       @current_context = []
       Context.define(:no_context)
-      instance_exec &block
+      instance_exec(&block)
     end
 
     # set which Context to map the following routes to
@@ -40,7 +40,7 @@ module Ruta
     # @param [Symbol] reference to context
     def root_to reference
       Router.set_root_to reference
-      context = Context.collection[:no_context]
+      context = Context.collection[reference]
       context.routes[:root]= Route.new('/', context,{ context: reference})
     end
 
@@ -79,8 +79,6 @@ module Ruta
       #     root_to :main
       #   end
       # @note please be aware that placing contexts within other contexts doesn't actully do anything.
-      #   however it is planed to be able to mount sub contexts to a route and re-direct as neccasary
-      #   think mounting engines or sub apps in RoR or Padrino
       # @yield Use this block to define any routes
       def define &block
         new block
@@ -91,6 +89,12 @@ module Ruta
       end
 
       def find_and_execute(path)
+        path =
+        if Ruta.config.context_prefix
+        (  path == '/' || path == "") ? path : (path[/(?:\/.*?)(\/.*)/];$1)
+        else
+          path
+        end
         res = find(path)
         if res
           navigate_to res

data/lib/ruta/version.rb

@@ -1,3 +1,3 @@
 module Ruta
-  VERSION = "1.0.2"
+  VERSION = "1.2.1"
 end

data/lib/ruta.rb

@@ -14,10 +14,29 @@ if RUBY_ENGINE == 'opal'
 
 
   module Ruta
-    class << self
+    class Config
+      attr_accessor :context_prefix
+      def initialize &block
+        @context_prefix = false
+        block_given?
+        instance_exec(self,&block) if block_given?
+      end
 
+      def configure &block
+        instance_exec(&block)
+      end
+    end
 
+    class << self
+      attr_reader :config
 
+      def configure &block
+        if self.config
+          @config.configure(&block)
+        else
+          @config = Config.new(&block)
+        end
+      end
       # used to retrieve a stored url
       #
       # @param [Symbol] context of the stored url, if this is nil it defaults to the current context
@@ -32,10 +51,9 @@ 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
-      # @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)
-        History.push(route[:path],route[:params],route[:title])
+        History.push(context,route[:path],route[:params],route[:title])
         Router.navigate_to(route)
       end
 
@@ -44,7 +62,12 @@ if RUBY_ENGINE == 'opal'
       #   $document.ready do
       #     Ruta.start_app
       #   end
-      def start_app
+      def start_app &block
+        if block_given?
+          configure(&block)
+        else
+          configure unless self.config
+        end
         Context.render(Router.current_context)
         Router.find_and_execute(History.current :path)
         History.listen_for_pop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruta
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Martin Becker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal