arh 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+rdoc
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    Lidia (0.0.2)
+      open4 (= 0.9.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    linecache (0.43)
+    open4 (0.9.6)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Lidia!
+  open4 (= 0.9.6)
+  rspec (~> 2.3.0)
+  ruby-debug (~> 0.10.3)

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 2010-12-30
+
+* 1 major enhancement:
+  * initial release: add class Arh

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+arh.gemspec
+lib/arh.rb
+script/console
+script/destroy
+script/generate
+
+

data/PostInstall.txt

@@ -0,0 +1,5 @@
+
+For more information on lidia, see http://lidia.rubyforge.org
+
+
+

data/README.rdoc

@@ -0,0 +1,134 @@
+= LIDIA
+
+* http://gitorious/gnoxys/lidia
+
+== DESCRIPTION:
+
+Lidia is a yml based command contructor class. Aims to be easy to use and to provide an easy way to remember tons of commands
+
+== SYNOPSIS:
+
+Lidia's is written to provide an easy way to manage commands calls. Commands structure can be defined in an easy yaml file.
+
+  # $your editor ls.lidia.yml
+  : ==parameters:
+    :columns:
+      :option: -l
+      :description:  listing format@
+
+By default, lidia loads definition files from gem installation folder ../source, or you can pass with <tt>:definition_file</tt> the location
+
+  >> Lidia::Command.new('ls', {}, :definition_file => 'ls.lidia.yml')
+  => Lidia::Command 
+        + name: ls,
+        + definition file at:/var/www/lidia/sources/ls.lidia.yml
+        + parameters:
+          * name: columns               group: option    , value: nil
+
+Values can be passed as argument on new, or creating by block
+
+  >> Lidia::Command.new('ls', {:columns => true })
+  ?> Lidia::Command.new('ls') do |l|
+  ?>   l.columns = true
+  >> end
+  => Lidia::Command 
+        + name: ls,
+        + definition file at:/var/www/lidia/sources/ls.lidia.yml
+        + parameters:
+          * name: columns               group: option    , value: true 
+
+Once u have defined all the parameters that your command will use, define which actions can be done, por example, list_by_columns
+
+  # your editor ls.lidia.yml
+  # :actions:
+  #   :list_by_columns:
+  #     :parameters:
+  #       :required: [ :columns ]
+
+Now ask for <tt>command_for</tt> lidia list_by_columns
+
+  >> l = Lidia::Command.new('ls', {:columns => nil })
+  => Lidia::Command 
+        + name: ls,
+        + definition file at:/var/www/lidia/sources/ls.lidia.yml
+        + parameters:
+          * name: columns               group: option    , value: nil 
+        
+  >> l.command_for(:list_by_columns)
+  ArgumentError: Parameter columns required but not valid
+
+Ooops, parameter -l is required, to list_by_columns action, so set it to true
+
+  >> l.columns = true
+  => true
+  >> l.command_for(:list_by_columns)
+  => "/bin/ls -l"
+
+We want sometimes, list other directory. so prepare defintion file to get an argument
+
+  # $your editor ls.lidia.yml
+  # :parameters:
+  #   :list_what:
+  #     :description:  what do u want to list?
+
+this option can be used for listing_by_columns to, but it is not mandatary
+
+  # $your editor ls.lidia.yml
+  # :actions:
+  #   :list_by_columns:
+  #     :parameters:
+  #       :required: [ :columns ]
+  #       :optional: [ :list_what ]
+
+Now, no exceptions is raised, but argument can be used
+
+  >> l = Lidia::Command.new('ls', {:columns => true })
+  => Lidia::Command 
+        + name: ls,
+        + definition file at:/var/www/lidia/sources/ls.lidia.yml
+        + parameters:
+          * name: columns               group: option    , value: true 
+          * name: list_what             group: argument  , value: nil 
+        
+  >> l.command_for(:list_by_columns)
+  => "/bin/ls -l "
+  >> l.list_what = '/tmp'
+  => "/tmp"
+  >> l.command_for(:list_by_columns)
+  => "/bin/ls -l   \"/tmp\" "
+
+
+
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+require 'rake'
+require 'rake/rdoctask'
+require 'rubygems'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'bundler'
+require 'open4'
+require File.join(File.dirname(__FILE__), 'lib', 'arh')
+
+
+Rspec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--color"]
+end
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'arh'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/arh.gemspec

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'lib', 'arh')
+
+Gem::Specification.new do |s|
+  s.name = "arh"
+  s.version = Arh::VERSION
+  s.summary = "Automatic Remote Hands (!) is a command executer class.Based on Open4, allows you to execute commands in ruby shell and capture output, errors, exit_level and more"
+  s.description = "Automatic Remote Hands (!) is a command executer class.Based on Open4, allows you to execute commands in ruby shell and capture output, errors, exit_level and more"
+  s.authors = ['Gnoxys' ]
+  s.email = ['development@gnoxys.net']
+  s.homepage = 'http://gitorious.org/gnoxys/arh'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency('open4', '~> 0.9.6')
+  s.add_development_dependency('rspec', '~> 2.3.0')
+  
+  if RUBY_VERSION < '1.9'
+    s.add_development_dependency('ruby-debug', '~> 0.10.3')
+  end
+
+end

