rodauth-rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32eea791dff9c98b9e78d209ba375d08095f07ec1d0ba0e852e5af83602e2128
-  data.tar.gz: f12a2c57d4f3dee31efd10c6ba8fd211af62d8636cda5118fcc949642ded1e29
+  metadata.gz: b6bb43d7d1d355de281ce5fe57e1e00a13943f29efe93d39dc98099aa100c78c
+  data.tar.gz: 43034ad43125b0bb56132b57dd27cacdc4e9833c285f98256e67a989da84321c
 SHA512:
-  metadata.gz: c722443088524cfedbffa17336de213dbcb004fe0866cb418f9bdc27a4a3a4b3af0ccd954a991bdc4d5e100278bd4738fc2a17b58a43555ddc725dcc49cca21b
-  data.tar.gz: a97951dd6653c70af6397633b6628450779497a80be7b7dd294fbd09c8f91b4d82fe722190911d7324af7a3ff2c4b9ff274dd55adde8c8983fbc513e5c81d12d
+  metadata.gz: fb66ec48409f5f15f1e0953a8ae8a715cec48811e1ba81ea25015128f360487425c0fd09574da22ece00277e9e488204bc9393212631ec4d3c235f16f3064aaa
+  data.tar.gz: 15cbe441d8ff403f3db98d41710a32d8cb819c1961e5f25187e93411b3ec5dad7b1a0c508e6efa54df8fc08cd169587c07948a4c8da2b70edb7a2751f4bd6b09

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.3.0 (2020-09-18)
+
+* Handle custom configured database migration paths in install generator (@janko)
+
+* Allow specifying features as plain arguments in `rodauth:views` generator (@janko)
+
+* Add some missing foreign key constraints in generated migration file (@janko)
+
 ## 0.2.1 (2020-07-26)
 
 * Fix incorrect JDBC connect syntax in `sequel.rb` template on JRuby (@janko)

data/README.md

@@ -82,10 +82,8 @@ ActiveRecord connection.
 # config/initializers/sequel.rb
 require "sequel/core"
 
-# initialize the appropriate Sequel adapter without creating a connection
-DB = Sequel.postgres(test: false)
-# have Sequel use ActiveRecord's connection for database interaction
-DB.extension :activerecord_connection
+# initialize Sequel and have it reuse Active Record's database connection
+DB = Sequel.postgres(extensions: :activerecord_connection)
 ```
 
 ### Rodauth app
@@ -162,17 +160,24 @@ These links are fully functional, feel free to visit them and interact with the
 pages. The templates that ship with Rodauth aim to provide a complete
 authentication experience, and the forms use [Bootstrap] markup.
 
-Let's also add the `#current_account` method for retrieving the account of the
-the authenticated session:
+Let's also load the account record for authenticated requests and expose it via
+`#current_account`:
 
 ```rb
 # app/controllers/application_controller.rb
 class ApplicationController < ActionController::Base
+  before_action :load_account, if: -> { rodauth.authenticated? }
+
   private
 
-  def current_account
-    @current_account ||= Account.find(rodauth.session_value)
+  def load_account
+    @current_account = Account.find(rodauth.session_value)
+  rescue ActiveRecord::RecordNotFound
+    rodauth.logout
+    rodauth.login_required
   end
+
+  attr_reader   :current_account
   helper_method :current_account
 end
 ```
@@ -258,7 +263,7 @@ You can pass a list of Rodauth features to the generator to create views for
 these features (this will not remove any existing views):
 
 ```sh
-$ rails generate rodauth:views --features login create_account lockout otp
+$ rails generate rodauth:views login create_account lockout otp
 ```
 
 Or you can generate views for all features:

data/lib/generators/rodauth/install_generator.rb

@@ -1,12 +1,11 @@
 require "rails/generators/base"
-require "rails/generators/migration"
-require "rails/generators/active_record"
+require "rails/generators/active_record/migration"
 
 module Rodauth
   module Rails
     module Generators
       class InstallGenerator < ::Rails::Generators::Base
-        include ::Rails::Generators::Migration
+        include ::ActiveRecord::Generators::Migration
 
         source_root "#{__dir__}/templates"
         namespace "rodauth:install"
@@ -14,7 +13,7 @@ module Rodauth
         def create_rodauth_migration
           return unless defined?(ActiveRecord::Base)
 
-          migration_template "db/migrate/create_rodauth.rb", "db/migrate/create_rodauth.rb"
+          migration_template "db/migrate/create_rodauth.rb", File.join(db_migrate_path, "create_rodauth.rb")
         end
 
         def create_rodauth_initializer
@@ -45,38 +44,32 @@ module Rodauth
 
         private
 
-        # required by #migration_template action
-        def self.next_migration_number(dirname)
-          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        def db_migrate_path
+          return "db/migrate" unless activerecord_at_least?(5, 0)
+          super
         end
 
         def migration_version
-          if ActiveRecord.version >= Gem::Version.new("5.0.0")
+          if activerecord_at_least?(5, 0)
             "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
           end
         end
 
-        if RUBY_ENGINE == "jruby"
-          def sequel_adapter
-            case activerecord_adapter
-            when "postgresql" then "postgresql"
-            when "mysql2"     then "mysql"
-            when "sqlite3"    then "sqlite"
-            end
-          end
-        else
-          def sequel_adapter
-            case activerecord_adapter
-            when "postgresql" then "postgres"
-            when "mysql2"     then "mysql2"
-            when "sqlite3"    then "sqlite"
-            end
+        def sequel_adapter
+          case activerecord_adapter
+          when "postgresql" then "postgres#{"ql" if RUBY_ENGINE == "jruby"}"
+          when "mysql2"     then "mysql#{"2" unless RUBY_ENGINE == "jruby"}"
+          when "sqlite3"    then "sqlite"
           end
         end
 
         def activerecord_adapter
           ActiveRecord::Base.connection_config.fetch(:adapter)
         end
