Class: Curate::SearchConfigGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/curate/search_config/search_config_generator.rb

Constant Summary collapse

NGRAM_QUESTION = 
<<-QUESTION_TO_ASK
Would you like to enable partial term matches for searches in your SOLR configuration?
 
This will create fields that use EdgeNGram filters, which might impact index sizes.

This will instruct SOLR to copy a configurable list of fields into a single
field for keyword searching instead of searching fields individually.

QUESTION_TO_ASK
PARTIAL_SEARCH_QUESTION = 
<<-QUESTION_TO_ASK
Would you like to enable partial term matches for searches in your SOLR configuration?
 
This will create fields that use EdgeNGram filters, which might impact index sizes.

This will instruct SOLR to copy a configurable list of fields into a single
field for keyword searching instead of searching fields individually.

QUESTION_TO_ASK
JETTY_SOLR_QUESTION = 
<<-QUESTION_TO_ASK
Would you like to enable these SOLR configuration options in the local Jetty
instance installed with Curate?

This will copy the resulting configuration files from solr_conf/conf to the SOLR
instance inside of the included Jetty server.
QUESTION_TO_ASK
EDGE_FILTER_CONFIG = 
<<-CONFIG_BLOCK
    <!-- The following definition was created during Curate installation -->
    <!-- A text field with EdgeNGram filtering for partial matches -->
    <fieldType name="text_en_ef" class="solr.TextField" positionIncrementGap="100">
      <analyzer type="index">
        <tokenizer class="solr.ICUTokenizerFactory"/>
        <filter class="solr.ICUFoldingFilterFactory"/>  <!-- NFKC, case folding, diacritics removed -->
        <filter class="solr.EnglishPossessiveFilterFactory"/>
        <!-- EnglishMinimalStemFilterFactory is less aggressive than PorterStemFilterFactory: -->
        <filter class="solr.EnglishMinimalStemFilterFactory"/>
        <filter class="solr.TrimFilterFactory"/>
        <filter class="solr.EdgeNGramFilterFactory" minGramSize="3" maxGramSize="15" side="front"/>
      </analyzer>
      <analyzer type="query">
        <tokenizer class="solr.ICUTokenizerFactory"/>
        <filter class="solr.ICUFoldingFilterFactory"/>  <!-- NFKC, case folding, diacritics removed -->
        <filter class="solr.EnglishPossessiveFilterFactory"/>
        <!-- EnglishMinimalStemFilterFactory is less aggressive than PorterStemFilterFactory: -->
        <filter class="solr.EnglishMinimalStemFilterFactory"/>
        <filter class="solr.TrimFilterFactory"/>
      </analyzer>
    </fieldType>

CONFIG_BLOCK
AGGREGATE_CONFIG = 
<<-CONFIG_BLOCK
    <!-- The following definition was created during Curate installation -->
    <!-- The all_text_tesim field is an aggregate of all *_tesim fields for overall keyword searching -->
    <!-- desc_metadata_name_ef is an alternate source for people names that has been edge filtered -->
    <field name="all_text_tesim" type="text_en_ef" stored="true" indexed="true" multiValued="true"/>
    <field name="desc_metadata_name_ef" type="text_en_ef" stored="true" indexed="true" multiValued="true"/>

CONFIG_BLOCK
COPYFIELD_CONFIG = 
<<-CONFIG_BLOCK

    <!-- The following definition was created during Curate installation -->
    <!-- Maintain aggregate of *_tesim fields in all_text_tesim field -->
    <copyField source="*_tesim" dest="all_text_tesim"/>
    <!-- Maintain an alternate source for people names that has been edge filtered -->
    <copyField source="desc_metadata__name_tesim" dest="desc_metadata_name_ef"/>

CONFIG_BLOCK
FINAL_STATUS = 
<<-BLOCK
Optional SOLR configuration complete. 

Please review files in ./solr_conf/conf. Changes are commented with the phrase
'created during Curate installation'. If you are using an external instance of
SOLR or chose not to copy resulting files to Jetty, then you must review/copy
the configuration files appropriately for your situation.

Also consult the changes to 'config/search_config'. This file is used to determine
SOLR options set in search controllers.
BLOCK

Instance Method Summary collapse

Instance Method Details

