JdbcPostgreSQLAdapter.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2008 Sun Microsystems, Inc.
 */
package org.netbeans.modules.ruby.railsprojects.database;

import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.netbeans.modules.ruby.railsprojects.RailsProject;
import org.openide.util.Exceptions;

/**
 * Represents the jdbcposgresql database adapter, i.e. the jdbc-postgresql gem.
 * Meant to be used for generating postgresql configuration for JRuby apps.
 *
 * @author Erno Mononen
 */
class JdbcPostgreSQLAdapter extends RailsDatabaseConfiguration {

    static final String GEM_NAME = "activerecord-jdbcpostgresql-adapter"; //NOI18N

    public String railsGenerationParam() {
        return "postgresql"; //NOI18N
    }

    public void editConfig(RailsProject project) {
        Document databaseYml = RailsAdapters.getDatabaseYml(project.getProjectDirectory());
        try {
            RailsAdapters.changeAttribute(databaseYml, "adapter:", "jdbcpostgresql", null); //NOI18N
            // intentionally within the same try-catch block as changing the adapter
            RailsAdapters.addProperty(databaseYml, "host:", "localhost", "encoding:"); //NOI18N
            editComments(databaseYml);
        } catch (BadLocationException ex) {
            Exceptions.printStackTrace(ex);
        }
    }

    private void editComments(Document databaseYml) throws BadLocationException {
        String text = databaseYml.getText(0, databaseYml.getLength());
        int offset = text.indexOf("development:"); // NOI18N
        if (offset == -1) {
            // best to do nothing
            return;
        }

        // remove the old comment that instructs to install the mysql gem,
        // it is not appropriate here since we're using jdbc-mysql
        databaseYml.remove(0, offset);
        String comment = "# PostgreSQL. Versions 7.4 and 8.x are supported.\n";
        databaseYml.insertString(0, comment, null);

    }

    public JdbcInfo getJdbcInfo() {
        return null;
    }

    @Override
    public boolean requiresJdbc() {
        return true;
    }

    public String getDisplayName() {
        return "postgresql (jdbc)"; //NOI18N
    }

    public String getDatabaseName(String projectName) {
        return projectName + RailsAdapters.DEVELOPMENT_DB_SUFFIX;
    }

    public String getTestDatabaseName(String developmentDbName) {
        return RailsAdapters.getTestDatabaseName(developmentDbName);
    }

    public String getProductionDatabaseName(String developmentDbName) {
        return RailsAdapters.getProductionDatabaseName(developmentDbName);
    }
}