All files / src/rules implement_methods.ts

91.12% Statements 267/293
84.14% Branches 69/82
100% Functions 16/16
91.12% Lines 267/293

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 2931x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9391x 9391x 9391x 9391x 9391x 27931x 27931x 27931x 27931x 27931x 27931x 27931x 27931x 9391x 9391x 8898x 8898x 9391x 9391x 216x 216x 9391x 9391x 267x 267x 267x 14x 267x 1x 1x 252x 252x 252x 267x 140x 140x 140x 140x 140x 252x 252x 252x 9391x 9391x 9391x 9391x 142x 151x 151x 136x 136x 151x 6x 6x 9391x 9391x 2x 2x 2x 2x 2x 2x     9391x 9391x 140x 140x 140x 44x 44x 44x 2x 1x 1x 1x 2x 2x 42x 44x 1x 1x 1x 44x 2x 2x 2x 2x 2x 44x 140x 140x 140x 9391x 9391x 4x 4x     4x 4x 4x 4x 4x 4x 4x 4x 4x 4x       9391x 9391x 40x 40x 40x 3x 3x 3x 3x 37x 37x 37x 9391x 9391x 44x 44x 44x 44x 36x 36x 36x 36x 34x 34x 34x 36x 44x 8x 8x 44x 44x 44x 9391x 9391x 9391x 29x 10x 29x 29x 6x 6x 6x 6x 6x 6x 6x 29x 29x 9391x 9391x 2x 2x 2x 2x 2x                         9391x 9391x 140x 140x 140x 34x 34x 34x 2x 34x 3x 3x 29x 34x 16x 1x 1x 15x 16x 2x 2x 2x 2x 2x 2x       2x 16x 29x 137x 137x 137x 9391x 9391x 17x     17x 17x 17x 17x 17x 7x 7x 1x 1x 1x 1x 1x 7x 17x 17x 2x 2x 2x 2x 2x 15x 17x 4x 4x 4x     4x 4x 2x 2x 4x 2x 13x 13x 13x 9391x 9391x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 9391x 9391x
import {Issue} from "../issue";
import {ABAPRule} from "./_abap_rule";
import {BasicRuleConfig} from "./_basic_rule_config";
import {ABAPObject} from "../objects/_abap_object";
import {Class, Interface, Program} from "../objects";
import * as Statements from "../abap/2_statements/statements";
import * as Expressions from "../abap/2_statements/expressions";
import {InfoClassImplementation, InfoClassDefinition, InfoInterfaceDefinition, InfoMethodDefinition} from "../abap/4_file_information/_abap_file_information";
import {IRuleMetadata, RuleTag} from "./_irule";
import {Identifier} from "../abap/4_file_information/_identifier";
import {ABAPFile} from "../abap/abap_file";
import {EditHelper, IEdit} from "../edit_helper";
 
// todo: abstract methods from superclass parents(might be multiple), if class is not abstract
 
export class ImplementMethodsConf extends BasicRuleConfig {
}
 
interface IMethod {
  objectName: string;
  method: InfoMethodDefinition;
}
 
export class ImplementMethods extends ABAPRule {
  private conf = new ImplementMethodsConf();
  private obj: ABAPObject;
 
  public getMetadata(): IRuleMetadata {
    return {
      key: "implement_methods",
      title: "Implement methods",
      shortDescription: `Checks for abstract methods and methods from interfaces which need implementing.`,
      extendedInformation: `INCLUDE programs are only checked in connection with their main programs.`,
      tags: [RuleTag.Syntax, RuleTag.Quickfix],
    };
  }
 
  public getConfig() {
    return this.conf;
  }
 
  public setConfig(conf: ImplementMethodsConf) {
    this.conf = conf;
  }
 
