How do I add authentication to High Voltage pages?

Override the default controller by creating a custom PagesController, include HighVoltage::StaticPage, and add a before_action like authenticate_user!. This allows integrating Devise or other auth gems seamlessly.

High Voltage vs creating custom controllers for static pages in Rails?

High Voltage saves time by automating routing and reducing boilerplate, but custom controllers offer more control for complex logic. Choose High Voltage for simplicity, custom controllers for heavy customization.

How to change the layout for specific High Voltage pages?

In a custom PagesController, use a method like layout_for_page to conditionally set layouts based on params[:id]. For example, set 'home' layout for the homepage and 'application' for others.

Can High Voltage handle dynamic content or database queries?

No, it's designed for static pages only. For dynamic content, you must override the controller or use separate Rails actions, which can complicate the setup.

How to integrate High Voltage with Rails internationalization (I18n)?

Disable default routes, use scoped routes with a locale parameter, and ensure locale files are set up. High Voltage pages can then use t() helpers for translated content.

Open-Awesome

High Voltage

MITRubyv4.0.0

A Rails engine for easily including static pages like 'About us' or marketing content in your application.

Visit Website GitHub

3.2k stars149 forks0 contributors

What is High Voltage?

High Voltage is a Ruby gem and Rails engine designed to simplify the inclusion of static pages in Ruby on Rails applications. It automatically handles routing and rendering for pages like 'About us', marketing content, or directions by treating them as view templates stored in a designated directory. This eliminates the need to manually configure routes and controllers for static content.

Target Audience

Rails developers who need to add static content pages to their applications without creating custom controllers and routes for each page. It's particularly useful for projects requiring marketing sites, informational pages, or any non-dynamic content integrated into a Rails app.

Value Proposition

Developers choose High Voltage because it reduces boilerplate code by providing a convention-based approach to static pages, integrates seamlessly with Rails' routing and view system, and offers flexibility through configuration and override options when custom behavior is needed.

Overview

Easily include static pages in your Rails app.

Use Cases

Best For

Adding marketing or informational pages to a Rails application
Managing static content like 'About', 'Contact', or 'FAQ' pages
Creating a simple CMS for static content within Rails
Handling nested static page structures with clean URLs
Integrating static pages with Rails authentication or custom layouts
Building sitemaps for static content using page IDs

Not Ideal For

Applications requiring a content management system (CMS) with a user-friendly admin interface for non-technical editors
Projects built on frameworks other than Ruby on Rails or needing cross-platform static page handling
Teams seeking actively maintained gems with frequent feature additions and community-driven enhancements

Pros & Cons

Pros

Automatic URL Mapping

Automatically routes URLs to view files in `app/views/pages`, including support for nested directories, eliminating manual route configuration for static content.

Rails Convention Integration

Seamlessly works with Rails features like `content_for` for page titles and I18n for localization, fitting naturally into existing Rails workflows.

Flexible Override Options

Allows custom controllers for adding authentication, different layouts, or advanced page-finding logic, providing adaptability beyond static defaults.

Simple Setup and Usage

With minimal configuration, pages are created as view templates and linked using `page_path`, reducing boilerplate code for static pages.

Cons

Maintenance Mode Stagnation

The gem is only receiving bug fixes and compatibility updates, with no new features planned, which may limit its evolution for modern needs.

Static-Only Limitation

Designed exclusively for static pages; integrating dynamic content requires complex overrides or separate solutions, adding development overhead.

Caching Implementation Burden

Built-in caching was removed, forcing developers to rely on Rails caching mechanisms manually, which can be an extra step for performance optimization.

Frequently Asked Questions

Related Projects

Bridgetown

A next-generation progressive site generator & fullstack framework, powered by Ruby

Stars1,351

Forks129

Last commit4 days ago

Awesome Jekyll

A collection of awesome Jekyll goodies (tools, templates, plugins, guides, etc.)

Stars594

Forks45

Last commit5 years ago

Photish

Fast, simple, configurable photo portfolio website generator

Stars151

Forks11