rcli 0.1.0

data/lib/commands/help.rb

@@ -0,0 +1,47 @@
+class HelpCommand  < Command
+
+  # description "Shows the current help screen"
+  # usage "rcli help <command>"
+  
+  def main
+    
+    if Rcli.script_config['global']['mode'] == 'single'
+      cmdname = Rcli.script_config['global']['default_command']
+      cmd = Command.load(cmdname)
+      cmd[cmdname][:instance].help
+    else
+      if @params[:args].size == 0
+        puts
+        puts Rcli.script_config['global']['description']
+        puts
+        puts "usage:\n     " + self.class.show_use
+        puts
+        
+        commands = Command.load_all
+
+        # require Rcli.script_root + DS + 'lib' + DS + 'commands' + DS + 'help'
+        # pp ::HelpCommand.describe ; exit
+
+        puts "Commands currently implemented are:"
+    
+        # calculate column width
+        biggest = 0
+        commands.each { |c,data| biggest = c.size if biggest < c.size }
+
+        commands.sort.each do |name,cmd|
+          next if name == 'help'
+          # puts "#{name}, :: #{cmd}"
+          puts "  %-#{biggest}s" % name + "  " + cmd[:instance].class.describe if name != 'debug'
+        end
+    
+        puts 
+        puts "Type '#{Rcli.script_config['global']['script_name']} help COMMAND' for instructions on using a specific command"
+        puts 
+      else
+        cmd = Command.load(@params[:args][0])
+      
+        cmd[@params[:args][0]][:instance].help
+      end
+    end
+  end
+end

data/lib/commands/install.rb

@@ -0,0 +1,86 @@
+require "highline/import"
+require 'core/shared/rcli_installation'
+class InstallCommand  < Command
+  
+  include Rcli::Installation
+  
+  description "Installs rcli to your system, or installs a specific rcli app"
+
+  def main()
+    
+    if $verbose
+      print "params : "
+      pp @params
+    end
+      
+    if _installed_rcli_base? && @params[:args].length > 0
+      if @params[:args].length != 2
+        puts "ERROR: Incorrect syntax. Please use 'rcli install [script] [alias]'"
+        exit
+      end
+      unless File.exists? @params[:args][0]
+        puts "ERROR: The filename provided does not exist. Please type 'rcli install help' for proper usage."
+      end
+      unless File.executable_real? @params[:args][0]
+        puts "ERROR: The script you're trying to install is not executable. Please type 'rcli install help' for proper usage."
+      end
+      if File.exists? Rcli::RCLI_DOTFOLDER + DS + 'bin' + DS + @params[:args][1]
+        puts "ERROR: The install name for that script is already taken"
+        exit
+      end
+            
+      unless FileUtils.ln_s(File.expand_path(@params[:args][0]),Rcli::RCLI_DOTFOLDER + DS + 'bin' + DS + @params[:args][1])
+        puts "ERROR: There was a problem installing " + @params[:args][1]
+        exit
+      end
+      
+      unless File.open(File.expand_path(Rcli::RCLI_DOTFOLDER + DS + 'app_info' + DS + @params[:args][1] + '.yml'),'w') { |f|
+          f << 'application_root: ' + File.dirname(File.expand_path(@params[:args][0])) + "\n"
+          f << 'executable: ' + File.basename(File.expand_path(@params[:args][0]))
+        }
+        puts "ERROR: There was a problem installing " + @params[:args][1]
+        FileUtils.rm(File.expand_path(@params[:args][0]),Rcli::RCLI_DOTFOLDER + DS + 'bin' + DS + @params[:args][1])
+        exit
+      end
+        
+    elsif @params[:args].length > 0 && !_installed_rcli_base?
+      puts "You haven't installed the rcli base yet. Please run 'rcli install' first."
+    elsif _installed_rcli_base?
+      puts "rcli base already installed"
+    else
+      if _install_rcli_base
+        puts "rcli successfully installed"
+      else
+        puts "ERROR"
+      end
+    end
+  end
+  
+private
+
+  def _install_rcli_base
+    if _installed_rcli_base?
+      return false
+    end
+
+    dotpath = File.expand_path('~/' + Rcli::RCLI_CONFIG['global']['hidden_dir_name'] )
+    puts "Installing to : #{dotpath}"
+    # exit
+    FileUtils.mkdir_p(dotpath + DS + 'bin')
+    FileUtils.mkdir_p(dotpath + DS + 'app_info')
+
+    if agree("Add rcli to your path to allow script installations? [yn]", true)
+      File.open(File.expand_path('~/.bash_profile'),'a') { |f|
+        f << "\n\n# rcli Installer addition on #{Time.now.inspect}. Adding appropriate PATH variables for use with rcli."
+        f << "\nexport PATH=#{dotpath}/bin:$PATH"
+        f << "\n# Finished adapting your PATH environment variable for use with rcli."
+      }
+    end
+  
+    File.open(dotpath + DS + 'config.yml', 'w') { |f|
+      f << File.read(Rcli::GEM_CONFIG + DS + 'application.yml')
+    }
+  
+
+  end
+end

