kaze 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a8de2c9dc1c9297b72ca20e60fc00582579e39cf1372ad019d6ab18c28942f
-  data.tar.gz: fadd95b9700cc5409c2cffcaae03ba3ad68cc79b8331b6a9e27612a47d6e5ce7
+  metadata.gz: c65dc7f1acffb3ae6d361fbd4f1172fb46b857611dc0cc96b9229219869a3576
+  data.tar.gz: 5fa72ea32080be5c77a451bbc9cf24d6e8ff1c83af914c0b97004086cfd76e14
 SHA512:
-  metadata.gz: a5bd8c23395b302a93fa836e33c10da76de5681d563f84c1f16ff70317583aa3470e05d03cdfd726257c0ece38ef20c8d72ffe0974e0cbdb14d93a7688a1686c
-  data.tar.gz: 70cd7f58402805e19197e0c9f161ebde8891e5696eafdec0c96dc3017c52fe6f966068329c77f3f55a3e989cc983050694d91a68097502691fed80e4ea4084c0
+  metadata.gz: 51c93d3f462be29745003941d34a1d8d42da5ff6ab8127c59ae4fc9c3ab001cf23094cc5f298262b63d661507bb5e79d93657fce24ea1fd1c82d8de7d7e5ac7f
+  data.tar.gz: 3abcbcda1957bf7415d10fc5c142183ca0227925843b6a1aeebd9c5a158fc5eeed0b855963c60cd785ce4201ac13dcbc169d27cdfe6d3dd12d9b41798d0e7931

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cuong Giang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -2,29 +2,41 @@
 
 # Kaze
 
