irb_hacks 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 2010-01-14
+----------------
+
+First public release.

data/README.md

@@ -0,0 +1,134 @@
+Yet another set of IRB hacks
+============================
+
+Setup
+-----
+
+    $ gem sources --add http://gemcutter.org
+    $ gem install irb_hacks
+
+Add to your `~/.irbrc`:
+
+    require "rubygems"
+    require "irb_hacks"
+
+Now fire up IRB for a quick test:
+
+    $ irb
+    irb> ae
+    (snippet)>>
+
+If you see "(snippet)", you're ready to go.
+
+
+The Hacks
+---------
+
+### Code snippets -- `a` and `ae` ###
+
+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").
+
+A very basic example:
+
+    irb> ae
+    (snippet)>> puts "Hello, world"
+    irb> a
+    Hello, world
+
+Snippet arguments are supported. It's an array called `args` in snippet context.
+
+    irb> ae
+    (snippet)>> p "args", args
+    irb> a 10, 1.0, "a string"
+    "args"
+    [10, 1.0, "a string"]
+
+Snippets work just like normal Ruby methods -- they return the value of the last statement executed.
+
+    irb> ae
+    (snippet)>> ["alfa", "zulu", "bravo"] + args
+    irb> puts a("charlie").sort
+    alfa
+    bravo
+    charlie
+    zulu
+
+Snippets support code blocks. It's a `Proc` called `block` in snippet context. Usage example follows (suppose we're building a simplistic `/etc/passwd` parser).
+
+    irb> ae
+    (snippet)>> File.readlines("/etc/passwd").map(&block).each {|s| p s}; nil
+    irb> a {|s| ar = s.split(":"); {:name => ar[0], :uid => ar[2]}}
+    {:uid=>"0", :name=>"root"}
+    {:uid=>"1", :name=>"bin"}
+    {:uid=>"2", :name=>"daemon"}
+    {:uid=>"3", :name=>"adm"}
+    ...
+
+Snippets are **persistent** though IRB invocations. That's quite handy, since not all stuff can be dynamically reloaded and sometimes we have to restart IRB to ensure clean reload.
+
+    irb> ae
+    (snippet)>> puts "Snippets are persistent!"
+    irb> exit
+    $ irb
+    irb> a
+    Snippets are persistent!
+
+Just in case, snippet history file is called `.irb_snippet_history` in your `$HOME`.
+
+Snippets maintain **their own** Realine 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.
+
+    irb> ae
+    (snippet)>> puts "snippet one"
+    irb> hala
+    irb> bala
+    irb> ae
+    (snippet)>> puts "snippet two"
+    irb> foo
+    irb> moo
+    irb> ae
+    (snippet)>>
+    ## Pressing [Up] will give you...
+    (snippet)>> puts "snippet two"
+    ## Pressing [Up] again will give you...
+    (snippet)>> puts "snippet one"
+
+### Browse program data with GNU `less` ###
+
+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. [Hpricot](http://github.com/whymirror/hpricot) documents/elements.
+
+To solve that, the greatest paging program of all times, GNU `less`, comes to the rescue.
+
+    $ irb
+    irb> files = Dir["/etc/*"].sort
+    ## Some bulky array...
+    irb> less files
+    ## ... which we browse interactively :).
+
+In block form, `less` hack intercepts everything output to `STDOUT` (and, optionally, to `STDERR`), and feeds it to the pager.
+
+    $ irb
+    irb> less do
+    puts "Hello, world"
+    end
+
+Now with `STDERR` capture:
+
+    $ irb
+    irb> less(:stderr) do
+    puts "to stdout"
+    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.
+
+
+Feedback
+--------
+
+Send bug reports, suggestions and criticisms through [project's page on GitHub](http://github.com/dadooda/irb_hacks).

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/irb_hacks.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{irb_hacks}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Fortuna"]
+  s.date = %q{2010-01-14}
+  s.description = %q{Yet another set of IRB hacks}
+  s.email = %q{alex.r@askit.org}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+     "README.md",
+     "VERSION.yml",
+     "irb_hacks.gemspec",
+     "lib/irb_hacks.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.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

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

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

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

@@ -0,0 +1,89 @@
+module IrbHacks   #:nodoc:
+  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.
+        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|
+                f.puts args
+              end
+            end
+          else
+            # Block invocation.
+
+            # Handle options.
+            options = {}
+
+            args.each do |arg|
+              if arg.is_a? Hash
+                ##p "arg hash", arg
+                options.merge! arg
+              elsif [Symbol, String].include? arg.class
+                ##p "arg sym/str", arg
+                options.merge! arg.to_sym => true
+              else
+                raise ArgumentError, "Unsupported argument #{arg.inspect}"
+              end
+            end
+
+            o_stderr = (v = options.delete(:stderr)).nil?? false : v
+
+            raise ArgumentError, "Unknown option(s): #{options.inspect}" if not options.empty?
+
+            old_stdout = STDOUT.clone
+            old_stderr = STDERR.clone if o_stderr
+
+            File.popen(less_cmd, "w") do |f|
+              STDOUT.reopen(f)
+              STDERR.reopen(f) if o_stderr
+              yield
+              STDOUT.reopen(old_stdout)
+              STDERR.reopen(old_stderr) if o_stderr
+            end
+          end # if block or no block.
+
+          nil
+        end # less
+      end # SingletonMethods
+
+      ::Kernel.extend SingletonMethods
+    end # Kernel
+  end # CoreExtensions
+end
+
+module Kernel   #:nodoc:
+  private
+
+  def less(*args, &block)
+    ::Kernel.less(*args, &block)
+  end
+end

data/lib/irb_hacks/snippet.rb

@@ -0,0 +1,80 @@
+require "readline"
+
+module IrbHacks   #:nodoc:
+  module Snippet
+    HISTORY_FILE = File.join(ENV["HOME"], ".irb_snippet_history")
+    HISTORY_SIZE = 20
+
+    # Edit code snippet.
+    def self.edit
+      ##p "R::H before", Readline::HISTORY.to_a
+      ##p "@history at inv", @history
+
+      # Push stuff into RL history.
+      npushed = @history.size
+      @history.each {|s| Readline::HISTORY.push s}
+
+      ##p "R::H after push", Readline::HISTORY.to_a
+
+      # NOTE: Readline help is missing. Copied from somewhere else.
+      input = Readline.readline("(snippet)>> ", true)
+
+      if not input.empty?
+        # Accept entry.
+        @history << input
+
+        # ["wan", "tew", "free", "tew"] should render into ["wan", "free", "tew"] with "tew" being the last input shippet.
+        @history = (@history.reverse.uniq).reverse
+      end
+
+      # Pop stuff out of RL history.
+      (npushed + 1).times {Readline::HISTORY.pop}
+
+      ##p "R::H after", Readline::HISTORY.to_a
+
+      # Save history -- we can't know when the session is going to end.
+      save_history
+
+      # Don't clutter IRB screen with anything extra.
+      nil
+    end
+
+    def self.history
+      @history
+    end
+
+    def self.history=(ar)
+      @history = ar
+    end
+
+    def self.load_history
+      @history = begin
+        content = File.read(HISTORY_FILE)
+        YAML.load(content)
+      rescue
+        nil
+      end
+
+      @history = [%{puts "YOUR test code here"}] if not @history.is_a? Array
+    end
+
+    # Run code snippet.
+    def self.run(*args, &block)
+      if (code = @history.last)
+        eval(code, &block)
+      end
+    end
+
+    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)
+      end
+    end
+
+    #--------------------------------------- Init
+
+    load_history
+  end # Snippet
+end # IrbHacks

data/lib/irb_hacks.rb

@@ -0,0 +1,15 @@
+Dir[File.join(File.dirname(__FILE__), "irb_hacks/**/*.rb")].each {|fn| require fn}
+
+module IrbHacks
+  def self.less_cmd
+    @less_cmd
+  end
+
+  def self.less_cmd=(cmd)
+    @less_cmd = cmd
+  end
+
+  #--------------------------------------- Defaults
+
+  self.less_cmd = "less -R"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: irb_hacks
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Fortuna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-14 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Yet another set of IRB hacks
+email: alex.r@askit.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- CHANGELOG.md
+- README.md
+- VERSION.yml
+- irb_hacks.gemspec
+- lib/irb_hacks.rb
+- lib/irb_hacks/core_ext/kernel/a_and_ae.rb
+- lib/irb_hacks/core_ext/kernel/less.rb
+- lib/irb_hacks/snippet.rb
+has_rdoc: true
+homepage: http://github.com/dadooda/irb_hacks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Yet another set of IRB hacks
+test_files: []
+