irbtools-more 1.7.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf26a9ff4aefb4be16ff43acf63d8e248f741cc7
-  data.tar.gz: 69269c9ee85167370323c398a951a836dc21dd10
+  metadata.gz: ff4dd7105b11ed9d3fd8b5237f40b8acbfe681e9
+  data.tar.gz: f96ebacf9fc0890463e36d14e3d618eddfd3bde6
 SHA512:
-  metadata.gz: bf69a3a8170ce32b9c7b99a5e1623f4a21b86e067c1016bc989b3bd57d573297fcddcd073da590ef574ecdaeb8c904e301c0d0b1913115f2107e63b9bce17d0b
-  data.tar.gz: 662a60026aec29b9b51de56deed7276d9c81dd1de36cd790a01e16a1d06f4581e40cb875ae3d3fc31ca8433962872da0048f0be88f846a4747353130e5e1fe9f
+  metadata.gz: c44bd5ff8423af18cd1daaeaa171642c615aa70bac09fb05acadc7b5cc78df57b2b465e4abc64153a9decc4428be9d5dcd45c47428485996b33cd99448e3a5c9
+  data.tar.gz: 7fc54f0e622be8906f04682acd5599edc53ad83879d2867f48bbde1d437ed9aceeb3253637766c684db25a677181f89d66089c7935e993f2fc2136eb702f6d28

data/{CHANGELOG → CHANGELOG-MORE.txt}

@@ -1,3 +1,8 @@
+== 2.0.0
+* Integrate more-repo into irbtools main repo
+* Improve auto-completion
+* Remove Object#l alias for looksee, use Object#lp
+
 == 1.7.2
 * Bump did_you_mean and looksee (Ruby 2.2 compat)
 

data/README.md

@@ -0,0 +1,195 @@
+# Irbtools [![version](https://badge.fury.io/rb/irbtools.svg)](http://badge.fury.io/rb/irbtools)
+
+     _ _|        |      |                  |
+       |    __|  __ \   __|   _ \    _ \   |   __|
+       |   |     |   |  |    (   |  (   |  | \__ \
+     ___| _|    _.__/  \__| \___/  \___/  _| ____/
+
+
+Improvements for Ruby's IRB console, like colored output and a lot of
+debugging and introspection methods. Unlike with PRY, you are still in your
+normal IRB. It is designed to work out-of-the-box, so there is no reason to not
+use it!
+
+## Setup
+
+    $ gem install irbtools
+
+IRB executes code in `~/.irbrc` on start-up. If the file does not exist, yet,
+just create a new one. Add the following content:
+
+    require 'irbtools'
+
+You also need to add irbtools to your project's Gemfile:
+
+    gem 'irbtools', require: 'irbtools/binding'
+
+Then start IRB (with **Irbtools** loaded) from the console or directly from your code with:
+
+    binding.irb
+
+If the `binding_of_caller` gem is available (e.g. see below), you can omit the `binding`:
+
+    irb
+
+### More Improvements
+
+Some suggested gems will not be installed to ensure wider general support. For
+the full feature set, you can add **irbtools-more** and change your
+`.irbrc` to:
+
+    require 'irbtools/more'
+
+and edit your Gemfile to
+
+    gem 'irbtools-more', require: 'irbtools/binding'
+
+
+### Included Gems and Libraries
+#### IRB Improvements
+
+*   Colored output:
+    [wirb](https://github.com/janlelis/wirb/)
+    [fanycy_irb](https://github.com/janlelis/fancy_irb)
+*   Custom views for specific objects:
+    [hirb](http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html)
+*   **(irbtools-more)** Correction suggestions for misspelled method/constant names:
+    [did_you_mean](https://github.com/yuki24/did_you_mean)
+*   **(irbtools-more)** Better tab-completion:
+    [bond](http://tagaholic.me/bond/)
+
+#### Utils
+
+*   Useful IRB commands (see below):
+    [every_day_irb](https://github.com/janlelis/irbtools/tree/master/lib/every
+    _day_irb.rb)
+    [debugging](https:/github.com/janlelis/debugging)
+    [fileutils](http://ruby-doc.org/stdlib-2.2.1/libdoc/fileutils/rdoc/FileUtils.html)
+*   Clipboard Access:
+    [clipboard](https://github.com/janlelis/clipboard)
+*   Terminal colors:
+    [paint](https://github.com/janlelis/paint)
+*   Load an editor into your IRB session:
+    [interactive_editor](https://github.com/jberkel/interactive_editor)
+
+#### Introspection
+
+*   Displays a method's source:
+    [code](https://github.com/janlelis/code)
+*   Access to `ri` docs:
+    [ori](https://github.com/dadooda/ori)
+*   Manipulate instance variables with ease:
+    [instance](https://github.com/rubyworks/instance/)
+*   Platform information:
+    [ruby_version](https://github.com/janlelis/ruby_version)
+    [ruby_engine](https://github.com/janlelis/ruby_engine)
+    [os](https://github.com/rdp/os)
+    [ruby_info](https://github.com/janlelis/ruby_info)
+*   Improved method lookup path inspection:
+    [method_locator](https://github.com/ryanlecompte/method_locator)
+*   Finds methods that turn one value into another value:
+    [methodfinder](https://github.com/citizen428/methodfinder)
+*   **irbtools-more** Awesome lookup path inspection:
+    [looksee](https://github.com/oggy/looksee)
+
+
+### Irbtools Methods
+
+Besides improving IRB itself, you will get the following methods:
+
+Method | Arguments  | Description
+------ | ---------- | -----------
+`beep` | | Ring terminal bell.
+`cat` | path | Read file contents.
+`cd` | path = nil | Changes the directory. Can also be used in these forms: `~cd` (change to home directory), `-cd` (change to previous directory).
+`clear` | | Clear the terminal.
+`code` | object = self, method_name | Display the method source with syntax highlighting. Will also look up C methods if the **core_docs** gem is available.
+`colorize` | string | Syntax highlight a Ruby string.
+`copy` | string | Copy something to the clipboard.
+`copy_input` | | Copy session history to the clipboard.
+`copy_output` | | Copy session output history to the clipboard.
+`ed` / `emacs` / `mate` / `mvim` / `nano` / `vi` / `vim` | filename = nil | Start an editor in the session context.
+`engine` | | Show the Ruby engine.
+`g` | *args | Like `Kernel#p`, but using terminal-notifier or growl.
+`howtocall` | object = self, method_or_proc | Displays parameter names and types for a proc or method.
+`info` | | List general information about the Ruby environment.
+`ld` | file | Shortcut for `load lib.to_s + '.rb'`.
+`ls` | path = "." | List directory content.
+`mf` | object1, object2 | Find methods that turn one value into another value:w
+`mof` | object, depth = 0, grep = // | Print a method list, ordered by modules.
+`os` | | Query operating system information.
+`pa` | string, color | Print a string in the specified color.
+`page` | what, options = {} | Page long content.
+`paste` | | Paste clipboard content.
+`q` | *args | Like `Kernel#p`, but prints results on one line, with different colors.
+`ray` | path | Syntax highlight a Ruby file.
+`re` | string, regexg, groups = nil | Assists you when matching regexes againts strings.
+`reset!` | | Restart the current IRB session.
+`rq` | lib | Shortcut for `require lib.to_s`. Use it like this: `rq:prime`.
+`rrq` / `rerequire` | lib | Hack to remove a library from `$LOADED_FEATURES` and `require` it again.
+`session_history` | number_of_lines = nil | Return a string of all commands issued in the current session.
+`version` | | Show the Ruby version.
+`wp` | inspect_string | Syntax-highlight a Ruby object.
+`Object#instance` | | Proxy object to read and manipulate instance variables / run eval.
+`Object#lp` | | **irbtools-more** Supercharged method introspection in IRB
+`Object#mlp` / `Object#method_lookup_path` | | Traverse an object's method lookup path to find all places where a method may be defined.
+`Object#ri` | *args | Show ri documentation for this object or method.
+
+
+### Advanced tweaking
+
+See [CONFIGURE.md](https://github.com/janlelis/irbtools/blob/master/CONFIGURE.md).
+
+
+### Troubleshooting: ANSI colors on Windows
+
+Windows: ANSI support can be enabled via
+[ansicon](https://github.com/adoxa/ansicon) or
+[ConEmu](http://code.google.com/p/conemu-maximus5/).
+
+
+### Troubleshooting: Clipboard not working on Linux
+
+Clipboard support requires **xclip** or **xsel**. On ubuntu, do: `sudo apt-get
+install xclip`
+
+
+### Troubleshooting: Unicode causes wrong display widths
+
+If you use double-width unicode characterss, you will need to paste the
+following snippet to your `.irbrc` file.
+
+    Irbtools.replace_library_callback :fancy_irb do
+      FancyIrb.start east_asian_width: true
+    end
+
+This setting is deactivated by default, because of performance issues.
+
+
+### Hint: Debundle
+
+If you do not want to add **Irbtools** to your project's Gemfile, you will need a
+[debundle hack](https://github.com/janlelis/debundle.rb). Put it at the
+beginning of your `~/.irbrc` file and you are fine (until it breaks).
+
+
+### Hint: No ANSI / IRB extension
+
+You can use Irbtools without colors/irb extensions. To do so, put this into `~/.irbrc`:
+
+```ruby
+require 'irbtools/non_fancy'
+Irbtools.start
+```
+
+
+### Hint: Web Console
+
+**Irbtools** works well together with the amazing
+[web-console!](https://github.com/rails/web-console)
+
+
+## J-_-L
+
+Copyright (c) 2010-2015 Jan Lelis <http://janlelis.com> released under the MIT
+license.

data/irbtools-more.gemspec

@@ -1,22 +1,33 @@
 # -*- encoding: utf-8 -*-
-require File.dirname(__FILE__) + "/lib/irbtools/more"
+require File.dirname(__FILE__) + "/lib/irbtools/more/version"
 
 Gem::Specification.new do |s|
   s.name = 'irbtools-more'
   s.version = Irbtools::More::VERSION
-  s.license               = 'MIT'
+
+  s.homepage              = 'https://github.com/janlelis/irbtools'
   s.authors               = ["Jan Lelis"]
-  s.email                 = %q{mail@janlelis.de}
-  s.homepage              = %q{https://github.com/janlelis/irbtools-more}
   s.summary               = 'irbtools-more adds bond and looksee to IRB.'
   s.description           = 'irbtools-more adds bond and looksee to IRB (Gems that use core extensions). Simply put a require "irbtools/more" in the .irbrc file in your home directory to get started.'
-  s.extra_rdoc_files      = %w[MIT-LICENSE README.rdoc]
-  s.files                 = Dir.glob(%w[lib/**/*.rb ]) + %w{CHANGELOG Rakefile irbtools-more.gemspec}
-  s.required_ruby_version = '>= 1.9.3'
-  s.add_dependency 'irbtools', '~> 1.7'
+  s.email                 = 'mail@janlelis.de'
+  s.files                 = %w[
+    lib/irbtools/more.rb
+    lib/irbtools/more/version.rb
+    lib/bond/completions/irbtools.rb
+    irbtools-more.gemspec
+  ]
+  s.extra_rdoc_files      = %w[
+    README.md
+    CHANGELOG-MORE.txt
+    MIT-LICENSE.txt
+  ]
+  s.license               = 'MIT'
+
+  s.required_ruby_version = '~> 2.0'
+  s.add_dependency 'irbtools', '~> 2.0'
   s.add_dependency 'bond',     '~> 0.5'
-  s.add_dependency 'looksee' , '~> 3.0', '>= 3.0.1'
+  s.add_dependency 'looksee' , '~> 3.1'
   s.add_dependency 'binding_of_caller', '~> 0.7'
-  s.add_dependency 'did_you_mean', '~> 0.9', '>= 0.9.5'
+  s.add_dependency 'did_you_mean', '~> 0.9', '>= 0.9.6'
 end
 

data/lib/bond/completions/irbtools.rb

@@ -1,18 +1,97 @@
-# encoding: utf-8
+# # #
+# completion actions
 
-# TODO more ;)
+none = ->(*){ [] }
 
-def send_methods(obj)
-  (obj.methods + obj.private_methods(false)).map {|e| e.to_s } - Mission::OPERATORS
-end
+send_completion = ->(e){
+ if e.arguments.empty?
+   [':']
+ else
+   e.object.methods.map(&:to_s) - Mission::OPERATORS
+ end
+}
 
-complete(:method=>"Object#ri") {|e|
+public_send_completion = ->(e){
  if e.arguments.empty?
    [':']
  else
-   # from bond send
-   (e.object.methods + e.object.private_methods(false)).map {|e| e.to_s } - Mission::OPERATORS
+   e.object.public_methods.map(&:to_s) - Mission::OPERATORS
  end
 }
 
-# J-_-L
+directories = ->(e){
+  if e.arguments.empty?
+    ['"']
+  else
+    files(e).select{ |f| File.directory?(f) }
+  end
+}
+
+files = ->(e){
+  if e.arguments.empty?
+    ['"']
+  else
+    files(e)
+  end
+}
+
+
+ruby_files = ->(e){
+  if e.arguments.empty?
+    ['"']
+  else
+    Dir["./**/*.{rb,bundle,dll,so}"].map{ |f| f.sub('./', '') }.uniq
+  end
+}
+
+ruby_files_with_load_path = ->(e){
+  if e.arguments.empty?
+    ['"']
+  else
+    ($:.flat_map{ |lf|
+      Dir["#{lf}/**/*.{rb,bundle,dll,so}"].map{ |f| f.sub(lf + '/', '') }
+    } + Gem.path.flat_map{ |gm|
+      Dir["#{gm}/gems/*/lib/*.{rb,bundle,dll,so}"].map{ |f| f.sub(/^.*\//,'') }
+    }).map{ |f| f.sub(/\.(?:rb|bundle|dll|so)$/, '') }.uniq
+  end
+}
+
+# # #
+# base ruby
+
+complete method: "Object#send", &send_completion
+complete method: "Object#method", &send_completion
+complete method: "Object#public_method", &public_send_completion
+complete method: "Object#public_send", &public_send_completion
+
+complete method: "#require", search: :files, &ruby_files_with_load_path
+complete method: "#rq", search: :files, &ruby_files_with_load_path
+complete method: "#rerequire", search: :files, &ruby_files_with_load_path
+complete method: "#rrq", search: :files, &ruby_files_with_load_path
+complete method: "#require_relative", &ruby_files
+complete method: "#rr", &ruby_files
+complete method: "#load", &ruby_files
+
+# # #
+# irbtools
+
+# methods
+complete method: "#howtocall", &send_completion
+complete method: "#code", &send_completion
+complete method: "Object#ri", &send_completion
+
+# files
+complete method: "ls", &directories
+complete method: "cd", &directories
+complete method: "cat", &files
+
+# nops
+complete method: "#reset!", &none
+complete method: "#clear", &none
+complete method: "#beep", &none
+complete method: "#session_history", &none
+complete method: "#info", &none
+complete method: "#version", &none
+complete method: "#engine", &none
+complete method: "#os", &none
+complete method: "Object#lp", &none

data/lib/irbtools/more.rb

@@ -1,43 +1,22 @@
-# check if loaded_directly to decide if Irbtools.init should be called
 standalone = !(defined? Irbtools)
 
-# define version
-module Irbtools
-  module More
-    VERSION = '1.7.2'
-  end
-end
-
-# require base package
-if standalone
-  begin
-    require 'irbtools/configure'
-  rescue LoadError
-    raise "Sorry, the irbtools-more package couldn't load, because the irbtools gem is not available"
-  end
-end
+require_relative 'more/version'
 
-# # # libraries
+require 'irbtools/configure'
 
 # Better auto-completion
-Irbtools.add_library :bond, :thread => 'more_2' do
+Irbtools.add_library :bond, thread: :more1 do
   Bond.start :gems => %w[irbtools]
 end
 
 # Object#l method for inspecting its lookup path
-Irbtools.add_library 'looksee', late_thread: :c do
-  Looksee.rename :l
-  class Object; def lp() l end; end
+Irbtools.add_library 'looksee', thread: :more2 do
+  Looksee.rename :lp
 end
 
-# repl method
-Irbtools.add_library 'binding_of_caller', thread: 'more_3'
-Irbtools.add_library 'debugging/repl', thread: 'more_3'
-
 # new guessmethod
-Irbtools.add_library 'did_you_mean', thread: 'more_4'
+Irbtools.add_library 'did_you_mean', thread: :more3
 
 # load now
 Irbtools.start if standalone
 
-# J-_-L

data/lib/irbtools/more/version.rb

@@ -0,0 +1,5 @@
+module Irbtools
+  module More
+    VERSION = '2.0.0'.freeze
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: irbtools-more
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irbtools
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bond
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +75,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +85,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.6
 description: irbtools-more adds bond and looksee to IRB (Gems that use core extensions).
   Simply put a require "irbtools/more" in the .irbrc file in your home directory to
   get started.
@@ -99,17 +93,18 @@ email: mail@janlelis.de
 executables: []
 extensions: []
 extra_rdoc_files:
-- MIT-LICENSE
-- README.rdoc
+- README.md
+- CHANGELOG-MORE.txt
+- MIT-LICENSE.txt
 files:
-- CHANGELOG
-- MIT-LICENSE
-- README.rdoc
-- Rakefile
+- CHANGELOG-MORE.txt
+- MIT-LICENSE.txt
+- README.md
 - irbtools-more.gemspec
 - lib/bond/completions/irbtools.rb
 - lib/irbtools/more.rb
-homepage: https://github.com/janlelis/irbtools-more
+- lib/irbtools/more/version.rb
+homepage: https://github.com/janlelis/irbtools
 licenses:
 - MIT
 metadata: {}
@@ -119,9 +114,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: irbtools-more adds bond and looksee to IRB.

data/README.rdoc

@@ -1,40 +0,0 @@
-= irbtools-more
-
-<tt>irbtools-more</tt> adds more IRB gems which may not build out-of-the-box. Currently included: <tt>bond</tt> for better auto-completion and <tt>looksee</tt> for great method introspection. The <tt>did_you_mean</tt> gem is included to improve error stacktraces. It also adds the <tt>binding_of_caller</tt> gem to enable starting IRB by just calling <tt>repl</tt> anywhere in your code. See the {irbtools readme}[https://github.com/janlelis/irbtools] for details.
-
-
-== Setup
-
-=== With bundler
-
-In your <tt>Gemfile</tt> put:
-
-  gem 'irbtools-more', require: 'debugging/repl'
-
-
-=== With bundler (debundle hack)
-
-See {debundle.rb}[https://github.com/janlelis/debundle.rb].
-
-
-=== Without bundler
-
-  gem install irbtools-more
-
-
-== Usage
-
-To use it, put the following in your <tt>~/.irbrc</tt> file (this file is loaded every time you start an irb, just create the file, if it does not exist, yet):
-
-  require 'irbtools/more'
-
-If you want to customize which libraries you want to use, you can load irbtools-more explicitely:
-
-  require 'irbtools/configure'
-  Irbtools.add_package :more # adds this extension package
-  Irbtools.start
-
-
-== J-_-L
-
-Copyright (c) 2010-2015 Jan Lelis, http://janlelis.com. See MIT-LICENSE for details.

data/Rakefile

@@ -1,32 +0,0 @@
-require 'rake'
-require 'fileutils'
-GEMSPEC = 'irbtools-more.gemspec'
-
-
-def gemspec
-  @gemspec ||= eval(File.read(GEMSPEC), binding, GEMSPEC)
-end
-
-desc "Build the gem"
-task :gem => :gemspec do
-  sh "gem build " + GEMSPEC
-  FileUtils.mkdir_p 'pkg'
-  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
-end
-
-desc "Install the gem locally"
-task :install => :gem do
-  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}.gem --no-rdoc --no-ri}
-end
-
-desc "Generate the gemspec"
-task :generate do
-  puts gemspec.to_ruby
-end
-
-desc "Validate the gemspec"
-task :gemspec do
-  gemspec.validate
-end
-
-task :default => :test