tailwind_views_generator 0.0.1

data/lib/generators/tailwind_views/devise_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module TailwindViews
+  module Generators
+    # Generator to run to add devise templates to the application
+    class DeviseGenerator < ::Rails::Generators::Base
+      include TailwindViewsGenerator::Helpers
+      hide!
+      desc 'Overwrite default devise views'
+      source_root ::File.expand_path('../../templates/devise', __dir__)
+
+      class_option :template_engine,    type: :string, default: 'erb', aliases: '-t', enum: %w[erb slim haml],
+                                        desc: 'Set template engine to generate the views with'
+
+      class_option :metatags,           type: :boolean, default: false, aliases: '-m',
+                                        desc: 'If views will assign pages title using metatags gem'
+
+      class_option :simpleform,         type: :boolean, default: false, aliases: '-sf',
+                                        desc: 'Enable SimpleForms for the form generating'
+
+      def install
+        template "#{file_template_location('confirmations/new')}.tt", "app/views/devise/confirmations/new.html.#{options[:template_engine]}", force: true
+        directory "#{options[:template_engine]}/mailer", 'app/views/devise/mailer', force: true
+
+        %i[edit new].map do |file|
+          template "#{file_template_location("passwords/#{file}")}.tt", "app/views/devise/passwords/#{file}.html.#{options[:template_engine]}", force: true
+          template "#{file_template_location("registrations/#{file}")}.tt", "app/views/devise/registrations/#{file}.html.#{options[:template_engine]}", force: true
+        end
+        template "#{file_template_location('sessions/new')}.tt", "app/views/devise/sessions/new.html.#{options[:template_engine]}", force: true
+        template "#{file_template_location('unlocks/new')}.tt", "app/views/devise/unlocks/new.html.#{options[:template_engine]}", force: true
+        directory "#{options[:template_engine]}/shared", 'app/views/devise/shared', force: true
+      end
+
+      private
+
+      def file_template_location(file_location = '')
+        return '' if file_location.blank?
+
+        # Depending if simpleform is to be used, it will return a path similar to one of the following:
+        # => slim/unlocks/new.html.slim || simple_form/slim/unlocks/new.html.slim
+        "#{simple_path}#{options[:template_engine]}/#{file_location}.html.#{options[:template_engine]}"
+      end
+
+      # If simpleform is going ot be used with the forms return a simple_form path
+      def simple_path
+        options[:simpleform] ? 'simple_form/' : ''
+      end
+    end
+  end
+end

data/lib/generators/tailwind_views/install_generator.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'devise_generator'
+require_relative '../../tailwind_views_generator/helpers'
+
+module TailwindViews
+  module Generators
+    # Generate scaffolds and views for tailwind
+    class InstallGenerator < ::Rails::Generators::Base
+      include TailwindViewsGenerator::Helpers
+      desc 'Override default view scaffolding with Tailwind based scaffolds'
+      source_root ::File.expand_path('../../templates', __dir__)
+      class_option :template_engine,    type: :string, default: 'erb', aliases: '-t', enum: %w[erb slim haml],
+                                        desc: 'The template_engine to use for generating the applications views (Erb, Slim, HAML)'
+
+      # Boolean flags that can be flagged by adding to the generator call ie: --pagination or --metag_tags
+      class_option :devise,             type: :boolean, default: false,
+                                        desc: 'If views for devise will be required by the generator'
+
+      class_option :layout,             type: :boolean, default: false, aliases: '-l',
+                                        desc: 'Over-write your application layout file with a bootstrap based layout'
+
+      class_option :metatags,           type: :boolean, default: false, aliases: '-m',
+                                        desc: 'If views will assign pages title using metatags gem'
+
+      class_option :pagination,         type: :boolean, default: false, aliases: '-p',
+                                        desc: 'Toggle if pagination will be used with the index view/controller (based off of Pagy)'
+
+      class_option :simpleform,         type: :boolean, default: false, aliases: '-sf',
+                                        desc: 'Enable SimpleForms for the form generating'
+
+      class_option :skip_javascript,    type: :boolean, default: false,
+                                        desc: 'Skip adding javascript_include_tag or javascript_pack_tag to the layouts'
+
+      class_option :skip_turbolinks,    type: :boolean, default: false,
+                                        desc: 'Skip associating assets and views with turbolinks'
+
+      def copy_scaffold_views
+        %w[edit index show new].each do |file|
+          template("scaffolds/#{options[:template_engine]}/#{file}.html.#{options[:template_engine]}",
+                   "lib/templates/#{options[:template_engine]}/scaffold/#{file}.html.#{options[:template_engine]}",
+                   force: true)
+        end
+      end
+
+      def copy_form
+        if options[:simpleform]
+          copy_file("scaffolds/simple_form/_form.html.#{options[:template_engine]}",
+                    "lib/templates/#{options[:template_engine]}/scaffold/_form.html.#{options[:template_engine]}", force: true)
+        else
+          copy_file("scaffolds/#{options[:template_engine]}/_form.html.#{options[:template_engine]}",
+                    "lib/templates/#{options[:template_engine]}/scaffold/_form.html.#{options[:template_engine]}", force: true)
+        end
+      end
+
+      def copy_layout_views
+        return unless options[:layout]
+
+        template("layouts/application.html.#{options[:template_engine]}.tt",
+                 "app/views/layouts/application.html.#{options[:template_engine]}", force: true)
+      end
+
+      def copy_shared_views
+        %w[footer navigation].each do |template_file|
+          template("shared/#{template_file}/_#{template_file}.html.#{options[:template_engine]}.tt",
+                   "app/views/shared/_#{template_file}.html.#{options[:template_engine]}", force: true)
+        end
+      end
+
+      def copy_pagination_view
+        return unless options[:pagination]
+
+        copy_file("shared/pagination/_pagination.html.#{options[:template_engine]}",
+                  "app/views/shared/_pagination.html.#{options[:template_engine]}", force: true)
+      end
+
+      def inject_application_helpers
+        pagy_helper = (options[:pagination] ? 'include Pagy::Frontend' : '')
+        helper_str = <<~HELPER
+          #{pagy_helper}
+
+          FLASH_TYPE_HASH = { success: 'green', error: 'yellow', alert: 'red', notice: 'indigo' }.freeze
+
+          def alert_color(flash_type)
+            (FLASH_TYPE_HASH[flash_type.to_sym] || flash_type.to_s)
+          end
+
+          def flash_messages(_opts = [])
+            return '' unless flash.any?
+
+            # remove any blank devise timeout errors
+            flash.delete(:timedout)
+            flash.each do |msg_type, message|
+              # You don't need to create an empty alert message
+              next if message.blank? || message.to_s.length.zero?
+
+              concat(tag.div(class: "bg-\#{alert_color(msg_type)}-50 p-5 lg:w-full rounded border-l-4 border-\#{alert_color(msg_type)}-400 mb-5", role: 'alert') do
+                concat(tag.p(message, class: "text-sm text-\#{alert_color(msg_type)}-500"))
+              end)
+            end
+            nil
+          end
+
+          # for outputting an objects error messages
+          def errors_for(object)
+            return '' unless object.errors.any?
+
+            content_tag(:div, class: 'text-sm bg-red-50 rounded p-5 mb-5') do
+              concat(content_tag(:div, class: 'text-red-600 font-medium') do
+                concat "\#{pluralize(object.errors.count, 'error')} prohibited this \#{object.class.name.downcase} from being saved:"
+              end)
+              concat(content_tag(:ul, class: 'px-0 text-red-500 italic font-sm') do
+                object.errors.full_messages.each do |msg|
+                  concat content_tag(:li, msg, class: 'list-disc px-0 py-1 mx-4')
+                end
+              end)
+            end
+          end
+        HELPER
+
+        inject_into_file('app/helpers/application_helper.rb',
+                         optimize_indentation(helper_str, 2),
+                         after: "module ApplicationHelper\n",
+                         force: true)
+      end
+
+      def invoke_devise_generator
+        # Generate tailwind based devise views if devise is being used
+        invoke('tailwind_views:devise') if options[:devise]
+      end
+    end
+  end
+end

data/lib/tailwind_views_generator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'tailwind_views_generator/version'
+require 'rails'
+require_relative 'tailwind_views_generator/helpers'
+
+module TailwindViewsGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/tailwind_views_generator/helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TailwindViewsGenerator
+  module Helpers
+    # Return a cleaned up version of the name of the application being generated
+    # @return [String]
+    def app_name
+      @app_name ||= if Rails.version.to_f >= 6.0
+                      Rails.app_class.module_parent_name.demodulize.titleize
+                    else
+                      Rails.application.class.parent.to_s.titleize
+                    end
+    end
+  end
+end

data/lib/tailwind_views_generator/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TailwindViewsGenerator
+  MIN_RUBY_VERSION = '2.4.0'
+  VERSION = '0.0.1'
+end

data/lib/templates/devise/erb/confirmations/new.html.erb.tt

@@ -0,0 +1,25 @@
+<div class="md:mx-auto md:max-w-md overflow-hidden mx-0">
+  <div class="shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col justify-center bg-gray-50">
+    <h2 class="text-center text-xl text-black">
+<%- if options[:metatags] -%>
+      <%%%= title('Resend confirmation instructions') %>
+<%- else -%>
+      Resend confirmation instructions
+<%- end -%>
+    </h2>
+
+    <%%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
+      <%%= render 'devise/shared/error_messages', resource: resource %>
+
+      <div class="mb-4">
+        <%%= f.label :email, class: 'text-sm font-medium text-gray-600' %>
+        <%%= f.email_field :email, autofocus: true, autocomplete: "email", value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email), class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out' %>
+      </div>
+      <%%= f.submit "Resend confirmation instructions" %>
+
+      <%%= f.submit "Resend confirmation instructions" class: 'my-2 bg-blue-500 hover:bg-blue-700 text-white font-bold text-sm py-2 px-4 rounded w-full' %>
+    <%% end %>
+
+    <%%= render 'devise/shared/links' %>
+  </div>
+</div>

data/lib/templates/devise/erb/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,5 @@
+<p>Welcome <%= @email %>!</p>
+
+<p>You can confirm your account email through the link below:</p>
+
+<p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>

data/lib/templates/devise/erb/mailer/email_changed.html.erb

@@ -0,0 +1,7 @@
+<p>Hello <%= @email %>!</p>
+
+<% if @resource.try(:unconfirmed_email?) %>
+  <p>We're contacting you to notify you that your email is being changed to <%= @resource.unconfirmed_email %>.</p>
+<% else %>
+  <p>We're contacting you to notify you that your email has been changed to <%= @resource.email %>.</p>
+<% end %>

data/lib/templates/devise/erb/mailer/password_change.html.erb

@@ -0,0 +1,3 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>We're contacting you to notify you that your password has been changed.</p>

data/lib/templates/devise/erb/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has requested a link to change your password. You can do this through the link below.</p>
+
+<p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
+
+<p>If you didn't request this, please ignore this email.</p>
+<p>Your password won't change until you access the link above and create a new one.</p>

data/lib/templates/devise/erb/mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
+
+<p>Click the link below to unlock your account:</p>
+
+<p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>

data/lib/templates/devise/erb/passwords/edit.html.erb.tt

@@ -0,0 +1,33 @@
+<div class="md:mx-auto md:max-w-md overflow-hidden mx-0">
+  <div class=" shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col justify-center bg-gray-50">
+    <h2 class="text-center text-xl text-black">
+<%- if options[:metatags] -%>
+      <%%= title('Change your password') %>
+<%- else -%>
+      Change your password
+<%- end -%>
+    </h2>
+
+    <%%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
+      <%%= render 'devise/shared/error_messages', resource: resource %>
+      <%%= f.hidden_field :reset_password_token %>
+
+      <div class="mb-4">
+        <%%= f.label :password, "New password", class: 'text-sm font-medium text-gray-600' %>
+        <%% if @minimum_password_length %>
+          <em>(<%%= @minimum_password_length %> characters minimum)</em><br />
+        <%% end %>
+        <%%= f.password_field :password, autofocus: true, autocomplete: "new-password", class: 'text-sm font-medium text-gray-600' %>
+      </div>
+
+      <div class="mb-4">
+        <%%= f.label :password_confirmation, "Confirm new password", class: 'text-sm font-medium text-gray-600' %>
+        <%%= f.password_field :password_confirmation, autocomplete: "new-password", class: 'text-sm font-medium text-gray-600' %>
+      </div>
+
+      <%%= f.submit "Change my password" class: 'my-2 bg-blue-500 hover:bg-blue-700 text-white font-bold text-sm py-2 px-4 rounded w-full' %>
+    <%% end %>
+
+    <%%= render 'devise/shared/links' %>
+  </div>
+</div>

data/lib/templates/devise/erb/passwords/new.html.erb.tt

@@ -0,0 +1,23 @@
+<div class="md:mx-auto md:max-w-md overflow-hidden mx-0">
+  <div class=" shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col justify-center bg-gray-50">
+    <h2 class="text-center text-xl text-black">
+<%- if options[:metatags] -%>
+      <%%= title('Forgot your password?') %>
+<%- else -%>
+      Forget your password?
+<%- end -%>
+    </h2>
+
+    <%%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
+      <%%= render 'devise/shared/error_messages', resource: resource %>
+      <div class="mb-4">
+        <%%= f.label :email, class: 'block email optional text-sm font-medium text-gray-600' %>
+        <%%= f.email_field :email, autofocus: true, autocomplete: 'email', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+      <%%= f.submit 'Send me reset password instructions', class: 'my-2 bg-blue-500 hover:bg-blue-700 text-white font-bold text-sm py-2 px-4 rounded w-full' %>
+    <%% end %>
+
+    <%%= render 'devise/shared/links' %>
+  </div>
+</div>

data/lib/templates/devise/erb/registrations/edit.html.erb.tt

@@ -0,0 +1,53 @@
+<div class="md:mx-auto md:max-w-md overflow-hidden mx-0">
+  <div class=" shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col justify-center bg-gray-50">
+    <h2 class="text-center text-xl text-black">
+<%- if options[:metatags] -%>
+      <%%= title("Edit #{resource_name.to_s.humanize}") %>
+<%- else -%>
+      Edit <%%= resource_name.to_s.humanize %>
+<%- end -%>
+    </h2>
+    <hr class="my-5">
+
+    <%%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %>
+      <%%= render 'devise/shared/error_messages', resource: resource %>
+
+      <div class="mb-4">
+        <%%= f.label :email, class: 'block email text-sm font-medium text-gray-600' %>
+        <%%= f.email_field :email, autofocus: true, autocomplete: 'email', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+      <%% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+        <div>Currently waiting confirmation for: <%%= resource.unconfirmed_email %></div>
+      <%% end %>
+
+      <div class="mb-4">
+        <%%= f.label :password, class: 'block password text-sm font-medium text-gray-600' %>
+        <%%= f.password_field :password, autocomplete: 'new-password', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+        <p class="mt-2 text-grey-700 text-xs italic">Leave it blank if you don't want to change it</p>
+        <%% if @minimum_password_length %>
+          <br />
+          <em><%%= @minimum_password_length %> characters minimum</em>
+        <%% end %>
+      </div>
+
+      <div class="mb-4">
+        <%%= f.label :password_confirmation, class: 'block password text-sm font-medium text-gray-600' %>
+        <%%= f.password_field :password_confirmation, autocomplete: 'new-password', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+      <div class="mb-4">
+        <%%= f.label :current_password, class: 'block password text-sm font-medium text-gray-600' %>
+        <%%= f.password_field :current_password, autocomplete: 'current-password', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+        <p class="mt-2 text-grey-700 text-xs italic">We need your current password to confirm your changes</p>
+      </div>
+
+        <%%= f.submit 'Update', class: 'my-2 bg-blue-500 hover:bg-blue-700 text-white font-bold text-sm py-2 px-4 rounded w-full' %>
+    <%% end %>
+    <hr class="my-5" />
+    <%%= button_to 'Cancel my account', registration_path(resource_name), class: 'my-2 bg-red-500 hover:bg-red-700 text-white font-bold text-sm py-2 px-4 rounded w-full', data: { confirm: 'Are you sure? You cannot undo this.' }, method: :delete %>
+
+    <hr class="my-5" />
+    <%%= link_to "Back", :back %>
+  </div>
+</div>

data/lib/templates/devise/erb/registrations/new.html.erb.tt

@@ -0,0 +1,37 @@
+<div class="md:mx-auto md:max-w-md overflow-hidden mx-0">
+  <div class=" shadow-md rounded px-8 pt-6 pb-8 mb-4 flex flex-col justify-center bg-gray-50">
+    <h2 class="text-center text-xl text-black">
+<%- if options[:metatags] -%>
+      <%%= title('Sign Up') %>
+<%- else -%>
+      Sign Up
+<%- end -%>
+    </h2>
+
+    <%%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+      <%%= render 'devise/shared/error_messages', resource: resource %>
+
+      <div class="mb-4">
+        <%%= f.label :email, class: 'block email optional text-sm font-medium text-gray-600' %>
+        <%%= f.email_field :email, autofocus: true, autocomplete: 'email', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+      <div class="mb-4">
+        <%%= f.label :password, class: 'block email optional text-sm font-medium text-gray-600' %>
+        <%% if @minimum_password_length %>
+        <em>(<%%= @minimum_password_length %> characters minimum)</em>
+        <%% end %>
+        <%%= f.password_field :password, autocomplete: 'new-password', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+      <div class="mb-4">
+        <%%= f.label :password_confirmation, class: 'block email optional text-sm font-medium text-gray-600' %>
+        <%%= f.password_field :password_confirmation, autocomplete: 'new-password', class: 'shadow appearance-none border border-gray-300 rounded w-full py-2 px-3 bg-white focus:outline-none focus:ring-0 focus:border-blue-500 text-gray-400 leading-6 transition-colors duration-200 ease-in-out string' %>
+      </div>
+
+        <%%= f.submit 'Sign Up', class: 'my-2 bg-blue-500 hover:bg-blue-700 text-white font-bold text-sm py-2 px-4 rounded w-full' %>
+    <%% end %>
+
+    <%%= render 'devise/shared/links' %>
+  </div>
+</div>