next_rails_scaffold 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d3d25e8b717552cb8ebd2a090c806de449f66b71c29463e22d41ca8ed85dcf
-  data.tar.gz: bdf00a7fd490e2a87baa48adea598d28a5481a2cb9e730902d0e4080b21194f5
+  metadata.gz: abd99131dfb6cd8584a12c366b039b743168e744b41f471c902596e10b77e138
+  data.tar.gz: 9523b8f173ba5373678d946497a7344e36afbd11505187153eeb79d2223e6540
 SHA512:
-  metadata.gz: 87d2348fcba0bd076632291330c078ab0f4db23a0730b64ee1b89e166f07e491983281cf8341d068878a96cf890990aca80b627a75038715f6317859018b747a
-  data.tar.gz: 68647f776a9f0ba73148639c76ac9c117026f390e9d9810382b86548e4c82bdb6908740e532bdae47ff0f23a674907686b1ff743d9a5159bf79c8845d3d19627
+  metadata.gz: d630cd3b07ce3c38b0411638def67bf59f5e2c1d79fbcc358a2ba681cf8318ca7bce8d8ef3a6b2f6929ec51c3019a49bdcbac8b36300f95e5c7c3fa1de311d0a
+  data.tar.gz: 49a4fb1332d41bfe302c91ab814177e748ff152fa4ed0f3ad43154d73a30e8137ee7ab3e96c6fc638ad48b5119f5e2973ef5380e139269b7f0f41717469c9c9f

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

data/README.md

@@ -1,24 +1,61 @@
 # NextRails
 
-TODO: Delete this and the text below, and describe your gem
+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.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/next_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+The generated Next.js app follows best practices, including a structured page routing system, ensuring that each resource created by the scaffold has its corresponding page and components. This integration enables developers to seamlessly transition between Rails backend and Next.js frontend development, fostering a cohesive and efficient development environment.
 
-## Installation
+Key Features:
+
+- **Automatic Frontend Setup:** The gem automates the creation of a frontend directory within the Rails project, ready for Next.js development.
+- **Page Routing Integration:** All scaffolded resources come with their own pages and components, organized using Next.js' page routing system.
+- **Effortless Transition:** Developers can seamlessly switch between Rails backend and Next.js frontend development within the same project.
+- **Boosted Productivity:** Accelerate development by eliminating the manual setup of frontend components and pages, allowing developers to focus on building features.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Integrate `next_rails_scaffold` into your Ruby on Rails projects to enjoy a streamlined, organized, and efficient full-stack development experience.
+
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add next_rails_scaffold
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install next_rails_scaffold
 
 ## Usage
 
-TODO: Write usage instructions here
+The `next_rails_scaffold` gem enhances the default Ruby on Rails scaffold generator by seamlessly integrating with Next.js, a React framework. This gem automates the process of scaffolding a Rails application along with a corresponding frontend directory containing a Next.js application. The generated Next.js app includes all necessary pages and components, leveraging the power of page routing for a smooth and organized development experience.
+
+Example:
+
+```
+bin/rails generate scaffold Post tile:string body:text
+```
+
+This will create:
+
+```
+app/
+  controllers/
+    posts_controller.rb
+  models/
+    post.rb
+  ...
+frontend/
+  src
+    pages
+      posts
+        [id]
+          edit.js
+          index.js
+        _components
+          Post.js
+          PostForm.js
+        index.js
+        new.js
+      services.js
+```
 
 ## Development
 
@@ -28,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/next_rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/raphox/next_rails.
 
 ## License
 

data/lib/generators/next_rails/USAGE

@@ -0,0 +1,27 @@
+Description:
+    The `next_rails_scaffold` gem enhances the default Ruby on Rails scaffold generator by seamlessly integrating with Next.js, a React framework. This gem automates the process of scaffolding a Rails application along with a corresponding frontend directory containing a Next.js application. The generated Next.js app includes all necessary pages and components, leveraging the power of page routing for a smooth and organized development experience.
+
+Example:
+    bin/rails generate scaffold Post tile:string body:text
+
+    This will create:
+
+        app/
+          controllers/
+            posts_controller.rb
+          models/
+            post.rb
+          ...
+        frontend/
+          src
+            pages
+              posts
+                [id]
+                  edit.js
+                  index.js
+                _components
+                  Post.js
+                  PostForm.js
+                index.js
+                new.js
+              services.js

data/lib/generators/next_rails/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NextRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy NextRails default files"
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_config
+        template "config/initializers/next_rails.rb"
+      end
+    end
+  end
+end

