ruby_var_dump 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68bd2adc9a3d1388b40b55dcdcfc8093b719c84341aa05babf48235319ee592d
-  data.tar.gz: 47726151d3cdfe8be8d0a1ba21bbbd203336918c5dcd5277752edfb39741fb6c
+  metadata.gz: 799e399b73739ab114d6779761b0cbe83f412846ed01d80222e8e776eaf91179
+  data.tar.gz: 98c621772c8f09e46576509d89042ccae209e35caf32437f43568f2f9575ec42
 SHA512:
-  metadata.gz: 43e87259f0741c9517d7918c66e6166c92aca62cb3dab44e91b0cf381ad72f556ace05c53a4859a939d014dc7d363e5bf4fdb47be349afca93671acfd6ef4a67
-  data.tar.gz: d698c17ea7903336b094fbba26ae3355c67517c836a6466280d8ed07caa60f68bdcee356c3d06a836d01b51304aa08c6bb50d64184951b9b722a692397626275
+  metadata.gz: b7ea84c346dbd477d62a6dcd3ef3bb7b670d847c9300d48fb08fa2b297f9b28861f9b8ef9d6e231ed45661f9e2402bd3e69ea19b561126ac57383556e91d5ba7
+  data.tar.gz: 51c4decf8a2c4df4a20fae7d69a5b02a3fc1057bbaacf8484dfe8eeeb3ad972d3893cbd47c93f80a50c4bc96a7d0d7f986e65ffe9f43d24b62736dfc260cb667

data/CHANGELOG.md

@@ -1,5 +1,55 @@
-## [Unreleased]
+# Change Log
 
-## [0.1.0] - 2024-04-14
+All notable changes to this project will be documented in this file.
+
+## [0.4.0] - 2026-07-12
+### Changed
+- The gem now automatically includes `RubyVarDump` into `Object` when required. You no longer need to create `config/initializers/setup_ruby_var_dump.rb` or write `Object.include RubyVarDump` manually — just requiring the gem (e.g. adding it to your `Gemfile`) makes `vdump` / `vpp` available on all objects.
+
+> **Note:** Requiring the gem now automatically includes `RubyVarDump` into `Object`. If you previously relied on `require` NOT modifying `Object`, be aware of this behavior change.
+
+### Added
+- Added a global setting `RubyVarDump.assoc` to toggle Active Record association output. Defaults to `1` (ON). Set `RubyVarDump.assoc = 0` to hide associations (`belongs_to` / `has_one` / `has_many` / `has_and_belongs_to_many`), and `RubyVarDump.assoc = 1` to show them again.
+
+## [0.3.0] - 2025-05-07
+### Added
+- Added header at the beginning of output and footer at the end of output
+
+## [0.2.0] - 2025-05-07
+### Added
+- Modified to pick up belongs_to and has_one
+
+## [0.1.6] - 2025-03-22
+### Added
+- I introduced `vpp` as an alias for `vdump`, where vpp stands for visual pretty print. It performs the same function as vdump, enhancing the usability and accessibility of the visual debugging features.
 
-- Initial release
+- Enhanced color coding for output to improve readability and debugging experience:
+  - Numbers are now displayed in blue, making it easier to distinguish numeric data.
+  - Strings are highlighted in salmon pink, helping them stand out in the output.
+  - Active Record relations are shown in red and orange, aiding in differentiation of nested structures within database relationships.
+  - Class objects are represented in green, clarifying type information at a glance.
+
+## [0.1.5] - 2025-02-27
+### Added
+- Changed the method name from dump to vdump.
+
+## [0.1.4] - 2024-05-17
+### Added
+- Added Active Record relation output.
+
+## [0.1.3] - 2024-04-20
+### Added
+- Fixed the implementation of adding a newline at the end.
+
+## [0.1.2] - 2024-04-14
+### Added
+- Add a newline at the end.
+
+## [0.1.1] - 2024-04-14
+### Added
+- `RubyVarDump` module's method added to `Object` class to enhance accessibility.
+
+## [0.1.0] - 2024-04-14
+### Added
+- Initial release of the `ruby_var_dump` gem.
+- Implemented the core functionality for dumping object details.

data/README.md

@@ -1,35 +1,335 @@
-# RubyVarDump
+# ruby_var_dump
 
