irb_hacks 0.2.3 → 0.2.4

data/.gitignore

@@ -0,0 +1,13 @@
+# General Ruby.
+/.bundle
+.old*
+*-old*
+.ref-*
+/.rvmrc
+
+# Project-specific.
+/*.rb
+/doc/
+/pkg/
+/.yardoc
+/var/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem dependencies in `PROJECT.gemspec`.
+gemspec

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Alex Fortuna
+Copyright (c) 2010-2012 Alex Fortuna
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,30 +1,36 @@
-Yet Another Set of IRB Hacks
+Yet another set of IRB hacks
 ============================
 
 Setup
 -----
 
-    $ gem sources --add http://rubygems.org
-    $ gem install irb_hacks
+~~~
+$ gem sources --add http://rubygems.org
+$ gem install irb_hacks
+~~~
 
 Add to your `~/.irbrc`:
 
-    require "rubygems"
-    require "irb_hacks"
+~~~
+require "rubygems"
+require "irb_hacks"
+~~~
 
 Now fire up IRB for a quick test:
 
-    $ irb
-    irb> ae
-    (snippet)>>
+~~~
+$ irb
+irb> ae
+(snippet)>>
+~~~
 
-If you see "(snippet)", you're ready to go.
+If you see `(snippet)`, you're ready to go.
 
 
-The Hacks
+The hacks
 ---------
 
-### Code Snippets -- `a` and `ae` ###
+### 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.
 
@@ -32,124 +38,148 @@ There's often a need to invoke our work-in-progress code a number of times using
 
 A very basic example:
 
-    irb> ae
-    (snippet)>> puts "Hello, world!"
-    irb> a
-    Hello, world!
+~~~
+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"]
+~~~
+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
+~~~
+irb> ae
+(snippet)>> ["alfa", "zulu", "bravo"] + args
+irb> puts a("charlie").sort
+alfa
+bravo
+charlie
+zulu
+~~~
 
 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
-    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"}
-    ...
+~~~
+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** 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!"
-    irb> exit
-    $ irb
-    irb> a
-    Snippets are persistent!
+~~~
+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` 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. 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"
-    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"
+~~~
+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"
+~~~
 
 You can configure some aspects of the snippets. Read "Configuration" chapter below.
 
 
-### Browse Program Data With GNU `less` ###
+### 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 you browse interactively!
+~~~
+$ irb
+irb> files = Dir["/etc/*"].sort
+# Some bulky array...
+irb> less files
+# ...which you 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
+~~~
+$ 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
+~~~
+$ irb
+irb> less(:stderr) do
+puts "to stdout"
+STDERR.puts "to stderr"
+end
+~~~
 
 You can configure which pager program to use and with which options. Read "Configuration" chapter below.
 
 
-### Break Execution and Return Instant Value ###
+### Break execution and return instant value ###
 
 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:
 
-    csv.each_with_index do |fc_row, i|
-      row = OpenHash[*fc_row.map {|k, v| [(k.to_sym rescue k), (v.to_s.strip rescue v)]}.flatten(1)]
-      ...
+~~~
+csv.each_with_index do |fc_row, i|
+  row = Hash[*fc_row.map {|k, v| [(k.to_sym rescue k), (v.to_s.strip rescue v)]}.flatten(1)]
+  ...
+~~~
 
 There's something wrong with the code and you want to see if `row` is given the correct value. To do it, use `IrbHacks.break`:
 
-    csv.each_with_index do |fc_row, i|
-      row = OpenHash[*fc_row.map {|k, v| [(k.to_sym rescue k), (v.to_s.strip rescue v)]}.flatten(1)]
-      IrbHacks.break(row)
+~~~
+csv.each_with_index do |fc_row, i|
+  row = Hash[*fc_row.map {|k, v| [(k.to_sym rescue k), (v.to_s.strip rescue v)]}.flatten(1)]
+  IrbHacks.break(row)
+~~~
 
 Now all you have to do is write an `ae` snippet and call it. `row` value will be available in IRB for inspection:
 
-    irb> ae
-    (snippet)>> Klass.new.method(args)
-    irb> row = a
-    # Back in IRB. Do whatever you want with `row` value now.
-    irb>
+~~~
+irb> ae
+(snippet)>> Klass.new.method(args)
+irb> row = a
+# 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 runtime, find the appropriate `IrbHacks.break` calls and defuse them.
 
@@ -159,13 +189,14 @@ 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"
+~~~
+require "rubygems"
+require "irb_hacks"
 
-    IrbHacks.conf.snippet_prompt = ">>> "
+IrbHacks.conf.snippet_prompt = ">>> "
+~~~
 
-
-### Configuration Variables (`IrbHacks.conf.*`)###
+### Configuration variables (`IrbHacks.conf.*`)###
 
 * `less_cmd` -- System command to invoke pager for `less`.
 * `snippet_history_file` -- Snippet (`a`, `ae`) history file.

data/Rakefile

@@ -1,44 +1 @@
-require "rake/rdoctask"
-require "yaml"
-
-GEM_NAME = "irb_hacks"
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.name = GEM_NAME
-    gem.summary = "Yet another set of IRB hacks"
-    gem.description = "Yet another set of IRB hacks"
-    gem.email = "alex.r@askit.org"
-    gem.homepage = "http://github.com/dadooda/irb_hacks"
-    gem.authors = ["Alex Fortuna"]
-    gem.files = FileList[
-      "[A-Z]*",
-      "*.gemspec",
-      "lib/**/*.rb",
-    ]
-  end
-rescue LoadError
-  STDERR.puts "This gem requires Jeweler to be built"
-end
-
-desc "Rebuild gemspec and package"
-task :rebuild => [:gemspec, :build]
-
-desc "Push (publish) gem to RubyGems.org"
-task :push do
-  # NOTE: 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], vh[:build]].compact.join(".")
-  pkgfile = File.join("pkg", "#{GEM_NAME}-#{version}.gem")
-  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
+require "bundler/gem_tasks"

data/irb_hacks.gemspec

@@ -1,45 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/irb_hacks/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{irb_hacks}
-  s.version = "0.2.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.name = "irb_hacks"
+  s.version = IrbHacks::VERSION
   s.authors = ["Alex Fortuna"]
-  s.date = %q{2012-02-10}
-  s.description = %q{Yet another set of IRB hacks}
-  s.email = %q{alex.r@askit.org}
-  s.extra_rdoc_files = [
-    "README.md"
-  ]
-  s.files = [
-    "MIT-LICENSE",
-    "README.md",
-    "Rakefile",
-    "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.6.2}
+  s.email = ["alex.r@askit.org"]
+  s.homepage = "http://github.com/dadooda/irb_hacks"
+
+  # Copy these from class's description, adjust markup.
   s.summary = %q{Yet another set of IRB hacks}
+  s.description = %q{Yet another set of IRB hacks}
+  # end of s.description=
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f)}
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
 end
-

data/lib/irb_hacks/break_exception.rb

@@ -1,4 +1,10 @@
 module IrbHacks
   # Exception class used by IrbHacks::break.
-  class BreakException < Exception; end
+  class BreakException < Exception
+    attr_accessor :value
+
+    def initialize(attrs = {})
+      attrs.each {|k, v| send("#{k}=", v)}
+    end
+  end
 end

data/lib/irb_hacks/snippet.rb

@@ -89,8 +89,7 @@ module IrbHacks
           # NOTE: Passing `binding` is important to provide a better backtrace when exception occurs.
           eval(code, binding, &block)
         rescue IrbHacks::BreakException => e
-          # If invoked as documented, `e.message` is always an array.
-          e.message[0]
+          return e.value
         end
       end
     end

data/lib/irb_hacks/version.rb

@@ -0,0 +1,4 @@
+module IrbHacks
+  # Gem version.
+  VERSION = "0.2.4"
+end

data/lib/irb_hacks.rb

@@ -24,7 +24,7 @@ module IrbHacks   #:doc:
   #   Reading name...
   #   => "John Smith"
   def self.break(value = nil)
-    raise BreakException, [value]
+    raise BreakException.new(:value => value)
   end
 
   # Access configuration object. See IrbHacks::Config.

metadata

@@ -1,32 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: irb_hacks
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.4
   prerelease: 
-  version: 0.2.3
 platform: ruby
-authors: 
+authors:
 - Alex Fortuna
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-10 00:00:00 +04:00
-default_executable: 
-dependencies: []
-
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Yet another set of IRB hacks
-email: alex.r@askit.org
+email:
+- alex.r@askit.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.md
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- VERSION.yml
 - irb_hacks.gemspec
 - lib/irb_hacks.rb
 - lib/irb_hacks/break_exception.rb
@@ -34,33 +62,29 @@ files:
 - 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
+- lib/irb_hacks/version.rb
 homepage: http://github.com/dadooda/irb_hacks
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Yet another set of IRB hacks
 test_files: []
-

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-:major: 0
-:minor: 2
-:patch: 3
-#:build: pre1