rcli 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Eduardo Del Balso
+
+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/README.md

@@ -0,0 +1,193 @@
+# rcli
+
+## WHAT IS THIS
+
+rcli is a simple tool for writing and managing command-line applications. It
+spawned simply from me not liking the idea that I have to type 'thor' before
+my command line scripts. This is my take on getting this done a little more
+cleanly.
+
+## CAVEAT
+
+This was done a project to learn ruby, and is by no means perfect. If you like 
+it, please let me know. If you would like to add features, also let me
+know as I'll be glad to hear your ideas and integrate your code.
+
+Most importantly, if you have ideas of things I did wrong and could do better,
+let me know! The point is for me to learn, hopefully you find use in this at
+the same time.
+
+## INSTALLATION
+
+Find a nice place to put this repo. I like:
+
+	mkdir -p ~/lib/ruby
+	cd ~/lib/ruby
+	git clone git://github.com/edelbalso/rcli.git
+
+Now build the gem
+
+	cd rcli
+	build rcli.gemspec
+	gem install rcli-0.6.gem
+	
+Then install the required gems:
+
+	gem install highline
+	gem install text
+	
+and you should be good to go. Try:
+
+	rcli
+
+If you don't get a page full of exceptions, you're good to go. If so,
+get in touch with me and I will help you out.
+
+## ADVANCED INSTALLATION
+
+*WARNING! WARNING!*
+
+	I suggest you back up your ~/.bash_profile before completing this
+	step. You've been warned.
+
+*END WARNING!*
+
+rcli has the capability of 'installing' the applications you make with
+it so that they're available system-wide. It does this by creating a
+'.rcli' hidden folder and storing the locations of your applications
+once they're installed.
+
+To set up this folder in your home directory, type:
+
+	rcli install
+
+It will then prompt you to add a line to your .bash_profile. If you've
+succesfully backed up your .bash_profile, go ahead and accept this. The 
+uninstall doesn't yet remove the added lines, so if you've done this once,
+no point in doing it again or it will just mess up your file unecessarily.
+
+Once installed, do this to load the path into your terminal:
+
+	source ~/.bash_profile
+
+## WRITING YOUR FIRST APP
+
+To get started with rcli, simply create a folder anywhere in your home 
+folder where you'd like to keep your applications. I like:
+
+	mkdir -p ~/lib/ruby/rcli_apps/
+
+but any folder will do. Now create your app:
+
+	cd ~/lib/ruby/rcli_apps/
+	rcli generate gemate
+	rcli install gemate/gemate.rb gemate
+
+You should now have created an application 'gemate' that can be used
+from anywhere on your system. Go ahead and confirm this:
+
+	rcli list
+
+'gemate' should be listed here. If you have textmate installed, you
+can now go ahead and edit the generate app by typing:
+
+	rcli edit gemate
+
+and you can go ahead and rename the command located at 'lib/commands/example.rb'
+to 'lib/commands/view.rb'
+
+	mv gemate/lib/commands/example.rb gemate/lib/commands/view.rb
+
+and put the following code in the file:
+
+	class ViewCommand  < Command
+  
+	  def after_init
+	    # called after Command::initialize
+	    @description = "Opens a gem (or gems) to be viewed in Textmate"
+	  end
+
+	  def main
+
+	    if @params[:args].size != 1
+	      puts "ERROR: please provide a gem name to look up"
+	    end
+    
+	    name = @params[:args][0]
+	    term = name + '*'
+
+	    puts "Searching for '" + term + "'..."
+
+	    # get the path to the gem directory from rubygems and search for any matching directories
+	    path = `gem env gemdir`
+	    new_path = File.join([path.chomp, 'gems'])
+	    Dir.chdir(new_path)
+	    @d_arr = Dir.glob(term)
+
+	    if @d_arr.empty?
+	      puts "Sorry, nothing like that found"
+	    elsif @d_arr.size == 1
+	      view_one()
+	    else
+	      view_list()
+	    end
+    
+	  end
+
+	  private
+
+	  def view_one
+	    puts @d_arr.first
+	    print 'Do you want to view this? [Y/n]: '
+	    resp = $stdin.gets.chomp!
+	    if resp.empty? or resp.downcase == 'y'
+	      exec "mate #{@d_arr.first}"
+	    end
+	  end
+
+	  def view_list
+	    @d_arr.each_with_index {|d,i| puts "#{i + 1}: #{d}"}
+	    puts
+	    print 'Choose a directory or quit(q): '
+	    idx = gets.chomp!
+	    if idx.downcase == 'q'
+	      exit
+	    elsif (1..@d_arr.size).include?(idx.to_i)
+	      exec "mate #{@d_arr.at(idx.to_i - 1)}"
+	    else
+	      puts 'not a valid option'
+	    end
+	  end
+
+	end
+
+This code has been ripped off from one of the Thor tutorials. My apologies.
+
+Anyways, after saving this file, you should now be able to type
+
+	gemate view thor
+
+and textmate should pop up with the thor. You should similarly be able to 
+view any other gem installed on your system.
+
+Congrats, you've made your first command-line app with rcli.
+
+## TO DO 
+
+* Trollop is being used to parse commands. I need to clean up command-level 
+customization of trollop
+* Wrap shell commands provided by highline into something clean.
+
+## DEPENDENCIES
+
+sudo gem install highline
+sudo gem install text
+
+
+## ACKNOWLEDGEMENTS
+
+* Yehuda Katz for code I copied from Thor::Actions modules, as well as a bunch of other chunks. :)
+
+## AUTHOR
+
+Eduardo Del Balso