data/lib/commands/list.rb

@@ -0,0 +1,28 @@
+class ListCommand  < Command
+
+  description "Lists all installed rcli programs"
+  
+  def main()
+    
+    puts "rcli installed applications"
+    puts "---------------------------"
+    
+    biggest = 0
+    Dir[Rcli::RCLI_DOTFOLDER + DS + 'app_info' + DS + '*'].each { |c| biggest = File.basename(c,'.yml').size if biggest < File.basename(c,'.yml').size }
+
+    puts "biggest is #{biggest}" if $verbose
+    # commands.sort.each do |name,cmd|
+    #   puts "  %-#{biggest}s" % name + "  " + cmd[:instance].description
+    # end
+
+    Dir[Rcli::RCLI_DOTFOLDER + DS + 'app_info' + DS + '*'].each { |f|
+      puts "loading #{f}..." if $verbose
+      app_info = YAML.load_file(f)
+      app_config = YAML.load_file(app_info['application_root'] + DS + 'config' + DS + 'application.yml' )
+      pp app_info if $verbose
+      # puts File.basename(f,'.yml') + " : " + (app_config['global']['description'] || "No description specified in #{File.basename(f,'.yml')}'s application config/application.yml")
+      puts "  %-#{biggest}s" % File.basename(f,'.yml') + " : " + (app_config['global']['description'] || "No description specified in #{File.basename(f,'.yml')}'s application config/application.yml")
+    }
+  end
+  
+end

data/lib/commands/uninstall.rb

@@ -0,0 +1,36 @@
+require "highline/import"
+
+class UninstallCommand  < Command
+  
+  include Rcli::Installation
+  
+  description "Uninstalls rcli from your system, or uninstalls a specific rcli app"
+
+  def main()
+    
+    if $verbose
+      print "params : "
+      pp @params
+    end
+      
+    if _installed_rcli_base? && @params[:args].length > 0
+      unless !File.exists? Rcli::RCLI_DOTFOLDER + DS + 'bin' + DS + @params[:args][0]
+        puts "ERROR: The rcli app you provided does not exist. Please type 'rcli list' for list of installed apps."
+      end
+
+      FileUtils.rm(File.exists? Rcli::RCLI_DOTFOLDER + DS + 'bin' + DS + @params[:args][0])
+      FileUtils.rm(File.exists? Rcli::RCLI_DOTFOLDER + DS + 'app_info' + DS + @params[:args][0] + '.yml')
+
+    elsif @params[:args].length > 0 && !_installed_rcli_base?
+      puts "You haven't installed the rcli base yet. Please run 'rcli install' first."
+    elsif _installed_rcli_base?
+      if agree('Are you sure you want to completely remove rcli from your system? (y/n)', true)
+        puts "Deleting : " + Rcli::RCLI_DOTFOLDER if $verbose
+        FileUtils.rm_rf(Rcli::RCLI_DOTFOLDER)
+      end
+    else
+      puts "ERROR: rcli isn't installed"
+    end
+  end
+  
+end

data/lib/commands/version.rb

@@ -0,0 +1,11 @@
+class VersionCommand  < Command
+  
+  description "Shows the current version of the application."
+  
+  def main
+    options = parse
+
+    puts "#{Rcli.script_config['global']['script_name']} version 0.0.1 (alpha)"
+  end
+
+end

data/lib/core/actions/create_file.rb

