reactrb-router 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 560f5e4ceb0cf919265e4be43f4835b9d52040a9
+  data.tar.gz: 18412d2c5caa9760f48a683d7faff813c2600a1d
+SHA512:
+  metadata.gz: d060b980b6d63dd302eaa7e05677893dac2e94da3b948aef5a7f57971ee82e60279c9b6a43e16332288bde2cfb86607b946a08bc489ea34e25f10884507a4caa
+  data.tar.gz: a81767b732acf324860098494e1b326960c7b7ed8f3374f2bec9843a28b95c72f7e86450f422703ed883fd85cabb6f65e7a2b8de2ed63572253ab8bb868150b9

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 catprintlabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,185 @@
+## Reactrb Router
+
+Reactrb Router allows you write and use the React Router in Ruby through Opal.
+
+### Note
+
+This gem is in the process of being re-written. It will be based on latest react-router which is way better. Please see the [v2-4-0 branch](https://github.com/reactrb/reactrb-router/tree/v2-4-0).
+If you you want to use this branch with `reactrb-rails-generator`, be sure to remove `require 'react_router` from `components.rb`. And to use the new Router syntax as per the docs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reactrb-router'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reactor-router
+
+## Usage
+
+The router is a React component that loads other components depending on the current URL.
+
+Unlike other components there can only be one router on a page.
+
+To get you started here is a sample router.   
+
+```ruby
+module Components
+  module Accounts
+
+    class Show
+
+      include React::Router  # instead of React::Component, you use React::Router
+
+      # the routes macro creates the mapping between URLs and components to display
+
+      routes(path: '/account/:user_id') do  # i.e. we expect to see something like /account/12345
+        # routes can be nested  the dashboard will be at /account/12345/dashboard
+        # the DashboardRoute component will be mounted
+        route(name: 'Dashboard', path: 'dashboard', handler: Components::Accounts::DashboardRoute)
+        route(path: 'orders', name: 'Orders', handler: Components::Accounts::OrdersRoute)
+        # when displaying an order we need the order order as well as the user_id
+        route(path: 'orders/:order_id', name: 'Order', handler: Components::Accounts::OrderRoute)
+        route(path: 'statement', name: 'Statement', handler: Components::Accounts::StatementRoute)
+        # the special redirect route
+        redirect(from: '/account/:user_id', to: 'Dashboard')
+      end
+
+      # you grab the url params and preprocess them using the router_param macro.
+      # when Router is mounted it will receive the :user_id from the url.  In this case we grab
+      # the corresponding active_record model.
+
+      router_param :user_id do |id|
+        User.find(id)
+      end
+
+      # like any component routers can have params that are passed in when the router is mounted
+
+      param :user_param, type: User
+      param :user_orders_param, type: [Order]
+      param :production_center_address_param, type: Address
+      param :open_invoices_param
+      param :user_profiles_param, type: [PaymentProfile]
+      param :user_addresses_param, type: [Address]
+
+      # because the underlying javascript router has no provisions to pass params we
+      # will export states and copy the params to the states so the lower components can read them
+      # expect this get fixed in the near future
+
+      export_state :user
+      export_state :production_center_address
+      export_state :open_invoices
+      export_state :payment_profiles
+      export_state :addresses
+
+      # the router also makes a good place for other top level states to be housed (i.e. the flux architecture)
+      export_state :order_count
+
+      before_mount do
+        # before mounting the router we copy the incoming params that the lower level components will need
+        user! user_param
+        production_center_address! production_center_address_param
+        open_invoices! open_invoices_param
+        payment_profiles! user_profiles_param
+        addresses! user_addresses_param
+
+        order_count! user.orders.count  # grab our top level state info and save it away
+
+      end
+
+      # For routers you define a show method instead of a render method
+      def show
+        div do
+          div.account_nav do
+
+            # link is a special router component that generates an on page link, that will maintain history etc.
+            # basically an intelligent anchor tag.  When a user clicks a link, it will rerender the router, update
+            # the history etc.
+            # So for example when 'My Statement' is clicked. The route changes to /account/:id/statement
+
+            link(to: 'Dashboard', class: 'no-underline btn btn-default', params: { user_id: user.id }) { 'Account Dashboard' }
+            link(to: 'Orders', class: 'no-underline btn btn-default', params: { user_id: user.id }) { 'My Quotes & Orders' }
+            link(to: 'Statement', class: 'no-underline btn btn-default', params: { user_id: user.id }) { 'My Statement' }
+
+          end
+        # someplace in the router show method you will have route_handler component which mounts and renders the component
+        # indicated by the current route.
+        route_handler   
+        end
+      end
+    end
+
+    # We can't pass parameters to the routed components, so we set up these mini components
+    # which grab the state from router and send it along to the actual component
+
+    class DashboardRoute
+
+      include React::Component
+
+      def render
+        AccountDashboard user: Show.user, addresses: Show.addresses, payment_profiles: Show.payment_profiles
+      end
+
+    end
+
+    class StatementRoute
+
+      include React::Component
+
+      def render
+        Statement production_center_address: Show.production_center_address,
+        open_invoices: Show.open_invoices, current_invoices: Show.open_invoices[:invoices],
+        mailing_address: Show.open_invoices[:mailing_address]
+      end
+
+    end
+
+    class OrdersRoute
+
+      include React::Component
+
+      def render
+        AccountOrders user: Show.user #, orders: Show.orders
+      end
+
+    end
+
+    class OrderRoute
+
+      include React::Component
+
+      router_param :order_id do |id|
+        Order.find(id)
+      end
+
+      def render
+        OrderShow(order: order_id, referrer: 'account')
+      end
+
+    end
+
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/reactrb/reactrb-router/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/reactrb-router/component.rb

@@ -0,0 +1,15 @@
+module React
+  module Component
+    module ClassMethods
+    end
+
+    def route_handler(*args)
+      Router::RR::RouteHandler(*args)
+    end
+
+    def link(opts = {}, &block)
+      opts[:params] = opts[:params].to_n if opts[:params]
+      Router::RR::Link(opts, &block)
+    end
+  end
+end

data/lib/reactrb-router/history.rb

@@ -0,0 +1,153 @@
+class History
+  class << self
+    def setup_handler
+      unless @handlers_setup
+        handler = lambda { |event| window_history_pop_handler(event) }
+        %x{
+          if (window.addEventListener) {
+            window.addEventListener('popstate', handler, false);
+          } else {
+            window.attachEvent('onpopstate', handler);
+          }
+        }
+      end
+      @handlers_setup = true
+    end
+
+    def current_path
+      @current_path ||= `decodeURI(window.location.pathname + window.location.search)`
+    end
+
+    attr_accessor :history
+
+    def [](name)
+      (@histories ||= {})[name]
+    end
+
+    def []=(name, value)
+      (@histories ||= {})[name] = value
+    end
+
+    def window_history_pop_handler(event)
+      return if `event.state === undefined`
+      if `event.state == null` # happens when popping off outer dialog
+        puts "pop handler pops off last value"
+        old_history = @history
+        @saved_history = @history # for safari's sake
+        @saved_path = @current_path
+        @saved_history_length = `ReactRouter.History.length`
+        @current_path = ""
+        @history = nil
+        `ReactRouter.History.length = 0`
+        old_history.on_state_change.call(:inactive) if old_history.on_state_change
+      else
+        puts "pop handler #{`event.state.history_id`}, #{`ReactRouter.History.length`} -> #{`event.state.history_length`}, #{`event.state.path`}"
+        old_history = @history
+        old_history_length = `ReactRouter.History.length`
+        @current_path = `event.state.path`
+        @history= History[`event.state.history_id`]
+        `ReactRouter.History.length = event.state.history_length`
+        if old_history != @history
+          if `ReactRouter.History.length` > old_history_length
+            puts "activating "
+            @history.on_state_change.call(:active) if @history.on_state_change
+          else
+            puts "deactivating"
+            old_history.on_state_change.call(:inactive) if old_history.on_state_change
+          end
+        end
+        @history.notify_listeners(:pop)
+      end
+    end
+
+    def push_path(path)
+      puts "pushing path #{path}"
+      unless @history # needed because safari strangly pops off outer most history on initialization
+        @history = @saved_history
+        @current_path = @saved_path
+        `ReactRouter.History.length = #{@saved_history_length}`
+        @history.on_state_change.call(:active) if @history.on_state_change
+      end
+      `window.history.pushState({ path: path, history_id: #{@history.name}, history_length: (ReactRouter.History.length += 1)}, '', path);`
+      @current_path = path
+      @history.notify_listeners(:push)
+    end
+
+    def replace_path(path)
+      puts "replacing path #{path}"
+      unless @history # needed because safari strangly pops off outer most history on initialization
+        @history = @saved_history
+        @current_path = @saved_path
+        `ReactRouter.History.length = #{@saved_history_length}`
+        @history.on_state_change.call(:active) if @history.on_state_change
+      end
+      `window.history.replaceState({ path: path, history_id: #{@history.name}, history_length: ReactRouter.History.length}, '', path);`
+      @current_path = path
+      @history.notify_listeners(:replace)
+    end
+
+    def pop_path
+      `window.history.go(-1)`
+    end
+  end
+
+  attr_reader :location
+  attr_reader :on_state_change
+  attr_reader :name
+
+  def to_s
+    "History<#{@name}>"
+  end
+
+  def initialize(name, preactivate_path = nil, &on_state_change)
+    @name = name
+    if History[@name]
+      raise "a history location named #{@name} already exists"
+    else
+      History[@name] = self
+    end
+    @on_state_change = on_state_change
+    @initial_path = @preactivate_path = preactivate_path
+    self.class.setup_handler
+    @listeners = []
+    @location = {
+      addChangeListener: lambda { |listener| @listeners << listener unless @listeners.include? listener} ,
+      removeChangeListener: lambda { |listener| @listeners.delete(listener) },
+      push: lambda { |path| self.class.push_path(path) },
+      pop: lambda { self.class.pop_path },
+      replace: lambda { |path| self.class.replace_path path },
+      getCurrentPath: lambda { (@preactivate_path || self.class.current_path)},
+      toString: lambda { '<HistoryLocation>'}
+    }.to_n
+  end
+
+  def activate(initial_path = nil)
+    puts "activating #{self}"
+    @preactivate_path = nil
+    initial_path ||= @initial_path || self.class.current_path
+    current_history = self.class.history
+    self.class.history = self
+    @starting_history_length = `ReactRouter.History.length` if current_history != self
+    if @name == "MainApp"
+      self.class.replace_path initial_path
+    else
+      self.class.push_path initial_path
+    end
+    @on_state_change.call(:active) if @on_state_change and current_history != self
+    self
+  end
+
+  def deactivate
+    puts "deactivate go(#{@starting_history_length-`ReactRouter.History.length`})"
+    `window.history.go(#{@starting_history_length}-ReactRouter.History.length)`
+    self
+  end
+
+  def notify_listeners(type)
+    puts "!! #{self}.notify_listeners(#{type}) listeners_count: #{@listeners.count}, path: #{self.class.current_path}"
+    @listeners.each { |listener| `listener.call(#{@location}, {path: #{self.class.current_path}, type: type})` }
+  rescue Exception => e
+    `debugger`
+    nil
+  end
+end

data/lib/reactrb-router/router.rb

@@ -0,0 +1,228 @@
+module React
+  module Router
+    class AbortTransition < Exception
+    end
+
+    class RR < React::NativeLibrary
+      imports ReactRouter
+    end
+
+    def self.included(base)
+      base.class_eval do
+
+        include React::Component
+        include React::IsomorphicHelpers
+
+        native_mixin `ReactRouter.Navigation`
+        native_mixin `ReactRouter.State`
+
+        class << self
+
+          attr_accessor :router_context
+
+          def get_path
+            path = `#{@router_component}.native.getPath()`
+            path = nil if `typeof path === 'undefined'`
+            path
+          end
+
+          def replace_with(route_or_path, params = nil, query = nil)
+            `#{@router_component}.native.replaceWith.apply(self.native, #{[route_or_path, params, query].compact})`
+          end
+
+          def transition_to(route_or_path, params = {}, query = {})
+            params = @router_component.params[:router_state][:params].merge params
+            query = @router_component.params[:router_state][:query].merge query
+            `#{@router_component}.native.transitionTo.apply(self.native, #{[route_or_path, params.to_n, query.to_n]})`
+          end
+
+          def link(opts={}, &block)
+            params = opts.delete(:params) || {}
+            query = opts.delete(:query) || {}
+            to = opts.delete(:to)
+            React::RenderingContext.render("a", opts, &block).on(:click) { transition_to(to, params, query) }
+          end
+
+          def url_param_methods
+            @url_param_methods ||= []
+          end
+
+          attr_accessor :evaluated_url_params
+          attr_accessor :current_url_params
+
+          def router_param(name, opts = {}, &block)
+
+            # create a method visible both the instance and the class
+            # that gets passed the named router parameter (typically a db :id) and returns a
+            # meaningful value (typically a database record)
+
+            method_name = opts[:as] || name
+
+            class << self
+              define_method method_name do
+                if @router_component
+                  block.call @router_component.url_params[name]
+                else
+                  raise "Call to #{self.name}.#{method_name} when #{self.name} is not mounted"
+                end
+              end
+            end
+
+            define_method method_name do
+              self.class.send method_name
+            end
+
+          end
+
+        end
+
+        static_call_back "willTransitionTo" do |transition, params, query, callback|
+          params = Hash.new(params)
+          query = Hash.new(query)
+          transition = `transition.path`
+          puts "willTransitionTo(#{transition}, #{params}, #{query}) for router #{self.object_id}, router_component = #{@router_component.object_id}"
+          begin
+            if self.respond_to? :will_transition_to
+              result = will_transition_to transition, params, query if self.respond_to? :will_transition_to
+              if result.is_a? Promise
+                result.then { |r| callback(r) }
+              else
+                callback.call()
+              end
+            else
+              callback.call()
+            end
+          rescue AbortTransition
+            raise "transition aborted"
+          end
+        end
+
+        before_first_mount do |context|
+
+          @evaluated_url_params = {}
+          @current_url_params = {}
+          if !self.instance_methods.include?(:show)  # if there is no show method this is NOT a top level router so we assume routing will begin elsewhere
+            @routing = true
+          elsif `typeof ReactRouter === 'undefined'`
+            if on_opal_client?
+              message = "ReactRouter not defined in browser assets - you must manually include it in your assets"
+            else
+              message = "ReactRouter not defined in components.js.rb assets manifest - you must manually include it in your assets"
+            end
+            `console.error(message)`
+            @routing = true
+          else
+            @routing = false
+          end
+        end
+
+        export_component
+
+        param :router_state # optional because it is not initially passed in but we add it when running the router
+        param :query
+        param :params
+
+        def url_params(params = params)
+          (params && (params[:params] || (params[:router_state] && params[:router_state][:params]))) || {}
+        end
+
+        def render
+          if self.class.routing?
+            if self.class.router_context
+              `self.native.context.router = #{self.class.router_context}`
+            else
+              self.class.router_context = `self.native.context.router`
+            end
+            self.class.instance_variable_set(:@router_component, self)  # this was done after mount, but I think it works here
+            show
+          elsif on_opal_server?
+            self.class.routing!
+            routes = self.class.build_routes(true)
+            %x{
+              ReactRouter.run(#{routes}, window.reactrb_router_static_location, function(root, state) {
+                self.native.props.router_state = state
+                self.root = React.createElement(root, self.native.props);
+              });
+            }
+            React::Element.new(@root, 'Root', {}, nil)
+          end
+        end
+
+        def self.routing?
+          @routing
+        end
+
+        def self.routing!
+          was_routing = @routing
+          @routing = true
+          was_routing
+        end
+
+        # override self.location to provide application specific location handlers
+
+        def location
+          (@location ||= History.new("MainApp")).activate.location  # must be called MainApp for now to avoid doing an extra state push (ugh)
+        end
+
+        after_mount do
+          if !self.class.routing!
+            puts "after mount outside of ruby router #{self.object_id}, my class router is #{self.class.object_id}"
+            dom_node = if `typeof React.findDOMNode === 'undefined'`
+              `#{self}.native.getDOMNode`            # v0.12.0
+            else
+              `React.findDOMNode(#{self}.native)`    # v0.13.0
+            end
+            routes = self.class.build_routes(true)
+            %x{
+              ReactRouter.run(#{routes}, #{location}, function(root, state) {
+                self.native.props.router_state = state
+                React.render(React.createElement(root, self.native.props), #{dom_node});
+              });
+            }
+          elsif respond_to? :show
+            puts "after mount inside of ruby router #{self.object_id}, my class router is #{self.class.object_id}"
+            #self.class.instance_variable_set(:@router_component, self)  # this was done here but was moved to the first render
+          end
+        end
+
+        def self.routes(opts = {}, &block)
+          @routes_opts = opts
+          @routes_block = block
+        end
+
+        def self.routes_block
+          @routes_block
+        end
+
+        def self.build_routes(generate_node = nil)
+          #raise "You must define a routes block in a router component" unless @routes_block
+          routes_opts = @routes_opts.dup
+          routes_opts[:handler] ||= self
+          route(routes_opts, generate_node, &@routes_block)
+        end
+
+        def self.route(opts = {}, generate_node = nil, &block)
+          block ||= opts[:handler].routes_block if opts[:handler].respond_to? :routes_block
+          opts = opts.dup
+          opts[:handler] = React::API.create_native_react_class(opts[:handler])
+          (generate_node ? RR::Route_as_node(opts, &block) : RR::Route(opts, &block))
+        rescue Exception => e
+          React::IsomorphicHelpers.log("Could not define route #{opts}: #{e}", :error)
+        end
+
+        def self.default_route(ops = {}, &block)
+          RR::DefaultRoute(opts, &block)
+        end
+
+        def self.redirect(opts = {}, &block)
+          RR::Redirect(opts, &block)
+        end
+
+        def self.not_found(opts={}, &block)
+          opts[:handler] = React::API.create_native_react_class(opts[:handler])
+          RR::NotFoundRoute(opts, &block)
+        end
+      end
+    end
+  end
+end

