semantic_ui_views_generator 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11cee013066e6ff87d9d373f3ba58ba728e29f197e7d4d15cced802a4dd1132b
-  data.tar.gz: a4eeab2201a647b31fe81522cb71fa9c953dc619fa66a82bf53fe6bda0f7f0d1
+  metadata.gz: 92aab57b70b5bf069f69136a2943f2d0e1be6170a4bc28999192726c3b729306
+  data.tar.gz: e0b67036694ab770a5aaae1b430493017ef63cb8321178540f82a1eadcbac860
 SHA512:
-  metadata.gz: 261f00eb1c1d8c0456cd24f4df3bb17e2281119c1a963468c5d0abac9e54392b7df48db372fb1c43e9a7da82d6ef264bb6138a25c992cfc0525c52e90e8d7c22
-  data.tar.gz: c4155a1c0c798441455d73ca4ea3c80cda56f83fbd1fcf0cf961291ab94943f9baf0140fbe5db973d68f26c9cc87cb7a9bb4b69bda0b6f612116994e60830b2d
+  metadata.gz: 4a55ce4eabe6aba2e6a66a772d1457146fced806cebad922962b1b9d45964c7193cf5343f6a2f10e32f806e7d4927c5c1b10f5d485725a9b24f8761a00b30efb
+  data.tar.gz: 30baff9b54a5228f67bebf70fa382ac1ca676c1f620acac756446bf495802a7eec76aa48997ec7ac272e9d598c9498fa5a87ae9edda7c58b9b6d7df504186d73

data/README.md

@@ -47,6 +47,8 @@ Options:
                                             # Default: false
 --layout                                    # Over-write your application layout file with a Semantic UI based layout
                                             # Default: false
+--devise                                    # If you want to generate semantic based devise views
+                                            # Default: false
 ```
 
 ## Options
@@ -84,7 +86,7 @@ Ensure you have [Pagy](https://github.com/ddnexus/pagy) gem installed
 ```ruby
 gem 'pagy'
 
-# Make sure you have the bootstrap pagy helper included
+# Make sure you have the semantic-ui pagy helper included
 # config/initializers/pagy.rb
 require 'pagy/extras/semantic'
 ```
@@ -108,6 +110,11 @@ Generate semantic views with slim and using simple_form
 rails g semantic:install --template_engine=slim --simpleform
 ```
 
+Generate semantic scaffolds, devise views, while using simpleform, metatags, and slim template engine.
+```shell
+ rails g semantic:install --devise --simpleform --metatags --template_engine=slim
+```
+
 ### Extras
 
 * If you like to use the [meta-tags](https://github.com/kpumuk/meta-tags) gem to add page titles based on the views.

data/lib/generators/semantic/devise_generator.rb

@@ -0,0 +1,61 @@
+require 'rails/generators'
+
+module Semantic
+  module Generators
+    class DeviseGenerator < ::Rails::Generators::Base
+      hide!
+      desc 'Overwrite default devise views'
+      source_root ::File.expand_path('../templates/devise', __FILE__)
+
+      class_option :template_engine, type: :string, default: 'erb', aliases: '-t', 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 copy_confirmation
+        template "#{file_template_location('confirmations/new')}.tt", "app/views/devise/confirmations/new.html.#{options[:template_engine]}"
+      end
+
+      def copy_mailers
+        directory "#{options[:template_engine]}/mailer", 'app/views/devise/mailer'
+      end
+
+      def copy_passwords
+        %i[edit new].map do |file|
+          template "#{file_template_location("passwords/#{file}")}.tt", "app/views/devise/passwords/#{file}.html.#{options[:template_engine]}"
+        end
+      end
+
+      def copy_registrations
+        %i[edit new].map do |file|
+          template "#{file_template_location("registrations/#{file}")}.tt", "app/views/devise/registrations/#{file}.html.#{options[:template_engine]}"
+        end
+      end
+
+      def copy_sessions
+        template "#{file_template_location('sessions/new')}.tt", "app/views/devise/sessions/new.html.#{options[:template_engine]}"
+      end
+
+      def copy_unlock
+        template "#{options[:template_engine]}/unlocks/new.html.#{options[:template_engine]}.tt", "app/views/devise/unlocks/new.html.#{options[:template_engine]}"
+      end
+
+      # Copy shared files that have no meta-tags or template associated with them
+      def copy_shared
+        directory "#{options[:template_engine]}/shared", 'app/views/devise/shared'
+      end
+
+      private
+      def file_template_location(file_location = '')
+        return '' if file_location.blank?
+        # Dpending 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/semantic/install_generator.rb

@@ -1,4 +1,5 @@
 require 'rails/generators'
+require_relative 'devise_generator'
 
 module Semantic
   module Generators
@@ -8,6 +9,7 @@ module Semantic
 
       class_option :template_engine, type: :string, default: 'erb', aliases: '-t', desc: 'Set template engine to generate the views with'
       # 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 Semantic UI 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)'
@@ -43,25 +45,29 @@ module Semantic
         pagy_helper = (options[:pagination] ? 'include Pagy::Frontend' : '')
         helper_str = <<~HELPER
         #{pagy_helper}
-
-        # For generating SemanitcUI based flash[:notices]
-        def flash_class(level)
-          case level
-          when 'success'
-            'positive'
-          when 'error'
-            'negative'
-          when 'alert'
-            'negative'
-          when 'notice'
-            'info'
-          else
-            'info'
+          # For generating SemanitcUI based flash[:notices]
+          def flash_class(level)
+            case level
+            when 'success'
+              'positive'
+            when 'error'
+              'negative'
+            when 'alert'
+              'negative'
+            when 'notice'
+              'info'
+            else
+              'info'
+            end
           end
-        end
       HELPER
         inject_into_file 'app/helpers/application_helper.rb', helper_str, after: "module ApplicationHelper\n", force: true
       end
+
+      def invoke_devise_generator
+        # Generate semantic based devise views if devise is being used
+        invoke('semantic:devise') if options[:devise]
+      end
     end
   end
 end

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

@@ -0,0 +1,34 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid grey">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="signup icon"></i><%%= title('Sign up') %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="signup icon"></i>Sign up</h2>
+    <%- end %>
+    <div class="ui large form <%%= "error" if resource.errors.any? %>">
+      <%%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
+        <div class="ui error message">
+          <%%= render 'devise/shared/error_messages' %>
+        </div>
+        <div class="field">
+          <%%= f.label :email %><br />
+          <%%= f.email_field :email, autofocus: true, value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) ,placeholder: "Enter your email" %>
+        </div>
+        <div class="actions">
+          <%%= f.submit 'Resend confirmation instructions', class: 'ui submit button teal fluid' %>
+        </div>
+      <%% end %>
+      <div class="ui horizontal divider">or</div>
+      <div class="ui horizontal list">
+        <%%= render 'devise/shared/links' %>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/semantic/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/generators/semantic/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/generators/semantic/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/generators/semantic/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/generators/semantic/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/generators/semantic/templates/devise/erb/passwords/edit.html.erb.tt

@@ -0,0 +1,44 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i><%%= title('Change your password') %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i>Change your password</h2>
+    <%- end %>
+    <div class="ui form large <%%= "error" if resource.errors.any? %>">
+      <%%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
+        <div class="ui error message">
+          <%%= render 'devise/shared/error_messages' %>
+        </div>
+        <%%= f.hidden_field :reset_password_token %>
+        <div class="field">
+          <%%= f.label :password, "New password" %>
+          <%% if @minimum_password_length %>
+            <div class="ui pointing below label">
+              <%%= @minimum_password_length %> characters minimum
+            </div>
+          <%% end %>
+          <%%= f.password_field :password, autofocus: true, autocomplete: "off" , placeholder: "Enter new password" %>
+        </div>
+        <div class="field">
+          <%%= f.label :password_confirmation, "Confirm new password" %>
+          <%%= f.password_field :password_confirmation, autocomplete: "off" , placeholder: "Confirm new password" %>
+        </div>
+        <div class="actions">
+          <%%= f.submit "Change my password",class: "ui submit button teal fluid" %>
+        </div>
+      <%% end %>
+      <div class="ui horizontal divider">or</div>
+      <div class="ui horizontal list">
+        <%%= render "devise/shared/links" %>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,35 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i><%%= title('Forgot your password?') %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i>Forgot your password?</h2>
+    <%- end %>
+    <div class="ui form large <%%= "error" if resource.errors.any? %>">
+      <%%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
+        <div class="ui error message">
+          <%%= render 'devise/shared/error_messages' %>
+        </div>
+        <div class="field">
+          <%%= f.label :email %>
+          <%%= f.email_field :email, autofocus: true ,placeholder: "Enter your registered email"%>
+        </div>
+        <br>
+        <div class="actions">
+          <%%= f.submit "Send me reset password instructions",class: "ui submit button teal fluid"  %>
+        </div>
+      <%% end %>
+      <div class="ui horizontal divider">or</div>
+      <div class="ui horizontal list">
+        <%%= render "devise/shared/links" %>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,54 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i><%%= title("Edit #{resource_name.to_s.humanize}") %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="lock icon"></i>Edit <%%= resource_name.to_s.humanize %></h2>
+    <%- end %>
+    <div class="ui form large <%%= "error" if resource.errors.any? %>">
+      <%%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %>
+        <%%= render 'devise/shared/error_messages' %>
+        <div class="field">
+          <%%= f.label :email %>
+          <%%= f.email_field :email, autofocus: true %>
+        </div>
+        <%% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+          <div>Currently waiting confirmation for: <%%= resource.unconfirmed_email %></div>
+        <%% end %>
+        <div class="field">
+          <%%= f.label :password %>
+          <%% if @minimum_password_length %>
+            <div class="ui pointing below label">
+              <%%= @minimum_password_length %> characters minimum
+            </div>
+          <%% end %>
+          <%%= f.password_field :password, autocomplete: "off", placeholder: "Enter new password (leave blank if you don't want to change it)" %>
+        </div>
+        <div class="field">
+          <%%= f.label :password_confirmation %>
+          <%%= f.password_field :password_confirmation, autocomplete: "off" ,placeholder: "Confirm new password" %>
+        </div>
+        <div class="field">
+          <%%= f.label :current_password %>
+          <%%= f.password_field :current_password, autocomplete: "off",placeholder: "(we need your current password to confirm your changes)" %>
+        </div>
+        <div class="actions">
+          <%%= f.submit "Update", class: "ui submit button fluid teal" %>
+        </div>
+        <%% end %>
+        <div class="ui horizontal divider">or</div>
+        <h4 class="ui light grey header">Cancel my account</h4>
+        <p>Unhappy? <%%= button_to "Cancel my account", registration_path(resource_name), data: { confirm: "Are you sure?" }, method: :delete ,class: "ui submit button red tiny "%></p>
+        <div class="ui horizontal list ">
+          <div class="item"><%%= link_to "Back", :back %></div>
+        </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,47 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid grey">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="signup icon"></i><%%= title("Sign up") %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="signup icon"></i>Sign up</h2>
+    <%- end %>
+    <div class="ui large form <%%= "error" if resource.errors.any? %>">
+      <%%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+        <div class="ui error message">
+          <%%= render 'devise/shared/error_messages' %>
+        </div>
+        <div class="field ">
+          <%%= f.label :email %>
+          <%%= f.email_field :email, autofocus: true ,placeholder: "mail@example.com"%>
+        </div>
+        <div class="field ">
+          <%%= f.label :password %>
+          <%% if @minimum_password_length %>
+            <div class="ui pointing below label">
+              <%%= @minimum_password_length %> characters minimum
+            </div>
+          <%% end %>
+          <%%= f.password_field :password, autocomplete: "off" ,placeholder: "Enter Password", data: { toggle: "tooltip", placement: "left" }%>
+        </div>
+        <div class="field">
+          <%%= f.label :password_confirmation %>
+          <%%= f.password_field :password_confirmation, autocomplete: "off" ,placeholder: "Confirm Password" %>
+        </div>
+        <div class="actions">
+          <%%= f.submit "Sign up", class: "ui submit button fluid teal" %>
+        </div>
+      <%% end %>
+      <div class="ui horizontal divider">or</div>
+      <div class="ui horizontal list">
+        <%%= render "devise/shared/links" %>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/semantic/templates/devise/erb/sessions/new.html.erb.tt

@@ -0,0 +1,47 @@
+<style type="text/css">
+  body > .grid { height: 90%; }
+  .column { max-width: 450px; }
+  @media (min-width: 768px){
+    .column { max-width: 600px; }
+  }
+</style>
+<div class="ui middle aligned center aligned grid">
+  <div class="column">
+    <%- if options[:metatags] %>
+    <h2 class="ui center aligned dividing header teal"><i class="sign in icon"></i><%%= title('Log in') %></h2>
+    <% else -%>
+    <h2 class="ui center aligned dividing header teal"><i class="sign in icon"></i>Log in</h2>
+    <%- end %>
+    <div class="ui large form ">
+      <%%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+        <div class="field">
+          <%%= f.label :email %>
+          <div class="ui left icon input">
+          <%%= f.email_field :email, autofocus: true ,placeholder:"Email"%>
+          <i class="user icon"></i>
+          </div>
+        </div>
+        <div class="field">
+          <%%= f.label :password %>
+          <div class="ui left icon input">
+          <%%= f.password_field :password, autocomplete: "off" ,placeholder:"Password"%>
+          <i class="lock icon"></i>
+          </div>
+        </div>
+        <%% if devise_mapping.rememberable? -%>
+          <div class="ui checkbox">
+            <%%= f.check_box :remember_me %>
+            <%%= f.label :remember_me %> <br>
+          </div>
+        <%% end -%>
+        <div class="actions">
+          <%%= f.submit "Log in", class: "ui submit button fluid teal"%>
+        </div>
+      <%% end %>
+    <div class="ui horizontal divider">or</div>
+      <div class="ui horizontal list">
+        <%%= render "devise/shared/links" %>
+      </div>
+    </div>
+  </div>
+</div>