dog_biscuits 0.4.0

data/lib/generators/dog_biscuits/USAGE

@@ -0,0 +1,50 @@
+Description:
+    Install Generator
+        This generator makes the following changes to your application:
+         1. Adds dog_biscuits initializer and config
+         2. Includes DogBiscuits::ExtendedSolrDocument in the SolrDocument
+         3. Runs the authorities, locales and schema_org generators
+         4. Adds various new files into app/
+         5. Runs the dates generator if date_picker or date_range are true
+
+    Generate All Generator
+        This generator makes the following changes to your application:
+         1. Runs the work generator for all selected models
+         2. Runs the locales generator
+         3. Runs the schema_org generator
+
+    Authority Generator:
+        This generator makes the following changes to your application:
+         1. Copies authorities into config/authorities.
+         2. Registers all subauthorities in config/intitializers/dog_biscuits.rb
+         3. Sets up references to the authority concept_schemes in config/dog_biscuits.yml
+         4. Copies the authority services into app/services/
+    
+    Catalog Generator
+        This generator makes the following changes to your application:
+         1. Adds a new app/controllers/catalog_controller.rb
+
+    Schema Org Generator
+        This generator makes the following changes to your application:
+         1. Creates a schema_org.yml file in ./config
+            using information configured in property_mappings
+
+    Locales Generator
+        This generator makes the following changes to your application
+         1. Creates a dog_biscuits.en.yml file in ./config/locales
+            using information configured in property_mappings
+
+    Imagify Generator
+        This generator can be run for an existing Model, or for All models (with All).
+        This generator makes the following changes to your application:
+          1. If this is a Hyku application, enables UV / IIIF
+
+Examples:
+    rails generate dog_biscuits:install
+    rails generate dog_biscuits:authority
+    rails generate dog_biscuits:schema_org
+    rails generate dog_biscuits:locales
+    rails generate dog_biscuits:catalog
+    
+    rails generate dog_biscuits:attribute_rows All
+    rails generate dog_biscuits:attribute_rows ConferenceItem

data/lib/generators/dog_biscuits/authority_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class DogBiscuits::AuthorityGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+  1. Copies authorities into config/authorities.
+  2. Registers all subauthorities in config/intitializers/dog_biscuits.rb
+  3. Sets up references to the authority concept_schemes in config/dog_biscuits.yml
+  4. Copies the authority services into app/services/
+       '
+
+  def copy_authorities
+    directory 'config/authorities', 'config/authorities'
+  end
+
+  def create_dog_biscuits
+    init_path = 'config/initializers/dog_biscuits.rb'
+    yml_path = 'config/dog_biscuits.yml'
+
+    copy_file 'config/dog_biscuits.yml', yml_path unless File.exist?(yml_path)
+    copy_file 'config/initializers/dog_biscuits.rb', init_path unless File.exist?(init_path)
+  end
+
+  def inject_into_dog_biscuits
+    init_path = 'config/initializers/dog_biscuits.rb'
+    yml_path = 'config/dog_biscuits.yml'
+
+    init_content = File.read(init_path)
+    yml_content = File.read(yml_path)
+
+    ::DogBiscuits::Terms.constants.each do |term|
+      t = term.to_s
+      term_string = "Qa::Authorities::Local.register_subauthority('#{t.gsub('Terms', '').underscore.downcase}', 'DogBiscuits::Terms::#{t}')"
+      unless init_content.include? term_string
+        inject_into_file init_path, after: '# include Terms' do
+          "\n#{term_string}"
+        end
+      end
+      next if yml_content.include? t
+      inject_into_file yml_path, after: '# authorities' do
+        "\n#{t.gsub('Terms', '').underscore.pluralize}: \"\""
+      end
+    end
+  end
+
+  def authority_service
+    template('authority_service.rb.erb', 'app/services/authority_service.rb')
+  end
+
+  def copy_concerns
+    directory 'app/services/concerns', 'app/services/concerns'
+  end
+end

