funk_hands 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4978a1d1304bf40e9b753e2d5cf3b26df51d598877ab430be1896b9c612be10a
-  data.tar.gz: a3c12a5f24b5a652bad99db4be51521237dea2b71b8d1ca92c5f84e12cce77a2
+  metadata.gz: 9b767a0fd1432f3f77e2f5d2efd21a083dd269dcb76baf695e1cf49a9a6a0d29
+  data.tar.gz: 20d6a66b7fb724d233676e5cde198a35e6e79f383e234765c35187bc80bd8fba
 SHA512:
-  metadata.gz: c844f3b3912c933ba76302bec770199d470838cc3d5e94a0d9753bacd8403881444c260daf74f9956a258193ffaf12d6153c6ba3151735374b1e11d8bbb2a02b
-  data.tar.gz: ec6aed617e06c9f70a46f77a39df7fc05663523f17f654a01f088eafabee3b574d00face85c796129cb72bfc20919f5333155a331dff53dfbf9019f10734e75d
+  metadata.gz: 3e299da70760635b89a099c29d2271008a0d5cf8562a81fb2582237df3af3ea0eec370dcb273aebbefb9cd66ec9494a71d184e5c0e7e93a8b3c9f8d7c4791913
+  data.tar.gz: f1b2490159619399114f21c680b45a19d02813c00d6cc2040e016484d00e809634f0adfbe5b2139e59c4a44813044e8b10c1b03cffd2416faadb209bb57e3878

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.0.0 (2023-12-07)
+
+* Dropped Pry prompt modifications, Hirb and awesome_print, coolline, coderay
+
+## 1.5.0 (2023-06-23)
+
+* Added support for the new module_parent_name method, required by
+  newer Rails versions (>= 6.1)
+
 ## 1.4.0 (2020-04-27)
 
 * Requires a more recent Pry version (at least 0.12.0) to work

data/README.md

@@ -10,20 +10,14 @@ hard-working hands!
 **funk_hands** is an opinionated set of console-related gems and a bit of glue:
 
 * [**Pry**][pry] for a powerful shell alternative to IRB.
-* [**Awesome Print**][awesome_print] for stylish pretty print.
-* [**Hirb**][hirb] for tabular collection output.
 * [**Pry Rails**][pry-rails] for additional commands (`show-routes`,
   `show-models`, `show-middleware`) in the Rails console.
-* [**Pry Doc**][pry-doc] to browse Ruby source, including C, directly from the
-  console.
-* [**Pry Remote**][pry-remote] to connect remotely to a Pry console.
-* [**Pry Byebug**][pry-byebug] to turn the console into a debugger.
-* [**Coolline**][coolline] and [**Coderay**][coderay] for syntax highlighting as
-  you type. _Optional. MRI 1.9.3/2.0.0 only_
+* [**Pry Remote**][pry-remote-reloaded] to connect remotely to a Pry console.
+* [**Pry Byebug**][pry-byebug-reloaded] to turn the console into a debugger.
 
 ## Usage
 
