browser_app_base 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb0eb570025887ea6e618a27467df3ca7f8bea72481786a1b6bc41fe7b3b5a86
-  data.tar.gz: 70c09c0eda44c4d8d0dbfe3ea26f907cc06c609415fafd5ab6dc35661a7b8176
+  metadata.gz: 54f5d83ea13920bcfc80e7ecd82c099c5749847535fb593de2f36ff942027555
+  data.tar.gz: 0a692e22ea4182825b0e6dd35c9c483c8e8d41ebbf9387155fcd4b53900b1f29
 SHA512:
-  metadata.gz: 5114a8aecabd7b9434635a0d4368bdcf40f8fc1da03f4171a089a69f5158b0ea04ec4348269eef6096ef66b4cc44a611828278c781b32972f7146f5d1e8b38f5
-  data.tar.gz: 5aeadef51294e212916da7141fe05df0a942c3c0626706e7d08c57cf27de4c88685f08ab2534b15b71cdf2ada3a2a084b79eb1814be7b15e77e38b1c0b52dea8
+  metadata.gz: d2be55260153ca5ea4ff173c72c5a368c5fc020ad426247bb4bdb6d40e875b1a83b56c2d61234a671ed4e650ea79e48bd5bfa0aa3038ba0681405e435d66d721
+  data.tar.gz: 06ba92962030bef3b58a5fb44ea8aa1c6596741fe82a12d40cbcf8bd1d040ddeeaf6e717046714ab76ae7623954b118edaa127ae6cbe0e9a8999770eb0a66db5

data/README.md

@@ -2,9 +2,22 @@
 
 Windows and Linux browser-based desktop application templates.
 
-On Linux, the Chrome browser is used by default.
+On Linux, the Chrome browser is used by default.  
 On Windows, the Edge browser is used by default.
 
+---
+
+## Features
+
+- Cross-platform browser-based desktop app template (Windows/Linux)
+- Simple app generation command (`create_browser_app`)
+- Flexible application settings via `setting.json`
+- Communication between browser UI and Ruby backend
+- RSpec-based test framework (from v0.1.9)
+- Easy browser configuration for each OS
+
+---
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,6 +34,8 @@ Or install it yourself as:
 
     $ gem install browser_app_base
 
+---
+
 ## Usage
 
     create_browser_app [options]
@@ -28,35 +43,43 @@ Or install it yourself as:
      -a, --app app_name               application name
      -h, --help                       command help
 
+---
 
-## Create app templat
+## Create app template
 
     $ create_browser_app -d /path/to/test/ -a MyApp
 
-## add application code
+---
+
+## Add application code
+
     $ cd /path/to/test/
     $ vi my_app.rb
 
 ```ruby
-    class MyApp < AppMainBase
-        def start(argv)
-            super
-            # add application code
-        end
-
-        def stop()
-            super
-            # add application code
-        end
-    end
+class MyApp < AppMainBase
+  def start(argv)
+    super
+    # add application code
+  end
+
+  def stop()
+    super
+    # add application code
+  end
+end
 ```
 
-ui application sample
+---
+
+## UI application sample
 
     index.html
     css/index.css
     js/main.js
 
+---
+
 ## Start application
 
 ```shell
@@ -65,10 +88,13 @@ $ /path/to/test/bin/start_my_app.rb
 
 ![app](img/app.png)
 
-## browser setting
+---
+
+## Browser setting
+
 Configure your browser for Windows or Linux.  
 
-    ${home}/${app_nane}/config/browser.json
+    ${home}/${app_name}/config/browser.json
 
 ```json
 {
@@ -78,23 +104,26 @@ Configure your browser for Windows or Linux.
 }
 ```
 
-## Send a message from your browser application to your ruby application
+---
+
+## Send a message from your browser application to your Ruby application
 
-Use the send_message function.  
+Use the `send_message` function.
 
-main.js sample
+main.js sample:
 ```javascript
 $("#exec").click(function () {
     send_message("exec:" + $("#upFile").val());
 });
-
 ```
 
-## Send a message from the ruby application to the browser application
+---
+
+## Send a message from the Ruby application to the browser application
 
-Use the app_send function.  
+Use the `app_send` function.
 
-my_app_sample.rb sample
+my_app_sample.rb sample:
 ```ruby
 class MyApp < AppMainBase
   def start(argv)
@@ -103,100 +132,189 @@ class MyApp < AppMainBase
 
     # log message
     yield "log message"
-    end
+  end
 end
 ```
 
-## Application Setting 
-You can add settings by modifying setting.json.  
+---
+
+## Application Setting
+
+You can add settings by modifying `setting.json`.
 
-    ${home}/${app_nane}/config/setting.json
+    ${home}/${app_name}/config/setting.json
 
+Example (`setting.json`):
 
 ```json
-[
-  {
-    "name": "name1",
-    "value": "value1 2 3 4",
-    "type": "input",
-    "select": "",
-    "description": "設定項目1"
-  },
-  {
-    "name": "name2",
-    "value": true,
-    "type": "checkbox",
-    "select": "",
-    "description": "有効にする場合はチェック"
-  },
-  {
-    "name": "name3",
-    "value": "2",
-    "type": "select",
-    "select": [
-      "1",
-      "2",
-      "3",
-      "4",
-      "5"
-    ],
-    "description": "選択項目"
-  },
-  {
-    "name": "name4",
-    "value": "value4",
-    "type": "input",
-    "select": "",
-    "description": "設定項目4"
-  },
-  {
-    "name": "name5",
-    "value": "value5",
-    "type": "input",
-    "select": "",
-    "description": "設定項目5"
-  },
-  {
-    "name": "name6",
-    "value": "value6",
-    "type": "input",
-    "select": "",
-    "description": "設定項目6"
-  }
-]
+{
+  "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>}"
+    }
+  ]
+}
 ```
-You can access the settings from your Ruby application like this:  
+
+You can access the settings from your Ruby application like this:
 
 ```ruby
 class MyApp < AppMainBase
   def start(argv)
-    # popup message
-    app_send("popup:message string")
+    # Access a setting value
+    puts @config["name1"]
+    # Access jaon_area as a hash
+    p @config["jaon_area"] # => {"DEBUG"=>true, "VERSION"=>1}
+  end
+end
+```
 
-    # log message
-    yield "log message"
-    end
+---
 
-    # read setting
-    puts @config["name1"]
+### About `jaon_area` in setting.json
+
+The `jaon_area` item in `setting.json` allows you to input a JSON string as a setting value.  
+This field is of type `"textarea"` and is intended for storing flexible, structured data such as additional configuration, flags, or custom parameters.
+
+**Example:**
+```json
+{
+  "DEBUG": true,
+  "VERSION": 1
+}
+```
+
+- You can edit this field directly in the settings screen.
+- The value must be valid JSON format.
+- The application can parse and use this data as needed.
+
+**Use cases:**
+- Toggle debug mode (`"DEBUG": true`)
+- Store version or environment information
+- Save arbitrary key-value pairs for advanced configuration
+
+**How to use in your Ruby application:**
+You can access the `jaon_area` value as a Ruby hash via `@config["jaon_area"]`.  
+For example:
+```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
 ```
 
-Setting menu
-![app](img/setting_menu.png)
+**Note:**  
+Be sure to enter valid JSON. If the format is incorrect, the application may not be able to read the settings properly.
+
+**Tips:**
+- You can use `jaon_area` to store any structured data your application needs at runtime.
+- This is useful for feature flags, environment-specific settings, or any advanced configuration that doesn't fit into a simple string or boolean value.
 
+---
 
-Setting screen
+## Setting menu  
+The following image shows the application's setting menu, where you can access and modify various configuration options.  
+![app](img/setting_menu.png)
+
+Setting screen  
+This image displays the detailed setting screen, allowing you to edit individual configuration items.  
 ![app](img/setting.png)
 
+---
+
+## Running Tests
+
+From v0.1.9, RSpec-based testing is supported.  
+After installing dependencies, you can run tests with:
+
+```sh
+bundle install
+bundle exec rake
+```
+
+or
+
+```sh
+bundle exec rspec
+```
+
+RSpec tasks are defined in the `Rakefile`, so `rake` will automatically run all tests.  
+Place your test code under the `spec/` directory.
+
+---
+
 ## Development
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 the created tag, 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/kuwayama1971/BrowserAppBase.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/kuwayama1971/BrowserAppBase](https://github.com/kuwayama1971/BrowserAppBase).
+
+---
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/browser_app_base/version.rb

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

data/lib/template/config/browser.json

@@ -1,5 +1,6 @@
 {
     "chrome_win": "start msedge",
     "chrome_win_": "start chrome",
-    "chrome_linux": "google-chrome"
+    "chrome_linux_": "google-chrome",
+    "chrome_linux": "chromium-browser"
 }

data/lib/template/config/setting.json

@@ -48,6 +48,16 @@
       "type": "input",
       "select": "",
       "description": "設定項目6"
+    },
+    {
+      "name": "jaon_area",
+      "value": {
+        "DEBUG": true,
+        "VERSION": 1
+      },
+      "type": "textarea",
+      "select": "",
+      "description": "Json文字列<br>例:<br>{<br>  \"DEBUG\":true <br>  \"VERSION\":1<br>}"
     }
   ]
-}
+}

data/lib/template/config.ru

@@ -102,6 +102,6 @@ configure do
 
 end
 
-#\ --port 35983
+#\ --port 34921
 
 run Sinatra::Application