tk_inspect 0.1.0

data/lib/tk_inspect/console.rb

@@ -0,0 +1,2 @@
+require_relative './console/base'
+require_relative './console/root_component'

data/lib/tk_inspect/console/base.rb

@@ -0,0 +1,118 @@
+module TkInspect
+  module Console
+    class Base
+      cattr_accessor :main_console
+
+      attr_accessor :tk_root
+      attr_accessor :main_component
+      attr_accessor :eval_binding
+      attr_accessor :modal
+      attr_accessor :root
+
+      def initialize(options = {})
+        @tk_root = nil
+        @main_component = nil
+        @eval_binding = binding
+        @modal = !!options[:modal]
+        @root = !!options[:root]
+      end
+
+      def make_main
+        self.class.main_console = self
+      end
+
+      def focus
+        create_root if @main_component.nil?
+        @tk_root.focus
+        @tk_root.tk_item.native_item.after(100) { @main_component.focus_on_code }
+      end
+
+      def refresh
+        @main_component.regenerate
+        @main_component.focus
+      end
+
+      def modal_loop
+        @main_component.run_modal_loop
+      end
+
+      def execute(code)
+        eval(code, eval_binding)
+      end
+
+      def say(s)
+        main_component.show_output(s)
+        return nil
+      end
+
+      def open_inspector(expression = nil)
+        if expression.present?
+          val = eval(expression, eval_binding)
+          TkInspect::Inspector::Base
+            .inspector_for_object(val)
+            .new(expression: expression,
+                 binding: eval_binding,
+                 value: val).refresh
+        else
+          TkInspect::Inspector::Base
+            .new(expression: expression,
+                 binding: eval_binding).refresh
+        end
+      end
+
+      def open_class_browser
+        TkInspect::ClassBrowser::Base.new.refresh
+      end
+
+      def create_root
+        @tk_root = TkComponent::Window.new(title: "Ruby Console", root: @root)
+        @main_component = RootComponent.new
+        @main_component.console = self
+        @tk_root.place_root_component(@main_component)
+        create_menu
+        @tk_root.tk_item.native_item.after(100) { @main_component.focus_on_code }
+      end
+
+      def create_menu
+        @menubar = TkMenu.new(@tk_root.tk_item.native_item)
+        @menu = {}
+        file = TkMenu.new(@menubar)
+        @menu[:file] = file
+        edit = TkMenu.new(@menubar)
+        @menu[:edit] = edit
+        edit.add :command, label: "Undo", accelerator: 'Command+z', command: -> { Tk.event_generate(Tk.focus, "<Undo>") }
+        edit.add :command, label: "Redo", accelerator: 'Command+Shift+z', command: -> { Tk.event_generate(Tk.focus, "<Redo>") }
+        edit.add :separator
+        edit.add :command, label: "Cut", accelerator: 'Command+x', command: -> { Tk.event_generate(Tk.focus, "<Cut>") }
+        edit.add :command, label: "Copy", accelerator: 'Command+c', command: -> { Tk.event_generate(Tk.focus, "<Copy>") }
+        edit.add :command, label: "Paste", accelerator: 'Command+v', command: -> { Tk.event_generate(Tk.focus, "<Paste>") }
+        edit.add :command, label: "Clear", accelerator: 'Delete', command: -> { Tk.event_generate(Tk.focus, "<Clear>") }
+        view = TkMenu.new(@menubar)
+        @menu[:view] = view
+        view.add :command, label: "Bigger font", accelerator: 'Command++', command: -> { main_component.zoom_in(nil) }
+        view.add :command, label: "Smaller font", accelerator: 'Command+-', command: -> { main_component.zoom_out(nil) }
+        tools = TkMenu.new(@menubar)
+        @menu[:tools] = tools
+        tools.add :command, label: "Run selection", accelerator: 'Command+r', command: -> { main_component.run_selected(nil) }
+        tools.add :command, label: "Inspect selection", accelerator: 'Command+i', command: -> { main_component.inspect_selected(nil) }
+        tools.add :separator
+        tools.add :command, label: "Clear output", accelerator: 'Command+k', command: -> { main_component.clear_output(nil) }
+        tools.add :separator
+        tools.add :command, label: "Inspector ...", accelerator: 'Command+Shift+i', command: -> { open_inspector }
+        tools.add :command, label: "Class Browser ...", accelerator: 'Command+Shift+b', command: -> { open_class_browser }
+        @menubar.add :cascade, menu: file, label: 'File'
+        @menubar.add :cascade, menu: edit, label: 'Edit'
+        @menubar.add :cascade, menu: view, label: 'View'
+        @menubar.add :cascade, menu: tools, label: 'Tools'
+        @tk_root.tk_item.native_item['menu'] = @menubar
+        @tk_root.tk_item.native_item.bind('Command-r', -> { main_component.run_selected(nil) })
+        @tk_root.tk_item.native_item.bind('Command-k', -> { main_component.clear_output(nil) })
+        @tk_root.tk_item.native_item.bind('Command-+', -> { main_component.zoom_in(nil) })
+        @tk_root.tk_item.native_item.bind('Command-minus', -> { main_component.zoom_out(nil) })
+        @tk_root.tk_item.native_item.bind('Command-i', -> { main_component.inspect_selected(nil) })
+        @tk_root.tk_item.native_item.bind('Command-Shift-i', -> { open_inspector })
+        @tk_root.tk_item.native_item.bind('Command-Shift-b', -> { open_class_browser })
+      end
+    end
+  end
+end

