irbtools 1.7.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc5dfb78450feaf9825ea3493ea0963bc615459
-  data.tar.gz: 77fb25ba999ee31c84d838ed2ab202d494e2a1c7
+  metadata.gz: bd8775be982770b7eccbe9b8a373d17dbde79af3
+  data.tar.gz: 2b6b6ca680bbe778b051ba48a02a23a21e92fe9b
 SHA512:
-  metadata.gz: 241cbd2266bbf07dc84ffd03ca4ed44e185764195c876dd120b3a896655b7022f1a31d647293d7f69426aa6369f6b464f13ed6542464d6f0deacceff91663c07
-  data.tar.gz: 4d3421692e19e5d76846b8afdf7ea105e82d4e3f5187d7e378dc5278db2a02424054c7a56c2a5e57d5601aeb12cdb9a36e421b325325264f7ff98891d43e67b9
+  metadata.gz: 2551c24c94f4afd8138c6fc058564c3f46348edf367ecd2584d9e7887b7333ca38e67e38c3ecce2feedde8db044c11f122333986236520f355cecb845d9b6093
+  data.tar.gz: 650846cfed1e20fae1d16f02cb4f9531be6fd8b16bfe1967d22a86e648aedd1cd3ef9d1d458b0940a9db1cf98833093ba56cea847f27c9d03c70601a1055262c

data/{CHANGELOG → CHANGELOG.txt}

@@ -1,3 +1,17 @@
+2.0.0
+* Use Wirb 2.0 and FancyIrb 1.0
+* Drop support for Ruby 1
+* Simplify starting from code via: require 'irbtools/binding'
+* Rename method to show a method's source to: code
+* Add instance gem
+* Remove code organization gems (boson + alias)
+* Don't add '.' to the load path, use rr (require_relative) instead
+* Improve loading order of libraries
+* Remove aliases for Irbtools configuration
+* Integrate irbtools-more into irbtools main repo
+* EveryDayIrb now gets released on its own, instead with every new irbtools version
+* Improve documentation in Readme
+
 1.7.1
 * bump binding.repl, hirb, methodfinder
 

data/CONFIGURE.md

