irbtools 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56c70830364ce3c1dcb8aa748b33587fdd0c85df
-  data.tar.gz: 789585cb1ebb48e5cd0ea0e95116d390609d63d5
+  metadata.gz: 633476b7bd03365d6fd418263557b9e57cb222c9
+  data.tar.gz: f94cdf342de1c51305e691f93a6dc2cbfa702eac
 SHA512:
-  metadata.gz: 8dbf1a730072f970412aaf53ed10c97f09daf4ee6b4bc1cfd67a9eacf0846b1c324bcc082421c8d39251edd2384595da411e3f377f2c7ae9137132044c7227e4
-  data.tar.gz: caa4b3a32be62122c0f25bdcf1e27617184c1222e329ece047b5e0a2d0f204a26de9226c2fe1daad3e82868cf035900a4340781ae7079ceec5e81178271b33a0
+  metadata.gz: df68612861c08d453c98f20d41325740b9b2ec31510df2c74e8dbbf7cd2310388de96519ef0387600f44542aae5c6c0fbf54ba8c8cde16402f84a49362f27f35
+  data.tar.gz: 66745790e85da24063af166545b6be213a387c5760c01a72ef4c71bf2c75878e4cd0bc92cb1dcbeb96bbb5fcc19f25ffd35df637f8ac7f113b45981181e0416c

data/CHANGELOG

@@ -1,3 +1,8 @@
+1.7.0
+* bump boson, boson-more, binding.repl
+* required ruby version: 1.9.3
+* remove awesome_print
+
 1.6.1
 * don't load debugging/repl by default
 * rename re method to engine and rv to version

data/README.rdoc

@@ -1,36 +1,42 @@
 = irbtools
 
-Improvements fro Ruby's IRB console. Everything is colorful and you will get lots of console helpers. 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!
+Improvements for Ruby's IRB console, for example, 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
 
