pry-gem 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c17d0cff41b4c1a89c229937e8eeca12067ea59
+  data.tar.gz: 013cb8d75c4213b0498ebaa97346e29df6b85b36
+SHA512:
+  metadata.gz: d42c4e0a9262050378fba8502682e6eaf6d102d42711631a194fa04c2c1d7da7cb8ae3e6361cc9c5e903e6ee2033ac8876f1e09228fdc1a4eb8033c2b0847aea
+  data.tar.gz: 4a772ee8ac8ee3bfdb43bbbc5a2ee6038dd6a5eb006b98b6b58f8b5febfdf51e5d25326feb187255d0794bea05059d785bab335bc5286f3255e264558b7a4aea

data/lib/pry-gem.rb

@@ -0,0 +1,10 @@
+require 'pry'
+
+require 'pry-gem/rubygem'
+require 'pry-gem/gem_cd'
+require 'pry-gem/gem_list'
+require 'pry-gem/gem_install'
+require 'pry-gem/gem_open'
+require 'pry-gem/gem_readme'
+require 'pry-gem/gem_search'
+require 'pry-gem/gem_stat'

data/lib/pry-gem/gem_cd.rb

@@ -0,0 +1,27 @@
+module PryGem
+  # @since 1.0.0
+  class GemCd < Pry::ClassCommand
+    match 'gem-cd'
+    group 'Gems'
+    description "Change working directory to specified gem's directory."
+    command_options argument_required: true
+
+    banner <<-'BANNER'
+      Usage: gem-cd GEM_NAME
+
+      Change the current working directory to that in which the given gem is
+      installed.
+    BANNER
+
+    def process(gem)
+      Dir.chdir(Rubygem.spec(gem).full_gem_path)
+      output.puts(Dir.pwd)
+    end
+
+    def complete(str)
+      Rubygem.complete(str)
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemCd)

data/lib/pry-gem/gem_install.rb

@@ -0,0 +1,33 @@
+module PryGem
+  # @since 1.0.0
+  class GemInstall < Pry::ClassCommand
+    match 'gem-install'
+    group 'Gems'
+    description 'Install a gem and refresh the gem cache.'
+    command_options argument_required: true
+
+    banner <<-'BANNER'
+      Usage: gem-install GEM_NAME
+
+      Installs the given gem, refreshes the gem cache, and requires the gem for
+      you based on a best guess from the gem name.
+
+      gem-install pry-stack_explorer
+    BANNER
+
+    def setup
+      require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
+    end
+
+    def process(gem)
+      Rubygem.install(gem)
+      output.puts "Gem `#{green(gem)}` installed."
+      require gem
+    rescue LoadError
+      require_path = gem.split('-').join('/')
+      require require_path
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemInstall)

data/lib/pry-gem/gem_list.rb

@@ -0,0 +1,41 @@
+module PryGem
+  # @since 1.0.0
+  class GemList < Pry::ClassCommand
+    match 'gem-list'
+    group 'Gems'
+    description 'List and search installed gems.'
+
+    banner <<-'BANNER'
+      Usage: gem-list [REGEX]
+
+      List all installed gems, when a regex is provided, limit the output to
+      those that match the regex.
+    BANNER
+
+    def process(pattern = nil)
+      gems(pattern).each do |gem, specs|
+        sort_specs!(specs)
+
+        versions = specs.each_with_index.map do |spec, index|
+          index == 0 ? bright_green(spec.version.to_s) : green(spec.version.to_s)
+        end
+
+        output.puts "#{default gem} (#{versions.join ', '})"
+      end
+    end
+
+    private
+
+    def gems(pattern)
+      Rubygem.list(Regexp.compile(pattern || '')).group_by(&:name)
+    end
+
+    def sort_specs!(specs)
+      specs.sort! do |a, b|
+        Gem::Version.new(b.version) <=> Gem::Version.new(a.version)
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemList)

data/lib/pry-gem/gem_open.rb

@@ -0,0 +1,30 @@
+module PryGem
+  # @since 1.0.0
+  class GemOpen < Pry::ClassCommand
+    match 'gem-open'
+    group 'Gems'
+    description 'Opens the working directory of the gem in your editor.'
+    command_options argument_required: true
+
+    banner <<-'BANNER'
+      Usage: gem-open GEM_NAME
+
+      Change the current working directory to that in which the given gem is
+      installed, and then opens your text editor.
+
+      gem-open pry-exception_explorer
+    BANNER
+
+    def process(gem)
+      Dir.chdir(Rubygem.spec(gem).full_gem_path) do
+        Pry::Editor.new(_pry_).invoke_editor(".", 0, false)
+      end
+    end
+
+    def complete(str)
+      Rubygem.complete(str)
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemOpen)

data/lib/pry-gem/gem_readme.rb

@@ -0,0 +1,30 @@
+module PryGem
+  # @since 1.0.0
+  class GemReadme < Pry::ClassCommand
+    match 'gem-readme'
+    description 'Show the readme bundled with a rubygem'
+    group 'Gems'
+    command_options argument_required: true
+    banner <<-BANNER
+      gem-readme gem
+      Show the readme bundled with a rubygem
+    BANNER
+
+    def process(name)
+      spec = Gem::Specification.find_by_name(name)
+      glob = File.join(spec.full_gem_path, 'README*')
+      readme = Dir[glob][0]
+
+      unless File.exist?(readme.to_s)
+        raise Pry::CommandError, "Gem '#{name}' doesn't appear to have a README"
+      end
+
+      _pry_.pager.page File.read(readme)
+    rescue Gem::LoadError
+      raise Pry::CommandError,
+            "Gem '#{name}' wasn't found. Are you sure it is installed?"
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemReadme)

data/lib/pry-gem/gem_search.rb

@@ -0,0 +1,46 @@
+module PryGem
+  # @since 1.0.0
+  class GemSearch < Pry::ClassCommand
+    match 'gem-search'
+    description 'Search for a gem with the rubygems.org JSON API'
+    group 'Gems'
+    command_options argument_required: true
+    banner <<-BANNER
+      gem-search [options] gem
+
+      Search for a gem with the rubygems.org HTTP API
+    BANNER
+
+    API_ENDPOINT = 'https://rubygems.org/api/v1/search.json'.freeze
+
+    def setup
+      require 'json' unless defined?(JSON)
+      require 'net/http' unless defined?(Net::HTTP)
+    end
+
+    def options(opt)
+      opt.on :l, :limit, 'Limit the number of results (max: 30)',
+             default: 10,
+             as: Integer,
+             argument: true
+    end
+
+    def process(str)
+      uri = URI.parse(API_ENDPOINT)
+      uri.query = URI.encode_www_form(query: str)
+      gems = JSON.parse(Net::HTTP.get(uri))
+      _pry_.pager.page list_as_string(gems, opts[:limit])
+    end
+
+    private
+
+    def list_as_string(gems, limit = 10)
+      gems[0..limit - 1].map do |gem|
+        name, version, info = gem.values_at 'name', 'version', 'info'
+        "#{bold(name)} #{bold('v' + version)} \n#{info}\n\n"
+      end.join
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemSearch)

data/lib/pry-gem/gem_stat.rb

