ovto-router 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d40d4c179ddbb67bc5be14dca1769e78df2fc61986effcba297cf0f0e8dcf28
+  data.tar.gz: 3eca906defa724817c6f1b012cfa9b1a370bde078fdf86dcd77525d0d34ef179
+SHA512:
+  metadata.gz: b2d9825b9555b7f14a2d634cd5e8cd7712231f64c0b9f8c3ad4a507c5fe2270d8a867c07bc6cfe06c0d11a817f23004026a6f2db46507b2f8460b834041e9716
+  data.tar.gz: 89fdb6ffde13dc151eee043b80ff2f1aba456c82b8742fe2f5687c2234246b179d47ecf1f1dd736244f29794f9b2c9c54f50ec3a1851bae473779a15c55a4d1e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ovto-router.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,66 @@
+# Ovto::Router
+
+A router for [Ovto](https://github.com/yhara/ovto).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ovto-router'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ovto-router
+
+## Usage
+
+```ruby
+require 'ovto'
+require 'ovto/router'
+
+class MyApp < Ovto::App
+  class State < Ovto::State
+    include Ovto::Router::State
+  end
+
+  class Actions < Ovto::Actions
+    include Ovto::Router::Actions
+  end
+
+  class MainComponent < Ovto::Component
+    def render
+      o 'div' do
+        o Ovto::Router::HashRouter, routes: {
+          "/": -> { o 'h1', 'Root' },
+          "/hello": -> { o 'h2', "Hello" },
+          "/bye": -> { o 'h2', "Bye" },
+        }
+
+        o Ovto::Router::Link, path: '#/', text: 'go to root'
+        o 'br'
+        o Ovto::Router::Link, path: '#/hello', text: 'go to hello'
+        o 'br'
+        o Ovto::Router::Link, path: '#/bye', text: 'go to bye'
+      end
+    end
+  end
+end
+
+MyApp.run(id: 'ovto')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/ovto-router.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ovto/router"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/app.js

data/examples/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'ovto-router', path: '..'
+gem 'rake'

data/examples/Rakefile

@@ -0,0 +1,4 @@
+desc 'compile into js'
+task :default do
+  sh 'opal -c -g ovto -g ovto-router app.rb > app.js'
+end

data/examples/app.rb

@@ -0,0 +1,32 @@
+require 'ovto'
+require 'ovto/router'
+
+class MyApp < Ovto::App
+  class State < Ovto::State
+    include Ovto::Router::State
+  end
+
+  class Actions < Ovto::Actions
+    include Ovto::Router::Actions
+  end
+
+  class MainComponent < Ovto::Component
+    def render
+      o 'div' do
+        o Ovto::Router::HashRouter, routes: {
+          "/": -> { o 'h1', 'Root' },
+          "/hello": -> (name:) { o 'h2', "Hello, #{name}" },
+          "/bye": -> { o 'h2', "Bye" },
+        }
+
+        o Ovto::Router::Link, path: '#/', text: 'go to root'
+        o 'br'
+        o Ovto::Router::Link, path: '#/hello?name=Pocke', text: 'go to hello'
+        o 'br'
+        o Ovto::Router::Link, path: '#/bye', text: 'go to bye'
+      end
+    end
+  end
+end
+
+MyApp.run(id: 'ovto')

data/examples/index.html

@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script type='text/javascript' src='app.js'></script>
+  </head>
+  <body>
+    <div id='ovto'></div>
+  </body>
+</html>

data/lib/ovto/router.rb

@@ -0,0 +1,26 @@
+require "ovto/router/version"
+
+module Ovto
+  module Router
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+# require all the files, only if Opal is executing
+if RUBY_ENGINE == 'opal'
+  require 'ovto'
+  require 'native'
+  require_relative 'router/version'
+  require_relative 'router/matcher'
+  require_relative 'router/hash_router'
+  require_relative 'router/link'
+  require_relative 'router/state'
+  require_relative 'router/actions'
+  require_relative 'router/ovto_router_state'
+else
+  # NOT running inside of opal, set things up
+  # so opal can find the files.
+  require 'opal'
+  Opal.append_path File.expand_path('..', __FILE__).untaint
+end

data/lib/ovto/router/actions.rb

@@ -0,0 +1,16 @@
+module Ovto
+  module Router
+    module Actions
+      HISTORY = Native(`history`)
+
+      def ovto_router_handle_update_path(path:)
+        return { ovto_router: OvtoRouterState.new(path: path) }
+      end
+
+      def ovto_router_handle_click_link(path:)
+        HISTORY.pushState(nil, "", path)
+        return { ovto_router: OvtoRouterState.new(path: path) }
+      end
+    end
+  end
+end

data/lib/ovto/router/hash_router.rb

@@ -0,0 +1,49 @@
+module Ovto
+  module Router
+    class HashRouter < Ovto::Component
+      # @example
+      #   o HashRouter, routes: {
+      #     "/foo": -> { o FooComponent },
+      #     "/foo/:id": -> (id:) { o FooComponent, id: id },
+      #   }
+      def render(routes:)
+        o 'div' do
+          path = trim_hash(state.ovto_router.path)
+          routes.each do |match_txt, renderer|
+            matcher = Matcher.build(trim_hash(match_txt))
+            if params = matcher.match?(path)
+              instance_exec(params, &renderer)
+              break
+            end
+          end
+
+          # A dummy node to bind oncreate hook
+          # NOTE: it needs `key` attribute to ensure calling oncreate event.
+          o 'div', { oncreate: -> { on_create }, style: { display: 'none' }, key: 'Ovto::Router::HashRouter' }
+        end
+      end
+
+      private def trim_hash(path)
+        if path.start_with?('#')
+          path[1..-1]
+        else
+          path
+        end
+      end
+
+      private def current_path
+        Native(`location.hash || '/'`)
+      end
+
+      private def on_create
+        actions.ovto_router_handle_update_path(path: current_path)
+        %x!
+          window.addEventListener('popstate', function (event) {
+            event.preventDefault();
+            #{actions.ovto_router_handle_update_path(path: current_path)}
+          });
+        !
+      end
+    end
+  end
+end

data/lib/ovto/router/link.rb

@@ -0,0 +1,16 @@
+module Ovto
+  module Router
+    class Link < Ovto::Component
+      def render(path:, text:)
+        o 'a', { href: path, onclick: click_handler(path: path) }, text
+      end
+
+      private def click_handler(path:)
+        -> (e) do
+          e.preventDefault()
+          actions.ovto_router_handle_click_link(path: path)
+        end
+      end
+    end
+  end
+end

data/lib/ovto/router/matcher.rb

@@ -0,0 +1,32 @@
+module Ovto
+  module Router
+    class Matcher
+      def self.build(str)
+        if str.include?(':')
+          raise NotImplementedError
+        else
+          SimpleMatcher.new(str)
+        end
+      end
+    end
+
+    class SimpleMatcher < Matcher
+      def initialize(str)
+        @str = str
+      end
+
+      def match?(path)
+        path, query = path.split('?', 2)
+
+        return unless path == @str
+        return {} unless query
+
+        params(query)
+      end
+
+      def params(query)
+        query.split('&').map { |kv| kv.split('=') }.to_h
+      end
+    end
+  end
+end

data/lib/ovto/router/ovto_router_state.rb

@@ -0,0 +1,7 @@
+module Ovto
+  module Router
+    class OvtoRouterState < Ovto::State
+      item :path, default: ''
+    end
+  end
+end

data/lib/ovto/router/state.rb

@@ -0,0 +1,9 @@
+module Ovto
+  module Router
+    module State
+      def self.included(mod)
+        mod.item :ovto_router, default: OvtoRouterState.new
+      end
+    end
+  end
+end

data/lib/ovto/router/version.rb

@@ -0,0 +1,5 @@
+module Ovto
+  module Router
+    VERSION = "1.0.0"
+  end
+end

data/ovto-router.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/ovto/router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ovto-router"
+  spec.version       = Ovto::Router::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{Ovto Router}
+  spec.description   = %q{Ovto Router}
+  spec.homepage      = "https://github.com/pocke/ovto-router"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'ovto'
+  spec.add_runtime_dependency 'opal'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ovto-router
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ovto
+  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'
+- !ruby/object:Gem::Dependency
+  name: opal
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ovto Router
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/.gitignore
+- examples/Gemfile
+- examples/Rakefile
+- examples/app.rb
+- examples/index.html
+- lib/ovto/router.rb
+- lib/ovto/router/actions.rb
+- lib/ovto/router/hash_router.rb
+- lib/ovto/router/link.rb
+- lib/ovto/router/matcher.rb
+- lib/ovto/router/ovto_router_state.rb
+- lib/ovto/router/state.rb
+- lib/ovto/router/version.rb
+- ovto-router.gemspec
+homepage: https://github.com/pocke/ovto-router
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pocke/ovto-router
+  source_code_uri: https://github.com/pocke/ovto-router
+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: []
+rubygems_version: 3.2.0.pre1
+signing_key: 
+specification_version: 4
+summary: Ovto Router
+test_files: []