-TODO: Delete this and the text below, and describe your gem
+A Ruby gem for detailed debugging and inspection of objects, mimicking PHP's `var_dump` function.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby_var_dump`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Usage
 
-## Installation
+Just install the gem and require it — `vdump` (and its alias `vpp`) become available on every object automatically. Here's how to get started:
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+### Installation
 
-Install the gem and add to the application's Gemfile by executing:
+First, add the gem to your application's Gemfile:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem 'ruby_var_dump'
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Then, run the following command to install the gem:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle install
+```
 
-## Usage
+Alternatively, you can install it yourself as:
+
+```bash
+gem install ruby_var_dump
+```
+
+### Example Setup
+
+Here's a simple example. Once the gem is required, `vdump` / `vpp` can be called from anywhere — no `include` is needed:
+
+```ruby
+require 'ruby_var_dump'
+
+class ExampleClass
+  def show_example_usage
+    # Define some example data
+    my_hash = {key1: "value1", key2: 123}
+    my_array = [1, 2, 3, {nested_key: "nested_value"}]
+
+    # Use the vdump method to output the structure of these objects
+    # Or you can use the 'vpp' method as an alias
+    vdump my_hash
+    vdump my_array
+
+    # Alternatively, use the 'vpp' method to achieve the same output
+    vpp my_hash
+    vpp my_array
+  end
+end
+```
+
+Output:
+
+```
+{
+  :key1 => "value1",
+  :key2 => 123
+}
+=> nil
+
+[
+  1,
+  2,
+  3,
+  {
+    :nested_key => "nested_value"
+  }
+]
+=> nil
+```
+
+### Usage in Rails
+
+Just add it to your `Gemfile`:
+
+```ruby
+gem 'ruby_var_dump'
+```
+
+That's it. When the gem is loaded, it automatically includes the `RubyVarDump` module into the Ruby `Object` class, so the `vdump` method is globally available across all objects. **No initializer file is required.**
+
+> In earlier versions you had to create `config/initializers/setup_ruby_var_dump.rb` and write `Object.include RubyVarDump` yourself. This is no longer necessary.
+
+> **Note (behavior change in 0.4.0):** Requiring the gem now automatically includes `RubyVarDump` into `Object`.
+> If you previously relied on `require` NOT modifying `Object`, be aware of it.
+
+### Toggling Active Record association output
+
+By default, when you dump an Active Record object its associations (`belongs_to` / `has_one` / `has_many` / `has_and_belongs_to_many`) are also printed. You can turn this off globally via `RubyVarDump.assoc`:
+
+```ruby
+RubyVarDump.assoc = 0   # hide associations
+vpp my_record           # only the record's own attributes are printed
+
+RubyVarDump.assoc = 1   # show associations again (this is the default)
+vpp my_record
+```
+
+The default is `1` (ON).
+
+### method
+
+#### vdump ( or 'vpp' as alias )
+You can use `vdump` or `vpp` to print the structure of any Ruby object. Here's how you can use it:
+
+vdump or vpp (alias of vdump)
+```ruby
+vdump "abc"
+ or
+vpp "abc"
+```
+
+Output
+```
+"abc"
+=> nil
+```
+
+Example with a more complex structure:
+```ruby
+item = {key1: "value1", key2: 1024, key3: {key4: {key5: "value5", key6: [11,22]}}}
+
+vdump item
+ or
+vpp item
+```
+
+Output:
+
+```
+{
+  :key1 => "value1",
+  :key2 => 1024,
+  :key3 => {
+    :key4 => {
+      :key5 => "value5",
+      :key6 => [
+        11,
+        22
+      ]
+    }
+  }
+}
+=> nil
+```
+
+### vpp (alias of vdump)
+`vpp`, an alias for `vdump`, stands for "visual pretty print" and can be used interchangeably to achieve the same functionality. 
+
+
+### versions
+
+In this way, arrays, hashes, and other objects are output graphically.
+
+Version 0.1.4: added support for Active Record output.
+
+Version 0.1.5: changed the method name from dump to vdump.
+
+Version 0.1.6: created the alias vpp, which stands for "visual pretty print".
+
+Version 0.2.0: modified to pick up belongs_to and has_one.
+
+Version 0.3.0: added header at the beginning of output and footer at the end of output
+
+Version 0.4.0: the gem now automatically includes `RubyVarDump` into `Object` on require, so no initializer file (`Object.include RubyVarDump`) is needed anymore. Also added the `RubyVarDump.assoc` setting to toggle Active Record association output (default `1` = ON; set to `0` to hide associations)
+
+
+
+# ruby_var_dump 日本語の説明
+
+PHPの `var_dump` 関数を模倣した、オブジェクトの詳細なデバッグ・検査を行うためのRuby用Gemです。
+
+## 使用方法
+
+gem をインストールして `require` するだけで、`vdump`（およびそのエイリアス `vpp`）がすべてのオブジェクトで自動的に使えるようになります。以下で始め方を説明します。
+
+### インストール
+
+まず、アプリケーションのGemfileに以下を追加してください：
+
+```ruby
+gem 'ruby_var_dump'
+```
+
+その後、以下のコマンドでインストール：
+
+```bash
+bundle install
+```
+
+もしくは、以下のコマンドで手動インストールも可能です：
+
+```bash
+gem install ruby_var_dump
+```
+
+### 使用例
+
+`require` した後は、`vdump` / `vpp` をどこからでも呼び出せます（`include` は不要です）：
+
+```ruby
+require 'ruby_var_dump'
+
+class ExampleClass
+  def show_example_usage
+    # 出力例のデータ
+    my_hash = {key1: "value1", key2: 123}
+    my_array = [1, 2, 3, {nested_key: "nested_value"}]
+
+    # vdump または vpp メソッドで構造を出力
+    vdump my_hash
+    vdump my_array
+
+    # vpp を使用しても同様の出力
+    vpp my_hash
+    vpp my_array
+  end
+end
+```
+
+出力例：
+
+```
+{
+  :key1 => "value1",
+  :key2 => 123
+}
+=> nil
+
+[
+  1,
+  2,
+  3,
+  {
+    :nested_key => "nested_value"
+  }
+]
+=> nil
+```
+
+### Railsでの利用方法
+
+`Gemfile` に追加するだけです：
+
+```ruby
+gem 'ruby_var_dump'
+```
+
+これで完了です。gem が読み込まれると自動的に RubyVarDump モジュールが Rubyの `Object` クラスにインクルードされ、アプリケーション全体で `vdump` メソッドが利用可能になります。
+
+> 以前のバージョンでは `config/initializers/setup_ruby_var_dump.rb` を作成し、自分で `Object.include RubyVarDump` を記述する必要がありましたが、現在は不要になりました。
+
+> **注意（0.4.0での挙動変化）:** gem を require すると自動的に `RubyVarDump` が `Object` にインクルードされます。
+`require` が `Object` を変更しないことを前提にしていた場合はご注意ください。
+
+### アソシエーション表示の切り替え
+
+Active Record オブジェクトをダンプすると、デフォルトではアソシエーション（`belongs_to` / `has_one` / `has_many` / `has_and_belongs_to_many`）も一緒に出力されます。これは `RubyVarDump.assoc` でグローバルに切り替えられます：
+
+```ruby
+RubyVarDump.assoc = 0   # アソシエーションを非表示
+vpp my_record           # そのレコード自身の属性だけを出力
+
+RubyVarDump.assoc = 1   # 再びアソシエーションを表示（デフォルト）
+vpp my_record
+```
+
+デフォルトは `1`（ON）です。
+
+### 提供メソッド
+
+#### vdump（およびそのエイリアス `vpp`）
+
+`vdump` または `vpp` を使用して、任意のRubyオブジェクトの構造を視覚的に出力できます。
+
+```ruby
+vdump "abc"
+# または
+vpp "abc"
+```
+
+出力例：
+
+```
+"abc"
+=> nil
+```
+
+複雑な構造の変数の出力例：
+
+```ruby
+item = {key1: "value1", key2: 1024, key3: {key4: {key5: "value5", key6: [11,22]}}}
+
+vdump item
+# または
+vpp item
+```
 
-TODO: Write usage instructions here
+出力：
 
-## Development
+```
+{
+  :key1 => "value1",
+  :key2 => 1024,
+  :key3 => {
+    :key4 => {
+      :key5 => "value5",
+      :key6 => [
+        11,
+        22
+      ]
+    }
+  }
+}
+=> nil
+```
 
-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.
+### `vpp`（`vdump` の別名）
 
-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).
+`vpp` は `visual pretty print` の略で、`vdump` と同じ機能を持つエイリアスメソッドです。
 
-## Contributing
+---
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_var_dump.
+## バージョン履歴
 
-## License
+このGemは、配列、ハッシュ、およびその他のオブジェクトの構造を視覚的に出力することができます。
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+- **v0.1.4**: Active Recordの出力に対応
+- **v0.1.5**: メソッド名を `dump` から `vdump` に変更
+- **v0.1.6**: `vpp`（visual pretty print）という別名を追加
+- **v0.2.0**: `belongs_to` および `has_one` の関連を出力対象に追加
+- **v0.3.0**: 出力の開始と終了時に区切り線を追加
+- **v0.4.0**: require 時に自動的に `RubyVarDump` を `Object` へインクルードするようにし、初期化ファイル（`Object.include RubyVarDump`）を不要にした。あわせて、Active Record のアソシエーション出力を切り替える `RubyVarDump.assoc` 設定を追加（デフォルト `1`＝ON、`0` で非表示）

data/lib/ruby_var_dump/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyVarDump
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/ruby_var_dump.rb

@@ -5,6 +5,21 @@ require_relative "ruby_var_dump/version"
 module RubyVarDump
   class Error < StandardError; end
 
+  # アソシエーション（belongs_to / has_many など）を出力するかどうかのグローバル設定。
+  # デフォルトは 1 (ON)。`RubyVarDump.assoc = 0` で OFF にできる。
+  class << self
+    attr_writer :assoc
+
+    def assoc
+      @assoc.nil? ? 1 : @assoc
+    end
+
+    # 0 / false / nil のときだけ非表示。それ以外（1 など）は表示。
+    def show_associations?
+      !(assoc == 0 || assoc == false || assoc.nil?)
+    end
+  end
+
   # カラーコードの定義
   RED_COLOR = "\e[38;5;196m"    # 赤色
   LIGHT_RED_COLOR = "\e[38;5;203m" # サーモンピンク
@@ -90,8 +105,10 @@ module RubyVarDump
           print "#{indent}  #{attr_name}: #{colorize_by_type(attr_value)},\n"
         end
       end
-      # リレーションも再帰的にダンプ
+      # リレーションも再帰的にダンプ（assoc 設定が ON のときのみ）
       obj.class.reflect_on_all_associations.each do |association|
+        break unless RubyVarDump.show_associations?
+
         next if association.macro.nil? # アソシエーションが存在しない場合はスキップ
 
         associated_value = obj.send(association.name)
@@ -186,4 +203,8 @@ module RubyVarDump
     end
   end
 end
+
+# require するだけで全オブジェクトから vdump / vpp を呼べるように、
+# gem 側で自動的に Object へ include する。
+Object.include(RubyVarDump)
 # gem build ruby_var_dump.gemspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_var_dump
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - hirokiyam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-15 00:00:00.000000000 Z
+date: 2026-07-12 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem for detailed debugging and inspection of objects, mimicking
   PHP's var_dump function.
@@ -19,7 +19,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".rspec_status"
 - ".standard.yml"
 - CHANGELOG.md
 - LICENSE.txt
@@ -51,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A Ruby gem for detailed debugging and inspection of objects.

data/.rspec_status

@@ -1,18 +0,0 @@
-example_id                              | status | run_time        |
---------------------------------------- | ------ | --------------- |
-./spec/ruby_var_dump_spec.rb[1:1:1]     | passed | 0.00134 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:2:1]   | passed | 0.00169 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:2:2]   | passed | 0.00006 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:2:3]   | passed | 0.0004 seconds  |
-./spec/ruby_var_dump_spec.rb[1:1:3:1:1] | passed | 0.00004 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:3:1:2] | passed | 0.00003 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:3:2:1] | passed | 0.00005 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:3:2:2] | passed | 0.00004 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:3:3:1] | passed | 0.00012 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:3:3:2] | passed | 0.00004 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:4:1]   | passed | 0.00014 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:4:2]   | passed | 0.00005 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:5:1]   | passed | 0.00016 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:5:2]   | passed | 0.00004 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:6:1]   | passed | 0.00006 seconds |
-./spec/ruby_var_dump_spec.rb[1:1:7:1]   | passed | 0.0001 seconds  |