  public runParsed(file: ABAPFile, obj: ABAPObject) {
    let ret: Issue[] = [];
 
    if (file.getStructure() === undefined) {
      return [];
    } else if (obj instanceof Program && obj.isInclude() === true) {
      return [];
    }
 
    this.obj = obj;
 
    for (const classDefinition of file.getInfo().listClassDefinitions()) {
      const classImplementation = this.lookupImplementationInObject(classDefinition.name, obj);
 
      ret = ret.concat(this.checkClass(classDefinition, classImplementation));
      ret = ret.concat(this.checkInterfaces(classDefinition, classImplementation));
    }
 
    return ret;
  }
 
/////////////////////////////////
 
  private lookupImplementationInObject(name: string, obj: ABAPObject) {
    for (const sub of obj.getABAPFiles()) {
      const impl = sub.getInfo().getClassImplementationByName(name);
      if (impl !== undefined) {
        return impl;
      }
    }
    return undefined;
  }
 
  private lookupDefinitionInObject(name: string) {
    for (const sub of this.obj.getABAPFiles()) {
      const def = sub.getInfo().getClassDefinitionByName(name);
      if (def !== undefined) {
        return def;
      }
    }
    return undefined;
  }
 
  private checkClass(def: InfoClassDefinition, impl: InfoClassImplementation | undefined): Issue[] {
    const ret: Issue[] = [];
 
    for (const md of def.methods) {
      const found = impl?.methods.find(m => m.getName().toUpperCase() === md.name.toUpperCase());
 
      if (md.isAbstract === true) {
        if (found !== undefined) {
          const issue = Issue.atIdentifier(found, "Do not implement abstract method \"" + md.name + "\"", this.getMetadata().key, this.conf.severity);
          ret.push(issue);
        }
        continue;
      }
 
      if (impl === undefined) {
        const message = "Class implementation for \"" + def.name + "\" not found";
        const issue = Issue.atIdentifier(def.identifier, message, this.getMetadata().key, this.conf.severity);
        ret.push(issue);
      } else if (found === undefined) {
        const message = "Implement method \"" + md.name + "\"";
        const fix = this.buildFix(impl, md.name);
        const issue = Issue.atIdentifier(impl.identifier, message, this.getMetadata().key, this.conf.severity, fix);
        ret.push(issue);
      }
    }
 
    return ret;
  }
 
  private buildFix(impl: InfoClassImplementation, methodName: string): IEdit | undefined {
    const file = this.obj.getABAPFileByName(impl.identifier.getFilename());
    if (file === undefined) {
      return undefined;
    }
 
    for (const i of file.getStructure()?.findAllStatements(Statements.ClassImplementation) || []) {
      const name = i.findFirstExpression(Expressions.ClassName)?.getFirstToken().getStr().toUpperCase();
      if (name === impl.identifier.getName().toUpperCase()) {
        return EditHelper.insertAt(file, i.getLastToken().getEnd(), `
  METHOD ${methodName.toLowerCase()}.
    RETURN. " todo, implement method
  ENDMETHOD.`);
      }
    }

    return undefined;
  }
 
  private findInterface(identifier: Identifier, name: string): InfoInterfaceDefinition | Issue | undefined {
    const idef = this.findInterfaceByName(name);
 
    if (idef === undefined) {
      const message = "Implemented interface \"" + name + "\" not found";
      const issue = Issue.atIdentifier(identifier, message, this.getMetadata().key, this.conf.severity);
      return issue;
    }
 
    return idef;
  }
 
  private findInterfaceByName(name: string): InfoInterfaceDefinition | undefined {
    let idef: InfoInterfaceDefinition | undefined = undefined;
 
    const intf = this.reg.getObject("INTF", name) as Interface | undefined;
    if (intf === undefined) {
      // lookup in localfiles
      for (const file of this.obj.getABAPFiles()) {
        const found = file.getInfo().getInterfaceDefinitionByName(name);
        if (found) {
          idef = found;
          break;
        }
      }
    } else {
      idef = intf.getMainABAPFile()?.getInfo().listInterfaceDefinitions()[0];
    }
 
    return idef;
  }
 
