browser_app_base 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f5d83ea13920bcfc80e7ecd82c099c5749847535fb593de2f36ff942027555
-  data.tar.gz: 0a692e22ea4182825b0e6dd35c9c483c8e8d41ebbf9387155fcd4b53900b1f29
+  metadata.gz: e3a2860c691d1d3804149cd68211e0d2ddbc05dd6bc198c27af21c9dc31b82be
+  data.tar.gz: d315366358a5e02d9180a207c950b8872bf230c07d8b6f4bbaefed7fd9db8483
 SHA512:
-  metadata.gz: d2be55260153ca5ea4ff173c72c5a368c5fc020ad426247bb4bdb6d40e875b1a83b56c2d61234a671ed4e650ea79e48bd5bfa0aa3038ba0681405e435d66d721
-  data.tar.gz: 06ba92962030bef3b58a5fb44ea8aa1c6596741fe82a12d40cbcf8bd1d040ddeeaf6e717046714ab76ae7623954b118edaa127ae6cbe0e9a8999770eb0a66db5
+  metadata.gz: 8f786c2046c321408bb51c353df8fe672735b00ed40feae90e38331d3dee32e1535ce476770028af4ceafbccf14bdd5e40e34eddc44136405c02382dd92bec43
+  data.tar.gz: b606cef5fb889cecf391b90dbe829fd6d0d94424958831b79f3ed1c556f9b9adf4b4045347c62f7222df68ea77f83bce42e22184e511cd7249e4a1a3615b9ea4

data/Gemfile

@@ -5,6 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in browser_app_base.gemspec
 gemspec
 
+gem "rack", ">= 3.0"
+gem "rackup"
 gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
+gem "rspec", ">= 0"
+gem "rack-test"
+gem "sinatra"

data/README.md

@@ -18,6 +18,13 @@ On Windows, the Edge browser is used by default.
 
 ---
 
+## Latest Changes
+- Added support for Rack 3
+- Added ruby-lsp environment
+- Added Docker test environment for Ubuntu
+
+---
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -281,6 +288,30 @@ This image displays the detailed setting screen, allowing you to edit individual
 
 ---
 
+## Docker Test Environment
+
+A Docker-based test environment is available for testing the application on Ubuntu.
+This setup uses X11 forwarding to display the browser window on your host machine.
+
+```shell
+$ cd test/docker/ubuntu
+$ docker-compose up -d
+$ docker exec -it ubuntu bash
+```
+
+For Ubuntu 24.04:
+```shell
+$ docker-compose -f docker-compose-24.04.yml up -d
+```
+
+Inside the container:
+```shell
+$ cd /work
+$ rake
+```
+
+---
+
 ## Running Tests
 
 From v0.1.9, RSpec-based testing is supported.  
@@ -294,7 +325,7 @@ bundle exec rake
 or
 
 ```sh
-bundle exec rspec
+RACK_ENV=test bundle exec rspec
 ```
 
 RSpec tasks are defined in the `Rakefile`, so `rake` will automatically run all tests.  

data/README_ja.md

