inline_forms_installer 8.0.3 → 8.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d4fdc2c47dbae9f0fb05f32157e77326029df28eae8c529655779d417d791a
-  data.tar.gz: d21272dbbdd19be64fd742f267054fca738afc40cffbda9cbfe74dfb1bf2982a
+  metadata.gz: d6570363351e7a504578a5e2bba393ec1b7fcd0c5dd3190bbb975a19b1347d8e
+  data.tar.gz: 05ec0f8cde0a8ffdafb8a1d5444c2d2246704343d333fe9af49ed8691d6f3a0e
 SHA512:
-  metadata.gz: 51085fde767560341594f9d3c3da50b8a6085b06bfef3a3ba4826e63a21de5f5278d43fdee437b1e6c45f44738bb81b3fc7e3cde5bd471dee6fe5581a7bb0bcf
-  data.tar.gz: 1f4f9a714507ac6ba8658418a0586d1f006591f3ea9ffe6a0f655390211e7ea090a74c35f5f18cf8bbf61bbbd5b2a4fa0f52cf4f17ba223aba0b6c6f6bb8ba60
+  metadata.gz: f74cde7fd33066320e1d971713c85854c9e6089958970c6b617d32f9ba3a717df6a08728dcfaed7c4c3670be0019089a5d2ea729625be10a85d398bf439cfa97
+  data.tar.gz: 28047b073197118349feba7ce2347ac6dc20a82f0933c1c8550cf009066c11b0f402e87b1c053d49bdbc1ca836a1b5adfe1d936bd39b350a9ec8cfb0bf42067f

data/lib/inline_forms_installer/creator.rb

@@ -22,6 +22,7 @@ module InlineFormsInstaller
     method_option :email, :aliases => "-e", :default => "admin@example.com", :desc => "specify admin email"
     method_option :password, :aliases => "-p", :default => "admin999", :desc => "specify admin password"
     method_option :skiprvm, :aliases => "--no-rvm", :type => :boolean, :default => false, :desc => "install inline_forms without RVM"
+    method_option :user_model, :aliases => "-U", :default => "User", :banner => "CLASS", :desc => "Devise model class (e.g. Member); Warden scope stays :user (current_user)"
 
     def create(app_name)
       def self.skiprvm
@@ -59,6 +60,13 @@ module InlineFormsInstaller
         exit 1
       end
 
+      begin
+        user_model_cfg = InlineFormsInstaller::UserModelConfig.from_name(options[:user_model].to_s)
+      rescue ArgumentError => e
+        say "Error: #{e.message}", :red
+        exit 1
+      end
+
       inline_forms_version = InlineFormsInstaller.inline_forms_version
       # The Gemfile pins `gem "inline_forms", "~> 8"`, so Bundler resolves the
       # highest 8.x available on RubyGems at install time. The
@@ -67,7 +75,8 @@ module InlineFormsInstaller
       # report the constraint instead of a misleading exact version, and let
       # `print_create_summary` read the actual locked versions from the
       # generated app's Gemfile.lock once `bundle install` is done.
-      say "Creating #{app_name} (inline_forms ~> 8) with development database #{database}...", :green
+      user_model_note = user_model_cfg.default? ? "" : " (auth model: #{user_model_cfg.class_name})"
+      say "Creating #{app_name} (inline_forms ~> 8) with development database #{database}#{user_model_note}...", :green
 
       regex = /\A[0-9a-zA-Z][0-9a-zA-Z_-]+[0-9a-zA-Z]\Z/
       if !regex.match(app_name)

data/lib/inline_forms_installer/installer_core.rb

@@ -3,6 +3,7 @@ require "shellwords"
 INSTALLER_ROOT = File.expand_path(ENV.fetch("INLINE_FORMS_INSTALLER_ROOT", File.expand_path("..", __dir__)))
 INLINE_FORMS_ROOT = File.expand_path(ENV.fetch("INLINE_FORMS_ROOT", INSTALLER_ROOT))
 require File.join(INSTALLER_ROOT, "lib", "inline_forms_installer", "create_log")
