irb_hacks 0.2.0 → 0.2.2

data/README.html

@@ -31,14 +31,14 @@ irb> ae
 
 <p>There’s often a need to invoke our work-in-progress code a number of times using the same arguments, wrapping block, etc. For that, “code snippets” feature is quite handy.</p>
 
-<p><code>irb_hacks</code> gem provides the two methods with short, meaningless (and thus conflict-free) names – <code>a</code> and <code>ae</code>. <code>a</code> means nothing, it’s just the first letter of the alphabet. <code>a</code> <strong>invokes</strong> the last-edited snippet. <code>ae</code> <strong>lets you edit</strong> the actual snippet (it roughly stands for “a” + “edit”).</p>
+<p><code>irb_hacks</code> provides the two methods with short, meaningless (and thus conflict-free) names – <code>a</code> and <code>ae</code>. <code>a</code> means nothing, it’s just the first letter of the alphabet. <code>a</code> <strong>invokes</strong> the last-edited snippet. <code>ae</code> <strong>lets you edit</strong> the actual snippet (it roughly stands for “a” + “edit”).</p>
 
 <p>A very basic example:</p>
 
 <pre><code>irb&gt; ae
-(snippet)&gt;&gt; puts "Hello, world"
+(snippet)&gt;&gt; puts "Hello, world!"
 irb&gt; a
-Hello, world
+Hello, world!
 </code></pre>
 
 <p>Snippet arguments are supported. It’s an array called <code>args</code> in snippet context.</p>
@@ -61,7 +61,7 @@ charlie
 zulu
 </code></pre>
 
-<p>Snippets support code blocks. It’s a <code>Proc</code> called <code>block</code> in snippet context. Usage example follows (suppose you’re building a simplistic <code>/etc/passwd</code> parser).</p>
+<p>Snippets support code blocks. It’s a <code>Proc</code> object called <code>block</code> in snippet context. Usage example follows. Suppose you’re building a simplistic <code>/etc/passwd</code> parser. You put the actual reading in the snippet, but do line data manipulation in a block:</p>
 
 <pre><code>irb&gt; ae
 (snippet)&gt;&gt; File.readlines("/etc/passwd").map(&amp;block).each {|s| p s}; nil
@@ -73,7 +73,7 @@ irb&gt; a {|s| ar = s.split(":"); {:name =&gt; ar[0], :uid =&gt; ar[2]}}
 ...
 </code></pre>
 
-<p>Snippets are <strong>persistent</strong> though IRB invocations. That’s quite handy, since not all stuff can be dynamically reloaded and sometimes one has to restart IRB to ensure a clean reload.</p>
+<p>Snippets are <strong>persistent</strong> thoughout IRB invocations. That’s quite handy, since not all stuff can be dynamically reloaded and sometimes we have to restart IRB to ensure a clean reload.</p>
 
 <pre><code>irb&gt; ae
 (snippet)&gt;&gt; puts "Snippets are persistent!"
@@ -83,9 +83,9 @@ irb&gt; a
 Snippets are persistent!
 </code></pre>
 
-<p>Just in case, snippet history file is called <code>.irb_snippet_history</code> in your <code>$HOME</code>.</p>
+<p>Just in case, snippet history file is called <code>~/.irb_snippet_history</code> by default.</p>
 
-<p>Snippets maintain <strong>their own</strong> Readline history. When you press [Up] and [Down] keys in <code>ae</code>, you browse the previously used snippets, not just your previous IRB input. Don’t retype the snippet you used yesterday – press [Up] a couple times and you’ll see it.</p>
+<p>Snippets maintain <strong>their own</strong> Readline history. When you press [Up] and [Down] keys in <code>ae</code>, you browse the previously used snippets, not just your previous IRB input. So don’t retype the snippet you used yesterday – press [Up] a few times and you’ll see it.</p>
 
 <pre><code>irb&gt; ae
 (snippet)&gt;&gt; puts "snippet one"
