irb-kit 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a5907eebfaf893e3124cdc4e0377b7fbca4c5b574275cdda768cc57d8cd729
-  data.tar.gz: 84043d9813d5e9731305f7630b93393644b746a3b3410641bdcae8d19945b663
+  metadata.gz: c77d7eb5845448c9e3050a2106ba4fd1a032f4027f7de2ee1209dfaa12aef203
+  data.tar.gz: '0281f3ab1ab7f7f3d9f0da865b795b8d6d65703d1d70eac18b047269c9345fab'
 SHA512:
-  metadata.gz: 5c1e6591d55b4f59324265e0f86ebaf034907e707640b4d3678e0d23091a973b184d3c1122b619da83deb1b876b63a6dd69f9e9990631f13c8b50f0e81f45cf4
-  data.tar.gz: d584db7f831d24d84f55aec04cf1f27e8ced2754f33b5d7101adcf67c8d5db7064fac27e6ad5dbd1cdcae79959acfe0d845759b7d924cd878a9fd36394ba7045
+  metadata.gz: 68577f28ddbadd851506efd218f4f8fa9fb755fa80a92b1617712d75494c081bc0251bc087dbe72161a6171ac48a10efb7e6c116d06ffbf63466c89f19f334b4
+  data.tar.gz: 7a1e64278796fa5b7685eae916f5b44b078501b38f89ea124dc0d103b2ffaeb20118486d33132f29aa4e192c802aecfea7256f3a4b39f53bae7e3c9112cb5414

data/README.adoc