@@ -0,0 +1,55 @@
+## Advanced Tweaking
+### Welcome Message
+
+The welcome message can be customized with `Irbtools.welcome_message=`
+
+### Customize Libraries to Load
+
+It is possible to modify, which libraries to load:
+
+    # Don't require 'irbtools', but:
+    require 'irbtools/configure'
+    # Here you can modify the libraries using the methods below
+    Irbtools.start
+
+If you do not want to load the default set of **irbtools** gems, you will have
+to use `require 'irbtools/minimal'` instead of `configure`.
+
+You can use the following methods:
+
+*   `Irbtools.add_library(lib, options_hash, &block)`
+*   `Irbtools.remove_library(lib)`
+
+
+The `options_hash` defines the way in which **irbtools** loads the library.
+The following options are possible
+(no options)/`:start`
+:   The library is required on startup before doing anything else (before
+    displaying the prompt)
+`:thread => identifier`
+:   After loading everything else, the library is required in a thread (while
+    continuing loading). You can choose any identifier, but if you take the
+    same one for multiple libraries, they will be loaded in the same thread
+    (in the order that you define)
+`:late => true`
+:   The library is required just before showing the prompt.
+`:late_thread => identifier`
+:   Same as `:thread`, but after loading late libraries.
+`:sub_session => true`
+:   The library is loaded every time a sub-session starts (using
+    `IRB.conf[:IRB_RC]`). In [ripl](https://github.com/cldwalker/ripl),
+    `ripl-after_rc` is used.
+`:autoload => :Constant`
+:   Use Ruby's `autoload` feature. It loads the library as soon as the
+    constant is encountered.
+
+
+You can pass a block as third argument, which gets executed after the library
+has completed loading (except for `:autoload`, in which case the code will be
+executed directly on startup). You can modify the callbacks by using
+`Irbtools.add_library_callback` and `Irbtools.replace_library_callback`.
+
+When adding a new library, you should firstly consider some way to load it via
+`:autoload`. If this is not possible, try loading via `:thread`. If that is
+not possible either, you will need to fallback to the default loading
+mechanism.

data/{MIT-LICENSE → MIT-LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2014 Jan Lelis
+Copyright (c) 2010-2015 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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/Rakefile

@@ -1,7 +1,7 @@
-# require 'rake'
 require 'fileutils'
 require "rspec/core/rake_task"
 
+
 task :test => :spec
 task :default => :spec
 RSpec::Core::RakeTask.new(:spec) do |t|
@@ -10,36 +10,38 @@ end
 
 
 def gemspec1
-  @gemspec1 ||= eval(File.read('irbtools.gemspec'), binding, 'irbtools.gemspec')
+  @gemspec1 ||= eval(File.read('every_day_irb.gemspec'), binding, 'every_day_irb.gemspec')
 end
 
 def gemspec2
-  @gemspec2 ||= eval(File.read('every_day_irb.gemspec'), binding, 'every_day_irb.gemspec')
+  @gemspec2 ||= eval(File.read('irbtools.gemspec'), binding, 'irbtools.gemspec')
+end
+
+def gemspec3
+  @gemspec3 ||= eval(File.read('irbtools-more.gemspec'), binding, 'irbtools-more.gemspec')
 end
 
-desc "Build the gem"
+desc "Build the gems"
 task :gem => :gemspec do
-  sh "gem build irbtools.gemspec"
-  sh "gem build every_day_irb.gemspec"
+  sh "gem build #{gemspec1.name}.gemspec"
+  sh "gem build #{gemspec2.name}.gemspec"
+  sh "gem build #{gemspec3.name}.gemspec"
   FileUtils.mkdir_p 'pkg'
   FileUtils.mv "#{gemspec1.name}-#{gemspec1.version}.gem", 'pkg'
   FileUtils.mv "#{gemspec2.name}-#{gemspec2.version}.gem", 'pkg'
+  FileUtils.mv "#{gemspec3.name}-#{gemspec3.version}.gem", 'pkg'
 end
 
 desc "Install the gem locally (without docs)"
 task :install => :gem do
-  sh %{gem install pkg/#{gemspec2.name}-#{gemspec2.version}.gem --no-rdoc --no-ri}
-  sh %{gem install pkg/#{gemspec1.name}-#{gemspec1.version}.gem --no-rdoc --no-ri}
-end
-
-desc "Generate the gemspec"
-task :generate do
-  puts gemspec1.to_ruby
-  puts gemspec2.to_ruby
+  sh %{gem install pkg/#{gemspec1.name}-#{gemspec1.version}.gem --no-document}
+  sh %{gem install pkg/#{gemspec2.name}-#{gemspec2.version}.gem --no-document}
+  sh %{gem install pkg/#{gemspec3.name}-#{gemspec3.version}.gem --no-document}
 end
 
 desc "Validate the gemspec"
 task :gemspec do
   gemspec1.validate
   gemspec2.validate
+  gemspec3.validate
 end

data/irbtools.gemspec

@@ -1,57 +1,66 @@
 # -*- encoding: utf-8 -*-
-require File.dirname(__FILE__) + '/lib/irbtools/configure'
+require File.dirname(__FILE__) + '/lib/irbtools/version'
 
 Gem::Specification.new do |s|
   s.name = 'irbtools'
   s.version = Irbtools::VERSION
 
+  s.homepage              = 'https://github.com/janlelis/irbtools'
   s.authors               = ["Jan Lelis"]
-  s.summary               = 'irbtools happy irb.'
-  s.description           = "irbtools makes using Ruby's IRB easier and more fun. Put a require 'irbtools' in a .irbrc file in your home directory to get started."
+  s.summary               = 'Irbtools happy IRB.'
+  s.description           = "Irbtools make Ruby's IRB more productive."
   s.email                 = 'mail@janlelis.de'
-  s.extra_rdoc_files      = %w[MIT-LICENSE README.rdoc]
-  s.files                 = %w[lib/irbtools.rb lib/irbtools/configure.rb lib/irbtools/libraries.rb lib/irbtools/minimal.rb CHANGELOG Rakefile irbtools.gemspec]
-  s.homepage              = 'https://github.com/janlelis/irbtools'
-  s.required_ruby_version = '>= 1.9.3'
+  s.files                 = %w[
+    lib/irbtools.rb
+    lib/irbtools/version.rb
+    lib/irbtools/configure.rb
+    lib/irbtools/implementation.rb
+    lib/irbtools/libraries.rb
+    lib/irbtools/non_fancy.rb
+    lib/irbtools/hirb.rb
+    lib/irbtools/minimal.rb
+    lib/irbtools/binding.rb
+    Rakefile
+    irbtools.gemspec
+  ]
+  s.extra_rdoc_files      = %w[
+    README.md
+    CONFIGURE.md
+    CHANGELOG.txt
+    MIT-LICENSE.txt
+  ]
   s.license               = 'MIT'
 
-  # functionality
-  s.add_dependency %q<every_day_irb>, ">= #{ s.version }"
-  s.add_dependency %q<binding.repl>,  "~> 3.0"
-  s.add_dependency %q<boson>,         "~> 1.3.0"
-  s.add_dependency %q<boson-more>,    "~> 0.3.0"
-  s.add_dependency %q<alias>,         "~> 0.2.3"
-  s.add_dependency %q<clipboard>,     "~> 1.0.5"
-  s.add_dependency %q<interactive_editor>, ">= 0.0.10"
+  s.required_ruby_version = '~> 2.0'
+  s. add_development_dependency 'rspec', '~> 3.2'
+  s. add_development_dependency 'rake', '~> 10.4'
+
+  # # #
+  # Dependencies
 
-  # irb patches / display helpers
-  s.add_dependency %q<fancy_irb>,     ">= 0.7.3"
-  s.add_dependency %q<wirb>,          ">= 1.0.3"
-  s.add_dependency %q<paint>,         ">= 0.8.7"
+  # core functionality
+  s.add_dependency %q<every_day_irb>, "~> 2.0"
+  s.add_dependency %q<fancy_irb>,     "~> 1.0"
+  s.add_dependency %q<wirb>,          "~> 2.0"
   s.add_dependency %q<hirb>,          "~> 0.7", ">= 0.7.3"
-  s.add_dependency %q<coderay>,       "~> 1.1.0"
+  s.add_dependency %q<binding.repl>,  "~> 3.0"
 
-  # debugging
-  s.add_dependency %q<debugging>,     "~> 1.0"
-  s.add_dependency %q<g>,             ">= 1.7.2"
+  # utils
+  s.add_dependency %q<paint>,         ">= 0.9", "< 2.0"
+  s.add_dependency %q<clipboard>,     "~> 1.0", ">= 1.0.6"
+  s.add_dependency %q<interactive_editor>, "~> 0.0", ">= 0.0.10"
+  s.add_dependency %q<coderay>,       "~> 1.1"
+  s.add_dependency %q<debugging>,     "~> 1.1"
+  s.add_dependency %q<g>,             "~> 1.7", ">= 1.7.2"
 
   # introspection / docs
+  s.add_dependency %q<code>,          "~> 0.9"
   s.add_dependency %q<ori>,           "~> 0.1.0"
   s.add_dependency %q<methodfinder>,  "~> 2.0"
-  s.add_dependency %q<method_locator>,">= 0.0.4"
-  s.add_dependency %q<method_source>, ">= 0.8.2"
-
-  # information
+  s.add_dependency %q<method_locator>,"~> 0.0", ">= 0.0.4"
   s.add_dependency %q<ruby_version>,  "~> 1.0"
   s.add_dependency %q<ruby_engine>,   "~> 1.0"
   s.add_dependency %q<ruby_info>,     "~> 1.0"
   s.add_dependency %q<os>,            "~> 0.9"
-
-  len = s.homepage.size
-  s.post_install_message = \
-    "       ┌── " + "info ".ljust(len-2,'─')                         + "─┐\n" +
-    " J-_-L │ "   + s.homepage                                       + " │\n" +
-    "       ├── " + "usage ".ljust(len-2,'─')                        + "─┤\n" +
-    "       │ "   + "require 'irbtools'".ljust(len,' ')              + " │\n" +
-    "       └─"   + '─'*len                                          + "─┘"
+  s.add_dependency %q<instance>,      "~> 0.2"
 end