data/lib/reactrb-router/version.rb

@@ -0,0 +1,3 @@
+module ReactrbRouter
+  VERSION = '0.8.1'
+end

data/lib/reactrb-router/window_location.rb

@@ -0,0 +1,11 @@
+module React
+  module Router
+    class WindowLocation
+      include React::IsomorphicHelpers
+
+      before_first_mount do |context|
+        context.eval("window.reactrb_router_static_location = '#{context.controller.request.path}?#{context.controller.request.query_string}'")
+      end
+    end
+  end
+end

data/lib/reactrb-router.rb

@@ -0,0 +1,15 @@
+if RUBY_ENGINE == 'opal'
+  require 'reactrb'
+  require 'reactrb-router/component'
+  require 'reactrb-router/history'
+  require 'reactrb-router/router'
+  require 'reactrb-router/version'
+else
+  require 'opal'
+  require 'reactrb'
+  require 'reactrb-router/window_location'
+  require 'reactrb-router/version'
+
+  Opal.append_path File.expand_path('../', __FILE__).untaint
+  Opal.append_path File.expand_path('../../vendor', __FILE__).untaint
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: reactrb-router
+version: !ruby/object:Gem::Version
+  version: 0.8.1
+platform: ruby
+authors:
+- Adam George
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reactrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds the ability to write and use the react-router in Ruby through Opal
+email:
+- adamgeorge.31@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/reactrb-router.rb
+- lib/reactrb-router/component.rb
+- lib/reactrb-router/history.rb
+- lib/reactrb-router/router.rb
+- lib/reactrb-router/version.rb
+- lib/reactrb-router/window_location.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: react-router for Opal, part of the reactrb gem family
+test_files: []