-Heavily inspired by [Laravel Breeze](https://github.com/laravel/breeze), this gem offers authentication and application starter kits to give you a head start building your new Rails application. These kits automatically scaffold your application with the routes, controllers, and views you need to register and authenticate your application's users.
+Heavily inspired by [Laravel Breeze](https://github.com/laravel/breeze), this gem offers authentication and application starter kits to give you a head start building your new [Rails](https://rubyonrails.org) application. These kits automatically scaffold your application with the routes, controllers, and views you need to register and authenticate your application's users.
 
-[Kaze](https://github.com/gtkvn/kaze) is a minimal, simple implementation of all of Rails's authentication features, including login, registration, password reset. In addition, Kaze includes a simple "profile" page where the user may update their name, email address, and password.
+[Kaze](https://github.com/gtkvn/kaze) is a opinionated minimal, simple implementation of all authentication features that a modern web application should have, including login, registration, password reset, email verification. In addition, Kaze includes a simple "profile" page where the user may update their name, email address, and password.
 
 Kaze provides scaffolding options based on [Hotwire](https://hotwired.dev) or [Inertia](https://inertiajs.com), with the choice of using Vue or React for the Inertia-based scaffolding.
 
 ## Installation
 
-First, you should create a new Rails application, configure your database, and run your database migrations.
+Before creating your first project powered by Kaze, make sure that your local machine has Ruby installed. Ruby can be installed in minutes via [mise](https://mise.jdx.dev).
 
-You may install Kaze globally with:
+```
+mise use -g ruby@3.3
+```
+
+After you have installed Ruby, you may install `rails` and `kaze` gems globally:
 
 ```
+gem install rails
 gem install kaze
 ```
 
-Once Kaze is installed, you may scaffold your application using one of the Kaze "stacks" discussed in the documentation below.
+Then, you may create a new Rails application:
+
+```
+rails new kaze-example-app
+cd kaze-example-app
+```
+
+Once the project has been created, you may scaffold your application using one of the Kaze "stacks" discussed in the documentation below.
 
-## Kaze & Hotwire
+## Kaze and Hotwire
 
 The default Kaze "stack" is the Hotwire stack. Hotwire is a powerful way to building dynamic, reactive, front-end UIs primarily using Ruby and ERB templates without using much JavaScript by sending HTML instead of JSON over the wire.
 
-The Hotwire stack may be installed by invoking the `install` command with no other additional arguments inside your app directory.
+The Hotwire stack may be installed by invoking the `kaze install` command with no other additional arguments inside your app directory. This command publishes the authentication, views, routes, controllers, and other resources to your application.
 
 ```
 kaze install
@@ -37,13 +49,13 @@ bin/setup
 bin/dev
 ```
 
-Next, you may navigate to your application's `/login` or `/register` URLs in your web browser.
+Next, you may navigate to your application's `/login` or `/register` URLs in your web browser. All of Kaze's routes are defined within the `config/routes.rb` file.
 
-## Kaze & React / Vue
+## Kaze and React / Vue
 
 Kaze offers React and Vue scaffolding via an Inertia frontend implementation. Inertia allows you to build modern, single-page React and Vue applications using classic server-side routing and controllers.
 
-Inertia lets you enjoy the frontend power of React and Vue combined with the incredible backend productivity of Rails and lightning-fast Vite compilation. To use an Inertia stack, specify `react` or `vue` as your desired stack when executing the `install` command inside your app directory:
+Inertia lets you enjoy the frontend power of React and Vue combined with the incredible backend productivity of Rails and lightning-fast Vite compilation. To use an Inertia stack, specify `react` or `vue` as your desired stack when executing the `kaze install` command:
 
 ```
 kaze install react
@@ -60,4 +72,4 @@ bin/setup
 bin/dev
 ```
 
-Next, you may navigate to your application's `/login` or `/register` URLs in your web browser.
+Next, you may navigate to your application's `/login` or `/register` URLs in your web browser. All of Kaze's routes are defined within the `config/routes.rb` file.

data/lib/kaze/commands/install_command.rb

@@ -11,17 +11,11 @@ class Kaze::Commands::InstallCommand < Thor
   def install(stack = 'hotwire')
     return say 'Kaze must be run in a new Rails application.', :red unless File.exist?("#{Dir.pwd}/bin/rails")
 
-    if stack == 'hotwire'
-      return install_hotwire_stack
-    end
+    return install_hotwire_stack if stack == 'hotwire'
 
-    if stack == 'react'
-      return install_inertia_react_stack
-    end
+    return install_inertia_react_stack if stack == 'react'
 
-    if stack == 'vue'
-      return install_inertia_vue_stack
-    end
+    return install_inertia_vue_stack if stack == 'vue'
 
     say 'Invalid stack. Supported stacks are [hotwire], [react], [vue].', :red
   end
@@ -53,14 +47,14 @@ class Kaze::Commands::InstallCommand < Thor
   end
 
   def install_migrations
-    ensure_directory_exists("#{Dir.pwd}/db/migrate")
-    FileUtils.copy_entry("#{File.dirname(__FILE__)}/../../../stubs/default/db/migrate", "#{Dir.pwd}/db/migrate")
     stdin, _ = Open3.capture3("#{Dir.pwd}/bin/rails version")
     versions = stdin.gsub!('Rails ', '').split('.')
     railsVersion = [ versions[0], versions[1] ].join('.')
+
+    ensure_directory_exists("#{Dir.pwd}/db/migrate")
+    FileUtils.copy_entry("#{File.dirname(__FILE__)}/../../../stubs/default/db/migrate", "#{Dir.pwd}/db/migrate")
     Dir.children("#{Dir.pwd}/db/migrate").each do |file|
-      path = "#{Dir.pwd}/db/migrate/#{file}"
-      File.write(path, File.read(path).gsub!(/ActiveRecord::Migration$/, "ActiveRecord::Migration[#{railsVersion}]"))
+      replace_in_file(/ActiveRecord::Migration$/, "ActiveRecord::Migration[#{railsVersion}]", "#{Dir.pwd}/db/migrate/#{file}")
     end
   end
 
@@ -76,15 +70,19 @@ class Kaze::Commands::InstallCommand < Thor
     FileUtils.mkdir_p(path) unless File.directory?(path)
   end
 
+  def replace_in_file(search, replace, path)
+    File.write(path, File.read(path).gsub!(search, replace))
+  end
+
   def run_command(command)
     Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
       stdout_thread = Thread.new do
-        while (line = stdout.gets) do
+        while line = stdout.gets do
           say line
         end
       end
       stderr_thread = Thread.new do
-        while (line = stderr.gets) do
+        while line = stderr.gets do
           say line, :red
         end
       end

data/lib/kaze/commands/installs_inertia_stacks.rb

@@ -60,7 +60,7 @@ module Kaze::Commands::InstallsInertiaStacks
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/default/bin/dev", "#{Dir.pwd}/bin/dev")
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/inertia-common/bin/vite", "#{Dir.pwd}/bin/vite")
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/default/Procfile.dev", "#{Dir.pwd}/Procfile.dev")
-    File.write("#{Dir.pwd}/Procfile.dev", "#{File.read("#{Dir.pwd}/Procfile.dev")}\nvite: bundle exec rake js:routes:typescript && bin/vite dev\n")
+    File.write("#{Dir.pwd}/Procfile.dev", "#{File.read("#{Dir.pwd}/Procfile.dev")}\nvite: bin/vite dev\n")
     run_command("#{Dir.pwd}/bin/rails generate js_routes:middleware")
     run_command("#{Dir.pwd}/bin/rails tailwindcss:build")
 
@@ -140,7 +140,7 @@ module Kaze::Commands::InstallsInertiaStacks
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/default/bin/dev", "#{Dir.pwd}/bin/dev")
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/inertia-common/bin/vite", "#{Dir.pwd}/bin/vite")
     FileUtils.copy_file("#{File.dirname(__FILE__)}/../../../stubs/default/Procfile.dev", "#{Dir.pwd}/Procfile.dev")
-    File.write("#{Dir.pwd}/Procfile.dev", "#{File.read("#{Dir.pwd}/Procfile.dev")}\nvite: bundle exec rake js:routes:typescript && bin/vite dev\n")
+    File.write("#{Dir.pwd}/Procfile.dev", "#{File.read("#{Dir.pwd}/Procfile.dev")}\nvite: bin/vite dev\n")
     run_command("#{Dir.pwd}/bin/rails generate js_routes:middleware")
     run_command("#{Dir.pwd}/bin/rails tailwindcss:build")
 

data/lib/kaze/version.rb

@@ -1,3 +1,3 @@
 module Kaze
-  VERSION = '0.10.0'
+  VERSION = '0.12.0'
 end

data/stubs/default/app/models/concerns/must_verify_email.rb

@@ -1,6 +1,4 @@
 module MustVerifyEmail
-  extend ActiveSupport::Concern
-
   def has_verified_email?
     !email_verified_at.nil?
   end

data/stubs/default/db/migrate/20240101000000_create_users.rb

@@ -1,11 +1,11 @@
 class CreateUsers < ActiveRecord::Migration
   def self.up
     create_table :users do |table|
-      table.string :name
-      table.string :email
-      table.timestamp :email_verified_at, null: true
-      table.string :password_digest
-      table.string :remember_token, null: true
+      table.string :name, null: false
+      table.string :email, null: false
+      table.timestamp :email_verified_at
+      table.string :password_digest, null: false
+      table.string :remember_token
       table.timestamps
     end
   end

data/stubs/hotwire/app/components/modal_component.rb

@@ -8,7 +8,7 @@ class ModalComponent < ViewComponent::Base
       lg: 'sm:max-w-lg',
       xl: 'sm:max-w-xl',
       '2xl': 'sm:max-w-2xl'
-    }[attributes[:max_width] || '2xl']
+    }[(attributes[:max_width] || '2xl').to_sym]
     @attributes = attributes.without(:name, :show, :max_width)
   end
 end

data/stubs/hotwire/app/controllers/profile_controller.rb

@@ -22,7 +22,7 @@ class ProfileController < ApplicationController
   def destroy
     @delete_user_form = DeleteUserForm.new(params.permit(:password))
 
-    return render partial: 'profile/partials/delete_user_form', status: :unprocessable_entity if @delete_user_form.invalid?
+    return render turbo_stream: turbo_stream.replace('confirm_user_deletion_modal', partial: 'profile/partials/confirm_user_deletion_modal'), status: :unprocessable_entity if @delete_user_form.invalid?
 
     user = Current.auth.user
 

data/stubs/hotwire/app/views/profile/partials/_confirm_user_deletion_modal.html.erb

@@ -0,0 +1,25 @@
+<div id="confirm_user_deletion_modal">
+  <%= render(ModalComponent.new({ name: "confirm-user-deletion", show: @delete_user_form.error_messages.has_key?(:password), focusable: true })) do %>
+    <%= form_with model: @delete_user_form, url: profile_destroy_path, method: "delete", class: "p-6" do %>
+      <h2 class="text-lg font-medium text-gray-900 dark:text-gray-100">
+        Are you sure you want to delete your account?
+      </h2>
+      <p class="mt-1 text-sm text-gray-600 dark:text-gray-400">
+        Once your account is deleted, all of its resources and data will be permanently deleted. Please enter your password to confirm you would like to permanently delete your account.
+      </p>
+      <div class="mt-6">
+        <%= render(InputLabelComponent.new({ for: "password", value: "Password", class: "sr-only" })) %>
+        <%= render(TextInputComponent.new({ id: "password", class: "mt-1 block w-3/4", type: "password", name: "password", placeholder: "Password" })) %>
+        <%= render(InputErrorComponent.new({ class: "mt-2", message: @delete_user_form.error_messages[:password] })) %>
+      </div>
+      <div class="mt-6 flex justify-end">
+        <%= render(SecondaryButtonComponent.new({ "x-on:click": "$dispatch('close')" })) do %>
+          Cancel
+        <% end %>
+        <%= render(DangerButtonComponent.new({ class: "ms-3" })) do %>
+          Delete Account
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+</div>

data/stubs/hotwire/app/views/profile/partials/_delete_user_form.html.erb

@@ -10,29 +10,5 @@
   <%= render(DangerButtonComponent.new({"x-data": "", "x-on:click.prevent": "$dispatch('open-modal', 'confirm-user-deletion')"})) do %>
     Delete Account
   <% end %>
-  <%= render(ModalComponent.new({ name: "confirm-user-deletion", show: @delete_user_form.error_messages.has_key?(:password), focusable: true })) do %>
-    <turbo-frame id="delete_user_form">
-      <%= form_with model: @delete_user_form, url: profile_destroy_path, method: "delete", class: "p-6" do %>
-        <h2 class="text-lg font-medium text-gray-900 dark:text-gray-100">
-          Are you sure you want to delete your account?
-        </h2>
-        <p class="mt-1 text-sm text-gray-600 dark:text-gray-400">
-          Once your account is deleted, all of its resources and data will be permanently deleted. Please enter your password to confirm you would like to permanently delete your account.
-        </p>
-        <div class="mt-6">
-          <%= render(InputLabelComponent.new({ for: "password", value: "Password", class: "sr-only" })) %>
-          <%= render(TextInputComponent.new({ id: "password", class: "mt-1 block w-3/4", type: "password", name: "password", placeholder: "Password" })) %>
-          <%= render(InputErrorComponent.new({ class: "mt-2", message: @delete_user_form.error_messages[:password] })) %>
-        </div>
-        <div class="mt-6 flex justify-end">
-          <%= render(SecondaryButtonComponent.new({ "x-on:click": "$dispatch('close')" })) do %>
-            Cancel
-          <% end %>
-          <%= render(DangerButtonComponent.new({ class: "ms-3" })) do %>
-            Delete Account
-          <% end %>
-        </div>
-      <% end %>
-    </turbo-frame>
-  <% end %>
+  <%= render 'profile/partials/confirm_user_deletion_modal' %>
 </section>

data/stubs/hotwire/app/views/welcome/index.html.erb

@@ -3,7 +3,6 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
-    <meta name="turbo-visit-control" content="reload">
     <title><%= content_for(:title) || "Rails" %></title>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaze
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Cuong Giang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - bin/kaze
 - lib/kaze.rb
@@ -150,6 +151,7 @@ files:
 - stubs/hotwire/app/views/layouts/application.html.erb
 - stubs/hotwire/app/views/layouts/guest.html.erb
 - stubs/hotwire/app/views/profile/edit.html.erb
+- stubs/hotwire/app/views/profile/partials/_confirm_user_deletion_modal.html.erb
 - stubs/hotwire/app/views/profile/partials/_delete_user_form.html.erb
 - stubs/hotwire/app/views/profile/partials/_update_password_form.html.erb
 - stubs/hotwire/app/views/profile/partials/_update_profile_information_form.html.erb
@@ -260,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -270,5 +272,6 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Minimal Rails authentication scaffolding with Hotwire, Vue, or React + Tailwind.
+summary: Opinionated minimal Rails authentication scaffolding with Hotwire, React,
+  or Vue + Tailwind.
 test_files: []