@@ -0,0 +1,106 @@
+require 'core/actions/empty_directory'
+
+class Rcli
+  module Actions
+
+    # Create a new file relative to the destination root with the given data,
+    # which is the return value of a block or a data string.
+    #
+    # ==== Parameters
+    # destination<String>:: the relative path to the destination root.
+    # data<String|NilClass>:: the data to append to the file.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   create_file "lib/fun_party.rb" do
+    #     hostname = ask("What is the virtual hostname I should use?")
+    #     "vhost.name = #{hostname}"
+    #   end
+    #
+    #   create_file "config/apach.conf", "your apache config"
+    #
+    def create_file(destination, data=nil, &block)
+      cf = CreateFile.new(destination, block || data.to_s)
+      cf.create
+    end
+    
+    alias :add_file :create_file
+
+    # AddFile is a subset of Template, which instead of rendering a file with
+    # ERB, it gets the content from the user.
+    #
+    class CreateFile #:nodoc:
+      attr_reader :data
+
+      def initialize(destination, data)
+        @data = data
+        @destination = destination
+        @empty_dir = EmptyDirectory.new(File.dirname(destination))
+
+      end
+
+      # Checks if the content of the file at the destination is identical to the rendered result.
+      #
+      # ==== Returns
+      # Boolean:: true if it is identical, false otherwise.
+      #
+      def identical?
+        exists? && File.binread(destination) == render
+      end
+
+      # Holds the content to be added to the file.
+      #
+      def contents
+        @render ||= if data.is_a?(Proc)
+          data.call
+        else
+          data
+        end
+      end
+
+      def create
+        
+        @empty_dir.create
+        File.open(@destination, 'wb') { |f| f.write contents }
+        
+      end
+
+      protected
+
+        # Now on conflict we check if the file is identical or not.
+        #
+        def on_conflict_behavior(&block)
+          if identical?
+            say_status :identical, :blue
+          else
+            options = base.options.merge(config)
+            force_or_skip_or_conflict(options[:force], options[:skip], &block)
+          end
+        end
+
+        # If force is true, run the action, otherwise check if it's not being
+        # skipped. If both are false, show the file_collision menu, if the menu
+        # returns true, force it, otherwise skip.
+        #
+        def force_or_skip_or_conflict(force, skip, &block)
+          if force
+            say_status :force, :yellow
+            block.call unless pretend?
+          elsif skip
+            say_status :skip, :yellow
+          else
+            say_status :conflict, :red
+            force_or_skip_or_conflict(force_on_collision?, true, &block)
+          end
+        end
+
+        # Shows the file collision menu to the user and gets the result.
+        #
+        def force_on_collision?
+          base.shell.file_collision(destination){ render }
+        end
+
+    end
+  end
+end

data/lib/core/actions/empty_directory.rb

@@ -0,0 +1,88 @@
+class Rcli
+  module Actions
+
+    # Creates an empty directory.
+    #
+    # ==== Parameters
+    # destination<String>:: the relative path to the destination root.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   empty_directory "doc"
+    #
+    def empty_directory(destination, config={})
+      go EmptyDirectory.new(destination)
+    end
+
+    # Class which holds create directory logic. This is the base class for
+    # other actions like create_file and directory.
+    #
+    # This implementation is based in Templater actions, created by Jonas Nicklas
+    # and Michael S. Klishin under MIT LICENSE.
+    #
+    class EmptyDirectory #:nodoc:
+      attr_reader :destination, :given_destination, :relative_destination
+
+      # Initializes given the source and destination.
+      #
+      # ==== Parameters
+      # base<Thor::Base>:: A Thor::Base instance
+      # source<String>:: Relative path to the source of this file
+      # destination<String>:: Relative path to the destination of this file
+      # config<Hash>:: give :verbose => false to not log the status.
+      #
+      def initialize(destination)
+        @destination = destination
+      end
+
+      # Checks if the destination folder already exists.
+      #
+      # ==== Returns
+      # Boolean:: true if the folder exists, false otherwise.
+      #
+      def exists?
+        ::File.exists?(destination)
+      end
+
+      def create
+        if exists?
+          return false;
+        else
+          ::FileUtils.mkdir_p(@destination)
+        end
+
+      end
+      
+      def revoke!
+        say_status :remove, :red
+        ::FileUtils.rm_rf(destination) if !pretend? && exists?
+        given_destination
+      end
+
+      protected
+
+        # Shortcut for pretend.
+        #
+        def pretend?
+          base.options[:pretend]
+        end
+
+        # Filenames in the encoded form are converted. If you have a file:
+        #
+        #   %class_name%.rb
+        #
+        # It gets the class name from the base and replace it:
+        #
+        #   user.rb
+        #
+        def convert_encoded_instructions(filename)
+          filename.gsub(/%(.*?)%/) do |string|
+            instruction = $1.strip
+            base.respond_to?(instruction) ? base.send(instruction) : string
+          end
+        end
+
+    end
+  end
+end

