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_activestorageObject



264
265
266
267
268
269
270
271
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 264

def add_activestorage
  append_to_file "app/assets/javascripts/application.js" do
    "

// Required by GBL Admin
//= require activestorage"
  end
end

#add_api_controllerObject



273
274
275
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 273

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

#add_assets_initialierObject



306
307
308
309
310
311
312
313
314
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 306

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]"
  end
end

#add_import_id_facetObject



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

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_serviceObject



316
317
318
319
320
321
322
323
324
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 316

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_documentObject



326
327
328
329
330
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 326

def add_kithe_model_to_solr_document
  inject_into_file "app/models/solr_document.rb", after: "include Geoblacklight::SolrDocument" do
    "\n\nattr_accessor :model"
  end
end

#add_package_jsonObject



302
303
304
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 302

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

#add_pagyObject



258
259
260
261
262
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 258

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

#add_search_builder_publication_state_concernObject



332
333
334
335
336
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 332

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_sidebarObject



285
286
287
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 285

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


277
278
279
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 277

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

#copy_app_imagesObject



297
298
299
300
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 297

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_app_javascriptObject

I’m certain this is not the best way to inject our JS behaviors into the root app But for now, this will do… Long term I hope to avoid webpack here altogether.



293
294
295
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 293

def copy_app_javascript
  directory "javascript", "app/javascript", force: true
end

#copy_catalog_index_viewObject



281
282
283
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 281

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

#copy_json_schemaObject



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

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

#copy_solrObject



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

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

#create_database_ymlObject



38
39
40
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 38

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

#create_dotenvObject



46
47
48
49
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 46

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

#create_gbl_admin_initializer_filesObject



26
27
28
29
30
31
32
33
34
35
36
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 26

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_ymlObject



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

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

#create_sidekiq_ymlObject



42
43
44
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 42

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

#create_solr_ymlObject



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

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

#set_development_mailer_hostObject



247
248
249
250
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 247

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_routesObject



67
68
69
70
71
72
73
74
75
76
77
78
79
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
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 67

def set_routes
  gbl_admin_routes = <<-ROUTES
    ####################
    # GBL‡ADMIN

    # Bulk Actions
    resources :bulk_actions do
      patch :run, on: :member
      patch :revert, on: :member
    end

    # Users
    devise_for :users, controllers: {invitations: "devise/invitations"}, skip: [:registrations]
    as :user do
      get "/sign_in" => "devise/sessions#new" # custom path to login/sign_in
      get "/sign_up" => "devise/registrations#new", :as => "new_user_registration" # custom path to sign_up/registration
      get "users/edit" => "devise/registrations#edit", :as => "edit_user_registration"
      put "users" => "devise/registrations#update", :as => "user_registration"
    end

    namespace :admin do
      # Root
      root to: "documents#index"

      # Bulk Actions
      resources :bulk_actions do
        patch :run, on: :member
        patch :revert, on: :member
      end

      # Imports
      resources :imports do
        resources :mappings
        resources :import_documents, only: [:show]
        patch :run, on: :member
      end

      # Elements
      resources :elements do
        post :sort, on: :collection
      end

      # Form Elements
      resources :form_elements do
        post :sort, on: :collection
      end
      resources :form_header, path: :form_elements, controller: :form_elements
      resources :form_group, path: :form_elements, controller: :form_elements
      resources :form_control, path: :form_elements, controller: :form_elements
      resources :form_feature, path: :form_elements, controller: :form_elements

      # Notifications
      resources :notifications do
        put "batch", on: :collection
      end

      # Users
      get "users/index"

      # Bookmarks
      resources :bookmarks
      delete "/bookmarks", to: "bookmarks#destroy", as: :bookmarks_destroy_by_fkeys

      # Search controller
      get "/search" => "search#index"
      
      # AdvancedSearch controller
      get '/advanced_search' => 'advanced_search#index', constraints: lambda { |req| req.format == :json }
      get '/advanced_search/facets' => 'advanced_search#facets', constraints: lambda { |req| req.format == :json }
      get '/advanced_search/facet/:id' => 'advanced_search#facet', constraints: lambda { |req| req.format == :json }, as: 'advanced_search_facet'

      # Ids controller
      get '/api/ids' => 'ids#index', constraints: lambda { |req| req.format == :json }
      get '/api' => 'api#index', constraints: lambda { |req| req.format == :json }
      get '/api/fetch' => 'api#fetch', constraints: lambda { |req| req.format == :json }
      get '/api/facet/:id' => 'api#facet', constraints: lambda { |req| req.format == :json }

      # Documents
      resources :documents do
        get "versions"

        # DocumentAccesses
        resources :document_accesses, path: "access" do
          collection do
            get "import"
            post "import"

            get "destroy_all"
            post "destroy_all"
          end
        end

        # DocumentDownloads
        resources :document_downloads, path: "downloads" do
          collection do
            get "import"
            post "import"

            get "destroy_all"
            post "destroy_all"
          end
        end

        # Document Assets
        resources :document_assets, path: "assets" do
          collection do
            get "display_attach_form"
            post "attach_files"

            get "destroy_all"
            post "destroy_all"
          end
        end

        collection do
          get "fetch"
        end
      end

      # Document Accesses
      resources :document_accesses, path: "access" do
        collection do
          get "import"
          post "import"

          get "destroy_all"
          post "destroy_all"
        end
      end

      # Document Downloads
      resources :document_downloads, path: "downloads" do
        collection do
          get "import"
          post "import"

          get "destroy_all"
          post "destroy_all"
        end
      end

      # Document Assets
      resources :document_assets, path: "assets" do
        collection do
          get "display_attach_form"
          post "attach_files"

          get "destroy_all"
          post "destroy_all"
        end
      end

      get "/documents/:id/ingest", to: "document_assets#display_attach_form", as: "asset_ingest"
      post "/documents/:id/ingest", to: "document_assets#attach_files"
      mount Kithe::AssetUploader.upload_endpoint(:cache) => "/direct_upload", :as => :direct_app_upload

      resources :collections, except: [:show]

      # Note "assets" is Rails reserved word for routing, oops. So we use
      # asset_files.
      resources :assets, path: "asset_files", except: [:new, :create] do
        member do
          put "convert_to_child_work"
        end
      end

      # @TODO
      # mount Qa::Engine => "/authorities"
      mount ActionCable.server => "/cable"

      # @TODO
      # authenticate :user, ->(user) { user } do
        # mount Blazer::Engine, at: "blazer"
      # end
    end
  ROUTES

  inject_into_file "config/routes.rb", gbl_admin_routes, before: /^end/
end

#set_seedsObject



252
253
254
255
256
# File 'lib/generators/geoblacklight_admin/config_generator.rb', line 252

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