kaze 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a8de2c9dc1c9297b72ca20e60fc00582579e39cf1372ad019d6ab18c28942f
-  data.tar.gz: fadd95b9700cc5409c2cffcaae03ba3ad68cc79b8331b6a9e27612a47d6e5ce7
+  metadata.gz: 801eeb176444975c22103b1c30236940bc4f039cbd78247f0dd953adceb14e2a
+  data.tar.gz: 7a0023977ffddbcdc64c30969fcbfe7f467df905636196433eb39f0adc65dda0
 SHA512:
-  metadata.gz: a5bd8c23395b302a93fa836e33c10da76de5681d563f84c1f16ff70317583aa3470e05d03cdfd726257c0ece38ef20c8d72ffe0974e0cbdb14d93a7688a1686c
-  data.tar.gz: 70cd7f58402805e19197e0c9f161ebde8891e5696eafdec0c96dc3017c52fe6f966068329c77f3f55a3e989cc983050694d91a68097502691fed80e4ea4084c0
+  metadata.gz: 9e69b526a0219cb6bad9268ccf6f312fe81a020f6925988eb4eb4d7733f5264bd02167c9b4f13c96daf1dcb0bece48eef41c2fa68a27b80b2b9ad8f917f37d8a
+  data.tar.gz: d683e46426ef76a6356343ade5d5e6026c5a05020daa3fc599e4279e73c31c09d1b18eae029bb9d8324f89fc429c4368beedf1089d273173e74c567ee76a412e

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.11.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,13 @@
 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.integer :current_team_id
+      table.string :profile_photo_path, limit: 2048
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaze
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Cuong Giang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -260,7 +260,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:
   - - ">="