webview_util 0.1.3

data/lib/webview_util/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WebviewUtil
+  VERSION = "0.1.3"
+end

data/lib/webview_util.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "ffi"
+require "ffi-compiler/loader"
+require "json"
+require_relative "webview_util/version"
+
+module WebviewUtil
+  extend FFI::Library
+  ffi_lib FFI::Compiler::Loader.find("webview-ext")
+  attach_function :webview_create,    [:int, :pointer], :pointer
+  attach_function :webview_run,       [:pointer], :void, blocking: true
+  attach_function :webview_terminate, [:pointer], :void
+  attach_function :webview_set_title, [:pointer, :string], :void
+  attach_function :webview_set_size,  [:pointer, :int, :int, :int], :void
+  attach_function :webview_navigate,  [:pointer, :string], :void
+  attach_function :webview_destroy,   [:pointer], :void
+  attach_function :webview_bind,      [:pointer, :string, :pointer, :pointer], :void
+  attach_function :webview_eval,      [:pointer, :string], :void
+  attach_function :webview_init,      [:pointer, :string], :void
+
+  # A minimal wrapper around the webview C library.
+  #
+  # Opens a native OS window (WebKit on macOS/Linux, WebView2 on Windows)
+  # and navigates it to a URL. Blocks in +run+ until the window is closed.
+  #
+  # @example
+  #   wv = WebviewUtil::Window.new(title: "My App", width: 1024, height: 768)
+  #   wv.navigate("http://localhost:9292")
+  #   wv.run
+  class Window
+    # @param title  [String]  window title
+    # @param width  [Integer] initial width in pixels
+    # @param height [Integer] initial height in pixels
+    # @param debug  [Boolean] enable webview devtools / debug mode
+    def initialize(title: "App", width: 1024, height: 768, debug: false)
+      @window = WebviewUtil.webview_create(debug ? 1 : 0, nil)
+      WebviewUtil.webview_set_title(@window, title)
+      WebviewUtil.webview_set_size(@window, width, height, 0)
+    end
+
+    # Navigate the window to +url+.
+    # @param url [String]
+    def navigate(url)
+      WebviewUtil.webview_navigate(@window, url)
+    end
+
+    # Block until the window is closed by the user.
+    #
+    # On Linux/GTK a GLib SIGINT handler is installed at the C level so that
+    # Ctrl+C exits the GTK main loop cleanly.
+    def run
+      WebviewUtil.webview_run(@window)
+    ensure
+      WebviewUtil.webview_destroy(@window)
+    end
+
+    # Programmatically close the window.
+    def terminate
+      WebviewUtil.webview_terminate(@window)
+    end
+
+    # Evaluate JavaScript in the window context.
+    # @param js [String]
+    def eval(js)
+      WebviewUtil.webview_eval(@window, js)
+    end
+
+    # Inject JavaScript that runs before any page script.
+    # @param js [String]
+    def init(js)
+      WebviewUtil.webview_init(@window, js)
+    end
+
+    # Bind a Ruby block to a JavaScript function name.
+    # The block receives parsed JSON arguments.
+    def bind(name, &block)
+      callback = FFI::Function.new(:void, [:string, :string, :pointer]) do |_seq, req, _arg|
+        block.call(*JSON.parse(req))
+      rescue StandardError => e
+        warn "WebviewUtil bind error: #{e.message}"
+        terminate
+      end
+      @bindings ||= []
+      @bindings << callback
+      WebviewUtil.webview_bind(@window, name, callback, nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: webview_util
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Marco Concetto Rudilosso
+- hmdne
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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: ffi-compiler
+  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'
+email:
+- marcoc.r@outlook.com
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/Rakefile
+- ext/webview/webview.cpp
+- ext/webview/webview.h
+- lib/webview_util.rb
+- lib/webview_util/version.rb
+homepage: https://github.com/rbutils/webview_utily
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rbutils/webview_utily
+  source_code_uri: https://github.com/rbutils/webview_utily
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Ruby bindings for webview
+test_files: []