cucumber_step_finder.py

# -*- coding: utf-8 -*-
import sublime, sublime_plugin
import os
import re
import codecs

def clean_step(text):
  return ' ' + re.sub("(Given|When|And|Then|But)|[\$\^\(\)\/]", '',text)



class InsertStepCommand(sublime_plugin.TextCommand):


  def run(self, edit, **args):
    for region in self.view.sel():
      if region.empty():
        continue
      else:
        line = self.view.line(region)
        line_contents = clean_step(args['step_text']) + '\n'
        self.view.insert(edit, line.end(), line_contents)




class CucumberBaseCommand(sublime_plugin.WindowCommand, object):
  def __init__(self, window):
    sublime_plugin.WindowCommand.__init__(self, window)

  def settings_get(self, name):
    # Get the plugin settings, default and user-defined.
    plugin_settings = sublime.load_settings('CucumberStepFinder.sublime-settings')
    # If this is a project, try to grab project-specific settings.
    if sublime.active_window() and sublime.active_window().active_view():
      project_settings = sublime.active_window().active_view().settings().get("CucumberStepFinder")
    else:
      project_settings = None
    # Grab the setting, by name, from the project settings if it exists.
    # Otherwise, default back to the plugin settings.
    return (project_settings or {}).get(name, plugin_settings.get(name))

  def find_all_steps(self):
    features_path = self.settings_get('cucumber_features_path')
    step_pattern = self.settings_get('cucumber_step_pattern')
    pattern = re.compile(r'((.*)(\/\^.*))\$\/')
    self.steps = []
    folders = self.window.folders()
    for folder in folders:
      if ( not os.path.exists(folder) ) : continue
      for path in os.listdir(folder) + ['.']:
        full_path = os.path.join(folder, path)
        if path == features_path:
          self.step_files = []
          for root, dirs, files in os.walk(full_path, followlinks=True):
            for f_name in files:
              if re.match(step_pattern, f_name):
                self.step_files.append((f_name, os.path.join(root, f_name)))
                step_file_path = os.path.join(root, f_name)
                with codecs.open(step_file_path, encoding='utf-8') as f:
                  index = 0
                  for line in f:
                    match = re.match(pattern, line)
                    if match:
                      self.steps.append((match.group(), index, step_file_path))
                    index += 1

  def determine_other_pane(self):
    active_group = self.window.active_group()
    num_groups = self.window.num_groups()
    layout = self.window.get_layout()
    cells = layout['cells']
    cols = layout['cols']
    if num_groups == 1:
      # Only pane. Create a new one.
      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]]
        })
      return 1
    elif active_group == num_groups - 1:
      # Last pane in window. Use the previous one.
      return active_group - 1
    elif len(cols) > 2 and cells[active_group][2] == len(cols) - 1:
      # Last pane in row. Use the previous one.
      return active_group - 1
    else:
      # Otherwise, use the next one.
      return active_group + 1

  def step_found(self, index):
    if index >= 0:
      # import pdb, sys; pdb.Pdb(stdout=sys.__stdout__).set_trace()
      file_path = self.steps[index][2]
      self.window.active_view().run_command("insert_step",{"step_text": self.steps[index][0]})

      open_in_different_pane = self.settings_get('open_in_different_pane')
      if open_in_different_pane:
        other_pane = self.determine_other_pane()
        self.window.focus_group(other_pane)
      match_view = self.window.open_file(file_path)
      self.active_ref = (match_view, self.steps[index][1])
      self.mark_step()

  def mark_step(self):
    view = self.window.active_view()
    if view.is_loading():
      sublime.set_timeout(self.mark_step, 50)
    else:
      view.run_command("goto_line", {"line": self.active_ref[1]+1} )

class MatchStepCommand(CucumberBaseCommand):
  def __init__(self, window):
    CucumberBaseCommand.__init__(self, window)

  def run(self, file_name=None):
    self.get_line()

  def get_line(self):
    view = self.window.active_view()
    line_sel = view.line(view.sel()[0])
    text_line = view.substr(line_sel).strip()
    self.cut_words(text_line)

  def cut_words(self, text):
     words = self.settings_get('cucumber_code_keywords')
     upcased = [up.capitalize() for up in words]
     expression = "^{0}".format('|^'.join(upcased))

     pattern = re.compile(expression)
     short_text = re.sub(pattern, '', text).strip()
     self.find_all_steps()

     step_filter = re.compile(r'.*\/\^(.*)\$\/') # map all steps
     steps_regex = [re.match(step_filter, x[0]).group(1) for x in self.steps]

     for step in self.steps:
       step_pattern = re.match(step_filter, step[0]).group(1)
       step_regex = re.compile(step_pattern)
       match =  re.match(step_regex, short_text)
       if match:
         index =  self.steps.index(step)
         self.step_found(index)
       else:
        sublime.status_message('Can\'t find a match')

class CucumberStepFinderCommand(CucumberBaseCommand):
  def __init__(self, window):
    CucumberBaseCommand.__init__(self, window)

  def run(self, file_name=None):
    self.list_steps()

  def list_steps(self):
    self.find_all_steps()
    steps_only = [x[0] for x in self.steps]
    self.window.show_quick_panel(steps_only, self.step_found)