+
+        def activerecord_at_least?(major, minor)
+          ActiveRecord.version >= Gem::Version.new("#{major}.#{minor}")
+        end
       end
     end
   end

data/lib/generators/rodauth/templates/config/initializers/sequel.rb

@@ -1,10 +1,8 @@
 require "sequel/core"
 
-# initialize the appropriate Sequel adapter without creating a connection
+# initialize Sequel and have it reuse Active Record's database connection
 <%- if RUBY_ENGINE == "jruby" -%>
-DB = Sequel.connect("jdbc:<%= sequel_adapter %>://", test: false)
+DB = Sequel.connect("jdbc:<%= sequel_adapter %>://", extensions: :activerecord_connection)
 <% else -%>
-DB = Sequel.<%= sequel_adapter %>(test: false)
+DB = Sequel.<%= sequel_adapter %>(extensions: :activerecord_connection)
 <% end -%>
-# have Sequel use ActiveRecord's connection for database interaction
-DB.extension :activerecord_connection

data/lib/generators/rodauth/templates/db/migrate/create_rodauth.rb

@@ -53,7 +53,7 @@ class CreateRodauth < ActiveRecord::Migration<%= migration_version %>
 
     # # Used by the audit logging feature
     # create_table :account_authentication_audit_logs do |t|
-    #   t.references :account, null: false
+    #   t.references :account, foreign_key: true, null: false
     #   t.datetime :at, null: false, default: -> { "CURRENT_TIMESTAMP" }
     #   t.text :message, null: false
 <% case activerecord_adapter -%>
@@ -70,7 +70,7 @@ class CreateRodauth < ActiveRecord::Migration<%= migration_version %>
 
     # # Used by the jwt refresh feature
     # create_table :account_jwt_refresh_keys do |t|
-    #   t.references :account, null: false
+    #   t.references :account, foreign_key: true, null: false
     #   t.string :key, null: false
     #   t.datetime :deadline, null: false
     #   t.index :account_id, name: "account_jwt_rk_account_id_idx"
@@ -78,7 +78,7 @@ class CreateRodauth < ActiveRecord::Migration<%= migration_version %>
 
     # # Used by the disallow_password_reuse feature
     # create_table :account_previous_password_hashes do |t|
-    #   t.references :account
+    #   t.references :account, foreign_key: true
     #   t.string :password_hash, null: false
     # end
 
@@ -124,7 +124,7 @@ class CreateRodauth < ActiveRecord::Migration<%= migration_version %>
 
     # # Used by the active sessions feature
     # create_table :account_active_session_keys, primary_key: [:account_id, :session_id] do |t|
-    #   t.references :account
+    #   t.references :account, foreign_key: true
     #   t.string :session_id
     #   t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
     #   t.datetime :last_use, null: false, default: -> { "CURRENT_TIMESTAMP" }
@@ -136,7 +136,7 @@ class CreateRodauth < ActiveRecord::Migration<%= migration_version %>
     #   t.string :webauthn_id, null: false
     # end
     # create_table :account_webauthn_keys, primary_key: [:account_id, :webauthn_id] do |t|
-    #   t.references :account
+    #   t.references :account, foreign_key: true
     #   t.string :webauthn_id
     #   t.string :public_key, null: false
     #   t.integer :sign_count, null: false

data/lib/generators/rodauth/views_generator.rb

@@ -7,6 +7,21 @@ module Rodauth
         source_root "#{__dir__}/templates"
         namespace "rodauth:views"
 
+        argument :features, optional: true, type: :array,
+          desc: "Rodauth features to generate views for (login, create_account, reset_password, verify_account etc.)",
+          default: %w[login logout create_account verify_account reset_password change_password change_login verify_login_change close_account]
+
+        class_option :features, type: :array,
+          desc: "[DEPRECATED] Rodauth features to generate views for (login, create_account, reset_password, verify_account etc.)"
+
+        class_option :all, aliases: "-a", type: :boolean,
+          desc: "Generates views for all Rodauth features",
+          default: false
+
+        class_option :directory, aliases: "-d", type: :string,
+          desc: "The directory under app/views/* into which to create views",
+          default: "rodauth"
+
         VIEWS = {
           login: %w[
             _field _field_error _login_field _login_display _password_field
@@ -83,20 +98,12 @@ module Rodauth
           webauthn:        :two_factor_base,
         }
 
-        class_option :features, type: :array,
-          desc: "Rodauth features to generate views for (login, create_account, reset_password, verify_account etc.)",
-          default: %w[login logout create_account verify_account reset_password change_password change_login verify_login_change close_account]
-
-        class_option :all, aliases: "-a", type: :boolean,
-          desc: "Generates views for all Rodauth features",
-          default: false
-
-        class_option :directory, aliases: "-d", type: :string,
-          desc: "The directory under app/views/* into which to create views",
-          default: "rodauth"
-
         def create_views
-          features = options[:all] ? VIEWS.keys : options[:features].map(&:to_sym)
+          if options[:all]
+            features = VIEWS.keys
+          else
+            features = (options[:features] || self.features).map(&:to_sym)
+          end
 
           views = features.inject([]) do |list, feature|
             list |= VIEWS[feature] || []

data/rodauth-rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-rails"
-  spec.version       = "0.2.1"
+  spec.version       = "0.3.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties