run_ruby_test.py

import os
import re
import functools
import sublime
import string
import sublime_plugin

#This does not work:
#from package_control import sys_path
#sys_path.add_dependency(u'Terminal')

#for 'run_in terminal' package 'Terminal' is needed
import sys
sys.path.append(sublime.packages_path()+u'/Terminal')
import Terminal #Sublime plugin

class ShowInPanel:
  def __init__(self, window):
    self.window = window

  def display_results(self):
    self.panel = self.window.get_output_panel("exec")
    self.window.run_command("show_panel", {"panel": "output.exec"})
    self.panel.settings().set("color_scheme", THEME)
    self.panel.set_syntax_file(SYNTAX)
    if HIDE_PANEL:
      self.window.run_command("hide_panel")
    self.panel.settings().set("color_scheme", THEME)


class ShowInScratch:
  def __init__(self, window):
    self.window = window
    self.active_for = 0
    self.copied_until = 0

  def display_results(self):
    self.panel = self.window.get_output_panel("exec")
    self.window.run_command("hide_panel")
    self.view = self.window.open_file("Test Results")
    self.view.set_scratch(True)
    self.view.set_read_only(False)

    self.view.set_syntax_file(SYNTAX)
    self.view.settings().set("color_scheme", THEME)
    self.view.set_read_only(True)
    self.poll_copy()
    self.append('\n\n')

  def poll_copy(self):
    # FIXME HACK: Stop polling after one minute
    if self.active_for < 60000:
      self.active_for += 50
      sublime.set_timeout(self.copy_stuff, 50)

  def append(self, content):
    self.view.set_read_only(False)
    edit = self.view.begin_edit()
    self.view.insert(edit, self.view.size(), content)
    self.view.end_edit(edit)
    self.view.set_read_only(True)
    self.view.set_viewport_position((self.view.size(), self.view.size()), True)

  def copy_stuff(self):
    size = self.panel.size()
    content = self.panel.substr(sublime.Region(self.copied_until, size))
    if content:
      self.copied_until = size
      self.append(content)
    self.poll_copy()

class ShowPanels:
  def __init__(self, window):
    self.window = window

  def split(self):
    self.window.run_command('set_layout', {
                          "cols": [0.0, 0.5, 1.0],
                          "rows": [0.0, 1.0],
                          "cells": [[0, 0, 1, 1], [1, 0, 2, 1]]
                      })
    self.window.focus_group(1)

class TestMethodMatcher(object):
  def __init__(self):
    self.matchers = [TestMethodMatcher.UnitTest, TestMethodMatcher.ShouldaTest]
  def find_first_match_in(self, test_file_content):
    for matcher in self.matchers:
      test_name = matcher.find_first_match(test_file_content)
      if test_name:
        return test_name

  class UnitTest(object):
    @staticmethod
    def find_first_match(test_file_content):
      match_obj = re.search('\s?([a-zA-Z_\d]+tset)\s+fed', test_file_content) # 1st search for 'def test_name'
      if match_obj:
        return match_obj.group(1)[::-1]

      match_obj = re.search('\s?[\"\']([a-zA-Z_\"\'\s\d\-\.#=?!:\/]+)[\"\']\s+tset', test_file_content) # 2nd search for 'test "name"'
      if match_obj:
        test_name = match_obj.group(1)[::-1]
        return "test_%s" % test_name.replace("\"", "\\\"").replace(" ", "_").replace("'", "\\'")

      return None

  class ShouldaTest(object):
    @staticmethod
    def find_first_match(test_file_content):
      match_obj = re.search('\s?(([\"][^\"]*[\"]|[\'][^\']*[\'])\s+dluohs)', test_file_content) # search for 'should "name"'
      if not match_obj:
        return None
      test_name = match_obj.group(1)[::-1]
      return "%s%s%s" % ("/", test_name.replace("should", "").replace("\"", "").replace("'", "").strip(), "/")


class RubyTestSettings:
  def __init__(self):
    self.settings = sublime.load_settings("RubyTest.sublime-settings")

  def __getattr__(self, name):
    if not self.settings.has(name):
      raise AttributeError(name)
    value = sublime.active_window().active_view().settings().get(name)
    if value:
      return lambda **kwargs: value.format(**kwargs)
    return lambda **kwargs: self.settings.get(name).format(**kwargs)


class BaseRubyTask(sublime_plugin.TextCommand):
  def load_config(self):
    s = sublime.load_settings("RubyTest.sublime-settings")
    global RUBY_UNIT_FOLDER; RUBY_UNIT_FOLDER = s.get("ruby_unit_folder")
    global CUCUMBER_UNIT_FOLDER; CUCUMBER_UNIT_FOLDER = s.get("ruby_cucumber_folder")
    global RSPEC_UNIT_FOLDER; RSPEC_UNIT_FOLDER = s.get("ruby_rspec_folder")
    global USE_SCRATCH; USE_SCRATCH = s.get("ruby_use_scratch")
    global USE_TERMINAL; USE_TERMINAL = s.get("ruby_use_terminal")
    global IGNORED_DIRECTORIES; IGNORED_DIRECTORIES = s.get("ignored_directories")
    global HIDE_PANEL; HIDE_PANEL = s.get("hide_panel")
    global BEFORE_CALLBACK; BEFORE_CALLBACK = s.get("before_callback")
    global AFTER_CALLBACK; AFTER_CALLBACK = s.get("after_callback")
    global COMMAND_PREFIX; COMMAND_PREFIX = False
    global SAVE_ON_RUN; SAVE_ON_RUN = s.get("save_on_run")
    global SYNTAX; SYNTAX = s.get('syntax')
    global THEME; THEME = s.get('theme')
    global TERMINAL_ENCODING; TERMINAL_ENCODING = s.get('terminal_encoding')


    rbenv   = s.get("check_for_rbenv")
    rvm     = s.get("check_for_rvm")
    bundler = s.get("check_for_bundler")
    spring  = s.get("check_for_spring")
    if rbenv or rvm: self.rbenv_or_rvm(s, rbenv, rvm)
    if spring: self.spring_support()
    if bundler: self.bundler_support()

  def spring_support(self):
    global COMMAND_PREFIX
    COMMAND_PREFIX = COMMAND_PREFIX + " spring "

  def rbenv_or_rvm(self, s, rbenv, rvm):
    which = os.popen('which rbenv').read().split('\n')[0]
    brew = '/usr/local/bin/rbenv'
    rbenv_cmd = os.path.expanduser('~/.rbenv/bin/rbenv')
    rvm_cmd = os.path.expanduser('~/.rvm/bin/rvm-auto-ruby')

    if os.path.isfile(brew): rbenv_cmd = brew
    elif os.path.isfile(which): rbenv_cmd = which

    global COMMAND_PREFIX
    if rbenv and self.is_executable(rbenv_cmd):
      COMMAND_PREFIX = rbenv_cmd + ' exec'
    elif rvm and self.is_executable(rvm_cmd):
      COMMAND_PREFIX = rvm_cmd + ' -S'

  def bundler_support(self):
    project_root = self.file_type(None, False).find_project_root()
    if not os.path.isdir(project_root):
      s = sublime.load_settings("RubyTest.last-run")
      project_root = s.get("last_test_working_dir")

    gemfile_path = project_root + '/Gemfile'

    global COMMAND_PREFIX
    if not COMMAND_PREFIX:
      COMMAND_PREFIX = ""

    if os.path.isfile(gemfile_path):
      COMMAND_PREFIX =  COMMAND_PREFIX + " bundle exec "

  def save_all(self):
    if SAVE_ON_RUN:
      self.window().run_command("save_all")

  def is_executable(self, path):
    return os.path.isfile(path) and os.access(path, os.X_OK)

  def save_test_run(self, command, working_dir):
    s = sublime.load_settings("RubyTest.last-run")
    s.set("last_test_run", command)
    s.set("last_test_working_dir", working_dir)

    sublime.save_settings("RubyTest.last-run")

  def run_shell_command(self, command, working_dir):
    if not command:
      return False
    if BEFORE_CALLBACK:
      os.system(BEFORE_CALLBACK)
    if AFTER_CALLBACK:
      command += " ; " + AFTER_CALLBACK
    self.save_test_run(command, working_dir)
    if COMMAND_PREFIX:
      command = COMMAND_PREFIX + ' ' + command
    if int(sublime.version().split('.')[0]) <= 2:
      command = [command]
    if USE_TERMINAL:
      trm=OpenInTerminal()
      trm.run(working_dir, command)
    else:  
      self.view.window().run_command("exec", {
        "cmd": command,
        "shell": True,
        "working_dir": working_dir,
        "file_regex": r"([^ ]*\.rb):?(\d*)",
        "encoding": TERMINAL_ENCODING
      })
      self.display_results()
    return True


  def display_results(self):
    if USE_SCRATCH:
      display = ShowInScratch(self.window())
    else:  
      display = ShowInPanel(self.window())
    
    display.display_results()

  def window(self):
    return self.view.window()

  class BaseFile(object):
    def __init__(self, file_name, partition_folder=""):
      self.folder_name, self.file_name = os.path.split(file_name)
      self.partition_folder = partition_folder
      self.absolute_path = file_name
    def parent_dir_name(self):
      head_dir, tail_dir = os.path.split(self.folder_name)
      return tail_dir
    def verify_syntax_command(self): return None
    def possible_alternate_files(self): return []
    def run_all_tests_command(self): return None
    def get_project_root(self): return self.folder_name
    def find_project_root(self):
      to_find = os.sep + self.partition_folder + os.sep
      project_root, _, _ = self.absolute_path.partition(to_find)
      return project_root
    def relative_file_path(self):
      to_find = os.sep + self.partition_folder + os.sep
      _, _, relative_path = self.absolute_path.partition(to_find)
      return self.partition_folder + os.sep + relative_path
    def get_current_line_number(self, view):
      char_under_cursor = view.sel()[0].a
      return view.rowcol(char_under_cursor)[0] + 1
    def features(self): return []

  class AnonymousFile(BaseFile):
    def __init__(self):
      True

  class RubyFile(BaseFile):
    def verify_syntax_command(self): return RubyTestSettings().ruby_verify_command(file_name=self.file_name)
    def possible_alternate_files(self): return [self.file_name.replace(".rb", "_spec.rb"), self.file_name.replace(".rb", "_test.rb"), "test_" + self.file_name, self.file_name.replace(".rb", ".feature")]
    def features(self): return ["verify_syntax", "switch_to_test", "rails_generate", "extract_variable"]

  class UnitFile(RubyFile):
    def possible_alternate_files(self): return [self.file_name.replace("_test.rb", ".rb").replace("test_", "")]
    def run_all_tests_command(self): return RubyTestSettings().run_ruby_unit_command(relative_path=self.relative_file_path())
    def run_single_test_command(self, view):
      region = view.sel()[0]
      line_region = view.line(region)
      text_string = view.substr(sublime.Region(region.begin() - 2000, line_region.end()))
      text_string = text_string.replace("\n", "\\N")
      text_string = text_string[::-1]
      test_name = TestMethodMatcher().find_first_match_in(text_string)
      if test_name is None:
        sublime.error_message("No test name!")
        return None
      return RubyTestSettings().run_single_ruby_unit_command(relative_path=self.relative_file_path(), test_name=test_name, line_number=self.get_current_line_number(view))
    def features(self): return super(BaseRubyTask.UnitFile, self).features() + ["run_test"]
    def get_project_root(self): return self.find_project_root()

  class CucumberFile(BaseFile):
    def possible_alternate_files(self): return list( set( [self.file_name.replace(".feature", ".rb"), self.file_name.replace(".feature", "_steps.rb")] ) )
    def run_all_tests_command(self): return RubyTestSettings().run_cucumber_command(relative_path=self.relative_file_path())
    def run_single_test_command(self, view): return RubyTestSettings().run_single_cucumber_command(relative_path=self.relative_file_path(), line_number=self.get_current_line_number(view))
    def features(self): return ["switch_to_test", "run_test"]
    def get_project_root(self): return self.find_project_root()

  class RSpecFile(RubyFile):
    def possible_alternate_files(self): return list( set( [self.file_name.replace("_spec.rb", ".rb"), self.file_name.replace(".haml_spec.rb", ".haml"), self.file_name.replace(".erb_spec.rb", ".erb")] ) - set([self.file_name]) )
    def run_all_tests_command(self): return RubyTestSettings().run_rspec_command(relative_path=self.relative_file_path())
    def run_single_test_command(self, view): return RubyTestSettings().run_single_rspec_command(relative_path=self.relative_file_path(), line_number=self.get_current_line_number(view))
    def features(self): return super(BaseRubyTask.RSpecFile, self).features() + ["run_test"]
    def get_project_root(self): return self.find_project_root()

  class ErbFile(BaseFile):
    def verify_syntax_command(self): return RubyTestSettings().erb_verify_command(file_name=self.file_name)
    def can_verify_syntax(self): return True
    def possible_alternate_files(self): return [self.file_name.replace(".erb", ".erb_spec.rb")]
    def features(self): return ["verify_syntax", "switch_to_test"]

  class HamlFile(BaseFile):
    def possible_alternate_files(self): return [self.file_name.replace(".haml", ".haml_spec.rb")]
    def features(self): return ["switch_to_test"]

  class CucumberStepsFile(BaseFile):
    def possible_alternate_files(self): return [self.file_name.replace("_steps.rb", ".feature")]
    def features(self): return ["switch_to_test"]

  def find_partition_folder(self, file_name, default_partition_folder):
    folders = self.view.window().folders()
    file_name = file_name.replace("\\","\\\\")
    for folder in folders:
      folder = folder.replace("\\","\\\\")
      if re.search(folder, file_name):
        return re.sub(os.sep + '.+', "", file_name.replace(folder,"")[1:])
    return default_partition_folder

  def file_type(self, file_name = None, load_config = True):
    if load_config:
      self.load_config()
    file_name = file_name or self.view.file_name()
    if not file_name: return BaseRubyTask.AnonymousFile()
    if re.search('\w+\_test.rb', file_name):
      partition_folder = self.find_partition_folder(file_name, RUBY_UNIT_FOLDER)
      return BaseRubyTask.UnitFile(file_name, partition_folder)
    elif re.search('test\_\w+\.rb', file_name):
      partition_folder = self.find_partition_folder(file_name, RUBY_UNIT_FOLDER)
      return BaseRubyTask.UnitFile(file_name, partition_folder)
    elif re.search('\w+\_spec.rb', file_name):
      partition_folder = self.find_partition_folder(file_name, RSPEC_UNIT_FOLDER)
      return BaseRubyTask.RSpecFile(file_name, partition_folder)
    elif re.search('\w+\.feature', file_name):
      partition_folder = self.find_partition_folder(file_name, CUCUMBER_UNIT_FOLDER)
      return BaseRubyTask.CucumberFile(file_name, partition_folder)
    elif re.search('\w+\_steps.rb', file_name):
      return BaseRubyTask.CucumberStepsFile(file_name)
    elif re.search('\w+\.rb', file_name):
      return BaseRubyTask.RubyFile(file_name)
    elif re.search('\w+\.erb', file_name):
      return BaseRubyTask.ErbFile(file_name)
    elif re.search('\w+\.haml', file_name):
      return BaseRubyTask.HamlFile(file_name)
    else:
      return BaseRubyTask.BaseFile(file_name)


class RunSingleRubyTest(BaseRubyTask):
  def is_enabled(self): return 'run_test' in self.file_type().features()
  def run(self, args):
    self.load_config()
    self.save_all()
    file = self.file_type()
    command = file.run_single_test_command(self.view)
    self.run_shell_command(command, file.get_project_root())


class RunAllRubyTest(BaseRubyTask):
  def is_enabled(self): return 'run_test' in self.file_type().features()
  def run(self, args):
    self.load_config()
    self.save_all()
    file = self.file_type(self.view.file_name())
    command = file.run_all_tests_command()
    if self.run_shell_command(command, file.get_project_root()):
      pass
    else:
      sublime.error_message("Only *_test.rb, test_*.rb, *_spec.rb, *.feature files supported!")


class RunLastRubyTest(BaseRubyTask):
  def load_last_run(self):
    self.load_config()
    self.save_all()
    s = sublime.load_settings("RubyTest.last-run")
    return (s.get("last_test_run"), s.get("last_test_working_dir"))

  def run(self, args):
    last_command, working_dir = self.load_last_run()
    self.run_shell_command(last_command, working_dir)

class VerifyRubyFile(BaseRubyTask):
  def is_enabled(self): return 'verify_syntax' in self.file_type().features()
  def run(self, args):
    self.load_config()
    file = self.file_type()
    command = file.verify_syntax_command()
    if self.run_shell_command(command, file.get_project_root()):
      pass
    else:
      sublime.error_message("Only .rb or .erb files supported!")

class SwitchBetweenCodeAndTest(BaseRubyTask):
  def is_enabled(self): return 'switch_to_test' in self.file_type().features()
  def run(self, args, split_view):
    self.load_config()
    possible_alternates = self.file_type().possible_alternate_files()
    alternates = self.project_files(lambda file: file in possible_alternates)

    for alternate in alternates:
      if re.search(self.file_type().parent_dir_name(), alternate):
        alternates = [alternate]
        break

    if alternates:
      if split_view:
        ShowPanels(self.window()).split()
      if len(alternates) == 1:
        self.window().open_file(alternates.pop())
      else:
        callback = functools.partial(self.on_selected, alternates)
        self.window().show_quick_panel(alternates, callback)
    else:
      GenerateTestFile(self.window(), split_view).doIt()

  def on_selected(self, alternates, index):
    if index == -1:
      return

    self.window().open_file(alternates[index])

  def walk(self, directory):
    for dir, dirnames, files in os.walk(directory):
      dirnames[:] = [dirname for dirname in dirnames if dirname not in IGNORED_DIRECTORIES]
      yield dir, dirnames, files

  def project_files(self, file_matcher):
    directories = self.window().folders()
    return [os.path.join(dirname, file) for directory in directories for dirname, _, files in self.walk(directory) for file in filter(file_matcher, files)]