  /** including implemented super interfaces */
  private findInterfaceMethods(idef: InfoInterfaceDefinition): IMethod[] {
    const methods = idef.methods.map((m) => {
      return {objectName: idef.name, method: m};
    });
    for (const i of idef.interfaces) {
      const sup = this.findInterface(idef.identifier, i.name);
      if (sup !== undefined && !(sup instanceof Issue)) {
        sup.methods.forEach(m => {
          methods.push({objectName: sup.name, method: m});
        });
      }
    }
    return methods;
  }
 
  private findClass(name: string): {def: InfoClassDefinition, impl: InfoClassImplementation} | undefined {
    let def = this.lookupDefinitionInObject(name);
    let impl = this.lookupImplementationInObject(name, this.obj);
    if (def && impl) {
      return {def, impl};
    }

    const global = this.reg.getObject("CLAS", name) as Class | undefined;
    if (global) {
      def = global.getClassDefinition();
      impl = this.lookupImplementationInObject(name, global);
      if (def && impl) {
        return {def, impl};
      }
    }

    return undefined;
  }
 
  private checkInterfaces(def: InfoClassDefinition, impl: InfoClassImplementation | undefined): Issue[] {
    const ret: Issue[] = [];
 
    for (const interfaceInfo of def.interfaces) {
      const idef = this.findInterface(def.identifier, interfaceInfo.name);
 
      if (idef === undefined || interfaceInfo.partial === true || interfaceInfo.allAbstract === true) {
        continue; // ignore parser errors in interface
      } else if (idef instanceof Issue) {
        return [idef];
      }
 
      for (const m of this.findInterfaceMethods(idef)) {
        if (interfaceInfo.abstractMethods.includes(m.method.name.toUpperCase())) {
          continue;
        }
 
        if (this.isImplemented(m, def, impl) === false) {
          const message = "Implement method \"" + m.method.name + "\" from interface \"" + m.objectName + "\"";
          if (impl) {
            const fix = this.buildFix(impl, m.objectName + "~" + m.method.name);
            const issue = Issue.atIdentifier(impl.identifier, message, this.getMetadata().key, this.conf.severity, fix);
            ret.push(issue);
          } else {
            const issue = Issue.atIdentifier(def.identifier, message, this.getMetadata().key, this.conf.severity);
            ret.push(issue);
          }
        }
      }
    }
 
    return ret;
  }
 
  private isImplemented(m: IMethod, def: InfoClassDefinition, impl: InfoClassImplementation | undefined): boolean {
    if (impl === undefined) {
      return false;
    }
 
    const name = m.objectName + "~" + m.method.name;
    let found = impl.methods.find(m => m.getName().toUpperCase() === name.toUpperCase());
 
    if (found === undefined) {
      // try looking for ALIASes
      for (const alias of def.aliases) {
        if (alias.component.toUpperCase() === name.toUpperCase()) {
          found = impl.methods.find(m => m.getName().toUpperCase() === alias.name.toUpperCase());
          break;
        }
      }
    }
 
    if (found === undefined && def.superClassName !== undefined) {
      const clas = this.findClass(def.superClassName);
      if (clas) {
        return this.isImplemented(m, clas?.def, clas?.impl);
      }
    }
 
    if (found === undefined) {
      for (const i of def.interfaces) {
        const idef = this.findInterfaceByName(i.name);
        if (idef === undefined) {
          continue;
        }
        const ali = this.viaAliasInInterface(m, idef, impl);
        if (ali) {
          return ali;
        }
      }
    }
 
    return found !== undefined;
  }
 
  private viaAliasInInterface(m: IMethod, intf: InfoInterfaceDefinition, impl: InfoClassImplementation): boolean {
    for (const a of intf.aliases) {
      if (a.component.toUpperCase() === m.objectName.toUpperCase() + "~" + m.method.name.toUpperCase()) {
        const name = intf.name + "~" + a.name;
        const found = impl.methods.find(m => m.getName().toUpperCase() === name.toUpperCase());
        if (found) {
          return true;
        }
      }
    }
 
    return false;
  }
 
}