irb-kit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d780521bda1e340bf6982b990365702a0d1b25db6ab6f5d644ecd17aacbd388
-  data.tar.gz: e5ba0a428a0572bfc79a34b034b225dc5f8a083f843f800b42786ec9666ca7e1
+  metadata.gz: bd95b94c3b604ba8c6c5c239475a99ab603815ba86d98587193063515b676fd2
+  data.tar.gz: e2082fe9b9e281291c2e67ec6b54e2ea7359c50178d625cf96faa05ce225ece8
 SHA512:
-  metadata.gz: 2632b3438788d8eef27586a9b59fd9caf203edcbb1ce5399f24c6c2758aa545bb2a074e89380e0cb7986c4ef158cb6b87491f2ee0a5b9ddc959861ddc76ba1e9
-  data.tar.gz: 39d38ee4db85954e6cb8616a31b7c087e9b9db1fcc9048f684d028fd1cfda0aa43d01ddb7d288e3eff0b989644862703490310a4fb136ec8d849b8ce4ffd5f2d
+  metadata.gz: a5bbb32382af12000c59e762774961637a00285f55355eed10d7feead6d6f015397661ec99a9ad0e29e7036a26cc938b89c3aa75ee6d96b1d2c0e6fd4c9f77bf
+  data.tar.gz: cc2472d1fd8069b751816de1f5c62574236dc999b59c380b886b5e2e0b1b5a8911935fe2c6b2fc9e9b738e9626f6c78699ae3d16d25bae5c5ff3ea63778b5837

data/README.adoc

@@ -9,6 +9,7 @@
 :rails_link: link:https://rubyonrails.org[Rails]
 :ruby_link: link:https://www.ruby-lang.org[Ruby]
 :xdg_link: link:https://alchemists.io/projects/xdg[XDG]
+:iterm_link: link:https://iterm2.com[iTerm2]
 
 = IRB Kit
 
@@ -160,11 +161,11 @@ Use this helper, short for _constant source_, to find the source location of a c
 
 [source,ruby]
 ----
-csource :RUBY_VERSION   # ["<main>", 0]
-csource "RUBY_VERSION"  # ["<main>", 0]
+csource :RUBY_DESCRIPTION   # "$HOME/.cache/frum/versions/3.3.2/bin/ruby:0"
+csource "RUBY_DESCRIPTION"  # "$HOME/.cache/frum/versions/3.3.2/bin/ruby:0"
 ----
 
-You can use a symbol or a string when looking up the source location of a constant.
+You can use a symbol or a string when looking up the source location of a constant. The output is formatted so you can use pass:[<kbd>CONTROL</kbd>] + `<click>` to immediately view the source at the exact line number in consoles like {iterm_link}.
 
 ==== `msource`
 
@@ -172,11 +173,13 @@ Use this helper, short for _method source_, to find the source location of a met
 
 [source,ruby]
 ----
-msource IRB, :start   # ["ruby/gems/3.3.0/gems/irb-1.13.1/lib/irb.rb", 893]
-msource IRB, "start"  # ["ruby/gems/3.3.0/gems/irb-1.13.1/lib/irb.rb", 893]
+msource IRB, :start   # "$HOME/.cache/frum/versions/3.3.2/lib/ruby/3.3.0/irb.rb:893"
+msource IRB, "start"  # "$HOME/.cache/frum/versions/3.3.2/lib/ruby/3.3.0/irb.rb:893"
 ----
 
-The first argument is the object you want to message while the second argument is the object's method you want to find the source code location for. You'll get an array with the path and the line number of the method's source. You can also use a symbol or string for the method.
+The first argument is the object you want to message while the second argument is the object's method you want to find the source code location for. You can also use a symbol or string for the method.
+
+The output is formatted so you can use pass:[<kbd>CONTROL</kbd>] + `<click>` to immediately view the source at the exact line number in consoles like {iterm_link}.
 
 ==== `paste`
 

data/irb-kit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "irb-kit"
-  spec.version = "0.1.1"
+  spec.version = "0.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/irb-kit"

data/lib/irb/kit/helpers/constant_source.rb

@@ -9,20 +9,21 @@ module IRB
 
         description "Find a constant's source location."
 
-        def initialize object = Object
+        def initialize object = Object, delimiter: ":"
           super()
           @object = object
+          @delimiter = delimiter
         end
 
         def execute name
-          object.const_source_location name
+          object.const_source_location(name).then { |details| details.join delimiter if details }
         rescue NameError
           "ERROR: Invalid constant (#{name.inspect})."
         end
 
         private
 
-        attr_reader :object
+        attr_reader :object, :delimiter
       end
     end
   end

data/lib/irb/kit/helpers/method_source.rb

@@ -9,11 +9,20 @@ module IRB
 
         description "Find an object method's source location."
 
+        def initialize delimiter: ":"
+          super()
+          @delimiter = delimiter
+        end
+
         def execute object, name
-          object.method(name).source_location
+          object.method(name).source_location.then { |details| details.join delimiter if details }
         rescue NameError => error
           "ERROR: #{error.message}"
         end
+
+        private
+
+        attr_reader :delimiter
       end
     end
   end

data/lib/irb/kit/loader.rb

@@ -2,7 +2,7 @@
 
 module IRB
   module Kit
-    # Loads IRB extensions for namespace.
+    # Loads extensions for namespace.
     class Loader
       ALL = [:all].freeze
 
@@ -18,15 +18,15 @@ module IRB
 
       attr_reader :registrar, :namespace, :all
 
-      def register_all = helpers.each { |helper| registrar.register helper::MONIKER, helper }
+      def register_all = constants.each { |helper| registrar.register helper::MONIKER, helper }
 
       def register_selected(*monikers)
-        helpers.select { |helper| monikers.include? helper::MONIKER }
-               .then { |selected| monikers.zip selected }
-               .each { |moniker, helper| registrar.register moniker, helper }
+        constants.select { |helper| monikers.include? helper::MONIKER }
+                 .then { |selected| monikers.zip selected }
+                 .each { |moniker, helper| registrar.register moniker, helper }
       end
 
-      def helpers = namespace.constants.sort.map { |name| namespace.const_get name }
+      def constants = namespace.constants.sort.map { |name| namespace.const_get name }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb-kit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Extends IRB by providing additional productivity enhancements.