authentication_with_registration_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4681439bb93e7104bd2fb5e81beb6d3bdebe2fa7b3f41ab40bf1667d1ec95560
+  data.tar.gz: 528b29f802154e3d896ba1a9c8a96cf3d7e2d8b7f406a774040050e5503ee962
+SHA512:
+  metadata.gz: 8e1b97b25be5535e159020308bc0592d97e574b23074f77f7b750f973966e58303f114ac1e43f77dfc419f224017ac9b99072c0d9965ab2aa02d037919f1d565
+  data.tar.gz: 3684fb7b2a2dd034464294b7c6edb0884a01e0d4d55ac60f06ed9f2a929eb49e6d7a9c8cbc2a2582d62159d514de2ba8037834e895625fa3a311073a90992cae

data/README.md

@@ -0,0 +1,41 @@
+# Authentication With Registration Generator
+
+A Rails Generator that adds registration pages to the Authentication Generator as well as some useful routes and helper methods.
+
+* Runs the Authentication generator
+* Adds a registration page which will create a new user with an email address and password.
+* Adds a link to the registration page on the sign_in page
+* Adds `new_registration_path` and `registration_path` routes
+* Adds '/sign_in' and '/sign_out' routes as alias to '/session/new' and 'session', these can be accessed using the `sign_in_path` and `sign_out_path, method: :delete` helpers
+* Adds a `link_to_sign_in_or_out` helper that will display a sign out or sign in link depending on if a user is authenticated or not
+* Adds a `show_user_if_signed_in` method that displays a "signed in as username" message if the user is signed in
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add registration_generator
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install registration_generator
+
+## Usage
+
+```bash
+rails generate registration
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/daz4126/registration_generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/authentication_with_registration/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Creates registration pages for the authentication generator
+
+Example:
+    bin/rails generate registration
+
+    This will create:
+        regisistration routes
+        new registration view
+        registrations controller
+        link_to_sign_in_or_out helper method
+        show_user_if_signed_in helper method

data/lib/generators/authentication_with_registration/authentication_with_registration_generator.rb

@@ -0,0 +1,59 @@
+# lib/generators/registration/registration_generator.rb
+require "rails/generators"
+
+module AuthenticationWithRegistration
+  class AuthenticationWithRegistration < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def run_auth_generator
+      unless File.exist?(Rails.root.join("app/controllers/concerns/authentication.rb"))
+        invoke "rails:authentication"
+      end
+    end
+    
+
+    def create_view
+      template "registration_form.html.erb", "app/views/registrations/new.html.erb"
+    end
+
+    def create_sign_in
+      template "sign_in_form.html.erb", "app/views/sessions/new.html.erb", force: true
+    end
+
+    def create_controller
+      template "registrations_controller.rb", "app/controllers/registrations_controller.rb"
+    end
+
+    def add_routes
+      route "resource :registration, only: [:new, :create]"
+      route "get \"sign_in\", to: \"sessions#new\", as: :sign_in"
+      route "delete \"sign_out\", to: \"sessions#destroy\", as: :sign_out"
+    end
+    
+    def update_authentication_concern
+      inject_into_file "app/controllers/concerns/authentication.rb", before: "private\n" do
+        <<~RUBY
+    
+          def link_to_sign_in_or_out
+            if authenticated?
+              button_to "Sign Out", sign_out_path, method: :delete
+            else
+              link_to "Sign In", sign_in_path
+            end
+          end
+    
+          def show_user_if_signed_in
+            if authenticated?
+              "Signed in as \#{Current.user.email_address}"
+            end
+          end
+        RUBY
+      end
+    
+      inject_into_file "app/controllers/concerns/authentication.rb", after: "helper_method :authenticated?\n" do
+        "    helper_method :link_to_sign_in_or_out, :show_user_if_signed_in\n"
+      end
+    end
+    
+  end
+end

data/lib/generators/authentication_with_registration/templates/registration_form.html.erb

@@ -0,0 +1,21 @@
+<h1>Registration</h1>
+
+<%%= form_with model: @user, url: registration_path do |f| %>
+  <%% if @user.errors.any? %>
+    <div>
+      <%%= @user.errors.full_messages.to_sentence %>
+    </div>
+  <%% end %>
+
+  <div>
+    <%%= f.label :email_address %>
+    <%%= f.email_field :email_address %>
+  </div>
+
+  <div>
+    <%%= f.label :password %>
+    <%%= f.password_field :password %>
+  </div>
+
+  <%%= f.submit "Register" %>
+<%% end %>

data/lib/generators/authentication_with_registration/templates/registrations_controller.rb

@@ -0,0 +1,24 @@
+class RegistrationsController < ApplicationController
+  allow_unauthenticated_access
+   
+   def new
+     @user = User.new
+   end
+ 
+   def create
+     @user = User.new(user_params)
+        
+     if @user.save
+       start_new_session_for @user
+       redirect_to after_authentication_url, notice: "You have successfully registered!"
+     else
+       render :new, status: :unprocessable_entity
+     end
+   end
+ 
+   private
+ 
+   def user_params
+     params.require(:user).permit(:email_address, :password)
+   end
+ end

data/lib/generators/authentication_with_registration/templates/sign_in_form.html.erb

@@ -0,0 +1,12 @@
+<%%= tag.div(flash[:alert], style: "color:red") if flash[:alert] %>
+<%%= tag.div(flash[:notice], style: "color:green") if flash[:notice] %>
+
+<%%= form_with url: session_path do |form| %>
+  <%%= form.email_field :email_address, required: true, autofocus: true, autocomplete: "username", placeholder: "Enter your email address", value: params[:email_address] %><br>
+  <%%= form.password_field :password, required: true, autocomplete: "current-password", placeholder: "Enter your password", maxlength: 72 %><br>
+  <%%= form.submit "Sign in" %>
+<%% end %>
+<p>
+<%%= link_to "Forgot password?", new_password_path %> | 
+<%%= link_to "No Account? Register here", new_registration_path %>
+</p>

data/lib/generators/authentication_with_registration_generator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "registration_generator/version"
+
+module AuthenticationWithRegistrationGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/generators/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AuthenticationWithRegistrationGenerator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: authentication_with_registration_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DAZ
+bindir: bin
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: This gem provides a Rails generator to create a registration form and
+  related files.
+email:
+- darren.jones@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/authentication_with_registration/USAGE
+- lib/generators/authentication_with_registration/authentication_with_registration_generator.rb
+- lib/generators/authentication_with_registration/templates/registration_form.html.erb
+- lib/generators/authentication_with_registration/templates/registrations_controller.rb
+- lib/generators/authentication_with_registration/templates/sign_in_form.html.erb
+- lib/generators/authentication_with_registration_generator.rb
+- lib/generators/version.rb
+homepage: https://github.com/your_username/registration_generator
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: A Rails generator for user authenticatin with extra registration pages, routes
+  and helpers
+test_files: []