hyper-router 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77e89bd0516ef8221fa2520ca3959c01b3310818
-  data.tar.gz: 33a47f5a63a77de06ab7d13947cdc53d7997dc07
+  metadata.gz: 6e5fcad96836cef5e80a04939e0a50ffc6884584
+  data.tar.gz: 7728921b4f4f45a9b60a9e8e22eac90cd6ad86cb
 SHA512:
-  metadata.gz: 8c78ae7c11bc1942b5f46ba15626cf87f879f4059a4716723d937dc463ef216c1606a845ab9c895b4215ddf22c2163cacf07336c259e4c1c4d92c2a680a6071b
-  data.tar.gz: 164b196fce9e58159800e1dc44ed33830c24dd24e49cc8274a1a0b1f96be6c84401da08be1ec6422f0734d5dd41b2c15902944b33b58e4aa25d8be4ccfad967e
+  metadata.gz: 0a3f6ab32532f2b455e17539b8ee74b93192239a55fd64eb5d190ee1419b872b47026375939c9fc49e13855081492ab2ac894dde68ae34543db609eeffe4c546
+  data.tar.gz: a25595ed8d84964d8df069cfcb57f9e4f7688a4b73eee454dc7526f90dde1d63bb1c817affa16543cb3b4510f3cd0f7548bc85c0b0a808f5d1a4d8d060d69a5d

data/README.md

@@ -1,6 +1,17 @@
-## HyperRouter
+<p align="center">
+  <a href="http://ruby-hyperloop.io/" alt="Hyperloop" title="Hyperloop">
+    <img src="https://github.com/ruby-hyperloop/ruby-hyperloop.io/blob/sprint/source/images/HyperRouter.png" width="150px"/>
+  </a>
+ </p>
+
+<h1 align="center">
+  HyperRouter
+</h1>
+
+<p align="center">
+  HyperRouter allows you write and use the React Router in Ruby through Opal.
+</p>
 
-HyperRouter allows you write and use the React Router in Ruby through Opal.
 
 ## Installation
 
@@ -201,7 +212,7 @@ class MyRouter < Hyperloop::Router
 end
 ```
 
-### BrowserRouter, HashRouter, MemoryRouter, StaticRouter
+### BrowserRouter, HashRouter, MemoryRouter
 
 Using one of these classes automatically takes care of the history for you,
 so you don't need to specify one.
@@ -216,6 +227,25 @@ class MyRouter < React::Component::Base
 end
 ```
 
+### StaticRouter
+
+Static router is a little different, since it doesn't actually have a history.
+These are used under-the-hood for any other Router during prerendering.
+To use a path with a StaticRouter, with the macro `initial_path`.
+This acts the same as `prerender_path` for other routers.
+
+```ruby
+class MyRouter < Hyperloop::StaticRouter
+  initial_path :current_path
+
+  route do
+    DIV do
+      Route('/:name', mounts: Greet)
+    end
+  end
+end
+```
+
 ### Rendering a Router
 
 To render children/routes use the `route` macro, it is the equivalent to `render` of a component.

data/lib/hyper-router.rb

@@ -30,12 +30,8 @@ IF USING NPM/WEBPACK:
   require 'hyper-router/match'
   require 'hyper-router/class_methods'
   require 'hyper-router/component_methods'
+  require 'hyper-router/instance_methods'
 
-  require 'hyperloop/router/base/class_methods'
-  require 'hyperloop/router/browser/class_methods'
-  require 'hyperloop/router/hash/class_methods'
-  require 'hyperloop/router/memory/class_methods'
-  require 'hyperloop/router/static/class_methods'
   require 'hyperloop/router/base'
   require 'hyperloop/router/browser'
   require 'hyperloop/router/component'

data/lib/hyper-router/class_methods.rb

@@ -1,43 +1,41 @@
 module HyperRouter
+  class NoHistoryError < StandardError; end
+
   module ClassMethods
-    def prerender_path(*args)
+    def initial_path(*args)
       name = args[0].is_a?(Hash) ? args[0].first[0] : args[0]
 
-      define_method(:prerender_path) do
+      define_method(:initial_path) do
         params.send(:"#{name}")
       end
 
       param(*args)
     end
 
-    def history(history_type)
-      define_method(:history) do
-        @history ||= self.class.send(:"#{history_type}_history")
+    alias prerender_path initial_path
+
+    def history(*args)
+      if args.count > 0
+        @__history_type = args.first
+      elsif @__history_type
+        @__history ||= send(:"#{@__history_type}_history")
       end
     end
 
