debugvisualizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a8a3162f364560e6455c89c36a29b7d82fd5aa437928b342d6317eb457c0d1b
+  data.tar.gz: c642e62625d02e20ef8d2691bbc737eb365619db984964be01d596b40e60c070
+SHA512:
+  metadata.gz: e1ed30c914a88b7f86b08c77df974bb0e61471428565ad9f73e7a67d9bf3c05503b694ec5f873d7cb1c8908e025e86a70a9f8193f43b5886af903eef4741d300
+  data.tar.gz: 847b26a202f2bf10210635958d5b5ecc460c09a6baf037147c5b900f20f24fa19acb23e1b4e95633197518c0fce480ef476d0993c62ee5ed9a3f066ec47fa8f4

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in debugvisualizer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Naoto Ono
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# DebugVisualizer
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add debugvisualizer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install debugvisualizer
+
+## Usage
+
+### Example
+
+```ruby
+require 'debugvisualizer'
+
+DebugVisualizer.register do |data|
+  if data.is_a?(Hash)
+    {
+      id: "hash_visualizer",
+      name: "Hash",
+      data: {
+          kind: { table: true },
+          rows: [data]
+      }
+    }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/debugvisualizer.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/debugvisualizer.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/debugvisualizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "debugvisualizer"
+  spec.version = DebugVisualizer::VERSION
+  spec.authors = ["Naoto Ono"]
+  spec.email = ["onoto1998@gmail.com"]
+
+  spec.summary = "debugvisualizer generates JSON based on VS Code Debug Visualizer protocol"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/ono-max/debugvisualizer"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/debugvisualizer/active_record.rb

@@ -0,0 +1,24 @@
+
+module DebugVisualizer
+  DebugVisualizer.register do |data|
+    if (defined?(::ActiveRecord::Base) && data.kind_of?(::ActiveRecord::Base)) ||
+       (defined?(::ActiveRecord::Relation) && data.kind_of?(::ActiveRecord::Relation))
+      rows = nil
+      if data.respond_to? :to_a
+        ary = data.to_a
+        rows = ary.map{|elem| elem.attributes}
+      else
+        rows = [data.attributes]
+      end
+
+      {
+        id: "active_record_visualizer",
+        name: "ActiveRecord As Table",
+        data: {
+          kind: { table: true },
+          rows: rows
+        }
+      }
+    end
+  end
+end

data/lib/debugvisualizer/array.rb

@@ -0,0 +1,44 @@
+module DebugVisualizer
+  DebugVisualizer.register do |data|
+    if data.is_a?(Array)
+      new_data = nil
+      name = ""
+      if data.all? {|v| v.is_a?(Integer) || v.is_a?(Float) }
+        new_data = {
+          "kind":{ "plotly": true },
+          "data":[
+              { "y": data },
+          ]
+        }
+        name = "Array As Plot"
+      else
+        columns = []
+        data.each{|elem|
+          columns << {content: elem.to_s, tag: elem.to_s}
+        }
+        new_data = {
+          "kind": { "grid": true },
+          "text": "test",
+          "columnLabels": [
+              {
+                  "label": "test"
+              }
+          ],
+          "rows": [
+              {
+                  "label": "foo",
+                  "columns": columns
+              }
+          ]
+        }
+        name = "Array As Grid"
+      end
+      {
+        id: "array_visualizer",
+        name: name,
+        priority: 30,
+        data: new_data
+      }
+    end
+  end
+end

data/lib/debugvisualizer/hash.rb

@@ -0,0 +1,14 @@
+module DebugVisualizer
+  DebugVisualizer.register do |data|
+    if data.is_a?(Hash)
+      {
+        id: "hash_visualizer",
+        name: "Hash As Table",
+        data: {
+          kind: { table: true },
+          rows: [data]
+        }
+      }
+    end
+  end
+end

data/lib/debugvisualizer/string_diff.rb

@@ -0,0 +1,16 @@
+module DebugVisualizer
+  DebugVisualizer.register do |data|
+    if data.is_a?(Array) && data.size == 2 && data.all? {|elem| elem.is_a?(String)}
+      {
+        id: "string_diff",
+        name: "String diff",
+        priority: 50,
+        data: {
+          kind: { text: true },
+          text: data[0],
+          otherText: data[1]
+        }
+      }
+    end
+  end
+end

data/lib/debugvisualizer/to_string.rb

@@ -0,0 +1,19 @@
+module DebugVisualizer
+  DebugVisualizer.register do |data|
+    {
+      id: "to_string",
+      name: "To String",
+      priority: 1,
+      data: {
+        kind: { text: true },
+        text: inspect(data),
+      }
+    }
+  end
+
+  def self.inspect obj
+    obj.inspect
+  rescue Exception => e
+    "failed to inspect: #{e.message}"
+  end
+end

data/lib/debugvisualizer/version.rb

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

data/lib/debugvisualizer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'json'
+
+module DebugVisualizer
+  def register &block
+    raise unless block_given?
+
+    unless defined? GENERATOR
+      DebugVisualizer.const_set(:GENERATOR, JSONGenerator.new)
+    end
+    GENERATOR.register_block block
+  end
+
+  def to_debug_visualizer_protocol_json preferred_id, data
+    GENERATOR.generate preferred_id, data
+  end
+
+  module_function :register, :to_debug_visualizer_protocol_json
+
+  class JSONGenerator
+    attr_accessor :default_registered
+
+    def initialize
+      @blocks = []
+    end
+
+    def register_block block
+      @blocks << block
+    end
+
+    def generate preferred_id, data
+      extractors = []
+      @blocks.each{|block|
+        result = block.call(data)
+        if result && result[:id] && result[:data]
+          extractors << get_extractor(result)
+        end
+      }
+
+      return JSON.generate({ kind: "NoExtractors" }) if extractors.empty?
+
+      sorted = extractors.sort_by{|ex| -ex[:priority]}
+      used_ex = sorted[0]
+
+      unless preferred_id.empty?
+        sorted.each{|ex|
+          if ex[:id] == preferred_id
+            used_ex = ex
+            break
+          end
+        }
+      end
+      
+
+      data = used_ex.delete(:data)
+
+      sorted.each{|ex| ex.delete :data}
+
+      JSON.generate({
+        kind: "Data",
+        extractionResult: {
+          data: data,
+          usedExtractor: used_ex,
+          availableExtractors: sorted,
+        },
+      })
+    rescue Exception => e
+      JSON.generate({
+        kind: "Error",
+        message: e.message
+      })
+    end
+
+    private
+
+    def get_extractor result
+      {
+        id: result[:id],
+        name: result[:name] || result[:id],
+        priority: result[:priority] || 100,
+        data: result[:data]
+      }
+    end
+  end
+end
+
+require_relative 'debugvisualizer/active_record'
+require_relative 'debugvisualizer/array'
+require_relative 'debugvisualizer/hash'
+require_relative 'debugvisualizer/to_string'
+require_relative 'debugvisualizer/string_diff'

data/sig/debugvisualizer.rbs

@@ -0,0 +1,4 @@
+module DebugVisualizer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: debugvisualizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naoto Ono
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-15 00:00:00.000000000 Z
+dependencies: []
+description: debugvisualizer generates JSON based on VS Code Debug Visualizer protocol
+email:
+- onoto1998@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- debugvisualizer.gemspec
+- lib/debugvisualizer.rb
+- lib/debugvisualizer/active_record.rb
+- lib/debugvisualizer/array.rb
+- lib/debugvisualizer/hash.rb
+- lib/debugvisualizer/string_diff.rb
+- lib/debugvisualizer/to_string.rb
+- lib/debugvisualizer/version.rb
+- sig/debugvisualizer.rbs
+homepage: https://github.com/ono-max/debugvisualizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ono-max/debugvisualizer
+  source_code_uri: https://github.com/ono-max/debugvisualizer
+post_install_message:
+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: 3.2.32
+signing_key:
+specification_version: 4
+summary: debugvisualizer generates JSON based on VS Code Debug Visualizer protocol
+test_files: []