@@ -103,6 +103,8 @@ irb&gt; ae
 (snippet)&gt;&gt; puts "snippet one"
 </code></pre>
 
+<p>You can configure some aspects of the snippets. Read “Configuration” chapter below.</p>
+
 <h3 id="browse-program-data-with-gnu-less">Browse program data with GNU <code>less</code></h3>
 
 <p>Sometimes the data your code works with is too long to fit in a console window. The clearest example of this are variables filled with text content, e.g. <a href="http://github.com/whymirror/hpricot">Hpricot</a> documents/elements.</p>
@@ -113,7 +115,7 @@ irb&gt; ae
 irb&gt; files = Dir["/etc/*"].sort
 # Some bulky array...
 irb&gt; less files
-# ... which you browse interactively!
+# ...which you browse interactively!
 </code></pre>
 
 <p>In block form, <code>less</code> hack intercepts everything output to <code>STDOUT</code> (and, optionally, to <code>STDERR</code>), and feeds it to the pager.</p>
@@ -133,16 +135,11 @@ STDERR.puts "to stderr"
 end
 </code></pre>
 
-<p>To specify another paging program or tweak <code>less</code> options, write in your <code>~/.irbrc</code>:</p>
-
-<pre><code>IrbHacks.less_cmd = "more"
-</code></pre>
-
-<p>, or something else you find appropriate.</p>
+<p>You can configure which pager program to use and with which options. Read “Configuration” chapter below.</p>
 
 <h3 id="break-execution-and-return-instant-value">Break execution and return instant value</h3>
 
-<p>By using <code>IrbHacks.break(value)</code> you break snippet execution and make it return <code>value</code>. This is a simple yet powerful debugging technique.</p>
+<p>By using <code>IrbHacks.break(value)</code> you break snippet (<code>a</code>) execution and make it return <code>value</code>. This is a simple yet powerful debugging technique.</p>
 
 <p>Suppose you’re debugging the code which contains something like:</p>
 
@@ -167,7 +164,26 @@ irb&gt; row = a
 irb&gt;
 </code></pre>
 
-<p>Each <code>IrbHacks.break</code> call raises an <code>IrbHacks::BreakException</code>. If you see them popping out during runtime, find the appropriate <code>IrbHacks.break</code> calls and defuse them.</p>
+<p>Each <code>IrbHacks.break</code> call raises an <code>IrbHacks::BreakException</code>. If you see them popping out runtime, find the appropriate <code>IrbHacks.break</code> calls and defuse them.</p>
+
+<h2 id="configuration">Configuration</h2>
+
+<p>Via <code>IrbHacks.conf</code> object you can configure various features of <code>irb_hacks</code>. Add <code>IrbHacks.conf</code> manipulation code to your <code>.irbrc</code>:</p>
+
+<pre><code>require "rubygems"
+require "irb_hacks"
+
+IrbHacks.conf.snippet_prompt = "&gt;&gt;&gt; "
+</code></pre>
+
+<h3 id="configuration-variables-irbhacksconf">Configuration Variables (<code>IrbHacks.conf.*</code>)</h3>
+
+<ul>
+  <li><code>less_cmd</code> – System command to invoke pager for <code>less</code>.</li>
+  <li><code>snippet_history_file</code> – Snippet (<code>a</code>, <code>ae</code>) history file.</li>
+  <li><code>snippet_history_size</code> – Snippet history size.</li>
+  <li><code>snippet_prompt</code> – Snippet input prompt.</li>
+</ul>
 
 <h2 id="feedback">Feedback</h2>
 

data/README.md

@@ -28,14 +28,14 @@ The Hacks
 
 There's often a need to invoke our work-in-progress code a number of times using the same arguments, wrapping block, etc. For that, "code snippets" feature is quite handy.
 