-Ruby 2.0+, Rails 3+. Add to your project Gemfile:
+Ruby 2.0+, Rails 5+. Add to your project Gemfile:
 
 ```ruby
 group :development, :test do
@@ -33,62 +27,15 @@ end
 
 That's it. Run `rails console` as usual.
 
-[Hirb][hirb] isn't enabled by default. To use, run `Hirb.enable` in the console.
-
-Ruby compiled against a proper readline library, ideally GNU readline, is
-recommended. Alternatively, [`gem install rb-readline`][rb-readline] for an
-acceptible backup. Using ruby compiled against a `libedit` wrapper (primarily OS
-X) will work but is not recommended.
-
-## Options
-
-Change the following options by creating an initializer in your Rails project
-Example `config/initializers/funk_hands.rb`:
-
-```ruby
-if defined?(FunkHands)
-  FunkHands.colored_prompt = false
-  FunkHands.enable_syntax_highlighting_as_you_type!
-end
-```
-
-### `colored_prompt`
-
-Color the console prompt? Defaults to `true` when the current ruby is compiled
-against GNU readline or `rb-readline`, which don't have issues counting
-characters in colored prompts. `false` for libedit.
-
-Note: `Pry.color = false` trumps this setting and disables all console coloring.
-
-### `prompt_separator`
-
-Separator string between the application name and line input. Defaults to `»`
-for GNU readline or libedit. Defaults to `>` for `rb-readline` which fails on
-mixed encodings.
-
-### Syntax highlighting
-
-Syntax highlighting as you type via [Coolline][coolline] and [Coderay][coderay]
-is disabled by default due to slightly buggy behavior. To enable, add
-`FunkHands.enable_syntax_highlighting_as_you_type!` to the initializer. Only
-works with MRI 1.9.3 or 2.0.0.
-
 ## Contributing
 
 Patches and bug reports are welcome. Just send a [pull request][pullrequests] or
 file an [issue][issues]. [Project changelog][changelog].
 
 [pry]:                    http://pry.github.com
-[awesome_print]:          https://github.com/michaeldv/awesome_print
-[hirb]:                   https://github.com/cldwalker/hirb
 [pry-rails]:              https://github.com/rweng/pry-rails
-[pry-doc]:                https://github.com/pry/pry-doc
-[pry-byebug]:             https://github.com/deivid-rodriguez/pry-byebug
-[pry-remote]:             https://github.com/Mon-Ouie/pry-remote
+[pry-byebug-reloaded]:    https://github.com/Jack12816/pry-byebug-reloaded
 [pry-remote-reloaded]:    https://github.com/Jack12816/pry-remote-reloaded
-[coolline]:               https://github.com/Mon-Ouie/coolline
-[coderay]:                https://github.com/rubychan/coderay
-[rb-readline]:            https://github.com/luislavena/rb-readline
-[pullrequests]:           https://github.com/Jack12816/jazz_hands/pulls
-[issues]:                 https://github.com/Jack12816/jazz_hands/issues
-[changelog]:              https://github.com/Jack12816/jazz_hands/blob/master/CHANGELOG.md
+[pullrequests]:           https://github.com/Jack12816/funk_hands/pulls
+[issues]:                 https://github.com/Jack12816/funk_hands/issues
+[changelog]:              https://github.com/Jack12816/funk_hands/blob/master/CHANGELOG.md

data/funk_hands.gemspec

@@ -17,15 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ['lib']
 
+  gem.required_ruby_version = '>= 2.5'
+
   # Dependencies
-  gem.required_ruby_version = '>= 1.9.2'
-  gem.add_runtime_dependency 'pry', '>= 0.12.0'
+  gem.add_runtime_dependency 'pry', '>= 0.14.0'
   gem.add_runtime_dependency 'pry-rails', '>= 0.3.6'
-  gem.add_runtime_dependency 'pry-doc', '>= 0.11.1'
-  gem.add_runtime_dependency 'pry-remote-reloaded', '~> 1.0'
-  gem.add_runtime_dependency 'pry-byebug', '>= 1.0'
-  gem.add_runtime_dependency 'hirb', '>= 0.7.3'
-  gem.add_runtime_dependency 'coolline', '>= 0.4.2'
-  gem.add_runtime_dependency 'awesome_print', '~> 1.8'
-  gem.add_runtime_dependency 'railties', '>= 3.0', '< 7.0'
+  gem.add_runtime_dependency 'pry-remote-reloaded', '~> 1.1'
+  gem.add_runtime_dependency 'pry-byebug-reloaded', '~> 3.10'
 end

data/lib/funk_hands/railtie.rb

@@ -1,31 +1,9 @@
-require 'pry'
-require 'pry-rails'
-require 'pry-doc'
-require 'pry-remote-reloaded'
-require 'awesome_print'
-require 'funk_hands/hirb_ext'
-require 'pry-byebug'
+# frozen_string_literal: true
 
 module FunkHands
   class Railtie < Rails::Railtie
-    initializer 'Funk_hands.initialize' do |app|
+    initializer 'FunkHands.initialize' do |app|
       silence_warnings do
-        # We're managing the loading of plugins. So don't let pry autoload them.
-        Pry.config.should_load_plugins = false
-
-        # Use awesome_print for output, but keep pry's pager. If Hirb is
-        # enabled, try printing with it first.
-        # See: https://github.com/pry/pry/blob/v0.11.3/lib/pry.rb#L20
-        Pry.config.print = ->(output, value, _pry_) do
-          if FunkHands._hirb_output
-            return output.puts(Hirb::View.view_or_page_output(value))
-          end
-          if Pry.pager
-            return Pry::DEFAULT_PRINT.call(output, value, _pry_)
-          end
-          output.puts("=> #{value.ai(indent: 2)}")
-        end
-
         # Friendlier prompt - line number, app name, nesting levels look like
         # directory paths.
         #
@@ -36,14 +14,18 @@ module FunkHands
         # libraries (GNU, rb-readline) correctly ignore color codes when
         # calculating line length.
 
-        color = -> { Pry.color && FunkHands.colored_prompt }
+        color = -> { Pry.color }
         red  = ->(text) { color[] ? "\001\e[0;31m\002#{text}\001\e[0m\002" : text.to_s }
         blue = ->(text) { color[] ? "\001\e[0;34m\002#{text}\001\e[0m\002" : text.to_s }
         bold = ->(text) { color[] ? "\001\e[1m\002#{text}\001\e[0m\002"    : text.to_s }
 
-        separator = -> { red.(FunkHands.prompt_separator) }
-        name = app.class.parent_name.underscore
-        colored_name = -> { blue.(name) }
+        name = app.class.module_parent_name \
+          if app.class.respond_to?(:module_parent_name)
+        name ||= app.class.parent_name
+        name = name.underscore.gsub('_', '-')
+
+        separator = red.(defined?(RbReadline) ? '>' : "\u00BB")
+        colored_name = blue.(name)
 
         line = ->(pry) { "[#{bold.(pry.input_ring.size)}] " }
         target_string = ->(object, level) do
@@ -55,19 +37,26 @@ module FunkHands
           end
         end
 
-        Pry.config.prompt = [
-          ->(object, level, pry) do      # Main prompt
-            "#{line.(pry)}#{colored_name.()}#{target_string.(object, level)} #{separator.()} "
-          end,
-          ->(object, level, pry) do      # Wait prompt in multiline input
-            spaces = ' ' * (
-              "[#{pry.input_ring.size}] ".size +  # Uncolored `line.(pry)`
-              name.size +
-              target_string.(object, level).size
-            )
-            "#{spaces} #{separator.()} "
-          end
-        ]
+        Pry.config.prompt = Pry::Prompt.new(
+          'funk_hands',
+          'funk_hands',
+          [
+            # Main prompt
+            proc do |object, level, pry|
+              "#{line.(pry)}#{colored_name}#{target_string.(object, level)} #{separator} "
+            end,
+
+            # Wait prompt in multiline input
+            proc do |object, level, pry|
+              spaces = ' ' * (
+                "[#{pry.input_ring.size}] ".size +  # Uncolored `line.(pry)`
+                name.size +
+                target_string.(object, level).size
+              )
+              "#{spaces} #{separator.()} "
+            end
+          ]
+        )
       end
     end
   end

data/lib/funk_hands/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FunkHands
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end

data/lib/funk_hands.rb

@@ -1,66 +1,14 @@
-require 'funk_hands/version'
-require 'funk_hands/railtie' if defined?(Rails)
+# frozen_string_literal: true
+
 require 'active_support'
 require 'readline'
+require 'pry'
+require 'pry-rails'
+require 'pry-byebug'
+require 'pry-byebug/pry_remote_ext'
+require 'pry-remote-reloaded'
 
-module FunkHands
-
-  ### Options ###
-
-  # Color the prompt?
-  #
-  # A different setting than Pry.color since some may like colored output, but a
-  # plain prompt.
-  #
-  # Default: 'true' for GNU readline or rb-readline which correctly count line
-  # widths with color codes when using \001 and \002 hints. 'false' for
-  # libedit-based wrapper (standard on OS X unless ruby is explicitly compiled
-  # otherwise).
-  #
-  mattr_accessor :colored_prompt
-  self.colored_prompt = (Readline::VERSION !~ /EditLine/)
-
-  # Separator between application name and input in the prompt.
-  #
-  # Default: right angle quote, or '>' when using rb-readline which doesn't
-  # handle mixed encodings well.
-  #
-  mattr_accessor :prompt_separator
-  self.prompt_separator = defined?(RbReadline) ? '>' : "\u00BB"
-
-
-  class << self
-    # Enable syntax highlighting as you type in the Rails console via coolline and
-    # coderay (MRI 1.9.3+ only). Disabled by default as it's a bit buggy.
-    #
-    # Call from a Rails initializer:
-    #
-    #   FunkHands.enable_syntax_highlighting_as_you_type!
-    #
-    def enable_syntax_highlighting_as_you_type!
-      raise 'Syntax highlighting only supported on 1.9.3+' unless RUBY_VERSION >= '1.9.3'
+module FunkHands; end
 
-      # Use coolline with CodeRay for syntax highlighting as you type.
-      # Only works on >= 1.9.3 because coolline depends on io/console.
-
-      require 'coolline'
-      require 'coderay'
-
-      Pry.config.input = Coolline.new do |c|
-        c.transform_proc = proc do
-          CodeRay.scan(c.line, :ruby).term
-        end
-
-        c.completion_proc = proc do
-          word = c.completed_word
-          Object.constants.map(&:to_s).select { |w| w.start_with? word }
-        end
-      end
-    end
-    alias :enable_syntax_highlighting_as_you_type :enable_syntax_highlighting_as_you_type!
-  end
-
-  ### Internal methods ###
-
-  mattr_accessor :_hirb_output
-end
+require 'funk_hands/version'
+require 'funk_hands/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funk_hands
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Gopal Patel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,110 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: pry-remote-reloaded
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: hirb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.3
-- !ruby/object:Gem::Dependency
-  name: coolline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: pry-byebug-reloaded
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '3.10'
 description: Spending hours in the rails console? Spruce it up and show off those
   hard-working hands! funk_hands replaces IRB with Pry, improves output through awesome_print,
   and has some other goodies up its sleeves.
@@ -158,14 +82,13 @@ files:
 - Rakefile
 - funk_hands.gemspec
 - lib/funk_hands.rb
-- lib/funk_hands/hirb_ext.rb
 - lib/funk_hands/railtie.rb
 - lib/funk_hands/version.rb
 homepage: https://github.com/Jack12816/funk_hands
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,15 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.8
+signing_key:
 specification_version: 4
 summary: Exercise those fingers. Pry-based enhancements for the default Rails console.
 test_files: []

data/lib/funk_hands/hirb_ext.rb

@@ -1,18 +0,0 @@
-require 'hirb'
-require 'pry'
-
-class << Hirb::View
-  alias_method :enable_output_method_existing, :enable_output_method
-  alias_method :disable_output_method_existing, :disable_output_method
-
-  def enable_output_method
-    @output_method = true
-    FunkHands._hirb_output = true
-    enable_output_method_existing
-  end
-
-  def disable_output_method
-    FunkHands._hirb_output = false
-    disable_output_method_existing
-  end
-end