data/README.rdoc

@@ -0,0 +1,194 @@
+= rcli
+
+== WHAT IS THIS
+
+rcli is a simple tool for writing and managing command-line applications. It
+spawned simply from me not liking the idea that I have to type 'thor' before
+my command line scripts. This is my take on getting this done a little more
+cleanly.
+
+== CAVEAT
+
+This was done a project to learn ruby, and is by no means perfect. If you like 
+it, please let me know. If you would like to add features, also let me
+know as I'll be glad to hear your ideas and integrate your code.
+
+Most importantly, if you have ideas of things I did wrong and could do better,
+let me know! The point is for me to learn, hopefully you find use in this at
+the same time.
+
+== INSTALLATION
+
+Find a nice place to put this repo. I like:
+
+	mkdir -p ~/lib/ruby
+	cd ~/lib/ruby
+	git clone git://github.com/edelbalso/rcli.git
+
+Now build the gem
+
+	cd rcli
+	build rcli.gemspec
+	gem install rcli-0.6.gem
+	
+Then install the required gems:
+
+	gem install highline
+	gem install text
+	
+and you should be good to go. Try:
+
+	rcli
+
+If you don't get a page full of exceptions, you're good to go. If so,
+get in touch with me and I will help you out.
+
+== ADVANCED INSTALLATION
+
+*WARNING! WARNING!*
+
+	I suggest you back up your ~/.bash_profile before completing this
+	step. You've been warned.
+
+*END WARNING!*
+
+rcli has the capability of 'installing' the applications you make with
+it so that they're available system-wide. It does this by creating a
+'.rcli' hidden folder and storing the locations of your applications
+once they're installed.
+
+To set up this folder in your home directory, type:
+
+	rcli install
+
+It will then prompt you to add a line to your .bash_profile. If you've
+succesfully backed up your .bash_profile, go ahead and accept this. The 
+uninstall doesn't yet remove the added lines, so if you've done this once,
+no point in doing it again or it will just mess up your file unecessarily.
+
+Once installed, do this to load the path into your terminal:
+
+	source ~/.bash_profile
+
+== WRITING YOUR FIRST APP
+
+To get started with rcli, simply create a folder anywhere in your home 
+folder where you'd like to keep your applications. I like:
+
+	mkdir -p ~/lib/ruby/rcli_apps/
+
+but any folder will do. Now create your app:
+
+	cd ~/lib/ruby/rcli_apps/
+	rcli generate gemate
+	rcli install gemate/gemate.rb gemate
+
+You should now have created an application 'gemate' that can be used
+from anywhere on your system. Go ahead and confirm this:
+
+	rcli list
+
+'gemate' should be listed here. If you have textmate installed, you
+can now go ahead and edit the generate app by typing:
+
+	rcli edit gemate
+
+and you can go ahead and rename the command located at 'lib/commands/example.rb'
+to 'lib/commands/view.rb'
+
+	mv gemate/lib/commands/example.rb gemate/lib/commands/view.rb
+
+and put the following code in the file:
+
+	class ViewCommand  < Command
+  
+	  def after_init
+	    # called after Command::initialize
+	    @description = "Opens a gem (or gems) to be viewed in Textmate"
+	  end
+
+	  def main
+
+	    if @params[:args].size != 1
+	      puts "ERROR: please provide a gem name to look up"
+	    end
+    
+	    name = @params[:args][0]
+	    term = name + '*'
+
+	    puts "Searching for '" + term + "'..."
+
+	    # get the path to the gem directory from rubygems and search for any matching directories
+	    path = `gem env gemdir`
+	    new_path = File.join([path.chomp, 'gems'])
+	    Dir.chdir(new_path)
+	    @d_arr = Dir.glob(term)
+
+	    if @d_arr.empty?
+	      puts "Sorry, nothing like that found"
+	    elsif @d_arr.size == 1
+	      view_one()
+	    else
+	      view_list()
+	    end
+    
+	  end
+
+	  private
+
+	  def view_one
+	    puts @d_arr.first
+	    print 'Do you want to view this? [Y/n]: '
+	    resp = $stdin.gets.chomp!
+	    if resp.empty? or resp.downcase == 'y'
+	      exec "mate #{@d_arr.first}"
+	    end
+	  end
+
+	  def view_list
+	    @d_arr.each_with_index {|d,i| puts "#{i + 1}: #{d}"}
+	    puts
+	    print 'Choose a directory or quit(q): '
+	    idx = gets.chomp!
+	    if idx.downcase == 'q'
+	      exit
+	    elsif (1..@d_arr.size).include?(idx.to_i)
+	      exec "mate #{@d_arr.at(idx.to_i - 1)}"
+	    else
+	      puts 'not a valid option'
+	    end
+	  end
+
+	end
+
+This code has been ripped off from one of the Thor tutorials. My apologies.
+
+Anyways, after saving this file, you should now be able to type
+
+	gemate view thor
+
+and textmate should pop up with the thor. You should similarly be able to 
+view any other gem installed on your system.
+
+Congrats, you've made your first command-line app with rcli.
+
+== TO DO 
+
+* Trollop is being used to parse commands. I need to clean up command-level 
+customization of trollop
+* Wrap shell commands provided by highline into something clean.
+
+== DEPENDENCIES
+
+sudo gem install highline
+sudo gem install text
+
+
+== ACKNOWLEDGEMENTS
+
+* Yehuda Katz for code I copied from Thor::Actions modules, as well as a bunch of other chunks. :)
+
+
+== Copyright
+
+Copyright (c) 2010 Eduardo Del Balso. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rcli"
+    gem.summary = %Q{A rough framework for building command-line scripts in ruby.}
+    gem.description = %Q{This script creates, manages, installs, uninstalls and edits command-line ruby scripts. It also works as a useful library for building scripts.}
+    gem.email = "e.delbalso@gmail.com"
+    gem.homepage = "http://github.com/edelbalso/rcli"
+    gem.authors = ["Eduardo Del Balso"]
+    
+    gem.add_dependency "text", ">= 0.2.0"
+    gem.add_dependency "highline", ">= 1.6.1"
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.executables = ['rcli']
+    gem.require_paths = ['lib']
+
+    gem.files = FileList['lib/**/*.rb','README*', 'LICENSE', 'Rakefile', 'test/**/*.*', 'bin/**/*.rb'].to_a
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rcli-gem #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/rcli

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rcli'
+
+#Rcli.trace_app = true # Uncomment if you want to enable tracing.
+
+### LAUNCH rcli
+Rcli.type = :rcli
+Rcli.script_root = Pathname(__FILE__).realpath.parent.parent.to_s
+Rcli.go
+

