ripl-irb 0.1.2 → 0.2.0

data/.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |s|
   s.email       = "gabriel.horner@gmail.com"
   s.homepage    = "http://github.com/cldwalker/ripl-irb"
   s.summary = "A ripl plugin to smooth the transition from irb"
-  s.description =  "A ripl plugin that smooths the transition from irb by stubbing out any IRB method or subclass called."
+  s.description =  "A ripl plugin that smooths the transition from irb by mocking out IRB. Safely captures all IRB calls and points to ripl equivalents for irb's commands and config options."
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = 'tagaholic'
-  s.add_dependency 'ripl', '>= 0.2.1'
+  s.add_dependency 'ripl', '>= 0.2.5'
   s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
   s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
   s.license = 'MIT'

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.2.0
+* Add suggestions for ripl equivalents to irb commands and config
+
 == 0.1.2
 * Fix awesome typo
 

data/README.rdoc

@@ -1,5 +1,6 @@
 == Description
-A ripl plugin that smooths the transition from irb by stubbing out any IRB method or subclass called.
+A ripl plugin that smooths the transition from irb by mocking out IRB. Safely captures all IRB calls
+and points to ripl equivalents for irb's commands and config options.
 
 == Install
 Install the gem with:
@@ -16,5 +17,16 @@ Or add to your ~/.riplrc
 
     require 'ripl/irb'
 
-== Todo
-* Point to ripl plugins which implement irb functionality called
+When your mocked out IRB encounters a ripl equivalent, it prints a message:
+
+    # When encountering a IRB.config[:HISTORY_FILE]
+    Use Ripl.config[:history] instead of IRB.config[:HISTORY_FILE]
+
+When you invoke an irb command, you'll get pointed to a similar ripl command:
+
+    >> context
+    See config() in ripl-commands plugin
+
+To disable printing these messages:
+
+    Ripl.config[:irb_verbose] = false

data/deps.rip

@@ -1 +1 @@
-ripl >=0.2.1
+ripl >=0.2.5

data/lib/ripl/irb.rb

@@ -1,15 +1,38 @@
+require 'ripl'
+
 module Ripl
   module Irb
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
 
     def before_loop
       mock_irb
       super
     end
 
+    CONFIG_MAP = {
+      :PROMPT_MODE => :prompt, :PROMPT => :prompt, :HISTORY_FILE => :history,
+      :USE_READLINE => :readline, :AP_NAME => :name, :RC => :irbrc
+    }
+    DESC_MAP = {
+      :SINGLE_IRB => "jump commands in ripl-commands plugin have this enabled by default",
+      :IRB_RC => "Use ripl-after_rc plugin instead of IRB.conf[:IRB_RC]",
+      :RC_NAME_GENERATOR => "Use Ripl.config[:history] or Ripl.config[:irbrc] "+
+        "instead of IRB.conf[:RC_NAME_GENERATOR]",
+      :LOAD_MODULES => 'No need for irb or ripl to do this. Just use require :)'
+    }
+
     def mock_irb
       mod = Object.const_set(:IRB, Module.new).extend(MockIrb)
-      class <<mod; self end.send(:define_method, :conf) { {} }
+      conf = {}
+      def conf.[]=(key, val)
+        return unless Ripl.config[:irb_verbose]
+        if ripl_key = CONFIG_MAP[key]
+          puts "Use Ripl.config[#{ripl_key.inspect}] instead of IRB.conf[#{key.inspect}]"
+        elsif desc = DESC_MAP[key]
+          puts desc
+        end
+      end
+      class <<mod; self end.send(:define_method, :conf) { conf }
     end
 
     module MockIrb
@@ -20,7 +43,31 @@ module Ripl
       def method_missing(*)
       end
     end
+
+    module Commands
+      JUMP_COMMANDS = [:bindings, :cb, :chws, :cws, :cwws, :fg, :irb, :irb_bindings, :irb_cb,
+        :irb_change_binding, :irb_change_workspace, :irb_chws, :irb_current_working_binding,
+        :irb_current_working_workspace, :irb_cwb, :irb_cws, :irb_cwws, :irb_exit, :irb_fg,
+        :irb_jobs, :irb_kill, :irb_pop_binding, :irb_pop_workspace, :irb_popb, :irb_popws,
+        :irb_print_working_binding, :irb_print_working_workspace, :irb_push_binding,
+        :irb_push_workspace, :irb_pushb, :irb_pushws, :irb_pwb, :irb_pwws, :irb_workspaces, :jobs,
+        :kill, :popb, :popws, :pushb, :pushws, :pwws, :workspaces]
+
+      (JUMP_COMMANDS - Ripl::Commands.instance_methods.map {|e| e.to_sym }).each do |meth|
+        define_method(meth) do
+          puts "See jump() and jumps() in ripl-commands plugin" if Ripl.config[:irb_verbose]
+        end
+      end
+
+      [:conf, :irb_context, :context].each do |meth|
+        define_method(meth) do
+          puts "See config() in ripl-commands plugin" if Ripl.config[:irb_verbose]
+        end
+      end
+    end
   end
 end
 
-Ripl::Shell.send :include, Ripl::Irb if defined? Ripl::Shell
+Ripl::Shell.send :include, Ripl::Irb
+Ripl::Commands.send :include, Ripl::Irb::Commands
+Ripl.config[:irb_verbose] = true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ripl-irb
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -05:00
+date: 2010-11-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,15 +26,15 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 29
         segments: 
         - 0
         - 2
-        - 1
-        version: 0.2.1
+        - 5
+        version: 0.2.5
   type: :runtime
   version_requirements: *id001
-description: A ripl plugin that smooths the transition from irb by stubbing out any IRB method or subclass called.
+description: A ripl plugin that smooths the transition from irb by mocking out IRB. Safely captures all IRB calls and points to ripl equivalents for irb's commands and config options.
 email: gabriel.horner@gmail.com
 executables: []