org.torquebox.mojo.rubygems.layout.NoopDefaultLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rubygems-tools Show documentation
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.layout;

import org.torquebox.mojo.rubygems.BundlerApiFile;
import org.torquebox.mojo.rubygems.Directory;
import org.torquebox.mojo.rubygems.GemArtifactFile;
import org.torquebox.mojo.rubygems.IOUtil;
import org.torquebox.mojo.rubygems.MavenMetadataFile;
import org.torquebox.mojo.rubygems.MavenMetadataSnapshotFile;
import org.torquebox.mojo.rubygems.PomFile;
import org.torquebox.mojo.rubygems.RubygemsFile;
import org.torquebox.mojo.rubygems.RubygemsGateway;
import org.torquebox.mojo.rubygems.Sha1File;
import org.torquebox.mojo.rubygems.SpecsIndexType;
import org.torquebox.mojo.rubygems.SpecsIndexZippedFile;

import java.io.IOException;
import java.io.InputStream;

/**
 * adds default behavior for all RubygemsFile:
 * all the generated files are marked as forbidden
 * all other files get passed to the DefaultLayout
 * 
 * it adds a few helper methods for sub classes.
 *
 * @author christian
 */
public class NoopDefaultLayout
        extends DefaultLayout {
    protected final RubygemsGateway gateway;

    protected final Storage store;

    public NoopDefaultLayout(RubygemsGateway gateway, Storage store) {
        this.gateway = gateway;
        this.store = store;
    }

    // all those files are generated on the fly

    @Override
    public Sha1File sha1(RubygemsFile file) {
        Sha1File sha = super.sha1(file);
        sha.markAsForbidden();
        return sha;
    }

    @Override
    public PomFile pomSnapshot(String name, String version, String timestamp) {
        PomFile file = super.pomSnapshot(name, version, timestamp);
        file.markAsForbidden();
        return file;
    }

    @Override
    public GemArtifactFile gemArtifactSnapshot(String name, String version, String timestamp) {
        GemArtifactFile file = super.gemArtifactSnapshot(name, version, timestamp);
        file.markAsForbidden();
        return file;
    }

    @Override
    public PomFile pom(String name, String version) {
        PomFile file = super.pom(name, version);
        file.markAsForbidden();
        return file;
    }

    @Override
    public GemArtifactFile gemArtifact(String name, String version) {
        GemArtifactFile file = super.gemArtifact(name, version);
        file.markAsForbidden();
        return file;
    }

    @Override
    public MavenMetadataSnapshotFile mavenMetadataSnapshot(String name, String version) {
        MavenMetadataSnapshotFile file = super.mavenMetadataSnapshot(name, version);
        file.markAsForbidden();
        return file;
    }

    @Override
    public MavenMetadataFile mavenMetadata(String name, boolean prereleased) {
        MavenMetadataFile file = super.mavenMetadata(name, prereleased);
        file.markAsForbidden();
        return file;
    }

    @Override
    public Directory directory(String path, String... items) {
        Directory file = super.directory(path, items);
        file.markAsForbidden();
        return file;
    }

    @Override
    public BundlerApiFile bundlerApiFile(String names) {
        BundlerApiFile file = super.bundlerApiFile(names);
        file.markAsForbidden();
        return file;
    }

    /**
     * on an empty storage there are no specs.4.8.gz, latest_specs.4.8.gz or prereleased_specs.4.8.gz
     * files. this method will create fresh and empty such files (having an empty index).
     */
    protected SpecsIndexZippedFile ensureSpecsIndexZippedFile(SpecsIndexType type) throws IOException {
        SpecsIndexZippedFile specs = super.specsIndexZippedFile(type);
        store.retrieve(specs);
        if (specs.notExists()) {
            try (InputStream content = gateway.newSpecsHelper().createEmptySpecs()) {
                store.create(IOUtil.toGzipped(content), specs);
                if (specs.hasNoPayload()) {
                    store.retrieve(specs);
                }
                if (specs.hasException()) {
                    throw new IOException(specs.getException());
                }
            }
        }
        return specs;
    }

    /**
     * delete underlying file from storage.
     */
    protected void delete(RubygemsFile file) throws IOException {
        store.delete(file);
        if (file.hasException()) {
            throw new IOException(file.getException());
        }
    }
}