class RubyRailsGenerate(BaseRubyTask):
  def is_enabled(self): return 'rails_generate' in self.file_type().features()

  def run(self, args, type = "migration"):
    self.window().show_input_panel("rails generate", type + " ", lambda s: self.generate(s), None, None)

  def generate(self, argument):
    command = 'rails generate {thing}'.format(thing=argument)
    self.run_shell_command(command, self.window().folders()[0])

class ShowTestPanel(BaseRubyTask):
  def run(self, args):
    self.window().run_command("show_panel", {"panel": "output.exec"})

class RubyExtractVariable(BaseRubyTask):
  def is_enabled(self): return 'extract_variable' in self.file_type().features()
  def run(self, args):
    for selection in self.view.sel():
      self.window().show_input_panel("Variable Name: ", '', lambda name: self.generate(selection, name), None, None)

  def generate(self, selection, name):
    extracted = self.view.substr(selection)
    line = self.view.line(selection)
    white_space = re.match("\s*", self.view.substr(line)).group()
    edit = self.view.begin_edit()
    try:
      self.view.replace(edit, selection, name)
      self.view.insert(edit, line.begin(), white_space + name + " = " + extracted + "\n")
    finally:
      self.view.end_edit(edit)

class GenerateTestFile:
  relative_paths = []
  full_torelative_paths = {}
  rel_path_start = 0

  def __init__(self, window, split_view):
    self.window = window
    self.split_view = split_view

  def doIt(self):
    self.build_relative_paths()
    self.window.show_quick_panel(self.relative_paths, self.dir_selected)

  def build_relative_paths(self):
      folders = self.active_project(self.window.folders())
      view = self.window.active_view()
      self.relative_paths = []
      self.full_torelative_paths = {}
      for path in folders:
          rootfolders = os.path.split(path)[-1]
          self.rel_path_start = len(os.path.split(path)[0]) + 1
          if self.is_valid_path(path):
            self.full_torelative_paths[rootfolders] = path
            self.relative_paths.append(rootfolders)

          for base, dirs, files in os.walk(path):
              for dir in dirs:
                  relative_path = os.path.join(base, dir)[self.rel_path_start:]
                  if self.is_valid_path(relative_path):
                    self.full_torelative_paths[relative_path] = os.path.join(base, dir)
                    self.relative_paths.append(relative_path)

  def active_project(self, folders):
    for folder in folders:
      project_name = os.path.split(folder)[-1]
      if re.search(project_name, self.current_file()):
        return [folder]
    return folders

  def is_valid_path(self, path):
    if re.search(self.test_path_re(), self.current_file()):
      return re.search('app(\/|\\\)|(lib|extras)$', path) and not re.search('assets|views|vendor', path)
    else:
      return re.search(self.test_path_re(), path)

  def test_path_re(self):
    return RUBY_UNIT_FOLDER + '|' + RSPEC_UNIT_FOLDER + '|' + CUCUMBER_UNIT_FOLDER

  def current_file(self):
    return self.window.active_view().file_name()

  def dir_selected(self, selected_index):
      if selected_index != -1:
          self.selected_dir = self.relative_paths[selected_index]
          self.selected_dir = self.full_torelative_paths[self.selected_dir]
          self.window.show_input_panel("File name", self.suggest_file_name(self.selected_dir), self.file_name_input, None, None)

  def suggest_file_name(self, path):
    current_file = os.path.split(self.current_file())[-1]
    return self.set_file_name(path, current_file)

  def set_file_name(self, path, current_file):
    if re.search(self.test_path_re(), self.current_file()):
      return re.sub('_test.rb|_spec.rb|.feature', '.rb', current_file)
    else:
      return current_file.replace('.rb', self.detect_test_type(path))

  def detect_test_type(self, path):
    if re.search(RUBY_UNIT_FOLDER, path):
      return '_test.rb'
    if re.search(RSPEC_UNIT_FOLDER, path):
      return '_spec.rb'
    if re.search(CUCUMBER_UNIT_FOLDER, path):
      return '.feature'

  def file_name_input(self, file_name):
      full_path = os.path.join(self.selected_dir, file_name)

      if os.path.lexists(full_path):
          sublime.error_message('File already exists:\n%s' % full_path)
          return
      else:
          self.create_and_open_file(full_path)

  def create_and_open_file(self, path):
      if not os.path.exists(path):
          self.create(path)

      if self.split_view:
        ShowPanels(self.window).split()

      self.window.open_file(path)

  def create(self, filename):
      base, filename = os.path.split(filename)
      self.create_folder(base)

  def create_folder(self, base):
      if not os.path.exists(base):
          parent = os.path.split(base)[0]
          if not os.path.exists(parent):
              self.create_folder(parent)
          os.mkdir(base)

class GenerateFile(sublime_plugin.WindowCommand):
  def run(self):
    GenerateNewFile(self.window).doIt()

class GenerateNewFile(GenerateTestFile):
  def __init__(self, window):
    self.window = window
    self.split_view = False

  def active_project(self, folders):
    return folders

  def is_valid_path(self, path):
    return not re.search('\.\w+', path)

  def suggest_file_name(self, path):
    return ""

class OpenInTerminal(Terminal.TerminalCommand):
  def get_terminal_args(self, t_app, working_dir, command):
    if 'PS.bat' in t_app: 
      args=[]
    elif '\\System32\\cmd.exe'  in t_app:
      args=[]
    elif 'Terminal.sh'  in t_app:
      args=[]
    elif 'gnome-terminal'  in t_app:
      #for gnome-terminal there i no '-hold' option, you have to set it in it's profile 
      args= ["--title=\"Sublime Test Run\"","--working-directory="+working_dir, "--execute", "bash", "-c"]
      args.extend([command])
    elif  'xfce4-terminal'  in t_app:
      args= ["--title=\"Sublime Test Run\"","--working-directory="+working_dir, "--hold", "--execute", "bash", "-c"]
      args.extend([command])
    elif  'konsole'  in t_app:
      args= ["-T=\"Sublime Test Run\"","--workdir="+working_dir, "--hold", "-e", "bash", "-c"]
      args.extend([command])
    elif 'lxterminal'  in t_app:
      # I do not known how to left lxterminal window open after end of tests
      args= ["--title=\"Sublime Test Run\"","--working-directory="+working_dir,  "-e" ]
      args.extend([command])

    elif  'mate-terminal'  in t_app:
      args=[]
    elif  'xterm'  in t_app:
      args= ["-title","\"Sublime Test Run\"", "-hold", "-e", "bash", "-c"]
      command_with_cd="cd "+working_dir+" && "+command
      args.extend([command_with_cd])
    else:
      args=[]  
      args.extend([command])

    return args

  def run(self, working_dir, command_to_execute):
    parameters = Terminal.get_setting('parameters', [])
    t_app=Terminal.TerminalSelector.get()
    parameters.extend(self.get_terminal_args(t_app, working_dir,command_to_execute))
    self.run_terminal(working_dir, parameters)