lib/irb_hacks.rb in irb_hacks-0.2.0 vs lib/irb_hacks.rb in irb_hacks-0.2.2

@@ -1,27 +1,51 @@
-require "yaml"
-
 Dir[File.join(File.dirname(__FILE__), "irb_hacks/**/*.rb")].each {|fn| require fn}
 
-module IrbHacks
-  # Break execution, return value if invoked from `a`.
+# Yet another set of IRB hacks.
+#
+# Summary of features brought to IRB:
+#
+# * <tt>a</tt> and <tt>ae</tt> methods to invoke or edit code snippets.
+# * <tt>less</tt> method to interactively dump data with OS pages like <tt>less</tt>.
+# * IrbHacks::break to instantly return value from code into IRB.
+module IrbHacks   #:doc:
+  # Break execution, instantly return value if caller is invoked from a snippet.
   #
-  #   IrbHacks.break
-  #   IrbHacks.break("hi")
+  #   def myfunc
+  #     puts "Reading name..."
+  #     name = File.read(...)
+  #     IrbHacks.break name     #DEBUG: See what's been read.
+  #
+  #     # Other code...
+  #   end
+  #
+  #   irb> ae
+  #   snippet>> myfunc
+  #   irb> a
+  #   Reading name...
+  #   => "John Smith"
   def self.break(value = nil)
     raise BreakException, [value]
   end
 
-  def self.less_cmd
+  # Access configuration object. See IrbHacks::Config.
+  #
+  #   IrbHacks.conf
+  #   IrbHacks.conf.snippet_history_size = 200
+  def self.conf
+    @conf ||= Config.new
+  end
+end
+
+#--------------------------------------- Junk
+
+if false
+  def self.less_cmd   #:nodoc:
     @less_cmd
   end
 
-  def self.less_cmd=(cmd)
+  def self.less_cmd=(cmd)   #:nodoc:
     @less_cmd = cmd
   end
-
-  class BreakException < Exception; end
-
-  #--------------------------------------- Defaults
 
   self.less_cmd = "less -R"
 end