data/lib/generators/dog_biscuits/catalog_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class DogBiscuits::CatalogGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+         1. Adds a new catalog_controller.rb
+       '
+
+  def banner
+    say_status("info", "Generating catalog_controller.rb", :blue)
+  end
+
+  def create_catalog
+    copy_file 'app/controllers/catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+  end
+end

data/lib/generators/dog_biscuits/dates_generator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class DogBiscuits::DatesGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator .
+  1. configures the date_picker, if config.date_picker is true;
+       it adds a form partial for all dates listed in config.date_picker_dates.
+  2. Configures the date_range in blacklight, if config.date_range is true.
+       '
+
+  def banner
+    say_status("info", "Configuring the date_picker and date_range", :blue)
+    say_status("info", "date_picker is disabled and will not be installed", :blue) unless DogBiscuits.config.date_picker
+    say_status("info", "date_range is disabled and will not be installed", :blue) unless DogBiscuits.config.date_range
+  end
+
+  # rubocop:disable Style/GuardClause
+  def date_picker
+    if DogBiscuits.config.date_picker
+
+      gem 'bootstrap-datepicker-rails'
+
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+
+      # insert into application.css
+      css = '*= require bootstrap-datepicker'
+      unless File.read('app/assets/stylesheets/application.css').include? css
+        inject_into_file 'app/assets/stylesheets/application.css', before: "*= require_self" do
+          "#{css}\n"
+        end
+      end
+
+      # insert into application.js
+      js = '//= require bootstrap-datepicker'
+      unless File.read('app/assets/javascripts/application.js').include? js
+        inject_into_file 'app/assets/javascripts/application.js', after: "//= require_tree ." do
+          "\n #{js}"
+        end
+      end
+
+      DogBiscuits.config.date_picker_dates.each do |date|
+        copy_file '_date_template.html.erb', "app/views/records/edit_fields/_#{date}.html.erb"
+      end
+    end
+  end
+
+  def date_range
+    if DogBiscuits.config.date_range
+      
+      gem "blacklight_range_limit"
+      
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+      generate 'blacklight_range_limit:install'
+      copy_file 'config/initializers/catalog_search_builder_overrides.rb', 'config/initializers/catalog_search_builder_overrides.rb'
+    end
+  end
+
+
+  # In Hyku, the blacklight_range_limit javascript inserts jquery, this causes other js to fail cos of multiple loads
+  #  (eg. add work modal doesn't work)
+  # To fix this, remove the standard insert from blacklight_range_limit to remove jquery
+  #   and add the require statements individually
+  #   do this earlier in the file because in production, the blacklight_range_limit js doesn't work if it's at the bottom
+  # This is a bit ugly and fragile.
+  def date_range_js
+    if File.exist?('config/initializers/version.rb') && File.read('config/initializers/version.rb').include?('Hyku')
+      unless File.read('app/assets/javascripts/application.js').include? "//= require 'blacklight_range_limit'\n// Moved the Hyku JS *above* the Hyrax JS"
+        rangejs = "// For blacklight_range_limit built-in JS, if you don't want it you don't need\n"
+        rangejs += "// this:\n"
+        rangejs += "//= require 'blacklight_range_limit'"
+
+        rangejs_altered = "// For blacklight_range_limit built-in JS, if you don't want it you don't need\n"
+        rangejs_altered += "// this:\n"
+        rangejs_altered += "// require 'blacklight_range_limit'\n"
+
+        rangejs_new = "\n//= require 'flot/jquery.flot.js'\n"
+        rangejs_new += "//= require 'flot/jquery.flot.selection.js'\n"
+        rangejs_new += "//= require 'bootstrap-slider'\n"
+        rangejs_new += "//= require 'blacklight_range_limit/range_limit_distro_facets.js'\n"
+        rangejs_new += "//= require 'blacklight_range_limit/range_limit_shared.js'\n"
+        rangejs_new += "//= require 'blacklight_range_limit/range_limit_slider.js'\n\n"
+
+        gsub_file 'app/assets/javascripts/application.js', rangejs, rangejs_altered
+
+        inject_into_file 'app/assets/javascripts/application.js', before: "// Moved the Hyku JS *above* the Hyrax JS" do
+          rangejs_new
+        end
+      end
+    end
+  end
+  # rubocop:enable Style/GuardClause
+end

