yaih 0.0.2 → 0.0.3

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.yardoc
+doc

data/README.textile

@@ -1,21 +1,21 @@
 h2. Description
 
-_YAIH_ is an acronym that stands for *Y*et *A*nother *I*RB *H*istory.
+YAIH is an acronym that stands for Yet Another IRB History. It's a gem that
+provides bash like methods for interfacing with IRB history.
 
 h2. Features
 
 The aim of this gem is providing a bash like history to IRB. If you require it in your irbrc you'll get the following methods:
 
 * h
-The h method prints the last _n_(10 as default) lines of your irb history.
+The h method prints the last _n_(10 as default) lines of your IRB history.
 * hgrep
-It takes a string as only argument and greps your irb history.
+It takes a string as only argument and greps your IRB history.
 * h!
-It takes a range of lines to execute from your irb history.
+It takes a range of lines to execute from your IRB history.
 
 h2. Roadmap
 
-* document source code
 * write some tests
 * includes a proc to erase history duplicate lines
 * make the gem configurable with some options like default printed lines number, history _decoration_ type, etc.

data/lib/yaih/core.rb

@@ -1,13 +1,16 @@
 module Yaih
-    module Core
+    module Core # This module contains methods for interefacing with IRB history
 
         extend self
 
+        # Returns an array of IRB history entries
+        # bases of the given n.
         def entries(n=Readline::HISTORY.size)
             size=Readline::HISTORY.size
             Readline::HISTORY.to_a[(size - n)..size-1]
         end
 
+        # Returns an array of strings
         def decorate(n)
             size=Readline::HISTORY.size
             ((size - n)..size-1).zip(entries(n)).map {|e| e.join(" ")}

data/lib/yaih/kernel.rb

@@ -1,17 +1,27 @@
-module Kernel
+module Kernel # Adding methods to Kernel module makes possible to use them in irb.
 
+    # Prints the latest n lines from IRB
+    # history. It decorates each line with
+    # the correspondent command number.
+    # @return [Fixnum] number of printed lines.
     def h(n=10)
         entries = Yaih::Core.decorate(n)
         puts entries
         entries.size
     end
 
+    # It greps history and prints matched lines.
+    # @return [Fixnum] number of printed lines.
+    # @todo Consider to highlight matched part.
     def hgrep(word)
         matched=Yaih::Core.decorate(Readline::HISTORY.size - 1).select {|h| h.match(word)}
         puts matched
         matched.size
     end
 
+    # It takes the range of lines to execute,
+    # evals the lines and prints them.
+    # @return [nil]
     def h!(start, stop=nil)
         stop=start unless stop
         lines = Yaih::Core.entries[start..stop]

data/lib/yaih/version.rb

@@ -1,3 +1,3 @@
 module Yaih
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/yaih.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["lucapette@gmail.com"]
   s.homepage    = "https://github.com/lucapette/yaih"
   s.summary     = %q{Yet Another IRB History}
-  s.description = %q{a bash like history}
+  s.description = %q{Require it in your irbrc if you want to get bash like commands for history}
 
   s.rubyforge_project = "yaih"
 

metadata

@@ -2,7 +2,7 @@
 name: yaih
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - lucapette
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 +01:00
+date: 2011-03-19 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: a bash like history
+description: Require it in your irbrc if you want to get bash like commands for history
 email: 
 - lucapette@gmail.com
 executables: []