data/lib/core/actions/file_binary_read.rb

@@ -0,0 +1,9 @@
+class File #:nodoc:
+
+  unless File.respond_to?(:binread)
+    def self.binread(file)
+      File.open(file, 'rb') { |f| f.read }
+    end
+  end
+
+end

data/lib/core/actions.rb

@@ -0,0 +1,9 @@
+require 'fileutils'
+require 'uri'
+require 'core/actions/file_binary_read'
+
+glob = Rcli::GEM_LIB  + DS + 'core' + DS + 'actions' + DS + '*'
+Dir[glob].each do |action|
+  puts "requiring action : " + action if $verbose
+  require action
+end

data/lib/core/command.rb

@@ -0,0 +1,137 @@
+class Command
+
+  attr_reader :description
+
+  class << self
+    def description(d); @description = d; end
+    def usage(u); @usage = u; end
+    def describe; @description; end
+    def show_use; @usage; end
+  end
+  
+  def initialize
+    before_init
+    @params = {}
+    @options = nil
+
+    # if Rcli.script_config['global']['mode'] == 'multi'
+    #   @@description = "Current action not described. Please use \"description '...'\" in " + self.class.to_s + " to correct."
+    #   @@usage = "Usage:\n       #{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 "
+    # else
+    #   @@description = Rcli.script_config['global']['description'] 
+    #   @@usage = "Usage:\n       #{Rcli.script_config['global']['script_name']} [--flags,-f] arg1 arg2 arg3 "
+    # end
+
+    after_init
+  end
+  
+  def self.default_cmd; Rcli.script_config['global']['default_command']; end
+
+  def run(params = {})
+    @params = params
+    @options = parse_parameters
+    $verbose= @options.verbose
+    main
+  end
+
+  def main
+    puts "ERROR: main() method not defined for this command. Please define " + self.class.to_s + "#main() to continue."
+  end
+
+  def help
+    ARGV.push('-h')
+    opts = parse_parameters
+    puts
+  end
+  
+  #should be over-ridden in Command classes.
+  def before_init; end
+  def after_init; end
+
+
+  #### CLASS METHODS #####
+  def self.load_all
+    commands = {}
+    
+    require Rcli::GEM_LIB + DS + 'commands' + DS + 'debug'
+    require Rcli::GEM_LIB + DS + 'commands' + DS + 'help'
+    commands['debug'] = { :instance => DebugCommand.new }
+    commands['help'] = { :instance => HelpCommand.new }
+    HelpCommand.description "Current action not described. Please use \"description '...'\" in HelpCommand to correct." if not HelpCommand.describe
+    HelpCommand.usage "#{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 " if not HelpCommand.show_use
+    DebugCommand.description "Current action not described. Please use \"description '...'\" in DebugCommand to correct." if not DebugCommand.describe
+    DebugCommand.usage "#{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 " if not DebugCommand.show_use
+    
+
+    Command.get_allowed_commands.each do |c|
+      require Rcli.script_root + DS + 'lib' + DS + 'commands' + DS + c if File.exist?(Rcli.script_root + DS + 'lib' + DS + 'commands' + DS + c + '.rb')
+      Object.const_get("#{camelize(c)}Command").description "Current action not described. Please use \"description '...'\" in #{camelize(c)}Command to correct." if not Object.const_get("#{camelize(c)}Command").describe
+      Object.const_get("#{camelize(c)}Command").usage "#{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 " if not Object.const_get("#{camelize(c)}Command").show_use
+      # usage "#{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 "
+      
+      if c != 'debug' && c != 'help'
+        commands[c] = {
+#          :instance => TraceableFactory.createTraceableObject(camelize(c) + "Command")
+          :instance => Object.const_get("#{camelize(c)}Command").new
+        }
+      end
+    end
+
+    commands
+  end
+
+  def self.load(command)
+    commands = {}
+
+    if Command.get_allowed_commands.include?(command) 
+      require Rcli.script_root + DS + 'lib' + DS + 'commands' + DS + command if File.exist?(Rcli.script_root + DS + 'lib' + DS + 'commands' + DS  + command + '.rb')
+      Object.const_get("#{camelize(command)}Command").description "Current action not described. Please use \"description '...'\" in #{camelize(command)}Command to correct." if not Object.const_get("#{camelize(command)}Command").describe
+      Object.const_get("#{camelize(command)}Command").usage "#{Rcli.script_config['global']['script_name']} <command> [--flags,-f] arg1 arg2 arg3 " if not Object.const_get("#{camelize(command)}Command").show_use
+      commands[command] = {
+#        :instance => TraceableFactory.createTraceableObject("#{camelize(command)}Command")
+        :instance => Object.const_get("#{camelize(command)}Command").new
+      }
+    end
+
+    commands
+  end
+
+  def self.get_allowed_commands
+    results = Array.new
+    
+    glob = Rcli.script_root + DS + 'lib' + DS + 'commands' + DS + '*'
+    Dir[glob].each{ |c| results << File.basename(c,'.rb')}
+
+    results
+  end
+
+private
+
+  # def parse_parameters
+  #   # This works with the global ARGV, so no parameters need to be passed.
+  #   begin
+  #     opts = Trollop::options do
+  #       banner @@description
+  #       banner @@usage
+  #       opt :verbose, "Run with extra debugging output", :default => false
+  #     end
+  #   rescue Trollop::HelpNeeded
+  #     exit # stop if help is being displayed
+  #   end
+  # 
+  # end
+
+  def parse_parameters
+    refclass = self.class
+    # This works with the global ARGV, so no parameters need to be passed.
+    opts = Trollop::options do
+      banner "\n" + refclass.describe
+      banner "\nusage: \n       " + refclass.show_use + "\n"
+      banner "\noptions:"
+      opt :verbose, "Run with extra debugging output", :default => false
+      
+      banner "\n"
+    end
+  end
+
+end

