rcomp 0.1.1 → 0.2.0

data/features/version.feature

@@ -3,4 +3,4 @@ Feature: Version
 
   Scenario: run version
     When I run `rcomp version`
-    Then the output should contain "0.1.0"
+    Then the output should contain the version number

data/lib/rcomp.rb

@@ -7,3 +7,5 @@ require 'rcomp/runner'
 require 'rcomp/suite'
 require 'rcomp/test'
 require 'rcomp/version'
+require 'rcomp/initializer'
+require 'rcomp/process'

data/lib/rcomp/actions.rb

@@ -26,6 +26,12 @@ module RComp
       end
     end
 
+    def mkpath(path)
+      unless File.exists? path
+        FileUtils.mkpath path
+      end
+    end
+
     def touch(path)
       unless File.exist? path
         FileUtils.touch path

data/lib/rcomp/cli.rb

@@ -3,9 +3,10 @@ require 'thor'
 module RComp
   class CLI < Thor
 
-    include RComp::Actions
+    include Thor::Actions
     include RComp::Runner
     include RComp::Suite
+    include RComp::Initializer
 
     def initialize(args=[], options={}, config={})
       super
@@ -13,69 +14,47 @@ module RComp
       @conf = Conf.instance
     end
 
-    ##
-    ## CLI Commands
-    ##
+    ###
+    # CLI Commands
+    ###
     
-    # init
     desc "init", "Setup rcomp test directory"
     def init
-      if initialized?
-        puts "RComp already initialized"
-        exit 1
-      end
+      guard_initialized
 
-      unless Dir.exists?(File.dirname(@conf.root))
-        puts "No directory #{File.dirname(@conf.root)}"
-        exit 1
+      unless command_exists?
+        @conf.set_command(ask("Enter the command you want to test:"))
       end
 
-      # Create RComp directories
-      mkdir @conf.root
-      mkdir @conf.test_root
-      mkdir @conf.expected_root
-      mkdir @conf.result_root
-
+      initialize_directories
       puts "RComp successfully initialized"
     end
 
-    # version
+
     desc "version", "Prints RComp's version information"
     def version
       puts "RComp version #{RComp::VERSION}"
     end
-    map %w(-v --version) => :version
 
-    # set-command
-    desc "set_command COMMAND", "Sets the command RComp will run tests with"
-    def set_command(command)
-      @conf.set_conf_value("command", command)
-    end
-    map "c" => :set_command
+    map %w(-v --version) => :version
 
-    # set-directory
-    desc "set_directory PATH", "Set the directory RComp will store files"
-    def set_directory(path)
-      @conf.set_conf_value("directory", path)
-    end
-    map "d" => :set_directory
 
-    # test
     desc "test", "Run all tests"
     method_option :grep,
       :type => :string,
       :desc => "Only test files that match pattern"
     def test
-      @conf.require_basic_conf
+      guard_uninitialized
       if @options[:grep]
         run_suite(load_suite(@options[:grep]), :test)
       else
         run_suite(load_suite, :test)
       end
     end
+
     map "t" => :test
 
-    # generate
+
     desc "generate", "Generate expected output for all tests"
     method_option :grep,
       :type => :string,
@@ -86,11 +65,14 @@ module RComp
       :aliases => "-O",
       :desc => "Overwrite expected output file for test if present"
     def generate
-      @conf.require_basic_conf
+      guard_uninitialized
 
       # Display confirmation dialouge when -O is passed without filter
       if !@options[:grep] && options.overwrite
-        confirm_action "This will overwrite all existing expected results."
+        unless yes? "This will overwrite all existing expected results."
+          say 'Aborting...'
+          exit 1
+        end
       end
 
       if @options[:grep]
@@ -99,26 +81,7 @@ module RComp
         run_suite(load_suite, :generate, @options)
       end
     end
-    map "g" => :generate
-
-    private
-
-    def confirm_action(warning)
-      puts warning
-      print 'Are you sure? (Y/N) '
-      confirm = STDIN.gets.chomp
-
-      unless confirm.downcase == 'y'
-        say 'Aborting...'
-        exit 1
-      end
-    end
 
-    def initialized?
-      File.exists?(@conf.root) && 
-      File.exists?(@conf.test_root) && 
-      File.exists?(@conf.result_root) && 
-      File.exists?(@conf.expected_root)
-    end
+    map "g" => :generate
   end
 end

data/lib/rcomp/conf.rb

@@ -8,61 +8,58 @@ module RComp
     include RComp::Actions
 
     attr_reader :root, :test_root, :result_root, :expected_root, 
-                :command
+                :command, :ignore, :timeout
+
+    # Conf file path
+    CONF_PATH = '.rcomp'
+
+    # Valid configuraiton keys
+    VALID_KEYS = ['directory',
+                  'command',
+                  'ignore',
+                  'timeout']
+
+    # Default configuration options
+    DEFAULT = { 'directory' => 'rcomp',
+                'timeout'   => 5 }
 
     # Initialize a new config object
     #
     # Loads options from config file, merges with defaults
     # and stores everything in memory
     def initialize
-      # Config file path
-      @path = '.rcomp'
-    
-      # Set valid keys for config file
-      @valid_keys = ['directory',
-                     'command']
-
-      # Set default options and overwrite with config file options
-      @default = { 'directory' => 'rcomp' }
+      # Load custom configuration and merge it with defaults
       @custom = read_conf_file
-      @conf = @default.merge(@custom)
+      @conf = DEFAULT.merge(@custom)
 
       # Load configuration values into attributes
       @command = @conf['command']
+      @ignore = @conf['ignore']
+      @ignore ||= []
+      @timeout = @conf['timeout']
       @root = @conf['directory']
       @test_root = @root + '/tests'
       @result_root = @root + '/results'
       @expected_root = @root + '/expected'
     end
 
-    # Set a configuration value and write it to the config file
+    # Set a command as a custom configuration value
     #
     # Returns nothing
-    def set_conf_value(key, value)
-      @custom[key] = value
-      puts "#{key} set to #{value}"
+    def set_command(command)
+      @custom['command'] = command
+      puts "Command set to #{command}"
       write_conf_file
     end
-    
-    # Emit error unless all required conf keys are present in conf file
-    #
-    # Returns nothing
-    def require_basic_conf
-      require_command
-      require_root_exists
-      require_root_subdirs
-    end
-
-
+   
     private
 
-    # Write the current config options to the config file
+    # Write the current custom config options to the config file
     #
     # Returns nothing
     def write_conf_file
-      exit 1 unless @path
-      touch @path unless File.exists?(@path)
-      conf_file = File.open(@path, 'w')
+      touch CONF_PATH unless File.exists?(CONF_PATH)
+      conf_file = File.open(CONF_PATH, 'w')
       conf_file.puts YAML.dump @custom
     end
     
@@ -71,58 +68,17 @@ module RComp
     # Returns a Hash of config options
     def read_conf_file
       conf = {}
-
-      if File.exists?(@path) && File.size?(@path)
-
+      if File.exists?(CONF_PATH) && File.size?(CONF_PATH)
         # Store valid conf keys
-        YAML.load_file(@path).each do |key, value|
-
-          if @valid_keys.include? key
+        YAML.load_file(CONF_PATH).each do |key, value|
+          if VALID_KEYS.include? key
             conf[key] = value
           else
             say "Invalid configuration key: #{key}"
           end
         end
       end
-
       conf
     end
-
-    # Require the command config option to be set
-    # Print error and exit otherwise
-    #
-    # Returns nothing
-    def require_command
-      unless @command
-        puts "No command present"
-        puts "Run rcomp c COMMAND to add a command to test with"
-        exit 1
-      end
-    end
-
-    # Require the existance of the root directory
-    # Print error and exit otherwise
-    #
-    # Returns nothing
-    def require_root_exists
-      unless File.exists? @root
-        puts "No RComp directory. Run rcomp init to create"
-        exit 1
-      end
-    end
-
-    # Require all sudirectories of the root directory to exist
-    # Print error and exit otherwise
-    #
-    # Returns nothing
-    def require_root_subdirs
-      unless File.exists?(@test_root) && 
-        File.exists?(@result_root) && 
-        File.exists?(@expected_root)
-        puts "Missing RComp directories at #{@root}"
-        puts "Run rcomp init to repair"
-        exit 1
-      end
-    end
   end
 end