#config_edge_filters ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/generators/curate/search_config/search_config_generator.rb', line 122

def config_edge_filters
  myfile = Rails.root.join("solr_conf","conf","schema.xml")
  config_target = /.*A text field with defaults appropriate for English --\>\n/
  say_status(".....", "Configuring SOLR with an EdgeNGramFilterFactory field type", :green)
  say_status(".....", "Making changes to "+myfile.to_s, :green)
  inject_into_file myfile, EDGE_FILTER_CONFIG, before: config_target
end

#config_partial_search ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/generators/curate/search_config/search_config_generator.rb', line 130

def config_partial_search
  myschema = Rails.root.join("solr_conf","conf","schema.xml")
  myconfig = Rails.root.join("solr_conf","conf","solrconfig.xml")
  yamlfile = Rails.root.join("config","search_config.yml")
  schema_target = /.*\<\/fields\>.*\n/
  schema_target = /.*\<\/fields\>.*\n/
  catalog_qf_opts = 'desc_metadata__title_tesim,desc_metadata__name_tesim'
  people_qf_opts = 'desc_metadata__name_tesim'
  if yes_with_banner?(PARTIAL_SEARCH_QUESTION)
    say_status(".....", "Configuring SOLR to return partial matches for searches", :green)
    say_status(".....", "Configuring SOLR to aggregate fields for keyword searches", :green)
    say_status(".....", "About to make changes to "+myschema.to_s+" and "+myconfig.to_s, :green)
    inject_into_file myschema, AGGREGATE_CONFIG, before: schema_target
    inject_into_file myschema, COPYFIELD_CONFIG, after: schema_target
    inject_into_file myconfig, "          all_text_tesim\n", after: /.*\<str name="qf"\>\n.*id\n/
    inject_into_file myconfig, "          all_text_tesim^10\n", after: /.*\<str name="pf"\>\n/
    catalog_qf_opts = 'all_text_tesim'
    people_qf_opts = 'desc_metadata_name_ef'
  else
    say_status(".....", "SOLR will not return partial matches for searches", :green)
  end
  inject_into_file yamlfile, "    qf: [#{catalog_qf_opts}]\n", after: /.\scatalog:\n/
  inject_into_file yamlfile, "    fl: desc_metadata__name_tesim id\n", after: /.\speople:\n/
  inject_into_file yamlfile, "    qf: [#{people_qf_opts}]\n", after: /.\speople:\n/
end

#copy_solr_configs ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/generators/curate/search_config/search_config_generator.rb', line 156

def copy_solr_configs
  my_solr_path = "solr_conf/conf"  
  my_jetty_dev_path = Rails.root.join("jetty","solr","development-core","conf")
  my_jetty_test_path = Rails.root.join("jetty","solr","test-core","conf")
  if File.directory?(Rails.root+"jetty")
    if yes_with_banner?(JETTY_SOLR_QUESTION)
      say_status(".....", "Copying SOLR config files to Jetty", :green)
      copy_file my_solr_path+"/schema.xml", my_jetty_dev_path+"schema.xml", force: true
      copy_file my_solr_path+"/schema.xml", my_jetty_test_path+"schema.xml", force: true
      copy_file my_solr_path+"/solrconfig.xml", my_jetty_dev_path+"solrconfig.xml", force: true
      copy_file my_solr_path+"/solrconfig.xml", my_jetty_test_path+"solrconfig.xml", force: true
    end
  end
end

#final_status ⇒ Object 



171
172
173
174
175
176
 
# File 'lib/generators/curate/search_config/search_config_generator.rb', line 171

def final_status
  banner = "\n" + "*" * 80 + "\n"
  puts banner
  say_status("Finished",FINAL_STATUS, :green)
  puts banner
end

#prepare_yaml_file ⇒ Object 



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/generators/curate/search_config/search_config_generator.rb', line 111

def prepare_yaml_file
  banner = "\n" + "*" * 80 + "\n"
  puts banner
  say_status("Preparing","Preparing search configuration files...", :green)
  puts banner
  yamlfile = Rails.root.join("config","search_config.yml")
  qt_option = "    qt: search\n"
  inject_into_file yamlfile, qt_option, after: /.*.\scatalog:\n/, force: true
  inject_into_file yamlfile, qt_option, after: /.*.\speople:\n/, force: true
end