@@ -0,0 +1,91 @@
+module PryGem
+  # @since 1.0.0
+  class GemStat < Pry::ClassCommand
+    require 'json'
+    require 'net/http'
+    STAT_HOST = "rubygems.org".freeze
+    STAT_PORT = 443
+    STAT_PATH = "/api/v1/gems/%s.json".freeze
+    FAIL_WHALE = <<-FAILWHALE.freeze
+W     W      W
+W        W  W     W
+              '.  W
+  .-""-._     \ \.--|
+ /       "-..__) .-'
+|     _         /
+\'-.__,   .__.,'
+ `'----'._\--'
+VVVVVVVVVVVVVVVVVVVVV
+    FAILWHALE
+
+    match 'gem-stat'
+    description 'Show the statistics of a gem (requires internet connection)'
+    group 'Gems'
+    command_options argument_required: true
+    banner <<-BANNER
+      gem-stats name
+
+      Show the statistics of a gem.
+      Requires an internet connection.
+    BANNER
+
+    def process(name)
+      client = Net::HTTP.start STAT_HOST, STAT_PORT, use_ssl: true
+      res = client.get STAT_PATH % URI.encode_www_form_component(name)
+      case res
+      when Net::HTTPOK
+        _pry_.pager.page format_gem(JSON.parse(res.body))
+      when Net::HTTPServiceUnavailable
+        _pry_.pager.page <<-FAILURE
+#{bright_blue(FAIL_WHALE)}
+#{bright_red('Ruby On Rails')}
+#{bright_red('Net::HTTPServiceUnavailable')}
+        FAILURE
+      else
+        raise Pry::CommandError, "Bad response (#{res.class})"
+      end
+    ensure
+      client.finish if client
+    end
+
+    private
+
+    def format_gem(h)
+      h = Pry::Config.from_hash(h)
+      format_str = unindent <<-FORMAT
+        %{name} %{version}
+        --
+        Total Downloads   : %{downloads}
+        Version Downloads : %{version_downloads}
+
+        #{red('Dependencies')} (runtime)
+        --
+        %{rdependencies}
+
+        #{red('Dependencies')} (development)
+        %{ddependencies}
+      FORMAT
+      format(
+        format_str,
+        name: green(h.name),
+        version: bold("v#{h.version}"),
+        downloads: h.downloads,
+        version_downloads: h.version_downloads,
+        rdependencies: format_dependencies(h.dependencies.runtime),
+        ddependencies: format_dependencies(h.dependencies.development)
+      )
+    end
+
+    def format_dependencies(rdeps)
+      return bold('None') if rdeps.empty?
+
+      with_line_numbers(
+        rdeps.map { |h| "#{h['name']} (#{h['requirements']})" }.join("\n"),
+        1,
+        :bold
+      )
+    end
+  end
+end
+
+Pry::Commands.add_command(PryGem::GemStat)

data/lib/pry-gem/rubygem.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+
+module PryGem
+  # @since 1.0.0
+  module Rubygem
+    class << self
+      def installed?(name)
+        if Gem::Specification.respond_to?(:find_all_by_name)
+          Gem::Specification.find_all_by_name(name).any?
+        else
+          Gem.source_index.find_name(name).first
+        end
+      end
+
+      # Get the gem spec object for the given gem name.
+      #
+      # @param [String] name
+      # @return [Gem::Specification]
+      def spec(name)
+        specs = if Gem::Specification.respond_to?(:each)
+                  Gem::Specification.find_all_by_name(name)
+                else
+                  Gem.source_index.find_name(name)
+                end
+
+        first_spec = specs.max_by { |spec| Gem::Version.new(spec.version) }
+
+        first_spec || raise(CommandError, "Gem `#{name}` not found")
+      end
+
+      # List gems matching a pattern.
+      #
+      # @param [Regexp] pattern
+      # @return [Array<Gem::Specification>]
+      def list(pattern = /.*/)
+        if Gem::Specification.respond_to?(:each)
+          Gem::Specification.select { |spec| spec.name =~ pattern }
+        else
+          Gem.source_index.gems.values.select { |spec| spec.name =~ pattern }
+        end
+      end
+
+      # Completion function for gem-cd and gem-open.
+      #
+      # @param [String] so_far what the user's typed so far
+      # @return [Array<String>] completions
+      def complete(so_far)
+        if so_far =~ / ([^ ]*)\z/
+          list(/\A#{Regexp.last_match(2)}/).map(&:name)
+        else
+          list.map(&:name)
+        end
+      end
+
+      # Installs a gem with all its dependencies.
+      #
+      # @param [String] name
+      # @return [void]
+      def install(name)
+        require 'rubygems/dependency_installer'
+        gem_config = Gem.configuration['gem']
+        gemrc_opts = (gem_config.nil? ? "" : gem_config.split(' '))
+        destination = if gemrc_opts.include?('--user-install')
+                        Gem.user_dir
+                      elsif File.writable?(Gem.dir)
+                        Gem.dir
+                      else
+                        Gem.user_dir
+                      end
+        installer = Gem::DependencyInstaller.new(install_dir: destination)
+        installer.install(name)
+      rescue Errno::EACCES
+        raise CommandError,
+              "Insufficient permissions to install #{green(name)}."
+      rescue Gem::GemNotFoundException
+        raise CommandError,
+              "Gem #{green(name)} not found. Aborting installation."
+      else
+        Gem.refresh
+      end
+    end
+  end
+end

data/lib/pry-gem/version.rb

@@ -0,0 +1,3 @@
+module PryGem
+  VERSION = '1.0.0'.freeze
+end

data/spec/gem_list_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe "gem-list" do
+  let(:pry) { Pry.new }
+
+  it 'should work arglessly' do
+    list = pry_eval('gem-list')
+    expect(list).to match(/rspec \(/)
+  end
+
+  it 'should find arg' do
+    prylist = pry_eval('gem-list rspec')
+    expect(prylist).to match(/rspec-core \(/)
+  end
+
+  it 'should return non-results as silence' do
+    expect(pry_eval('gem-list aoeuoueouaou')).to be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'pry-gem'
+require 'pry/testable'
+require 'rspec'
+
+RSpec.configure do |c|
+  c.order = 'random'
+  c.color = true
+  c.disable_monkey_patching!
+  c.include Pry::Testable::Evalable
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pry-gem
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kyrylo Silin
+- Robert Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !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'
+description: 
+email:
+- silin@kyrylo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pry-gem.rb
+- lib/pry-gem/gem_cd.rb
+- lib/pry-gem/gem_install.rb
+- lib/pry-gem/gem_list.rb
+- lib/pry-gem/gem_open.rb
+- lib/pry-gem/gem_readme.rb
+- lib/pry-gem/gem_search.rb
+- lib/pry-gem/gem_stat.rb
+- lib/pry-gem/rubygem.rb
+- lib/pry-gem/version.rb
+- spec/gem_list_spec.rb
+- spec/spec_helper.rb
+homepage: http://pryrepl.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A collection of commands to work with gems within Pry
+test_files:
+- spec/spec_helper.rb
+- spec/gem_list_spec.rb