data/lib/arh.rb

@@ -0,0 +1,113 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'open4'
+
+class Arh
+  VERSION = '0.1.0'
+  
+  attr_reader :start_at
+  attr_reader :end_at
+  attr_reader :cmd
+  attr_reader :output
+  attr_reader :errors
+  attr_reader :exit_level
+  attr_reader :pid
+  attr_reader :status
+  
+  
+  # = Arh.execute
+  # 
+  # Arh executes command with open4. Arh instance is returned with this attributes
+  #
+  #  - start_at: Time instance storing when command was started
+  #  - end_at: Time instance storing when command was ended
+  #  - cmd: Command executed
+  #  - output: Returns String with output at standart output
+  #  - errors: Returns String with output at errors output
+  #  - exit_evel: Returns interger command exit level
+  #  - pid: assigned process identificator
+  #  - status: Process status object
+  #
+  # = User example
+  #
+  #   a = Arh.execute('ls /tmp')
+  #   => #<Arh:0xf7049dac @end_at=Thu Dec 30 18:13:41 +0000 2010, @cmd="ls /tmp", @status=#<Process::Status: pid=10863,exited(0)>, @exit_level=0, @pid=10863, @start_at=Thu Dec 30 18:13:41 +0000 2010, @errors="\n", @pipe=nil, @output="test">
+  #  a.exit_level
+  # >> a.exit_level
+  # => 0
+  # >> a =  Arh.execute('ls /tmps')
+  # => #<Arh:0xf7041990 @end_at=Thu Dec 30 18:15:21 +0000 2010, @cmd="ls /tmps", @status=#<Process::Status: pid=10871,exited(2)>, @exit_level=2, @pid=10871, @start_at=Thu Dec 30 18:15:21 +0000 2010, @errors="ls: no se puede acceder a /tmps: No existe el fichero o el directorio\n", @pipe=nil, @output="\n">
+  # >> a.errors
+  # => "ls: no se puede acceder a /tmps: No existe el fichero o el directorio\n"
+  # >> a.exit_level
+  # => 2
+  def self.execute(shell_command, options = {})
+    new(shell_command, options).execute
+  end
+  
+  def self.execute!(shell_command, options = {})
+    new(shell_command, options).execute!
+  end
+    
+  def execute!
+    @raise_on_fail = true
+    execute
+  end
+  
+  def initialize(shell_command, options = {})
+    raise ArgumentError, "no command given" unless shell_command
+    @cmd  = shell_command
+    @pipe = options[:pipe]
+  end
+    
+  def execute
+
+    # trap_save = trap( 0, "IGNORE" )
+    
+    @start_at = Time.now
+
+    read_stdout, write_stdout = IO.pipe
+    read_stderr, write_stderr = IO.pipe
+
+    pid = fork do
+      # trap( 0, "IGNORE" )
+      read_stdout.close
+      read_stderr.close
+
+      cmd = @cmd
+      cmd = "#{ @pipe }|#{ cmd }" if @pipe
+      
+      pid_open4, stdin, stdout, stderr = Open4::popen4 "#{ cmd }"
+
+      write_stdout.puts stdout.read
+      write_stderr.puts stderr.read
+
+      ignored, status_open4 = Process::waitpid2 pid_open4
+      exit status_open4.exitstatus
+    end
+    
+    # trap( 0, trap_save )
+
+    write_stdout.close
+    write_stderr.close
+
+    result_stdout = read_stdout.read
+    result_stderr = read_stderr.read
+
+    @pid, @status = Process.wait2(pid)
+
+    @output     = result_stdout
+    @errors     = result_stderr
+    @exit_level = status.exitstatus
+    @pid        = pid
+    @status     = status
+    @end_at     = Time.now
+    self
+  end
+  
+  def success?
+    @exit_level.zero?
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/arh.rb'}"
+puts "Loading arh gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: arh
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gnoxys
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-30 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 9
+        - 6
+        version: 0.9.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 10
+        - 3
+        version: 0.10.3
+  type: :development
+  version_requirements: *id003
+description: Automatic Remote Hands (!) is a command executer class.Based on Open4, allows you to execute commands in ruby shell and capture output, errors, exit_level and more
+email: 
+- development@gnoxys.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- arh.gemspec
+- lib/arh.rb
+- script/console
+- script/destroy
+- script/generate
+has_rdoc: true
+homepage: http://gitorious.org/gnoxys/arh
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatic Remote Hands (!) is a command executer class.Based on Open4, allows you to execute commands in ruby shell and capture output, errors, exit_level and more
+test_files: []
+