data/lib/core/commander.rb

@@ -0,0 +1,48 @@
+require 'core/command'
+
+class Commander
+
+  def initialize
+    @commands = Command.load_all
+  end
+
+  def go
+    if ARGV.first == '--version'
+      ARGV[0] = 'version' # simulate 'script --version' functionality
+    end
+
+    if ARGV.first == '-h' || ARGV.first == '--help'
+      ARGV[0] = 'help' # catch help requests.
+    end
+
+    if Rcli.script_config['global']['mode'] == 'multi' && ARGV.size == 0 
+      ARGV.push Command.default_cmd # default action
+    end
+    
+
+    if Rcli.script_config['global']['mode'] == 'single'
+      if ARGV[0] != 'help' && ARGV[0] != 'version' && ARGV[0] != 'debug'
+        ARGV.insert( 0, Command.default_cmd)
+      end
+    elsif ARGV.first[0,1] !~ /^[a-zA-z]$/ 
+      puts "ERROR: Please specify a command as first argument"
+      exit
+    end
+
+    command = ARGV.shift # first parameter should be the command at this point.
+
+    unless @commands.keys.include?(command)
+      puts "ERROR: Invalid command: "  + command + ". Please use 'help' command for a list of allowed commands."
+      exit
+    end
+
+    # Separate arguments into those preceded by dashes (usually options or flags)
+    # and those not preceded by dashes (usually files)
+    opts = ARGV.collect { |arg| arg if arg[0,1] == '-' }.compact
+    args = ARGV.collect { |arg| arg if arg[0,1] != '-'}.compact
+
+    @commands[command][:instance].run(:opts => opts,:args =>args)
+    
+  end
+
+end

data/lib/core/console.rb

@@ -0,0 +1,5 @@
+class Console
+  def self.title(title)
+    say "<%= color('#{title}', :yellow) %>"
+  end
+end

data/lib/core/global_functions.rb

@@ -0,0 +1,16 @@
+# # shortcut to call a class method that you would like to be traceable
+# def ccm(className, sym, *args, &block)
+#   TraceableObject.call_class_method(className, sym, *args, &block)
+# end
+# # shortcut to instantiate a traceable object
+# def cto(className)
+#   TraceableFactory.createTraceableObject(className)
+# end
+
+def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+  if first_letter_in_uppercase
+    lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  else
+    lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+  end
+end

data/lib/core/shared/rcli_installation.rb

@@ -0,0 +1,9 @@
+class Rcli
+  module Installation
+  
+    def _installed_rcli_base?
+      File.directory? File.expand_path('~/' + Rcli::RCLI_CONFIG['global']['hidden_dir_name'] )
+    end
+
+  end
+end