data/lib/tk_inspect/console/root_component.rb

@@ -0,0 +1,104 @@
+module TkInspect
+  module Console
+    class RootComponent < TkComponent::Base
+      attr_accessor :console
+
+      def generate(parent_component, options = {})
+        parse_component(parent_component, options) do |p|
+          p.vframe(sticky: 'nsew', x_flex: 1, y_flex: 1) do |r|
+            r.hframe(sticky: 'new', padding: '8', x_flex: 0) do |hf|
+              hf.label(text: "Write Ruby code here", sticky: 'w')
+              hf.hframe(sticky: 'ne', x_flex: 1) do |buttons|
+                buttons.button(text: "Run selected", default: "active", on_click: :run_selected)
+                buttons.button(text: "Return", on_click: :return_from_modal) if console.modal
+              end
+            end
+            r.vpaned(sticky: 'nswe', x_flex: 1, y_flex: 1) do |vp|
+              @input = vp.text(sticky: 'nswe', scrollers: 'y',
+                               highlightthickness: 0,
+                               x_flex: 1, y_flex: 1)
+              vp.vframe(padding: "0 0 0 0", sticky: 'nswe', x_flex: 1, y_flex: 1) do |vf|
+                vf.hframe(sticky: 'new', padding: '8', x_flex: 0) do |hf|
+                  hf.label(text: "Output", padding: '8', sticky: 'w')
+                  hf.hframe(sticky: 'ne', x_flex: 1) do |buttons|
+                    buttons.button(text: "Clear", on_click: :clear_output)
+                  end
+                end
+                @output = vf.text(sticky: 'nswe', scrollers: 'y',
+                                  background: 'systemSheetBackgroundOpaque', highlightthickness: 0,
+                                  x_flex: 1, y_flex: 1)
+              end
+            end
+          end
+        end
+      end
+
+      def focus_on_code
+        @input.tk_item.focus
+      end
+
+      def run_modal_loop
+        @running_modal_loop = true
+        while @running_modal_loop
+          Tk.update
+          sleep(0.019)
+        end
+      end
+
+      def run_selected(e)
+        code = @input.tk_item.selected_text
+        code = @input.tk_item.current_line if code.blank?
+        return unless code.present?
+
+        res = console.execute(code)
+        show_output(res)
+      end
+
+      def inspect_selected(e)
+        code = @input.tk_item.selected_text
+        code = @input.tk_item.current_line if code.blank?
+        return unless code.present?
+
+        res = console.open_inspector(code)
+      end
+
+      def show_output(res)
+        @output.tk_item.append_text(res.to_s + "\n");
+      end
+
+      def zoom_in(e)
+        zoom_by(1.1, @input)
+        zoom_by(1.1, @output)
+      end
+
+      def zoom_out(e)
+        zoom_by(0.9091, @input)
+        zoom_by(0.9091, @output)
+      end
+
+      def zoom_by(factor, item)
+        font = item.native_item.font
+        new_font = TkFont.new(family: font.family, weight: font.weight, size: (font.size * factor).ceil)
+        geom = console.tk_root.tk_item.native_item['geometry']
+        item.native_item.font(new_font)
+        console.tk_root.tk_item.native_item['geometry'] = geom
+      end
+
+      def clear_output(e)
+        @output.tk_item.value = ''
+      end
+
+      def inspect(e)
+        console.open_inspector
+      end
+
+      def open_class_browser(e)
+        console.open_class_browser
+      end
+
+      def return_from_modal(e)
+        @running_modal_loop = false
+      end
+    end
+  end
+end