-`irb_hacks` gem provides the two methods with short, meaningless (and thus conflict-free) names -- `a` and `ae`. `a` means nothing, it's just the first letter of the alphabet. `a` **invokes** the last-edited snippet. `ae` **lets you edit** the actual snippet (it roughly stands for "a" + "edit").
+`irb_hacks` provides the two methods with short, meaningless (and thus conflict-free) names -- `a` and `ae`. `a` means nothing, it's just the first letter of the alphabet. `a` **invokes** the last-edited snippet. `ae` **lets you edit** the actual snippet (it roughly stands for "a" + "edit").
 
 A very basic example:
 
     irb> ae
-    (snippet)>> puts "Hello, world"
+    (snippet)>> puts "Hello, world!"
     irb> a
-    Hello, world
+    Hello, world!
 
 Snippet arguments are supported. It's an array called `args` in snippet context.
 
@@ -55,7 +55,7 @@ Snippets work just like normal Ruby methods -- they return the value of the last
     charlie
     zulu
 
-Snippets support code blocks. It's a `Proc` called `block` in snippet context. Usage example follows (suppose you're building a simplistic `/etc/passwd` parser).
+Snippets support code blocks. It's a `Proc` object called `block` in snippet context. Usage example follows. Suppose you're building a simplistic `/etc/passwd` parser. You put the actual reading in the snippet, but do line data manipulation in a block:
 
     irb> ae
     (snippet)>> File.readlines("/etc/passwd").map(&block).each {|s| p s}; nil
@@ -66,7 +66,7 @@ Snippets support code blocks. It's a `Proc` called `block` in snippet context. U
     {:uid=>"3", :name=>"adm"}
     ...
 
-Snippets are **persistent** though IRB invocations. That's quite handy, since not all stuff can be dynamically reloaded and sometimes one has to restart IRB to ensure a clean reload.
+Snippets are **persistent** thoughout IRB invocations. That's quite handy, since not all stuff can be dynamically reloaded and sometimes we have to restart IRB to ensure a clean reload.
 
     irb> ae
     (snippet)>> puts "Snippets are persistent!"
@@ -75,9 +75,9 @@ Snippets are **persistent** though IRB invocations. That's quite handy, since no
     irb> a
     Snippets are persistent!
 
-Just in case, snippet history file is called `.irb_snippet_history` in your `$HOME`.
+Just in case, snippet history file is called `~/.irb_snippet_history` by default.
 
-Snippets maintain **their own** Readline history. When you press [Up] and [Down] keys in `ae`, you browse the previously used snippets, not just your previous IRB input. Don't retype the snippet you used yesterday -- press [Up] a couple times and you'll see it.
+Snippets maintain **their own** Readline history. When you press [Up] and [Down] keys in `ae`, you browse the previously used snippets, not just your previous IRB input. So don't retype the snippet you used yesterday -- press [Up] a few times and you'll see it.
 
     irb> ae
     (snippet)>> puts "snippet one"
@@ -94,6 +94,8 @@ Snippets maintain **their own** Readline history. When you press [Up] and [Down]
     # Pressing [Up] again will give you...
     (snippet)>> puts "snippet one"
 
+You can configure some aspects of the snippets. Read "Configuration" chapter below.
+
 
 ### Browse program data with GNU `less` ###
 
@@ -105,7 +107,7 @@ To solve that, the greatest paging program of all times, GNU `less`, comes to th
     irb> files = Dir["/etc/*"].sort
     # Some bulky array...
     irb> less files
-    # ... which you browse interactively!
+    # ...which you browse interactively!
 
 In block form, `less` hack intercepts everything output to `STDOUT` (and, optionally, to `STDERR`), and feeds it to the pager.
 
@@ -122,16 +124,12 @@ Now with `STDERR` capture:
     STDERR.puts "to stderr"
     end
 
-To specify another paging program or tweak `less` options, write in your `~/.irbrc`:
-
-    IrbHacks.less_cmd = "more"
-
-, or something else you find appropriate.
+You can configure which pager program to use and with which options. Read "Configuration" chapter below.
 
 
 ### Break execution and return instant value ###
 