data/lib/rcomp/initializer.rb

@@ -0,0 +1,108 @@
+module RComp
+  module Initializer
+
+    include RComp::Actions
+
+    @@conf = Conf.instance
+
+    # Emit error unless RComp is fully initialized
+    #
+    # Returns nothing
+    def guard_uninitialized
+      guard_command_exists
+      guard_root_dir_exists
+      guard_root_subdirs_exist
+    end
+
+    # Emit error unless RComp is not fully initialized
+    #
+    # Returns nothing
+    def guard_initialized
+      if initialized?
+        puts "RComp already initialized"
+        exit 1
+      end
+    end
+
+    # Create RComp directories if they don't already exist
+    # 
+    # Returns nothing
+    def initialize_directories
+      mkpath @@conf.root
+      mkdir @@conf.test_root
+      mkdir @@conf.expected_root
+      mkdir @@conf.result_root
+    end
+
+    private
+
+    # Checks for the existance of a command to test with
+    #
+    # Returns a boolean
+    def command_exists?
+      @@conf.command
+    end
+
+    # Checks for the existance of RComp's root directory
+    #
+    # Returns a boolean
+    def root_dir_exists?
+      File.exists?(@@conf.root)
+    end
+
+    # Checks for the existance of the required subdirectories inside
+    # of RComp's root directory
+    #
+    # Returns a boolean
+    def root_subdirs_exist?
+      File.exists?(@@conf.test_root) && 
+      File.exists?(@@conf.result_root) && 
+      File.exists?(@conf.expected_root)
+    end
+
+    # Checks to see if RComp is fully initialized
+    #
+    # Returns a boolean
+    def initialized?
+      command_exists? &&
+        root_dir_exists? &&
+        root_subdirs_exist?
+    end
+
+    # Require the command config option to be set
+    # Print error and exit otherwise
+    #
+    # Returns nothing
+    def guard_command_exists
+      unless command_exists?
+        puts "No command present"
+        puts "Run rcomp init to setup"
+        exit 1
+      end
+    end
+
+    # Require the existance of the root directory
+    # Print error and exit otherwise
+    #
+    # Returns nothing
+    def guard_root_dir_exists
+      unless root_dir_exists?
+        puts "No RComp directory"
+        puts "Run rcomp init to create"
+        exit 1
+      end
+    end
+
+    # Require all sudirectories of the root directory to exist
+    # Print error and exit otherwise
+    #
+    # Returns nothing
+    def guard_root_subdirs_exist
+      unless root_subdirs_exist?
+        puts "Missing RComp directories at #{@@conf.root}"
+        puts "Run rcomp init to repair"
+        exit 1
+      end
+    end
+  end
+end

data/lib/rcomp/process.rb

@@ -0,0 +1,44 @@
+require 'childprocess'
+
+module RComp
+  class Process
+
+    include RComp::Actions
+
+    # Initialize a new process
+    #
+    # cmd - An array of shellwords of a command
+    # timeout - Time until the process is automatically killed
+    # out - Path to send stdout of process
+    # err - Path to send stderr of process
+    def initialize(cmd, timeout, out, err)
+      @timeout = timeout
+      @process = ChildProcess.build(*cmd)
+      @process.io.stdout = File.new(out, 'w')
+      @process.io.stderr = File.new(err, 'w')
+    end
+
+    # Runs a process and with a specified command and timeout
+    #
+    # Returns nothing
+    def run
+      begin @process.start
+      rescue ChildProcess::LaunchError => e
+        raise StandardError.new(e.message)
+      end
+
+      begin @process.poll_for_exit(@timeout)
+      rescue ChildProcess::TimeoutError
+        @timedout = true
+        @process.stop
+      end
+    end
+
+    # Check if the proccess timed out or not
+    #
+    # Returns a boolean
+    def timedout?
+      @timedout ||= false
+    end
+  end
+end