#!/usr/bin/env python
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
# 
# The contents of this file are subject to the Mozilla Public License
# Version 1.1 (the "License"); you may not use this file except in
# compliance with the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
# 
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
# License for the specific language governing rights and limitations
# under the License.
# 
# The Original Code is Komodo code.
# 
# The Initial Developer of the Original Code is ActiveState Software Inc.
# Portions created by ActiveState Software Inc are Copyright (C) 2000-2007
# ActiveState Software Inc. All Rights Reserved.
# 
# Contributor(s):
#   ActiveState Software Inc
# 
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
# 
# ***** END LICENSE BLOCK *****

"""Common routines for ruby and ruby/rhtml support for CodeIntel"""

import os.path
import logging

log = logging.getLogger("codeintel.ruby.common")
#log.setLevel(logging.DEBUG)
class RubyCommonBufferMixin:
    def check_for_rails_app_path(self, path):
        self.framework_role = None
        if path is None:
            #log.debug("check_for_rails_app_path: no path given")
            return
        apath = os.path.abspath(path)
        aplist = apath.split(os.path.sep)
        role_root = "rails"
        if len(aplist) < 3:
            return
        elif (aplist[-3] == "app" and
            (aplist[-2] == "controllers" and aplist[-1].endswith(".rb")
             or aplist[-2] == "helpers" and aplist[-1].endswith("_helper.rb")
             or aplist[-2] == "models" and aplist[-1].endswith(".rb"))):
            role = '.'.join((role_root, aplist[-2]))
        elif (len(aplist) >= 4
              and aplist[-4] == "app" and aplist[-3] == "views"
              and aplist[-1].endswith((".html.erb", ".rhtml"))):
            role = '.'.join((role_root, aplist[-3], aplist[-2]))
        elif (aplist[-3] == "db" and aplist[-2] == "migrate"
              and aplist[-1][0].isdigit()
              and aplist[-1].endswith(".rb")):
            role = '.'.join((role_root, aplist[-3], aplist[-2]))        
        elif (aplist[-3] == "test"
              and aplist[-2] in ("functional", "unit")
              # integration tests not supported until we can find
              # ActionController::IntegrationTest
              and aplist[-1].endswith("_test.rb")):
            role = '.'.join((role_root, aplist[-3], aplist[-2]))        
        else:
            return
        self.framework_role = role