-By using `IrbHacks.break(value)` you break snippet execution and make it return `value`. This is a simple yet powerful debugging technique.
+By using `IrbHacks.break(value)` you break snippet (`a`) execution and make it return `value`. This is a simple yet powerful debugging technique.
 
 Suppose you're debugging the code which contains something like:
 
@@ -153,7 +151,26 @@ Now all you have to do is write an `ae` snippet and call it. `row` value will be
     # Back in IRB. Do whatever you want with `row` value now.
     irb>
 
-Each `IrbHacks.break` call raises an `IrbHacks::BreakException`. If you see them popping out during runtime, find the appropriate `IrbHacks.break` calls and defuse them.
+Each `IrbHacks.break` call raises an `IrbHacks::BreakException`. If you see them popping out runtime, find the appropriate `IrbHacks.break` calls and defuse them.
+
+
+Configuration
+-------------
+
+Via `IrbHacks.conf` object you can configure various features of `irb_hacks`. Add `IrbHacks.conf` manipulation code to your `.irbrc`:
+
+    require "rubygems"
+    require "irb_hacks"
+
+    IrbHacks.conf.snippet_prompt = ">>> "
+
+
+### Configuration Variables (`IrbHacks.conf.*`)###
+
+* `less_cmd` -- System command to invoke pager for `less`.
+* `snippet_history_file` -- Snippet (`a`, `ae`) history file.
+* `snippet_history_size` -- Snippet history size.
+* `snippet_prompt` -- Snippet input prompt.
 
 
 Feedback

data/Rakefile

@@ -1,5 +1,5 @@
+require "rake/rdoctask"
 require "yaml"
-#require 'rake/gempackagetask'
 
 GEM_NAME = "irb_hacks"
 
@@ -25,15 +25,24 @@ end
 desc "Rebuild gemspec and package"
 task :rebuild => [:gemspec, :build]
 
-desc "Push (publish) gem to Gemcutter"
+desc "Push (publish) gem to RubyGems.org"
 task :push do
   # Yet found no way to ask Jeweler forge a complete version string for us.
   vh = YAML.load(File.read("VERSION.yml"))
-  version = [vh[:major], vh[:minor], vh[:patch]].join(".")
-  pkgfile = File.join("pkg", [GEM_NAME, "-", version, ".gem"].to_s)
+  version = [vh[:major], vh[:minor], vh[:patch], (if (v = vh[:build]); v; end)].compact.join(".")
+  pkgfile = File.join("pkg", [GEM_NAME, "-", version, ".gem"].join)
   Kernel.system("gem", "push", pkgfile)
 end
 
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "doc"
+  rdoc.title    = "IrbHacks"
+  #rdoc.options << "--line-numbers"
+  #rdoc.options << "--inline-source"
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
 #Rake::GemPackageTask.new(spec) do |p|
 #  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
 #end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 0
-#:build: pre
+:patch: 2
+#:build: pre2

data/irb_hacks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irb_hacks}
-  s.version = "0.2.0"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Fortuna"]
-  s.date = %q{2010-12-13}
+  s.date = %q{2011-07-12}
   s.description = %q{Yet another set of IRB hacks}
   s.email = %q{alex.r@askit.org}
   s.extra_rdoc_files = [
@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    "CHANGELOG.md",
     "MIT-LICENSE",
     "README.html",
     "README.md",
@@ -25,17 +24,18 @@ Gem::Specification.new do |s|
     "VERSION.yml",
     "irb_hacks.gemspec",
     "lib/irb_hacks.rb",
+    "lib/irb_hacks/break_exception.rb",
+    "lib/irb_hacks/config.rb",
     "lib/irb_hacks/core_ext/kernel/a_and_ae.rb",
     "lib/irb_hacks/core_ext/kernel/less.rb",
     "lib/irb_hacks/snippet.rb"
   ]
   s.homepage = %q{http://github.com/dadooda/irb_hacks}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Yet another set of IRB hacks}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/irb_hacks/break_exception.rb

@@ -0,0 +1,4 @@
+module IrbHacks
+  # Exception class used by IrbHacks::break.
+  class BreakException < Exception; end
+end

data/lib/irb_hacks/config.rb

@@ -0,0 +1,33 @@
+module IrbHacks
+  # IrbHacks configuration object.
+  class Config
+    # System command to invoke pager for <tt>less</tt>. Default:
+    #
+    #   less -R
+    attr_accessor :less_cmd
+
+    # Snippet (<tt>a</tt>, <tt>ae</tt>) history file. Default:
+    #
+    #   ~/.irb_snippet_history
+    attr_accessor :snippet_history_file
+
+    # Snippet history size. Default is <tt>100</tt>.
+    attr_accessor :snippet_history_size
+
+    # Snippet input prompt. Default:
+    #
+    #   (snippet)>>
+    attr_accessor :snippet_prompt
+
+    def initialize(attrs = {})
+      defaults = {
+        :less_cmd => "less -R",
+        :snippet_history_file => "~/.irb_snippet_history",
+        :snippet_history_size => 100,
+        :snippet_prompt => "(snippet)>> ",
+      }
+
+      defaults.merge(attrs).each {|k, v| send("#{k}=", v)}
+    end
+  end
+end

data/lib/irb_hacks/core_ext/kernel/a_and_ae.rb

@@ -1,27 +1,25 @@
-module IrbHacks   #:nodoc:
+module IrbHacks
   module CoreExtensions   #:nodoc:
     module Kernel   #:nodoc:
-      module SingletonMethods
-        # Run code snippet.
-        # See <tt>IrbHacks::Snippet.run</tt>.
+      module SingletonMethods   #:nodoc:
         def a(*args, &block)
-          IrbHacks::Snippet.run(*args, &block)
+          Snippet.run(*args, &block)
         end
 
-        # Edit code snippet.
-        # See <tt>IrbHacks::Snippet.edit</tt>.
         def ae(*args)
-          IrbHacks::Snippet.edit(*args)
+          Snippet.edit(*args)
         end
       end # SingletonMethods
 
       module InstanceMethods
         private
 
+        # Run code snippet. See IrbHacks::Snippet::run.
         def a(*args, &block)
           ::Kernel.a(*args, &block)
         end
 
+        # Interactively edit code snippet. See IrbHacks::Snippet::edit.
         def ae(*args)
           ::Kernel.ae(*args)
         end

data/lib/irb_hacks/core_ext/kernel/less.rb

@@ -1,39 +1,16 @@
-module IrbHacks   #:nodoc:
+module IrbHacks
   module CoreExtensions   #:nodoc:
     module Kernel   #:nodoc:
-      module SingletonMethods
-        # Dump program data with GNU <tt>less</tt>.
-        #
-        # Plain form:
-        #   less "hello", "world"
-        #   less mydata
-        #
-        # Block form:
-        #   less do
-        #     puts "hello, world"
-        #   end
-        #
-        #   less(:stderr => true) do
-        #     puts "to stdout"
-        #     STDERR.puts "to stderr"
-        #   end
-        #
-        # Block form options:
-        #   :stderr => T|F      # Redirect STDERR too.
-        #
-        # If block form option is <tt>String</tt> or <tt>Symbol</tt>, it's automatically
-        # converted to a hash like <tt>{:var => true}</tt>. Thus, <tt>less(:stderr => true)</tt>
-        # and <tt>less(:stderr)</tt> are identical.
+      module SingletonMethods   #:nodoc:
+        # See InstanceMethods for documentation.
         def less(*args, &block)
-          less_cmd = IrbHacks.less_cmd
-
           if not block
             # Non-block invocation.
             if args.size < 1
               # We're interactive anyway. Why not give user a quick prompt?
               STDERR.puts "Nothing to show. Invoke as less(args) or less(options, &block)"
             else
-              File.popen(less_cmd, "w") do |f|
+              File.popen(IrbHacks.conf.less_cmd, "w") do |f|
                 f.puts args
               end
             end
@@ -62,7 +39,7 @@ module IrbHacks   #:nodoc:
             old_stdout = STDOUT.clone
             old_stderr = STDERR.clone if o_stderr
 
-            File.popen(less_cmd, "w") do |f|
+            File.popen(IrbHacks.conf.less_cmd, "w") do |f|
               STDOUT.reopen(f)
               STDERR.reopen(f) if o_stderr
               yield
@@ -78,6 +55,33 @@ module IrbHacks   #:nodoc:
       module InstanceMethods
         private
 
+        # Dump program data with GNU <tt>less</tt> or the other configured OS pager.
+        #
+        # Plain form:
+        #
+        #   less "hello", "world"
+        #   less mydata
+        #
+        # Block form:
+        #
+        #   less do
+        #     puts "hello, world"
+        #   end
+        #
+        #   less(:stderr => true) do
+        #     puts "to stdout"
+        #     STDERR.puts "to stderr"
+        #   end
+        #
+        # Block form options:
+        #
+        #   :stderr => T|F      # Redirect STDERR too.
+        #
+        # If block form option is String or Symbol, it's automatically
+        # converted to Hash like <tt>{:var => true}</tt>. Thus, you can write <tt>less(:stderr)</tt>
+        # for <tt>less(:stderr => true)</tt>, they are functionally identical.
+        #
+        # See also IrbHacks::Config::less_cmd.
         def less(*args, &block)
           ::Kernel.less(*args, &block)
         end

data/lib/irb_hacks/snippet.rb

@@ -1,43 +1,66 @@
 require "readline"
 
-module IrbHacks   #:nodoc:
+module IrbHacks
+  # Snippet manipulation internals.
   module Snippet
-    #TODO: Configured values. Config is common for entire IrbHacks.
-    HISTORY_FILE = File.join(ENV["HOME"], ".irb_snippet_history")
-    HISTORY_SIZE = 500
+    # Initializer.
+    def self._initialize    #:nodoc:
+      load_history
+    end
+
+    # On-the-fly initializer.
+    def self._otf_init    #:nodoc:
+      # Consider job done, replace self with a blank.
+      class_eval {
+        def self._otf_init    #:nodoc:
+        end
+      }
 
-    # Edit code snippet.
+      _initialize
+    end
+
+    # Interactively edit code snippet.
     def self.edit
-      ##p "R::H before", Readline::HISTORY.to_a
+      _otf_init
+
+      # Gracefully catch Ctrl-C.
+      old_sigint = trap("INT") do
+        puts "\nAborted"
+        return nil
+      end
+
+      #DEBUG
+      ##p "RH at inv", Readline::HISTORY.to_a
       ##p "@history at inv", @history
 
-      # Push stuff into RL history.
-      npushed = @history.size
-      @history.each {|s| Readline::HISTORY.push s}
+      rl_history = _replace_rl_history(@history)
 
-      ##p "R::H after push", Readline::HISTORY.to_a
+      ##p "RH at cp 1", Readline::HISTORY.to_a    #DEBUG
 
-      # NOTE: Readline help is missing. Copied from somewhere else.
-      input = Readline.readline("(snippet)>> ", true)
+      # Read input.
+      # NOTE: Readline help is missing.
+      input = Readline.readline(IrbHacks.conf.snippet_prompt, true).strip
 
-      if not input.empty?
-        # Accept entry.
-        @history << input
+      return nil if input.empty?
 
-        # ["wan", "tew", "free", "tew"] should render into ["wan", "free", "tew"] with "tew" being the last input shippet.
-        @history = (@history.reverse.uniq).reverse
-      end
+      # Accept input.
+      @history << input
 
-      # Pop stuff out of RL history.
-      (npushed + 1).times {Readline::HISTORY.pop}
+      # Remove duplicates. Most recent bubble up.
+      # [1, 2, 3, 2] will render into [1, 3, 2] with 2 being the last snippet.
+      @history = (@history.reverse.uniq).reverse
 
-      ##p "R::H after", Readline::HISTORY.to_a
+      ##p "RH after restore", Readline::HISTORY.to_a    #DEBUG
 
-      # Save history -- we can't know when the session is going to end.
+      # Save our history now.
       save_history
 
       # Don't clutter IRB screen with anything extra.
       nil
+    ensure
+      ##puts "-- ensure"    #DEBUG
+      trap("INT", &old_sigint) if old_sigint
+      _replace_rl_history(rl_history) if rl_history
     end
 
     def self.history
@@ -48,20 +71,19 @@ module IrbHacks   #:nodoc:
       @history = ar
     end
 
+    # Load history from a file.
     def self.load_history
       @history = begin
-        content = File.read(HISTORY_FILE)
-        YAML.load(content)
+        File.readlines(File.expand_path(IrbHacks.conf.snippet_history_file)).map(&:chomp)
       rescue
-        nil
+        [%{puts "YOUR test code here"}]
       end
-
-      @history = [%{puts "YOUR test code here"}] if not @history
     end
 
-    # Run code snippet.
-    # If <tt>IrbHacks.break</tt> is called anywhere, immediately return its argument.
+    # Run latest edited code snippet. If IrbHacks::break is called anywhere, immediately return its argument.
     def self.run(*args, &block)
+      _otf_init
+
       if (code = @history.last)
         begin
           eval(code, &block)
@@ -72,16 +94,25 @@ module IrbHacks   #:nodoc:
       end
     end
 
+    # Save history to a file.
     def self.save_history
-      # Truncate a saved version of @history.
-      hist = @history.size > HISTORY_SIZE ? @history.slice(-HISTORY_SIZE..-1) : @history
-      File.open(HISTORY_FILE, "w") do |f|
-        f.write YAML.dump(hist)
+      # Truncate and save history.
+      # NOTE: It's more logical (WYSIWYG) to truncate @history live, not its copy. Thus the user will see what's going to be saved & restored.
+      @history.slice!(0..-(IrbHacks.conf.snippet_history_size + 1))
+      File.open(File.expand_path(IrbHacks.conf.snippet_history_file), "w") do |f|
+        f.puts @history
       end
     end
 
-    #--------------------------------------- Init
+    #---------------------------------------
 
-    load_history
+    # Clear Readline history and optionally replace it with new content.
+    # Return previous content.
+    def self._replace_rl_history(ar = nil)    #:nodoc:
+      out = []
+      while (s = Readline::HISTORY.shift); out << s; end
+      ar.each {|s| Readline::HISTORY << s} if ar
+      out
+    end
   end # Snippet
 end # IrbHacks

data/lib/irb_hacks.rb

@@ -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.
+  #
+  #   def myfunc
+  #     puts "Reading name..."
+  #     name = File.read(...)
+  #     IrbHacks.break name     #DEBUG: See what's been read.
+  #
+  #     # Other code...
+  #   end
   #
-  #   IrbHacks.break
-  #   IrbHacks.break("hi")
+  #   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

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: irb_hacks
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors: 
 - Alex Fortuna
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 +03:00
+date: 2011-07-12 00:00:00 +04:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +24,6 @@ extra_rdoc_files:
 - README.html
 - README.md
 files: 
-- CHANGELOG.md
 - MIT-LICENSE
 - README.html
 - README.md
@@ -36,6 +31,8 @@ files:
 - VERSION.yml
 - irb_hacks.gemspec
 - lib/irb_hacks.rb
+- lib/irb_hacks/break_exception.rb
+- lib/irb_hacks/config.rb
 - lib/irb_hacks/core_ext/kernel/a_and_ae.rb
 - lib/irb_hacks/core_ext/kernel/less.rb
 - lib/irb_hacks/snippet.rb
@@ -53,21 +50,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Yet another set of IRB hacks

data/CHANGELOG.md

@@ -1,10 +0,0 @@
-0.1.1 2010-01-18
-----------------
-
-Fixed YAML issue for Ruby 1.9.1.
-
-
-0.1.0 2010-01-14
-----------------
-
-First public release.