data/lib/generators/dog_biscuits/generate_all_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class DogBiscuits::GenerateAllGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+  1. Runs the work generator for selected models configured in `config/initializers/dog_biscuits.rb`
+  2. Runs the catalog_controller generator
+  3. Runs the locales generator
+  4. Runs the schema_org generator
+       '
+
+  class_option :skipmodel, type: :boolean, default: false
+
+  def banner
+    say_status("info", "Re-generating catalog_controller, locales, attribute_rows and schema_org", :blue)
+  end
+
+  def generate_works
+    DogBiscuits.config.selected_models.each do |model|
+      if options[:skipmodel]
+        generate 'dog_biscuits:work', "#{model} --skipmodel -f"
+      else
+        generate 'dog_biscuits:work', "#{model} -f"
+      end
+    end
+  end
+end

data/lib/generators/dog_biscuits/imagify_generator.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/model_helpers'
+
+class DogBiscuits::ImagifyGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::ModelHelpers
+  source_root File.expand_path('../templates', __FILE__)
+
+  class_option :skipmodel, type: :boolean, default: false
+
+  desc '
+This generator makes the following changes to your application:
+    1. If this is a Hyku application, enables UV / IIIF
+       '
+
+  def banner
+    say_status("info", "Enabling UV / IIIF support for #{class_name}", :blue)
+
+    if class_name == 'All'
+      @models = DogBiscuits.config.selected_models.map(&:underscore)
+    else
+      if DogBiscuits.config.selected_models.include? class_name
+        @models = [class_name.underscore]
+      else
+        say_status("error", "UNSUPPORTED MODEL. SUPPORTED MODELS ARE: #{DogBiscuits.config.available_models.collect { |m| m }.join(', ')}", :red)
+        exit 0
+      end
+    end
+  end
+
+  # If this is a Hyku app, enable IIIF / UV rendering
+  def image_ify_hyku
+    @models.each do |model|
+      next unless File.exist?('config/initializers/version.rb') && File.read('config/initializers/version.rb').include?('Hyku')
+      model_injection = "  include HasRendering"
+      unless File.read("app/models/#{model}.rb").include? model_injection
+        inject_into_file "app/models/#{model}.rb", after: 'WorkBehavior' do
+          "\n#{model_injection}"
+        end
+      end
+
+      # add 'rendering_ids' to the form
+      form_injection = "self.terms += [:rendering_ids]"
+      form_injection += "\n\n    def secondary_terms"
+      form_injection += "\n       super - [:rendering_ids]"
+      form_injection += "\n    end"
+      gsub_file "app/forms/hyrax/#{model}_form.rb", /self\.terms \+\= \[\]/, form_injection
+
+      # change from WorkShowPresenter to ManifestEnabledWorkShowPresente
+      presenter_injection = "Hyku::ManifestEnabledWorkShowPresenter"
+      gsub_file "app/presenters/hyrax/#{model}_presenter.rb", /Hyrax::WorkShowPresenter/, presenter_injection
+
+      # add Hyku::IIIFManifest to the controllers
+      controller_injection = "\n\n    include Hyku::IIIFManifest"
+      unless File.read("app/controllers/hyrax/#{model.pluralize}_controller.rb").include? controller_injection
+        inject_into_file "app/controllers/hyrax/#{model.pluralize}_controller.rb", after: "::#{class_name}\n" do
+          controller_injection
+        end
+      end
+
+      # add all properties to the delegates block of Hyku::ManifestEnabledWorkShowPresenter
+      delegates = DogBiscuits.config.all_properties - DogBiscuits.config.base_properties
+      gsub_file 'app/presenters/hyku/manifest_enabled_work_show_presenter.rb', /delegate :extent/, "delegate :#{delegates.join(', :')}, :extent"
+    end
+  end
+end