@@ -65,10 +65,14 @@ To use, add the following to your `~/.config/irb/irbrc` configuration (or `~/.ir
 
 [source,ruby]
 ----
-require "irb/kit"
+begin
+  require "irb/kit"
+rescue LoadError => error
+  puts "ERROR: #{error.message.capitalize}."
+end
 ----
 
-This ensures this gem is fully loaded in order to enhance {irb_link} further. To customize, read on.
+This ensures this gem is fully loaded in order to enhance {irb_link} further. Otherwise, an error is displayed if you are in a Ruby project that doesn't have this gem as a dependency. To customize, read on.
 
 === Quick Start
 
@@ -76,19 +80,25 @@ If you'd like all the bells and whistles fully enabled, add the following to you
 
 [source,ruby]
 ----
-require "irb/kit"
+begin
+  require "irb/kit"
 
-IRB::Kit.register_helpers :all
+  IRB::Kit.register_helpers :all
 
-IRB.conf[:PROMPT][:DEMO] = {
-  PROMPT_I: "[#{IRB::Kit.prompt}]> ",
-  PROMPT_N: "[#{IRB::Kit.prompt}]| ",
-  PROMPT_C: "[#{IRB::Kit.prompt}]| ",
-  PROMPT_S: "[#{IRB::Kit.prompt}]%l ",
-  RETURN: "=> %s\n"
-}
+  IRB.conf[:PROMPT] ||= {}
 
-IRB.conf[:PROMPT_MODE] = :DEMO
+  IRB.conf[:PROMPT][:DEMO] = {
+    PROMPT_I: "[#{IRB::Kit.prompt}]> ",
+    PROMPT_N: "[#{IRB::Kit.prompt}]| ",
+    PROMPT_C: "[#{IRB::Kit.prompt}]| ",
+    PROMPT_S: "[#{IRB::Kit.prompt}]%l ",
+    RETURN: "=> %s\n"
+  }
+
+  IRB.conf[:PROMPT_MODE] = :DEMO
+rescue LoadError => error
+  puts "ERROR: #{error.message.capitalize}."
+end
 ----
 
 The above enables all helpers and configures your prompt for {ruby_link}, {hanami_link}, and {rails_link} environments.
@@ -241,19 +251,23 @@ The following screenshots demonstrate what the prompt looks like in different en
 
 *Ruby (with Git)*
 
-image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-with_git.png[Screenshot,459,108,role=focal_point]
+image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-with_git.png[Screenshot,651,150,role=focal_point]
 
 *Ruby (without Git)*
 
-image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-without_git.png[Screenshot,292,116,role=focal_point]
+image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-without_git.png[Screenshot,400,146,role=focal_point]
+
+*Hanami (development)*
+
+image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-hanami-development.png[Screenshot,690,146,role=focal_point]
 
-*Hanami*
+*Hanami (production)*
 
-image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-hanami.png[Screenshot,520,120,role=focal_point]
+image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-hanami-production.png[Screenshot,910,169,role=focal_point]
 
 *Rails*
 
-image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-rails.png[Screenshot,541,137,role=focal_point]
+image::https://alchemists.io/images/projects/irb-kit/screenshots/prompt-rails.png[Screenshot,756,170,role=focal_point]
 
 == Development
 

data/irb-kit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "irb-kit"
-  spec.version = "0.0.0"
+  spec.version = "0.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/irb-kit"
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
     "changelog_uri" => "https://alchemists.io/projects/irb-kit/versions",
     "documentation_uri" => "https://alchemists.io/projects/irb-kit",
     "funding_uri" => "https://github.com/sponsors/bkuhlmann",
-    "label" => "Irb Kit",
+    "label" => "IRB Kit",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/irb-kit"
   }

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

@@ -5,11 +5,10 @@ module IRB
     module Helpers
       # Copies input to macOS clipboard.
       class Clip < IRB::HelperMethod::Base
-        description "Copy input to macOS clipboard."
+        MONIKER = :clip
 
-        def self.moniker = :clip
+        description "Copy input to macOS clipboard."
 
-        # :nocov:
         def initialize io = IO
           super()
           @io = io
@@ -17,6 +16,8 @@ module IRB
 
         def execute(*lines)
           io.popen("pbcopy", "w") { |clipboard| clipboard.write lines.join("\n") }
+        rescue Errno::ENOENT
+          "ERROR: Unable to copy since `pbcopy` is only supported on macOS."
         end
 
         private

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

@@ -5,9 +5,9 @@ module IRB
     module Helpers
       # Finds constant's source location.
       class ConstantSource < IRB::HelperMethod::Base
-        description "Find a constant's source location."
+        MONIKER = :csource
 
-        def self.moniker = :csource
+        description "Find a constant's source location."
 
         def initialize object = Object
           super()

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

@@ -5,9 +5,9 @@ module IRB
     module Helpers
       # Find an object method's source location.
       class MethodSource < IRB::HelperMethod::Base
-        description "Find an object method's source location."
+        MONIKER = :msource
 
-        def self.moniker = :msource
+        description "Find an object method's source location."
 
         def execute object, name
           object.method(name).source_location

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

@@ -5,17 +5,20 @@ module IRB
     module Helpers
       # Pastes last entry from macOS clipboard.
       class Paste < IRB::HelperMethod::Base
-        description "Paste last entry from macOS clipboard."
+        MONIKER = :paste
 
-        def self.moniker = :paste
+        description "Paste last entry from macOS clipboard."
 
-        # :nocov:
         def initialize io = IO
           super()
           @io = io
         end
 
-        def execute = io.popen "pbpaste", "r", &:read
+        def execute
+          io.popen "pbpaste", "r", &:read
+        rescue Errno::ENOENT
+          "ERROR: Unable to paste since `pbpaste` is only supported on macOS."
+        end
 
         private
 

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

@@ -5,9 +5,9 @@ module IRB
     module Helpers
       # Search an object's methods by pattern.
       class Search < IRB::HelperMethod::Base
-        description "Search an object's methods by pattern."
+        MONIKER = :search
 
-        def self.moniker = :search
+        description "Search an object's methods by pattern."
 
         def initialize regex = Regexp
           super()

data/lib/irb/kit/loader.rb

@@ -18,10 +18,10 @@ module IRB
 
       attr_reader :registrar, :namespace, :all
 
-      def register_all = helpers.each { |helper| registrar.register helper.moniker, helper }
+      def register_all = helpers.each { |helper| registrar.register helper::MONIKER, helper }
 
       def register_selected(*monikers)
-        helpers.select { |helper| monikers.include? helper.moniker }
+        helpers.select { |helper| monikers.include? helper::MONIKER }
                .then { |selected| monikers.zip selected }
                .each { |moniker, helper| registrar.register moniker, helper }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb-kit
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.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-18 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -93,7 +93,7 @@ metadata:
   changelog_uri: https://alchemists.io/projects/irb-kit/versions
   documentation_uri: https://alchemists.io/projects/irb-kit
   funding_uri: https://github.com/sponsors/bkuhlmann
-  label: Irb Kit
+  label: IRB Kit
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/irb-kit
 post_install_message: