Progress on Generators.

Author: gkellogg

lib/generators/blacklight/sparql/assets_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module Blacklight::Sparql
+  class Assets < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def assets
+      copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
+
+      return if has_blacklight_assets?
+
+      marker = if turbolinks?
+                 '//= require turbolinks'
+               else
+                 '//= require jquery_ujs'
+               end
+
+      insert_into_file "app/assets/javascripts/application.js", :after => marker do
+<<-EOF
+//
+// Required by Blacklight
+//= require blacklight/blacklight
+EOF
+      end
+
+    end
+
+    private
+
+    def turbolinks?
+      @turbolinks ||= IO.read("app/assets/javascripts/application.js").include?('turbolinks')
+    end
+
+    def has_blacklight_assets?
+      IO.read("app/assets/javascripts/application.js").include?('blacklight/blacklight')
+    end
+  end
+end

lib/generators/blacklight/sparql/controller_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Blacklight::Sparql
+  class ControllerGenerator < Rails::Generators::Base
+    
+    source_root File.expand_path('../templates', __FILE__)
+    
+    argument     :controller_name  , type: :string , default: "catalog"
+
+    desc <<-EOS
+      This generator makes the following changes to your application:
+       1. Injects behavior into your user application_controller.rb
+       2. Creates a Blacklight::Catalog-based controller
+       3. Adds routes for your controller
+    EOS
+
+    # Add Blacklight to the application controller
+    def inject_blacklight_controller_behavior
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  # Adds a few additional behaviors into the application controller\n" \
+        "  include Blacklight::Controller\n" \
+        "  layout 'blacklight'\n\n"
+      end
+    end
+    
+    # Generate blacklight catalog controller
+    def create_blacklight_catalog
+      template "catalog_controller.rb", "app/controllers/#{controller_name}_controller.rb"
+    end
+
+    def inject_blacklight_routes
+      route <<-EOF
+  concern :searchable, Blacklight::Routes::Searchable.new
+
+  resource :catalog, only: [:index], as: 'catalog', path: '/catalog', controller: 'catalog' do
+    concerns :searchable
+  end
+      EOF
+    end
+  end
+end

lib/generators/blacklight/sparql/document_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'rails/generators'
+
+module Blacklight::Sparql
+  class DocumentGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :model_name, :type => :string , :default => "sparql_document"
+
+    desc <<-EOS
+      This generator makes the following changes to your application:
+       1. Creates a blacklight document in your /app/models directory
+    EOS
+
+    def create_sparql_document
+      template "sparql_document.rb", "app/models/#{model_name}.rb"
+    end
+
+  end
+end