data/lib/generators/next_rails/templates/config/initializers/next_rails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "next_rails"
+
+NextRails.setup do |config|
+  config.generators do |g|
+    g.helper :next_rails
+  end
+end

data/lib/generators/rails/next_rails/next_rails_generator.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Rails
+  class NextRailsGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    NODE_REQUIRED_VERSION = ">= 18.17.0"
+    YARN_VERSION = "1.22.19"
+    NEXT_VERSION = "14.0.2"
+    NODULES_MODULES = [
+      "@hookform/resolvers",
+      "@tanstack/react-query",
+      "axios",
+      "react-hook-form",
+      "zod"
+    ].freeze
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    def initialize(args, *options) # :nodoc:
+      super
+      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?
+
+      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
+    # scaffold code for frontend application.
+    def create_frontend_project
+      check_node!
+      append_gitignore!
+
+      empty_directory "frontend"
+
+      inside("frontend") do
+        create_next_app!
+
+        install_hygen!
+        install_dependencies!
+
+        run("npx hygen generate scaffold #{name} #{mapped_attributes.join(" ")}")
+        run("yarn build")
+      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)
+        say "Your Node version is '#{node_version}'", :green
+      else
+        say_error "You need to have a Node version '#{NODE_REQUIRED_VERSION}'", :red
+        abort
+      end
+    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("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 \"@/*\"")
+    end
+
+    def install_hygen!
+      return if Dir.exist?("_templates")
+
+      run("yarn add -D hygen hygen-add")
+      run("npx hygen-add next-rails-scaffold")
+    end
+
+    def install_dependencies!
+      run("yarn add #{NODULES_MODULES.join(" ")}")
+    end
+
+    def mapped_attributes
+      attributes.map { |attr| "#{attr.name}:#{attr.type}" }
+    end
+
+    # Make an entry in \Rails routing file <tt>config/routes.rb</tt>
+    #
+    #   route "root 'welcome#index'"
+    #   route "root 'admin#index'", namespace: :admin
+    #   route "root 'admin#index'", namespace: :admin, scope: '/api'
+    def route(routing_code, namespace: nil, scope: nil)
+      namespace = Array(namespace)
+      namespace_pattern = route_namespace_pattern(namespace)
+      routing_code = namespace.reverse.reduce(routing_code) do |code, name|
+        "namespace :#{name} do\n#{rebase_indentation(code, 2)}end"
+      end
+
+      scope = Array(scope)
+      routing_code = scope.reverse.reduce(routing_code) do |code, name|
+        "scope '#{name}' do\n#{rebase_indentation(code, 2)}end"
+      end
+
+      log :route, routing_code
+
+      in_root do
+        if namespace_match = match_file("config/routes.rb", namespace_pattern)
+          base_indent, *, existing_block_indent = namespace_match.captures.compact.map(&:length)
+          existing_line_pattern = /^ {,#{existing_block_indent}}\S.+\n?/
+          routing_code = rebase_indentation(routing_code, base_indent + 2).gsub(existing_line_pattern, "")
+          namespace_pattern = /#{Regexp.escape namespace_match.to_s}/
+        end
+
+        inject_into_file "config/routes.rb", routing_code, after: namespace_pattern, verbose: false, force: false
+
+        if behavior == :revoke && namespace.any? && namespace_match
+          empty_block_pattern = /(#{namespace_pattern})((?:\s*end\n){1,#{namespace.size}})/
+          gsub_file "config/routes.rb", empty_block_pattern, verbose: false, force: true do |matched|
+            beginning, ending = empty_block_pattern.match(matched).captures
+            ending.sub!(/\A\s*end\n/, "") while !ending.empty? && beginning.sub!(/^ *namespace .+ do\n\s*\z/, "")
+            beginning + ending
+          end
+        end
+      end
+    end
+
+    def exit_on_failure?
+      true
+    end
+  end
+end

data/lib/next_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NextRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: next_rails_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Raphael Araújo
@@ -43,11 +43,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/next_rails/USAGE
+- lib/generators/next_rails/install_generator.rb
+- lib/generators/next_rails/templates/config/initializers/next_rails.rb
+- lib/generators/rails/next_rails/next_rails_generator.rb
 - lib/next_rails.rb
 - lib/next_rails/version.rb
 - sig/next_rails.rbs
@@ -58,7 +64,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/raphox/next-rails#readme
   source_code_uri: https://github.com/raphox/next-rails
-  changelog_uri: https://github.com/raphox/next-rails/CHANGELOG.md
+  changelog_uri: https://github.com/raphox/next-rails/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -74,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: The `next_rails_scaffold` gem enhances the default Ruby on Rails scaffold