-* On Linux, you will need +xclip+ or +xsel+ for a functional clipboard: <tt>sudo apt-get install xclip</tt>
-* On Windows, you will need ansicon[https://github.com/adoxa/ansicon] to enable ANSI colors
-* On Mac OS, you will need growl, to use the +g+ gem
+
+=== Extra Requirements
+
+Linux: Clipboard support requires *xclip* or *xsel*: <tt>sudo apt-get install xclip</tt>
+
+Windows: ANSI colors can be enabled via ansicon[https://github.com/adoxa/ansicon]
+
+Mac OS: The g gem makes use of *growl*
 
 
 == Usage
 
-To use *irbtools*, put the following in your <tt>~/.irbrc</tt> file (it is loaded every time you start irb):
+IRB executes code in <tt>~/.irbrc</tt> on start-up. If the file does not exist, yet, just create a new one. Add the following:
 
   require 'irbtools'
 
-If the file does not exist, just create a new one. See further below on how to customize loaded libraries.
+See further below, if you want to customize which libraries should be loaded on IRB start-up.
 
 
-=== Rails/Bundler Notes
+=== With Bundler
 
-To integrate *irbtools* into a Rails console, you should <tt>irbtools</tt> to your Gemfile:
+To integrate *irbtools* into a Rails console (or any project that uses bundler), add <tt>irbtools</tt> to your Gemfile:
 
   gem 'irbtools', require: 'binding.repl'
 
-Thanks to help from the {binding.repl}[https://github.com/robgleeson/binding.repl] gem, you can start IRB (with *irbtools*) directly from your code:
+Thanks to help from the {binding.repl gem}[https://github.com/robgleeson/binding.repl], you can start IRB (with *irbtools*) directly from your code:
 
   binding.repl!
 
+
 === Debundle
 
 Another way to activate *irbtools* in bundler projects is to add a {debundle hack}[https://github.com/janlelis/debundle.rb] at the beginning of your <tt>~/.irbrc</tt> file.
@@ -38,41 +44,60 @@ Another way to activate *irbtools* in bundler projects is to add a {debundle hac
 
 === This is irbtools Light
 
-When installing *irbtools*, some gems will not be installed to ensure Windows OS support, e.g. the bond gem for better auto-completion or the looksee gem. These are packaged into the {irbtools-more}[https://github.com/janlelis/irbtools-more] gem. To use <tt>irbtools-more</tt>, you will need to change your <tt>.irbrc</tt> to:
+When installing *irbtools*, some gems will not be installed to ensure Windows OS support, for example, the bond gem for better auto-completion or the looksee gem for method/class introspection. These are packaged as {irbtools-more}[https://github.com/janlelis/irbtools-more]. To use <tt>irbtools-more</tt>, you will need to change your <tt>.irbrc</tt> to:
 
   require 'irbtools/more'
 
+and/or edit your Gemfile to
+
+  gem 'irbtools-more', require: 'binding.repl'
+
 
 === Included Gems and Libraries
+==== IRB Improvements
+
+* Colorization: wirb[https://github.com/janlelis/wirb/]
+* IRB tweaks: fancy_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]
+* <b>(irbtools-more)</b> Better IRB tab-completion: bond[http://tagaholic.me/bond/]
+
+
+==== Helpful Methods
+
+* Useful IRB commands: every_day_irb[https://github.com/janlelis/irbtools/tree/master/lib/every_day_irb.rb]
+* Clipboard Access: clipboard[http://github.com/janlelis/clipboard]
+* Loads an editor into your IRB session: interactive_editor[https://github.com/jberkel/interactive_editor]
+* Print debugging helpers: debugging[https:/github.com/janlelis/debugging]
+* File-related system commands: *fileutils* (stdlib)
+
 
-[wirb[https://github.com/janlelis/wirb/]]                  Colorizes Ruby objects
-[hirb[http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html]]
-                                                           Custom views for specific objects, e.g. tables for ActiveRecord
-[fancy_irb[https://github.com/janlelis/fancy_irb]]         Hash rockets and colorful error messages
-[every_day_irb[https://github.com/janlelis/irbtools/tree/master/lib/every_day_irb.rb]]
-                                                           Contains helper methods that might be useful in every-day irb usage, see below for details
-[clipboard[http://github.com/janlelis/clipboard]]          Easy clipboard access
-[interactive_editor[https://github.com/jberkel/interactive_editor]]
-                                                           Lets you open vim (or emacs) from within IRB to hack something that gets loaded into the current session
-[debugging[https:/github.com/janlelis/debugging]]          Print debugging helpers (<tt>q</tt>, <tt>mof</tt>, <tt>re</tt>)
-[ap[https://github.com/michaeldv/awesome_print]]           More print debugging (<tt>ap</tt>)
-[ruby_version[https://github.com/janlelis/ruby_version]]   <tt>version</tt>
-[ruby_engine[https://github.com/janlelis/ruby_engine]]     <tt>engine</tt>
-[os[https://github.com/rdp/os]]                            <tt>os</tt>
-[ruby_info[https://github.com/janlelis/ruby_info]]         <tt>info</tt>
-[coderay[http://coderay.rubychan.de/]]                     Colorizes Ruby code (<tt>colorize</tt>, <tt>ray</tt>)
-[methodfinder[https://github.com/citizen428/methodfinder]] malltalk like method finder for Ruby (<tt>mf</tt>)
-[ori[https://github.com/dadooda/ori]]                      <tt>Object#ri</tt>
-[method_locator[https://github.com/ryanlecompte/method_locator]] Provides <tt>Object#mlp</tt> (improved version of <tt>Module#ancestors</tt>) and <tt>Object#methods_for(m)</tt> (get this method from all ancestors)
-[method_source[https://github.com/banister/method_source]] <tt>Object#src</tt> can be shown for Ruby methods
-[alias[http://tagaholic.me/2009/07/07/alias-quickness-in-the-ruby-console.html]] Easily create shortcuts for your favorite methods, even when they are nested, saved in personal yaml file
-[boson[http://tagaholic.me/boson/]]                        Command/task framework similar to rake and thor that opens your ruby universe to the commandline and irb
-[bond[http://tagaholic.me/bond/]]                          <b>irbtools-more:</b> Better IRB tab-completion
-[looksee[https://github.com/oggy/looksee]]                 <b>irbtools-more:</b> Great lookup path inspector: <tt>Object#l</tt> (Extended version of <tt>mof</tt>), also provides the ability to <tt>Object#edit</tt> methods.
-[*fileutils* (stdlib)]                                     System utility methods: <tt>cd</tt>, <tt>pwd</tt>, <tt>ln_s</tt>, <tt>mv</tt>, <tt>rm</tt>, <tt>mkdir</tt>, <tt>touch</tt>
-
-
-=== irbtools Methods (every_day_irb)
+==== Platform Information
+
+* Query current Ruby version: ruby_version[https://github.com/janlelis/ruby_version]
+* Query current Ruby engine: ruby_engine[https://github.com/janlelis/ruby_engine]
+* Query current operating system: os[https://github.com/rdp/os]
+* Global information by the interpreter behind one <tt>Info</tt> constant: ruby_info[https://github.com/janlelis/ruby_info]
+
+
+==== Introspection
+
+* Improved lookup path inspection: method_locator[https://github.com/ryanlecompte/method_locator]
+* Displays a method's source: method_source[https://github.com/banister/method_source]
+* Adds a +ri+ doc method to Object: [ori[https://github.com/dadooda/ori]
+* Finds the methods that turned a value into another value: methodfinder[https://github.com/citizen428/methodfinder]
+* Syntax highlighting: coderay[https://github.com/rubychan/coderay]
+* <b>irbtools-more</b> Awesome lookup path inspection: looksee[https://github.com/oggy/looksee]
+* <b>irbtools-more</b> Useful "did you mean?" suggestions in stack-traces: did_you_mean[https://github.com/yuki42/did_you_mean]
+
+
+==== Code Organization
+
+* Command/task framework similar to rake and thor: boson[http://tagaholic.me/boson/]
+* Shortcuts for your favorite methods, saved in personal yaml file: alias[http://tagaholic.me/2009/07/07/alias-quickness-in-the-ruby-console.html]
+
+
+=== Irbtools Methods
+==== From every_day_irb
 
 [ls]     Returns an array with the directory's content
 [cat]    Shortcut for <tt>File.read</tt>
@@ -83,47 +108,50 @@ When installing *irbtools*, some gems will not be installed to ensure Windows OS
 [clear]  Clears the terminal (<tt>system "clear"</tt>)
 [session_history] Returns all issued commands as a string
 
-irbtools also defines custom helper methods in combination with the loaded gems:
-
-[cd]     Improves the cd that is already provided by *FileUtils* (try <tt>cd '-'</tt>)
-[rv]     Displays RubyVersion
-[re]     Displays RubyEngine
-[os]     OS information
-[info]   Aggregates information about your Ruby environment
-[colorize] Syntax highlights a ruby string using *CodeRay*
-[ray]    Syntax highlights a ruby file using *CodeRay*
-[copy]   Shortcut for <tt>Clipboard.copy</tt>
-[paste]  Shortcut for <tt>Clipboard.paste</tt>
+
+==== From irbtools in conjunction with the libraries
+
+[cd]      Improves the cd that is already provided by *fileutils* (try <tt>cd '-'</tt>)
+[version] Displays RubyVersion
+[engine]  Displays RubyEngine
+[os]      OS information
+[info]    Aggregates information about your Ruby environment
+[copy]    Shortcut for <tt>Clipboard.copy</tt>
+[paste]   Shortcut for <tt>Clipboard.paste</tt>
 [copy_input]  Copies the session_history to the clipboard
 [copy_output] Copies this session's results to the clipboard
-[mf]     Shortcut for using the *methodfinder*
-[page]   Shortcut for using the pager from *hirb*
+[mf]      Shortcut for using the *methodfinder*
+[page]    Shortcut for using the pager from *hirb*
+[colorize] Syntax highlights a ruby string using *coderay*
+[ray]      Syntax highlights a ruby file using *coderay*
+
 
-These are the custom public +Object+ methods renamed/patched for some gems
+==== From the libraries (puplic Object methods, renamed/patched)
 
 [ri]     Patching the +ri+ provided by *ori* to also allow default ri syntax on toplevel
 [src]    Shortcut for displaying the method source using *method_source* and *coderay*
+[mlp]    Shortcut for the *method_locator*
 [l/lp]   Alternative method name to trigger the *looksee* gem (<b>irbtools-more</b>)
 
 
 == Advanced tweaking
-=== How to load more or less libraries
+=== Customize libraries to load
 
-It is possible to modify, which libraries should get loaded:
+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 <tt>require 'irbtools/minimal'</tt> instead of <tt>configure</tt>.
+If you do not want to load the default set of *irbtools* gems, you will have to use <tt>require 'irbtools/minimal'</tt> instead of <tt>configure</tt>.
 
 You can use the following methods:
 
 * <tt>Irbtools.add_library(lib, options_hash, &block)</tt>
 * <tt>Irbtools.remove_library(lib)</tt>
 
-The <tt>options_hash</tt> defines the way in which irbtools loads the library. The following options are possible
+The <tt>options_hash</tt> defines the way in which *irbtools* loads the library. The following options are possible
 [(no options)/<tt>:start</tt>] The library is required on startup before doing anything else (before displaying the prompt)
 [<tt>:thread => identifier</tt>] 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)
 [<tt>:late => true</tt>] The library is required just before showing the prompt (note: loading threads might still be in process)
@@ -131,7 +159,7 @@ The <tt>options_hash</tt> defines the way in which irbtools loads the library. T
 [<tt>:sub_session => true</tt>] The library is loaded every time a sub-session starts (using <tt>IRB.conf[:IRB_RC]</tt>). In ripl[https://github.com/cldwalker/ripl], <tt>ripl-after_rc</tt> is used.
 [<tt>:autoload => :Constant</tt>] Use Ruby's <tt>autoload</tt> 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 <tt>:autoload</tt>, in which case the code will executed directly on startup). You can modify the callbacks by using <tt>Irbtools.add_library_callback</tt> and <tt>Irbtools.replace_library_callback</tt>.
+You can pass a block as third argument, which gets executed after the library has completed loading (except for <tt>:autoload</tt>, in which case the code will be executed directly on startup). You can modify the callbacks by using <tt>Irbtools.add_library_callback</tt> and <tt>Irbtools.replace_library_callback</tt>.
 
 When adding a new library, you should firstly consider some way to load it via <tt>:autoload</tt>.
 If this is not possible, try loading via <tt>:thread</tt>. If that is not possible either, you will need to fallback to the default loading mechanism.
@@ -167,9 +195,9 @@ The welcome message can be customized with <tt>Irbtools.welcome_message=</tt>
 
 == Web Console
 
-Irbtools works well together with the amazing {web-console!}[https://github.com/rails/web-console]
+*irbtools* works well together with the amazing {web-console!}[https://github.com/rails/web-console]
 
 
 == J-_-L
 
-Copyright (c) 2010-2014 Jan Lelis <http://janlelis.de> released under the MIT license.
+Copyright (c) 2010-2014 Jan Lelis <http://janlelis.com> released under the MIT license.

data/Rakefile

@@ -1,5 +1,13 @@
 # require 'rake'
 require 'fileutils'
+require "rspec/core/rake_task"
+
+task :test => :spec
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--backtrace --color'
+end
+
 
 def gemspec1
   @gemspec1 ||= eval(File.read('irbtools.gemspec'), binding, 'irbtools.gemspec')

data/irbtools.gemspec

@@ -9,17 +9,17 @@ Gem::Specification.new do |s|
   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.email                 = 'mail@janlelis.de'
-  s.extra_rdoc_files      = %w[LICENSE README.rdoc]
+  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.2'
+  s.required_ruby_version = '>= 1.9.3'
   s.license               = 'MIT'
 
   # functionality
   s.add_dependency %q<every_day_irb>, ">= #{ s.version }"
-  s.add_dependency %q<binding.repl>,  ">= 1.0.1"
-  s.add_dependency %q<boson>,         "~> 1.2.4"
-  s.add_dependency %q<boson-more>,    "~> 0.2.2"
+  s.add_dependency %q<binding.repl>,  "~> 1", ">= 1.0.4"
+  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"
@@ -33,7 +33,6 @@ Gem::Specification.new do |s|
 
   # debugging
   s.add_dependency %q<debugging>,     "~> 1.0"
-  s.add_dependency %q<awesome_print>, "~> 1.2"
   s.add_dependency %q<g>,             ">= 1.7.2"
 
   # introspection / docs

data/lib/irbtools/configure.rb

@@ -8,7 +8,7 @@
 # # # # #
 # define module methods
 module Irbtools
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 
   @libraries       = { :start => [], :sub_session => [], :autoload => [], :thread => {}, :late => [], :late_thread => {} }
   @lib_hooks       = Hash.new{|h,k| h[k] = [] }

data/lib/irbtools/libraries.rb

@@ -41,7 +41,6 @@ Irbtools.add_library 'debugging/q', :thread => 21
 Irbtools.add_library 'debugging/mof', :thread => 22
 Irbtools.add_library 'debugging/re', :thread => 23
 Irbtools.add_library 'debugging/beep', :thread => 24
-Irbtools.add_library 'ap', :thread => 30
 Irbtools.add_library 'g', :thread => 40 if RbConfig::CONFIG['host_os'] =~ /mac|darwin/
 
 # lets you open vim (or your favourite editor), hack something, save it, and it's loaded in the current irb session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: irbtools
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: every_day_irb
@@ -16,56 +16,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: binding.repl
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: boson
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: boson-more
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: alias
   requirement: !ruby/object:Gem::Requirement
@@ -192,20 +198,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: g
   requirement: !ruby/object:Gem::Requirement
@@ -338,11 +330,11 @@ email: mail@janlelis.de
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
+- MIT-LICENSE
 - README.rdoc
 files:
 - CHANGELOG
-- LICENSE
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - irbtools.gemspec
@@ -367,7 +359,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -375,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: irbtools happy irb.