mbien commented on code in PR #5567: URL: https://github.com/apache/netbeans/pull/5567#discussion_r1125873879
########## rust/rust.cargo/src/org/netbeans/modules/rust/cargo/api/SemVer.java: ########## @@ -0,0 +1,110 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.rust.cargo.api; + +import java.util.Objects; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * SemVer + * + * @see <a href="https://semver.org/";>https://semver.org</a> + */ +public final class SemVer implements Comparable<SemVer> { + + public static final Pattern PATTERN = Pattern.compile("^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"); + + private final String semver; + private final Long major; + private final Long minor; + private final Long patch; Review Comment: could those be primitive longs? ########## rust/rust.cargo/src/org/netbeans/modules/rust/cargo/impl/CargoTOMLParser.java: ########## @@ -0,0 +1,189 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.rust.cargo.impl; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStreamReader; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.TreeMap; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.stream.Collectors; +import org.netbeans.modules.rust.cargo.api.CargoTOML; +import org.netbeans.modules.rust.cargo.api.RustPackage; +import org.openide.filesystems.FileObject; +import org.openide.filesystems.FileUtil; +import org.tomlj.Toml; +import org.tomlj.TomlArray; +import org.tomlj.TomlParseError; +import org.tomlj.TomlParseResult; +import org.tomlj.TomlTable; + +/** + * + */ +public class CargoTOMLParser { + + private static final Logger LOG = Logger.getLogger(CargoTOMLParser.class.getName()); + + /** + * Parses a Cargo.toml file. + * + * @param cargoTomlFile The "Cargo.toml" file to parse. + * @param cargotoml The CargoTOML resulting object. + * @throws IOException in case of error. + */ + public static void parseCargoToml(FileObject cargoTomlFile, CargoTOML cargotoml) throws Throwable { + File file = FileUtil.toFile(cargoTomlFile); + if (!file.exists() || !file.isFile() || !file.canRead()) { + throw new IOException(String.format("Cannot read file '%s'", file.getAbsolutePath())); // NOI18N + } + long start = System.currentTimeMillis(); + // As per the specification, .toml files are always UTF-8 + try (final BufferedReader fileContent = new BufferedReader(new InputStreamReader(new FileInputStream(file), StandardCharsets.UTF_8))) { + TomlParseResult parseResult = Toml.parse(fileContent); + List<TomlParseError> errors = parseResult.errors().stream().collect(Collectors.toList()); + if (!errors.isEmpty()) { + final String fileName = file.getAbsolutePath(); + errors.forEach(e -> { + LOG.warning(String.format("Error parsing '%s': '%s'", fileName, e.getMessage())); // NOI18N + }); + throw new IOException(String.format("Errors parsing '%s'. See log for details", fileName)); // NOI18N + } + String packageName = parseResult.getString("package.name"); // NOI18N + String version = parseResult.getString("package.version"); // NOI18N + String edition = parseResult.getString("package.edition"); // NOI18N + edition = edition == null ? "2015" : edition; + String rustVersion = parseResult.getString("package.rust-version"); // NOI18N + String description = parseResult.getString("package.description"); // NOI18N + String documentation = parseResult.getString("package.documentation"); // NOI18N + String homepage = parseResult.getString("package.homepage"); + // TODO: Read more stuff... + // TODO: Fire property change only if required. + + cargotoml.setPackageName(packageName); + cargotoml.setVersion(version); + cargotoml.setEdition(edition); + cargotoml.setDocumentation(documentation); + cargotoml.setHomePage(homepage); + cargotoml.setDescription(description); + cargotoml.setRustVersion(rustVersion); + + // dependencies + { + List<RustPackage> dependencies = getDependencies(cargotoml, parseResult, "dependencies"); // NOI18N + cargotoml.setDependencies(dependencies); + } + + // dev-dependencies + { + List<RustPackage> devDependencies = getDependencies(cargotoml, parseResult, "dev-dependencies"); // NOI18N + cargotoml.setDevDependencies(devDependencies); + } + + // build-dependencies + { + List<RustPackage> buildDependencies = getDependencies(cargotoml, parseResult, "build-dependencies"); // NOI18N + cargotoml.setBuildDependencies(buildDependencies); + } + + // Workspaces https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html + TomlArray members = parseResult.getArray("workspace.members"); + if (members != null) { + TreeMap<String, CargoTOML> workspacesByName = new TreeMap<>(); + FileObject root = cargotoml.getFileObject().getParent(); + for (int i = 0; i < members.size(); i++) { + String memberName = members.getString(i); + FileObject memberCargoFO = root.getFileObject(memberName); + if (memberCargoFO != null) { + memberCargoFO = memberCargoFO.getFileObject("Cargo.toml"); // NOI18N + } + if (memberCargoFO != null) { + CargoTOML memberCargo = new CargoTOML(memberCargoFO); + workspacesByName.put(memberName, memberCargo); + } + } + cargotoml.setWorkspace(workspacesByName); + LOG.log(Level.FINE, String.format("Workspace: %s", cargotoml.getWorkspace().toString())); + } + + } + long end = System.currentTimeMillis(); + LOG.info(String.format("Parsing '%s' took %5.2g ms.", file.getAbsolutePath(), (end - start) / 1000.0)); //NOI18N + } + + private static final List<RustPackage> getDependencies(CargoTOML cargotoml, TomlParseResult parseResult, String propertyKey) { + TomlTable dependencies = parseResult.getTable(propertyKey); + if (dependencies == null || dependencies.isEmpty()) { + return Collections.<RustPackage>emptyList(); + } + ArrayList<RustPackage> packages = new ArrayList<>(dependencies.size()); + for (Map.Entry<String, Object> declaredDependency : dependencies.entrySet()) { + String key = declaredDependency.getKey(); + Object value = declaredDependency.getValue(); + if (value instanceof String) { + String stringValue = (String) value; + packages.add(RustPackage.withNameAndVersion(cargotoml, key, stringValue)); + } else if (value instanceof TomlTable) { + String dependencyName = key.replaceAll("^dependencies\\.", ""); // NOI18N + TomlTable dependencyInfo = (TomlTable) value; + String version = dependencyInfo.getString("version"); // NOI18N + String git = dependencyInfo.getString("git"); // NOI18N + if (version != null) { + // Examples: + // [dependencies] + // some-crate = { version = "1.0", registry = "my-registry" } + Boolean optional = dependencyInfo.getBoolean("optional"); // NOI18N + RustPackage rp = RustPackage.withNameAndVersion(cargotoml, dependencyName, version, optional); + packages.add(rp); + } else if (git != null) { + // Examples: + // [dependencies] + // regex = { git = "https://github.com/rust-lang/regex"; } + // regex = { git = "https://github.com/rust-lang/regex";, branch = "next" } + String branch = dependencyInfo.getString("branch"); + RustPackage rp = RustPackage.withGit(cargotoml, dependencyName, git, branch); + packages.add(rp); + } + } else { + // TODO: Add support for github dependencies and registry dependencies https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html + LOG.warning(String.format("Unrecognized cargo dev-dependency on file %s with key '%s', value '%s'", + FileUtil.toFile(cargotoml.getFileObject()).getAbsolutePath(), + key, value)); // NOI18N + } + } + Collections.sort(packages, (RustPackage a, RustPackage b) -> { Review Comment: nitpick: could be `packages.sort((RustPackage a, RustPackage b) -> { ...` since List has a sort method. only noticed this since I have some [extra jackpot rules](https://github.com/mbien/jackpot-inspections/blob/c5ab627bb39f81153a562d0352f2c403452e0945/CollectionPerformance.hint#L149-L150) enabled. ########## rust/rust.grammar/src/org/netbeans/modules/rust/grammar/folding/RustFoldingProvider.java: ########## @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.rust.grammar.folding; + +import java.util.ArrayList; +import java.util.Collection; +import org.netbeans.api.editor.fold.FoldType; +import org.netbeans.api.editor.mimelookup.MimeRegistration; +import org.netbeans.spi.editor.fold.FoldTypeProvider; + +/** + * Responsible for Rust folding. + * + * @author antonio + */ +@MimeRegistration(mimeType = "text/x-rust", service = FoldTypeProvider.class, position = 1000) +public class RustFoldingProvider implements FoldTypeProvider { + + private static final Collection<FoldType> TYPES = new ArrayList<>(9); + + static { + TYPES.add(RustFoldingScanner.TYPE_CODE_BLOCKS); + TYPES.add(RustFoldingScanner.TYPE_STRUCTS); + TYPES.add(RustFoldingScanner.TYPE_FUNCTION); + TYPES.add(RustFoldingScanner.TYPE_IMPL); + TYPES.add(RustFoldingScanner.TYPE_TRAIT); + TYPES.add( RustFoldingScanner.TYPE_ENUM); + TYPES.add( RustFoldingScanner.TYPE_MACRO); + TYPES.add( RustFoldingScanner.TYPE_MODULE); Review Comment: extra space ########## rust/rust.cargo/src/org/netbeans/modules/rust/cargo/impl/nodes/RustPackageNode.java: ########## @@ -0,0 +1,168 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.rust.cargo.impl.nodes; + +import java.lang.reflect.InvocationTargetException; +import java.util.function.Function; +import javax.swing.Action; +import org.netbeans.modules.rust.cargo.api.RustPackage; +import org.netbeans.modules.rust.cargo.impl.nodes.actions.dependencies.RustRemoveDependencyAction; +import org.netbeans.modules.rust.project.api.RustProjectAPI; +import org.openide.nodes.AbstractNode; +import org.openide.nodes.Children; +import org.openide.nodes.PropertySupport; +import org.openide.nodes.Sheet; +import org.openide.util.NbBundle; +import org.openide.util.lookup.AbstractLookup; +import org.openide.util.lookup.InstanceContent; + +/** + * A Node for RustPackages + * + * @author antonio + */ [email protected]({ + "NAME=Name", + "VERSION=Version", + "MAJOR=Major version", + "MINOR=Minor version", + "PATCH=Patch version", + "DESCRIPTION=Description", + "GIT=Git repository", + "BRANCH=Git repository branch", + "NAME_DESC=The name of this package", + "VERSION_DESC=The version of this package", + "MAJOR_DESC=The major version of this package", + "MINOR_DESC=The minor version of this package", + "PATCH_DESC=The patch version of this package", + "DESCRIPTION_DESC=The description of this package", + "GIT_DESC=A git repository where this package is downloaded from", + "BRANCH_DESC=The branch used to fetch this package source from git", +}) +public final class RustPackageNode extends AbstractNode { + + public enum PROPS { + NAME, + VERSION, + MAJOR, + MINOR, + PATCH, + DESCRIPTION, + GIT, + BRANCH; + } + + private final RustPackage rustPackage; + private final RustProjectDependenciesNode.DependencyType dependencyType; + + public RustPackageNode(RustPackage rustPackage, RustProjectDependenciesNode.DependencyType dependencyType) { + this(rustPackage, dependencyType, new InstanceContent()); + } + + private RustPackageNode(RustPackage rustPackage, RustProjectDependenciesNode.DependencyType dependencyType, InstanceContent ic) { + super(Children.LEAF, new AbstractLookup(ic)); + this.rustPackage = rustPackage; + this.dependencyType = dependencyType; + setIconBaseWithExtension(RustProjectAPI.ICON); + if (rustPackage != null) { + setDisplayName(String.format("%s (%s)", rustPackage.getName(), rustPackage.getVersion())); + if (rustPackage.getDescription() != null) { + setShortDescription(rustPackage.getDescription()); + } + ic.add(rustPackage); + ic.add(rustPackage.getCargotoml()); + } + } + + private static final String I18N(String key) { + return NbBundle.getMessage(RustPackageNode.class, key); + } + + @Override + protected Sheet createSheet() { + + // Create an empty sheet + Sheet sheet = Sheet.createDefault(); + // Create a set of properties + Sheet.Set set = Sheet.createPropertiesSet(); + + set.put(getNameProperty()); + set.put(getMajorProperty()); + set.put(getMinorProperty()); + set.put(getPatchProperty()); + set.put(getDescriptionProperty()); + set.put( getGitProperty()); + set.put( getBranchProperty()); Review Comment: nitpick: extra spaces -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