data/lib/tk_inspect/inspector.rb

@@ -0,0 +1,2 @@
+require_relative './inspector/base'
+require_relative './inspector/root_component'

data/lib/tk_inspect/inspector/base.rb

@@ -0,0 +1,68 @@
+module TkInspect
+  module Inspector
+    class Base
+      cattr_accessor :shared_inspector
+      cattr_accessor :custom_inspectors
+
+      self.custom_inspectors = {}
+
+      attr_accessor :inspected_binding
+      attr_accessor :expression
+      attr_accessor :tk_root
+      attr_accessor :main_component
+
+      def self.shared_inspector
+        shared_inspector ||= self.new
+      end
+
+      def self.register_shared_inspector(inspector_class, inspected_class)
+        custom_inspectors[inspected_class] = inspector_class
+      end
+
+      def self.inspector_for_class(klass)
+        while klass && !(inspector = custom_inspectors[klass]) do
+          klass = klass.superclass
+        end
+        inspector || self
+      end
+
+      def self.inspector_for_object(obj)
+        self.inspector_for_class(obj.class)
+      end
+
+      def initialize(options = {})
+        @expression = options[:expression]
+        @inspected_binding = options[:binding] || binding
+        @value = options[:value]
+        @tk_root = nil
+        @main_component = nil
+      end
+
+      def refresh
+        @main_component.nil? ? create_root : @main_component.regenerate
+      end
+
+      def create_root
+        @tk_root = TkComponent::Window.new(title: window_title)
+        create_main_component
+        @main_component.inspector = self
+        @tk_root.place_root_component(@main_component)
+      end
+
+      def browse_class(class_name)
+        class_browser = TkInspect::ClassBrowser::Base.new
+        class_browser.select_class_name(class_name)
+        class_browser.refresh
+        class_browser.show_current_path
+      end
+
+      def create_main_component
+        @main_component = RootComponent.new
+      end
+
+      def window_title
+        "Inspector"
+      end
+    end
+  end
+end

data/lib/tk_inspect/inspector/root_component.rb

