Class: Hydra::HeadGenerator

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

Instance Method Summary collapse

Instance Method Details

#add_gems ⇒ Object

Config Files & Initializers



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/generators/hydra/head_generator.rb', line 25

def add_gems
  gem_group :development, :test do
    gem "fcrepo_wrapper"
    gem "rspec-rails" unless options[:'skip-rspec']
  end

  Bundler.with_clean_env do
    run "bundle install"
  end
end

#create_configuration_files ⇒ Object

Copy all files in templates/config directory to host config



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/generators/hydra/head_generator.rb', line 61

def create_configuration_files

  # Initializers
  template "config/initializers/hydra_config.rb",
           "config/initializers/hydra_config.rb"

  # Role Mappings
  copy_file "config/role_map.yml", "config/role_map.yml"

  # CanCan ability.rb
  copy_file "ability.rb", "app/models/ability.rb"

  # Fedora & Solr YAML files
  invoke('active_fedora:config')

  copy_file 'config/blacklight.yml', force: true
end

#create_conneg_configuration ⇒ Object 



79
80
81
82
83
84
85
86
 
# File 'lib/generators/hydra/head_generator.rb', line 79

def create_conneg_configuration
  file_path = "config/initializers/mime_types.rb"
  append_to_file file_path do
    "Mime::Type.register \"application/n-triples\", :nt\n" + 
    "Mime::Type.register \"application/ld+json\", :jsonld\n" +
    "Mime::Type.register \"text/turtle\", :ttl"
  end
end

#inject_hydra_controller_behavior ⇒ Object

Add Hydra to the application controller



46
47
48
49
50
 
# File 'lib/generators/hydra/head_generator.rb', line 46

def inject_hydra_controller_behavior
  insert_into_file "app/controllers/application_controller.rb", after: "include Blacklight::Controller\n" do
    "  include Hydra::Controller::ControllerBehavior\n"
  end
end

#inject_hydra_search_builder_behavior ⇒ Object

Add Hydra to the SearchBuilder



53
54
55
56
57
58
 
# File 'lib/generators/hydra/head_generator.rb', line 53

def inject_hydra_search_builder_behavior
  insert_into_file "app/models/search_builder.rb", after: "include Blacklight::Solr::SearchBuilderBehavior\n" do
    "  # Add a filter query to restrict the search to documents the current user has access to\n" \
    "  include Hydra::AccessControlsEnforcement\n"
  end
end

#inject_hydra_user_behavior ⇒ Object

Add Hydra behaviors to the user model



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/generators/hydra/head_generator.rb', line 99

def inject_hydra_user_behavior
  file_path = "app/models/#{model_name.underscore}.rb"
  if File.exists?(file_path)
    inject_into_class file_path, model_name.classify do
      "  # Connects this user object to Hydra behaviors.\n" +
      "  include Hydra::User\n\n"
    end
  else
    puts "     \e[31mFailure\e[0m  Hydra requires a user object in order to apply access controls. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g hydra:head client"
  end
end

#inject_solr_document_conneg ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/generators/hydra/head_generator.rb', line 88

def inject_solr_document_conneg
  file_path = "app/models/solr_document.rb"
  if File.exists?(file_path)
    inject_into_file file_path, :before => /end\Z/ do
      "\n  # Do content negotiation for AF models. \n" + 
      "\n  use_extension( Hydra::ContentNegotiation )\n"
    end
  end
end

#install_rspec ⇒ Object 



36
37
38
39
 
# File 'lib/generators/hydra/head_generator.rb', line 36

def install_rspec
  return if options[:'skip-rspec']
  generate 'rspec:install'
end

#overwrite_catalog_controller ⇒ Object 



41
42
43
 
# File 'lib/generators/hydra/head_generator.rb', line 41

def overwrite_catalog_controller
  copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
end