registration_generator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd28b26f3f15209f5ae09b58445af142d718a72448469b87b92fc5821c6c4fcd
-  data.tar.gz: 15d8d57286ac36cee35843e5ae68911a2027463f37781a6528f52ce6e1f68bb1
+  metadata.gz: a95a984757d27298f9e5badb0dc3e8d4951865ddc0fe3b839335c85000d5efaf
+  data.tar.gz: fee07f733da31a604c0ff23935a468fba8b0830ab4c8b32e39a5be53dbee6c08
 SHA512:
-  metadata.gz: daad25001fe12feed81e20fe62cd83b677b8792466f42a4377a62acaf2c50d807e3c384555fb3249b7bf9a5378822958f3bdde7a855415827a75e84405e588fe
-  data.tar.gz: 9c139a62bd8c2cb4821e4330cb7cc05c7591a7cc052021ab97ef732300b1736cbdf311e3906480eca7298590cef45dbde38fa3ccd508e064c193f4f80583e48e
+  metadata.gz: ae0c5fb1061edcd25a28c6fe8fb9ff23654f894b85b9da5ec26f5569f105c95e2842ccb6913917aacb7b7cdc2e6bbf2857f31898f49848baac85b68530475e65
+  data.tar.gz: b521a0507ec7f13ee484f0538268a6c002ec5bcdd5f9f53cc687fe9a2552204e774317cfbf83b8960e5001fe7f589b08127c19c7d75b6b8cb1d74e5d7704b309

data/README.md

@@ -1,24 +1,36 @@
 # RegistrationGenerator
 
-TODO: Delete this and the text below, and describe your gem
+A Rails Generator that adds registration pages to the Authentication Generator as well as some useful routes and helper methods.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/registration_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+* Adds a registration page which will create a new user with an email address and password.
+* Adds `new_registration_path` and `registration_path` routes
+* Adds a registration link on the sign_in page
+* 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_username_if_signed_in` method that displays a "signed in as username" message if the user is signed in
+* Adds a `name` method to the user model that is an alias for the email_address, but can be changed
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add registration_generator
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install registration_generator
 
 ## Usage
 
-TODO: Write usage instructions here
+```bash
+rails generate authentication
+```
+
+Then run the registration generator:
+
+```bash
+rails generate registration
+```
 
 ## Development
 
@@ -28,7 +40,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/registration_generator.
+Bug reports and pull requests are welcome on GitHub at https://github.com/daz4126/registration_generator.
 
 ## License
 

data/lib/registration_generator/registration_generator.rb

@@ -20,6 +20,44 @@ module RegistrationGenerator
 
     def add_routes
       route "resource :registration, only: [:new, :create]"
+      route "get 'sign_in', to: 'session#new', as :sign_in"
+      route "delete 'sign_out', to: 'session#destroy', as :sign_out"
     end
   end
+
+  def create_helper
+    create_file "app/helpers/authentication_helper.rb", <<-RUBY
+  module AuthenticationHelper
+    def link_to_sign_in_or_out(show_user: false)
+      if authenticated?
+        button_to "Sign Out", sign_out_path, method: :delete
+      else
+        link_to "Sign In", sign_in_path
+      end
+    end
+
+    def show_username_if_signed_in(text="Signed in as")
+      if authenticated?
+        content = "#{text} #{Current.user.name}"
+        content.html_safe
+      end
+    end
+  end
+    RUBY
+  
+    inject_into_class "app/controllers/application_controller.rb", ApplicationController, <<-RUBY
+  
+    include AuthenticationHelper
+    RUBY
+  end
+
+  def add_name_method_to_user
+    inject_into_class "app/models/user.rb", User, <<-RUBY
+  
+    def name
+      email_address
+    end
+  
+    RUBY
+  end
 end

data/lib/registration_generator/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: registration_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Your Name
-autorequire:
+- DAZ
 bindir: bin
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,10 +23,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: This gem provides a Rails generator to create a registration form and
   related files.
 email:
-- your_email@example.com
+- darren.jones@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -45,7 +58,6 @@ homepage: https://github.com/your_username/registration_generator
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A Rails generator for user registration
 test_files: []