@@ -0,0 +1,65 @@
+module TkInspect
+  module Inspector
+    class RootComponent < TkComponent::Base
+      attr_accessor :inspector
+
+      def generate(parent_component, options = {})
+        parse_component(parent_component, options) do |p|
+          p.vframe(padding: "0 0 0 0", sticky: 'nsew', x_flex: 1, y_flex: 1) do |f|
+            @table = f.insert_component(TkComponent::TableViewComponent, self,
+                                        data_source: self,
+                                        columns: [
+                                          { key: :var, text: 'Variable', anchor: 'w' },
+                                          { key: :value, text: 'Value', anchor: 'center' },
+                                          { key: :klass, text: 'Class', anchor: 'center' }
+                                        ],
+                                        nested: true,
+                                        lazy: true,
+                                        sticky: 'nsew', x_flex: 1, y_flex: 1)
+            f.hframe(sticky: 'se', padding: '8', x_flex: 1) do |hf|
+              hf.button(text: "Browse selected class", on_click: :browse_class)
+              hf.button(text: "Refresh", on_click: ->(e) { regenerate })
+            end
+          end
+        end
+      end
+
+      def items_for_path(path = nil)
+        path = [] if path.blank?
+        if path.empty?
+          self_exp = inspector.expression || 'self'
+          self_value = eval(self_exp, inspector.inspected_binding)
+          res = [{ var: self_exp, value: self_value.value_for_tk_inspect, klass: self_value.class.to_s, real_value: self_value }]
+          if inspector.expression.blank?
+            vars = inspector.inspected_binding.local_variables.sort.map do |var_name|
+              value = inspector.inspected_binding.local_variable_get(var_name)
+              res << { var: var_name, value: value.value_for_tk_inspect, klass: value.class.to_s, real_value: value }
+            end
+          end
+          res
+        else
+          obj = path.last[:real_value]
+          obj.children_for_tk_inspect.map do |child_name, child_value|
+            { var: child_name, value: child_value.value_for_tk_inspect, klass: child_value.class.to_s, real_value: child_value }
+          end
+        end
+      end
+
+      def has_sub_items?(path)
+        path = [] if path.blank?
+        if path.empty?
+          return true # At least we have self
+        else
+          obj = path.last[:real_value]
+          obj.children_for_tk_inspect.any?
+        end
+      end
+
+      def browse_class(e)
+        item = @table.selected_item
+        return unless item && (class_name = item[:klass])
+        inspector.browse_class(class_name)
+      end
+    end
+  end
+end

data/lib/tk_inspect/version.rb

@@ -0,0 +1,3 @@
+module TkInspect
+  VERSION = "0.1.0"
+end

data/tk_inspect.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tk_inspect/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tk_inspect"
+  spec.version       = TkInspect::VERSION
+  spec.authors       = ["Josep Egea"]
+  spec.email         = ["jes@josepegea.com"]
+
+  spec.summary       = %q{Poor's man Smalltalk-like environment for Ruby using TK}
+  spec.description   = %q{Poor's man Smalltalk-like environment for Ruby using TK}
+  spec.homepage      = "https://github.com/josepegea/tk_inspect"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/josepegea/tk_inspect"
+    spec.metadata["changelog_uri"] = "https://github.com/josepegea/tk_inspect"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tk_component", "~> 0.1.2"
+
+  spec.add_dependency "rouge", "~> 3.26"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: tk_inspect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josep Egea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tk_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.26'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Poor's man Smalltalk-like environment for Ruby using TK
+email:
+- jes@josepegea.com
+executables:
+- console
+- setup
+- tk_console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tk_console
+- lib/base_inspectors.rb
+- lib/cli_support.rb
+- lib/tk_inspect.rb
+- lib/tk_inspect/canvas_window.rb
+- lib/tk_inspect/canvas_window/base.rb
+- lib/tk_inspect/canvas_window/root_component.rb
+- lib/tk_inspect/class_browser.rb
+- lib/tk_inspect/class_browser/base.rb
+- lib/tk_inspect/class_browser/class_namespace_data_source.rb
+- lib/tk_inspect/class_browser/class_tree_data_source.rb
+- lib/tk_inspect/class_browser/code_component.rb
+- lib/tk_inspect/class_browser/module_method_data_source.rb
+- lib/tk_inspect/class_browser/root_component.rb
+- lib/tk_inspect/console.rb
+- lib/tk_inspect/console/base.rb
+- lib/tk_inspect/console/root_component.rb
+- lib/tk_inspect/inspector.rb
+- lib/tk_inspect/inspector/base.rb
+- lib/tk_inspect/inspector/root_component.rb
+- lib/tk_inspect/version.rb
+- tk_inspect.gemspec
+homepage: https://github.com/josepegea/tk_inspect
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/josepegea/tk_inspect
+  source_code_uri: https://github.com/josepegea/tk_inspect
+  changelog_uri: https://github.com/josepegea/tk_inspect
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.8
+signing_key:
+specification_version: 4
+summary: Poor's man Smalltalk-like environment for Ruby using TK
+test_files: []