Class: GeoblacklightAdmin::ConfigGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/geoblacklight_admin/config_generator.rb

Instance Method Summary collapse

Instance Method Details

#add_activestorage ⇒ Object 



362
363
364
365
366
367
368
369
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 362

def add_activestorage
  append_to_file "app/assets/javascripts/application.js" do
    "
// Required by GBL Admin
//= require activestorage
//= require geoblacklight_admin"
  end
end

#add_api_controller ⇒ Object 



371
372
373
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 371

def add_api_controller
  copy_file "api_controller.rb", "app/controllers/admin/api_controller.rb"
end

#add_application_config_for_psych_time_with_zone ⇒ Object 



462
463
464
465
466
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 462

def add_application_config_for_psych_time_with_zone
  inject_into_file "config/application.rb", after: "config.generators.system_tests = nil" do
    "\n    config.active_record.yaml_column_permitted_classes = [Symbol, Date, Time, ActiveSupport::TimeWithZone, ActiveSupport::TimeZone]"
  end
end

#add_assets_initialier ⇒ Object 



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 400

def add_assets_initialier
  append_to_file "config/initializers/assets.rb" do
    "
    # GBL ADMIN
    Rails.application.config.assets.paths << Rails.root.join('node_modules')
    Rails.application.config.assets.precompile += %w( geoblacklight_admin.js )
    Rails.application.config.assets.precompile += %w[application.js]
    Rails.application.config.assets.precompile += %w[application.css]"
  end
end

#add_data_dictionaries_action ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 427

def add_data_dictionaries_action
  inject_into_file "app/controllers/catalog_controller.rb", before: "\nend" do
    "\n  def data_dictionaries
      \n    @response, @documents = action_documents
      \n    respond_to do |format|
      \n      format.html do
      \n        return render layout: false if request.xhr?
      \n        # Otherwise draw the full page
      \n      end
      \n    end
      \n  end"
  end
end

#add_gbl_admin_data_dictionariesable ⇒ Object 



335
336
337
338
339
340
341
342
343
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 335

def add_gbl_admin_data_dictionariesable
  inject_into_file "config/routes.rb", before: /^end/ do
    "\n        concern :gbl_admin_data_dictionariesable, GeoblacklightAdmin::Routes::DataDictionariesable.new
    resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do
      concerns :gbl_admin_data_dictionariesable
    end
    \n\n"
  end
end

#add_import_id_facet ⇒ Object 



456
457
458
459
460
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 456

def add_import_id_facet
  inject_into_file "app/controllers/catalog_controller.rb", before: "# Item Relationship Facets" do
    "\nconfig.add_facet_field Settings.FIELDS.B1G_IMPORT_ID, label: 'Import ID', show: false\n"
  end
end

#add_kithe_bulk_loading_service ⇒ Object 



411
412
413
414
415
416
417
418
419
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 411

def add_kithe_bulk_loading_service
  prepend_to_file "app/controllers/catalog_controller.rb" do
    "require 'kithe/blacklight_tools/bulk_loading_search_service'\n\n"
  end

  inject_into_file "app/controllers/catalog_controller.rb", after: "include Blacklight::Catalog" do
    "\n  self.search_service_class = Kithe::BlacklightTools::BulkLoadingSearchService"
  end
end

#add_kithe_model_to_solr_document ⇒ Object 



441
442
443
444
445
446
447
448
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 441

def add_kithe_model_to_solr_document
  inject_into_file "app/models/solr_document.rb", after: "include Geoblacklight::SolrDocument" do
    "\n\nattr_accessor :model
    \n def kithe_model
      Kithe::Model.find_by_friendlier_id(self.id)
    end\n\n"
  end
end

#add_package_json ⇒ Object 



392
393
394
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 392

def add_package_json
  copy_file "package.json", "package.json", force: true
end

#add_pagy ⇒ Object 



356
357
358
359
360
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 356

def add_pagy
  inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
    "  include Pagy::Backend\n" \
  end
end

#add_search_builder_publication_state_concern ⇒ Object 



450
451
452
453
454
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 450

def add_search_builder_publication_state_concern
  inject_into_file "app/models/search_builder.rb", after: "include Geoblacklight::SuppressedRecordsSearchBehavior" do
    "\n      include GeoblacklightAdmin::PublicationStateSearchBehavior"
  end