lib/generators/blacklight/sparql/install_generator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+module Blacklight::Sparql
+  class Install < Rails::Generators::Base
+    
+    source_root File.expand_path('../templates', __FILE__)
+    
+    argument     :model_name  , type: :string , default: "user"
+    argument     :controller_name, type: :string , default: "catalog"
+    argument     :document_name, type: :string , default: "sparql_document"
+    argument     :search_builder_name, type: :string , default: "search_builder"
+
+    class_option :devise      , type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
+
+    desc <<-EOS
+      This generator makes the following changes to your application:
+       1. Generates blacklight:models
+       2. Creates a number of public assets, including images, stylesheets, and javascript
+       3. Injects behavior into your user application_controller.rb
+       4. Adds Blacklight routes to your ./config/routes.rb
+
+      Thank you for Installing SparqLight.
+    EOS
+
+    def bundle_install
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+    end
+
+    # Copy all files in templates/public/ directory to public/
+    # Call external generator in AssetsGenerator, so we can
+    # leave that callable seperately too.
+    # FIXME: Could be blacklight:assets, as there's nothing different here for SPARQL
+    def copy_public_assets 
+      generate "blacklight:sparql:assets"
+    end
+    
+    def generate_blacklight_sparql_document
+      generate 'blacklight:sparql:document', document_name
+    end
+
+    def generate_search_builder
+      generate 'blacklight:sparql:search_builder', search_builder_name
+    end
+
+    def generate_blacklight_sparql_models
+      generate 'blacklight:sparql:models'
+    end
+
+    # FIXME: Could be blacklight:user, as there's nothing different here for SPARQL
+    def generate_blacklight_user
+
+      generator_args = [model_name]
+      if options[:devise]
+        generator_args << "--devise #{options[:devise]}"
+      end
+      
+      generate 'blacklight:sparql:user', generator_args.join(" ")
+    end
+
+    # FIXME: Could be blacklight:controller, as there's nothing different here for SPARQL
+    def generate_controller
+      generate 'blacklight:sparql:controller', controller_name
+    end
+    
+    def add_default_catalog_route
+      route("root to: \"#{controller_name}#index\"")
+    end
+
+    def add_sparqlight_configuration
+
+      insert_into_file "config/application.rb", :after => "require 'rails/all'" do <<-EOF
+
+        require 'blacklight/sparql'
+EOF
+      end
+    end
+
+    def add_sass_configuration
+
+      insert_into_file "config/application.rb", :after => "config.assets.enabled = true" do <<EOF
+
+      # Default SASS Configuration, check out https://github.com/rails/sass-rails for details
+      config.assets.compress = !Rails.env.development?
+EOF
+      end
+    end
+
+    def inject_blacklight_i18n_strings
+      copy_file "blacklight.en.yml", "config/locales/blacklight.en.yml"
+    end
+
+    def add_routes
+      route "mount Blacklight::Engine => '/'"
+    end
+  end
+end

lib/generators/blacklight/sparql/models_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Blacklight::Sparql
+  class ModelsGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc <<-EOS
+    This generator makes the following changes to your application:
+     1. Creates several database migrations if they do not exist in /db/migrate
+     2. Creates config/blacklight.yml with a default configuration
+    EOS
+
+    # Copy all files in templates/config directory to host config
+    def create_configuration_files
+      copy_file "config/blacklight.yml", "config/blacklight.yml"
+    end
+
+
+    # Setup the database migrations
+    def copy_migrations
+      rake "blacklight:sparql:install:migrations"
+    end
+
+    def add_routes
+      route <<-EOF
+
+  concern :exportable, Blacklight::Routes::Exportable.new
+
+  resources :sparql_documents, only: [:show], path: '/catalog', controller: 'catalog' do
+    concerns :exportable
+  end
+
+  resources :bookmarks do
+    concerns :exportable
+
+    collection do
+      delete 'clear'
+    end
+  end
+      EOF
+    end
+
+
+  end
+end

lib/generators/blacklight/sparql/search_builder_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'rails/generators'
+
+module Blacklight::Sparql
+  class SearchBuilderGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :model_name, :type => :string , :default => "search_builder"
+
+    desc <<-EOS
+    This generator makes the following changes to your application:
+     1. Creates a blacklight search builder in your /app/models directory
+    EOS
+    def create_search_builder
+      template "search_builder.rb", "app/models/#{model_name}.rb"
+    end
+
+  end
+end

lib/generators/blacklight/sparql/templates/alternate_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+class AlternateController < CatalogController  
+  configure_blacklight do |config|
+    config.index.thumbnail_method = :xyz
+  end
+
+  def xyz *args
+    view_context.image_tag "asdfg"
+  end
+  
+  helper_method :xyz
+
+end 

lib/generators/blacklight/sparql/templates/blacklight.en.yml

@@ -0,0 +1,3 @@
+en:
+  blacklight:
+    application_name: 'Blacklight'

lib/generators/blacklight/sparql/templates/blacklight.scss

@@ -0,0 +1,5 @@
+@import 'bootstrap-sprockets';
+
+@import 'bootstrap';
+
+@import 'blacklight/blacklight';