+require File.join(INSTALLER_ROOT, "lib", "inline_forms_installer", "user_model_config")
 
 def use_app_rvm_gemset!
   return if ENV["skiprvm"] == "true"
@@ -262,11 +263,16 @@ say "\n *** Please make sure to create a mysql production database and use 'rail
 say "- Devise install..."
 run "bundle exec rails g devise:install"
 
+user_cfg = InlineFormsInstaller::UserModelConfig.from_env
+unless user_cfg.default?
+  say "- Auth model #{user_cfg.class_name} (#{user_cfg.table_name} table; Warden scope :user → current_user)", :green
+end
+
 say "- Create Devise route and add path_prefix..."
 
 route <<-ROUTE.strip_heredoc
-devise_for :users, :path_prefix => 'auth'
-  resources :users do
+#{user_cfg.devise_route_line}
+  resources :#{user_cfg.plural_route} do
     post 'revert', :on => :member
     get 'list_versions', :on => :member
 end
@@ -278,11 +284,11 @@ sleep 1 # to get unique migration number
 create_file "db/migrate/" +
   Time.now.utc.strftime("%Y%m%d%H%M%S") +
   "_" +
-  "devise_create_users.rb", <<-DEVISE_MIGRATION.strip_heredoc
-class DeviseCreateUsers < ActiveRecord::Migration[8.0]
+  "#{user_cfg.devise_migration_basename}.rb", <<-DEVISE_MIGRATION.strip_heredoc
+class #{user_cfg.devise_migration_class} < ActiveRecord::Migration[8.0]
 
   def change
