python_uml_class 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57d9b2f9c5e9a33f0ddad879342573239dfd191c4f157db560cc65288478c6ad
-  data.tar.gz: 16108c011929af51026809c24ff5d75647109869b43aa1d5cac02b1a1008cf55
+  metadata.gz: d435129de73a27c2496f0a9e11a842eafa98e207992a60bec4ccbdfdceba5317
+  data.tar.gz: c270fe9e35fec84ec6dc785be1b144d9539a9e0b2d8ed99feec47b0b6ff7066f
 SHA512:
-  metadata.gz: ae1adf4ebc0faefebd3a64a81b259453a4c6ba2adca2ced788371cc901416c5f90703653f7c6479cb82ee30684c0a969e5862b82b3db8f3fa3a69468ea6cd2a9
-  data.tar.gz: 4b8ccf75957dae5936bf478b915cfa45e6b7b9deccadfbec7c97613b4d70091d3016030b47c0876544ba09213b56e79c793a81d084225bc55521991d4431b631
+  metadata.gz: 12db394eab5180b1085d411bba1750b46b3c90448b93ef54f984b5d1f6538e5782d4bfaf4cf3c5c1efdee0eaccc0b575edaa225ecca38078f67ba8625c8e3ac9
+  data.tar.gz: cef0a8ba1f172ba4f0545a61f7745d9d1b28deaae211dc2e0ecef9549b1c7990b1ffbed614c66a616f685b4151b1eb605d5dedc681e7f1006d502b9244842bdb

data/.rspec_status

@@ -0,0 +1,13 @@
+example_id                             | status | run_time        |
+-------------------------------------- | ------ | --------------- |
+./spec/PythonUmlClass_spec.rb[1:1]     | passed | 0.00068 seconds |
+./spec/create_uml_class_spec.rb[1:1:1] | passed | 0.00038 seconds |
+./spec/create_uml_class_spec.rb[1:1:2] | passed | 0.00008 seconds |
+./spec/create_uml_class_spec.rb[1:2:1] | passed | 0.00007 seconds |
+./spec/create_uml_class_spec.rb[1:2:2] | passed | 0.00006 seconds |
+./spec/create_uml_class_spec.rb[1:3:1] | passed | 0.00819 seconds |
+./spec/create_uml_class_spec.rb[1:3:2] | passed | 0.00183 seconds |
+./spec/create_uml_class_spec.rb[1:3:3] | passed | 0.00176 seconds |
+./spec/create_uml_class_spec.rb[1:3:4] | passed | 0.00141 seconds |
+./spec/test_vars_spec.rb[1:1]          | passed | 0.00508 seconds |
+./spec/test_vars_spec.rb[1:2]          | passed | 0.00081 seconds |

data/Gemfile

@@ -8,3 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+
+gem "rack", ">= 3.0"
+gem "rackup"

data/Gemfile.lock

@@ -1,86 +1,101 @@
 PATH
   remote: .
   specs:
-    python_uml_class (0.1.0)
+    python_uml_class (0.2.1)
       browser_app_base (~> 0.1)
       facter (~> 4.2)
+      rack (>= 3.0)
+      rackup
+      webrick
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
-    base64 (0.2.0)
-    browser_app_base (0.1.7)
-      facter
+    addressable (2.8.9)
+      public_suffix (>= 2.0.2, < 8.0)
+    base64 (0.3.0)
+    browser_app_base (0.2.0)
       json
       sinatra
       sinatra-contrib
       sinatra-websocket
       thin
     daemons (1.4.1)
-    diff-lcs (1.5.0)
+    diff-lcs (1.6.2)
     em-websocket (0.3.8)
       addressable (>= 2.1.1)
       eventmachine (>= 0.12.9)
     eventmachine (1.2.7)
-    facter (4.5.1)
+    facter (4.10.0)
       hocon (~> 1.3)
-      thor (>= 1.0.1, < 2.0)
+      thor (>= 1.0.1, < 1.3)
     hocon (1.4.0)
-    json (2.7.1)
-    multi_json (1.15.0)
-    mustermann (3.0.0)
+    json (2.19.3)
+    logger (1.7.0)
+    multi_json (1.19.1)
+    mustermann (3.0.4)
       ruby2_keywords (~> 0.0.1)
-    public_suffix (5.0.4)
-    rack (2.2.8)
-    rack-protection (3.2.0)
+    public_suffix (7.0.5)
+    rack (3.2.5)
+    rack-protection (4.2.1)
       base64 (>= 0.1.0)
-      rack (~> 2.2, >= 2.2.4)
-    rake (13.1.0)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rackup (2.3.1)
+      rack (>= 3)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
     ruby2_keywords (0.0.5)
-    sinatra (3.2.0)
+    sinatra (4.2.1)
+      logger (>= 1.6.0)
       mustermann (~> 3.0)
-      rack (~> 2.2, >= 2.2.4)
-      rack-protection (= 3.2.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.2.1)
+      rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    sinatra-contrib (3.2.0)
+    sinatra-contrib (4.2.1)
       multi_json (>= 0.0.2)
       mustermann (~> 3.0)
-      rack-protection (= 3.2.0)
-      sinatra (= 3.2.0)
+      rack-protection (= 4.2.1)
+      sinatra (= 4.2.1)
       tilt (~> 2.0)
-    sinatra-websocket (0.3.1)
+    sinatra-websocket (0.3.0)
       em-websocket (~> 0.3.6)
       eventmachine
-      thin (>= 1.3.1, < 2.0.0)
-    thin (1.8.2)
+      thin (>= 1.3.1)
+    thin (2.0.1)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
-      rack (>= 1, < 3)
-    thor (1.3.0)
-    tilt (2.3.0)
+      logger
+      rack (>= 1, < 4)
+    thor (1.2.2)
+    tilt (2.7.0)
+    webrick (1.9.2)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   python_uml_class!
+  rack (>= 3.0)
+  rackup
   rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.4.21
+   2.4.20

data/README.md

@@ -1,10 +1,14 @@
 # PythonUmlClass
 Create a python class diagram
 
+Read this in other languages: [English](README.md), [日本語](README_JA.md)
+
 ## Setup
     for ubuntu
     $ sudo apt install plantuml
-    $ apt install -y pip
+    $ sudo apt install python3.12-venv
+    $ python3 -m venv .venv
+    $ source .venv/bin/activate
     $ pip install astor
 
     install google-chrome
@@ -29,6 +33,59 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ![class](img/class.png)
 
+## Release Notes
+
+### v0.2.1
+- **Feature**: Added `python_path` setting in `setting.json` to allow specifying a custom Python path when executing the formatter script.
+- **Feature**: Added `class_color` and `color_class_name` settings in `setting.json`. Classes matching the `color_class_name` regular expression will be displayed with the specified `class_color` along with their inheritance (`-|>`) and composition (`*--`) relationship lines.
+- **Enhancement**: Improved the extraction of class compositions to properly detect class instantiations inside parentheses (e.g., `chat_history.append(HumanMessage(content=...))`).
+- **Enhancement**: Modified class extraction to output fully qualified module names (e.g., `langchain_core.messages.HumanMessage`) when an alias or module path is specified via `from module import Class` or `import module as alias`.
+- **Enhancement**: Filtered the extracted objects to include only the classes explicitly imported or defined locally within the parsed file.
+- **Enhancement**: Updated `README.md` to include instructions for setting up a Python virtual environment (`python3 -m venv .venv`).
+- **Bug Fix**: Addressed an issue where variables defined with `class_` prefix (like `class_var`) or variables without assignments but containing type hints (like `global_var: int`) were incorrectly identified.
+- **Bug Fix**: Fixed a bug where multi-line strings (`"""` or `'''`) or empty lines containing whitespace only within class functions caused indentation miscalculations, leading to local variables being improperly recognized as class or global variables.
+- **Bug Fix**: Fixed `uninitialized constant Rack::Server` error and improved Rack 3 support by unifying the server usage to `Rackup::Server` while maintaining backward compatibility with `Rack::Server` for older Rack 2 environments.
+- **Bug Fix**: Fixed an issue where the WebSocket connection URL in `main.js` was missing or updating to the wrong port.
+- **Bug Fix**: Resolved `SinatraWebsocket::Error::ConfigurationError` by explicitly passing `:server => 'thin'` to ensure websockets work smoothly in async environments.
+- **Bug Fix**: Handled an `Encoding::CompatibilityError` where incoming WebSocket messages from the browser were incorrectly interpreted as `US-ASCII`. They are now correctly parsed as `UTF-8`.
+- **Bug Fix**: Fixed a crash `no implicit conversion of nil into String` in `create_uml_class.rb` which occurred when `@config` was `nil`.
+
+## Testing with Docker
+
+You can use Docker to set up a development and testing environment for Ubuntu 22.04 and 24.04.
+
+1. Move to `test/docker/ubuntu`.
+    ```bash
+    $ cd test/docker/ubuntu
+    ```
+
+2. Build and start the container using docker compose.
+   - For Ubuntu 22.04:
+     ```bash
+     $ docker compose up -d --build
+     ```
+   - For Ubuntu 24.04:
+     ```bash
+     $ docker compose -f docker-compose-24.04.yml up -d --build
+     ```
+
+3. Log in to the container to run tests or the application. (The source code is mounted at `/work` inside the container)
+   - For Ubuntu 22.04:
+     ```bash
+     $ docker exec -it ubuntu bash
+     ```
+   - For Ubuntu 24.04:
+     ```bash
+     $ docker exec -it ubuntu-24.04 bash
+     ```
+
+4. Run tests inside the container.
+    ```bash
+    $ cd /work
+    $ bundle install
+    $ bundle exec rspec
+    ```
+
 ## 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 [pythongems.org](https://pythongems.org).
@@ -39,4 +96,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/kuwaya
 
 ## 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/README_JA.md

@@ -0,0 +1,99 @@
+# PythonUmlClass
+Pythonのクラス図を作成します。
+
+他の言語で読む: [English](README.md), [日本語](README_JA.md)
+
+## セットアップ
+    Ubuntuの場合
+    $ sudo apt install plantuml
+    $ sudo apt install python3.12-venv
+    $ python3 -m venv .venv
+    $ source .venv/bin/activate
+    $ pip install astor
+
+    Google Chromeのインストール
+    $ echo "deb http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google.list
+    $ wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
+    $ apt update
+    $ apt -y install google-chrome-stable
+
+## インストール
+
+アプリケーションのGemfileに以下を追加してインストールします:
+
+    $ bundle add python_uml_class
+
+bundlerを使用していない場合は、以下のコマンドでgemをインストールします:
+
+    $ gem install python_uml_class
+
+## 使用方法
+
+    $ start_python_uml_class.rb
+
+![class](img/class.png)
+
+## リリースノート
+
+### v0.2.1
+- **機能追加**: `setting.json` に `python_path` 設定を追加し、フォーマッターのスクリプトを実行する際の Python のパスを指定可能にしました。
+- **機能追加**: `setting.json` に `class_color` と `color_class_name` 設定を追加。`color_class_name` の正規表現に部分一致するクラスは、PlantUML出力時にクラス自体の背景色と、そのクラスへ繋がる継承 (`-|>`) やコンポジション (`*--`) の矢印線の色が `class_color` で指定した色になります。
+- **改善**: コンポジション関係の抽出処理（クラスの初期化）を強化し、括弧内の呼び出し（例: `chat_history.append(HumanMessage(content=...))`）であってもクラスのインスタンス化を正しく検出できるようにしました。
+- **改善**: `from ... import ...` や `import ... as ...` などでインポートされたクラスを利用する際、元の完全修飾名（例: `langchain_core.messages.HumanMessage`）を復元してUMLに正しく出力するように修正しました。
+- **改善**: クラスの初期化（コンポジション）において、同じファイル内で定義されたクラスか、明示的にインポートされたクラスのみを対象とするようにフィルタリング処理を強化しました。
+- **改善**: `README.md` に Pythonの仮想環境（venv）のセットアップ手順を追記しました。
+- **バグ修正**: `class_var` のように名前に `class` を含む変数が誤ってクラス宣言として認識される問題や、型ヒントのみ（`global_var: int` など）で代入を伴わないクラス変数・外部変数が正しく抽出されない問題を修正しました。
+- **バグ修正**: クラス内の関数（メソッド）に空白のみの空行や、マルチライン文字列（`"""` や `'''`）が含まれる場合、インデントレベルが誤認されて以降のローカル変数が「クラス変数」や「外部変数（グローバル）」として誤って抽出・出力されるバグを修正しました。
+- **バグ修正**: Rack 3環境での `uninitialized constant Rack::Server` エラーを修正。サーバー起動処理を `Rackup::Server` に統一し、古いRack 2環境でも動作するように後方互換性を持たせました。
+- **バグ修正**: `main.js` 内の WebSocket 接続URLのポート番号が正しく書き換わらない問題を修正しました。
+- **バグ修正**: 非同期サーバーである Thin を明示的に指定することで、WebSocket接続時の `SinatraWebsocket::Error::ConfigurationError` を解決しました。
+- **バグ修正**: WebSocket通信において、ブラウザから受信した文字列が `US-ASCII` として解釈されてしまうことで起きるエンコーディングエラー（`Encoding::CompatibilityError`）を修正し、`UTF-8` として処理するようにしました。
+- **バグ修正**: `create_uml_class.rb` において、`@config` が `nil` の時に `no implicit conversion of nil into String` エラーが発生してクラッシュする問題を修正しました。
+
+## Dockerでのテスト環境構築
+
+Dockerを使用して開発・テスト環境（Ubuntu 22.04、および24.04）を構築できます。
+
+1. `test/docker/ubuntu` に移動します。
+    ```bash
+    $ cd test/docker/ubuntu
+    ```
+
+2. docker composeを使用してコンテナをビルド・起動します。
+   - Ubuntu 22.04 の場合:
+     ```bash
+     $ docker compose up -d --build
+     ```
+   - Ubuntu 24.04 の場合:
+     ```bash
+     $ docker compose -f docker-compose-24.04.yml up -d --build
+     ```
+
+3. コンテナにログインしてテストやアプリケーションの実行を行います。（ソースコードはコンテナ内の `/work` にマウントされています）
+   - Ubuntu 22.04 の場合:
+     ```bash
+     $ docker exec -it ubuntu bash
+     ```
+   - Ubuntu 24.04 の場合:
+     ```bash
+     $ docker exec -it ubuntu-24.04 bash
+     ```
+
+4. コンテナ内でテストを実行します。
+    ```bash
+    $ cd /work
+    $ bundle install
+    $ bundle exec rspec
+    ```
+
+## 開発
+
+このgemをローカルマシンにインストールするには、`bundle exec rake install`を実行します。新しいバージョンをリリースするには、`version.rb`のバージョン番号を更新してから、`bundle exec rake release`を実行します。これにより、バージョンのgitタグが作成され、コミットとタグがプッシュされ、`.gem`ファイルが[pythongems.org](https://pythongems.org)にプッシュされます。
+
+## コントリビューション
+
+バグレポートとプルリクエストはGitHub https://github.com/kuwayama1971/PythonUmlClass で歓迎します。
+
+## ライセンス
+
+このgemは[MIT License](https://opensource.org/licenses/MIT)の条件の下でオープンソースとして利用可能です。

data/lib/config/setting.json

@@ -1,5 +1,5 @@
 {
-  "version": 0.1,
+  "version": 0.2,
   "setting_list": [
     {
       "name": "plantuml",
@@ -8,6 +8,13 @@
       "select": "",
       "description": "PlantUMLコマンド"
     },
+    {
+      "name": "python_path",
+      "value": " ~/.python3_venv/bin/python3",
+      "type": "input",
+      "select": "",
+      "description": "pythonのパス"
+    },
     {
       "name": "formatter_path",
       "value": "./del_comment.py",
@@ -38,10 +45,24 @@
     },
     {
       "name": "exclude_path",
-      "value": "",
+      "value": "/venv/",
       "type": "input",
       "select": "",
       "description": "除外するパス（正規表現）"
+    },
+    {
+      "name": "class_color",
+      "value": "LightBlue",
+      "type": "input",
+      "select": "",
+      "description": "特定クラスの色"
+    },
+    {
+      "name": "color_class_name",
+      "value": "(langchain)",
+      "type": "input",
+      "select": "",
+      "description": "色を付けるクラスの正規表現"
     }
   ]
 }

data/lib/config.ru

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