webview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c48d69ff8dd6f7dbf4220a5a481e4af44e8b542493a9274005378e326764b5c1
+  data.tar.gz: cd11ae6d0ee8627ced9548fe321cf5165b2e4c37d4da096ec5a653ffb24abf7c
+SHA512:
+  metadata.gz: 56645c7bde105ace3fbe47187add745cd7896a99c6a1e8aa1af120f41d31b0a209770dea7dab8aee986397b876c5faed5b8e3b930581e7de3f9aa61317941627
+  data.tar.gz: e991be01929ad140d398e6054a76af9d5017fcc75580e35210b666725080caac2fc1e1d877195cf2463ab4e7a83118879d00a7bc5d2914fa806c398a7134a533

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/ext/ext_package
+/ext/webview_app
+mkmf.log
+/webview-*.gem
+
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--require gem_helper
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    webview (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webview!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 jiangzhi.xie
+
+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,93 @@
+# Webview
+
+a webview GUI based on [zserge/webview](https://github.com/zserge/webview)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webview'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webview
+
+## Usage
+
+```ruby
+app = Webview::App.new
+app.open('http://localhost:3000?foo=bar')
+
+at_exit { app.close }
+begin
+  app.join
+rescue Interrupt
+  app.close
+end
+```
+
+Allow debug page
+
+```ruby
+app = Webview::App.new(debug: true)
+```
+
+Run with your backend
+
+```ruby
+app = Webview::App.new
+backend = Thread.new { `rails s` }
+app.open('http://localhost:3000')
+
+at_exit { app.close }
+begin
+  app.join
+rescue Interrupt
+  app.close
+  backend.kill
+end
+```
+
+RPC with Javascript
+
+```javascript
+window.rpc_cb = function(type, value, user_data) {
+  consloe.log(type, value, user_data)
+}
+
+var type = 'openfile'
+window.external.invoke(type + ',' + 'my_data_id');
+// Open a dialog. and call rpc_cb('openfile', 'selected_file_path', "my_data_id") after user choice file.
+
+window.external.invoke('invalid_type' + ',' + 'my_data');
+// if got a error, will call rpc_cb('error', 'invalid_type', 'my_data')
+```
+
+## Javascript RPCs
+
+* close: close this app window, no callback
+* fullscreen: no callback
+* unfullscreen: no callback
+* openfile: Open a dialog, and call rpc_cb('openfile', path, user_data) 
+* opendir: Open a dialog, and call rpc_cb('opendir', path, user_data) 
+* savefile: Open a dialog, and call rpc_cb('savefile', path, user_data) 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/webview.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webview"
+
+# 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/ext/Makefile

@@ -0,0 +1,14 @@
+
+webview_app: ext_package
+	cd webview && go build
+
+ext_package:
+	go get github.com/zserge/webview
+	touch ext_package
+  
+install:
+	mv webview/webview ./webview_app
+
+clean:
+	rm webview_app
+	rm ext_package

data/ext/extconf.rb

@@ -0,0 +1,8 @@
+require 'mkmf'
+
+unless find_executable 'go'
+  puts "Not found go command, please install golang compile environment"
+  exit 1
+end
+
+$makefile_created = true

data/ext/webview/main.go

@@ -0,0 +1,87 @@
+// webview commit 2019-1-23 16c93bcaeaeb6aa7bb5a1432de3bef0b9ecc44f3
+
+package main
+
+import "github.com/zserge/webview"
+import "flag"
+import "fmt"
+import "os"
+import "strings"
+
+func EvalCallback(w webview.WebView, name string, value string, userdata string) {
+  value = strings.ReplaceAll(value, "'", "\\'")
+  userdata = strings.ReplaceAll(userdata, "'", "\\'")
+
+	w.Eval(fmt.Sprintf(`
+    (function(){
+      var cb = window.rpc_cb;
+      if (!cb) {
+        console.error("Not found RPC callback window.rpc_cb")
+        return;
+      }
+      cb('%s', '%s', '%s')
+    })()
+  `, name, value, userdata))
+}
+
+func handleRPC(w webview.WebView, data string) {
+  s := strings.SplitN(data, ",", 2)
+  action, userdata := s[0], s[1]
+
+	switch {
+	case action == "close":
+		w.Terminate()
+	case action == "fullscreen":
+		w.SetFullscreen(true)
+	case action == "unfullscreen":
+		w.SetFullscreen(false)
+  case action == "open":
+    path := w.Dialog(
+      webview.DialogTypeOpen, webview.DialogFlagFile & webview.DialogFlagDirectory,
+      "Select a file or directory", "")
+    EvalCallback(w, action, path, userdata)
+  case action == "openfile":
+    path := w.Dialog(
+      webview.DialogTypeOpen, webview.DialogFlagFile,
+      "Select a file", "")
+    EvalCallback(w, action, path, userdata)
+	case action == "opendir":
+    path := w.Dialog(
+      webview.DialogTypeOpen, webview.DialogFlagDirectory,
+      "Select a directory", "")
+    EvalCallback(w, action, path, userdata)
+  case action == "savefile":
+    path := w.Dialog(webview.DialogTypeSave, 0, "Save file", "")
+    EvalCallback(w, action, path, userdata)
+  default:
+    EvalCallback(w, "error", action, userdata)
+  }
+}
+
+func main() {
+  urlPtr := flag.String("url", "", "App URL")
+  titlePtr := flag.String("title", "MyApp", "App title")
+  widthPtr := flag.Int("width", 1100, "width of window")
+  heightPtr := flag.Int("height", 800, "height of window")
+  debugPtr := flag.Bool("debug", false, "debug mode")
+  resizablePtr := flag.Bool("resizable", false, "Allow resize window")
+
+  flag.Parse()
+
+  if *urlPtr == "" {
+    fmt.Fprintf(os.Stderr, "URL is required\n")
+    os.Exit(1)
+  }
+
+  w := webview.New(webview.Settings{
+		URL: *urlPtr,
+		Title: *titlePtr,
+		Width: *widthPtr,
+		Height: *heightPtr,
+		Resizable: *resizablePtr,
+    Debug: *debugPtr,
+    ExternalInvokeCallback: handleRPC,
+	})
+  defer w.Exit()
+  w.Run()
+}

data/lib/webview/app.rb

@@ -0,0 +1,75 @@
+require 'timeout'
+require 'open3'
+
+module Webview
+  class App
+    attr_reader :app_out, :app_err, :app_process, :options
+
+    def initialize(title: nil, width: nil, height: nil, resizable: nil, debug: false)
+      @options = {
+        title: title,
+        width: width,
+        height: height,
+        resizable: resizable,
+        debug: debug
+      }
+      @options.delete_if { |k, v| v.nil? }
+    end
+
+    def open(url)
+      return true if @app_process
+      cmd = [
+        File.expand_path('ext/webview_app', ROOT_PATH),
+        "-url '#{url}'"
+      ]
+      @options.each do |k, v|
+        case v
+        when true, false then cmd << "-#{k}" if v
+        else cmd << "-#{k} '#{v}'"
+        end
+      end
+      exec_cmd(cmd.join(' '))
+    end
+
+    def close
+      return true unless app_process
+      app_out.close
+      app_err.close
+
+      pid = app_process.pid
+      Process.kill('QUIT', pid)
+      begin
+        Timeout.timeout(3) { Process.wait(pid) }
+      rescue Timeout::Error
+        kill
+      rescue Errno::ECHILD
+      end
+
+      @app_process = nil
+    end
+
+    def join
+      return unless app_process && app_process.alive?
+      Process.wait(app_process.pid)
+    rescue Errno::ECHILD
+    end
+
+    def kill
+      return unless app_process&.pid
+      Process.kill('TERM', app_process.pid)
+    end
+
+    private
+
+    def exec_cmd(cmd)
+      app_in, @app_out, @app_err, @app_process = Open3.popen3(cmd)
+      app_in.close
+      if app_process && app_process.alive?
+        true
+      else
+        false
+      end
+    end
+  end
+
+end

data/lib/webview/version.rb

@@ -0,0 +1,3 @@
+module Webview
+  VERSION = "0.1.0"
+end

data/lib/webview.rb

@@ -0,0 +1,8 @@
+require "webview/version"
+require 'webview/app'
+
+module Webview
+  class Error < StandardError; end
+
+  ROOT_PATH = File.expand_path('../../', __FILE__)
+end

data/webview.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "webview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "webview"
+  spec.version       = Webview::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{Ruby api for zserge/webview project}
+  spec.description   = %q{Ruby api for zserge/webview project}
+  spec.homepage      = "https://github.com/xiejiangzhi/webview"
+  spec.license       = "MIT"
+
+  # 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.extensions    = ['ext/extconf.rb']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: webview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 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'
+description: Ruby api for zserge/webview project
+email:
+- xiejiangzhi@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/Makefile
+- ext/extconf.rb
+- ext/webview/main.go
+- lib/webview.rb
+- lib/webview/app.rb
+- lib/webview/version.rb
+- webview.gemspec
+homepage: https://github.com/xiejiangzhi/webview
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby api for zserge/webview project
+test_files: []