-    create_table(:users) do |t|
+    create_table(:#{user_cfg.table_name}) do |t|
       ## Database authenticatable
       t.string :email,              null: false, default: ""
       t.string :encrypted_password, null: false, default: ""
@@ -318,24 +324,24 @@ class DeviseCreateUsers < ActiveRecord::Migration[8.0]
       t.timestamps
     end
 
-    add_index :users, :email,                unique: true
-    add_index :users, :reset_password_token, unique: true
-    # add_index :users, :confirmation_token,   unique: true
-    # add_index :users, :unlock_token,         unique: true
+    add_index :#{user_cfg.table_name}, :email,                unique: true
+    add_index :#{user_cfg.table_name}, :reset_password_token, unique: true
+    # add_index :#{user_cfg.table_name}, :confirmation_token,   unique: true
+    # add_index :#{user_cfg.table_name}, :unlock_token,         unique: true
   end
 end
 DEVISE_MIGRATION
 
-say "- Create User Controller..."
-create_file "app/controllers/users_controller.rb", <<-USERS_CONTROLLER.strip_heredoc
-  class UsersController < InlineFormsController
-    set_tab :user
+say "- Create #{user_cfg.class_name} controller..."
+create_file user_cfg.controller_path, <<-USERS_CONTROLLER.strip_heredoc
+  class #{user_cfg.controller_name} < InlineFormsController
+    set_tab :#{user_cfg.tab_key}
   end
 USERS_CONTROLLER
 
-say "- Create User Model..."
-create_file "app/models/user.rb", <<-USER_MODEL.strip_heredoc
-  class User < ApplicationRecord
+say "- Create #{user_cfg.class_name} model..."
+create_file user_cfg.model_path, <<-USER_MODEL.strip_heredoc
+  class #{user_cfg.class_name} < ApplicationRecord
 
     # devise options
     devise :database_authenticatable
@@ -413,36 +419,36 @@ USER_MODEL
 
 # Create Locales
 say "- Create locales"
-generate "inline_forms", "Locale name:string title:string users:has_many _enabled:yes _presentation:\#{title}"
+generate "inline_forms", "Locale name:string title:string #{user_cfg.table_name}:has_many _enabled:yes _presentation:\#{title}"
 append_to_file "db/seeds.rb", "Locale.create({ id: 1, name: 'en', title: 'English' })\n"
 
 # Create Roles
 say "- Create roles"
-generate "inline_forms", "Role name:string description:text users:has_and_belongs_to_many _enabled:yes _presentation:\#{name}"
+generate "inline_forms", "Role name:string description:text #{user_cfg.table_name}:has_and_belongs_to_many _enabled:yes _presentation:\#{name}"
 append_to_file "db/seeds.rb", "Role.create({ id: 1, name: 'superadmin', description: 'Super Admin can access all.' })\n"
 
 # Create Admin User
 
-say "- Adding admin user with email: #{ENV['email']}, password: #{ENV['password']} to seeds.rb"
-append_to_file "db/seeds.rb", "User.create({ id: 1, email: '#{ENV['email']}', locale_id: 1, name: 'Admin', password: '#{ENV['password']}', password_confirmation: '#{ENV['password']}' })\n"
+say "- Adding admin #{user_cfg.class_name.downcase} with email: #{ENV['email']}, password: #{ENV['password']} to seeds.rb"
+append_to_file "db/seeds.rb", "#{user_cfg.class_name}.create({ id: 1, email: '#{ENV['email']}', locale_id: 1, name: 'Admin', password: '#{ENV['password']}', password_confirmation: '#{ENV['password']}' })\n"
 
 
 sleep 1 # to get unique migration number
 create_file "db/migrate/" +
   Time.now.utc.strftime("%Y%m%d%H%M%S") +
   "_" +
-  "inline_forms_create_join_table_user_role.rb", <<-ROLES_MIGRATION.strip_heredoc
-  class InlineFormsCreateJoinTableUserRole < ActiveRecord::Migration[8.0]
+  "#{user_cfg.join_migration_basename}.rb", <<-ROLES_MIGRATION.strip_heredoc
+  class #{user_cfg.join_migration_class} < ActiveRecord::Migration[8.0]
     def self.up
-      create_table  :roles_users, :id => false, :force => true do |t|
+      create_table  :#{user_cfg.join_table}, :id => false, :force => true do |t|
         t.integer   :role_id
-        t.integer   :user_id
+        t.integer   :#{user_cfg.foreign_key}
       end
-      execute 'INSERT INTO roles_users VALUES (1,1);'
+      execute 'INSERT INTO #{user_cfg.join_table} VALUES (1,1);'
     end
 
     def self.down
-      drop_table roles_users
+      drop_table #{user_cfg.join_table}
     end
   end
 ROLES_MIGRATION
@@ -611,7 +617,7 @@ create_file "app/models/ability.rb", <<-END_ABILITY.strip_heredoc
     def initialize(user)
       # See the wiki for details: https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities
 
-      user ||= User.new # guest user
+      user ||= #{user_cfg.class_name}.new # guest user
 
       # use this if you get stuck:
       # if user.id == 1 #quick hack
@@ -1060,9 +1066,10 @@ if ENV['install_example'] == 'true'
   route "root :to => 'apartments#index'"
 
   example_tests_root = File.join(INSTALLER_ROOT, "lib/installer_templates/example_app_tests")
+  example_user_cfg = InlineFormsInstaller::UserModelConfig.from_env
   Dir.glob(File.join(example_tests_root, "**", "*.rb")).sort.each do |abs|
     rel = abs.delete_prefix(example_tests_root + File::SEPARATOR).tr("\\", "/")
-    create_file rel, File.read(abs)
+    create_file rel, example_user_cfg.adapt_example_test_source(File.read(abs))
   end
 
   say "- Running example regression tests (bundle exec rails test)..."

data/lib/inline_forms_installer/user_model_config.rb

@@ -0,0 +1,104 @@
+# -*- encoding : utf-8 -*-
+require "active_support/core_ext/string/inflections"
+
+module InlineFormsInstaller
+  # Devise mapping stays on :users (Warden scope :user → current_user in inline_forms).
+  # A custom class (e.g. Member) uses members table, /members routes, and
+  # devise_for :users, class_name: "Member", path: "members".
+  class UserModelConfig
+    DEFAULT_CLASS = "User"
+
+    def self.from_env(env = ENV)
+      from_name(env["user_model"].to_s.strip)
+    end
+
+    def self.from_name(name)
+      name = DEFAULT_CLASS if name.empty?
+      new(name)
+    end
+
+    def initialize(class_name)
+      unless class_name.match?(/\A[A-Z][A-Za-z0-9]*\z/)
+        raise ArgumentError, "user model must be a Ruby constant (e.g. User, Member)"
+      end
+
+      @class_name = class_name
+    end
+
+    attr_reader :class_name
+
+    def default?
+      class_name == DEFAULT_CLASS
+    end
+
+    def table_name
+      class_name.tableize
+    end
+
+    def plural_route
+      table_name
+    end
+
+    def foreign_key
+      "#{class_name.underscore}_id"
+    end
+
+    # Rails HABTM join table: plural model names in lexical order (roles_users, members_roles).
+    def join_table
+      return "roles_users" if default?
+
+      [table_name, "roles"].sort.join("_")
+    end
+
+    def controller_name
+      "#{class_name.pluralize}Controller"
+    end
+
+    def controller_path
+      "app/controllers/#{table_name}_controller.rb"
+    end
+
+    def model_path
+      "app/models/#{class_name.underscore}.rb"
+    end
+
+    def tab_key
+      class_name.underscore.to_sym
+    end
+
+    def devise_migration_basename
+      "devise_create_#{table_name}"
+    end
+
+    def devise_migration_class
+      "DeviseCreate#{class_name.pluralize}"
+    end
+
+    def join_migration_basename
+      "inline_forms_create_join_table_#{class_name.underscore}_role"
+    end
+
+    def join_migration_class
+      "InlineFormsCreateJoinTable#{class_name}Role"
+    end
+
+    def devise_route_line
+      if default?
+        "devise_for :users, :path_prefix => 'auth'"
+      else
+        "devise_for :users, class_name: \"#{class_name}\", path: \"#{plural_route}\", path_prefix: 'auth'"
+      end
+    end
+
+    def sign_in_path_fragment
+      "/auth/#{default? ? 'users' : plural_route}/sign_in"
+    end
+
+    def adapt_example_test_source(content)
+      return content if default?
+
+      content = content.gsub("User", class_name)
+      content.gsub(%r{/auth/users/sign_in}, sign_in_path_fragment)
+    end
+  end
+end

data/lib/inline_forms_installer/version.rb

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 module InlineFormsInstaller
-  VERSION = "8.0.3"
+  VERSION = "8.0.4"
 
   # Written into generated apps' `.ruby-version` (must match gemspec `required_ruby_version`).
   TARGET_RUBY_VERSION = "ruby-4.0.4"

data/lib/inline_forms_installer.rb

@@ -79,4 +79,5 @@ module InlineFormsInstaller
   end
 end
 
+require "inline_forms_installer/user_model_config"
 require "inline_forms_installer/creator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inline_forms_installer
 version: !ruby/object:Gem::Version
-  version: 8.0.3
+  version: 8.0.4
 platform: ruby
 authors:
 - Ace Suares
@@ -81,6 +81,7 @@ files:
 - lib/inline_forms_installer/create_log.rb
 - lib/inline_forms_installer/creator.rb
 - lib/inline_forms_installer/installer_core.rb
+- lib/inline_forms_installer/user_model_config.rb
 - lib/inline_forms_installer/version.rb
 - lib/installer_templates/capistrano/Capfile
 - lib/installer_templates/capistrano/deploy.rb