end

#add_show_gbl_admin_data_dictionaries ⇒ Object 



421
422
423
424
425
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 421

def add_show_gbl_admin_data_dictionaries
  inject_into_file "app/controllers/catalog_controller.rb", after: "# Custom tools for GeoBlacklight" do
    "\n   config.add_show_tools_partial :gbl_admin_data_dictionaries, partial: 'gbl_admin_data_dictionaries', if: proc { |_context, _config, options| options[:document] && options[:document]&.kithe_model&.document_data_dictionaries&.present? }"
  end
end

#add_show_sidebar ⇒ Object 



383
384
385
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 383

def add_show_sidebar
  copy_file "_show_sidebar.html.erb", "app/views/catalog/_show_sidebar.html.erb"
end

#add_test_fixture_files ⇒ Object

Add test fixture files - Necessary for import background job tests



476
477
478
479
480
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 476

def add_test_fixture_files
  copy_file "btaa_sample_records.csv", "test/fixtures/files/btaa_sample_records.csv", force: true
  copy_file "btaa_sample_document_distributions.csv", "test/fixtures/files/btaa_sample_document_distributions.csv", force: true
  copy_file "btaa_sample_document_data_dictionary_entries.csv", "test/fixtures/files/btaa_sample_document_data_dictionary_entries.csv", force: true
end

#add_user_util_links ⇒ Object 



375
376
377
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 375

def add_user_util_links
  copy_file "_user_util_links.html.erb", "app/views/shared/_user_util_links.html.erb"
end

#add_vite_rails_config ⇒ Object 



468
469
470
471
472
473
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 468

def add_vite_rails_config
  copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb", force: true
  copy_file "vite.config.ts", "vite.config.ts", force: true
  copy_file "config/vite.json", "config/vite.json", force: true
  copy_file "frontend/entrypoints/application.js", "app/javascript/entrypoints/application.js", force: true
end

#bundle_install ⇒ Object

Run bundle with vite install



483
484
485
486
487
488
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 483

def bundle_install
  Bundler.with_clean_env do
    run "bundle install"
    run "bundle exec vite install"
  end
end

#copy_app_images ⇒ Object 



387
388
389
390
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 387

def copy_app_images
  copy_file "images/bookmark-regular.svg", "app/assets/images/bookmark-regular.svg"
  copy_file "images/bookmark-solid.svg", "app/assets/images/bookmark-solid.svg"
end

#copy_catalog_index_view ⇒ Object 



379
380
381
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 379

def copy_catalog_index_view
  copy_file "views/_index_split_default.html.erb", "app/views/catalog/_index_split_default.html.erb"
end

#copy_json_schema ⇒ Object 



72
73
74
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 72

def copy_json_schema
  copy_file "config/geomg_aardvark_schema.json", "config/geomg_aardvark_schema.json"
end

#copy_rake_tasks ⇒ Object 



396
397
398
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 396

def copy_rake_tasks
  append_to_file "Rakefile", "require \"geoblacklight_admin/rake_task\"\n"
end

#copy_solr ⇒ Object 



76
77
78
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 76

def copy_solr
  directory "solr", "solr", force: true
end

#create_database_yml ⇒ Object 



51
52
53
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 51

def create_database_yml
  copy_file "config/database.yml", "config/database.yml", force: true
end

#create_dotenv ⇒ Object 



63
64
65
66
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 63

def create_dotenv
  copy_file ".env.development.example", ".env.development"
  copy_file ".env.development.example", ".env.test"
end

#create_gbl_admin_initializer_files ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 39

def create_gbl_admin_initializer_files
  copy_file "config/initializers/geoblacklight_admin.rb", "config/initializers/geoblacklight_admin.rb", force: true
  copy_file "config/initializers/devise.rb", "config/initializers/devise.rb", force: true
  copy_file "config/initializers/kithe.rb", "config/initializers/kithe.rb", force: true
  copy_file "config/initializers/mime_types.rb", "config/initializers/mime_types.rb", force: true
  copy_file "config/initializers/pagy.rb", "config/initializers/pagy.rb", force: true
  copy_file "config/initializers/shrine.rb", "config/initializers/shrine.rb", force: true
  copy_file "config/initializers/simple_form.rb", "config/initializers/simple_form.rb", force: true
  copy_file "config/initializers/simple_form_bootstrap.rb", "config/initializers/simple_form_bootstrap.rb", force: true
  copy_file "config/initializers/statesman.rb", "config/initializers/statesman.rb", force: true
end

#create_settings_yml ⇒ Object 



68
69
70
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 68

def create_settings_yml
  copy_file "config/settings.yml", "config/settings.yml", force: true
end

#create_sidekiq_yml ⇒ Object 



55
56
57
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 55

def create_sidekiq_yml
  copy_file "config/sidekiq.yml", "config/sidekiq.yml", force: true
end

#create_solr_wrapper_yml ⇒ Object 



59
60
61
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 59

def create_solr_wrapper_yml
  copy_file ".solr_wrapper.yml", ".solr_wrapper.yml", force: true
end

#set_development_mailer_host ⇒ Object 



345
346
347
348
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 345

def set_development_mailer_host
  mailer_host = "\n  config.action_mailer.default_url_options = { :host => 'localhost:3000' }\n"
  inject_into_file "config/environments/development.rb", mailer_host, after: "config.action_mailer.perform_caching = false"
end

#set_routes ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 80

def set_routes
  gbl_admin_routes = "    ####################\n    # GBL\u2021ADMIN\n\n    # Bulk Actions\n    resources :bulk_actions do\n      patch :run, on: :member\n      patch :revert, on: :member\n    end\n\n    # Users\n    devise_for :users, skip: [:registrations]\n    as :user do\n      get \"/sign_in\" => \"devise/sessions#new\" # custom path to login/sign_in\n      get \"/sign_up\" => \"devise/registrations#new\", :as => \"new_user_registration\" # custom path to sign_up/registration\n      get \"users/edit\" => \"devise/registrations#edit\", :as => \"edit_user_registration\"\n      put \"users\" => \"devise/registrations#update\", :as => \"user_registration\"\n    end\n\n    namespace :admin do\n      # Root\n      root to: \"documents#index\"\n\n      # Assets\n      # Note \"assets\" is Rails reserved word for routing, oops. So we use\n      # asset_files.\n      resources :assets, path: \"asset_files\" do\n        collection do\n          get \"display_attach_form\"\n          post \"attach_files\"\n\n          get \"destroy_all\"\n          post \"destroy_all\"\n        end\n\n        post :sort, on: :collection\n      end\n\n      # Bulk Actions\n      resources :bulk_actions do\n        patch :run, on: :member\n        patch :revert, on: :member\n      end\n\n      # Imports\n      resources :imports do\n        resources :mappings\n        resources :import_documents, only: [:show]\n        patch :run, on: :member\n      end\n\n      # Import Distributions\n      resources :import_distributions do\n        resources :import_document_distributions, only: [:show]\n        patch :run, on: :member\n      end\n\n      # Elements\n      resources :elements do\n        post :sort, on: :collection\n      end\n\n      # Form Elements\n      resources :form_elements do\n        post :sort, on: :collection\n      end\n      resources :form_header, path: :form_elements, controller: :form_elements\n      resources :form_group, path: :form_elements, controller: :form_elements\n      resources :form_control, path: :form_elements, controller: :form_elements\n      resources :form_feature, path: :form_elements, controller: :form_elements\n\n      # Reference Types\n      resources :reference_types do\n        post :sort, on: :collection\n      end\n\n      # Notifications\n      resources :notifications do\n        put \"batch\", on: :collection\n      end\n\n      # Users\n      get \"users/index\"\n\n      # Bookmarks\n      resources :bookmarks\n      delete \"/bookmarks\", to: \"bookmarks#destroy\", as: :bookmarks_destroy_by_fkeys\n\n      # Search controller\n      get \"/search\" => \"search#index\"\n      \n      # AdvancedSearch controller\n      get '/advanced_search' => 'advanced_search#index', constraints: lambda { |req| req.format == :json }\n      get '/advanced_search/facets' => 'advanced_search#facets', constraints: lambda { |req| req.format == :json }\n      get '/advanced_search/facet/:id' => 'advanced_search#facet', constraints: lambda { |req| req.format == :json }, as: 'advanced_search_facet'\n\n      # Ids controller\n      get '/api/ids' => 'ids#index', constraints: lambda { |req| req.format == :json }\n      get '/api' => 'api#index', constraints: lambda { |req| req.format == :json }\n      get '/api/fetch' => 'api#fetch', constraints: lambda { |req| req.format == :json }\n      get '/api/facet/:id' => 'api#facet', constraints: lambda { |req| req.format == :json }\n\n      # Documents\n      resources :documents do\n        get \"admin\"\n        get \"versions\"\n\n        collection do\n          get \"fetch\"\n        end\n\n        # DocumentAccesses\n        resources :document_accesses, path: \"access\" do\n          collection do\n            get \"import\"\n            post \"import\"\n\n            get \"destroy_all\"\n            post \"destroy_all\"\n          end\n        end\n\n        # Document Assets\n        resources :document_assets, path: \"assets\" do\n          collection do\n            get \"display_attach_form\"\n            post \"attach_files\"\n\n            get \"destroy_all\"\n            post \"destroy_all\"\n          end\n        end\n\n        # Data Dictionaries\n        resources :document_data_dictionaries, path: \"data_dictionaries\" do\n          collection do\n            get \"import\"\n            post \"import\"\n\n            get \"destroy_all\"\n            post \"destroy_all\"\n          end\n\n          resources :document_data_dictionary_entries, path: \"entries\" do\n            collection do\n              post \"sort\"\n              get \"destroy_all\"\n              post \"destroy_all\"\n            end\n          end\n        end\n\n        # DocumentDownloads\n        resources :document_downloads, path: \"downloads\" do\n          collection do\n            get \"import\"\n            post \"import\"\n\n            get \"destroy_all\"\n            post \"destroy_all\"\n          end\n        end\n\n        # Document Distributions\n        resources :document_distributions, path: \"distributions\" do\n          collection do\n            get \"display_attach_form\"\n            post \"attach_files\"\n\n            get \"destroy_all\"\n            post \"destroy_all\"\n          end\n        end\n      end\n\n      # Document Accesses\n      resources :document_accesses, path: \"access\" do\n        collection do\n          get \"import\"\n          post \"import\"\n\n          get \"destroy_all\"\n          post \"destroy_all\"\n        end\n      end\n\n      # Document Downloads\n      resources :document_downloads, path: \"downloads\" do\n        collection do\n          get \"import\"\n          post \"import\"\n\n          get \"destroy_all\"\n          post \"destroy_all\"\n        end\n      end\n\n      # Document Distributions\n      resources :document_distributions, path: \"distributions\" do\n        collection do\n          get \"import\"\n          post \"import\"\n\n          get \"destroy_all\"\n          post \"destroy_all\"\n        end\n      end\n\n      # Document Assets\n      resources :document_assets, path: \"assets\" do\n        collection do\n          get \"display_attach_form\"\n          post \"attach_files\"\n\n          get \"destroy_all\"\n          post \"destroy_all\"\n        end\n      end\n\n      # Assets\n      get \"/asset_files/ingest\", to: \"assets#display_attach_form\", as: \"assets_ingest\"\n      post \"/asset_files/ingest\", to: \"assets#attach_files\"\n      \n      # DocumentAssets\n      get \"/documents/:id/ingest\", to: \"document_assets#display_attach_form\", as: \"asset_ingest\"\n      post \"/documents/:id/ingest\", to: \"document_assets#attach_files\"\n      \n      # Asset Direct Upload\n      mount Kithe::AssetUploader.upload_endpoint(:cache) => \"/direct_upload\", :as => :direct_app_upload\n\n      resources :collections, except: [:show]\n\n      # Note \"assets\" is Rails reserved word for routing, oops. So we use\n      # asset_files.\n      resources :assets, path: \"asset_files\", except: [:new, :create] do\n        member do\n          put \"convert_to_child_work\"\n        end\n      end\n\n      # @TODO\n      # mount Qa::Engine => \"/authorities\"\n      mount ActionCable.server => \"/cable\"\n\n      # @TODO\n      # authenticate :user, ->(user) { user } do\n        # mount Blazer::Engine, at: \"blazer\"\n      # end\n    end\n  ROUTES\n\n  inject_into_file \"config/routes.rb\", gbl_admin_routes, before: /^end/\nend\n"

#set_seeds ⇒ Object 



350
351
352
353
354
 
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 350

def set_seeds
  append_to_file "db/seeds.rb" do
    "GeoblacklightAdmin::Engine.load_seed"
  end
end