rsh 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rsh.rb

@@ -2,7 +2,7 @@
 # 
 # Creates and operates an 'rsh' command call instance. Parameters to rsh may
 # be specified through either constructor or attribute accessors. Result of
-# rsh execution (_String_) is either returned in functional style (<tt>##execute</tt> method call)
+# rsh execution (_String_) is either returned in functional style (<tt>execute</tt> method call)
 # or in special attribute, _result_.
 #
 # == Synopsis
@@ -16,6 +16,23 @@
 #
 #   18:30:46.799 MSD Fri Oct 22 2010
 #
+# === Example:
+#
+# This is an example of rsh in action usin interactive Ruby.
+#
+#   irb(main):001:0> require 'rsh'
+#   => true
+#
+#   irb(main):002:0> rsh = Rsh.new(:host => "c7206", :ruser => "bill",
+#                                  :command => "show clock")
+#   => #<Rsh:0x2853f390 @ruser="bill", @executable="/usr/bin/rsh", @result="", @command="show clock", @nullr=false, @host="c7206", @to=3>
+#
+#   irb(main):003:0> rsh.execute do |line| puts line end
+#
+#   18:30:46.799 MSD Fri Oct 22 2010
+#   => "\r\n18:30:46.799 MSD Fri Oct 22 2010\n"
+#
+#
 # == See also
 #
 #   % man 1 rsh
@@ -44,26 +61,22 @@ class Rsh
   attr_accessor :nullr
 
   # The Constructor. Checks the presence of rsh in the system (running,
-  # naturally, 'which rsh') and prepares the command to be run with <tt>##execute</tt>. 
+  # naturally, 'which rsh') and prepares the command to be run with <tt>execute</tt>. 
   # rsh CLI arguments are either having default values, being collected from constructor 
   # call or specified via accessors.
   #
-  # call-seq:
-  #   new(:host => "hostname", 
-  #       :command => "example.sh", 
-  #       :ruser => "jack", 
-  #       :to => 5, 
-  #       :nullr => true)
-  #
-  # Argument defaults are:
+  # Call sequence:
+  #   Rsh.new -> Rsh instance
+  #   Rsh.new(:host => "hostname", :command => "example.sh", :ruser => "jack", :to => 5, :nullr => true) -> Rsh instance
+  # 
+  # If called without arguments, the following default values are being used:
+  # 
   #   :host    => "localhost"
   #   :command => ""
   #   :ruser   => "nobody"
   #   :to      => 3 
   #   :nullr   => false
   #
-  # Arguments hash is optional.
-  #
   def initialize(args={})
     args = {:host    => "localhost", 
             :command => "", 
@@ -92,6 +105,15 @@ class Rsh
   # If given a block, calls it for each line received from rsh output
   # (parameter _line_).
   #
+  # Call sequence:
+  #
+  # a)
+  #   rsh_inst.execute do |line|
+  #     puts line
+  #   done -> complete_result_String
+  # b)
+  #   rsh_inst.execute -> complete_result_String
+  #
   # Returns:: the complete rsh output as one _String_. The result is also
   #           stored and available via _result_ attribute.
   #
@@ -106,22 +128,4 @@ class Rsh
     @result
   end
 
-  #
-  # :section: Example
-  #
-  # This is an example of rsh in action usin interactive Ruby.
-  #
-  #   irb(main):001:0> require 'rsh'
-  #   => true
-  #
-  #   irb(main):002:0> rsh = Rsh.new(:host => "c7206", :ruser => "bill",
-  #                                  :command => "show clock")
-  #   => #<Rsh:0x2853f390 @ruser="bill", @executable="/usr/bin/rsh", @result="", @command="show clock", @nullr=false, @host="c7206", @to=3>
-  #
-  #   irb(main):003:0> rsh.execute do |line| puts line end
-  #
-  #   18:30:46.799 MSD Fri Oct 22 2010
-  #   => "\r\n18:30:46.799 MSD Fri Oct 22 2010\n"
-  #
-
 end

data/rsh.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rsh}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pavel Argentov"]
-  s.date = %q{2010-10-22}
+  s.date = %q{2010-10-25}
   s.description = %q{All freenixes (e.g. Linux, *BSD, etc.) have 'rsh' command.
       Here's the gem wrapping call to this command and handling the command's result/output.}
   s.email = %q{argentoff@gmail.com}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsh
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Pavel Argentov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 +04:00
+date: 2010-10-25 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency