basecoat 2.0.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1211adbec8da355fa5ec5c1794561f8637b1a0cc08441ad67c560fe550f12b1e
-  data.tar.gz: 9e7569725fcfd26c137868fa764d6302b29c1011bda90d00a39e253f857a2474
+  metadata.gz: 6fa9470ef968e4c5dff1e61b2c016056700d4bac56cb48601d86c7cd6eb0a0e1
+  data.tar.gz: 1116eb1741c23532506854d7243c8785431a7ea9957a6ab097ec952ead59d345
 SHA512:
-  metadata.gz: 0037adf9df5619c1402db0216bb281f340b5008b954a2cb0c1f278165909d5306037183dd93f839a18b09126a5edec914efab7380c339e928ff0144e3d5145d7
-  data.tar.gz: b0ebf8d1841064e080c81a4a3ad57cacff757fa78b6e3f1d9534f200e68702d5f4376645ba12aad92509acfea0a0aa28514e54f71370b432a0405209bf924873
+  metadata.gz: 9ee345ffafaa76be5521b2fb9c9fade4f527517963acdb1f5cd50d283ff469e8704bde799d0b9c6070ffaa200f916e8d5ebb160416ef2466efabf653ef1c5f7d
+  data.tar.gz: e50d6e88672d5f555466e4d12abe0f5dc712b6bb29054403a306964d8fa8ca0d99391a602ae39c3ae588dddb89f00cc96cf5b797de8deed1176178357035b500

data/README.md

@@ -3,84 +3,75 @@
 This gem provides you with amazing layouts, scaffolds, views and partials based on [Basecoat UI](https://basecoatui.com).
 It is especially powerful for admin applications with a lot of CRUD actions.
 
-Beautiful responsive, dark & light mode Rails scaffolds, pages for authentication and Devise, and pagy styling.
-
-
 ![Basecoat Login](basecoat-login.png)
 
-![Basecoat Index](basecoat-new.png)
-
-## Why?
-
-Shadcn has quickly become the default ui for the web. However, sometimes we don't _really_ need all the React components.
-Especially with backend applications - where Rails shines as full stack solution.
-
-This is where basecoat-ui comes in. The reason why I love basecoat is because it combines tailwind with clean css classes (like daisy-ui). 
+![Basecoat Form](basecoat-new.png)
 
-If you need more complex components; enrich the views with https://railsblocks.com/ or https://shadcn.rails-components.com/ or just the shadcn React components themselves.
+## Usage
 
-## Installation
+Try it from scratch:
 
-Add this line to your application's Gemfile in the development group:
+    rails new myproject -c tailwind
+    cd myproject
+    bundle add basecoat
+    rails basecoat:install
+    rails g scaffold Post title:string! description:text posted_at:datetime active:boolean rating:integer 
+    rails db:migrate
+    ./bin/dev
+    # open http://localhost:3000/posts
 
-```ruby
-gem 'basecoat'
-```
+**Note:** Basecoat requires Tailwind CSS. If you haven't installed it yet, follow the instructions at [https://github.com/rails/tailwindcss-rails](https://github.com/rails/tailwindcss-rails) to set up Tailwind CSS in your Rails application.
 
-And then execute:
+## Why?
 
-```bash
-bundle install
-```
+The default scaffolds are ugly. There's no styling, no turbo frames - it's missing the WOW factor.
 
-**Note:** Basecoat requires Tailwind CSS. If you haven't installed it yet, follow the instructions at [https://github.com/rails/tailwindcss-rails](https://github.com/rails/tailwindcss-rails) to set up Tailwind CSS in your Rails application.
+Basecoat CSS combines tailwind with clean css classes. It creates the looks of shadcn, which has a massive community.
 
-## Usage
-
-Run the rake tasks, run a scaffold and observe beauty.
+If you need more complex components; enrich the views with https://railsblocks.com/ or https://shadcn.rails-components.com/ or just the shadcn React components themselves.
 
-### Install Application Layout
+## Rake tasks
 
-Install the Basecoat application layout and partials:
+### Layout (required)
 
 ```bash
 rake basecoat:install
 ```
-NB: This could overwrite exising files!
+NB: Only run this once.
 
 The generated views will include:
 *  Basecoat CSS styling
 *  Turbo Frame support for SPA-like navigation
-*  View transitions
+*  A tiny bit of javascript for awesome view transitions
 *  Responsive design
 *  Dark mode support
 *  Form validation with required fields
 *  Boolean fields styled as switches
 *  Automatic sidebar navigation links
 
-The scaffold templates are automatically available from the gem, so you can immediately generate scaffolds:
+The scaffold templates are automatically available from the gem, so you can immediately generate scaffolds.
 
-```bash
-rails generate scaffold Post title:string body:text published:boolean
-```
+### Default Rails Authentication
 
-### Install Devise Views
-
-Install the Basecoat-styled Devise views and layout:
+Install the Basecoat-styled authentication views (for Rails built-in authentication):
+    
+    rails generate:authentication
+    rails db:migrate
+    rake basecoat:install:authentication
 
-```bash
-rake basecoat:install:devise
-```
-NB: This will overwrite exising files!
+NB: To create a user, go to your console:
+    
+    rails console
+    User.create(email_address: "email@example.com", password: "basecoat")
+    exit
 
-### Install Authentication Views
+### Install the Basecoat-styled Devise views and layout:
 
-Install the Basecoat-styled authentication views (for Rails built-in authentication):
+First install devise, follow the instructions at https://github.com/heartcombo/devise. Then:
 
 ```bash
-rake basecoat:install:authentication
+rake basecoat:install:devise
 ```
-NB: This will overwrite exising files!
 
 ### Install Pagy Pagination Styles
 
@@ -97,19 +88,9 @@ rake basecoat:install:pagy
 - Basecoat CSS
 - Stimulus (for the theme toggle, can be moved to something else if you desire...)
 
-## Discussion
-
-The scaffolds are more opinionated than the default - it includes a main turbo frame. 
-I also strongly feel that the index should not reuse the partial used in show - it defeats the purpose of the show page.
-A responsive table was the best I could come up with - closer to the OG scaffolds before Hotwire.
-
-Also, the (arguably) most messy part of the views are the svg tags which contain the lovely lucide icons. 
-Since these icons are the default for shadcn I'm considering including https://github.com/heyvito/lucide-rails to clean up the views. 
-
 ## Issues
 
-* The javascript included by basecoat needs some improvement. It's not automatically initialized on turbo:load - included is a hack that I hope is temporary.
-* We include extra css for the definition list. Hopefully this will be part of basecoat-css someday.
+* We include extra css for the definition list. Ideally I would pick an existing component.
 * Rails adds class="field_with_errors", so we need extra css for this. I hope Rails will at some point have aria-invalid="true" on the input, basecoat will apply the correct styling.
 * Can the views even be prettier? Probably! I'm more than happy to discuss improvements:
 

data/lib/basecoat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Basecoat
-  VERSION = "2.0.1"
+  VERSION = "2.2.1"
 end

data/lib/tasks/basecoat.rake

@@ -1,8 +1,27 @@
 require 'fileutils'
 
 namespace :basecoat do
+  # Helper method to prompt for overwrite confirmation
+  def prompt_overwrite(file_path, overwrite_all)
+    return true if overwrite_all[:value]
+    return true unless File.exist?(file_path)
+
+    print "  Overwrite #{file_path.relative_path_from(Rails.root)}? [y/n/a] "
+    response = STDIN.gets.chomp.downcase
+
+    if response == 'a'
+      overwrite_all[:value] = true
+      true
+    elsif response == 'y'
+      true
+    else
+      false
+    end
+  end
+
   desc "Install Basecoat application layout and partials"
   task :install do
+    overwrite_all = { value: false }
     # Install basecoat-css (detect package manager)
     puts "\n📦 Installing basecoat-css..."
 
@@ -82,8 +101,12 @@ namespace :basecoat do
       theme_controller_destination = Rails.root.join("app/javascript/controllers/theme_controller.js")
 
       FileUtils.mkdir_p(File.dirname(theme_controller_destination))
-      FileUtils.cp(theme_controller_source, theme_controller_destination)
-      puts "  Created: app/javascript/controllers/theme_controller.js"
+      if prompt_overwrite(theme_controller_destination, overwrite_all)
+        FileUtils.cp(theme_controller_source, theme_controller_destination)
+        puts "  Created: app/javascript/controllers/theme_controller.js"
+      else
+        puts "  Skipped: app/javascript/controllers/theme_controller.js"
+      end
     end
 
     # Add CSS imports and styles
@@ -112,23 +135,25 @@ namespace :basecoat do
       css_content = File.read(css_path)
 
       css_code = <<~CSS
-        .field_with_errors {
-            label {
-                color: var(--color-destructive);
-            }
-        
-            input {
-                border-color: var(--color-destructive);
-            }
-        }
-
-        dl {
-            font-size: var(--text-sm);
-            dt {
-                font-weight: var(--font-weight-bold);
-                margin-top: calc(var(--spacing)*4);
-            }
-        }
+dl {
+    font-size: var(--text-sm);
+    dt {
+        font-weight: var(--font-weight-bold);
+        margin-top: calc(var(--spacing)*4);
+    }
+}
+
+label:has(+ input:required):after {
+    content: " *"
+}
+
+input:user-invalid, .field_with_errors input {
+    border-color: var(--color-destructive);
+}
+
+label:has(+ input:user-invalid), .field_with_errors label {
+    color: var(--color-destructive);
+}
       CSS
       File.open(css_path, "a") { |f| f.write(css_code) }
       puts "  Added: basic styles to #{css_path.relative_path_from(Rails.root)}"
@@ -147,30 +172,53 @@ namespace :basecoat do
       if content =~ /(<head>.*?<\/head>)/m
         head_content = $1
         head_destination = partials_destination.join("_head.html.erb")
-        File.write(head_destination, head_content + "\n")
-        puts "  Created: app/views/layouts/_head.html.erb (extracted from existing application.html.erb)"
+        if prompt_overwrite(head_destination, overwrite_all)
+          File.write(head_destination, head_content + "\n")
+          puts "  Created: app/views/layouts/_head.html.erb (extracted from existing application.html.erb)"
+        else
+          puts "  Skipped: app/views/layouts/_head.html.erb"
+        end
       else
         # Fallback: copy the template if no <head> found in existing layout
-        FileUtils.cp("#{partials_source}/_head.html.erb", partials_destination.join("_head.html.erb"))
-        puts "  Created: app/views/layouts/_head.html.erb (from template)"
+        head_destination = partials_destination.join("_head.html.erb")
+        if prompt_overwrite(head_destination, overwrite_all)
+          FileUtils.cp("#{partials_source}/_head.html.erb", head_destination)
+          puts "  Created: app/views/layouts/_head.html.erb (from template)"
+        else
+          puts "  Skipped: app/views/layouts/_head.html.erb"
+        end
       end
     else
       # No existing layout, use template
-      FileUtils.cp("#{partials_source}/_head.html.erb", partials_destination.join("_head.html.erb"))
-      puts "  Created: app/views/layouts/_head.html.erb (from template)"
+      head_destination = partials_destination.join("_head.html.erb")
+      if prompt_overwrite(head_destination, overwrite_all)
+        FileUtils.cp("#{partials_source}/_head.html.erb", head_destination)
+        puts "  Created: app/views/layouts/_head.html.erb (from template)"
+      else
+        puts "  Skipped: app/views/layouts/_head.html.erb"
+      end
     end
 
     # Copy application layout
     layout_source = File.expand_path("../generators/basecoat/templates/application.html.erb", __dir__)
-    FileUtils.cp(layout_source, layout_destination)
-    puts "  Created: app/views/layouts/application.html.erb"
+    if prompt_overwrite(layout_destination, overwrite_all)
+      FileUtils.cp(layout_source, layout_destination)
+      puts "  Created: app/views/layouts/application.html.erb"
+    else
+      puts "  Skipped: app/views/layouts/application.html.erb"
+    end
 
     # Copy layout partials (except _head.html.erb which we already handled)
     Dir.glob("#{partials_source}/*").each do |file|
       filename = File.basename(file)
       next if filename == "_head.html.erb" # Skip _head.html.erb, we already created it
-      FileUtils.cp(file, partials_destination.join(filename))
-      puts "  Created: app/views/layouts/#{filename}"
+      destination = partials_destination.join(filename)
+      if prompt_overwrite(destination, overwrite_all)
+        FileUtils.cp(file, destination)
+        puts "  Created: app/views/layouts/#{filename}"
+      else
+        puts "  Skipped: app/views/layouts/#{filename}"
+      end
     end
 
     # Copy shared partials
@@ -180,8 +228,13 @@ namespace :basecoat do
     FileUtils.mkdir_p(shared_destination)
     Dir.glob("#{shared_source}/*").each do |file|
       filename = File.basename(file)
-      FileUtils.cp(file, shared_destination.join(filename))
-      puts "  Created: app/views/shared/#{filename}"
+      destination = shared_destination.join(filename)
+      if prompt_overwrite(destination, overwrite_all)
+        FileUtils.cp(file, destination)
+        puts "  Created: app/views/shared/#{filename}"
+      else
+        puts "  Skipped: app/views/shared/#{filename}"
+      end
     end
 
     # Copy scaffold hook initializer
@@ -189,8 +242,12 @@ namespace :basecoat do
     initializer_destination = Rails.root.join("config/initializers/scaffold_hook.rb")
 
     FileUtils.mkdir_p(File.dirname(initializer_destination))
-    FileUtils.cp(initializer_source, initializer_destination)
-    puts "  Created: config/initializers/scaffold_hook.rb"
+    if prompt_overwrite(initializer_destination, overwrite_all)
+      FileUtils.cp(initializer_source, initializer_destination)
+      puts "  Created: config/initializers/scaffold_hook.rb"
+    else
+      puts "  Skipped: config/initializers/scaffold_hook.rb"
+    end
 
     puts "\n✓ Basecoat installed successfully!"
     puts "  Scaffold templates are automatically available from the gem."
@@ -200,21 +257,37 @@ namespace :basecoat do
   namespace :install do
     desc "Install Basecoat Devise views and layout"
     task :devise do
+      overwrite_all = { value: false }
+
       # Copy devise views
       devise_source = File.expand_path("../generators/basecoat/templates/devise", __dir__)
       devise_destination = Rails.root.join("app/views/devise")
 
       FileUtils.mkdir_p(devise_destination)
-      FileUtils.cp_r("#{devise_source}/.", devise_destination)
-      puts "  Created: app/views/devise/"
+      Dir.glob("#{devise_source}/**/*").each do |file|
+        next if File.directory?(file)
+        relative_path = Pathname.new(file).relative_path_from(Pathname.new(devise_source))
+        destination = devise_destination.join(relative_path)
+        FileUtils.mkdir_p(File.dirname(destination))
+        if prompt_overwrite(destination, overwrite_all)
+          FileUtils.cp(file, destination)
+          puts "  Created: app/views/devise/#{relative_path}"
+        else
+          puts "  Skipped: app/views/devise/#{relative_path}"
+        end
+      end
 
       # Copy devise layout
       layout_source = File.expand_path("../generators/basecoat/templates/devise.html.erb", __dir__)
       layout_destination = Rails.root.join("app/views/layouts/devise.html.erb")
 
       FileUtils.mkdir_p(File.dirname(layout_destination))
-      FileUtils.cp(layout_source, layout_destination)
-      puts "  Created: app/views/layouts/devise.html.erb"
+      if prompt_overwrite(layout_destination, overwrite_all)
+        FileUtils.cp(layout_source, layout_destination)
+        puts "  Created: app/views/layouts/devise.html.erb"
+      else
+        puts "  Skipped: app/views/layouts/devise.html.erb"
+      end
 
       # Add user dropdown to header partial
       header_path = Rails.root.join("app/views/layouts/_header.html.erb")
@@ -253,6 +326,7 @@ namespace :basecoat do
 
     desc "Install Basecoat Pagy pagination styles"
     task :pagy do
+      overwrite_all = { value: false }
       pagy_source = File.expand_path("../generators/basecoat/templates/pagy.scss", __dir__)
 
       # Check if using Tailwind v4 setup (app/assets/tailwind)
@@ -260,8 +334,12 @@ namespace :basecoat do
         # Copy pagy styles to tailwind directory
         pagy_destination = Rails.root.join("app/assets/tailwind/pagy.scss")
         FileUtils.mkdir_p(File.dirname(pagy_destination))
-        FileUtils.cp(pagy_source, pagy_destination)
-        puts "  Created: app/assets/tailwind/pagy.scss"
+        if prompt_overwrite(pagy_destination, overwrite_all)
+          FileUtils.cp(pagy_source, pagy_destination)
+          puts "  Created: app/assets/tailwind/pagy.scss"
+        else
+          puts "  Skipped: app/assets/tailwind/pagy.scss"
+        end
 
         # Add import to tailwind application.css
         tailwind_css = Rails.root.join("app/assets/tailwind/application.css")
@@ -276,8 +354,12 @@ namespace :basecoat do
         # Copy pagy styles to stylesheets directory
         pagy_destination = Rails.root.join("app/assets/stylesheets/pagy.scss")
         FileUtils.mkdir_p(File.dirname(pagy_destination))
-        FileUtils.cp(pagy_source, pagy_destination)
-        puts "  Created: app/assets/stylesheets/pagy.scss"
+        if prompt_overwrite(pagy_destination, overwrite_all)
+          FileUtils.cp(pagy_source, pagy_destination)
+          puts "  Created: app/assets/stylesheets/pagy.scss"
+        else
+          puts "  Skipped: app/assets/stylesheets/pagy.scss"
+        end
       end
 
       puts "\n✓ Basecoat Pagy styles installed successfully!"
@@ -286,29 +368,55 @@ namespace :basecoat do
 
     desc "Install Basecoat authentication views and layout"
     task :authentication do
+      overwrite_all = { value: false }
+
       # Copy sessions views
       sessions_source = File.expand_path("../generators/basecoat/templates/sessions", __dir__)
       sessions_destination = Rails.root.join("app/views/sessions")
 
       FileUtils.mkdir_p(sessions_destination)
-      FileUtils.cp_r("#{sessions_source}/.", sessions_destination)
-      puts "  Created: app/views/sessions/"
+      Dir.glob("#{sessions_source}/**/*").each do |file|
+        next if File.directory?(file)
+        relative_path = Pathname.new(file).relative_path_from(Pathname.new(sessions_source))
+        destination = sessions_destination.join(relative_path)
+        FileUtils.mkdir_p(File.dirname(destination))
+        if prompt_overwrite(destination, overwrite_all)
+          FileUtils.cp(file, destination)
+          puts "  Created: app/views/sessions/#{relative_path}"
+        else
+          puts "  Skipped: app/views/sessions/#{relative_path}"
+        end
+      end
 
       # Copy passwords views
       passwords_source = File.expand_path("../generators/basecoat/templates/passwords", __dir__)
       passwords_destination = Rails.root.join("app/views/passwords")
 
       FileUtils.mkdir_p(passwords_destination)
-      FileUtils.cp_r("#{passwords_source}/.", passwords_destination)
-      puts "  Created: app/views/passwords/"
+      Dir.glob("#{passwords_source}/**/*").each do |file|
+        next if File.directory?(file)
+        relative_path = Pathname.new(file).relative_path_from(Pathname.new(passwords_source))
+        destination = passwords_destination.join(relative_path)
+        FileUtils.mkdir_p(File.dirname(destination))
+        if prompt_overwrite(destination, overwrite_all)
+          FileUtils.cp(file, destination)
+          puts "  Created: app/views/passwords/#{relative_path}"
+        else
+          puts "  Skipped: app/views/passwords/#{relative_path}"
+        end
+      end
 
       # Copy sessions layout
       layout_source = File.expand_path("../generators/basecoat/templates/sessions.html.erb", __dir__)
       layout_destination = Rails.root.join("app/views/layouts/sessions.html.erb")
 
       FileUtils.mkdir_p(File.dirname(layout_destination))
-      FileUtils.cp(layout_source, layout_destination)
-      puts "  Created: app/views/layouts/sessions.html.erb"
+      if prompt_overwrite(layout_destination, overwrite_all)
+        FileUtils.cp(layout_source, layout_destination)
+        puts "  Created: app/views/layouts/sessions.html.erb"
+      else
+        puts "  Skipped: app/views/layouts/sessions.html.erb"
+      end
 
       # Add layout to passwords_controller
       passwords_controller = Rails.root.join("app/controllers/passwords_controller.rb")

data/lib/templates/erb/scaffold/_form.html.erb.tt

@@ -23,12 +23,15 @@
       <%%= form.check_box :<%= attribute.column_name %>, class: "input", role: "switch" %>
       <%= attribute.human_name %>
     <%% end %>
-<% elsif attribute.field_type == :datetime_local_field || attribute.field_type == :date_field || attribute.field_type == :time_field -%>
+<% elsif %w[url permalink website].include? attribute.column_name -%>
     <%%= form.label :<%= attribute.column_name %>, class: "label" %>
-    <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "input"<%= ", required: true" if required %> %>
-<% elsif attribute.field_type == :number_field -%>
+      <%%= form.url_field :<%= attribute.column_name %>, class: "input"<%= ", required: true" if required %> %>
+<% elsif %w[email email_address].include? attribute.column_name -%>
     <%%= form.label :<%= attribute.column_name %>, class: "label" %>
-    <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "input"<%= ", required: true" if required %> %>
+    <%%= form.email_field :<%= attribute.column_name %>, class: "input"<%= ", required: true" if required %> %>
+<% elsif %w[phone phone_number].include? attribute.column_name -%>
+    <%%= form.label :<%= attribute.column_name %>, class: "label" %>
+    <%%= form.phone_field :<%= attribute.column_name %>, maxLength: 16, pattern: "[0-9\+\\-\\(\\)\s]*", class: "input"<%= ", required: true" if required %> %>
 <% else -%>
     <%%= form.label :<%= attribute.column_name %>, class: "label" %>
     <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "input"<%= ", required: true" if required %> %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basecoat
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Martijn Lafeber