devise-foundation-views 0.1.0 → 1.0.1

data/app/views/devise_slim/sessions/new.html.slim

@@ -1,19 +1,20 @@
-= foundation_devise_error_messages!
-.large-3.large-centered.columns
-  .login-box
-    .row
-      .large-12.columns
-        = form_for(resource, as: resource_name, url: session_path(resource_name)) do |f|
-          .row
-            h5.text-center= t('.sign_in', :default => "Sign in")
-          .row
-            = f.email_field :email, autofocus: true, class: "large-12 columns", placeholder: "Email"
-          .row
-            = f.password_field :password, autocomplete: "off", class: "large-12 columns", placeholder: "Password"
-          - if devise_mapping.rememberable?
-            .row
+= render layout: "devise/shared/foundation_layout", locals: { title: t(".sign_in", default: "Log in") } do
+  = form_for(resource, as: resource_name, url: session_path(resource_name)) do |f|
+    = render "devise/shared/error_messages", resource: resource
+    .grid-x.grid-padding-x
+      .cell
+        = f.label :email
+        = f.email_field :email, autofocus: true, autocomplete: "email"
+      .cell
+        = f.label :password
+        = f.password_field :password, autocomplete: "current-password"
+      - if devise_mapping.rememberable?
+        .cell
+          .grid-x.align-middle
+            .cell.shrink
               = f.check_box :remember_me
+            .cell.auto
               = f.label :remember_me
-          .row
-            = f.submit  t('.sign_in', :default => "Sign in"), class: "button expand large-12 large-centered columns"
-      = render "devise/shared/links"
+      .cell
+        = f.submit t(".sign_in", default: "Log in"), class: "button expanded"
+  = render "devise/shared/links"

data/app/views/devise_slim/shared/_error_messages.html.slim

@@ -0,0 +1,9 @@
+- if resource.errors.any?
+  #error_explanation.callout.alert data-closable=true role="alert"
+    h2
+      = I18n.t("errors.messages.not_saved", count: resource.errors.count, resource: resource.class.model_name.human.downcase)
+    ul.no-bullet
+      - resource.errors.full_messages.each do |message|
+        li= message
+    button.close-button aria-label=t("devise.shared.error_messages.close", default: "Dismiss alert") type="button" data-close=true
+      span aria-hidden="true" ×

data/app/views/devise_slim/shared/_foundation_layout.html.slim

@@ -0,0 +1,7 @@
+.grid-container.devise-foundation-views
+  .grid-x.grid-padding-x.align-center
+    .medium-10.large-7.cell
+      .devise-form-card
+        - if local_assigns[:title].present?
+          h2.text-center.devise-form-card__title= title
+        = yield

data/app/views/devise_slim/shared/_links.html.slim

@@ -1,19 +1,20 @@
-- if controller_name != 'sessions'
-  = link_to t(".sign_in", :default => "Sign in"), new_session_path(resource_name)
-  br/
-- if devise_mapping.registerable? && controller_name != 'registrations'
-  = link_to t(".sign_up", :default => "Sign up"), new_registration_path(resource_name)
-  br/
-- if devise_mapping.recoverable? && controller_name != 'passwords'
-  = link_to t(".forgot_your_password", :default => "Forgot your password?"), new_password_path(resource_name)
-  br/
-- if devise_mapping.confirmable? && controller_name != 'confirmations'
-  = link_to t('.didn_t_receive_confirmation_instructions', :default => "Didn't receive confirmation instructions?"), new_confirmation_path(resource_name)
-  br/
-- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks'
-  = link_to t('.didn_t_receive_unlock_instructions', :default => "Didn't receive unlock instructions?"), new_unlock_path(resource_name)
-  br/
-- if devise_mapping.omniauthable?
-  - resource_class.omniauth_providers.each do |provider|
-    = link_to t('.sign_in_with_provider', :provider => provider.to_s.titleize, :default => "Sign in with #{provider.to_s.titleize}"), omniauth_authorize_path(resource_name, provider)
-    br/
+.devise-links.text-center
+  - if controller_name != 'sessions'
+    = link_to t(".sign_in", default: "Log in"), new_session_path(resource_name)
+    br
+  - if devise_mapping.registerable? && controller_name != 'registrations'
+    = link_to t(".sign_up", default: "Sign up"), new_registration_path(resource_name)
+    br
+  - if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations'
+    = link_to t(".forgot_your_password", default: "Forgot your password?"), new_password_path(resource_name)
+    br
+  - if devise_mapping.confirmable? && controller_name != 'confirmations'
+    = link_to t(".didn_t_receive_confirmation_instructions", default: "Didn't receive confirmation instructions?"), new_confirmation_path(resource_name)
+    br
+  - if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks'
+    = link_to t(".didn_t_receive_unlock_instructions", default: "Didn't receive unlock instructions?"), new_unlock_path(resource_name)
+    br
+  - if devise_mapping.omniauthable?
+    - resource_class.omniauth_providers.each do |provider|
+      = button_to t(".sign_in_with_provider", provider: OmniAuth::Utils.camelize(provider), default: "Sign in with #{OmniAuth::Utils.camelize(provider)}"), omniauth_authorize_path(resource_name, provider), data: { turbo: false }, class: "button hollow expanded"
+      br