data/lib/generators/dog_biscuits/install_generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class DogBiscuits::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+         1. Adds dog_biscuits initializer and config
+         2. Includes DogBiscuits::ExtendedSolrDocument in the SolrDocument
+         3. Runs the authorities, locales and schema_org generators
+         4. Adds various new files into app/
+         5. Runs the dates generator if date_picker or date_range are true
+       '
+
+  def banner
+    say_status("info", "Generating DogBiscuits installation", :blue)
+  end
+
+  def create_dog_biscuits
+    init_path = 'config/initializers/dog_biscuits.rb'
+    yml_path = 'config/dog_biscuits.yml'
+
+    copy_file 'config/dog_biscuits.yml', yml_path unless File.exist?(yml_path) && !options[:force]
+    copy_file 'config/initializers/dog_biscuits.rb', init_path unless File.exist?(init_path) && !options[:force]
+  end
+
+  # copy all new files in app
+  def create_app
+    directory 'app', 'app'
+  end
+
+  def update_initializer
+    gsub_file 'config/initializers/dog_biscuits.rb', /#   Available models are:/, "#   Available models are: #{DogBiscuits.config.available_models.join(', ')}"
+  end
+
+  def update_solr_document
+    solr_doc = 'app/models/solr_document.rb'
+    unless solr_doc.include? 'DogBiscuits::ExtendedSolrDocument'
+      inject_into_file solr_doc, after: 'include Hyrax::SolrDocumentBehavior' do
+        "\n  include DogBiscuits::ExtendedSolrDocument"
+      end
+    end
+  end
+
+  def create_authorities
+    generate 'dog_biscuits:authority'
+  end
+
+  def create_helpers
+    db_injection = '  include ::DogBiscuitsHelper'
+    unless File.read('app/helpers/hyrax_helper.rb').include? db_injection
+      inject_into_file 'app/helpers/hyrax_helper.rb', after: "Hyrax::HyraxHelperBehavior\n" do
+        "#{db_injection}\n"
+      end
+    end
+  end
+  
+  # Make sure range is in place, if we're running install again, it could remove it
+  def generate_dates
+    if DogBiscuits.config.date_range || DogBiscuits.config.date_picker
+      generate('dog_biscuits:dates')
+    end
+  end
+  
+  # Remove all blacklight labels from hyrax locales; we're going to re-add them below
+  def wipe_hyrax_locales
+    Dir.entries('config/locales').select { |file| file.start_with?('hyrax.') }.each do |locale|
+      gsub_file "config/locales/#{locale}", /        index:(.*)        show:/m, "        index:\n        show:"
+      gsub_file "config/locales/#{locale}", /        facet:(.*)        index:/m, "        facet:\n        index:"
+      gsub_file "config/locales/#{locale}", /        show:(.*)  hyrax:/m, "        show:\n  hyrax:"
+    end
+  end
+  
+  def generate_locales
+    generate 'dog_biscuits:locales'
+  end
+  
+  def create_schema_org
+    generate 'dog_biscuits:schema_org'
+  end
+
+end

data/lib/generators/dog_biscuits/locales_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class DogBiscuits::LocalesGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator can be run for an existing Model, or for All models (with All).
+This generator makes the following changes to your application
+  where information is available in property_mappings:
+    1. Injects labels and help_text into the en locales.
+       '
+
+  def banner
+    say_status("info", "Generating locales", :blue)
+  end
+
+  def create_dog_biscuits_locale
+    template('dog_biscuits.en.yml.erb', 'config/locales/dog_biscuits.en.yml')
+  end
+end

data/lib/generators/dog_biscuits/schema_org_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class DogBiscuits::SchemaOrgGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+  1. Creates a schema_org.yml file in ./config
+  2. Injects schema_org metadata for all properties
+    where this information is configured in property_mappings
+       '
+
+  def banner
+    say_status("info", "Generating schema_org.yml", :blue)
+  end
+
+  def create_schema_org
+    template('schema_org.yml.erb', 'config/schema_org.yml')
+  end
+end