next_rails_scaffold 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cfc0dd5220ecc60e9781e9844d08a3636b858e013572d66bbc8097b4928fa26
-  data.tar.gz: b93eb19cd0e4d9ea2effa6cef7ff11fd5a4d4f792d5925ccb2baaad9eee5f5d4
+  metadata.gz: 1cc3d58eda573151a58994e22522dd40c516b5d2626ce68255787fae807fcbb8
+  data.tar.gz: 1ce21ee31c2e2aeae77da4f43203e07b23497d40a9bf44bd3df16fc2bf3dde0a
 SHA512:
-  metadata.gz: 79bc08d233802b69d1a1b6745dc561d95c8c8e1c1f138eadf4116840ee11d95e55b3c03447e843740eb05ea88298a94e3141e152b184330d142a9afa5b2839fd
-  data.tar.gz: 3f6245dd4badbfced192b0474541a27f14de49435fa43ed137afc2b0bb17542cc41d8d054396ba21614bcf211fcb37db980c37f710b60035029fe5e37cb41aa5
+  metadata.gz: f96f4a0a7e4bf885d1c431256f83efbaccf61cfa9c94f96448a9191267275e2d6539f11703bbac0984b897b2eccc3a3099d6a9984c10b83e5dd08ced758609c2
+  data.tar.gz: ab8d3d422e6ff1a631d28efc6b6a0c6d470928e8601d835ae2792e47ba448acc80abe28d9288594059a684f93436a87831254a6970a6881933215c285885527f

data/lib/generators/next_rails_scaffold/node_package_manager.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "open3"
+require "tty-prompt"
+
+module NextRailsScaffold
+  module Generators
+    NodePackageManagerStruct = Struct.new(:fetch, :run, :add, :lock_file, :version) do
+      def to_s = run.split.first
+
+      def available?
+        version.present?
+      end
+
+      def version
+        @version ||= NodePackageManager.get_version(to_s)
+      end
+    end
+
+    NODE_REQUIRED_VERSION = ENV.fetch("NODE_REQUIRED_VERSION", ">= 18.20")
+    NEXT_VERSION = ENV.fetch("NEXT_VERSION", "15.1.6")
+
+    PACKAGE_MANAGERS = {
+      "npm" => NodePackageManagerStruct.new("npx", "npm run", "npm install", "package-lock.json"),
+      "yarn" => NodePackageManagerStruct.new("npx", "yarn", "yarn add", "yarn.lock"),
+      "pnpm" => NodePackageManagerStruct.new("pnpm dlx", "pnpm", "pnpm add", "pnpm-lock.yaml"),
+      "bun" => NodePackageManagerStruct.new("bunx", "bun run", "bun add", "bun.lock.json")
+    }.freeze
+
+    class NodePackageManager
+      attr_reader :selected_package_manager
+
+      def self.get_version(command)
+        Open3.capture3(command, "--version").first.gsub(/[^0-9.]/, "")
+      rescue Errno::ENOENT
+        nil
+      end
+
+      def initialize(shell)
+        @prompt = TTY::Prompt.new
+        @shell = shell
+      end
+
+      def check_node!
+        node_version = self.class.get_version("node")
+
+        return if Gem::Dependency.new("", NODE_REQUIRED_VERSION).match?("", node_version)
+
+        raise node_version ? "Your Node version is '#{node_version}'" : "Node not found"
+      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)
+          raise "Invalid package manager" unless package_manager.nil?
+
+          package_manager = @prompt.select(
+            "Which package manager do you want to use?",
+            PACKAGE_MANAGERS.keys.map { |pm| { name: pm, value: pm, disabled: !PACKAGE_MANAGERS[pm].available? } }
+          )
+        end
+
+        @selected_package_manager = PACKAGE_MANAGERS[package_manager]
+      end
+
+      def create_next_app!
+        return if File.exist?("package.json")
+
+        system(
+          "#{selected_package_manager.fetch} create-next-app@#{NEXT_VERSION} . --use-#{selected_package_manager} " \
+          "--no-app --src-dir --import-alias \"@/*\" #{Rails.env.test? ? "--yes" : ""}"
+        )
+
+        if selected_package_manager.to_s == "yarn" &&
+           Gem::Dependency.new("", ">= 2.0").match?("", selected_package_manager.version)
+          system("yarn config set nodeLinker node-modules")
+        end
+      end
+
+      def install_hygen!
+        return if Dir.exist?("_templates")
+
+        system("#{selected_package_manager.add} -D hygen hygen-add")
+        system("#{selected_package_manager.fetch} hygen-add next-rails-scaffold")
+      end
+    end
+  end
+end

data/lib/generators/next_rails_scaffold/scaffold_generator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "rails/generators/rails/scaffold/scaffold_generator"
+require_relative "node_package_manager"
+
+module NextRailsScaffold
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
+      include ::NextRailsScaffold::Actions
+
+      source_root File.expand_path("templates", __dir__)
+
+      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
+        self.attributes = shell.base.attributes
+      end
+
+      def add_resource_route
+        return if options[:actions].present? || options[:skip_routes]
+
+        route "resources :#{file_name.pluralize}", namespace: regular_class_path, scope: "/api"
+      end
+
+      def create_root_folder
+        empty_directory "frontend"
+      end
+
+      # 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
+
+        append_gitignore!
+
+        node_package_manager = NodePackageManager.new(shell)
+
+        inside("frontend") do
+          node_package_manager.check_node!
+          node_package_manager.check_pm_version!
+          node_package_manager.create_next_app!
+          node_package_manager.install_hygen!
+
+          return if Rails.env.test?
+
+          selected_package_manager = node_package_manager.selected_package_manager
+          language = File.exist?("tsconfig.json") ? "typescript" : "javascript"
+
+          run("#{selected_package_manager.fetch} hygen scaffold #{language} #{name} #{mapped_attributes.join(" ")}")
+          if !options[:skip_build] && !@prompt.no?("Do you want to build your Next.js project?")
+            run("#{selected_package_manager.run} build")
+          end
+        end
+      end
+
+      private
+
+      def append_gitignore!
+        path = File.join(destination_root, ".gitignore")
+
+        return unless File.exist?(path)
+
+        rows = <<~HEREDOC
+
+          # Ignoring node modules for Rails and Next.js projects
+          node_modules/
+        HEREDOC
+
+        append_to_file path, rows
+      end
+
+      def mapped_attributes
+        attributes.map { |attr| "#{attr.name}:#{attr.type}" }
+      end
+    end
+  end
+end

data/lib/next_rails_scaffold/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: next_rails_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Raphael Araújo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -68,8 +68,9 @@ files:
 - config/routes.rb
 - lib/generators/next_rails_scaffold/USAGE
 - lib/generators/next_rails_scaffold/install_generator.rb
+- lib/generators/next_rails_scaffold/node_package_manager.rb
+- lib/generators/next_rails_scaffold/scaffold_generator.rb
 - lib/generators/next_rails_scaffold/templates/config/initializers/next_rails_scaffold.rb
-- lib/generators/rails/next_rails_scaffold/next_rails_scaffold_generator.rb
 - lib/next_rails_scaffold.rb
 - lib/next_rails_scaffold/actions.rb
 - lib/next_rails_scaffold/engine.rb

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

@@ -1,158 +0,0 @@
-# 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__)
-
-    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
-
-    # Properly nests namespaces passed into a generator
-    #
-    #   $ bin/rails generate resource admin/users/products
-    #
-    # should give you
-    #
-    #   scope '/api' do
-    #     namespace :admin do
-    #       namespace :users do
-    #         resources :products
-    #       end
-    #     end
-    #   end
-    def add_resource_route
-      return if options[:actions].present? || options[:skip_routes]
-
-      route "resources :#{file_name.pluralize}", namespace: regular_class_path, scope: "/api"
-    end
-
-    # 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
-
-      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("#{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
-
-    private
-
-    def check_node!
-      node_version = run("node --version", capture: true).gsub(/[^0-9.]/, "")
-
-      if Gem::Dependency.new("", NODE_REQUIRED_VERSION).match?("", node_version)
-        log :node_version, "Your Node version is '#{node_version}'"
-      else
-        say_status :node_version, "You need to have a Node version '#{NODE_REQUIRED_VERSION}'", :red
-        abort
-      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
-
-        # Ingoring node modules for Rails and Next.js projects
-        node_modules/
-      HEREDOC
-
-      append_to_file ".gitignore", rows
-    end
-
-    def create_next_app!
-      return if File.exist?("package.json")
-
-      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("#{selected_package_manager.add} -D hygen hygen-add")
-      run("#{selected_package_manager} hygen-add next-rails-scaffold")
-    end
-
-    def mapped_attributes
-      attributes.map { |attr| "#{attr.name}:#{attr.type}" }
-    end
-
-    def exit_on_failure?
-      true
-    end
-  end
-end