data/app/views/devise_slim/unlocks/new.html.slim

@@ -1,14 +1,10 @@
-= foundation_devise_error_messages!
-.large-3.large-centered.columns
-  .login-box
-    .row
-      .large-12.columns
-        = form_for(resource, :as => resource_name, :url => unlock_path(resource_name), :html => { :method => :post}) do |f|
-          .row
-            h5.text-center= t('.resend_unlock_instructions', :default => "Resend unlock instructions")
-          .row
-            = f.email_field :email, autofocus: true, class: "large-12 columns", placeholder: "Email"
-          .row
-            = f.submit t('.resend_unlock_instructions', :default => "Resend unlock instructions"), class: "button expand large-12 large-centered columns"
-      = render "devise/shared/links"
-
+= render layout: "devise/shared/foundation_layout", locals: { title: t(".resend_unlock_instructions", default: "Resend unlock instructions") } do
+  = form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f|
+    = render "devise/shared/error_messages", resource: resource
+    .grid-x.grid-padding-x
+      .cell
+        = f.label :email
+        = f.email_field :email, autofocus: true, autocomplete: "email"
+      .cell
+        = f.submit t(".resend_unlock_instructions", default: "Resend unlock instructions"), class: "button expanded"
+  = render "devise/shared/links"

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "devise-foundation-views"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/devise-foundation-views.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+# frozen_string_literal: true
+
+require_relative "lib/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "devise-foundation-views"
@@ -9,25 +8,37 @@ Gem::Specification.new do |spec|
   spec.authors       = ["ethi"]
   spec.email         = ["ethirajsrinivasan@gmail.com"]
 
-  spec.summary       = "Devise views based on foundation framework"
-  spec.description   = "Devise views based on foundation framework"
+  spec.summary       = "Devise views based on Foundation 6"
+  spec.description   = "A Rails engine providing Foundation 6 styled Devise views (aligned with current Devise templates) in ERB, HAML, and Slim"
   spec.homepage      = "https://github.com/ethirajsrinivasan/devise-foundation-views"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/ethirajsrinivasan/devise-foundation-views",
+    "bug_tracker_uri" => "https://github.com/ethirajsrinivasan/devise-foundation-views/issues",
+    "changelog_uri" => "https://github.com/ethirajsrinivasan/devise-foundation-views/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/ethirajsrinivasan/devise-foundation-views/blob/master/README.md",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 1.9.3'
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec'
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.add_runtime_dependency "devise", ">= 4.9", "< 6.0"
+  spec.add_runtime_dependency "railties", ">= 6.0", "< 9.0"
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "bundler-audit", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 1.50"
 end

data/lib/devise-foundation-views.rb

@@ -1,28 +1,25 @@
-require 'rails'
-require 'devise_foundation_views_helper'
-module DeviseFoundationViews
-  class Engine < ::Rails::Engine
-  end
+# frozen_string_literal: true
 
-  class Railtie < ::Rails::Railtie
-    initializer 'rails-devise-foundation-views' do |app|
-      DeviseFoundationViews::Railtie.instance_eval do
-        pattern = pattern_from app.config.i18n.available_locales
+require "rails"
+require "devise_foundation_views_helper"
+require "devise_layout_helper"
 
-        files = Dir[File.join(File.dirname(__FILE__), '../locales', "#{pattern}.yml")]
-        I18n.load_path.concat(files)
+module DeviseFoundationViews
+  class Engine < Rails::Engine
+  end
 
-        ActionView::Base.send :include, DeviseFoundationViewsHelper
-      end
+  class Railtie < Rails::Railtie
+    initializer "devise-foundation-views" do |app|
+      pattern = DeviseFoundationViews::Railtie.pattern_from(app.config.i18n.available_locales)
+      files = Dir[File.join(__dir__, "../locales", "#{pattern}.yml")]
+      I18n.load_path.concat(files)
+      ActionView::Base.include DeviseFoundationViewsHelper
+      ActionView::Base.include DeviseLayoutHelper
     end
 
-    protected
-
     def self.pattern_from(args)
-      array = Array(args || [])
-      array.blank? ? '*' : "{#{array.join ','}}"
+      array = Array(args)
+      array.blank? ? "*" : "{#{array.join(',')}}"
     end
   end
 end
-
-

data/lib/devise_foundation_views_helper.rb

@@ -1,22 +1,8 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 
 module DeviseFoundationViewsHelper
+  # Deprecated: use <%= render "devise/shared/error_messages", resource: resource %> in views.
   def foundation_devise_error_messages!
-    return '' if resource.errors.empty?
-
-    messages = resource.errors.full_messages.map { |msg| content_tag(:li, msg) }.join
-    sentence = I18n.t('errors.messages.not_saved',
-      count: resource.errors.count,
-      resource: resource.class.model_name.human.downcase)
-
-    html = <<-HTML
-    <div data-alert class="alert-box alert radius">
-      <h5>#{sentence}</h5>
-      <ul>#{messages}</ul>
-      <a href="#" class="close">&times;</a>
-    </div>
-    HTML
-
-    html.html_safe
+    render_to_string(partial: "devise/shared/error_messages", locals: { resource: resource })
   end
 end

data/lib/devise_layout_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DeviseLayoutHelper
+  def devise_page_title
+    return content_for(:title) if content_for?(:title)
+
+    case [controller_name, action_name]
+    when %w[sessions new] then "Sign in"
+    when %w[registrations new] then "Sign up"
+    when %w[registrations edit] then "Edit account"
+    when %w[passwords new] then "Forgot password"
+    when %w[passwords edit] then "Change password"
+    when %w[confirmations new] then "Resend confirmation"
+    when %w[unlocks new] then "Resend unlock"
+    else "Account"
+    end
+  end
+end

data/lib/generators/devise/views/foundation_layout/foundation_layout_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Devise
+  module Views
+    class FoundationLayoutGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Copy a centered Devise-only layout and hook it up in ApplicationController"
+
+      def copy_layout
+        template "layouts/devise.html.erb", "app/views/layouts/devise.html.erb"
+      end
+
+      def show_application_controller_note
+        say "\nAdd to ApplicationController:\n", :yellow
+        say <<~RUBY, :green
+          layout :layout_for_controller
+
+          private
+
+          def layout_for_controller
+            devise_controller? ? "devise" : "application"
+          end
+        RUBY
+        say "\nIn application.css (Sprockets, no Sass required):\n", :yellow
+        say <<~CSS, :green
+          *= require devise_foundation_views
+          *= require devise_foundation_layout
+        CSS
+        say "\nEnsure Foundation 6 CSS is loaded in the devise layout.\n", :yellow
+      end
+    end
+  end
+end

data/lib/generators/devise/views/foundation_layout/templates/layouts/devise.html.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en" class="devise-layout-root">
+  <head>
+    <title><%%= devise_page_title %></title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <%%= csrf_meta_tags %>
+    <%%= csp_meta_tag %>
+    <!-- Load Foundation 6 in your app (CDN, npm, or foundation-rails) -->
+    <%%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%%= stylesheet_link_tag "devise_foundation_views", "data-turbo-track": "reload" %>
+    <%%= stylesheet_link_tag "devise_foundation_layout", "data-turbo-track": "reload" %>
+  </head>
+  <body class="devise-layout">
+    <%% if notice.present? %>
+      <div class="grid-container" style="padding-top: 1rem;">
+        <div class="callout success" data-closable>
+          <%%= notice %>
+          <button class="close-button" type="button" data-close aria-label="Dismiss">&times;</button>
+        </div>
+      </div>
+    <%% end %>
+    <%% if alert.present? %>
+      <div class="grid-container" style="padding-top: 1rem;">
+        <div class="callout alert" data-closable>
+          <%%= alert %>
+          <button class="close-button" type="button" data-close aria-label="Dismiss">&times;</button>
+        </div>
+      </div>
+    <%% end %>
+
+    <main class="devise-layout__main<%%= " devise-layout__main--tall" if controller_name == "registrations" && action_name == "edit" %>">
+      <%%= yield %>
+    </main>
+
+    <%%= javascript_include_tag "application", "data-turbo-track": "reload" %>
+  </body>
+</html>

data/lib/generators/devise/views/foundation_templates/foundation_templates_generator.rb

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 module Devise
   module Views
     class FoundationTemplatesGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../../../../../app/views', __FILE__)
-      argument :template_name, :type => :string, :default => "devise"
+      source_root File.expand_path("../../../../../app/views", __dir__)
+      argument :template_name, type: :string, default: "devise"
+
       def copy_views
-         directory(template, Rails.root.join("app", "views", "devise"))
+        directory(template, Rails.root.join("app", "views", "devise"))
       end
 
       private
+
       def template
-      	case template_name
-      	when "devise"
-      		"devise"
-      	when "slim"
-      	  "devise_slim"
-      	when "haml"
-      	  "devise_haml"
-      	else
-      		raise "Template not available for #{template_name}"
-      	end
-      end		
-		end
+        case template_name
+        when "devise"
+          "devise"
+        when "slim"
+          "devise_slim"
+        when "haml"
+          "devise_haml"
+        else
+          raise "Template not available for #{template_name}. Use: devise, slim, or haml."
+        end
+      end
+    end
   end
 end

data/lib/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseFoundationViews
-  VERSION = "0.1.0"
+  VERSION = "1.0.1"
 end

data/locales/uk.yml

@@ -20,7 +20,7 @@ uk:
         action: "Розблокувати обліковий запис"
         greeting: "Привіт \"%{recipient}!\""
         instruction: "Натисніть на посилання для активації облікового запису:"
-        message: "Ваш обліковий запис був заблокований у зв\'язку з перевищенням ліміту невдалих спроб входу."
+        message: "Ваш обліковий запис був заблокований у зв'язку з перевищенням ліміту невдалих спроб входу."
         subject: "Інструкції для розблокування облікового запису"
     passwords:
       new: