orthodox 0.3.2 → 0.3.6

data/lib/generators/authentication/authentication_generator.rb

@@ -1,41 +1,41 @@
 class AuthenticationGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
-  
+
   desc "Creates authentication views, controllers and models for a given Model"
-  
+
   class_option :skip_views, type: :boolean, default: false
 
   class_option :skip_tests, type: :boolean, default: false
-  
+
   class_option :two_factor, type: :boolean, default: false
-  
+
   class_option :js, type: :boolean, default: false
-  
-  
+
+
   def create_controllers
-    generate "base_controller", class_name
-    template "controllers/sessions_controller.rb.erb", 
+    generate "base_controller", plural_name
+    template "controllers/sessions_controller.rb.erb",
              "app/controllers/#{plural_file_name}/sessions_controller.rb"
-    template "controllers/password_resets_controller.rb.erb", 
+    template "controllers/password_resets_controller.rb.erb",
             "app/controllers/#{plural_file_name}/password_resets_controller.rb"
 
-    if options[:two_factor]             
-      template "controllers/tfa_sessions_controller.rb.erb", 
+    if options[:two_factor]
+      template "controllers/tfa_sessions_controller.rb.erb",
                "app/controllers/#{plural_file_name}/tfa_sessions_controller.rb"
-              
-      template "controllers/tfas_controller.rb.erb", 
+
+      template "controllers/tfas_controller.rb.erb",
                "app/controllers/#{plural_file_name}/tfas_controller.rb"
     end
   end
 
   def extend_controllers
-    inject_into_class "app/controllers/#{plural_name}/base_controller.rb", 
-                      "#{plural_class_name}::BaseController", 
+    inject_into_class "app/controllers/#{plural_name}/base_controller.rb",
+                      "#{plural_class_name}::BaseController",
                       "  authenticate_model :#{singular_name}, tfa: #{options[:two_factor]}\n"
     include_module_in_controller("#{plural_name}/base_controller", "Authentication")
-    
+
   end
-  
+
   def ensure_helpers
     if options[:two_factor]
       copy_file "helpers/otp_credentials_helper.rb", "app/helpers/otp_credentials_helper.rb"
@@ -47,7 +47,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
       copy_file "javascript/tfa_forms.js", "app/javascript/packs/tfa_forms.js"
     end
   end
-  
+
   def create_mailer
     generate "mailer", "#{class_name}Mailer"
     inject_into_class "app/mailers/#{singular_name}_mailer.rb", "#{class_name}Mailer", <<~RUBY
@@ -56,47 +56,47 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
       @#{singular_name} = #{singular_name}
       mail(to: #{singular_name}.email, subject: "Reset your password")
     end
-    
+
     RUBY
     template "views/mailers/password_reset_link.html.slim.erb",
              "app/views/#{singular_name}_mailer/password_reset_link.html.slim"
   end
-      
+
   def create_models
     copy_file "models/password_reset_token.rb", "app/models/password_reset_token.rb"
     if options[:two_factor]
       template "models/otp_credential.rb.erb", "app/models/otp_credential.rb"
-    end    
+    end
   end
-  
+
   def extend_models
     include_module_in_model(class_name, "Authenticateable")
-    include_module_in_model(class_name, "PasswordResetable")    
+    include_module_in_model(class_name, "PasswordResetable")
     if options[:two_factor]
       include_module_in_model(class_name, "Otpable")
     end
   end
-  
+
   def create_form_objects
-    template "models/session.rb.erb", "app/models/#{singular_name}_session.rb" 
+    template "models/session.rb.erb", "app/models/#{singular_name}_session.rb"
     if options[:two_factor]
       copy_file "models/tfa_session.rb", "app/models/tfa_session.rb"
-    end   
+    end
   end
-  
+
   def ensure_concerns
-    template "controllers/concerns/authentication.rb.erb", 
+    template "controllers/concerns/authentication.rb.erb",
              "app/controllers/concerns/authentication.rb"
-    copy_file "models/concerns/authenticateable.rb", 
-              "app/models/concerns/authenticateable.rb"    
-    copy_file "models/concerns/password_resetable.rb", 
-              "app/models/concerns/password_resetable.rb"    
+    copy_file "models/concerns/authenticateable.rb",
+              "app/models/concerns/authenticateable.rb"
+    copy_file "models/concerns/password_resetable.rb",
+              "app/models/concerns/password_resetable.rb"
 
     if options[:two_factor]
-      copy_file "controllers/concerns/two_factor_authentication.rb", 
-                "app/controllers/concerns/two_factor_authentication.rb"    
-      
-      copy_file "models/concerns/otpable.rb", "app/models/concerns/otpable.rb"    
+      copy_file "controllers/concerns/two_factor_authentication.rb",
+                "app/controllers/concerns/two_factor_authentication.rb"
+
+      copy_file "models/concerns/otpable.rb", "app/models/concerns/otpable.rb"
     end
   end
 
@@ -111,64 +111,64 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
                               secret:string{32} \
                               authable:references{polymorphic} \
                               recovery_codes:json"
-    end    
+    end
   end
-  
+
   def create_view_templates
     return if options[:skip_views]
-    template "views/sessions/new.html.slim.erb", 
-             "app/views/#{plural_name}/sessions/new.html.slim"    
+    template "views/sessions/new.html.slim.erb",
+             "app/views/#{plural_name}/sessions/new.html.slim"
+
+    template "views/password_resets/new.html.slim.erb",
+             "app/views/#{plural_name}/password_resets/new.html.slim"
 
-    template "views/password_resets/new.html.slim.erb", 
-             "app/views/#{plural_name}/password_resets/new.html.slim"    
+    template "views/password_resets/edit.html.slim.erb",
+             "app/views/#{plural_name}/password_resets/edit.html.slim"
 
-    template "views/password_resets/edit.html.slim.erb", 
-             "app/views/#{plural_name}/password_resets/edit.html.slim"    
-             
     if options[:two_factor]
-      template "views/tfa_sessions/new.html.slim.erb", 
-               "app/views/#{plural_name}/tfa_sessions/new.html.slim"      
-      template "views/tfas/show.html.slim.erb", 
-               "app/views/#{plural_name}/tfas/show.html.slim"      
-               
+      template "views/tfa_sessions/new.html.slim.erb",
+               "app/views/#{plural_name}/tfa_sessions/new.html.slim"
+      template "views/tfas/show.html.slim.erb",
+               "app/views/#{plural_name}/tfas/show.html.slim"
+
     end
   end
-  
+
   def create_specs
     return if options[:skip_tests]
-    
+
     copy_file "spec/support/factory_bot.rb", "spec/support/factory_bot.rb"
-    
-    template "spec/system/authentication_spec.rb.erb", 
-             "spec/system/#{plural_name}/authentication_spec.rb" 
-
-    template "spec/system/password_resets_spec.rb.erb", 
-             "spec/system/#{plural_name}/password_resets_spec.rb" 
-             
-    template "spec/models/session_spec.rb.erb", 
-            "spec/models/#{singular_name}_session_spec.rb" 
-    
-    copy_file "spec/models/password_reset_token_spec.rb", 
+
+    template "spec/system/authentication_spec.rb.erb",
+             "spec/system/#{plural_name}/authentication_spec.rb"
+
+    template "spec/system/password_resets_spec.rb.erb",
+             "spec/system/#{plural_name}/password_resets_spec.rb"
+
+    template "spec/models/session_spec.rb.erb",
+            "spec/models/#{singular_name}_session_spec.rb"
+
+    copy_file "spec/models/password_reset_token_spec.rb",
               "spec/models/password_reset_token_spec.rb"
-    
+
     if options[:two_factor]
-      copy_file "spec/support/authentication_helpers.rb", 
+      copy_file "spec/support/authentication_helpers.rb",
                 "spec/support/authentication_helpers.rb"
       template "spec/models/tfa_session_spec.rb.erb", "spec/models/tfa_session_spec.rb"
-      copy_file "spec/models/otp_credential_spec.rb", 
-                "spec/models/otp_credential_spec.rb"      
-      template "spec/system/tfa_authentication_spec.rb.erb", 
-               "spec/system/#{plural_name}/tfa_authentication_spec.rb" 
-      
+      copy_file "spec/models/otp_credential_spec.rb",
+                "spec/models/otp_credential_spec.rb"
+      template "spec/system/tfa_authentication_spec.rb.erb",
+               "spec/system/#{plural_name}/tfa_authentication_spec.rb"
+
     end
   end
-  
+
   def create_factories
     generate "factory_bot:model", "otp_credential"
     generate "factory_bot:model", "password_reset_token"
-    generate "factory_bot:model", "#{singular_name}_session email:email password:password"    
+    generate "factory_bot:model", "#{singular_name}_session email:email password:password"
   end
-  
+
   def ensure_gems
     gem "validates_email_format_of", version: "~> 1.6"
     gem "slim-rails"
@@ -179,39 +179,39 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
       gem "rqrcode", require: false
     end
   end
-  
+
   def create_routes
     route <<~RUBY
     namespace :#{plural_name} do
-    
+
       resource :session, only: [:new, :create, :destroy]
-    
+
       #{"resource :tfa_session, only: [:new, :create]" if options[:two_factor]}
-    
+
       resource :tfa, only: [:create, :show, :destroy]
-        
+
       resources :password_resets, only: [:new, :create, :edit, :update], param: :token
-    
+
     end
     RUBY
   end
-  
+
   private
-  
+
   def plural_class_name
     class_name.pluralize
   end
 
   def include_module_in_controller(controller_name, module_name)
     class_name = controller_name.classify
-    inject_into_class "app/controllers/#{controller_name}.rb", class_name, 
+    inject_into_class "app/controllers/#{controller_name}.rb", class_name,
                       "  include #{module_name}\n"
-    
+
   end
-  
+
   def include_module_in_model(model_name, module_name)
-    inject_into_class "app/models/#{model_name.underscore}.rb", model_name, 
+    inject_into_class "app/models/#{model_name.underscore}.rb", model_name,
                       "  include #{module_name}\n"
-    
+
   end
 end

data/lib/generators/authentication/templates/controllers/concerns/authentication.rb.erb

@@ -1,15 +1,15 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # Concern added to controllres to provide methods for authentication.
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 module Authentication
-  
+
   extend ActiveSupport::Concern
-  
+
   protected
-  
+
   # Sign in a given record as a given type
   #
   # record - An AppliationRecord subclass instance (e.g. A Member)
@@ -25,7 +25,7 @@ module Authentication
     session[:"#{as}_tfa_authenticated"] = tfa
     <%- end -%>
   end
-  
+
   # Sign out a given record type.
   #
   # as - A String or Symbol with the model name (e.g. "member")
@@ -36,11 +36,11 @@ module Authentication
     <%- end -%>
     instance_variable_set("@current_#{as}", nil)
   end
-  
+
   module ClassMethods
-    
+
     # Create a bunch of authentication methods for a given ActiveRecord model
-    def authenticate_model(model_name, **options)      
+    def authenticate_model(model_name, **options)
       # Define a current_<model> method to load the currently signed in record, if present
       #
       # Returns ApplicationRecord subclass
@@ -50,24 +50,24 @@ module Authentication
           instance_variable_get(instance_method_name)
         else
           scope = send(:"#{model_name}_auth_scope")
-          instance_variable_set(instance_method_name, 
+          instance_variable_set(instance_method_name,
                                 scope.find_by(id: session[:"#{model_name}_id"]))
         end
       end
-      
+
       # Define a controller before_action method to authenticate a record for the given
       # model. Redirects to the <model_name>_failed_authentication_url if not passed.
       #
       # Returns nil
       define_method(:"authenticate_#{model_name}")  do
         unless send(:"current_#{model_name}?")
-          redirect_to send(:"#{model_name}_failed_authentication_url"), 
+          redirect_to send(:"#{model_name}_failed_authentication_url"),
                       warn: "You must be signed in to do that"
-        end                        
+        end
       end
-      
+
       before_action :"authenticate_#{model_name}"
-      
+
       # Creates a scope that records are loaded through when being authenticated. Subclass
       # this method to customise the load conditions.
       #
@@ -75,37 +75,37 @@ module Authentication
       define_method(:"#{model_name}_auth_scope") do
         model_name.to_s.classify.constantize.all
       end
-      
+
       # Creates a boolean method to check if a current_<model_name> has been authenticated
       # or not.
       #
       # Returns Boolean
       define_method(:"current_#{model_name}?") { send(:"current_#{model_name}").present? }
-      
-      define_method(:"#{model_name}_signed_in?") { send(:"current_#{model_name}?") } 
-      
+
+      define_method(:"#{model_name}_signed_in?") { send(:"current_#{model_name}?") }
+
       define_method(:"#{model_name}_failed_authentication_url") do
         send(:"new_#{model_name.to_s.pluralize}_session_url")
       end
-      
+
       helper_method :"current_#{model_name}"
       helper_method :"current_#{model_name}?"
       helper_method :"#{model_name}_signed_in?"
-      
+
       protected :"current_#{model_name}"
       protected :"current_#{model_name}?"
       protected :"#{model_name}_signed_in?"
       protected :"authenticate_#{model_name}"
-      
+
       <%- if options[:two_factor] -%>
       # This is included if the authentication generator is run with --two-factor=true
       if options[:tfa] == true
-        include TwoFactorAuthentication 
+        include TwoFactorAuthentication
         define_tfa_methods(model_name)
       end
       <%- end -%>
     end
 
   end
-  
+
 end

data/lib/generators/authentication/templates/controllers/password_resets_controller.rb.erb

@@ -1,4 +1,4 @@
-# frozen_string_literal
+# frozen_string_literal: true
 class <%= plural_class_name %>::PasswordResetsController < <%= plural_class_name %>::BaseController
   
   skip_before_action :authenticate_<%= singular_name %>

data/lib/generators/authentication/templates/controllers/sessions_controller.rb.erb

@@ -1,10 +1,10 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # Controller for managing sessions for <%= plural_class_name %>.
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 class <%= plural_class_name %>::SessionsController < <%= plural_class_name %>::BaseController
-  
+
   skip_before_action :authenticate_<%= singular_name %>
 
   def new
@@ -20,7 +20,7 @@ class <%= plural_class_name %>::SessionsController < <%= plural_class_name %>::B
       render :new
     end
   end
-  
+
   def destroy
     sign_out(:<%= singular_name %>)
     redirect_to root_url, notice: "Successfully signed out"

data/lib/generators/authentication/templates/controllers/tfa_sessions_controller.rb.erb

@@ -1,8 +1,8 @@
-# frozen_string_literal
+# frozen_string_literal: true
 #
 # Controller for managing two-factor sessions for <%= plural_class_name %>.
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 class <%= plural_class_name %>::TfaSessionsController < <%= plural_class_name %>::BaseController
   
   skip_before_action :authenticate_<%= singular_name %>

data/lib/generators/authentication/templates/controllers/tfas_controller.rb.erb

@@ -1,8 +1,8 @@
-# frozen_string_literal
+# frozen_string_literal: true
 #
 # Controller for managing two-factor credentials for <%= plural_class_name %>.
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 class <%= plural_class_name %>::TfasController < <%= plural_class_name %>::BaseController
   
   skip_before_action :authenticate_<%= singular_name %>

data/lib/generators/authentication/templates/helpers/otp_credentials_helper.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # Helper for one-time-password authentication methods
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 module OtpCredentialsHelper
 
   require 'rqrcode'

data/lib/generators/authentication/templates/javascript/tfa_forms.js

@@ -1,9 +1,7 @@
-// Basic JS functionality for one-time-password form. Designed to be used with jQuery and 
+// Basic JS functionality for one-time-password form. Designed to be used with jQuery and
 // Bootstrap.
 //
-// Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-// (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
-  
+// Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
 // Initialize method called when jQuery ready
 function init() {
   $("body").on("click", ".js-tfa-link", onClick);
@@ -16,4 +14,4 @@ function onClick(e){
   $(".js-tfa-field-group").toggleClass("d-none");
 }
 
-jQuery(init);
+jQuery(init);

data/lib/generators/authentication/templates/models/concerns/authenticateable.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # Model concern to provide shared behaviour for authenticating records.
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 module Authenticateable
 
   extend ActiveSupport::Concern

data/lib/generators/authentication/templates/models/concerns/otpable.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal
+# frozen_string_literal: true
 #
 # Model concern to provide shared behaviour for two-factor auth (one-time password)
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 module Otpable
   extend ActiveSupport::Concern
   

data/lib/generators/authentication/templates/models/concerns/password_resetable.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal
+# frozen_string_literal: true
 #
 # Model concern to provide shared behaviour for password resets
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 module PasswordResetable
   
   extend ActiveSupport::Concern

data/lib/generators/authentication/templates/models/otp_credential.rb.erb

@@ -1,9 +1,9 @@
-# frozen_string_literal
+# frozen_string_literal: true
 # 
 # Model for managing one-time password credentials for a given Member
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 #
 # == Schema Information
 #

data/lib/generators/authentication/templates/models/password_reset_token.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # 
 # Model for managing password reset tokens
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 #
 # == Schema Information
 #

data/lib/generators/authentication/templates/models/session.rb.erb

@@ -1,8 +1,8 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 # Form object for authenticating <%= class_name %> records.
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 class <%= class_name %>Session
   
   include ActiveModel::Model

data/lib/generators/authentication/templates/models/tfa_session.rb

@@ -1,7 +1,7 @@
 # Form object for handling two-factor authentication sessions
 #
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 class TfaSession
   include ActiveModel::Model
   include ActiveModel::Attributes

data/lib/generators/authentication/templates/spec/models/otp_credential_spec.rb

@@ -1,5 +1,5 @@
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 #
 # == Schema Information
 #

data/lib/generators/authentication/templates/spec/models/password_reset_token_spec.rb

@@ -1,5 +1,5 @@
-# Automatically generated by the orthodox gem (https://github.com/katanacode/orthodox)
-# (c) Copyright 2019 Katana Code Ltd. All Rights Reserved. 
+# Automatically generated by the orthodox gem (https://github.com/bodacious/orthodox)
+
 #
 # == Schema Information
 #