devise-guests 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776fbee405a1074096bd13610d3691a1016244e35aa1b25cd36d437077da6d56
-  data.tar.gz: 9d61df8e8b059d679d3a614bc6ffacd72d80a50b8568d7ab03a6aabb2e027611
+  metadata.gz: 1cf09de56176a4e1572a0d31dedb4c8583483f6b93706ef6b026c9ecbc191eaf
+  data.tar.gz: a91ee992b8c0302a08946c7dfa3416f0a53200b909188419cfd11c0fbac415cb
 SHA512:
-  metadata.gz: 9194038c18a01eaae39f335533d200e4a36acb054af5ac60f9da912b022714162d3240c4c2943bb0d58c6738a9b9e50253dafc078afc689e5055a2e16b541f67
-  data.tar.gz: 4538fc330f09a7678e94b3c4aa21619f93e5469cae3a4159a556c17a14f43960108aa10be69f8f42e0b9ff17ad60e9d71b8e8b8308f1d62bae12ab08471c956a
+  metadata.gz: 3158f2d0423e1153bcc26e34539ae063f4e81fb6a761ee48f26ee3f428b7d060b6604ac3553ca0e41a949f9655918947ae7b2926f7c6d8e9182554f74d789b08
+  data.tar.gz: f792e1da66916f9c29ee2aacf8030fb01614f80c1bc66f0477e398b8a63610ccee2bbcf48618e046e087db0a44ea7590ea75858bed7790b365088a9d10cd96b7

data/.github/workflows/tests.yml

@@ -12,24 +12,55 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - labeled
+      - unlabeled
 
 jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - id: read-version
+        run: |
+          echo "::set-output name=VERSION::`cat lib/devise-guests/version.rb | grep -i version | awk '{ print $3 }' | sed -e 's/\"//g'`"
+      - uses: dangoslen/changelog-enforcer@v2.3.1
+        with:
+          skipLabels: 'skip-changelog'
+          expectedLatestVersion: ${{ steps.read-version.outputs.VERSION }}
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+          cache-version: 1
+      - run: bundle exec standardrb
   test:
-
+    needs:
+      - changelog
+      - lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby: ['2.7', '3.0', '3.1', '3.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
       with:
-        ruby-version: ${{ matrix.ruby-version }}
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        cache-version: 1
     - name: Run tests
       run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.8.2] - 2023-12-24
+### Fixed
+- Prevent crashing processes due to loading all guest users in memory during delete_old_guest_users task ([#42](https://github.com/cbeer/devise-guests/pull/42))
+
+### Changed
+- Update README with better detail around data migration ([#49](https://github.com/cbeer/devise-guests/pull/49)) by [@joshmenden](https://github.com/joshmenden)
+- Update supported ruby versions ([#50](https://github.com/cbeer/devise-guests/pull/50)) by [@pacso](https://github.com/pacso)
+
+## [0.8.1] - 2021-10-26
+### Changed
+- Simplify guest transfer ([#38](https://github.com/cbeer/devise-guests/pull/38))
+
+## [0.8.0] - 2021-10-25
+### Added
+- Allow setting of custom params on guest model ([#31](https://github.com/cbeer/devise-guests/pull/31)) by [@pacso](https://github.com/pacso)
+- Allow deletion of guest records to optionally be skipped ([#32](https://github.com/cbeer/devise-guests/pull/32)) by [@pacso](https://github.com/pacso)
+
+### Changed
+- Switch to SecureRandom.uuid for guest_user_unique_suffix ([#28](https://github.com/cbeer/devise-guests/pull/28)) by [@notch8](https://github.com/notch8)
+- Update combustion gem ([#29](https://github.com/cbeer/devise-guests/pull/29)) by [@notch8](https://github.com/notch8)
+
+### Fixed
+- Defining the logging_in callback when the controller loads ([#34](https://github.com/cbeer/devise-guests/pull/34)) by [@davidkuz](https://github.com/davidkuz)
+
+[Unreleased]: https://github.com/cbeer/devise-guests/compare/v0.8.1...HEAD
+[0.8.1]: https://github.com/cbeer/devise-guests/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/cbeer/devise-guests/compare/v0.7.0...v0.8.0

data/README.md

@@ -1,4 +1,5 @@
 # Devise Guests
+[![Gem Version](https://badge.fury.io/rb/devise-guests.svg)](https://badge.fury.io/rb/devise-guests)
 [![Tests](https://github.com/cbeer/devise-guests/actions/workflows/tests.yml/badge.svg)](https://github.com/cbeer/devise-guests/actions/workflows/tests.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
@@ -40,15 +41,12 @@ guest_user # ( for anonymous users)
 
 ### Transferring Guest to User on Login
 
-During the login process you may want to transfer things from your guest user to the account the logged into.
-To do so, modify your ApplicationController like so:
+During the login process you may want to transfer things from your guest user to the account they logged into.
+To do so, add the following method to your ApplicationController:
 
 ```ruby
-define_callbacks :logging_in_user
-set_callback :logging_in_user, :before, :transfer_guest_to_current_user
-
 private
-def transfer_guest_to_current_user
+def transfer_guest_to_user
   # At this point you have access to:
   #   * current_user - the user they've just logged in as
   #   * guest_user - the guest user they were previously identified by
@@ -60,6 +58,13 @@ def transfer_guest_to_current_user
   else
     guest_user.cart.update!(user: current_user)
   end
+
+  # In this example we've moved `LineItem` records from the guest
+  # user's cart to the logged-in user's cart.
+  #
+  # To prevent these being deleted when the guest user & cart are
+  # destroyed, we need to reload the guest record:
+  guest_user.reload
 end
 ```
 
@@ -75,6 +80,26 @@ def guest_user_params
 end
 ```
 
+### Non-standard authentication keys
+
+By default Devise will use `:email` as the authentication key for your model. If for some reason you have modified your
+Devise config to use an alternative attribute (such as `:phone_number`) you will need to provide a method to generate
+the value of this attribute for any guest users which are created.
+
+Sticking with the `:phone_number` example, you should define the following method in your `application_controller.rb`:
+
+```ruby
+private
+def guest_phone_number_authentication_key(key)
+  key &&= nil unless key.to_s.match(/^guest/)
+  key ||= "guest_447" + 9.times.map { SecureRandom.rand(0..9) }.join
+end
+```
+
+Validations are skipped when creating guest users, but if you need to rely on future modifications to the guest record
+passing validations, then you should ensure that this default value for guests is generated in such a way as to be
+valid.
+
 ### Prevent deletion of guest records
 
 By default, when signing in from a guest account to an authenticated account, the guest user is destroyed. You have an

data/devise-guests.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "yard"
 
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/devise-guests/controllers/helpers.rb

@@ -74,6 +74,9 @@ module DeviseGuests::Controllers
           false
         end
 
+        def transfer_guest_to_#{mapping}
+        end
+
       METHODS
 
       ActiveSupport.on_load(:action_controller) do
@@ -81,6 +84,7 @@ module DeviseGuests::Controllers
           helper_method "guest_#{mapping}", "current_or_guest_#{mapping}"
         end
         define_callbacks "logging_in_#{mapping}"
+        set_callback :"logging_in_#{mapping}", :"transfer_guest_to_#{mapping}"
       end
     end
   end

data/lib/devise-guests/version.rb

@@ -1,3 +1,3 @@
 module DeviseGuests
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

data/lib/railties/devise_guests.rake

@@ -4,8 +4,10 @@ namespace :devise_guests do
   # example cron entry to delete users older than 7 days at 2:00 AM every day:
   # 0 2 * * * cd /path/to/your/app && /path/to/rake devise_guests:delete_old_guest_users[7] RAILS_ENV=your_env
   desc "Removes entries in the users table for guest users that are older than the number of days given."
-  task :delete_old_guest_users, [:days_old] => [:environment] do |t, args|
-    args.with_defaults(days_old: 7)
-    User.where("guest = ? and updated_at < ?", true, Time.now - args[:days_old].to_i.days).each { |x| x.destroy }
+  task :delete_old_guest_users, [:days_old, :batch_size] => [:environment] do |t, args|
+    args.with_defaults(days_old: 7, batch_size: 1000)
+    User
+      .where("guest = ? and updated_at < ?", true, Time.now - args[:days_old].to_i.days)
+      .find_each(batch_size: batch_size, &:destroy)
   end
 end

data/spec/controllers/application_controller_spec.rb

@@ -35,6 +35,7 @@ describe ApplicationController, type: :controller do
     allow(@controller).to receive(:session) { {guest_user_id: 123} }
 
     expect(@controller).to receive(:run_callbacks).with(:logging_in_user).and_call_original
+    expect(@controller).to receive(:transfer_guest_to_user).and_call_original
 
     @controller.current_or_guest_user
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-guests
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -133,6 +133,7 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -181,22 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Guest user implementation for devise
-test_files:
-- spec/controllers/application_controller_spec.rb
-- spec/helpers/devise_guests_helpers_spec.rb
-- spec/integration/simple_integration_spec.rb
-- spec/internal/app/assets/config/manifest.js
-- spec/internal/app/controllers/application_controller.rb
-- spec/internal/app/models/user.rb
-- spec/internal/config/database.yml
-- spec/internal/config/initializers/devise.rb
-- spec/internal/config/routes.rb
-- spec/internal/config/storage.yml
-- spec/internal/db/schema.rb
-- spec/internal/log/.gitignore
-- spec/internal/public/favicon.ico
-- spec/spec_helper.rb
+test_files: []