data/lib/commands/compile.rb

@@ -0,0 +1,15 @@
+class CompileCommand < Command
+  
+  description 'Uninstalls and reinstalls rcli gem to your system from source. YMMV'
+  usage 'rcli compile'
+  
+  def main
+    
+    FileUtils.cd(Rcli::SRC_PATH)
+    `./comp`
+    
+    puts "Done"
+    # exec 'comp'
+  end
+  
+end

data/lib/commands/debug.rb

@@ -0,0 +1,86 @@
+class DebugCommand  < Command
+  
+  description "Dumps debug variables"
+  usage "rcli debug [console]"
+
+  def main
+    allowed_commands = ['console']
+    if @params[:args].size == 0
+      default_debug
+    elsif @params[:args].size == 1 && allowed_commands.include?( @params[:args][0] )
+      send( "console_debug" )
+    else
+      puts "ERROR: Invalid command"
+    end
+  end
+
+private
+
+  def console_debug
+    # Supported color sequences.
+    colors = %w{black red green yellow blue magenta cyan white}
+
+    # Using color() with symbols.
+    colors.each_with_index do |c, i|
+      say("This should be <%= color('#{c}', :#{c}) %>!")
+      if i == 0
+        say( "This should be " +
+             "<%= color('white on #{c}', :white, :on_#{c}) %>!")
+      else
+        say( "This should be " +
+             "<%= color( '#{colors[i - 1]} on #{c}',
+                         :#{colors[i - 1]}, :on_#{c} ) %>!")
+      end
+    end
+
+    # Using color with constants.
+    say("This should be <%= color('bold', BOLD) %>!")
+    say("This should be <%= color('underlined', UNDERLINE) %>!")
+
+    # Using constants only.
+    say("This might even <%= BLINK %>blink<%= CLEAR %>!")
+
+    # It even works with list wrapping.
+    erb_digits = %w{Zero One Two Three Four}      +
+                 ["<%= color('Five', :blue) %%>"] +
+                 %w{Six Seven Eight Nine}
+    say("<%= list(#{erb_digits.inspect}, :columns_down, 3) %>")
+
+  end
+  def default_debug
+    puts " misc"
+    puts " ----"
+    print "Dir.pwd : " 
+    puts Dir.pwd
+    puts
+    
+    puts  " rcli"
+    puts  " ----"
+    print "Rcli::GEM_ROOT       : "
+    puts Rcli::GEM_ROOT
+    print "Rcli::GEM_LIB        : "
+    puts Rcli::GEM_LIB
+    print "Rcli::GEM_BIN        : "
+    puts Rcli::GEM_BIN
+    print "Rcli::GEM_CONFIG     : "
+    puts Rcli::GEM_CONFIG
+    print "Rcli::RCLI_DOTFOLDER : "
+    puts Rcli::RCLI_DOTFOLDER
+    puts  "Rcli::RCLI_CONFIG    :"
+    pp Rcli::RCLI_CONFIG 
+    puts
+    
+    puts  " script"
+    puts  " ------"
+    print "Rcli.type          : "
+    puts Rcli.type
+    print "Rcli.script_root   : "
+    puts Rcli.script_root
+    print "Rcli.trace_app     : "
+    puts Rcli.trace_app
+    puts  "Rcli.script_config :"
+    pp Rcli.script_config
+
+    
+  end
+end

data/lib/commands/edit.rb

@@ -0,0 +1,34 @@
+class EditCommand < Command
+  
+  description "Opens a script for editing in your editor of choice"
+  usage "rcli edit <installed script> [-hv]"
+
+  def main
+      if @params[:args].size != 1
+        puts "ERROR: please provide a rcli app name to look up. Try 'rcli list' for a list of installed apps."
+      end
+
+      name = @params[:args][0]
+
+      if name == 'core'
+        exec "mate #{Rcli::SRC_PATH}"
+        exit
+      end
+      
+      yml_file = Rcli::RCLI_DOTFOLDER + DS + 'app_info' + DS + @params[:args][0] + '.yml'
+      unless File.exists? yml_file
+        puts "ERROR: That app is not installed"
+        exit
+      end
+      
+      app_info = YAML.load_file(yml_file)
+      
+      unless File.directory? app_info['application_root']
+        puts "ERROR: The installed application's folder could not be found"
+        exit
+      end
+
+      exec "$EDITOR #{app_info['application_root']}"
+    end
+
+end

data/lib/commands/generate.rb

@@ -0,0 +1,43 @@
+class GenerateCommand  < Command
+  
+  include Rcli::Actions
+
+  description "Generates a template CLI script in current folder"
+
+  def main()
+        
+    if @params[:args].length != 1
+      puts "ERROR: You must provide a unique app name as an argument."
+      exit
+    end
+
+    if File.directory? Dir.pwd + DS + @params[:args][0]
+      puts "ERROR: folder already exists. Please choose another name"
+      exit
+    end
+        
+    app_name = @params[:args][0]
+    
+    tpl_dir = Rcli::GEM_LIB + DS + 'templates' + DS + 'new_app'
+        
+    # iterate through the new_app template
+    Dir[ tpl_dir + DS + '**' + DS + '*.*'].each do |f|
+      # TODO : Use Pathname#relative_path_from for this.
+      new_file_name = f[tpl_dir.length + 1 ,f.length - tpl_dir.length]
+      
+      new_file_name.gsub!(/RCLIAPPNAME/,app_name)
+
+      puts "creating " + app_name + DS + new_file_name
+      create_file Dir.pwd() + DS + app_name + DS + new_file_name do
+        contents = File.read(f)
+        contents.gsub(/RCLIAPPNAME/,app_name)
+      end
+      
+      if f == tpl_dir + DS + 'RCLIAPPNAME.rb'
+        puts "Changing executable mode of " + new_file_name
+        File.chmod(0755,Dir.pwd() + DS + app_name + DS + new_file_name)
+      end
+    end
+  end
+
+end