next_rails_scaffold 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c2225f9eacbc656621975912ce9b1c2929c187557fe469fb341bb09d49e5750
-  data.tar.gz: 9315b207c3c4c8e5b64bf810185f99bd6bc6682ffc85a760a7c5149b85f7aaeb
+  metadata.gz: 7cfc0dd5220ecc60e9781e9844d08a3636b858e013572d66bbc8097b4928fa26
+  data.tar.gz: b93eb19cd0e4d9ea2effa6cef7ff11fd5a4d4f792d5925ccb2baaad9eee5f5d4
 SHA512:
-  metadata.gz: be60c9ec365f1899d090820cffa5704003a1d07c6e0d6b1225d41081428b9e4ba7fe9fd1f2ea4b6ea9d1bb9c7af7556bcd089c2b99eaae093a341d7e548dd29f
-  data.tar.gz: f93520c64dfacf3a926400672469d1ab53d60cd2fe8d70b8d0bda80b7bb657c927e014fce731813e90b4554df08d5e32a16f3ae4dbd832882ebe661f393e3088
+  metadata.gz: 79bc08d233802b69d1a1b6745dc561d95c8c8e1c1f138eadf4116840ee11d95e55b3c03447e843740eb05ea88298a94e3141e152b184330d142a9afa5b2839fd
+  data.tar.gz: 3f6245dd4badbfced192b0474541a27f14de49435fa43ed137afc2b0bb17542cc41d8d054396ba21614bcf211fcb37db980c37f710b60035029fe5e37cb41aa5

data/lib/generators/rails/next_rails_scaffold/next_rails_scaffold_generator.rb

@@ -1,19 +1,38 @@
 # frozen_string_literal: true
 
+require "tty-prompt"
+
+PackageManager = Struct.new(:fetch, :run, :add, :lock_file, :version) do
+  def to_s = run.split.first
+end
+
 module Rails
   class NextRailsScaffoldGenerator < Rails::Generators::NamedBase
     include ::NextRailsScaffold::Actions
 
     source_root File.expand_path("templates", __dir__)
 
-    NODE_REQUIRED_VERSION = ENV.fetch("NODE_REQUIRED_VERSION", ">= 18.20.6")
-    YARN_VERSION = ENV.fetch("YARN_VERSION", "1.22.22")
+    PACKAGE_MANAGERS = {
+      "npm" => PackageManager.new("npx", "npm run", "npm install", "package-lock.json"),
+      "yarn" => PackageManager.new("yarn dlx", "yarn", "yarn add", "yarn.lock"),
+      "pnpm" => PackageManager.new("pnpm dlx", "pnpm", "pnpm add", "pnpm-lock.yaml"),
+      "bun" => PackageManager.new("bunx", "bun run", "bun add", "bun.lock.json")
+    }.freeze
+    NODE_REQUIRED_VERSION = ENV.fetch("NODE_REQUIRED_VERSION", ">= 18.20")
     NEXT_VERSION = ENV.fetch("NEXT_VERSION", "15.1.6")
 
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
+    class_option :package_manager, type: :string, desc: "Package manager to use for frontend project"
+    class_option :skip_build, type: :boolean, default: false, desc: "Skip running Next.js build"
+    class_option :skip_routes, type: :boolean, default: false, desc: "Skip adding resources to routes.rb"
+
+    attr_accessor :selected_package_manager
 
     def initialize(args, *options) # :nodoc:
       super
+
+      @prompt = TTY::Prompt.new
+
       self.attributes = shell.base.attributes
     end
 
@@ -31,29 +50,32 @@ module Rails
     #     end
     #   end
     def add_resource_route
-      return if options[:actions].present?
+      return if options[:actions].present? || options[:skip_routes]
 
       route "resources :#{file_name.pluralize}", namespace: regular_class_path, scope: "/api"
     end
 
-    # Check Javascript depencies and create a new Next.js project. Install the the usefull packages and create the
+    # Check Javascript dependencies and create a new Next.js project. Install the the useful packages and create the
     # scaffold code for frontend application.
     def create_frontend_project
       return say_status :remove, "skip frontend folder", :yellow if shell.base.behavior == :revoke
 
-      check_node!
       append_gitignore!
 
       empty_directory "frontend"
 
       inside("frontend") do
+        check_node!
+        check_pm_version!
         create_next_app!
         install_hygen!
 
         language = File.exist?("tsconfig.json") ? "typescript" : "javascript"
 
-        run("npx hygen scaffold #{language} #{name} #{mapped_attributes.join(" ")}")
-        run("yarn build")
+        run("#{selected_package_manager} hygen scaffold #{language} #{name} #{mapped_attributes.join(" ")}")
+        if !options[:skip_build] && @prompt.no?("Do you want to build your Next.js project? (y/N)")
+          run("#{selected_package_manager.run} build")
+        end
       end
     end
 
@@ -70,6 +92,30 @@ module Rails
       end
     end
 
+    def check_pm_version!
+      package_manager = shell.base.options[:package_manager]
+
+      unless package_manager
+        PACKAGE_MANAGERS.each do |manager, details|
+          if File.exist?(details.lock_file)
+            package_manager = manager
+            break
+          end
+        end
+      end
+
+      until PACKAGE_MANAGERS.keys.include?(package_manager)
+        puts "Invalid package manager" unless package_manager.nil?
+
+        package_manager = @prompt.select("Which package manager do you want to use?", PACKAGE_MANAGERS.keys)
+      end
+
+      self.selected_package_manager = PACKAGE_MANAGERS[package_manager]
+
+      selected_package_manager.version = run("#{selected_package_manager} --version", capture: true).gsub(/[^0-9.]/, "")
+      log :package_manager, "Using #{selected_package_manager} version '#{selected_package_manager.version}'"
+    end
+
     def append_gitignore!
       rows = <<~HEREDOC
 
@@ -83,16 +129,22 @@ module Rails
     def create_next_app!
       return if File.exist?("package.json")
 
-      run("npm install --global yarn@#{YARN_VERSION}")
-      run("yarn global add create-next-app@#{NEXT_VERSION}")
-      run("yarn create next-app . --no-app --src-dir --import-alias \"@/*\"")
+      run(
+        "#{selected_package_manager.fetch} create-next-app@#{NEXT_VERSION} . " \
+        "--no-app --src-dir --import-alias \"@/*\""
+      )
+
+      if selected_package_manager.to_s == "yarn" &&
+         Gem::Dependency.new("", ">= 2.0").match?("", selected_package_manager.version)
+        run("yarn config set nodeLinker node-modules")
+      end
     end
 
     def install_hygen!
       return if Dir.exist?("_templates")
 
-      run("yarn add -D hygen hygen-add")
-      run("npx hygen-add next-rails-scaffold")
+      run("#{selected_package_manager.add} -D hygen hygen-add")
+      run("#{selected_package_manager} hygen-add next-rails-scaffold")
     end
 
     def mapped_attributes

data/lib/next_rails_scaffold/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NextRailsScaffold
-  VERSION = "0.3.1"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: next_rails_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Raphael Araújo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 description: |
   The `next_rails_scaffold` gem is a powerful extension to the standard Ruby on Rails scaffold generator. It streamlines the development workflow by not only creating the backend structure with Rails but also automating the setup of a frontend directory using Next.js. Upon running the scaffold generator, this gem intelligently generates a Next.js application within the specified frontend directory.