@@ -0,0 +1,351 @@
+# BrowserAppBase
+
+WindowsおよびLinux向けのブラウザベースデスクトップアプリケーションのテンプレートです。
+
+LinuxではデフォルトでChromeブラウザが使用されます。
+WindowsではデフォルトでEdgeブラウザが使用されます。
+
+---
+
+## 機能
+
+- クロスプラットフォームのブラウザベースデスクトップアプリテンプレート（Windows/Linux）
+- シンプルなアプリ生成コマンド (`create_browser_app`)
+- `setting.json` による柔軟なアプリケーション設定
+- ブラウザUIとRubyバックエンド間の通信
+- RSpecベースのテストフレームワーク（v0.1.9以降）
+- OSごとの簡単なブラウザ設定
+
+---
+
+## 最新の変更点
+- Rack 3 をサポートしました
+- ruby-lspの環境を追加しました
+- Ubuntu用のDockerテスト環境を追加しました
+
+---
+
+## インストール
+
+アプリケーションのGemfileに以下の行を追加します：
+
+```ruby
+gem 'browser_app_base'
+```
+
+そして実行します：
+
+    $ bundle install
+
+または、直接インストールします：
+
+    $ gem install browser_app_base
+
+---
+
+## 使い方
+
+    create_browser_app [options]
+     -d, --dir dir_name               アプリケーションのディレクトリ
+     -a, --app app_name               アプリケーション名
+     -h, --help                       コマンドのヘルプ
+
+---
+
+## アプリケーションテンプレートの作成
+
+    $ create_browser_app -d /path/to/test/ -a MyApp
+
+---
+
+## アプリケーションコードの追加
+
+    $ cd /path/to/test/
+    $ vi my_app.rb
+
+```ruby
+class MyApp < AppMainBase
+  def start(argv)
+    super
+    # ここにアプリケーションコードを追加
+  end
+
+  def stop()
+    super
+    # ここにアプリケーションコードを追加
+  end
+end
+```
+
+---
+
+## UIアプリケーションのサンプル
+
+    index.html
+    css/index.css
+    js/main.js
+
+---
+
+## アプリケーションの起動
+
+```shell
+$ /path/to/test/bin/start_my_app.rb
+```
+
+![app](img/app.png)
+
+---
+
+## ブラウザの設定
+
+WindowsまたはLinux用にブラウザを設定します。
+
+    ${home}/${app_name}/config/browser.json
+
+```json
+{
+    "chrome_win": "start msedge",
+    "chrome_win_": "start chrome",
+    "chrome_linux": "/bin/google-chrome"
+}
+```
+
+---
+
+## ブラウザアプリケーションからRubyアプリケーションへのメッセージ送信
+
+`send_message` 関数を使用します。
+
+main.jsのサンプル：
+```javascript
+$("#exec").click(function () {
+    send_message("exec:" + $("#upFile").val());
+});
+```
+
+---
+
+## Rubyアプリケーションからブラウザアプリケーションへのメッセージ送信
+
+`app_send` 関数を使用します。
+
+my_app_sample.rbのサンプル：
+```ruby
+class MyApp < AppMainBase
+  def start(argv)
+    # ポップアップメッセージ
+    app_send("popup:message string")
+
+    # ログメッセージ
+    yield "log message"
+  end
+end
+```
+
+---
+
+## アプリケーションの設定
+
+`setting.json` を変更することで設定を追加できます。
+
+    ${home}/${app_name}/config/setting.json
+
+設定例 (`setting.json`):
+
+```json
+{
+  "version": 0.1,
+  "setting_list": [
+    {
+      "name": "name1",
+      "value": "value1 2 3 4",
+      "type": "input",
+      "select": "",
+      "description": "Setting item 1"
+    },
+    {
+      "name": "name2",
+      "value": true,
+      "type": "checkbox",
+      "select": "",
+      "description": "Check to enable"
+    },
+    {
+      "name": "name3",
+      "value": "3",
+      "type": "select",
+      "select": [
+        "1",
+        "2",
+        "3",
+        "4",
+        "5"
+      ],
+      "description": "Select item"
+    },
+    {
+      "name": "name4",
+      "value": "value4",
+      "type": "input",
+      "select": "",
+      "description": "Setting item 4"
+    },
+    {
+      "name": "name5",
+      "value": "value5",
+      "type": "input",
+      "select": "",
+      "description": "Setting item 5"
+    },
+    {
+      "name": "name6",
+      "value": "value6",
+      "type": "input",
+      "select": "",
+      "description": "Setting item 6"
+    },
+    {
+      "name": "jaon_area",
+      "value": {
+        "DEBUG": true,
+        "VERSION": 1
+      },
+      "type": "textarea",
+      "select": "",
+      "description": "JSON string<br>Example:<br>{<br>  \"DEBUG\": true,<br>  \"VERSION\": 1<br>}"
+    }
+  ]
+}
+```
+
+Rubyアプリケーションからは以下のように設定にアクセスできます：
+
+```ruby
+class MyApp < AppMainBase
+  def start(argv)
+    # 設定値へのアクセス
+    puts @config["name1"]
+    # jaon_areaへのハッシュとしてのアクセス
+    p @config["jaon_area"] # => {"DEBUG"=>true, "VERSION"=>1}
+  end
+end
+```
+
+---
+
+### setting.jsonの `jaon_area` について
+
+`setting.json` の `jaon_area` 項目を使用すると、設定値としてJSON文字列を入力できます。
+このフィールドのタイプは `"textarea"` であり、追加の設定、フラグ、カスタムパラメータなどの柔軟な構造化データを保存することを目的としています。
+
+**例：**
+```json
+{
+  "DEBUG": true,
+  "VERSION": 1
+}
+```
+
+- このフィールドは設定画面で直接編集できます。
+- 値は有効なJSON形式である必要があります。
+- アプリケーションは必要に応じてこのデータを解析して使用できます。
+
+**使用例：**
+- デバッグモードの切り替え (`"DEBUG": true`)
+- バージョンや環境情報の保存
+- 高度な設定のための任意のキーバリューペアの保存
+
+**Rubyアプリケーションでの使用方法：**
+`@config["jaon_area"]` を介してRubyのハッシュとして `jaon_area` の値にアクセスできます。
+例：
+```ruby
+class MyApp < AppMainBase
+  def start(argv)
+    debug_mode = @config["jaon_area"]["DEBUG"]
+    version = @config["jaon_area"]["VERSION"]
+    puts "Debug mode: #{debug_mode}, Version: #{version}"
+  end
+end
+```
+
+**注意：**
+必ず有効なJSONを入力してください。フォーマットが正しくない場合、アプリケーションが設定を正しく読み込めない可能性があります。
+
+**ヒント：**
+- 実行時にアプリケーションが必要とする任意の構造化データを保存するために `jaon_area` を使用できます。
+- これは機能フラグ、環境固有の設定、または単純な文字列や真偽値に収まらない高度な設定に便利です。
+
+---
+
+## 設定メニュー
+以下の画像はアプリケーションの設定メニューを示しており、ここから様々な設定オプションにアクセスして変更できます。
+![app](img/setting_menu.png)
+
+設定画面
+この画像は詳細な設定画面を表示しており、個々の設定項目を編集できます。
+![app](img/setting.png)
+
+---
+
+## Dockerテスト環境
+
+UbuntuでアプリケーションをテストするためのDockerベースのテスト環境が利用可能です。
+この設定ではX11フォワーディングを使用して、ホストマシン上にブラウザウィンドウを表示します。
+
+```shell
+$ cd test/docker/ubuntu
+$ docker-compose up -d
+$ docker exec -it ubuntu bash
+```
+
+Ubuntu 24.04の場合：
+```shell
+$ docker-compose -f docker-compose-24.04.yml up -d
+```
+
+コンテナ内での操作：
+```shell
+$ cd /work
+$ rake
+```
+
+---
+
+## テストの実行
+
+v0.1.9からRSpecベースのテストがサポートされています。
+依存関係をインストールした後、以下のコマンドでテストを実行できます：
+
+```sh
+bundle install
+bundle exec rake
+```
+
+または
+
+```sh
+RACK_ENV=test bundle exec rspec
+```
+
+RSpecタスクは `Rakefile` で定義されているため、`rake` コマンドですべてのテストが自動的に実行されます。
+テストコードは `spec/` ディレクトリの下に配置してください。
+
+---
+
+## 開発
+
+このgemをローカルマシンにインストールするには、`bundle exec rake install` を実行します。
+新しいバージョンをリリースするには、`version.rb` でバージョン番号を更新し、`bundle exec rake release` を実行します。これによりバージョンのgitタグが作成され、gitコミットと作成されたタグがプッシュされ、`.gem` ファイルが [rubygems.org](https://rubygems.org) にプッシュされます。
+
+---
+
+## コントリビューション
+
+バグレポートとプルリクエストはGitHubの [https://github.com/kuwayama1971/BrowserAppBase](https://github.com/kuwayama1971/BrowserAppBase) で歓迎します。
+
+---
+
+## ライセンス
+
+このgemは [MIT License](https://opensource.org/licenses/MIT) の条件の下でオープンソースとして利用可能です。

data/bin/create_browser_app.rb

@@ -1,24 +1,23 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
 require "browser_app_base"
 require "optparse"
 
 opt = OptionParser.new
 o = {}
-opt.on("-d dir_name", "--dir dir_name", "application directory") { |v| o[:dir] = v }
-opt.on("-a app_name", "--app app_name", "application name") { |v| o[:app] = v }
+opt.on("-d DIR_NAME", "--dir DIR_NAME", "application directory") { |v| o[:dir] = v }
+opt.on("-a APP_NAME", "--app APP_NAME", "application name") { |v| o[:app] = v }
 opt.on("-h", "--help", "command help") { puts opt; exit }
 begin
   opt.parse!(ARGV)
-rescue
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
   puts opt
   exit
 end
 
-if o[:dir] == nil
+if o[:dir].nil? || o[:dir].strip.empty?
   puts opt
   exit
 end
 
-BrowserAppBase.create o
+BrowserAppBase.create o

data/bin/ruby-lsp

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby3.2
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-lsp' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("ruby-lsp", "ruby-lsp")

data/bin/ruby-lsp-check

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby3.2
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-lsp-check' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("ruby-lsp", "ruby-lsp-check")

data/bin/ruby-lsp-launcher

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby3.2
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-lsp-launcher' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("ruby-lsp", "ruby-lsp-launcher")

data/bin/ruby-lsp-test-exec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby3.2
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-lsp-test-exec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("ruby-lsp", "ruby-lsp-test-exec")

data/bin/start_sample.rb

@@ -1,15 +1,16 @@
 #!/usr/bin/env ruby
-
+# -*- coding: utf-8 -*-
+$LOAD_PATH << File.dirname(File.expand_path(__FILE__)).gsub(/bin$/, "lib")
 require "fileutils"
-require "facter"
 require "tmpdir"
 require "json"
+require "common"
 
 # tmpdirディレクトリにコピー
 dir = File.dirname(File.expand_path(__FILE__ + "/../"))
-home_dir = ENV["HOME"] + "/" + dir.split("/")[-1].gsub(/-[0-9\.-]+/,"")
+home_dir = ENV["HOME"] + "/" + dir.split("/")[-1].gsub(/-[0-9\.-]+/, "")
 puts "home_dir=#{home_dir}"
-Dir.mktmpdir { |tmpdir|
+Dir.mktmpdir do |tmpdir|
   outdir = tmpdir + "/" + dir.split("/")[-1]
   FileUtils.mkdir_p outdir
   FileUtils.mkdir_p home_dir
@@ -27,8 +28,8 @@ Dir.mktmpdir { |tmpdir|
     end
   end
   begin
-  json = JSON.parse(File.read("#{home_dir}/config/setting.json"))
-  old_version = json["version"]
+    json = JSON.parse(File.read("#{home_dir}/config/setting.json"))
+    old_version = json["version"]
   rescue
     old_version = ""
   end
@@ -39,14 +40,14 @@ Dir.mktmpdir { |tmpdir|
     FileUtils.cp "#{dir}/lib/config/setting.json", "#{home_dir}/config/setting.json"
   end
 
-  FileUtils.cd "#{outdir}"
-  kernel = Facter.value(:kernel)
-  if kernel == "windows"
+  FileUtils.cd outdir
+  kernel = get_os_type
+  if kernel.downcase == "windows"
     system "rubyw ./start.rb"
-  elsif kernel == "Linux"
+  elsif kernel.downcase == "linux"
     system "ruby ./start.rb"
   else
     system "ruby ./start.rb"
   end
   FileUtils.cd ENV["HOME"]
-}
+end

data/browser_app_base.gemspec

@@ -30,12 +30,13 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "rack", ">= 3.0"
+  spec.add_dependency "rackup"
   spec.add_dependency "sinatra"
   spec.add_dependency "sinatra-contrib"
   spec.add_dependency "sinatra-websocket"
   spec.add_dependency "thin"
   spec.add_dependency "json"
-  spec.add_dependency "facter"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/browser_app_base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrowserAppBase
-  VERSION = "0.1.9"
+  VERSION = "0.2.1"
 end