org.torquebox.mojo.rubygems.RubygemsFileFactory Maven / Gradle / Ivy
The newest version!
/*
* Sonatype Nexus (TM) Open Source Version
* Copyright (c) 2008-present Sonatype, Inc.
* All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
*
* This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
* which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
* of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
* Eclipse Foundation. All other trademarks are the property of their respective owners.
*/
package org.torquebox.mojo.rubygems;
/**
* interface for a factory to create RubygemsFile
*
* @author christian
*/
public interface RubygemsFileFactory {
/**
* create Directory with given entries
*
* @return Directory
*/
Directory directory(String path, String... entries);
/**
* create RubygemsDirectory /maven/releases/rubygems or /maven/prerelease/rubygems
*
* @return RubygemsDirectory
*/
RubygemsDirectory rubygemsDirectory(String path);
/**
* create Directory /maven/releases/rubygems/{artifactId} or /maven/prerelease/rubygems/{artifactId}
*
* @param prereleases flag to create released or prereleased gem, i.e. without or with SNAPSHOT in version
* @return RubygemsDirectory
*/
Directory gemArtifactIdDirectory(String path, String artifactId, boolean prereleases);
/**
* create Directory /maven/releases/rubygems/{artifactId}/{version} or
* /maven/prerelease/rubygems/{artifactId}/{version}
*
* @return RubygemsDirectory
*/
Directory gemArtifactIdVersionDirectory(String path, String artifactId, String version, boolean prereleases);
/**
* create GemFile /gems/{name}-{version}.gem or /gems/{name}-{version}-{platform}.gem
*
* @param platform can be null
* @return GemFile
*/
GemFile gemFile(String name, String version, String platform);
/**
* create GemFile /gems/{filename}.gem
*
* @return GemFile
*/
GemFile gemFile(String filename);
/**
* create GemspecFile /quick/Marshal.4.8/{name}-{version}.gemspec.rz or
* /quick/Marshal.4.8/{name}-{version}-{platform}.gemspec.rz
*
* @param platform can be null
* @return GemspecFile
*/
GemspecFile gemspecFile(String name, String version, String platform);
/**
* create GemspecFile /quick/Marshal.4.8/{filename}.gemspec.rz
*
* @return GemspecFile
*/
GemspecFile gemspecFile(String filename);
/**
* create DependencyFile /api/v1/dependencies/{name}.ruby for
* a given gem-name
*
* @param name of the gemfile
* @return DependencyFile
*/
@Deprecated
DependencyFile dependencyFile(String name);
ApiV2File rubygemsInfoV2(String name, String version);
CompactInfoFile compactInfo(String name);
/**
* create BundlerApiFile /api/v1/dependencies?gems=name1,name2,etc
*
* @param namesCommaSeparated which is a list of gem-names separated with a comma
* @return BundlerApiFile
*/
BundlerApiFile bundlerApiFile(String namesCommaSeparated);
/**
* create BundlerApiFile /api/v1/dependencies?gems=name1,name2,etc
*
* @param names list of gem-names
* @return BundlerApiFile
*/
BundlerApiFile bundlerApiFile(String... names);
/**
* create ApiV1File /api/v1/gem or /api/v1/api_key
*
* @param name which is either 'gem' or 'api_key'
* @return ApiV1File
*/
ApiV1File apiV1File(String name);
/**
* create SpecsIndexFile /specs.4.8 or /latest_specs.4.8 or /prerelease_specs.4.8
*
* @param name which is either 'specs' or 'latest_specs' or 'prerelease_specs'
* @return SpecsIndexFile
*/
SpecsIndexFile specsIndexFile(String name);
/**
* create SpecsIndexFile /specs.4.8 or /latest_specs.4.8 or /prerelease_specs.4.8
*/
SpecsIndexFile specsIndexFile(SpecsIndexType type);
/**
* create SpecsIndexZippedFile /specs.4.8.gz or /latest_specs.4.8.gz or /prerelease_specs.4.8.gz
*
* @param name which is either 'specs' or 'latest_specs' or 'prerelease_specs'
*/
SpecsIndexZippedFile specsIndexZippedFile(String name);
/**
* create SpecsIndexZippedFile /specs.4.8 or /latest_specs.4.8 or /prerelease_specs.4.8
*/
SpecsIndexZippedFile specsIndexZippedFile(SpecsIndexType type);
/**
* create MavenMetadataFile /maven/releases/rubygems/{name}/maven-metadata.xml or
* /maven/prereleases/rubygems/{name}/maven-metadata.xml
*
* @param name gem name
* @param prereleased a flag whether to add '-SNAPSHOT' to version or not
* @return MavenMetadataFile
*/
MavenMetadataFile mavenMetadata(String name, boolean prereleased);
/**
* create MavenMetadataSnapshotFile /maven/prereleases/rubygems/{name}/{version}/maven-metadata.xml
*
* @param name gem name
* @param version of the gem
* @return MavenMetadataSnapshotFile
*/
MavenMetadataSnapshotFile mavenMetadataSnapshot(String name, String version);
/**
* create PomFile /maven/prereleases/rubygems/{name}/{version}/{name}-{version}-SNAPSHOT.pom
*
* @param name gem name
* @param version of the gem
* @param timestamp when the gem was created
* @return PomFile
*/
PomFile pomSnapshot(String name, String version, String timestamp);
/**
* create PomFile /maven/releases/rubygems/{name}/{version}/{name}-{version}.pom
*
* @param name gem name
* @param version of the gem
* @return PomFile
*/
PomFile pom(String name, String version);
/**
* create PomFile /maven/prereleases/rubygems/{name}/{version}/{name}-{version}-SNAPSHOT.gem
*
* @param name gem name
* @param version of the gem
* @param timestamp when the gem was created
* @return PomFile
*/
GemArtifactFile gemArtifactSnapshot(String name, String version, String timestamp);
/**
* create PomFile /maven/releases/rubygems/{name}/{version}/{name}-{version}.gem
*
* @param name gem name
* @param version of the gem
* @return PomFile
*/
GemArtifactFile gemArtifact(String name, String version);
/**
* create NotFoundFile for any path name not belonging to the rubygems world
*
* @return NotFoundFile
*/
NotFoundFile notFound(String path);
/**
* create Sha1File for a given RubygemsFile
*
* @param file the sha1 is for this RubygemsFile
* @return Sha1File
*/
Sha1File sha1(RubygemsFile file);
/**
* Create a NoContentFile for /api/v1/dependencies and /api/v1/dependencies?gems=
*
* @param path for this RubygemsFile
* @return NoContentFile
*/
NoContentFile noContent(String path);
}