inesita-router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfda9b707e3e98f034c012927370dc77b66ae0e9
+  data.tar.gz: 5ef031c92b95e87fca5babdfd84cc953f024d4c3
+SHA512:
+  metadata.gz: a3eacee08c9678bcf32a683c11a6b278a78a5ca0a534825a204d635f646a8a8c3cf9cead165030411ae19490a9b2875f4794e11de14a9a995c861ac987768788
+  data.tar.gz: 7506170c651e8c1cc27fe4ef493ca7e314230c46730c9f9e8792ef2dc27a7d1965a19bb8fa9fe95fb2312ce979767e9f606fb1a5c383059ae187a5997e9d05bf

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache:
+  bundler: true
+rvm:
+  - 2.3.1
+before_install:
+  - "export PATH=$PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
+  - "if [ $(phantomjs --version) != '2.1.1' ]; then rm -rf $PWD/travis_phantomjs; mkdir -p $PWD/travis_phantomjs; fi"
+  - "if [ $(phantomjs --version) != '2.1.1' ]; then wget https://assets.membergetmember.co/software/phantomjs-2.1.1-linux-x86_64.tar.bz2 -O $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2; fi"
+  - "if [ $(phantomjs --version) != '2.1.1' ]; then tar -xvf $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2 -C $PWD/travis_phantomjs; fi"
+  - "phantomjs --version"
+notifications:
+  webhooks:
+    urls: https://webhooks.gitter.im/e/04c689326f7cd8e4d499

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michał Kalbarczyk
+
+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,23 @@
+# Inesita Router [![Gem Version](https://badge.fury.io/rb/inesita-router.svg)](http://badge.fury.io/rb/inesita-router) [![Code Climate](https://codeclimate.com/github/inesita-rb/inesita-router/badges/gpa.svg)](https://codeclimate.com/github/inesita-rb/inesita-router) [![Dependency Status](https://gemnasium.com/inesita-rb/inesita-router.svg)](https://gemnasium.com/inesita-rb/inesita-router) [![Build Status](https://travis-ci.org/inesita-rb/inesita-router.svg?branch=master)](https://travis-ci.org/inesita-rb/inesita-router)
+
+Router for [Inesita](https://github.com/inesita-rb/inesita) framework.
+
+## Example
+
+```ruby
+class Router
+  include Inesita::Router
+
+  def auth
+    unless store.logged_in?
+      go_to('/login')
+    end
+  end
+
+  def routes
+    route '/', to: Home, on_enter: method(:auth)
+    route '/list', to: List, on_enter: method(:auth)
+    route '/login', to: Login
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'opal/rspec/rake_task'
+
+ENV['SPEC_OPTS'] = '--color'
+
+Opal::RSpec::RakeTask.new(:spec_opal) do |_server, task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.default_path = 'spec/'
+end
+
+task default: [:spec_opal]

data/inesita-router.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'inesita-router'
+  s.version     = '0.1.0'
+  s.authors     = ['Michał Kalbarczyk']
+  s.email       = 'fazibear@gmail.com'
+  s.homepage    = 'http://github.com/inesita-rb/inesia-router'
+  s.summary     = 'Router component for Inesita'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'opal', '~> 0.10'
+  s.add_dependency 'inesita', '~> 0.6.0'
+
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'opal-rspec', '~> 0.6.0'
+  s.add_development_dependency 'rake', '~> 11.0'
+end

data/lib/inesita-router.rb

@@ -0,0 +1,4 @@
+require 'opal'
+require 'inesita'
+
+Opal.append_path File.expand_path('../../opal', __FILE__)

data/opal/inesita-router/browser.rb

@@ -0,0 +1,32 @@
+module Inesita
+  module Browser
+    module_function
+
+    Location = Document.JS[:location]
+    History = Window.JS[:history]
+
+    def path
+      Location.JS[:pathname]
+    end
+
+    def query
+      Location.JS[:search]
+    end
+
+    def decode_uri_component(value)
+      JS.decodeURIComponent(value)
+    end
+
+    def push_state(path)
+      History.JS.pushState({}, nil, path)
+    end
+
+    def on_pop_state(&block)
+      Window.JS[:onpopstate] = block
+    end
+
+    def hash_change(&block)
+      AddEventListener.call(:hashchange, block)
+    end
+  end
+end

data/opal/inesita-router/router.rb

@@ -0,0 +1,119 @@
+module Inesita
+  module Router
+    include Inesita::Component
+
+    attr_reader :params
+
+    def initialize
+      @routes = Routes.new
+      raise Error, 'Add #routes method to router!' unless respond_to?(:routes)
+      routes
+      raise Error, 'Add #route to your #routes method!' if @routes.routes.empty?
+      find_route
+      parse_url_params
+      add_listeners
+    end
+
+    def self.included(base)
+      base.extend(Inesita::Component::ClassMethods)
+      Component.module_eval do
+        unless respond_to?(:__a)
+          alias_method :__a, :a
+          define_method(:a) do |params, &block|
+            params = { onclick: -> { router.go_to(params[:href]) } }.merge(params)
+            __a(params, &block)
+          end
+        end
+      end
+    end
+
+    def add_listeners
+      Browser.on_pop_state { find_route; parse_url_params; render! }
+      Browser.hash_change { find_route; parse_url_params; render! }
+    end
+
+    def route(*params, &block)
+      @routes.route(*params, &block)
+    end
+
+    def find_route
+      @routes.routes.each do |route|
+        next unless path.match(route[:regex])
+        return go_to(url_for(route[:redirect_to])) if route[:redirect_to]
+        return @route = route
+      end
+      raise Error, "Can't find route for url"
+    end
+
+    def find_component(route)
+      call_on_enter_callback(route)
+      @component_props = route[:component_props]
+      route[:component]
+    end
+
+    def render
+      component find_component(@route), props: @component_props if @route
+    end
+
+    def call_on_enter_callback(route)
+      return unless route[:on_enter]
+      if route[:on_enter].respond_to?(:call)
+        route[:on_enter].call
+      end
+    end
+
+    def go_to(path)
+      Browser.push_state(path)
+      find_route
+      parse_url_params
+      render!
+      false
+    end
+
+    def parse_url_params
+      @params = compotent_url_params
+      query[1..-1].split('&').each do |param|
+        key, value = param.split('=')
+        @params[Browser.decode_uri_component(key)] = Browser.decode_uri_component(value)
+      end unless query.empty?
+    end
+
+    def compotent_url_params
+      Hash[@route[:params].zip(path.match(@route[:regex])[1..-1])]
+    end
+
+    def url_for(name, params = nil)
+      route = @routes.routes.find do |r|
+        case name
+        when String
+          r[:name] == name || r[:path] == name
+        when Object
+          r[:component] == name
+        else
+          false
+        end
+      end
+      route ? url_with_params(route, params) : raise(Error, "Route '#{name}' not found.")
+    end
+
+    def query
+      Browser.query
+    end
+
+    def path
+      Browser.path
+    end
+
+    def current_url?(name)
+      path == url_for(name, params)
+    end
+
+    def url_with_params(route, params)
+      path = route[:path]
+      params.each do |key, value|
+        path = path.gsub(":#{key}", "#{value}")
+      end if params
+      path
+    end
+  end
+end

data/opal/inesita-router/routes.rb

@@ -0,0 +1,79 @@
+module Inesita
+  class Routes
+    attr_reader :routes
+
+    def initialize(parent = nil)
+      @parent = parent
+      @routes = []
+    end
+
+    def route(*params, &block)
+      path = params.first.gsub(/^\//, '')
+      path = @parent ? "#{@parent}/#{path}" : "/#{path}"
+
+      add_subroutes(path, &block) if block_given?
+
+      if params.last[:redirect_to]
+        add_redirect(path, params.last[:redirect_to])
+      else
+        add_route(params.last[:as], path, params.last[:to], params.last[:props], params.last[:on_enter])
+      end
+    end
+
+    def validate_component(component)
+      raise Error, 'Component not exists' unless component
+      raise Error, "Invalid #{component} class, should mixin Inesita::Component" unless component.include?(Inesita::Component)
+    end
+
+    def add_redirect(path, redirect_to)
+      @routes << {
+        path: path,
+        redirect_to: redirect_to
+      }.merge(build_params_and_regex(path))
+    end
+
+    def add_route(name, path, component, component_props, on_enter)
+      validate_component(component)
+      @routes << {
+        path: path,
+        component: component,
+        component_props: component_props,
+        on_enter: on_enter,
+        name: name || component.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
+      }.merge(build_params_and_regex(path))
+    end
+
+    def add_subroutes(path, &block)
+      subroutes = Routes.new(path)
+      subroutes.instance_exec(&block)
+      @routes += subroutes.routes
+    end
+
+    def build_params_and_regex(path)
+      regex = ['^']
+      params = []
+      parts = path.split('/')
+      regex << '\/' if parts.empty?
+      parts.each do |part|
+        next if part.empty?
+        regex << '\/'
+        case part[0]
+        when ':'
+          params << part[1..-1]
+          regex << '([^\/]+)'
+        when '*'
+          params << part[1..-1]
+          regex << '(.*)'
+          break
+        else
+          regex << part
+        end
+      end
+      regex << '$'
+      {
+        regex: Regexp.new(regex.join),
+        params: params
+      }
+    end
+  end
+end

data/opal/inesita-router.rb

@@ -0,0 +1,3 @@
+require 'inesita-router/browser'
+require 'inesita-router/routes'
+require 'inesita-router/router'

data/spec/router_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Inesita::Router do
+  let(:element) { Inesita::Browser::Document.JS.createElement('div') }
+  let(:wrong_router) { Class.new { include Inesita::Router } }
+  let(:empty_router) { Class.new { include Inesita::Router; def routes; end } }
+  let(:router) do
+    Class.new do
+      include Inesita::Router
+
+      class TestComponent
+        include Inesita::Component
+
+        def render
+          div { "test" }
+        end
+      end
+
+      class OtherTestComponent
+        include Inesita::Component
+
+        def render
+          div { "other" }
+        end
+      end
+
+      def routes
+        route '/', to: TestComponent
+        route '/other', to: OtherTestComponent
+      end
+    end
+  end
+
+  it 'should fail without routes' do
+    expect { wrong_router.new.mount_to(element) }.to raise_error Inesita::Error
+  end
+
+  it 'should fail with empty routes' do
+    expect { empty_router.new }.to raise_error Inesita::Error
+  end
+
+  it 'should not fail with routes' do
+    expect { router.new }.not_to raise_error
+  end
+
+  describe '#url_for' do
+    it 'should return url for component name' do
+      expect(router.new.url_for(:test_component)).to eq '/'
+    end
+
+    it 'should return url for component name' do
+      expect(router.new.url_for(:other_test_component)).to eq '/other'
+    end
+
+    it 'should fail when no route for component' do
+      expect { router.new.url_for(:nothing) }.to raise_error Inesita::Error
+    end
+  end
+
+  describe '#current_url?' do
+    it 'should return true for current url' do
+      expect(router.mount_to(element).current_url?(:test_component)).to eq true
+    end
+
+    it 'should return false for current url' do
+      expect(router.mount_to(element).current_url?(:other_test_component)).to eq false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+include RSpec
+
+require 'inesita'
+require 'inesita-router'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: inesita-router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Kalbarczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: inesita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: opal-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: Router component for Inesita
+email: fazibear@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- inesita-router.gemspec
+- lib/inesita-router.rb
+- opal/inesita-router.rb
+- opal/inesita-router/browser.rb
+- opal/inesita-router/router.rb
+- opal/inesita-router/routes.rb
+- spec/router_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/inesita-rb/inesia-router
+licenses:
+- MIT
+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: Router component for Inesita
+test_files:
+- spec/router_spec.rb
+- spec/spec_helper.rb