xref: /OpenGrok/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/ruby/RubyAnalyzerFactory.java (revision 0e4c55544f8ea0a68e8bae37b0e502097e008ec1)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * See LICENSE.txt included in this distribution for the specific
9  * language governing permissions and limitations under the License.
10  *
11  * When distributing Covered Code, include this CDDL HEADER in each
12  * file and include the License file at LICENSE.txt.
13  * If applicable, add the following below this CDDL HEADER, with the
14  * fields enclosed by brackets "[]" replaced with your own identifying
15  * information: Portions Copyright [yyyy] [name of copyright owner]
16  *
17  * CDDL HEADER END
18  */
19 
20 /*
21  * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
22  * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
23  */
24 package org.opengrok.indexer.analysis.ruby;
25 
26 import org.opengrok.indexer.analysis.AbstractAnalyzer;
27 import org.opengrok.indexer.analysis.FileAnalyzerFactory;
28 
29 /**
30  * Represents an implementation of {@link FileAnalyzerFactory} to produce
31  * {@link RubyAnalyzer} instances.
32  */
33 public class RubyAnalyzerFactory extends FileAnalyzerFactory {
34 
35     private static final String NAME = "Ruby";
36 
37     private static final String[] SUFFIXES = {
38         "RB",
39         "RUBY"
40     };
41     private static final String[] MAGICS = {
42         "#!/usr/bin/env ruby",
43         "#!/usr/bin/ruby",
44         "#!/usr/local/bin/ruby",
45         "#!/bin/ruby",
46         "#!ruby",
47     };
48 
49     /**
50      * Creates a new instance of {@link RubyAnalyzerFactory}.
51      */
RubyAnalyzerFactory()52     public RubyAnalyzerFactory() {
53         super(null, null, SUFFIXES, MAGICS, null, "text/plain", AbstractAnalyzer.Genre.PLAIN, NAME);
54     }
55 
56     /**
57      * Creates a new instance of {@link RubyAnalyzer}.
58      * @return the new instance
59      */
60     @Override
newAnalyzer()61     protected AbstractAnalyzer newAnalyzer() {
62         return new RubyAnalyzer(this);
63     }
64 }
65