-    def prerender_router(&block)
-      define_method(:render) do
-        location = {}.tap do |hash|
-          pathname, search = (respond_to?(:prerender_path) ? prerender_path : '').split('?', 2)
-          hash[:pathname] = pathname
-          hash[:search] = search ? "?#{search}" : ''
-        end
-
-        React::Router::StaticRouter(location: location.to_n, context: {}.to_n) do
-          instance_eval(&block)
-        end
-      end
+    def location
+      Location.new(`#{history.to_n}.location`)
     end
 
     def route(&block)
-      if React::IsomorphicHelpers.on_opal_client?
-        render_router(&block)
-      else
+      if React::IsomorphicHelpers.on_opal_server?
         prerender_router(&block)
+      else
+        render_router(&block)
       end
     end
 
+    private
+
     def browser_history
       React::Router::History.current.create_browser_history
     end
@@ -49,5 +47,29 @@ module HyperRouter
     def memory_history(*args)
       React::Router::History.current.create_memory_history(*args)
     end
+
+    def render_router(&block)
+      define_method(:render) do
+        raise(HyperRouter::NoHistoryError, 'A history must be defined') unless history
+
+        React::Router::Router(history: history.to_n) do
+          instance_eval(&block)
+        end
+      end
+    end
+
+    def prerender_router(&block)
+      define_method(:render) do
+        location = {}.tap do |hash|
+          pathname, search = (respond_to?(:initial_path) ? initial_path : '').split('?', 2)
+          hash[:pathname] = pathname
+          hash[:search] = search ? "?#{search}" : ''
+        end
+
+        React::Router::StaticRouter(location: location.to_n, context: {}.to_n) do
+          instance_eval(&block)
+        end
+      end
+    end
   end
 end

data/lib/hyper-router/history.rb

@@ -10,12 +10,15 @@ module HyperRouter
       @native
     end
 
+    def location
+      HyperRouter::Location.new(`#{@native}.location`)
+    end
+
     alias_native :block
     alias_native :create_href, :createHref
     alias_native :go
     alias_native :go_back, :goBack
     alias_native :go_forward, :goForward
-    alias_native :location, :location
     alias_native :push, :push
     alias_native :replace, :replace
   end

data/lib/hyper-router/instance_methods.rb

@@ -0,0 +1,11 @@
+module HyperRouter
+  module InstanceMethods
+    def history
+      self.class.history
+    end
+
+    def location
+      self.class.location
+    end
+  end
+end

data/lib/hyper-router/version.rb

@@ -1,3 +1,3 @@
 module HyperRouter
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

data/lib/hyperloop/router.rb

@@ -1,35 +1,35 @@
 module Hyperloop
   class Router
     def self.inherited(child)
-      child.include(React::Component)
+      child.include(Hyperloop::Component::Mixin)
       child.include(Base)
     end
   end
 
   class BrowserRouter
     def self.inherited(child)
-      child.include(React::Component)
+      child.include(Hyperloop::Component::Mixin)
       child.include(Hyperloop::Router::Browser)
     end
   end
 
   class HashRouter
     def self.inherited(child)
-      child.include(React::Component)
+      child.include(Hyperloop::Component::Mixin)
       child.include(Hyperloop::Router::Hash)
     end
   end
 
   class MemoryRouter
     def self.inherited(child)
-      child.include(React::Component)
+      child.include(Hyperloop::Component::Mixin)
       child.include(Hyperloop::Router::Memory)
     end
   end
 
   class StaticRouter
     def self.inherited(child)
-      child.include(React::Component)
+      child.include(Hyperloop::Component::Mixin)
       child.include(Hyperloop::Router::Static)
     end
   end

data/lib/hyperloop/router/base.rb

@@ -3,8 +3,8 @@ module Hyperloop
     module Base
       def self.included(base)
         base.extend(HyperRouter::ClassMethods)
-        base.extend(ClassMethods)
 
+        base.include(HyperRouter::InstanceMethods)
         base.include(HyperRouter::ComponentMethods)
       end
     end

data/lib/hyperloop/router/browser.rb

@@ -3,8 +3,9 @@ module Hyperloop
     module Browser
       def self.included(base)
         base.extend(HyperRouter::ClassMethods)
-        base.extend(ClassMethods)
+        base.history(:browser)
 
+        base.include(HyperRouter::InstanceMethods)
         base.include(HyperRouter::ComponentMethods)
       end
     end

data/lib/hyperloop/router/component.rb

@@ -2,7 +2,7 @@ module Hyperloop
   class Router
     class Component
       def self.inherited(base)
-        base.include(React::Component)
+        base.include(Hyperloop::Component::Mixin)
         base.include(HyperRouter::ComponentMethods)
 
         base.class_eval do

data/lib/hyperloop/router/hash.rb

@@ -1,10 +1,11 @@
 module Hyperloop
   class Router
-    module Browser
+    module Hash
       def self.included(base)
         base.extend(HyperRouter::ClassMethods)
-        base.extend(ClassMethods)
-        
+        base.history(:hash)
+
+        base.include(HyperRouter::InstanceMethods)
         base.include(HyperRouter::ComponentMethods)
       end
     end

data/lib/hyperloop/router/memory.rb

@@ -3,8 +3,9 @@ module Hyperloop
     module Memory
       def self.included(base)
         base.extend(HyperRouter::ClassMethods)
-        base.extend(ClassMethods)
-        
+        base.history(:memory)
+
+        base.include(HyperRouter::InstanceMethods)
         base.include(HyperRouter::ComponentMethods)
       end
     end

data/lib/hyperloop/router/static.rb

@@ -1,10 +1,17 @@
 module Hyperloop
   class Router
     module Static
+      module ClassMethods
+        def route(&block)
+          prerender_router(&block)
+        end
+      end
+
       def self.included(base)
         base.extend(HyperRouter::ClassMethods)
         base.extend(ClassMethods)
-        
+
+        base.include(HyperRouter::InstanceMethods)
         base.include(HyperRouter::ComponentMethods)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyper-router
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Adam George
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyper-component
@@ -486,22 +486,18 @@ files:
 - lib/hyper-router/class_methods.rb
 - lib/hyper-router/component_methods.rb
 - lib/hyper-router/history.rb
+- lib/hyper-router/instance_methods.rb
 - lib/hyper-router/location.rb
 - lib/hyper-router/match.rb
 - lib/hyper-router/react-router-source.rb
 - lib/hyper-router/version.rb
 - lib/hyperloop/router.rb
 - lib/hyperloop/router/base.rb
-- lib/hyperloop/router/base/class_methods.rb
 - lib/hyperloop/router/browser.rb
-- lib/hyperloop/router/browser/class_methods.rb
 - lib/hyperloop/router/component.rb
 - lib/hyperloop/router/hash.rb
-- lib/hyperloop/router/hash/class_methods.rb
 - lib/hyperloop/router/memory.rb
-- lib/hyperloop/router/memory/class_methods.rb
 - lib/hyperloop/router/static.rb
-- lib/hyperloop/router/static/class_methods.rb
 - lib/react/router.rb
 - lib/react/router/dom.rb
 - lib/react/router/history.rb
@@ -527,7 +523,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: react-router for Opal, part of the hyperloop gem family

data/lib/hyperloop/router/base/class_methods.rb

@@ -1,21 +0,0 @@
-module Hyperloop
-  class Router
-    module Base
-      module ClassMethods
-        def render_router(&block)
-          define_method(:render) do
-            if respond_to?(:history)
-              React::Router::Router(history: history.to_n) do
-                instance_eval(&block)
-              end
-            else
-              React::Router::MemoryRouter(location: { pathname: '/' }.to_n) do
-                instance_eval(&block)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hyperloop/router/browser/class_methods.rb

@@ -1,15 +0,0 @@
-module Hyperloop
-  class Router
-    module Browser
-      module ClassMethods
-        def render_router(&block)
-          define_method(:render) do
-            React::Router::DOM::BrowserRouter() do
-              instance_eval(&block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hyperloop/router/hash/class_methods.rb

@@ -1,15 +0,0 @@
-module Hyperloop
-  class Router
-    module Hash
-      module ClassMethods
-        def render(&block)
-          define_method(:render) do
-            React::Router::DOM::HashRouter() do
-              instance_eval(&block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hyperloop/router/memory/class_methods.rb

@@ -1,15 +0,0 @@
-module Hyperloop
-  class Router
-    module Memory
-      module ClassMethods
-        def render(&block)
-          define_method(:render) do
-            React::Router::MemoryRouter() do
-              instance_eval(&block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hyperloop/router/static/class_methods.rb

@@ -1,15 +0,0 @@
-module Hyperloop
-  class Router
-    module Static
-      module ClassMethods
-        def render_router(&block)
-          define_method(:render) do
-            React::Router::StaticRouter() do
-              instance_eval(&block)
-            end
-          end
-        end
-      end
-    end
-  end
-end